InfoTables.h 13.3 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
/* ----------------------------------------------------------------------------
   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.

   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

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
/* -----------------------------------------------------------------------------
   Ticky info

54 55
   There is no ticky-specific stuff in an info table at this time.
   -------------------------------------------------------------------------- */
56

57 58 59 60 61 62 63 64 65 66 67 68
/* -----------------------------------------------------------------------------
   Debugging info
   -------------------------------------------------------------------------- */

#ifdef DEBUG_CLOSURE

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

#else /* !DEBUG_CLOSURE */

69
/* There is no DEBUG-specific stuff in an info table at this time. */
70 71 72

#endif /* DEBUG_CLOSURE */

73 74 75 76
/* -----------------------------------------------------------------------------
   Closure flags
   -------------------------------------------------------------------------- */

77 78
/* The type flags provide quick access to certain properties of a closure. */

79
#define _HNF (1<<0)  /* head normal form?    */
80
#define _BTM (1<<1)  /* bitmap-style layout? */
81 82 83 84 85 86 87
#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?   */
88

89 90 91 92 93 94
#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)
95

96 97
extern StgWord16 closure_flags[];

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

100 101
#define closure_HNF(c)          (  closureFlags(c) & _HNF)
#define closure_BITMAP(c)       (  closureFlags(c) & _BTM)
102
#define closure_NON_SPARK(c)    ( (closureFlags(c) & _NS))
103
#define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
104 105
#define closure_STATIC(c)       (  closureFlags(c) & _STA)
#define closure_THUNK(c)        (  closureFlags(c) & _THU)
106 107
#define closure_MUTABLE(c)      (  closureFlags(c) & _MUT)
#define closure_UNPOINTED(c)    (  closureFlags(c) & _UPT)
108
#define closure_SRT(c)          (  closureFlags(c) & _SRT)
109
#define closure_IND(c)          (  closureFlags(c) & _IND)
110 111 112

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

114 115 116 117 118 119 120 121
#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)
122
#define ip_IND(ip)          	 (  ipFlags(ip) & _IND)
123 124

/* -----------------------------------------------------------------------------
125 126 127 128 129 130
   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).
131 132

   In these bitmaps: 0 == ptr, 1 == non-ptr.
133 134
   -------------------------------------------------------------------------- */

135 136 137 138 139
/*
 * 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.
 */
140 141 142 143
#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)
144

145 146 147
/*
 * A large bitmap.
 */
148
typedef struct {
149
  StgWord size;
150
  StgWord bitmap[FLEXIBLE_ARRAY];
151 152
} StgLargeBitmap;

153 154 155 156 157 158 159 160 161
/* -----------------------------------------------------------------------------
   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.
   -------------------------------------------------------------------------- */

162
/* An SRT is just an array of closure pointers: */
163 164
typedef StgClosure* StgSRT[];

165 166 167 168 169 170 171 172
/*
 * 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:
 */
173 174 175 176 177
typedef struct StgLargeSRT_ {
    StgSRT *srt;
    StgLargeBitmap l;
} StgLargeSRT;

178 179 180
/* ----------------------------------------------------------------------------
   Info Tables
   ------------------------------------------------------------------------- */
181

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

196
#ifndef TABLES_NEXT_TO_CODE
197
    StgLargeBitmap* large_bitmap; /* pointer to large bitmap structure */
198
#else
199
    OFFSET_FIELD( large_bitmap_offset );  /* offset from info table to large bitmap structure */
200
#endif
201
    
202
    StgWord selector_offset;	  /* used in THUNK_SELECTORs */
sof's avatar
sof committed
203

204 205 206
} StgClosureInfo;


207 208 209
/*
 * The "standard" part of an info table.  Every info table has this bit.
 */
Simon Marlow's avatar
Simon Marlow committed
210
typedef struct StgInfoTable_ {
211

212
#if !defined(TABLES_NEXT_TO_CODE)
213 214 215
    StgFunPtr       entry;	/* pointer to the entry code */
#endif

sof's avatar
sof committed
216
#ifdef PROFILING
217
    StgProfInfo     prof;
sof's avatar
sof committed
218
#endif
219
#ifdef TICKY
220
  /* Ticky-specific stuff would go here. */
221
#endif
sof's avatar
sof committed
222
#ifdef DEBUG_CLOSURE
223
  /* Debug-specific stuff would go here. */
sof's avatar
sof committed
224
#endif
225

226
    StgClosureInfo  layout;	/* closure layout info (one word) */
227

228
    StgHalfWord     type;	/* closure type */
229 230 231 232 233 234
    StgHalfWord     srt_bitmap;
       /* In a CONSTR:
            - the constructor tag
          In a FUN/THUNK
            - a bitmap of SRT entries
       */
235

236
#ifdef TABLES_NEXT_TO_CODE
237
    StgCode         code[FLEXIBLE_ARRAY];
238
#endif
Simon Marlow's avatar
Simon Marlow committed
239
} *StgInfoTablePtr;
240

241 242 243 244 245 246 247 248 249 250 251

/* -----------------------------------------------------------------------------
   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).
      
252
   -  If srt_bitmap (in the std info table part) is zero, then the srt
253 254 255 256
      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
257
typedef struct StgFunInfoExtraRev_ {
258 259 260 261 262 263
    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 */
264 265
    StgHalfWord    fun_type;    /* function type */
    StgHalfWord    arity;       /* function arity */
266 267
} StgFunInfoExtraRev;

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

typedef struct {
#if defined(TABLES_NEXT_TO_CODE)
    StgFunInfoExtraRev f;
    StgInfoTable i;
#else
    StgInfoTable i;
    StgFunInfoExtraFwd f;
285 286 287
#endif
} StgFunInfoTable;

288 289 290
// canned bitmap for each arg type, indexed by constants in FunTypes.h
extern StgWord stg_arg_bitmaps[];

291 292 293 294
/* -----------------------------------------------------------------------------
   Return info tables
   -------------------------------------------------------------------------- */

295 296 297 298
/*
 * When info tables are laid out backwards, we can omit the SRT
 * pointer iff srt_bitmap is zero.
 */
299

300
typedef struct {
301
#if defined(TABLES_NEXT_TO_CODE)
302
    OFFSET_FIELD( srt_offset );	/* offset to the SRT table */
303
    StgInfoTable i;
304 305
#else
    StgInfoTable i;
306
    StgSRT      *srt;	/* pointer to the SRT table */
307 308 309 310 311 312 313
#endif
} StgRetInfoTable;

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

314 315 316 317
/*
 * When info tables are laid out backwards, we can omit the SRT
 * pointer iff srt_bitmap is zero.
 */
318

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

333 334 335 336
/* -----------------------------------------------------------------------------
   Constructor info tables
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
337
typedef struct StgConInfoTable_ {
338 339 340 341
#if !defined(TABLES_NEXT_TO_CODE)
    StgInfoTable i;
#endif

342
#if defined(TABLES_NEXT_TO_CODE)
343 344
    OFFSET_FIELD(con_desc) // the name of the data constructor 
                           // as: Package:Module.Name
345 346
#else
    char *con_desc;
Simon Marlow's avatar
Simon Marlow committed
347
#endif
348 349 350 351 352 353

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

354 355 356 357 358

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

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

369 370 371 372 373 374 375 376 377 378
/*
 * 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

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

Simon Marlow's avatar
Simon Marlow committed
403 404 405 406 407 408 409 410 411 412 413 414 415
/*
 * 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
416 417

#endif /* RTS_STORAGE_INFOTABLES_H */