includes/README

   1 -----------------------------------------------------------------------------
   2 The External API to the GHC Runtime System.
   3 -----------------------------------------------------------------------------
   4
   5 The header files in this directory form the external API for the
   6 runtime.  The header files are used in the following scenarios:
   7
   8   1. Included into the RTS source code itself.
   9         In this case we include "Rts.h", which includes everything
  10         else in the appropriate order.
  11
  12         Pretty much everything falls into this category.
  13
  14   2. Included into a .hc file generated by the compiler.
  15         In this case we include Stg.h, which includes a
  16         subset of the headers, in the appropriate order and
  17         with the appropriate settings (e.g. global register variables
  18         turned on).
  19
  20         Includes everything below Stg.h in the hierarchy (see below).
  21
  22   3. Included into external C source code.
  23         The following headers are designed to be included into
  24         external C  code (i.e. C code compiled using a GHC installation,
  25         not part of GHC itself or the RTS):
  26
  27                 HsFFI.h
  28                 RtsAPI.h
  29                 SchedAPI.h
  30                 RtsFlags.h
  31                 Linker.h
  32
  33         These interfaces are intended to be relatively stable.
  34
  35         Also Rts.h can be included to get hold of everything else, including
  36         definitions of heap objects, info tables, the storage manager interface
  37         and so on.  But be warned: none of this is guaranteed to remain stable
  38         from one GHC release to the next.
  39
  40   4. Included into non-C source code, including Haskell (GHC itself)
  41      and C-- code in the RTS.
  42
  43         The following headers are #included into non-C source, so
  44         cannot contain any C code or declarations:
  45                 config.h
  46                 RtsConfig.h
  47                 Constants.h
  48                 DerivedConstants.h
  49                 ClosureTypes.h
  50                 StgFun.h
  51                 MachRegs.h
  52                 Liveness.h
  53                 StgLdvProf.h
  54
  55 Here is a rough hierarchy of the header files by dependency.
  56
  57 Rts.h
  58   Stg.h
  59     ghcconfig.h         /* configuration info derived by the configure script. */
  60     RtsConfig.h         /* settings for Rts things (eg. eager vs. lazy BH) */
  61     MachDeps.h          /* sizes of various basic types */
  62     StgTypes.h          /* basic types specific to the virtual machine */
  63     TailCalls.h         /* tail calls in .hc code */
  64     StgDLL.h            /* stuff related to Windows DLLs */
  65     MachRegs.h          /* global register assignments for this arch */
  66     Regs.h              /* "registers" in the virtual machine */
  67     StgMiscClosures.h   /* decls for closures & info tables in the RTS */
  68     SMP.h               /* basic primitives for synchronisation */
  69
  70   RtsTypes.h            /* types used in the RTS */
  71
  72   Constants.h           /* build-time constants */
  73   StgLdvProf.h
  74   StgFun.h
  75   StgProf.h             /* profiling gubbins */
  76   Closures.h
  77   Liveness.h            /* macros for constructing RET_DYN liveness masks */
  78   ClosureMacros.h
  79   ClosureTypes.h
  80   InfoTables.h
  81   SMPClosureOps.h       /* lockClosure/unlockClosure etc. */
  82   SpinLock.h
  83   TSO.h
  84   Updates.h             /* macros for performing updates */
  85   GranSim.h
  86   Parallel.h
  87   Block.h
  88   Stable.h
  89   Hooks.h
  90   Signals.h
  91   DNInvoke.h
  92     Dotnet.h
  93   RtsExternal.h         /* decls for RTS things required by .hc code */
  94     (RtsAPI.h)
  95     (HsFFI.h)
  96
  97 Cmm.h                   /* included into .cmm source only */
  98   DerivedConstants.h    /* generated by mkDerivedConstants.c from other */
  99                         /* .h files. */
 100   (Constants.h)
 101   (ClosureTypes.h)
 102   (StgFun.h)
 103   (MachRegs.h)
 104   (Liveness.h)
 105   (Block.h)
 106
 107 Bytecodes.h     /* Bytecode definitions for the interpreter */
 108 Linker.h        /* External API to the linker */
 109 RtsFlags.h      /* External API to the RTS runtime flags */
 110 SchedAPI.h      /* External API to the RTS scheduler */
 111 ieee-flpt.h     /* ToDo: needed? */
 112
 113 RtsAPI.h        /* The top-level interface to the RTS (rts_evalIO(), etc.) */
 114 HsFFI.h         /* The external FFI api */