wiki:Commentary

Version 107 (modified by batterseapower, 4 years ago) (diff)

--

The GHC Commentary

This tree of wiki pages is a "commentary" on the GHC source code. It contains all the explanatory material that doesn't belong in comments in the source code itself, because the material is wide-ranging, usually covers multiple source files, and is more architectural in nature. The commentary can also be considered a design document for GHC.

For the dedicated, there are videos of Simon and Simon giving an overview of GHC, at the 2006 GHC Hackathon.

Please feel free to add material to this commentary: don't worry too much about accuracy, in due course someone will edit your contribution. Try to link to source files as much as possible by using this macro: [[GhcFile(compiler/Makefile)]] (the usual Trac source: macro doesn't work here because the GHC darcs repository isn't integrated into this Trac). Also try to add appropriate links to other parts of the commentary.

Contents

Contributed Documentation

Please edit and improve the Commentary above, or the Building Guide.

However sometimes you may want to add new material that doesn't quite fit into the existing structure. Or perhaps your pages are about work-in-progress, status reports and suchlike, which don't belong in the Commentary per se. Regardless, you can add your new material here.

  • The Runtime System
    • GarbageCollectorNotes Notes about GHC's existing single threaded garbage collector and development of a parallel GC.
    • GMPMemoryManagement Describes how the garbage collector cooperates with GMP for Integer.
    • SemiTagging: Describes how the semi-tagging optimisation will be implemented.
    • PAPI: Measurement of program performance usign CPU events (cache misses, branch mispredictions).
  • Getting to grips with the code base
    • BeginnersNotes?: Some notes about getting started hacking GHC and the structure of the compiler (especially types and typecheck)

Old but useful

Finally, here are some generally-useful, but now somewhat-out-of-date resources:

  • The old GHC Commentary: Information on the internals of GHC, in various states of up-to-dateness. We are keen to move this stuff out of its current location and onto this Wiki. If anyone is willing to help do that, even for just a part in which you are interested, we would be delighted.
  • GhcPapers: papers and pointers to other documents that relate to the inner workings of GHC.

Convert type diagram to SVG? Upload graphviz source?