1 /* -----------------------------------------------------------------------------
2 * $Id: StgMacros.h,v 1.8 1999/04/27 12:31:40 simonm Exp $
4 * (c) The GHC Team, 1998-1999
6 * Macros used for writing STG-ish C code.
8 * ---------------------------------------------------------------------------*/
13 /* -----------------------------------------------------------------------------
14 The following macros create function headers.
16 Each basic block is represented by a C function with no arguments.
17 We therefore always begin with either
25 The macros can be used either to define the function itself, or to provide
26 prototypes (by following with a ';').
28 Note: the various I*_ shorthands in the second block below are used to
29 declare forward references to local symbols. These shorthands *have* to
30 use the 'extern' type specifier and not 'static'. The reason for this is
31 that 'static' declares a reference as being a static/local variable,
32 and *not* as a forward reference to a static variable.
34 This might seem obvious, but it had me stumped as to why my info tables
35 were suddenly all filled with 0s.
39 --------------------------------------------------------------------------- */
41 #define STGFUN(f) StgFunPtr f(void)
42 #define EXTFUN(f) extern StgFunPtr f(void)
43 #define EXTFUN_RTS(f) extern DLL_IMPORT_RTS StgFunPtr f(void)
44 #define FN_(f) F_ f(void)
45 #define IFN_(f) static F_ f(void)
46 #define IF_(f) static F_ f(void)
47 #define EF_(f) extern F_ f(void)
48 #define EDF_(f) extern DLLIMPORT F_ f(void)
51 #define EDD_ extern DLLIMPORT
52 #define ED_RO_ extern const
54 #define ID_RO_ extern const
55 #define EI_ extern const StgInfoTable
56 #define EDI_ extern DLLIMPORT const StgInfoTable
57 #define II_ extern const StgInfoTable
58 #define EC_ extern StgClosure
59 #define EDC_ extern DLLIMPORT StgClosure
60 #define IC_ extern StgClosure
61 #define ECP_(x) extern const StgClosure *(x)[]
62 #define EDCP_(x) extern DLLIMPORT StgClosure *(x)[]
63 #define ICP_(x) extern const StgClosure *(x)[]
65 /* -----------------------------------------------------------------------------
68 For a block of non-pointer words on the stack, we precede the
69 block with a small-integer tag giving the number of non-pointer
71 -------------------------------------------------------------------------- */
74 #define ARGTAG_MAX 16 /* probably arbitrary */
75 #define ARG_TAG(n) (n)
76 #define ARG_SIZE(n) stgCast(StgWord,n)
80 INT_TAG = sizeofW(StgInt),
81 INT64_TAG = sizeofW(StgInt64),
82 WORD_TAG = sizeofW(StgWord),
83 ADDR_TAG = sizeofW(StgAddr),
84 CHAR_TAG = sizeofW(StgChar),
85 FLOAT_TAG = sizeofW(StgFloat),
86 DOUBLE_TAG = sizeofW(StgDouble),
87 STABLE_TAG = sizeofW(StgWord),
90 #else /* DEBUG_EXTRA */
103 ARGTAG_MAX = DOUBLE_TAG
106 /* putting this in a .h file generates many copies - but its only a
109 static StgWord stg_arg_size[] = {
111 [INT_TAG ] = sizeofW(StgInt),
112 [INT64_TAG ] = sizeofW(StgInt64),
113 [WORD_TAG ] = sizeofW(StgWord),
114 [ADDR_TAG ] = sizeofW(StgAddr),
115 [CHAR_TAG ] = sizeofW(StgChar),
116 [FLOAT_TAG ] = sizeofW(StgFloat),
117 [DOUBLE_TAG] = sizeofW(StgDouble),
118 [STABLE_TAG] = sizeofW(StgWord)
121 #define ARG_SIZE(tag) stg_arg_size[stgCast(StgWord,tag)]
123 #endif /* DEBUG_EXTRA */
125 static inline int IS_ARG_TAG( StgWord p );
126 static inline int IS_ARG_TAG( StgWord p ) { return p <= ARGTAG_MAX; }
128 /* -----------------------------------------------------------------------------
131 If (Sp + <n_args>) > Su { JMP_(stg_update_PAP); }
133 Sp points to the topmost used word on the stack, and Su points to
134 the most recently pushed update frame.
136 Remember that <n_args> must include any tagging of unboxed values.
138 ARGS_CHK_LOAD_NODE is for top-level functions, whose entry
139 convention doesn't require that Node is loaded with a pointer to
140 the closure. Thus we must load node before calling stg_updatePAP if
141 the argument check fails.
142 -------------------------------------------------------------------------- */
144 #define ARGS_CHK(n) \
145 if ((P_)(Sp + (n)) > (P_)Su) { \
146 JMP_(stg_update_PAP); \
149 #define ARGS_CHK_LOAD_NODE(n,closure) \
150 if ((P_)(Sp + (n)) > (P_)Su) { \
151 R1.p = (P_)closure; \
152 JMP_(stg_update_PAP); \
155 /* -----------------------------------------------------------------------------
158 When failing a check, we save a return address on the stack and
159 jump to a pre-compiled code fragment that saves the live registers
160 and returns to the scheduler.
162 The return address in most cases will be the beginning of the basic
163 block in which the check resides, since we need to perform the check
164 again on re-entry because someone else might have stolen the resource
166 ------------------------------------------------------------------------- */
168 #define STK_CHK(headroom,ret,r,layout,tag_assts) \
169 if (Sp - headroom < SpLim) { \
170 EXTFUN_RTS(stg_chk_##layout); \
173 JMP_(stg_chk_##layout); \
176 #define HP_CHK(headroom,ret,r,layout,tag_assts) \
177 if ((Hp += headroom) > HpLim) { \
178 EXTFUN_RTS(stg_chk_##layout); \
181 JMP_(stg_chk_##layout); \
183 TICK_ALLOC_HEAP(headroom);
185 #define HP_STK_CHK(stk_headroom,hp_headroom,ret,r,layout,tag_assts) \
186 if (Sp - stk_headroom < SpLim || (Hp += hp_headroom) > HpLim) { \
187 EXTFUN_RTS(stg_chk_##layout); \
190 JMP_(stg_chk_##layout); \
192 TICK_ALLOC_HEAP(hp_headroom);
194 /* -----------------------------------------------------------------------------
195 A Heap Check in a case alternative are much simpler: everything is
196 on the stack and covered by a liveness mask already, and there is
197 even a return address with an SRT info table there as well.
199 Just push R1 and return to the scheduler saying 'EnterGHC'
201 {STK,HP,HP_STK}_CHK_NP are the various checking macros for
202 bog-standard case alternatives, thunks, and non-top-level
203 functions. In all these cases, node points to a closure that we
204 can just enter to restart the heap check (the NP stands for 'node points').
206 HpLim points to the LAST WORD of valid allocation space.
207 -------------------------------------------------------------------------- */
209 #define STK_CHK_NP(headroom,ptrs,tag_assts) \
210 if ((Sp - (headroom)) < SpLim) { \
211 EXTFUN_RTS(stg_gc_enter_##ptrs); \
213 JMP_(stg_gc_enter_##ptrs); \
216 #define HP_CHK_NP(headroom,ptrs,tag_assts) \
217 if ((Hp += (headroom)) > HpLim) { \
218 EXTFUN_RTS(stg_gc_enter_##ptrs); \
220 JMP_(stg_gc_enter_##ptrs); \
222 TICK_ALLOC_HEAP(headroom);
224 #define HP_CHK_SEQ_NP(headroom,ptrs,tag_assts) \
225 if ((Hp += (headroom)) > HpLim) { \
226 EXTFUN_RTS(stg_gc_seq_##ptrs); \
228 JMP_(stg_gc_seq_##ptrs); \
230 TICK_ALLOC_HEAP(headroom);
232 #define HP_STK_CHK_NP(stk_headroom, hp_headroom, ptrs, tag_assts) \
233 if ((Sp - (stk_headroom)) < SpLim || (Hp += (hp_headroom)) > HpLim) { \
234 EXTFUN_RTS(stg_gc_enter_##ptrs); \
236 JMP_(stg_gc_enter_##ptrs); \
238 TICK_ALLOC_HEAP(hp_headroom);
240 /* Heap checks for branches of a primitive case / unboxed tuple return */
242 #define GEN_HP_CHK_ALT(headroom,lbl,tag_assts) \
243 if ((Hp += (headroom)) > HpLim) { \
248 TICK_ALLOC_HEAP(headroom);
250 #define HP_CHK_NOREGS(headroom,tag_assts) \
251 GEN_HP_CHK_ALT(headroom,stg_gc_noregs,tag_assts);
252 #define HP_CHK_UNPT_R1(headroom,tag_assts) \
253 GEN_HP_CHK_ALT(headroom,stg_gc_unpt_r1,tag_assts);
254 #define HP_CHK_UNBX_R1(headroom,tag_assts) \
255 GEN_HP_CHK_ALT(headroom,stg_gc_unbx_r1,tag_assts);
256 #define HP_CHK_F1(headroom,tag_assts) \
257 GEN_HP_CHK_ALT(headroom,stg_gc_f1,tag_assts);
258 #define HP_CHK_D1(headroom,tag_assts) \
259 GEN_HP_CHK_ALT(headroom,stg_gc_d1,tag_assts);
261 #define HP_CHK_L1(headroom,tag_assts) \
262 GEN_HP_CHK_ALT(headroom,stg_gc_d1,tag_assts);
264 #define HP_CHK_UT_ALT(headroom, ptrs, nptrs, r, ret, tag_assts) \
265 GEN_HP_CHK_ALT(headroom, stg_gc_ut_##ptrs##_##nptrs, \
266 tag_assts r = (P_)ret;)
268 /* -----------------------------------------------------------------------------
271 These are slow, but have the advantage of being usable in a variety
274 The one restriction is that any relevant SRTs must already be pointed
275 to from the stack. The return address doesn't need to have an info
276 table attached: hence it can be any old code pointer.
278 The liveness mask is a logical 'XOR' of NO_PTRS and zero or more
279 Rn_PTR constants defined below. All registers will be saved, but
280 the garbage collector needs to know which ones contain pointers.
282 Good places to use a generic heap check:
284 - case alternatives (the return address with an SRT is already
287 - primitives (no SRT required).
289 The stack layout is like this:
298 so the liveness mask depends on the size of an StgDouble (FltRegs
299 and R<n> are guaranteed to be 1 word in size).
301 -------------------------------------------------------------------------- */
303 /* VERY MAGIC CONSTANTS!
304 * must agree with code in HeapStackCheck.c, stg_gen_chk
307 #if SIZEOF_DOUBLE > SIZEOF_VOID_P
308 #define ALL_NON_PTRS 0xffff
309 #else /* SIZEOF_DOUBLE == SIZEOF_VOID_P */
310 #define ALL_NON_PTRS 0x3fff
313 #define LIVENESS_MASK(ptr_regs) (ALL_NON_PTRS ^ (ptr_regs))
325 #define HP_CHK_GEN(headroom,liveness,reentry,tag_assts) \
326 if ((Hp += (headroom)) > HpLim ) { \
329 R9.w = (W_)LIVENESS_MASK(liveness); \
330 R10.w = (W_)reentry; \
333 TICK_ALLOC_HEAP(headroom);
335 #define STK_CHK_GEN(headroom,liveness,reentry,tag_assts) \
336 if ((Sp - (headroom)) < SpLim) { \
339 R9.w = (W_)LIVENESS_MASK(liveness); \
340 R10.w = (W_)reentry; \
344 #define MAYBE_GC(liveness,reentry) \
345 if (doYouWantToGC()) { \
347 R9.w = (W_)LIVENESS_MASK(liveness); \
348 R10.w = (W_)reentry; \
352 /* -----------------------------------------------------------------------------
353 Voluntary Yields/Blocks
355 We only have a generic version of this at the moment - if it turns
356 out to be slowing us down we can make specialised ones.
357 -------------------------------------------------------------------------- */
362 #define YIELD(liveness,reentry) \
364 R9.w = (W_)LIVENESS_MASK(liveness); \
365 R10.w = (W_)reentry; \
366 JMP_(stg_gen_yield); \
369 #define BLOCK(liveness,reentry) \
371 R9.w = (W_)LIVENESS_MASK(liveness); \
372 R10.w = (W_)reentry; \
373 JMP_(stg_gen_block); \
376 #define BLOCK_NP(ptrs) \
378 EF_(stg_block_##ptrs); \
379 JMP_(stg_block_##ptrs); \
382 /* -----------------------------------------------------------------------------
383 CCall_GC needs to push a dummy stack frame containing the contents
384 of volatile registers and variables.
386 We use a RET_DYN frame the same as for a dynamic heap check.
387 ------------------------------------------------------------------------- */
390 EI_(stg_gen_chk_info);
392 EDI_(stg_gen_chk_info);
394 /* -----------------------------------------------------------------------------
397 RETVEC(p,t) where 'p' is a pointer to the info table for a
398 vectored return address, returns the address of the return code for
401 Return vectors are placed in *reverse order* immediately before the info
402 table for the return address. Hence the formula for computing the
403 actual return address is (addr - sizeof(InfoTable) - tag - 1).
404 The extra subtraction of one word is because tags start at zero.
405 -------------------------------------------------------------------------- */
407 #ifdef USE_MINIINTERPRETER
408 #define RET_VEC(p,t) ((*(stgCast(StgInfoTable*,p)->vector))[t])
410 #define RET_VEC(p,t) (*((P_)(p) - sizeofW(StgInfoTable) - t - 1))
413 /* -----------------------------------------------------------------------------
415 -------------------------------------------------------------------------- */
417 /* set the tag register (if we have one) */
418 #define SET_TAG(t) /* nothing */
420 /* don't do eager blackholing for now */
421 #define UPD_BH_UPDATABLE(thunk) /* nothing */
422 #define UPD_BH_SINGLE_ENTRY(thunk) /* nothing */
424 /* -----------------------------------------------------------------------------
425 Moving Floats and Doubles
427 ASSIGN_FLT is for assigning a float to memory (usually the
428 stack/heap). The memory address is guaranteed to be
429 StgWord aligned (currently == sizeof(long)).
431 PK_FLT is for pulling a float out of memory. The memory is
432 guaranteed to be StgWord aligned.
433 -------------------------------------------------------------------------- */
435 static inline void ASSIGN_FLT (W_ [], StgFloat);
436 static inline StgFloat PK_FLT (W_ []);
438 #if ALIGNMENT_FLOAT <= ALIGNMENT_LONG
440 static inline void ASSIGN_FLT(W_ p_dest[], StgFloat src) { *(StgFloat *)p_dest = src; }
441 static inline StgFloat PK_FLT (W_ p_src[]) { return *(StgFloat *)p_src; }
443 #else /* ALIGNMENT_FLOAT > ALIGNMENT_UNSIGNED_INT */
445 static inline void ASSIGN_FLT(W_ p_dest[], StgFloat src)
452 static inline StgFloat PK_FLT(W_ p_src[])
459 #endif /* ALIGNMENT_FLOAT > ALIGNMENT_LONG */
461 #if ALIGNMENT_DOUBLE <= ALIGNMENT_LONG
463 static inline void ASSIGN_DBL (W_ [], StgDouble);
464 static inline StgDouble PK_DBL (W_ []);
466 static inline void ASSIGN_DBL(W_ p_dest[], StgDouble src) { *(StgDouble *)p_dest = src; }
467 static inline StgDouble PK_DBL (W_ p_src[]) { return *(StgDouble *)p_src; }
469 #else /* ALIGNMENT_DOUBLE > ALIGNMENT_LONG */
471 /* Sparc uses two floating point registers to hold a double. We can
472 * write ASSIGN_DBL and PK_DBL by directly accessing the registers
473 * independently - unfortunately this code isn't writable in C, we
474 * have to use inline assembler.
476 #if sparc_TARGET_ARCH
478 #define ASSIGN_DBL(dst,src) \
479 __asm__("st %2,%0\n\tst %R2,%1" : "=m" (((P_)(dst))[0]), \
480 "=m" (((P_)(dst))[1]) : "f" (src));
482 #define PK_DBL(src) \
483 ( { register double d; \
484 __asm__("ld %1,%0\n\tld %2,%R0" : "=f" (d) : \
485 "m" (((P_)(src))[0]), "m" (((P_)(src))[1])); d; \
488 #else /* ! sparc_TARGET_ARCH */
490 static inline void ASSIGN_DBL (W_ [], StgDouble);
491 static inline StgDouble PK_DBL (W_ []);
503 static inline void ASSIGN_DBL(W_ p_dest[], StgDouble src)
507 p_dest[0] = y.du.dhi;
508 p_dest[1] = y.du.dlo;
511 /* GCC also works with this version, but it generates
512 the same code as the previous one, and is not ANSI
514 #define ASSIGN_DBL( p_dest, src ) \
515 *p_dest = ((double_thing) src).du.dhi; \
516 *(p_dest+1) = ((double_thing) src).du.dlo \
519 static inline StgDouble PK_DBL(W_ p_src[])
527 #endif /* ! sparc_TARGET_ARCH */
529 #endif /* ALIGNMENT_DOUBLE > ALIGNMENT_UNSIGNED_INT */
531 #ifdef SUPPORT_LONG_LONGS
536 } unpacked_double_word;
540 unpacked_double_word iu;
545 unpacked_double_word wu;
548 static inline void ASSIGN_Word64(W_ p_dest[], StgWord64 src)
552 p_dest[0] = y.wu.dhi;
553 p_dest[1] = y.wu.dlo;
556 static inline StgWord64 PK_Word64(W_ p_src[])
564 static inline void ASSIGN_Int64(W_ p_dest[], StgInt64 src)
568 p_dest[0] = y.iu.dhi;
569 p_dest[1] = y.iu.dlo;
572 static inline StgInt64 PK_Int64(W_ p_src[])
581 /* -----------------------------------------------------------------------------
583 -------------------------------------------------------------------------- */
585 extern DLL_IMPORT_DATA const StgPolyInfoTable catch_frame_info;
587 /* -----------------------------------------------------------------------------
590 A seq frame is very like an update frame, except that it doesn't do
592 -------------------------------------------------------------------------- */
594 extern DLL_IMPORT_DATA const StgPolyInfoTable seq_frame_info;
596 #define PUSH_SEQ_FRAME(sp) \
598 StgSeqFrame *__frame; \
599 TICK_SEQF_PUSHED(); \
600 __frame = (StgSeqFrame *)(sp); \
601 SET_HDR_(__frame,&seq_frame_info,CCCS); \
602 __frame->link = Su; \
603 Su = (StgUpdateFrame *)__frame; \
606 /* -----------------------------------------------------------------------------
608 -------------------------------------------------------------------------- */
610 #if defined(USE_SPLIT_MARKERS)
611 #define __STG_SPLIT_MARKER(n) FN_(__stg_split_marker##n) { }
613 #define __STG_SPLIT_MARKER(n) /* nothing */
616 /* -----------------------------------------------------------------------------
617 Closure and Info Macros with casting.
619 We don't want to mess around with casts in the generated C code, so
620 we use these casting versions of the closure/info tables macros.
621 -------------------------------------------------------------------------- */
623 #define SET_HDR_(c,info,ccs) \
624 SET_HDR((StgClosure *)(c),(StgInfoTable *)(info),ccs)
626 /* -----------------------------------------------------------------------------
627 Saving context for exit from the STG world, and loading up context
628 on entry to STG code.
630 We save all the STG registers (that is, the ones that are mapped to
631 machine registers) in their places in the TSO.
633 The stack registers go into the current stack object, and the heap
634 registers are saved in global locations.
635 -------------------------------------------------------------------------- */
637 static __inline__ void
638 SaveThreadState(void)
640 /* Don't need to save REG_Base, it won't have changed. */
644 CurrentTSO->splim = SpLim;
647 #if defined(PROFILING)
648 CurrentTSO->prof.CCCS = CCCS;
652 static __inline__ void
653 LoadThreadState (void)
656 BaseReg = (StgRegTable*)&MainRegTable;
661 SpLim = CurrentTSO->splim;
662 OpenNursery(Hp,HpLim);
664 # if defined(PROFILING)
665 CCCS = CurrentTSO->prof.CCCS;
669 #endif /* STGMACROS_H */