InfoTables.h 13.5 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 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/* ----------------------------------------------------------------------------
   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.

   Note [x86-64-relative]
   There is a complication on the x86_64 platform, where pointeres 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.

   When going via-C, the mangler arranges that we only generate
   relative relocations between symbols in the same segment (the text
   segment).  The NCG, however, puts things in the right sections and
   uses 32-bit relative offsets instead.

   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.
   ------------------------------------------------------------------------- */

#if x86_64_TARGET_ARCH
#define OFFSET_FIELD(n) StgHalfInt n; StgHalfWord __pad_##n;
#else   
#define OFFSET_FIELD(n) StgInt n;
#endif

42 43 44 45 46
/* -----------------------------------------------------------------------------
   Profiling info
   -------------------------------------------------------------------------- */

typedef struct {
Simon Marlow's avatar
Simon Marlow committed
47
#ifndef TABLES_NEXT_TO_CODE
48 49
    char *closure_type;
    char *closure_desc;
Simon Marlow's avatar
Simon Marlow committed
50 51 52 53
#else
    OFFSET_FIELD(closure_type_off);
    OFFSET_FIELD(closure_desc_off);
#endif
54 55
} StgProfInfo;

56 57 58
/* -----------------------------------------------------------------------------
   Ticky info

59 60
   There is no ticky-specific stuff in an info table at this time.
   -------------------------------------------------------------------------- */
61

62 63 64 65 66 67 68 69 70 71 72 73
/* -----------------------------------------------------------------------------
   Debugging info
   -------------------------------------------------------------------------- */

#ifdef DEBUG_CLOSURE

typedef struct {
	... whatever ...
} StgDebugInfo;

#else /* !DEBUG_CLOSURE */

74
/* There is no DEBUG-specific stuff in an info table at this time. */
75 76 77

#endif /* DEBUG_CLOSURE */

78 79 80 81
/* -----------------------------------------------------------------------------
   Closure flags
   -------------------------------------------------------------------------- */

82 83
/* The type flags provide quick access to certain properties of a closure. */

84
#define _HNF (1<<0)  /* head normal form?    */
85
#define _BTM (1<<1)  /* bitmap-style layout? */
86 87 88 89 90 91 92
#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?   */
93

94 95 96 97 98 99
#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)
100

101 102
extern StgWord16 closure_flags[];

Simon Marlow's avatar
Simon Marlow committed
103
#define closureFlags(c)         (closure_flags[get_itbl(UNTAG_CLOSURE(c))->type])
104

105 106
#define closure_HNF(c)          (  closureFlags(c) & _HNF)
#define closure_BITMAP(c)       (  closureFlags(c) & _BTM)
107
#define closure_NON_SPARK(c)    ( (closureFlags(c) & _NS))
108
#define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
109 110
#define closure_STATIC(c)       (  closureFlags(c) & _STA)
#define closure_THUNK(c)        (  closureFlags(c) & _THU)
111 112
#define closure_MUTABLE(c)      (  closureFlags(c) & _MUT)
#define closure_UNPOINTED(c)    (  closureFlags(c) & _UPT)
113
#define closure_SRT(c)          (  closureFlags(c) & _SRT)
114
#define closure_IND(c)          (  closureFlags(c) & _IND)
115 116 117

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

119 120 121 122 123 124 125 126
#define ip_HNF(ip)               (  ipFlags(ip) & _HNF)
#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)
127
#define ip_IND(ip)          	 (  ipFlags(ip) & _IND)
128 129

/* -----------------------------------------------------------------------------
130 131 132 133 134 135
   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).
136 137

   In these bitmaps: 0 == ptr, 1 == non-ptr.
138 139
   -------------------------------------------------------------------------- */

140 141 142 143 144
/*
 * Small bitmaps:  for a small bitmap, we store the size and bitmap in 
 * 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.
 */
145 146 147 148
#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)
149

150 151 152
/*
 * A large bitmap.
 */
153
typedef struct {
154
  StgWord size;
155
  StgWord bitmap[FLEXIBLE_ARRAY];
156 157
} StgLargeBitmap;

