[project @ 2002-12-05 23:49:43 by mthomas]
[ghc-hetmet.git] / ghc / includes / InfoTables.h
index fb1640d..1aff768 100644 (file)
@@ -1,6 +1,8 @@
 /* ----------------------------------------------------------------------------
- * $Id: InfoTables.h,v 1.6 1999/01/26 11:12:55 simonm Exp $
+ * $Id: InfoTables.h,v 1.27 2002/05/14 08:15:49 matthewc Exp $
  * 
+ * (c) The GHC Team, 1998-1999
+ *
  * Info Tables
  *
  * -------------------------------------------------------------------------- */
    Profiling info
    -------------------------------------------------------------------------- */
 
-#ifdef PROFILING
-
-#define PROF_INFO_WORDS n
-
 typedef struct {
-  /* nothing yet */
+    char *closure_type;
+    char *closure_desc;
 } StgProfInfo;
 
-#else /* !PROFILING */
-
-#define PROF_INFO_WORDS 0
-
-typedef struct {
-  /* empty */
-} StgProfInfo;
-
-#endif /* PROFILING */
-
 /* -----------------------------------------------------------------------------
    Parallelism info
    -------------------------------------------------------------------------- */
 
-#ifdef PAR
+#if 0 && (defined(PAR) || defined(GRAN))
 
-#define PAR_INFO_WORDS 0
+// CURRENTLY UNUSED
+// ToDo: use this in StgInfoTable (mutually recursive) -- HWL
 
 typedef struct {
-       /* empty */
+  StgInfoTable *rbh_infoptr;     /* infoptr to the RBH  */
 } StgParInfo;
 
-#else /* !PAR */
+#endif /* 0 */
 
-#define PAR_INFO_WORDS 0
+/*
+   Copied from ghc-0.29; ToDo: check this code -- HWL
 
-typedef struct {
-       /* empty */
-} StgParInfo;
+   In the parallel system, all updatable closures have corresponding
+   revertible black holes.  When we are assembly-mangling, we guarantee
+   that the revertible black hole code precedes the normal entry code, so
+   that the RBH info table resides at a fixed offset from the normal info
+   table.  Otherwise, we add the RBH info table pointer to the end of the
+   normal info table and vice versa.
+
+   Currently has to use a !RBH_MAGIC_OFFSET setting.
+   Still todo: init of par.infoptr field in all infotables!!
+*/
+
+#if defined(PAR) || defined(GRAN)
+
+# ifdef RBH_MAGIC_OFFSET
+
+#  error magic offset not yet implemented
+
+#  define RBH_INFO_WORDS    0
+#  define INCLUDE_RBH_INFO(infoptr)
+
+#  define RBH_INFOPTR(infoptr)     (((P_)infoptr) - RBH_MAGIC_OFFSET)
+#  define REVERT_INFOPTR(infoptr)   (((P_)infoptr) + RBH_MAGIC_OFFSET)
+
+# else
 
-#endif /* PAR */
+#  define RBH_INFO_WORDS    1
+#  define INCLUDE_RBH_INFO(info)    rbh_infoptr : &(info)
+
+#  define RBH_INFOPTR(infoptr)     (((StgInfoTable *)(infoptr))->rbh_infoptr)
+#  define REVERT_INFOPTR(infoptr)   (((StgInfoTable *)(infoptr))->rbh_infoptr)
+
+# endif
+
+/* see ParallelRts.h */
+// EXTFUN(RBH_entry);
+//StgClosure *convertToRBH(StgClosure *closure);
+//#if defined(GRAN)
+//void convertFromRBH(StgClosure *closure);
+//#elif defined(PAR)
+//void convertToFetchMe(StgPtr closure, globalAddr *ga);
+//#endif
+
+#endif
+
+/* -----------------------------------------------------------------------------
+   Ticky info
+   -------------------------------------------------------------------------- */
+
+typedef struct {
+    /* empty */
+} StgTickyInfo;
 
 /* -----------------------------------------------------------------------------
    Debugging info
@@ -58,16 +95,12 @@ typedef struct {
 
 #ifdef DEBUG_CLOSURE
 
-#define DEBUG_INFO_WORDS n
-
 typedef struct {
        ... whatever ...
 } StgDebugInfo;
 
 #else /* !DEBUG_CLOSURE */
 
