ghc/includes/InfoTables.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: InfoTables.h,v 1.19 2000/04/05 15:27:59 simonmar Exp $
   3  *
   4  * (c) The GHC Team, 1998-1999
   5  *
   6  * Info Tables
   7  *
   8  * -------------------------------------------------------------------------- */
   9
  10 #ifndef INFOTABLES_H
  11 #define INFOTABLES_H
  12
  13 /* -----------------------------------------------------------------------------
  14    Profiling info
  15    -------------------------------------------------------------------------- */
  16
  17 #ifdef PROFILING
  18
  19 typedef struct {
  20     char *closure_type;
  21     char *closure_desc;
  22 } StgProfInfo;
  23
  24 #else /* !PROFILING */
  25
  26 typedef struct {
  27   /* empty */
  28 } StgProfInfo;
  29
  30 #endif /* PROFILING */
  31
  32 /* -----------------------------------------------------------------------------
  33    Parallelism info
  34    -------------------------------------------------------------------------- */
  35
  36 #if 0 && (defined(PAR) || defined(GRAN))
  37
  38 // CURRENTLY UNUSED
  39 // ToDo: use this in StgInfoTable (mutually recursive) -- HWL
  40
  41 typedef struct {
  42   StgInfoTable *rbh_infoptr;     /* infoptr to the RBH  */
  43 } StgParInfo;
  44
  45 #else /* !PAR */
  46
  47 typedef struct {
  48         /* empty */
  49 } StgParInfo;
  50
  51 #endif /* PAR */
  52
  53 /*
  54    Copied from ghc-0.29; ToDo: check this code -- HWL
  55
  56    In the parallel system, all updatable closures have corresponding
  57    revertible black holes.  When we are assembly-mangling, we guarantee
  58    that the revertible black hole code precedes the normal entry code, so
  59    that the RBH info table resides at a fixed offset from the normal info
  60    table.  Otherwise, we add the RBH info table pointer to the end of the
  61    normal info table and vice versa.
  62
  63    Currently has to use a !RBH_MAGIC_OFFSET setting.
  64    Still todo: init of par.infoptr field in all infotables!!
  65 */
  66
  67 #if defined(PAR) || defined(GRAN)
  68
  69 # ifdef RBH_MAGIC_OFFSET
  70
  71 #  error magic offset not yet implemented
  72
  73 #  define RBH_INFO_WORDS    0
  74 #  define INCLUDE_RBH_INFO(infoptr)
  75
  76 #  define RBH_INFOPTR(infoptr)      (((P_)infoptr) - RBH_MAGIC_OFFSET)
  77 #  define REVERT_INFOPTR(infoptr)   (((P_)infoptr) + RBH_MAGIC_OFFSET)
  78
  79 # else
  80
  81 #  define RBH_INFO_WORDS    1
  82 #  define INCLUDE_RBH_INFO(info)    rbh_infoptr : &(info)
  83
  84 #  define RBH_INFOPTR(infoptr)      (((StgInfoTable *)(infoptr))->rbh_infoptr)
  85 #  define REVERT_INFOPTR(infoptr)   (((StgInfoTable *)(infoptr))->rbh_infoptr)
  86
  87 # endif
  88
  89 /* see ParallelRts.h */
  90 // EXTFUN(RBH_entry);
  91 //StgClosure *convertToRBH(StgClosure *closure);
  92 //#if defined(GRAN)
  93 //void convertFromRBH(StgClosure *closure);
  94 //#elif defined(PAR)
  95 //void convertToFetchMe(StgPtr closure, globalAddr *ga);
  96 //#endif
  97
  98 #endif
  99
 100 /* -----------------------------------------------------------------------------
 101    Debugging info
 102    -------------------------------------------------------------------------- */
 103
 104 #ifdef DEBUG_CLOSURE
 105
 106 typedef struct {
 107         ... whatever ...
 108 } StgDebugInfo;
 109
 110 #else /* !DEBUG_CLOSURE */
 111
 112 typedef struct {
 113         /* empty */
 114 } StgDebugInfo;
 115
 116 #endif /* DEBUG_CLOSURE */
 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
 129 #define isSTATIC(flags)    ((flags) &_STA)
 130 #define isMUTABLE(flags)   ((flags) &_MUT)
 131 #define isBITMAP(flags)    ((flags) &_BTM)
 132 #define isTHUNK(flags)     ((flags) &_THU)
 133 #define isUNPOINTED(flags) ((flags) &_UPT)
 134 #define hasSRT(flags)      ((flags) &_SRT)
 135
 136 extern StgWord16 closure_flags[];
 137
 138 #define closureFlags(c)         (closure_flags[get_itbl(c)->type])
 139
 140 #define closure_HNF(c)          (  closureFlags(c) & _HNF)
 141 #define closure_BITMAP(c)       (  closureFlags(c) & _BTM)
 142 #define closure_NON_SPARK(c)    ( (closureFlags(c) & _NS))
 143 #define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
 144 #define closure_STATIC(c)       (  closureFlags(c) & _STA)
 145 #define closure_THUNK(c)        (  closureFlags(c) & _THU)
 146 #define closure_MUTABLE(c)      (  closureFlags(c) & _MUT)
 147 #define closure_UNPOINTED(c)    (  closureFlags(c) & _UPT)
 148 #define closure_SRT(c)          (  closureFlags(c) & _SRT)
 149
 150 /* same as above but for info-ptr rather than closure */
 151 #define ipFlags(ip)             (closure_flags[ip->type])
 152
 153 #define ip_HNF(ip)               (  ipFlags(ip) & _HNF)
 154 #define ip_BITMAP(ip)            (  ipFlags(ip) & _BTM)
 155 #define ip_SHOULD_SPARK(ip)      (!(ipFlags(ip) & _NS))
 156 #define ip_STATIC(ip)            (  ipFlags(ip) & _STA)
 157 #define ip_THUNK(ip)             (  ipFlags(ip) & _THU)
 158 #define ip_MUTABLE(ip)           (  ipFlags(ip) & _MUT)
 159 #define ip_UNPOINTED(ip)         (  ipFlags(ip) & _UPT)
 160 #define ip_SRT(ip)               (  ipFlags(ip) & _SRT)
 161
 162 /* -----------------------------------------------------------------------------
 163    Info Tables
 164    -------------------------------------------------------------------------- */
 165
 166 /* A large bitmap.  Small 32-bit ones live in the info table, but sometimes
 167  * 32 bits isn't enough and we have to generate a larger one.  (sizes
 168  * differ for 64-bit machines.
 169  */
 170
 171 typedef struct {
 172   StgWord size;
 173   StgWord bitmap[0];
 174 } StgLargeBitmap;
 175
 176 /*
 177  * Stuff describing the closure layout.  Well, actually, it might
 178  * contain the selector index for a THUNK_SELECTOR.  If we're on a
 179  * 64-bit architecture then we can enlarge some of these fields, since
 180  * the union contains a pointer field.
 181  */
 182
 183 typedef union {
 184   struct {
 185 #if SIZEOF_VOID_P == 8
 186     StgWord32 ptrs;             /* number of pointers     */
 187     StgWord32 nptrs;            /* number of non-pointers */
 188 #else
 189     StgWord16 ptrs;             /* number of pointers     */
 190     StgWord16 nptrs;            /* number of non-pointers */
 191 #endif
 192   } payload;
 193
 194   StgWord bitmap;               /* bit pattern, 1 = pointer, 0 = non-pointer */
 195   StgWord selector_offset;      /* used in THUNK_SELECTORs */
 196   StgLargeBitmap* large_bitmap; /* pointer to large bitmap structure */
 197
 198 } StgClosureInfo;
 199
 200 /*
 201  * Info tables.  All info tables are the same type, to simplify code
 202  * generation.  However, the mangler removes any unused SRT fields
 203  * from the asm to save space (convention: if srt_len is zero, or the
 204  * type is a CONSTR_ type, then the SRT field isn't present.
 205  */
 206
 207 typedef StgClosure* StgSRT[];
 208
 209 typedef struct _StgInfoTable {
 210     StgSRT         *srt;        /* pointer to the SRT table */
 211 #if defined(PAR) || defined(GRAN)
 212     struct _StgInfoTable    *rbh_infoptr;
 213 #endif
 214 #ifdef PROFILING
 215     StgProfInfo     prof;
 216 #endif
 217 #ifdef DEBUG_CLOSURE
 218     StgDebugInfo    debug;
 219 #endif
 220     StgClosureInfo  layout;     /* closure layout info (pointer-sized) */
 221 #if SIZEOF_VOID_P == 8
 222     StgWord32       type;       /* } These 2 elements fit into 64 bits */
 223     StgWord32       srt_len;    /* }                                   */
 224 #else
 225     StgWord         type : 16;  /* } These 2 elements fit into 32 bits */
 226     StgWord         srt_len : 16; /* }                                   */
 227 #endif
 228 #ifdef TABLES_NEXT_TO_CODE
 229     StgCode         code[0];
 230 #else
 231     StgFunPtr       entry;
 232     StgFunPtr       vector[0];
 233 #endif
 234 } StgInfoTable;
 235
 236 /* Info tables are read-only, therefore we uniformly declare them with
 237  * C's const attribute.  This isn't just a nice thing to do: it's
 238  * necessary because the garbage collector has to distinguish between
 239  * closure pointers and info table pointers when traversing the
 240  * stack.  We distinguish the two by checking whether the pointer is
 241  * into text-space or not.
 242  */
 243
 244 #define INFO_TBL_CONST  const
 245
 246 #endif /* INFOTABLES_H */