158 159 160 161 162 163 164 165 166
/* -----------------------------------------------------------------------------
   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.
   -------------------------------------------------------------------------- */

167
/* An SRT is just an array of closure pointers: */
168 169
typedef StgClosure* StgSRT[];

170 171 172 173 174 175 176 177
/*
 * 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:
 */
178 179 180 181 182
typedef struct StgLargeSRT_ {
    StgSRT *srt;
    StgLargeBitmap l;
} StgLargeSRT;

183 184 185
/* ----------------------------------------------------------------------------
   Info Tables
   ------------------------------------------------------------------------- */
186

187 188 189 190 191
/*
 * Stuff describing the closure layout.  Well, actually, it might
 * contain the selector index for a THUNK_SELECTOR.  This union is one
 * word long.
 */
192
typedef union {
193 194 195
    struct {			/* Heap closure payload layout: */
	StgHalfWord ptrs;	/* number of pointers */
	StgHalfWord nptrs;	/* number of non-pointers */
196 197
    } payload;
    
198 199
    StgWord bitmap;		  /* word-sized bit pattern describing */
				  /*  a stack frame: see below */
200

201
#ifndef TABLES_NEXT_TO_CODE
202
    StgLargeBitmap* large_bitmap; /* pointer to large bitmap structure */
203
#else
204
    OFFSET_FIELD( large_bitmap_offset );  /* offset from info table to large bitmap structure */
205
#endif
206
    
207
    StgWord selector_offset;	  /* used in THUNK_SELECTORs */
sof's avatar
sof committed
208

209 210 211
} StgClosureInfo;


212 213 214
/*
 * The "standard" part of an info table.  Every info table has this bit.
 */
Simon Marlow's avatar
Simon Marlow committed
215
typedef struct StgInfoTable_ {
216

217
#if !defined(TABLES_NEXT_TO_CODE)
218 219 220
    StgFunPtr       entry;	/* pointer to the entry code */
#endif

sof's avatar
sof committed
221
#ifdef PROFILING
222
    StgProfInfo     prof;
sof's avatar
sof committed
223
#endif
224
#ifdef TICKY
225
  /* Ticky-specific stuff would go here. */
226
#endif
sof's avatar
sof committed
227
#ifdef DEBUG_CLOSURE
228
  /* Debug-specific stuff would go here. */
sof's avatar
sof committed
229
#endif
230

231
    StgClosureInfo  layout;	/* closure layout info (one word) */
232

233
    StgHalfWord     type;	/* closure type */
234 235 236 237 238 239
    StgHalfWord     srt_bitmap;
       /* In a CONSTR:
            - the constructor tag
          In a FUN/THUNK
            - a bitmap of SRT entries
       */
240

241
#ifdef TABLES_NEXT_TO_CODE
242
    StgCode         code[FLEXIBLE_ARRAY];
243
#endif
Simon Marlow's avatar
Simon Marlow committed
244
} *StgInfoTablePtr;
245

246 247 248 249 250 251 252 253 254 255 256

/* -----------------------------------------------------------------------------
   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).
      
257
   -  If srt_bitmap (in the std info table part) is zero, then the srt
258 259 260 261
      field may be omitted.  This only applies if the slow_apply and
      bitmap fields have also been omitted.
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
262
typedef struct StgFunInfoExtraRev_ {
263 264 265 266 267 268
    OFFSET_FIELD ( slow_apply_offset ); /* apply to args on the stack */
    union { 
	StgWord bitmap;
	OFFSET_FIELD ( bitmap_offset );	/* arg ptr/nonptr bitmap */
    } b;
    OFFSET_FIELD ( srt_offset ); /* pointer to the SRT table */
269 270
    StgHalfWord    fun_type;    /* function type */
    StgHalfWord    arity;       /* function arity */
271 272
} StgFunInfoExtraRev;

