[project @ 2004-11-08 12:26:52 by simonmar]
[ghc-hetmet.git] / ghc / includes / InfoTables.h
index 79b3de1..8677e90 100644 (file)
@@ -1,5 +1,5 @@
 /* ----------------------------------------------------------------------------
- * $Id: InfoTables.h,v 1.29 2003/05/14 09:14:02 simonmar Exp $
+ * $Id: InfoTables.h,v 1.35 2004/11/08 12:26:55 simonmar Exp $
  * 
  * (c) The GHC Team, 1998-2002
  *
@@ -83,11 +83,9 @@ typedef struct {
 
 /* -----------------------------------------------------------------------------
    Ticky info
-   -------------------------------------------------------------------------- */
 
-typedef struct {
-    /* empty */
-} StgTickyInfo;
+   There is no ticky-specific stuff in an info table at this time.
+   -------------------------------------------------------------------------- */
 
 /* -----------------------------------------------------------------------------
    Debugging info
@@ -101,9 +99,7 @@ typedef struct {
 
 #else /* !DEBUG_CLOSURE */
 
-typedef struct {
-       /* empty */
-} StgDebugInfo;
+// There is no DEBUG-specific stuff in an info table at this time.
 
 #endif /* DEBUG_CLOSURE */
 
@@ -165,6 +161,8 @@ extern StgWord16 closure_flags[];
    (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).
+
+   In these bitmaps: 0 == ptr, 1 == non-ptr.
    -------------------------------------------------------------------------- */
 
 //
@@ -226,7 +224,11 @@ typedef union {
     StgWord bitmap;              // word-sized bit pattern describing
                                  //  a stack frame: see below
 
+#ifndef TABLES_NEXT_TO_CODE
     StgLargeBitmap* large_bitmap; // pointer to large bitmap structure
+#else
+    StgWord large_bitmap_offset;  // offset from info table to large bitmap structure
+#endif
     
     StgWord selector_offset;     // used in THUNK_SELECTORs
 
@@ -249,10 +251,10 @@ typedef struct _StgInfoTable {
     StgProfInfo     prof;
 #endif
 #ifdef TICKY
-    StgTickyInfo    ticky;
+    // Ticky-specific stuff would go here.
 #endif
 #ifdef DEBUG_CLOSURE
-    StgDebugInfo    debug;
+    // Debug-specific stuff would go here.
 #endif
 
     StgClosureInfo  layout;    // closure layout info (one word)
@@ -281,21 +283,29 @@ typedef struct _StgInfoTable {
       bitmap fields have also been omitted.
    -------------------------------------------------------------------------- */
 
-typedef struct _StgFunInfoTable {
-#if defined(TABLES_NEXT_TO_CODE)
-    StgFun         *slow_apply; // apply to args on the stack
+typedef struct _StgFunInfoExtraRev {
+    StgWord        slow_apply_offset; // apply to args on the stack
     StgWord        bitmap;     // arg ptr/nonptr bitmap
-    StgSRT         *srt;       // pointer to the SRT table
+    StgWord        srt_offset; // pointer to the SRT table
     StgHalfWord    fun_type;    // function type
     StgHalfWord    arity;       // function arity
-    StgInfoTable i;
-#else
-    StgInfoTable i;
+} StgFunInfoExtraRev;
+
+typedef struct _StgFunInfoExtraFwd {
     StgHalfWord    fun_type;    // function type
     StgHalfWord    arity;       // function arity
     StgSRT         *srt;       // pointer to the SRT table
     StgWord        bitmap;     // arg ptr/nonptr bitmap
     StgFun         *slow_apply; // apply to args on the stack
+} StgFunInfoExtraFwd;
+
+typedef struct {
+#if defined(TABLES_NEXT_TO_CODE)
+    StgFunInfoExtraRev f;
+    StgInfoTable i;
+#else
+    StgInfoTable i;
+    StgFunInfoExtraFwd f;
 #endif
 } StgFunInfoTable;
 
@@ -306,15 +316,13 @@ typedef struct _StgFunInfoTable {
 // When info tables are laid out backwards, we can omit the SRT
 // pointer iff srt_bitmap is zero.
 
-typedef struct _StgRetInfoTable {
-#if !defined(TABLES_NEXT_TO_CODE)
-    StgInfoTable i;
-#endif
-    StgSRT         *srt;       // pointer to the SRT table
+typedef struct {
 #if defined(TABLES_NEXT_TO_CODE)
+    StgWord      srt_offset;   // offset to the SRT table
     StgInfoTable i;
-#endif
-#if !defined(TABLES_NEXT_TO_CODE)
+#else
+    StgInfoTable i;
+    StgSRT      *srt;  // pointer to the SRT table
     StgFunPtr vector[FLEXIBLE_ARRAY];
 #endif
 } StgRetInfoTable;
@@ -330,10 +338,50 @@ typedef struct _StgThunkInfoTable {
 #if !defined(TABLES_NEXT_TO_CODE)
     StgInfoTable i;
 #endif
+#if defined(TABLES_NEXT_TO_CODE)
+    StgWord        srt_offset; // offset to the SRT table
+#else
     StgSRT         *srt;       // pointer to the SRT table
+#endif
 #if defined(TABLES_NEXT_TO_CODE)
     StgInfoTable i;
 #endif
 } StgThunkInfoTable;
 
+
+/* -----------------------------------------------------------------------------
+   Accessor macros for fields that might be offsets (C version)
+   -------------------------------------------------------------------------- */
+
+// GET_SRT(info)
+// info must be a Stg[Ret|Thunk]InfoTable* (an info table that has a SRT)
+#ifdef TABLES_NEXT_TO_CODE
+#define GET_SRT(info) ((StgSRT*) (((StgWord) ((info)+1)) + (info)->srt_offset))
+#else
+#define GET_SRT(info) ((info)->srt)
+#endif
+
+// GET_FUN_SRT(info)
+// info must be a StgFunInfoTable*
+#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)) \
+                                        + (info)->f.bitmap))
+#else
+#define GET_FUN_LARGE_BITMAP(info) ((StgLargeBitmap*) ((info)->f.bitmap))
+#endif
+
+
 #endif /* INFOTABLES_H */