InfoTables.h 13.2 KB
Newer Older
1
/* ----------------------------------------------------------------------------
2
 *
3
 * (c) The GHC Team, 1998-2002
4
 *
5 6 7 8
 * Info Tables
 *
 * -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
9 10
#ifndef RTS_STORAGE_INFOTABLES_H
#define RTS_STORAGE_INFOTABLES_H
11

Simon Marlow's avatar
Simon Marlow committed
12 13 14 15 16 17
/* ----------------------------------------------------------------------------
   Relative pointers

   Several pointer fields in info tables are expressed as offsets
   relative to the info pointer, so that we can generate
   position-independent code.
18 19 20 21 22 23 24 25 26 27 28

   Note [x86-64-relative]
   There is a complication on the x86_64 platform, where pointers are
   64 bits, but the tools don't support 64-bit relative relocations.
   However, the default memory model (small) ensures that all symbols
   have values in the lower 2Gb of the address space, so offsets all
   fit in 32 bits.  Hence we can use 32-bit offset fields.

   Somewhere between binutils-2.16.1 and binutils-2.16.91.0.6,
   support for 64-bit PC-relative relocations was added, so maybe this
   hackery can go away sometime.
Simon Marlow's avatar
Simon Marlow committed
29 30 31
   ------------------------------------------------------------------------- */

#if x86_64_TARGET_ARCH
32
#define OFFSET_FIELD(n) StgHalfInt n; StgHalfWord __pad_##n
33
#else
34
#define OFFSET_FIELD(n) StgInt n
Simon Marlow's avatar
Simon Marlow committed
35 36
#endif

37 38 39 40 41
/* -----------------------------------------------------------------------------
   Profiling info
   -------------------------------------------------------------------------- */

typedef struct {
Simon Marlow's avatar
Simon Marlow committed
42
#ifndef TABLES_NEXT_TO_CODE
43 44
    char *closure_type;
    char *closure_desc;
Simon Marlow's avatar
Simon Marlow committed
45 46 47 48
#else
    OFFSET_FIELD(closure_type_off);
    OFFSET_FIELD(closure_desc_off);
#endif
49 50
} StgProfInfo;

51 52 53 54
/* -----------------------------------------------------------------------------
   Closure flags
   -------------------------------------------------------------------------- */

55 56
/* The type flags provide quick access to certain properties of a closure. */

57
#define _HNF (1<<0)  /* head normal form?    */
58
#define _BTM (1<<1)  /* uses info->layout.bitmap */
59 60 61 62 63 64 65
#define _NS  (1<<2)  /* non-sparkable        */
#define _STA (1<<3)  /* static?              */
#define _THU (1<<4)  /* thunk?               */
#define _MUT (1<<5)  /* mutable?             */
#define _UPT (1<<6)  /* unpointed?           */
#define _SRT (1<<7)  /* has an SRT?          */
#define _IND (1<<8)  /* is an indirection?   */
66

67 68 69 70 71 72
#define isSTATIC(flags)    ((flags) &_STA)
#define isMUTABLE(flags)   ((flags) &_MUT)
#define isBITMAP(flags)    ((flags) &_BTM)
#define isTHUNK(flags)     ((flags) &_THU)
#define isUNPOINTED(flags) ((flags) &_UPT)
#define hasSRT(flags)      ((flags) &_SRT)
73

74 75
extern StgWord16 closure_flags[];

76 77
#define closureFlags(c)         (closure_flags[get_itbl \
                                    (UNTAG_CONST_CLOSURE(c))->type])
78

79 80
#define closure_HNF(c)          (  closureFlags(c) & _HNF)
#define closure_BITMAP(c)       (  closureFlags(c) & _BTM)
81
#define closure_NON_SPARK(c)    ( (closureFlags(c) & _NS))
82
#define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
83 84
#define closure_STATIC(c)       (  closureFlags(c) & _STA)
#define closure_THUNK(c)        (  closureFlags(c) & _THU)
85 86
#define closure_MUTABLE(c)      (  closureFlags(c) & _MUT)
#define closure_UNPOINTED(c)    (  closureFlags(c) & _UPT)
87
#define closure_SRT(c)          (  closureFlags(c) & _SRT)
88
#define closure_IND(c)          (  closureFlags(c) & _IND)
89 90 91

