1 /* ----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2002
7 * -------------------------------------------------------------------------- */
12 /* -----------------------------------------------------------------------------
14 -------------------------------------------------------------------------- */
21 /* -----------------------------------------------------------------------------
23 -------------------------------------------------------------------------- */
25 #if 0 && (defined(PAR) || defined(GRAN))
28 ToDo: use this in StgInfoTable (mutually recursive) -- HWL */
31 StgInfoTable *rbh_infoptr; /* infoptr to the RBH */
37 Copied from ghc-0.29; ToDo: check this code -- HWL
39 In the parallel system, all updatable closures have corresponding
40 revertible black holes. When we are assembly-mangling, we guarantee
41 that the revertible black hole code precedes the normal entry code, so
42 that the RBH info table resides at a fixed offset from the normal info
43 table. Otherwise, we add the RBH info table pointer to the end of the
44 normal info table and vice versa.
46 Currently has to use a !RBH_MAGIC_OFFSET setting.
47 Still todo: init of par.infoptr field in all infotables!!
50 #if defined(PAR) || defined(GRAN)
52 # ifdef RBH_MAGIC_OFFSET
54 # error magic offset not yet implemented
56 # define RBH_INFO_WORDS 0
57 # define INCLUDE_RBH_INFO(infoptr)
59 # define RBH_INFOPTR(infoptr) (((P_)infoptr) - RBH_MAGIC_OFFSET)
60 # define REVERT_INFOPTR(infoptr) (((P_)infoptr) + RBH_MAGIC_OFFSET)
64 # define RBH_INFO_WORDS 1
65 # define INCLUDE_RBH_INFO(info) rbh_infoptr : &(info)
67 # define RBH_INFOPTR(infoptr) (((StgInfoTable *)(infoptr))->rbh_infoptr)
68 # define REVERT_INFOPTR(infoptr) (((StgInfoTable *)(infoptr))->rbh_infoptr)
72 /* see ParallelRts.h */
75 StgClosure *convertToRBH(StgClosure *closure);
77 void convertFromRBH(StgClosure *closure);
79 void convertToFetchMe(StgPtr closure, globalAddr *ga);
85 /* -----------------------------------------------------------------------------
88 There is no ticky-specific stuff in an info table at this time.
89 -------------------------------------------------------------------------- */
91 /* -----------------------------------------------------------------------------
93 -------------------------------------------------------------------------- */
101 #else /* !DEBUG_CLOSURE */
103 /* There is no DEBUG-specific stuff in an info table at this time. */
105 #endif /* DEBUG_CLOSURE */
107 /* -----------------------------------------------------------------------------
109 -------------------------------------------------------------------------- */
111 /* The type flags provide quick access to certain properties of a closure. */
113 #define _HNF (1<<0) /* head normal form? */
114 #define _BTM (1<<1) /* bitmap-style layout? */
115 #define _NS (1<<2) /* non-sparkable */
116 #define _STA (1<<3) /* static? */
117 #define _THU (1<<4) /* thunk? */
118 #define _MUT (1<<5) /* mutable? */
119 #define _UPT (1<<6) /* unpointed? */
120 #define _SRT (1<<7) /* has an SRT? */
121 #define _IND (1<<8) /* is an indirection? */
123 #define isSTATIC(flags) ((flags) &_STA)
124 #define isMUTABLE(flags) ((flags) &_MUT)
125 #define isBITMAP(flags) ((flags) &_BTM)
126 #define isTHUNK(flags) ((flags) &_THU)
127 #define isUNPOINTED(flags) ((flags) &_UPT)
128 #define hasSRT(flags) ((flags) &_SRT)
130 extern StgWord16 closure_flags[];
132 #define closureFlags(c) (closure_flags[get_itbl(c)->type])
134 #define closure_HNF(c) ( closureFlags(c) & _HNF)
135 #define closure_BITMAP(c) ( closureFlags(c) & _BTM)
136 #define closure_NON_SPARK(c) ( (closureFlags(c) & _NS))
137 #define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
138 #define closure_STATIC(c) ( closureFlags(c) & _STA)
139 #define closure_THUNK(c) ( closureFlags(c) & _THU)
140 #define closure_MUTABLE(c) ( closureFlags(c) & _MUT)
141 #define closure_UNPOINTED(c) ( closureFlags(c) & _UPT)
142 #define closure_SRT(c) ( closureFlags(c) & _SRT)
143 #define closure_IND(c) ( closureFlags(c) & _IND)
145 /* same as above but for info-ptr rather than closure */
146 #define ipFlags(ip) (closure_flags[ip->type])
148 #define ip_HNF(ip) ( ipFlags(ip) & _HNF)
149 #define ip_BITMAP(ip) ( ipFlags(ip) & _BTM)
150 #define ip_SHOULD_SPARK(ip) (!(ipFlags(ip) & _NS))
151 #define ip_STATIC(ip) ( ipFlags(ip) & _STA)
152 #define ip_THUNK(ip) ( ipFlags(ip) & _THU)
153 #define ip_MUTABLE(ip) ( ipFlags(ip) & _MUT)
154 #define ip_UNPOINTED(ip) ( ipFlags(ip) & _UPT)
155 #define ip_SRT(ip) ( ipFlags(ip) & _SRT)
156 #define ip_IND(ip) ( ipFlags(ip) & _IND)
158 /* -----------------------------------------------------------------------------
161 These are used to describe the pointerhood of a sequence of words
162 (usually on the stack) to the garbage collector. The two primary
163 uses are for stack frames, and functions (where we need to describe
164 the layout of a PAP to the GC).
166 In these bitmaps: 0 == ptr, 1 == non-ptr.
167 -------------------------------------------------------------------------- */
170 * Small bitmaps: for a small bitmap, we store the size and bitmap in
171 * the same word, using the following macros. If the bitmap doesn't
172 * fit in a single word, we use a pointer to an StgLargeBitmap below.
174 #define MK_SMALL_BITMAP(size,bits) (((bits)<<BITMAP_BITS_SHIFT) | (size))
176 #define BITMAP_SIZE(bitmap) ((bitmap) & BITMAP_SIZE_MASK)
177 #define BITMAP_BITS(bitmap) ((bitmap) >> BITMAP_BITS_SHIFT)
184 StgWord bitmap[FLEXIBLE_ARRAY];
187 /* -----------------------------------------------------------------------------
188 SRTs (Static Reference Tables)
190 These tables are used to keep track of the static objects referred
191 to by the code for a closure or stack frame, so that we can follow
192 static data references from code and thus accurately
193 garbage-collect CAFs.
194 -------------------------------------------------------------------------- */
196 /* An SRT is just an array of closure pointers: */
197 typedef StgClosure* StgSRT[];
200 * Each info table refers to some subset of the closure pointers in an
201 * SRT. It does this using a pair of an StgSRT pointer and a
202 * half-word bitmap. If the half-word bitmap isn't large enough, then
203 * we fall back to a large SRT, including an unbounded bitmap. If the
204 * half-word bitmap is set to all ones (0xffff), then the StgSRT
205 * pointer instead points to an StgLargeSRT:
207 typedef struct StgLargeSRT_ {
212 /* ----------------------------------------------------------------------------
214 ------------------------------------------------------------------------- */
217 * Stuff describing the closure layout. Well, actually, it might
218 * contain the selector index for a THUNK_SELECTOR. This union is one
222 struct { /* Heap closure payload layout: */
223 StgHalfWord ptrs; /* number of pointers */
224 StgHalfWord nptrs; /* number of non-pointers */
227 StgWord bitmap; /* word-sized bit pattern describing */
228 /* a stack frame: see below */
230 #ifndef TABLES_NEXT_TO_CODE
231 StgLargeBitmap* large_bitmap; /* pointer to large bitmap structure */
233 StgWord large_bitmap_offset; /* offset from info table to large bitmap structure */
236 StgWord selector_offset; /* used in THUNK_SELECTORs */
242 * The "standard" part of an info table. Every info table has this bit.
244 typedef struct _StgInfoTable {
246 #ifndef TABLES_NEXT_TO_CODE
247 StgFunPtr entry; /* pointer to the entry code */
250 #if defined(PAR) || defined(GRAN)
251 struct _StgInfoTable *rbh_infoptr;
257 /* Ticky-specific stuff would go here. */
260 /* Debug-specific stuff would go here. */
263 StgClosureInfo layout; /* closure layout info (one word) */
265 StgHalfWord type; /* closure type */
266 StgHalfWord srt_bitmap; /* number of entries in SRT (or constructor tag) */
268 #ifdef TABLES_NEXT_TO_CODE
269 StgCode code[FLEXIBLE_ARRAY];
274 /* -----------------------------------------------------------------------------
277 This is the general form of function info tables. The compiler
278 will omit some of the fields in common cases:
280 - If fun_type is not ARG_GEN or ARG_GEN_BIG, then the slow_apply
281 and bitmap fields may be left out (they are at the end, so omitting
282 them doesn't affect the layout).
284 - If srt_bitmap (in the std info table part) is zero, then the srt
285 field may be omitted. This only applies if the slow_apply and
286 bitmap fields have also been omitted.
287 -------------------------------------------------------------------------- */
289 typedef struct _StgFunInfoExtraRev {
290 StgWord slow_apply_offset; /* apply to args on the stack */
291 StgWord bitmap; /* arg ptr/nonptr bitmap */
292 StgWord srt_offset; /* pointer to the SRT table */
293 StgHalfWord fun_type; /* function type */
294 StgHalfWord arity; /* function arity */
295 } StgFunInfoExtraRev;
297 typedef struct _StgFunInfoExtraFwd {
298 StgHalfWord fun_type; /* function type */
299 StgHalfWord arity; /* function arity */
300 StgSRT *srt; /* pointer to the SRT table */
301 StgWord bitmap; /* arg ptr/nonptr bitmap */
302 StgFun *slow_apply; /* apply to args on the stack */
303 } StgFunInfoExtraFwd;
306 #if defined(TABLES_NEXT_TO_CODE)
307 StgFunInfoExtraRev f;
311 StgFunInfoExtraFwd f;
315 /* -----------------------------------------------------------------------------
317 -------------------------------------------------------------------------- */
320 * When info tables are laid out backwards, we can omit the SRT
321 * pointer iff srt_bitmap is zero.
325 #if defined(TABLES_NEXT_TO_CODE)
326 StgWord srt_offset; /* offset to the SRT table */
330 StgSRT *srt; /* pointer to the SRT table */
331 StgFunPtr vector[FLEXIBLE_ARRAY];
335 /* -----------------------------------------------------------------------------
337 -------------------------------------------------------------------------- */
340 * When info tables are laid out backwards, we can omit the SRT
341 * pointer iff srt_bitmap is zero.
344 typedef struct _StgThunkInfoTable {
345 #if !defined(TABLES_NEXT_TO_CODE)
348 #if defined(TABLES_NEXT_TO_CODE)
349 StgWord srt_offset; /* offset to the SRT table */
351 StgSRT *srt; /* pointer to the SRT table */
353 #if defined(TABLES_NEXT_TO_CODE)
359 /* -----------------------------------------------------------------------------
360 Accessor macros for fields that might be offsets (C version)
361 -------------------------------------------------------------------------- */
365 * info must be a Stg[Ret|Thunk]InfoTable* (an info table that has a SRT)
367 #ifdef TABLES_NEXT_TO_CODE
368 #define GET_SRT(info) ((StgSRT*) (((StgWord) ((info)+1)) + (info)->srt_offset))
370 #define GET_SRT(info) ((info)->srt)
375 * info must be a StgFunInfoTable*
377 #ifdef TABLES_NEXT_TO_CODE
378 #define GET_FUN_SRT(info) ((StgSRT*) (((StgWord) ((info)+1)) + (info)->f.srt_offset))
380 #define GET_FUN_SRT(info) ((info)->f.srt)
383 #ifdef TABLES_NEXT_TO_CODE
384 #define GET_LARGE_BITMAP(info) ((StgLargeBitmap*) (((StgWord) ((info)+1)) \
385 + (info)->layout.large_bitmap_offset))
387 #define GET_LARGE_BITMAP(info) ((info)->layout.large_bitmap)
390 #ifdef TABLES_NEXT_TO_CODE
391 #define GET_FUN_LARGE_BITMAP(info) ((StgLargeBitmap*) (((StgWord) ((info)+1)) \
394 #define GET_FUN_LARGE_BITMAP(info) ((StgLargeBitmap*) ((info)->f.bitmap))
398 #endif /* INFOTABLES_H */