X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fincludes%2FClosureMacros.h;h=70470e93b51121ef0fe906a2cb118d1b2bb81c8d;hb=b3155aac1d0b847fb9249c08faad58f0ba576617;hp=9d8f6cf2add519140f71c3ffb9ccc79df501f01e;hpb=438596897ebbe25a07e1c82085cfbc5bdb00f09e;p=ghc-hetmet.git diff --git a/ghc/includes/ClosureMacros.h b/ghc/includes/ClosureMacros.h index 9d8f6cf..70470e9 100644 --- a/ghc/includes/ClosureMacros.h +++ b/ghc/includes/ClosureMacros.h @@ -1,5 +1,7 @@ /* ---------------------------------------------------------------------------- - * $Id: ClosureMacros.h,v 1.2 1998/12/02 13:20:58 simonm Exp $ + * $Id: ClosureMacros.h,v 1.33 2001/11/22 14:25:11 simonmar Exp $ + * + * (c) The GHC Team, 1998-1999 * * Macros for building and manipulating closures * @@ -8,14 +10,10 @@ #ifndef CLOSUREMACROS_H #define CLOSUREMACROS_H -/* ----------------------------------------------------------------------------- - Fixed Header Size - - The compiler tries to abstract away from the actual value of this - constant. - -------------------------------------------------------------------------- */ - -#define _FHS sizeof(StgHeader) +/* Say whether the code comes before the heap; on mingwin this may not be the + case, not because of another random MS pathology, but because the static + program may reside in a DLL +*/ /* ----------------------------------------------------------------------------- Info tables are slammed up against the entry code, and the label @@ -57,151 +55,63 @@ #define INIT_INFO(i) info : &(i) #define SET_INFO(c,i) ((c)->header.info = (i)) #define GET_INFO(c) ((c)->header.info) +#define GET_ENTRY(c) (ENTRY_CODE(GET_INFO(c))) +#define get_itbl(c) (INFO_PTR_TO_STRUCT((c)->header.info)) -#if USE_MINIINTERPRETER -#define INIT_ENTRY(e) entry : (F_)(e) -#define GET_ENTRY(c) ((c)->header.info->entry) -#define ENTRY_CODE(info) (stgCast(StgInfoTable*,info)->entry) -#define INFO_PTR_TO_STRUCT(info) (info) -#define get_itbl(c) ((c)->header.info) +#ifdef TABLES_NEXT_TO_CODE +#define INIT_ENTRY(e) code : {} +#define ENTRY_CODE(info) (info) +#define INFO_PTR_TO_STRUCT(info) ((StgInfoTable *)(info) - 1) static __inline__ StgFunPtr get_entry(const StgInfoTable *itbl) { - return itbl->entry; + return (StgFunPtr)(itbl+1); } #else -#define INIT_ENTRY(e) code : {} -#define GET_ENTRY(c) stgCast(StgFunPtr,((c)->header.info)) -#define ENTRY_CODE(info) (info) -#define INFO_PTR_TO_STRUCT(info) (stgCast(StgInfoTable*,info) - 1) -#define get_itbl(c) (stgCast(StgInfoTable*,(c)->header.info) -1) +#define INIT_ENTRY(e) entry : (F_)(e) +#define ENTRY_CODE(info) (((StgInfoTable *)info)->entry) +#define INFO_PTR_TO_STRUCT(info) ((StgInfoTable *)info) static __inline__ StgFunPtr get_entry(const StgInfoTable *itbl) { - return stgCast(StgFunPtr,itbl+1); + return itbl->entry; } #endif /* ----------------------------------------------------------------------------- - Macros for distinguishing data pointers from code pointers - -------------------------------------------------------------------------- */ -/* - * We use some symbols inserted automatically by the linker to decide - * whether a pointer points to text, data, or user space. These tests - * assume that text is lower in the address space than data, which in - * turn is lower than user allocated memory. - * - * If this assumption is false (say on some strange architecture) then - * the tests IS_CODE_PTR and IS_DATA_PTR below will need to be - * modified (and that should be all that's necessary). - * - * _start } start of read-only text space - * _etext } end of read-only text space - * _end } end of read-write data space - */ -extern StgFun start; -extern StgFun TEXT_SECTION_END_MARKER_DECL; -extern StgFun DATA_SECTION_END_MARKER_DECL; - -#define IS_CODE_PTR(p) ((P_)(p) < (P_)&TEXT_SECTION_END_MARKER) -#define IS_DATA_PTR(p) ((P_)(p) >= (P_)&TEXT_SECTION_END_MARKER && (P_)(p) < (P_)&DATA_SECTION_END_MARKER) -#define IS_USER_PTR(p) ((P_)(p) >= (P_)&DATA_SECTION_END_MARKER) - -/* ----------------------------------------------------------------------------- - Macros for distinguishing infotables from closures. - - You'd think it'd be easy to tell an info pointer from a closure pointer: - closures live on the heap and infotables are in read only memory. Right? - Wrong! Static closures live in read only memory and Hugs allocates - infotables for constructors on the (writable) C heap. - - ToDo: in the combined Hugs-GHC system, the following are but crude - approximations. This absolutely has to be fixed. + Macros for building closures -------------------------------------------------------------------------- */ -#ifdef USE_MINIINTERPRETER -/* yoiks: one of the dreaded pointer equality tests */ -#define IS_HUGS_CONSTR_INFO(info) (stgCast(StgInfoTable*,info)->entry == stgCast(StgFunPtr,&Hugs_CONSTR_entry)) -#else -#define IS_HUGS_CONSTR_INFO(info) 0 /* ToDo: more than mildly bogus */ -#endif - -#ifdef USE_MINIINTERPRETER -/* in the mininterpreter, we put infotables on closures */ -#define LOOKS_LIKE_GHC_INFO(info) IS_CODE_PTR(info) +#ifdef PROFILING +#ifdef DEBUG_RETAINER +/* + For the sake of debugging, we take the safest way for the moment. Actually, this + is useful to check the sanity of heap before beginning retainer profiling. + flip is defined in RetainerProfile.c, and declared as extern in RetainerProfile.h. + Note: change those functions building Haskell objects from C datatypes, i.e., + all rts_mk???() functions in RtsAPI.c, as well. + */ +extern StgWord flip; +#define SET_PROF_HDR(c,ccs_) \ + ((c)->header.prof.ccs = ccs_, (c)->header.prof.hp.rs = (retainerSet *)((StgWord)NULL | flip)) #else -/* otherwise we have entry pointers on closures */ -#define LOOKS_LIKE_GHC_INFO(info) IS_CODE_PTR(info) -#endif - -#define LOOKS_LIKE_STATIC(r) IS_DATA_PTR(r) - -/* ----------------------------------------------------------------------------- - Macros for calculating how big a closure will be (used during allocation) - -------------------------------------------------------------------------- */ - -/* ToDo: replace unsigned int by nat. The only fly in the ointment is that - * nat comes from Rts.h which many folk dont include. Sigh! +/* + For retainer profiling only: we do not have to set (c)->header.prof.hp.rs to + NULL | flip (flip is defined in RetainerProfile.c) because even when flip + is 1, rs is invalid and will be initialized to NULL | flip later when + the closure *c is visited. */ -static __inline__ StgOffset AP_sizeW ( unsigned int n_args ) -{ return sizeofW(StgAP_UPD) + n_args; } - -static __inline__ StgOffset PAP_sizeW ( unsigned int n_args ) -{ return sizeofW(StgPAP) + n_args; } - -static __inline__ StgOffset CONSTR_sizeW( unsigned int p, unsigned int np ) -{ return sizeofW(StgHeader) + p + np; } - -static __inline__ StgOffset BCO_sizeW ( unsigned int p, unsigned int np, unsigned int is ) -{ return sizeofW(StgBCO) + p + np + (is+sizeof(StgWord)-1)/sizeof(StgWord); } - -static __inline__ StgOffset THUNK_SELECTOR_sizeW ( void ) -{ return sizeofW(StgHeader) + MIN_UPD_SIZE; } - -static __inline__ StgOffset BLACKHOLE_sizeW ( void ) -{ return sizeofW(StgHeader) + MIN_UPD_SIZE; } - -static __inline__ StgOffset CAF_sizeW ( void ) -{ return sizeofW(StgCAF); } - -/* -------------------------------------------------------------------------- - * Sizes of closures - * ------------------------------------------------------------------------*/ - -static __inline__ StgOffset size_fromITBL( const StgInfoTable* itbl ) -{ return sizeof(StgClosure) - + sizeof(StgPtr) * itbl->layout.payload.ptrs - + sizeof(StgWord) * itbl->layout.payload.nptrs; } - -static __inline__ StgOffset sizeW_fromITBL( const StgInfoTable* itbl ) -{ return sizeofW(StgClosure) - + sizeofW(StgPtr) * itbl->layout.payload.ptrs - + sizeofW(StgWord) * itbl->layout.payload.nptrs; } - -static __inline__ StgOffset pap_size( StgPAP* x ) -{ return sizeof(StgPAP) - + sizeof(StgWord) * x->n_args; } - -static __inline__ StgOffset pap_sizeW( StgPAP* x ) -{ return PAP_sizeW(x->n_args); } - -/* These two functions give the same result - but have slightly - * different types. +/* +#define SET_PROF_HDR(c,ccs_) \ + ((c)->header.prof.ccs = ccs_, (c)->header.prof.hp.rs = NULL) */ -static __inline__ StgOffset arr_words_sizeW( StgArrWords* x ) -{ return sizeofW(StgArrWords) + x->words; } -static __inline__ StgOffset arr_ptrs_sizeW( StgArrPtrs* x ) -{ return sizeofW(StgArrPtrs) + x->ptrs; } - -static __inline__ StgWord bco_sizeW( StgBCO* bco ) -{ return BCO_sizeW(bco->n_ptrs,bco->n_words,bco->n_instrs); } - -static __inline__ StgWord tso_sizeW ( StgTSO *tso ) -{ return TSO_STRUCT_SIZEW + tso->stack_size; } - -/* ----------------------------------------------------------------------------- - Macros for building closures - -------------------------------------------------------------------------- */ - -#ifdef PROFILING -#define SET_PROF_HDR(c,ccs_) (c)->header.prof.ccs = ccs_ -#define SET_STATIC_PROF_HDR(ccs_) prof : { ccs : ccs_ }, +/* + The following macro works for both retainer profiling and LDV profiling: + for retainer profiling, ldvTime remains 0, so rs fields are initialized to 0. + See the invariants on ldvTime. + */ +#define SET_PROF_HDR(c,ccs_) \ + ((c)->header.prof.ccs = ccs_, \ + LDV_recordCreate((c))) +#endif // DEBUG_RETAINER +#define SET_STATIC_PROF_HDR(ccs_) \ + prof : { ccs : ccs_, hp : { rs : NULL } }, #else #define SET_PROF_HDR(c,ccs) #define SET_STATIC_PROF_HDR(ccs) @@ -215,8 +125,6 @@ static __inline__ StgWord tso_sizeW ( StgTSO *tso ) #define SET_STATIC_GRAN_HDR #endif -/* there is no PAR header, as far as I can tell -- SDM */ - #ifdef PAR #define SET_PAR_HDR(c,stuff) #define SET_STATIC_PAR_HDR(stuff) @@ -225,50 +133,49 @@ static __inline__ StgWord tso_sizeW ( StgTSO *tso ) #define SET_STATIC_PAR_HDR(stuff) #endif -#ifdef TICKY -#define SET_TICKY_HDR(c,stuff) (c)->header.ticky.updated = stuff -#define SET_STATIC_TICKY_HDR(stuff) ticky : { updated : stuff } +#ifdef TICKY_TICKY +#define SET_TICKY_HDR(c,stuff) /* old: (c)->header.ticky.updated = stuff */ +#define SET_STATIC_TICKY_HDR(stuff) /* old: ticky : { updated : stuff } */ #else #define SET_TICKY_HDR(c,stuff) #define SET_STATIC_TICKY_HDR(stuff) #endif -#define SET_HDR(c,info,ccs) \ - { \ - SET_INFO(c,info); \ + +#define SET_HDR(c,info,ccs) \ + { \ + SET_INFO(c,info); \ SET_GRAN_HDR((StgClosure *)(c),ThisPE); \ SET_PAR_HDR((StgClosure *)(c),LOCAL_GA); \ SET_PROF_HDR((StgClosure *)(c),ccs); \ SET_TICKY_HDR((StgClosure *)(c),0); \ } -/* works for all ARR_WORDS, ARR_PTRS variants (at the moment...) */ - -#define SET_ARR_HDR(c,info,costCentreStack,n_words) \ - SET_HDR(c,info,costCentreStack); \ +#define SET_ARR_HDR(c,info,costCentreStack,n_words) \ + SET_HDR(c,info,costCentreStack); \ (c)->words = n_words; /* ----------------------------------------------------------------------------- Static closures are defined as follows: -SET_STATIC_HDR(PrelBase_CZh_closure,PrelBase_CZh_info,costCentreStack,const); + SET_STATIC_HDR(PrelBase_CZh_closure,PrelBase_CZh_info,costCentreStack,closure_class,info_class); The info argument must have type 'StgInfoTable' or 'StgSRTInfoTable', since we use '&' to get its address in the macro. -------------------------------------------------------------------------- */ -#define SET_STATIC_HDR(label,info,costCentreStack,closure_class,info_class) \ - info_class info; \ - closure_class StgClosure label = { \ +#define SET_STATIC_HDR(label,info,costCentreStack,closure_class,info_class) \ + info_class info; \ + closure_class StgClosure label = { \ STATIC_HDR(info,costCentreStack) -#define STATIC_HDR(info,ccs) \ - header : { \ - INIT_INFO(info), \ - SET_STATIC_GRAN_HDR \ - SET_STATIC_PAR_HDR(LOCAL_GA) \ - SET_STATIC_PROF_HDR(ccs) \ - SET_STATIC_TICKY_HDR(0) \ +#define STATIC_HDR(info,ccs) \ + header : { \ + INIT_INFO(info), \ + SET_STATIC_GRAN_HDR \ + SET_STATIC_PAR_HDR(LOCAL_GA) \ + SET_STATIC_PROF_HDR(ccs) \ + SET_STATIC_TICKY_HDR(0) \ } /* how to get hold of the static link field for a static closure. @@ -276,27 +183,34 @@ SET_STATIC_HDR(PrelBase_CZh_closure,PrelBase_CZh_info,costCentreStack,const); * Note that we have to use (*cast(T*,&e)) instead of cast(T,e) * because C won't let us take the address of a casted expression. Huh? */ -#define STATIC_LINK(info,p) \ - (*stgCast(StgClosure**,&((p)->payload[info->layout.payload.ptrs + \ +#define STATIC_LINK(info,p) \ + (*(StgClosure**)(&((p)->payload[info->layout.payload.ptrs + \ info->layout.payload.nptrs]))) -#define STATIC_LINK2(info,p) \ - (*stgCast(StgClosure**,&((p)->payload[info->layout.payload.ptrs + \ + +/* These macros are optimised versions of the above for certain + * closure types. They *must* be equivalent to the generic + * STATIC_LINK. + */ +#define FUN_STATIC_LINK(p) ((p)->payload[0]) +#define THUNK_STATIC_LINK(p) ((p)->payload[2]) +#define IND_STATIC_LINK(p) ((p)->payload[1]) + +#define STATIC_LINK2(info,p) \ + (*(StgClosure**)(&((p)->payload[info->layout.payload.ptrs + \ info->layout.payload.nptrs + 1]))) /* ----------------------------------------------------------------------------- INTLIKE and CHARLIKE closures. -------------------------------------------------------------------------- */ -#define CHARLIKE_CLOSURE(n) ((P_)&CHARLIKE_closure[n]) -#define INTLIKE_CLOSURE(n) ((P_)&INTLIKE_closure[(n)-MIN_INTLIKE]) +#define CHARLIKE_CLOSURE(n) ((P_)&stg_CHARLIKE_closure[(n)-MIN_CHARLIKE]) +#define INTLIKE_CLOSURE(n) ((P_)&stg_INTLIKE_closure[(n)-MIN_INTLIKE]) /* ----------------------------------------------------------------------------- - Payload access + Closure Tables (for enumerated data types) -------------------------------------------------------------------------- */ -#define payloadPtr( c, i ) (*stgCast(StgPtr*, ((c)->payload+(i)))) -#define payloadCPtr( c, i ) (*stgCast(StgClosure**, ((c)->payload+(i)))) -#define payloadWord( c, i ) (*stgCast(StgWord*, ((c)->payload+(i)))) +#define CLOSURE_TBL(lbl) const StgClosure *lbl[] = { /* ----------------------------------------------------------------------------- CONSTRs. @@ -305,20 +219,4 @@ SET_STATIC_HDR(PrelBase_CZh_closure,PrelBase_CZh_info,costCentreStack,const); /* constructors don't have SRTs */ #define GET_TAG(info) (INFO_PTR_TO_STRUCT(info)->srt_len) -/* ----------------------------------------------------------------------------- - BCOs. - -------------------------------------------------------------------------- */ - -#define bcoConstPtr( bco, i ) (*stgCast(StgPtr*, ((bco)->payload+(i)))) -#define bcoConstCPtr( bco, i ) (*stgCast(StgClosurePtr*,((bco)->payload+(i)))) -#define bcoConstInfoPtr( bco, i )(*stgCast(StgInfoTable**,((bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstInt( bco, i ) (*stgCast(StgInt*, ((bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstInt64( bco, i ) (PK_Int64(stgCast(StgWord*,(bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstWord( bco, i ) (*stgCast(StgWord*, ((bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstAddr( bco, i ) (*stgCast(StgAddr*, ((bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstChar( bco, i ) (*stgCast(StgChar*, ((bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstFloat( bco, i ) (PK_FLT(stgCast(StgWord*,(bco)->payload+(bco)->n_ptrs+i))) -#define bcoConstDouble( bco, i ) (PK_DBL(stgCast(StgWord*,(bco)->payload+(bco)->n_ptrs+i))) -#define bcoInstr( bco, i ) (stgCast(StgNat8*, ((bco)->payload+(bco)->n_ptrs+(bco)->n_words))[i]) - #endif /* CLOSUREMACROS_H */