/* same as above but for info-ptr rather than closure */
#define ipFlags(ip)             (closure_flags[ip->type])
92

93
#define ip_HNF(ip)               (  ipFlags(ip) & _HNF)
94 95 96 97 98 99 100 101
#define ip_BITMAP(ip)            (  ipFlags(ip) & _BTM)
#define ip_SHOULD_SPARK(ip)      (!(ipFlags(ip) & _NS))
#define ip_STATIC(ip)            (  ipFlags(ip) & _STA)
#define ip_THUNK(ip)             (  ipFlags(ip) & _THU)
#define ip_MUTABLE(ip)           (  ipFlags(ip) & _MUT)
#define ip_UNPOINTED(ip)         (  ipFlags(ip) & _UPT)
#define ip_SRT(ip)               (  ipFlags(ip) & _SRT)
#define ip_IND(ip)               (  ipFlags(ip) & _IND)
102 103

/* -----------------------------------------------------------------------------
104 105 106 107 108 109
   Bitmaps

   These are used to describe the pointerhood of a sequence of words
   (usually on the stack) to the garbage collector.  The two primary
   uses are for stack frames, and functions (where we need to describe
   the layout of a PAP to the GC).
110 111

   In these bitmaps: 0 == ptr, 1 == non-ptr.
112 113
   -------------------------------------------------------------------------- */

114
/*
115
 * Small bitmaps:  for a small bitmap, we store the size and bitmap in
116 117 118
 * the same word, using the following macros.  If the bitmap doesn't
 * fit in a single word, we use a pointer to an StgLargeBitmap below.
 */
119 120 121 122
#define MK_SMALL_BITMAP(size,bits) (((bits)<<BITMAP_BITS_SHIFT) | (size))

#define BITMAP_SIZE(bitmap) ((bitmap) & BITMAP_SIZE_MASK)
#define BITMAP_BITS(bitmap) ((bitmap) >> BITMAP_BITS_SHIFT)
123

124 125 126
/*
 * A large bitmap.
 */
127
typedef struct {
128
  StgWord size;
129
  StgWord bitmap[];
130 131
} StgLargeBitmap;

132 133 134 135 136 137 138 139 140
/* -----------------------------------------------------------------------------
   SRTs  (Static Reference Tables)

   These tables are used to keep track of the static objects referred
   to by the code for a closure or stack frame, so that we can follow
   static data references from code and thus accurately
   garbage-collect CAFs.
   -------------------------------------------------------------------------- */

141
/* An SRT is just an array of closure pointers: */
142 143
typedef StgClosure* StgSRT[];

144 145 146 147 148 149 150 151
/*
 * Each info table refers to some subset of the closure pointers in an
 * SRT.  It does this using a pair of an StgSRT pointer and a
 * half-word bitmap.  If the half-word bitmap isn't large enough, then
 * we fall back to a large SRT, including an unbounded bitmap.  If the
 * half-word bitmap is set to all ones (0xffff), then the StgSRT
 * pointer instead points to an StgLargeSRT:
 */
152 153 154 155 156
typedef struct StgLargeSRT_ {
    StgSRT *srt;
    StgLargeBitmap l;
} StgLargeSRT;

157 158 159
/* ----------------------------------------------------------------------------
   Info Tables
   ------------------------------------------------------------------------- */
160

161 162 163 164 165
/*
 * Stuff describing the closure layout.  Well, actually, it might
 * contain the selector index for a THUNK_SELECTOR.  This union is one
 * word long.
 */
166
typedef union {
167 168 169
    struct {                    /* Heap closure payload layout: */
        StgHalfWord ptrs;       /* number of pointers */
        StgHalfWord nptrs;      /* number of non-pointers */
170
    } payload;
171 172 173

    StgWord bitmap;               /* word-sized bit pattern describing */
                                  /*  a stack frame: see below */
174

175
#ifndef TABLES_NEXT_TO_CODE
176
    StgLargeBitmap* large_bitmap; /* pointer to large bitmap structure */
177
#else
178
    OFFSET_FIELD(large_bitmap_offset);  /* offset from info table to large bitmap structure */
179
#endif
180 181

    StgWord selector_offset;      /* used in THUNK_SELECTORs */
sof's avatar
sof committed
182

183 184 185
} StgClosureInfo;


186 187 188
/*
 * The "standard" part of an info table.  Every info table has this bit.
 */