-#define DEBUG_INFO_WORDS 0
-
 typedef struct {
        /* empty */
 } StgDebugInfo;
@@ -75,149 +108,55 @@ typedef struct {
 #endif /* DEBUG_CLOSURE */
 
 /* -----------------------------------------------------------------------------
-   Closure Types
-
-   If you add or delete any closure types, don't forget to update
-   ClosureTypes.h for the native code generator.  This is a temporary
-   measure (I hope).
+   Closure flags
    -------------------------------------------------------------------------- */
 
-typedef enum {
-
-    INVALID_OBJECT /* Object tag 0 raises an internal error */
-    , CONSTR
-    /* CONSTR_p_np */
-    , CONSTR_INTLIKE
-    , CONSTR_CHARLIKE
-    , CONSTR_STATIC
-    , CONSTR_NOCAF_STATIC
-
-    , FUN
-    , FUN_STATIC
-
-    , THUNK
-    /* THUNK_p_np */
-    , THUNK_STATIC
-    , THUNK_SELECTOR
-
-    , BCO
-    , AP_UPD
-
-    , PAP  /* should be called AP_NUPD */
-
-    , IND
-    , IND_OLDGEN
-    , IND_PERM
-    , IND_OLDGEN_PERM
-    , IND_STATIC
-
-    , CAF_UNENTERED
-    , CAF_ENTERED
-    , CAF_BLACKHOLE
-
-    , RET_BCO
-    , RET_SMALL
-    , RET_VEC_SMALL
-    , RET_BIG
-    , RET_VEC_BIG
-    , RET_DYN
-    , UPDATE_FRAME
-    , CATCH_FRAME
-    , STOP_FRAME
-    , SEQ_FRAME
-
-    , BLACKHOLE
-    , BLACKHOLE_BQ
-
-    , MVAR
-
-    , ARR_WORDS
-    , MUT_ARR_WORDS
-
-    , MUT_ARR_PTRS
-    , MUT_ARR_PTRS_FROZEN
-
-    , MUT_VAR
-
-    , WEAK
-    , FOREIGN
-    , STABLE_NAME
-
-    , TSO
-
-    , BLOCKED_FETCH
-    , FETCH_ME
-
-    , EVACUATED
-
-    , N_CLOSURE_TYPES          /* number of distinct closure types */
-
-} StgClosureType;
-
 /* The type flags provide quick access to certain properties of a closure. */
 
-#define _HNF (1<<0)  /* head normal form?  */
+#define _HNF (1<<0)  /* head normal form?    */
 #define _BTM (1<<1)  /* bitmap-style layout? */
-#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 isSTATIC(flags)  ((flags)&_STA)
-#define isMUTABLE(flags) ((flags) &_MUT)
-
-#define closure_STATIC(closure)       (  get_itbl(closure)->flags & _STA)
-#define closure_SHOULD_SPARK(closure) (!(get_itbl(closure)->flags & _NS))
-#define closure_MUTABLE(closure)      (  get_itbl(closure)->flags & _MUT)
-#define closure_UNPOINTED(closure)    (  get_itbl(closure)->flags & _UPT)
-
-/*                                 HNF  BTM   NS  STA  THU MUT UPT SRT */
-                                                                   
-#define FLAGS_CONSTR              (_HNF|     _NS                        )      
-#define FLAGS_CONSTR_STATIC       (_HNF|     _NS|_STA                   )      
-#define FLAGS_CONSTR_NOCAF_STATIC  (_HNF|     _NS|_STA                   )     
-#define FLAGS_FUN                 (_HNF|     _NS|                  _SRT )      
-#define FLAGS_FUN_STATIC          (_HNF|     _NS|_STA|             _SRT )      
-#define FLAGS_THUNK               (     _BTM|         _THU|        _SRT )      
-#define FLAGS_THUNK_STATIC        (     _BTM|    _STA|_THU|        _SRT )      
-#define FLAGS_THUNK_SELECTOR      (     _BTM|         _THU|        _SRT )      
-#define FLAGS_BCO                 (_HNF|     _NS                        )      
-#define FLAGS_CAF_UNENTERED        0 /* Do we still use these? */
-#define FLAGS_CAF_ENTERED          0
-#define FLAGS_CAF_BLACKHOLE        (    _BTM|_NS|              _UPT     )
-#define FLAGS_AP_UPD              (     _BTM|         _THU              )      
-#define FLAGS_PAP                 (_HNF|     _NS                        )      
-#define FLAGS_IND                 0
-#define FLAGS_IND_OLDGEN          0
-#define FLAGS_IND_PERM            0
-#define FLAGS_IND_OLDGEN_PERM     0
-#define FLAGS_IND_STATIC          (              _STA                   )      
-#define FLAGS_EVACUATED                   0
-#define FLAGS_ARR_WORDS                   (_HNF|     _NS|              _UPT     )      
-#define FLAGS_MUT_ARR_WORDS       (_HNF|     _NS|         _MUT|_UPT     )      
-#define FLAGS_MUT_ARR_PTRS        (_HNF|     _NS|         _MUT|_UPT     )      
-#define FLAGS_MUT_ARR_PTRS_FROZEN  (_HNF|     _NS|         _MUT|_UPT     )     
-#define FLAGS_MUT_VAR             (_HNF|     _NS|         _MUT|_UPT     )      
-#define FLAGS_FOREIGN             (_HNF|     _NS|              _UPT     )      
-#define FLAGS_STABLE_NAME         (_HNF|     _NS|              _UPT     )      
-#define FLAGS_WEAK                (_HNF|     _NS|              _UPT     )      
-#define FLAGS_BLACKHOLE                   (          _NS|              _UPT     )      
-#define FLAGS_BLACKHOLE_BQ        (          _NS|         _MUT|_UPT     )      
-#define FLAGS_MVAR                (_HNF|     _NS|         _MUT|_UPT     )      
-#define FLAGS_FETCH_ME            (_HNF|     _NS                        )      
-#define FLAGS_TSO                  (_HNF|     _NS|         _MUT|_UPT     )
-#define FLAGS_RET_BCO             (     _BTM                            )
-#define FLAGS_RET_SMALL                   (     _BTM|                       _SRT)
-#define FLAGS_RET_VEC_SMALL       (     _BTM|                       _SRT)
-#define FLAGS_RET_BIG             (                                 _SRT)
-#define FLAGS_RET_VEC_BIG         (                                 _SRT)
-#define FLAGS_RET_DYN             (                                 _SRT)
-#define FLAGS_CATCH_FRAME         (     _BTM                            )
-#define FLAGS_STOP_FRAME          (     _BTM                            )
-#define FLAGS_SEQ_FRAME           (     _BTM                            )
-#define FLAGS_UPDATE_FRAME         (     _BTM                            )
+#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?   */
+
+#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)
+
+extern StgWord16 closure_flags[];
+
+#define closureFlags(c)         (closure_flags[get_itbl(c)->type])
+
+#define closure_HNF(c)          (  closureFlags(c) & _HNF)
+#define closure_BITMAP(c)       (  closureFlags(c) & _BTM)
+#define closure_NON_SPARK(c)    ( (closureFlags(c) & _NS))
+#define closure_SHOULD_SPARK(c) (!(closureFlags(c) & _NS))
+#define closure_STATIC(c)       (  closureFlags(c) & _STA)
+#define closure_THUNK(c)        (  closureFlags(c) & _THU)
+#define closure_MUTABLE(c)      (  closureFlags(c) & _MUT)
+#define closure_UNPOINTED(c)    (  closureFlags(c) & _UPT)
+#define closure_SRT(c)          (  closureFlags(c) & _SRT)
+#define closure_IND(c)          (  closureFlags(c) & _IND)
+
+/* same as above but for info-ptr rather than closure */
+#define ipFlags(ip)             (closure_flags[ip->type])
+
+#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)
+#define ip_IND(ip)              (  ipFlags(ip) & _IND)
 
 /* -----------------------------------------------------------------------------
    Info Tables
@@ -230,7 +169,7 @@ typedef enum {
 
 typedef struct {
   StgWord size;
-  StgWord bitmap[0];
+  StgWord bitmap[FLEXIBLE_ARRAY];
 } StgLargeBitmap;
 
 /*
@@ -241,22 +180,19 @@ typedef struct {
  */
 
 typedef union {
+  struct {
+#if SIZEOF_VOID_P == 8
+    StgWord32 ptrs;            /* number of pointers     */
+    StgWord32 nptrs;           /* number of non-pointers */
+#else
+    StgWord16 ptrs;            /* number of pointers     */
+    StgWord16 nptrs;           /* number of non-pointers */
+#endif
+  } payload;
 
   StgWord bitmap;              /* bit pattern, 1 = pointer, 0 = non-pointer */
   StgWord selector_offset;     /* used in THUNK_SELECTORs */
   StgLargeBitmap* large_bitmap;        /* pointer to large bitmap structure */
-
-#if SIZEOF_VOID_P == 8
-  struct {
-    StgNat32 ptrs;             /* number of pointers     */
-    StgNat32 nptrs;            /* number of non-pointers */
-  } payload;
-#else
-  struct {
-    StgNat16 ptrs;             /* number of pointers     */
-    StgNat16 nptrs;            /* number of non-pointers */
-  } payload;
-#endif
   
 } StgClosureInfo;
 
@@ -269,27 +205,55 @@ typedef union {
 
 typedef StgClosure* StgSRT[];
 
+/*
+ * The entry code pointer must be the first word of an info table.
+ * See the comment in ghc/rts/Storage.h (Plan C) for details.
+ */
 typedef struct _StgInfoTable {
+#ifndef TABLES_NEXT_TO_CODE
+    StgFunPtr       entry;
+#endif
     StgSRT         *srt;       /* pointer to the SRT table */
-    StgParInfo     par;
+#if defined(PAR) || defined(GRAN)
+    struct _StgInfoTable    *rbh_infoptr;
+#endif
+#ifdef PROFILING
     StgProfInfo     prof;
+#endif
+#ifdef TICKY
+    StgTickyInfo    ticky;
+#endif
+#ifdef DEBUG_CLOSURE
     StgDebugInfo    debug;
+#endif
     StgClosureInfo  layout;    /* closure layout info (pointer-sized) */
 #if SIZEOF_VOID_P == 8
-    StgNat16        flags;     /* }                                   */
-    StgClosureType  type : 16; /* } These 4 elements fit into 64 bits */
-    StgNat32        srt_len;    /* }                                   */
+    StgWord32       type;      /* } These 2 elements fit into 64 bits */
+    StgWord32       srt_len;    /* }                                   */
 #else
-    StgNat8         flags;     /* }                                   */
-    StgClosureType  type : 8;  /* } These 4 elements fit into 32 bits */
-    StgNat16        srt_len;    /* }                                   */
+    StgWord         type : 16; /* } These 2 elements fit into 32 bits */
+    StgWord         srt_len : 16; /* }                                   */
 #endif
-#if USE_MINIINTERPRETER
-    StgFunPtr       (*vector)[];
-    StgFunPtr       entry;
+#ifdef TABLES_NEXT_TO_CODE
+    StgCode         code[FLEXIBLE_ARRAY];
 #else
-    StgCode         code[0];
+    StgFunPtr       vector[FLEXIBLE_ARRAY];
 #endif
 } StgInfoTable;
 
+/* Info tables are read-only, therefore we uniformly declare them with
+ * C's const attribute.  This isn't just a nice thing to do: it's
+ * necessary because the garbage collector has to distinguish between 
+ * closure pointers and info table pointers when traversing the
+ * stack.  We distinguish the two by checking whether the pointer is
+ * into text-space or not.
+ */
+
+#if ia64_TARGET_ARCH
+/* We need to give the compiler a gentle hint to put it in text-space */
+#define INFO_TBL_CONST  const __attribute__((section (".text")))
+#else
+#define INFO_TBL_CONST  const
+#endif
+
 #endif /* INFOTABLES_H */