GHC Commentary: The Compiler

The compiler itself is written entirely in Haskell, and lives in the many sub-directories of the compiler directory.

• Compiler Module Dependencies (deals with the arcane mutual recursions among GHC's many data types)
• Coding guidelines

• Compiling one module: HscMain
  • Overview gives the big picture.
  • Some details of the parser
  • Some details of the renamer
  • Some details of the code generator
  • A guide to the generated assembly code

• Key data types
  • The source language: HsSyn
  • RdrNames, Modules, and OccNames
  • Names
  • Entities: variables, type constructors, data constructors, and classes.
  • Types: Type and Kind, equality types and coercions
  • The core language
  • The STG language
  • The Cmm language
  • Back end types

• The GHC API
• Symbol names and the Z-encoding
• Template Haskell?
• Wired-in and known-key things
• Packages
• The Finder?
• Recompilation Avoidance
• Backends:
  • C code generator
  • Native code generator
  • LLVM backend

Overall Structure

Here is a block diagram of its top-level structure:

The part called HscMain? deals with compiling a single module. On top of this is built the compilation manager (in blue) that manages the compilation of multiple modules. It exports an interface called the GHC API. On top of this API are four small front ends:

• GHCi, the interactive environment, is implemented in compiler/ghci/InteractiveUI.hs and sits squarely on top of the GHC API.

• --make is almost a trivial client of the GHC API, and is implemented in compiler/main/Main.hs.

• -M, the Makefile dependency generator, is also a client of the GHC API and is implemented in compiler/main/DriverMkDepend.hs.

• The "one-shot" mode, where GHC compiles each file on the command line separately (eg. ghc -c Foo.hs). This mode bypasses the GHC API, and is implemented directly on top of HscMain, since it compiles only one file at a time. In fact, this is all that GHC consisted of prior to version 5.00 when GHCi and --make were introduced.

GHC is packaged as a single binary in which all of these front-ends are present, selected by the command-line flags indicated above. There is a single command-line interface implemented in compiler/main/Main.hs.

In adition, GHC is compiled, without its front ends, as a library which can be imported by any Haskell program; see the GHC API.