ghc/includes/InfoTables.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: InfoTables.h,v 1.32 2003/11/14 14:28:08 stolz Exp $
   3  *
   4  * (c) The GHC Team, 1998-2002
   5  *
   6  * Info Tables
   7  *
   8  * -------------------------------------------------------------------------- */
   9
  10 #ifndef INFOTABLES_H
  11 #define INFOTABLES_H
  12
  13 /* -----------------------------------------------------------------------------
  14    Profiling info
  15    -------------------------------------------------------------------------- */
  16
  17 typedef struct {
  18     char *closure_type;
  19     char *closure_desc;
  20 } StgProfInfo;
  21
  22 /* -----------------------------------------------------------------------------
  23    Parallelism info
  24    -------------------------------------------------------------------------- */
  25
  26 #if 0 && (defined(PAR) || defined(GRAN))
  27
  28 // CURRENTLY UNUSED
  29 // ToDo: use this in StgInfoTable (mutually recursive) -- HWL
  30
  31 typedef struct {
  32   StgInfoTable *rbh_infoptr;     /* infoptr to the RBH  */
  33 } StgParInfo;
  34
  35 #endif /* 0 */
  36
  37 /*
  38    Copied from ghc-0.29; ToDo: check this code -- HWL
  39
  40    In the parallel system, all updatable closures have corresponding
  41    revertible black holes.  When we are assembly-mangling, we guarantee
  42    that the revertible black hole code precedes the normal entry code, so
  43    that the RBH info table resides at a fixed offset from the normal info
  44    table.  Otherwise, we add the RBH info table pointer to the end of the
  45    normal info table and vice versa.
  46
  47    Currently has to use a !RBH_MAGIC_OFFSET setting.
  48    Still todo: init of par.infoptr field in all infotables!!
  49 */
  50
  51 #if defined(PAR) || defined(GRAN)
  52
  53 # ifdef RBH_MAGIC_OFFSET
  54
  55 #  error magic offset not yet implemented
  56
  57 #  define RBH_INFO_WORDS    0
  58 #  define INCLUDE_RBH_INFO(infoptr)
  59
  60 #  define RBH_INFOPTR(infoptr)      (((P_)infoptr) - RBH_MAGIC_OFFSET)
  61 #  define REVERT_INFOPTR(infoptr)   (((P_)infoptr) + RBH_MAGIC_OFFSET)
  62
  63 # else
  64
  65 #  define RBH_INFO_WORDS    1
  66 #  define INCLUDE_RBH_INFO(info)    rbh_infoptr : &(info)
  67
  68 #  define RBH_INFOPTR(infoptr)      (((StgInfoTable *)(infoptr))->rbh_infoptr)
  69 #  define REVERT_INFOPTR(infoptr)   (((StgInfoTable *)(infoptr))->rbh_infoptr)
  70
  71 # endif
  72
  73 /* see ParallelRts.h */
  74 // EXTFUN(RBH_entry);
  75 //StgClosure *convertToRBH(StgClosure *closure);
  76 //#if defined(GRAN)
  77 //void convertFromRBH(StgClosure *closure);
  78 //#elif defined(PAR)
  79 //void convertToFetchMe(StgPtr closure, globalAddr *ga);
  80 //#endif
  81
  82 #endif
  83
  84 /* -----------------------------------------------------------------------------
  85    Ticky info
  86    -------------------------------------------------------------------------- */
  87
  88 #if defined(SUPPORTS_EMPTY_STRUCTS)
  89 typedef struct {
  90     /* empty */
  91 } StgTickyInfo;
  92 #endif
  93
  94 /* -----------------------------------------------------------------------------
  95    Debugging info
  96    -------------------------------------------------------------------------- */
  97
  98 #ifdef DEBUG_CLOSURE
  99
 100 typedef struct {
 101         ... whatever ...
 102 } StgDebugInfo;
 103
 104 #else /* !DEBUG_CLOSURE */
 105
 106 # if defined(SUPPORTS_EMPTY_STRUCTS)
 107 typedef struct StgDebugInfo {
 108         /* empty */
 109 } StgDebugInfo;
 110 # endif
 111
 112 #endif /* DEBUG_CLOSURE */
 113
 114 /* -----------------------------------------------------------------------------
 115    Closure flags
 116    -------------------------------------------------------------------------- */
 117
 118 /* The type flags provide quick access to certain properties of a closure. */
 119
 120 #define _HNF (1<<0)  /* head normal form?    */
 121 #define _BTM (1<<1)  /* bitmap-style layout? */
 122 #define _NS  (1<<2)  /* non-sparkable        */
 123 #define _STA (1<<3)  /* static?              */
 124 #define _THU (1<<4)  /* thunk?               */
 125 #define _MUT (1<<5)  /* mutable?             */
 126 #define _UPT (1<<6)  /* unpointed?           */
 127 #define _SRT (1<<7)  /* has an SRT?          */
 128 #define _IND (1<<8)  /* is an indirection?   */
 129
 130 #define isSTATIC(flags)    ((flags) &_STA)
 131 #define isMUTABLE(flags)   ((flags) &_MUT)
 132 #define isBITMAP(flags)    ((flags) &_BTM)
 133 #define isTHUNK(flags)     ((flags) &_THU)
 134 #define isUNPOINTED(flags) ((flags) &_UPT)
 135 #define hasSRT(flags)      ((flags) &_SRT)
 136
 137 extern StgWord16 closure_flags[];
 138
 139 #define closureFlags(c)         (closure_flags[get_itbl(c)->type])
 140
 141 #define closure_HNF(c)          (  closureFlags(c) & _HNF)
 142 #define closure_BITMAP(c)       (  closureFlags(c) & _BTM)
 143 #define closure_NON_SPARK(c)    ( (closureFlags(c) & _NS))
 144 #define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
 145 #define closure_STATIC(c)       (  closureFlags(c) & _STA)
 146 #define closure_THUNK(c)        (  closureFlags(c) & _THU)
 147 #define closure_MUTABLE(c)      (  closureFlags(c) & _MUT)
 148 #define closure_UNPOINTED(c)    (  closureFlags(c) & _UPT)
 149 #define closure_SRT(c)          (  closureFlags(c) & _SRT)
 150 #define closure_IND(c)          (  closureFlags(c) & _IND)
 151
 152 /* same as above but for info-ptr rather than closure */
 153 #define ipFlags(ip)             (closure_flags[ip->type])
 154
 155 #define ip_HNF(ip)               (  ipFlags(ip) & _HNF)
 156 #define ip_BITMAP(ip)            (  ipFlags(ip) & _BTM)
 157 #define ip_SHOULD_SPARK(ip)      (!(ipFlags(ip) & _NS))
 158 #define ip_STATIC(ip)            (  ipFlags(ip) & _STA)
 159 #define ip_THUNK(ip)             (  ipFlags(ip) & _THU)
 160 #define ip_MUTABLE(ip)           (  ipFlags(ip) & _MUT)
 161 #define ip_UNPOINTED(ip)         (  ipFlags(ip) & _UPT)
 162 #define ip_SRT(ip)               (  ipFlags(ip) & _SRT)
 163 #define ip_IND(ip)               (  ipFlags(ip) & _IND)
 164
 165 /* -----------------------------------------------------------------------------
 166    Bitmaps
 167
 168    These are used to describe the pointerhood of a sequence of words
 169    (usually on the stack) to the garbage collector.  The two primary
 170    uses are for stack frames, and functions (where we need to describe
 171    the layout of a PAP to the GC).
 172    -------------------------------------------------------------------------- */
 173
 174 //
 175 // Small bitmaps:  for a small bitmap, we store the size and bitmap in
 176 // the same word, using the following macros.  If the bitmap doesn't
 177 // fit in a single word, we use a pointer to an StgLargeBitmap below.
 178 //
 179 #define MK_SMALL_BITMAP(size,bits) (((bits)<<BITMAP_BITS_SHIFT) | (size))
 180
 181 #define BITMAP_SIZE(bitmap) ((bitmap) & BITMAP_SIZE_MASK)
 182 #define BITMAP_BITS(bitmap) ((bitmap) >> BITMAP_BITS_SHIFT)
 183
 184 //
 185 // A large bitmap.
 186 //
 187 typedef struct {
 188   StgWord size;
 189   StgWord bitmap[FLEXIBLE_ARRAY];
 190 } StgLargeBitmap;
 191
 192 /* -----------------------------------------------------------------------------
 193    SRTs  (Static Reference Tables)
 194
 195    These tables are used to keep track of the static objects referred
 196    to by the code for a closure or stack frame, so that we can follow
 197    static data references from code and thus accurately
 198    garbage-collect CAFs.
 199    -------------------------------------------------------------------------- */
 200
 201 // An SRT is just an array of closure pointers:
 202 typedef StgClosure* StgSRT[];
 203
 204 // Each info table refers to some subset of the closure pointers in an
 205 // SRT.  It does this using a pair of an StgSRT pointer and a
 206 // half-word bitmap.  If the half-word bitmap isn't large enough, then
 207 // we fall back to a large SRT, including an unbounded bitmap.  If the
 208 // half-word bitmap is set to all ones (0xffff), then the StgSRT
 209 // pointer instead points to an StgLargeSRT:
 210 typedef struct StgLargeSRT_ {
 211     StgSRT *srt;
 212     StgLargeBitmap l;
 213 } StgLargeSRT;
 214
 215 /* ----------------------------------------------------------------------------
 216    Info Tables
 217    ------------------------------------------------------------------------- */
 218
 219 //
 220 // Stuff describing the closure layout.  Well, actually, it might
 221 // contain the selector index for a THUNK_SELECTOR.  This union is one
 222 // word long.
 223 //
 224 typedef union {
 225     struct {                    // Heap closure payload layout:
 226         StgHalfWord ptrs;       // number of pointers
 227         StgHalfWord nptrs;      // number of non-pointers
 228     } payload;
 229
 230     StgWord bitmap;               // word-sized bit pattern describing
 231                                   //  a stack frame: see below
 232
 233     StgLargeBitmap* large_bitmap; // pointer to large bitmap structure
 234
 235     StgWord selector_offset;      // used in THUNK_SELECTORs
 236
 237 } StgClosureInfo;
 238
 239
 240 //
 241 // The "standard" part of an info table.  Every info table has this bit.
 242 //
 243 typedef struct _StgInfoTable {
 244
 245 #ifndef TABLES_NEXT_TO_CODE
 246     StgFunPtr       entry;      // pointer to the entry code
 247 #endif
 248
 249 #if defined(PAR) || defined(GRAN)
 250     struct _StgInfoTable    *rbh_infoptr;
 251 #endif
 252 #ifdef PROFILING
 253     StgProfInfo     prof;
 254 #endif
 255 #ifdef TICKY
 256     MAYBE_EMPTY_STRUCT(StgTickyInfo,ticky)
 257 #endif
 258 #ifdef DEBUG_CLOSURE
 259     MAYBE_EMPTY_STRUCT(StgDebugInfo,debug)
 260 #endif
 261
 262     StgClosureInfo  layout;     // closure layout info (one word)
 263
 264     StgHalfWord     type;       // closure type
 265     StgHalfWord     srt_bitmap;    // number of entries in SRT (or constructor tag)
 266
 267 #ifdef TABLES_NEXT_TO_CODE
 268     StgCode         code[FLEXIBLE_ARRAY];
 269 #endif
 270 } StgInfoTable;
 271
 272
 273 /* -----------------------------------------------------------------------------
 274    Function info tables
 275
 276    This is the general form of function info tables.  The compiler
 277    will omit some of the fields in common cases:
 278
 279    -  If fun_type is not ARG_GEN or ARG_GEN_BIG, then the slow_apply
 280       and bitmap fields may be left out (they are at the end, so omitting
 281       them doesn't affect the layout).
 282
 283    -  If srt_bitmap (in the std info table part) is zero, then the srt
 284       field may be omitted.  This only applies if the slow_apply and
 285       bitmap fields have also been omitted.
 286    -------------------------------------------------------------------------- */
 287
 288 typedef struct _StgFunInfoTable {
 289 #if defined(TABLES_NEXT_TO_CODE)
 290     StgFun         *slow_apply; // apply to args on the stack
 291     StgWord        bitmap;      // arg ptr/nonptr bitmap
 292     StgSRT         *srt;        // pointer to the SRT table
 293     StgHalfWord    fun_type;    // function type
 294     StgHalfWord    arity;       // function arity
 295     StgInfoTable i;
 296 #else
 297     StgInfoTable i;
 298     StgHalfWord    fun_type;    // function type
 299     StgHalfWord    arity;       // function arity
 300     StgSRT         *srt;        // pointer to the SRT table
 301     StgWord        bitmap;      // arg ptr/nonptr bitmap
 302     StgFun         *slow_apply; // apply to args on the stack
 303 #endif
 304 } StgFunInfoTable;
 305
 306 /* -----------------------------------------------------------------------------
 307    Return info tables
 308    -------------------------------------------------------------------------- */
 309
 310 // When info tables are laid out backwards, we can omit the SRT
 311 // pointer iff srt_bitmap is zero.
 312
 313 typedef struct _StgRetInfoTable {
 314 #if !defined(TABLES_NEXT_TO_CODE)
 315     StgInfoTable i;
 316 #endif
 317     StgSRT         *srt;        // pointer to the SRT table
 318 #if defined(TABLES_NEXT_TO_CODE)
 319     StgInfoTable i;
 320 #endif
 321 #if !defined(TABLES_NEXT_TO_CODE)
 322     StgFunPtr vector[FLEXIBLE_ARRAY];
 323 #endif
 324 } StgRetInfoTable;
 325
 326 /* -----------------------------------------------------------------------------
 327    Thunk info tables
 328    -------------------------------------------------------------------------- */
 329
 330 // When info tables are laid out backwards, we can omit the SRT
 331 // pointer iff srt_bitmap is zero.
 332
 333 typedef struct _StgThunkInfoTable {
 334 #if !defined(TABLES_NEXT_TO_CODE)
 335     StgInfoTable i;
 336 #endif
 337     StgSRT         *srt;        // pointer to the SRT table
 338 #if defined(TABLES_NEXT_TO_CODE)
 339     StgInfoTable i;
 340 #endif
 341 } StgThunkInfoTable;
 342
 343 #endif /* INFOTABLES_H */