ghc/includes/InfoTables.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: InfoTables.h,v 1.3 1999/01/13 17:25:53 simonm Exp $
   3  *
   4  * Info Tables
   5  *
   6  * -------------------------------------------------------------------------- */
   7
   8 #ifndef INFOTABLES_H
   9 #define INFOTABLES_H
  10
  11 /* -----------------------------------------------------------------------------
  12    Profiling info
  13    -------------------------------------------------------------------------- */
  14
  15 #ifdef PROFILING
  16
  17 #define PROF_INFO_WORDS n
  18
  19 typedef struct {
  20   /* nothing yet */
  21 } StgProfInfo;
  22
  23 #else /* !PROFILING */
  24
  25 #define PROF_INFO_WORDS 0
  26
  27 typedef struct {
  28   /* empty */
  29 } StgProfInfo;
  30
  31 #endif /* PROFILING */
  32
  33 /* -----------------------------------------------------------------------------
  34    Parallelism info
  35    -------------------------------------------------------------------------- */
  36
  37 #ifdef PAR
  38
  39 #define PAR_INFO_WORDS 0
  40
  41 typedef struct {
  42        /* empty */
  43 } StgParInfo;
  44
  45 #else /* !PAR */
  46
  47 #define PAR_INFO_WORDS 0
  48
  49 typedef struct {
  50         /* empty */
  51 } StgParInfo;
  52
  53 #endif /* PAR */
  54
  55 /* -----------------------------------------------------------------------------
  56    Debugging info
  57    -------------------------------------------------------------------------- */
  58
  59 #ifdef DEBUG_CLOSURE
  60
  61 #define DEBUG_INFO_WORDS n
  62
  63 typedef struct {
  64         ... whatever ...
  65 } StgDebugInfo;
  66
  67 #else /* !DEBUG_CLOSURE */
  68
  69 #define DEBUG_INFO_WORDS 0
  70
  71 typedef struct {
  72         /* empty */
  73 } StgDebugInfo;
  74
  75 #endif /* DEBUG_CLOSURE */
  76
  77 /* -----------------------------------------------------------------------------
  78    Closure Types
  79
  80    If you add or delete any closure types, don't forget to update
  81    ClosureTypes.h for the native code generator.  This is a temporary
  82    measure (I hope).
  83    -------------------------------------------------------------------------- */
  84
  85 typedef enum {
  86
  87     INVALID_OBJECT /* Object tag 0 raises an internal error */
  88     , CONSTR
  89     /* CONSTR_p_np */
  90     , CONSTR_INTLIKE
  91     , CONSTR_CHARLIKE
  92     , CONSTR_STATIC
  93     , CONSTR_NOCAF_STATIC
  94
  95     , FUN
  96     , FUN_STATIC
  97
  98     , THUNK
  99     /* THUNK_p_np */
 100     , THUNK_STATIC
 101     , THUNK_SELECTOR
 102
 103     , BCO
 104     , AP_UPD
 105
 106     , PAP  /* should be called AP_NUPD */
 107
 108     , IND
 109     , IND_OLDGEN
 110     , IND_PERM
 111     , IND_OLDGEN_PERM
 112     , IND_STATIC
 113
 114     , CAF_UNENTERED
 115     , CAF_ENTERED
 116     , CAF_BLACKHOLE
 117
 118     , RET_BCO
 119     , RET_SMALL
 120     , RET_VEC_SMALL
 121     , RET_BIG
 122     , RET_VEC_BIG
 123     , RET_DYN
 124     , UPDATE_FRAME
 125     , CATCH_FRAME
 126     , STOP_FRAME
 127     , SEQ_FRAME
 128
 129     , BLACKHOLE
 130     , MVAR
 131
 132     , ARR_WORDS
 133
 134     , MUT_ARR_WORDS
 135     , MUT_ARR_PTRS
 136     , MUT_ARR_PTRS_FROZEN
 137     , MUT_VAR
 138
 139     , WEAK
 140     , FOREIGN
 141
 142     , TSO
 143
 144     , BLOCKED_FETCH
 145     , FETCH_ME
 146
 147     , EVACUATED
 148
 149     , N_CLOSURE_TYPES           /* number of distinct closure types */
 150
 151 } StgClosureType;
 152
 153 /* The type flags provide quick access to certain properties of a closure. */
 154
 155 #define _HNF (1<<0)  /* head normal form?  */
 156 #define _BTM (1<<1)  /* bitmap-style layout? */
 157 #define _NS  (1<<2)  /* non-sparkable      */
 158 #define _STA (1<<3)  /* static?            */
 159 #define _THU (1<<4)  /* thunk?             */
 160 #define _MUT (1<<5)  /* mutable?           */
 161 #define _UPT (1<<6)  /* unpointed?         */
 162 #define _SRT (1<<7)  /* has an SRT?        */
 163
 164 #define isSTATIC(flags)  ((flags)&_STA)
 165 #define isMUTABLE(flags) ((flags) &_MUT)
 166
 167 #define closure_STATIC(closure)       (  get_itbl(closure)->flags & _STA)
 168 #define closure_SHOULD_SPARK(closure) (!(get_itbl(closure)->flags & _NS))
 169 #define closure_MUTABLE(closure)      (  get_itbl(closure)->flags & _MUT)
 170 #define closure_UNPOINTED(closure)    (  get_itbl(closure)->flags & _UPT)
 171
 172 /*                                  HNF  BTM   NS  STA  THU MUT UPT SRT */
 173
 174 #define FLAGS_CONSTR               (_HNF|     _NS                        )
 175 #define FLAGS_CONSTR_STATIC        (_HNF|     _NS|_STA                   )
 176 #define FLAGS_CONSTR_NOCAF_STATIC  (_HNF|     _NS|_STA                   )
 177 #define FLAGS_FUN                  (_HNF|     _NS|                  _SRT )
 178 #define FLAGS_FUN_STATIC           (_HNF|     _NS|_STA|             _SRT )
 179 #define FLAGS_THUNK                (     _BTM|         _THU|        _SRT )
 180 #define FLAGS_THUNK_STATIC         (     _BTM|    _STA|_THU|        _SRT )
 181 #define FLAGS_THUNK_SELECTOR       (     _BTM|         _THU|        _SRT )
 182 #define FLAGS_BCO                  (_HNF|     _NS                        )
 183 #define FLAGS_CAF_UNENTERED        0 /* Do we still use these? */
 184 #define FLAGS_CAF_ENTERED          0
 185 #define FLAGS_CAF_BLACKHOLE        (     _BTM|_NS|              _UPT     )
 186 #define FLAGS_AP_UPD               (     _BTM|         _THU              )
 187 #define FLAGS_PAP                  (_HNF|     _NS                        )
 188 #define FLAGS_IND                  0
 189 #define FLAGS_IND_OLDGEN           0
 190 #define FLAGS_IND_PERM             0
 191 #define FLAGS_IND_OLDGEN_PERM      0
 192 #define FLAGS_IND_STATIC           (              _STA                   )
 193 #define FLAGS_EVACUATED            0
 194 #define FLAGS_ARR_WORDS            (_HNF|     _NS|              _UPT     )
 195 #define FLAGS_MUT_ARR_WORDS        (_HNF|     _NS|         _MUT|_UPT     )
 196 #define FLAGS_MUT_ARR_PTRS         (_HNF|     _NS|         _MUT|_UPT     )
 197 #define FLAGS_MUT_ARR_PTRS_FROZEN  (_HNF|     _NS|         _MUT|_UPT     )
 198 #define FLAGS_MUT_VAR              (_HNF|     _NS|         _MUT|_UPT     )
 199 #define FLAGS_FOREIGN              (_HNF|     _NS|              _UPT     )
 200 #define FLAGS_WEAK                 (_HNF|     _NS|              _UPT     )
 201 #define FLAGS_BLACKHOLE            (          _NS|              _UPT     )
 202 #define FLAGS_MVAR                 (_HNF|     _NS|         _MUT|_UPT     )
 203 #define FLAGS_FETCH_ME             (_HNF|     _NS                        )
 204 #define FLAGS_TSO                  (_HNF|     _NS|         _MUT|_UPT     )
 205 #define FLAGS_RET_BCO              (     _BTM                            )
 206 #define FLAGS_RET_SMALL            (     _BTM|                       _SRT)
 207 #define FLAGS_RET_VEC_SMALL        (     _BTM|                       _SRT)
 208 #define FLAGS_RET_BIG              (                                 _SRT)
 209 #define FLAGS_RET_VEC_BIG          (                                 _SRT)
 210 #define FLAGS_RET_DYN              (                                 _SRT)
 211 #define FLAGS_CATCH_FRAME          (     _BTM                            )
 212 #define FLAGS_STOP_FRAME           (     _BTM                            )
 213 #define FLAGS_SEQ_FRAME            (     _BTM                            )
 214 #define FLAGS_UPDATE_FRAME         (     _BTM                            )
 215
 216 /* -----------------------------------------------------------------------------
 217    Info Tables
 218    -------------------------------------------------------------------------- */
 219
 220 /* A large bitmap.  Small 32-bit ones live in the info table, but sometimes
 221  * 32 bits isn't enough and we have to generate a larger one.  (sizes
 222  * differ for 64-bit machines.
 223  */
 224
 225 typedef struct {
 226   StgWord size;
 227   StgWord bitmap[0];
 228 } StgLargeBitmap;
 229
 230 /*
 231  * Stuff describing the closure layout.  Well, actually, it might
 232  * contain the selector index for a THUNK_SELECTOR.  If we're on a
 233  * 64-bit architecture then we can enlarge some of these fields, since
 234  * the union contains a pointer field.
 235  */
 236
 237 typedef union {
 238
 239   StgWord bitmap;               /* bit pattern, 1 = pointer, 0 = non-pointer */
 240   StgWord selector_offset;      /* used in THUNK_SELECTORs */
 241   StgLargeBitmap* large_bitmap; /* pointer to large bitmap structure */
 242
 243 #if SIZEOF_VOID_P == 8
 244   struct {
 245     StgNat32 ptrs;              /* number of pointers     */
 246     StgNat32 nptrs;             /* number of non-pointers */
 247   } payload;
 248 #else
 249   struct {
 250     StgNat16 ptrs;              /* number of pointers     */
 251     StgNat16 nptrs;             /* number of non-pointers */
 252   } payload;
 253 #endif
 254
 255 } StgClosureInfo;
 256
 257 /*
 258  * Info tables.  All info tables are the same type, to simplify code
 259  * generation.  However, the mangler removes any unused SRT fields
 260  * from the asm to save space (convention: if srt_len is zero, or the
 261  * type is a CONSTR_ type, then the SRT field isn't present.
 262  */
 263
 264 typedef StgClosure* StgSRT[];
 265
 266 typedef struct _StgInfoTable {
 267     StgSRT         *srt;        /* pointer to the SRT table */
 268     StgParInfo      par;
 269     StgProfInfo     prof;
 270     StgDebugInfo    debug;
 271     StgClosureInfo  layout;     /* closure layout info (pointer-sized) */
 272 #if SIZEOF_VOID_P == 8
 273     StgNat16        flags;      /* }                                   */
 274     StgClosureType  type : 16;  /* } These 4 elements fit into 64 bits */
 275     StgNat32        srt_len;    /* }                                   */
 276 #else
 277     StgNat8         flags;      /* }                                   */
 278     StgClosureType  type : 8;   /* } These 4 elements fit into 32 bits */
 279     StgNat16        srt_len;    /* }                                   */
 280 #endif
 281 #if USE_MINIINTERPRETER
 282     StgFunPtr       (*vector)[];
 283     StgFunPtr       entry;
 284 #else
 285     StgCode         code[0];
 286 #endif
 287 } StgInfoTable;
 288
 289 #endif /* INFOTABLES_H */