Simon Marlow's avatar
Simon Marlow committed
189
typedef struct StgInfoTable_ {
190

191
#if !defined(TABLES_NEXT_TO_CODE)
192
    StgFunPtr       entry;      /* pointer to the entry code */
193 194
#endif

sof's avatar
sof committed
195
#ifdef PROFILING
196
    StgProfInfo     prof;
sof's avatar
sof committed
197
#endif
198

199
    StgClosureInfo  layout;     /* closure layout info (one word) */
200

201
    StgHalfWord     type;       /* closure type */
202 203 204 205 206 207
    StgHalfWord     srt_bitmap;
       /* In a CONSTR:
            - the constructor tag
          In a FUN/THUNK
            - a bitmap of SRT entries
       */
208

209
#ifdef TABLES_NEXT_TO_CODE
210
    StgCode         code[];
211
#endif
thomie's avatar
thomie committed
212
} *StgInfoTablePtr; // StgInfoTable defined in rts/Types.h
213

214 215 216 217 218 219 220 221 222 223

/* -----------------------------------------------------------------------------
   Function info tables

   This is the general form of function info tables.  The compiler
   will omit some of the fields in common cases:

   -  If fun_type is not ARG_GEN or ARG_GEN_BIG, then the slow_apply
      and bitmap fields may be left out (they are at the end, so omitting
      them doesn't affect the layout).
224

225
   -  If srt_bitmap (in the std info table part) is zero, then the srt
Ben Gamari's avatar
Ben Gamari committed
226
      field needn't be set.  This only applies if the slow_apply and
227 228 229
      bitmap fields have also been omitted.
   -------------------------------------------------------------------------- */

Ben Gamari's avatar
Ben Gamari committed
230 231 232 233 234 235 236 237 238 239 240
/*
   Note [Encoding static reference tables]
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   As static reference tables appear frequently in code, we use a special
   compact encoding for the common case of a module defining only a few CAFs: We
   produce one table containing a list of CAFs in the module and then include a
   bitmap in each info table describing which entries of this table the closure
   references.
 */

Simon Marlow's avatar
Simon Marlow committed
241
typedef struct StgFunInfoExtraRev_ {
242
    OFFSET_FIELD(slow_apply_offset); /* apply to args on the stack */
243 244 245
    union {
        StgWord bitmap;
        OFFSET_FIELD(bitmap_offset);    /* arg ptr/nonptr bitmap */
246
    } b;
247
    OFFSET_FIELD(srt_offset);   /* pointer to the SRT table */
248 249
    StgHalfWord    fun_type;    /* function type */
    StgHalfWord    arity;       /* function arity */
250 251
} StgFunInfoExtraRev;

Simon Marlow's avatar
Simon Marlow committed
252
typedef struct StgFunInfoExtraFwd_ {
253 254
    StgHalfWord    fun_type;    /* function type */
    StgHalfWord    arity;       /* function arity */
255
    StgSRT         *srt;        /* pointer to the SRT table */
256
    union { /* union for compat. with TABLES_NEXT_TO_CODE version */
257
        StgWord        bitmap;  /* arg ptr/nonptr bitmap */
258
    } b;
259
    StgFun         *slow_apply; /* apply to args on the stack */
260 261 262 263 264 265 266 267 268
} StgFunInfoExtraFwd;

typedef struct {
#if defined(TABLES_NEXT_TO_CODE)
    StgFunInfoExtraRev f;
    StgInfoTable i;
#else
    StgInfoTable i;
    StgFunInfoExtraFwd f;
269 270 271
#endif
} StgFunInfoTable;

272 273 274
// canned bitmap for each arg type, indexed by constants in FunTypes.h
extern StgWord stg_arg_bitmaps[];

275 276 277 278
/* -----------------------------------------------------------------------------
   Return info tables
   -------------------------------------------------------------------------- */

279 280 281 282
/*
 * When info tables are laid out backwards, we can omit the SRT
 * pointer iff srt_bitmap is zero.
 */
283

284
typedef struct {
285
#if defined(TABLES_NEXT_TO_CODE)
286
    OFFSET_FIELD(srt_offset);   /* offset to the SRT table */
287
    StgInfoTable i;
288 289
#else
    StgInfoTable i;
290
    StgSRT      *srt;   /* pointer to the SRT table */
291 292 293 294 295 296 297
#endif
} StgRetInfoTable;