Simon Marlow's avatar
Simon Marlow committed
273
typedef struct StgFunInfoExtraFwd_ {
274 275 276
    StgHalfWord    fun_type;    /* function type */
    StgHalfWord    arity;       /* function arity */
    StgSRT         *srt;	/* pointer to the SRT table */
277 278 279
    union { /* union for compat. with TABLES_NEXT_TO_CODE version */
	StgWord        bitmap;	/* arg ptr/nonptr bitmap */
    } b;
280
    StgFun         *slow_apply; /* apply to args on the stack */
281 282 283 284 285 286 287 288 289
} StgFunInfoExtraFwd;

typedef struct {
#if defined(TABLES_NEXT_TO_CODE)
    StgFunInfoExtraRev f;
    StgInfoTable i;
#else
    StgInfoTable i;
    StgFunInfoExtraFwd f;
290 291 292
#endif
} StgFunInfoTable;

293 294 295
// canned bitmap for each arg type, indexed by constants in FunTypes.h
extern StgWord stg_arg_bitmaps[];

296 297 298 299
/* -----------------------------------------------------------------------------
   Return info tables
   -------------------------------------------------------------------------- */

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

305
typedef struct {
306
#if defined(TABLES_NEXT_TO_CODE)
307
    OFFSET_FIELD( srt_offset );	/* offset to the SRT table */
308
    StgInfoTable i;
309 310
#else
    StgInfoTable i;
311
    StgSRT      *srt;	/* pointer to the SRT table */
312 313 314 315 316 317 318
#endif
} StgRetInfoTable;

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

319 320 321 322
/*
 * When info tables are laid out backwards, we can omit the SRT
 * pointer iff srt_bitmap is zero.
 */
323

Simon Marlow's avatar
Simon Marlow committed
324
typedef struct StgThunkInfoTable_ {
325 326 327
#if !defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
#endif
328
#if defined(TABLES_NEXT_TO_CODE)
329
    OFFSET_FIELD( srt_offset );	/* offset to the SRT table */
330
#else
331
    StgSRT         *srt;	/* pointer to the SRT table */
332
#endif
333 334
#if defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
335
#endif
336
} StgThunkInfoTable;
337

338 339 340 341
/* -----------------------------------------------------------------------------
   Constructor info tables
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
342
typedef struct StgConInfoTable_ {
343 344 345 346
#if !defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
#endif

347
#if defined(TABLES_NEXT_TO_CODE)
348 349
    OFFSET_FIELD(con_desc) // the name of the data constructor 
                           // as: Package:Module.Name
350 351
#else
    char *con_desc;
Simon Marlow's avatar
Simon Marlow committed
352
#endif
353 354 355 356 357 358

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

359 360 361 362 363

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

364 365 366 367
/*
 * GET_SRT(info)
 * info must be a Stg[Ret|Thunk]InfoTable* (an info table that has a SRT)
 */
368 369 370 371 372 373
#ifdef TABLES_NEXT_TO_CODE
#define GET_SRT(info) ((StgSRT*) (((StgWord) ((info)+1)) + (info)->srt_offset))
#else
#define GET_SRT(info) ((info)->srt)
#endif

374 375 376 377 378 379 380 381 382 383
/*
 * GET_CON_DESC(info)
 * info must be a StgConInfoTable*.
 */
#ifdef TABLES_NEXT_TO_CODE
#define GET_CON_DESC(info) ((char *)((StgWord)((info)+1) + (info->con_desc)))
#else
#define GET_CON_DESC(info) ((info)->con_desc)
#endif

384 385 386 387
/*
 * GET_FUN_SRT(info)
 * info must be a StgFunInfoTable*
 */
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
#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)) \
403
                                        + (info)->f.b.bitmap_offset))
404
#else
405
#define GET_FUN_LARGE_BITMAP(info) ((StgLargeBitmap*) ((info)->f.b.bitmap))
406 407
#endif

Simon Marlow's avatar
Simon Marlow committed
408 409 410 411 412 413 414 415 416 417 418 419 420
/*
 * 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
421 422

#endif /* RTS_STORAGE_INFOTABLES_H */