/* -----------------------------------------------------------------------------
   Thunk info tables
   -------------------------------------------------------------------------- */

298 299 300 301
/*
 * When info tables are laid out backwards, we can omit the SRT
 * pointer iff srt_bitmap is zero.
 */
302

Simon Marlow's avatar
Simon Marlow committed
303
typedef struct StgThunkInfoTable_ {
304 305 306
#if !defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
#endif
307
#if defined(TABLES_NEXT_TO_CODE)
308
    OFFSET_FIELD(srt_offset);   /* offset to the SRT table */
309
#else
310
    StgSRT         *srt;        /* pointer to the SRT table */
311
#endif
312 313
#if defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
314
#endif
315
} StgThunkInfoTable;
316

317 318 319 320
/* -----------------------------------------------------------------------------
   Constructor info tables
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
321
typedef struct StgConInfoTable_ {
322 323 324 325
#if !defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
#endif

326
#if defined(TABLES_NEXT_TO_CODE)
327
    OFFSET_FIELD(con_desc); // the name of the data constructor
328
                            // as: Package:Module.Name
329 330
#else
    char *con_desc;
Simon Marlow's avatar
Simon Marlow committed
331
#endif
332 333 334 335 336 337

#if defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
#endif
} StgConInfoTable;

338 339 340 341 342

/* -----------------------------------------------------------------------------
   Accessor macros for fields that might be offsets (C version)
   -------------------------------------------------------------------------- */

343 344 345 346
/*
 * GET_SRT(info)
 * info must be a Stg[Ret|Thunk]InfoTable* (an info table that has a SRT)
 */
347 348 349 350 351 352
#ifdef TABLES_NEXT_TO_CODE
#define GET_SRT(info) ((StgSRT*) (((StgWord) ((info)+1)) + (info)->srt_offset))
#else
#define GET_SRT(info) ((info)->srt)
#endif

353 354 355 356 357
/*
 * GET_CON_DESC(info)
 * info must be a StgConInfoTable*.
 */
#ifdef TABLES_NEXT_TO_CODE
358 359
#define GET_CON_DESC(info) \
            ((const char *)((StgWord)((info)+1) + (info->con_desc)))
360
#else
361
#define GET_CON_DESC(info) ((const char *)(info)->con_desc)
362 363
#endif

364 365 366 367
/*
 * GET_FUN_SRT(info)
 * info must be a StgFunInfoTable*
 */
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
#ifdef TABLES_NEXT_TO_CODE
#define GET_FUN_SRT(info) ((StgSRT*) (((StgWord) ((info)+1)) + (info)->f.srt_offset))
#else
#define GET_FUN_SRT(info) ((info)->f.srt)
#endif

#ifdef TABLES_NEXT_TO_CODE
#define GET_LARGE_BITMAP(info) ((StgLargeBitmap*) (((StgWord) ((info)+1)) \
                                        + (info)->layout.large_bitmap_offset))
#else
#define GET_LARGE_BITMAP(info) ((info)->layout.large_bitmap)
#endif

#ifdef TABLES_NEXT_TO_CODE
#define GET_FUN_LARGE_BITMAP(info) ((StgLargeBitmap*) (((StgWord) ((info)+1)) \
383
                                        + (info)->f.b.bitmap_offset))
384
#else
385
#define GET_FUN_LARGE_BITMAP(info) ((StgLargeBitmap*) ((info)->f.b.bitmap))
386 387
#endif

Simon Marlow's avatar
Simon Marlow committed
388 389 390 391 392 393 394 395 396 397 398 399 400
/*
 * GET_PROF_TYPE, GET_PROF_DESC
 */
#ifdef TABLES_NEXT_TO_CODE
#define GET_PROF_TYPE(info) ((char *)((StgWord)((info)+1) + (info->prof.closure_type_off)))
#else
#define GET_PROF_TYPE(info) ((info)->prof.closure_type)
#endif
#ifdef TABLES_NEXT_TO_CODE
#define GET_PROF_DESC(info) ((char *)((StgWord)((info)+1) + (info->prof.closure_desc_off)))
#else
#define GET_PROF_DESC(info) ((info)->prof.closure_desc)
#endif
Simon Marlow's avatar
Simon Marlow committed
401 402

#endif /* RTS_STORAGE_INFOTABLES_H */