[project @ 2003-04-28 09:57:12 by simonmar]
[ghc-hetmet.git] / ghc / includes / StgProf.h
index b221ba7..f6af87f 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: StgProf.h,v 1.4 1999/03/25 13:14:04 simonm Exp $
+ * $Id: StgProf.h,v 1.16 2001/12/12 14:59:41 simonmar Exp $
  *
  * (c) The GHC Team, 1998
  *
@@ -9,9 +9,116 @@
 #ifndef STGPROF_H
 #define STGPROF_H
 
+/* -----------------------------------------------------------------------------
+ * Data Structures 
+ * ---------------------------------------------------------------------------*/  
+typedef struct _CostCentre {
+  int ccID;
+
+  char *label;
+  char *module;
+  /* used for accumulating costs at the end of the run... */
+  unsigned long time_ticks;
+  unsigned long long mem_alloc;
+
+  char is_caf;
+
+  struct _CostCentre *link;
+} CostCentre;
+
+
+typedef struct _CostCentreStack {
+  int ccsID;
+
+  CostCentre *cc;
+  struct _CostCentreStack *prevStack;
+  struct _IndexTable *indexTable;
+
+  unsigned int selected;
+
+  unsigned long long scc_count;
+
+  unsigned long time_ticks;
+  unsigned long long mem_alloc;
+
+  unsigned long inherited_ticks;
+  unsigned long long inherited_alloc;
+
+  CostCentre *root;
+} CostCentreStack;
+
+
+/* -----------------------------------------------------------------------------
+ * The rest is PROFILING only...
+ * ---------------------------------------------------------------------------*/
+
 #if defined(PROFILING)
   
 /* -----------------------------------------------------------------------------
+ * Constants
+ * ---------------------------------------------------------------------------*/
+
+#define EMPTY_STACK NULL
+#define EMPTY_TABLE NULL
+
+/* Constants used to set sumbsumed flag on CostCentres */
+
+#define CC_IS_CAF      'c'            /* 'c'  => *is* a CAF cc           */
+#define CC_IS_BORING   'B'            /* 'B'  => *not* a CAF/sub cc      */
+
+
+/* -----------------------------------------------------------------------------
+ * Data Structures
+ * ---------------------------------------------------------------------------*/
+
+typedef struct _IndexTable {
+  CostCentre *cc;
+  CostCentreStack *ccs;
+  struct _IndexTable *next;
+  unsigned int back_edge;
+} IndexTable;
+
+     
+/* -----------------------------------------------------------------------------
+   Pre-defined cost centres and cost centre stacks
+   -------------------------------------------------------------------------- */
+
+extern CostCentreStack *CCCS;          /* current CCS */
+extern CostCentre      CC_MAIN[];      
+extern CostCentreStack CCS_MAIN[];      /* Top CCS */
+
+extern CostCentre      CC_SYSTEM[];    
+extern CostCentreStack CCS_SYSTEM[];    /* RTS costs */
+
+extern CostCentre      CC_GC[];
+extern CostCentreStack CCS_GC[];        /* Garbage collector costs */
+
+extern CostCentre      CC_SUBSUMED[];  
+extern CostCentreStack CCS_SUBSUMED[];   /* Costs are subsumed by caller */
+
+extern CostCentre      CC_OVERHEAD[];
+extern CostCentreStack CCS_OVERHEAD[];   /* Profiling overhead */
+
+extern CostCentre      CC_DONT_CARE[];
+extern CostCentreStack CCS_DONT_CARE[];  /* shouldn't ever get set */
+
+extern unsigned int CC_ID;     /* global ids */
+extern unsigned int CCS_ID;
+extern unsigned int HP_ID;
+
+/* -----------------------------------------------------------------------------
+ * Functions 
+ * ---------------------------------------------------------------------------*/
+
+CostCentreStack *EnterFunCCS ( CostCentreStack *cccs, CostCentreStack *ccsfn );
+CostCentreStack *PushCostCentre ( CostCentreStack *, CostCentre * );
+CostCentreStack *AppendCCS ( CostCentreStack *ccs1, CostCentreStack *ccs2 );
+
+extern unsigned int entering_PAP;
+
+/* -----------------------------------------------------------------------------
  * Registering CCs
  
  Cost centres are registered at startup by calling a registering
 
  -------------------------------------------------------------------------- */
 
-extern F_ *register_stack;
-
 extern CostCentre *CC_LIST;               /* registered CC list */
 extern CostCentreStack *CCS_LIST;         /* registered CCS list */
 
-# define PUSH_REGISTER_STACK(reg_function)                             \
-       *(register_stack++) = (F_)reg_function
-
-# define POP_REGISTER_STACK()                                          \
-       *(--register_stack)
-
-# define START_REGISTER_CCS(reg_mod_name)                              \
-       static int _module_registered = 0;                              \
-       FN_(reg_mod_name) {                                             \
-           FB_;                                                        \
-           if (! _module_registered) {                                 \
-               _module_registered = 1
-
-# define REGISTER_IMPORT(reg_mod_name)                                 \
-       do { EF_(reg_mod_name);                                         \
-         PUSH_REGISTER_STACK(reg_mod_name) ;                           \
-       } while (0)
-       
-# define END_REGISTER_CCS()                                            \
-        };                                                             \
-       JMP_(POP_REGISTER_STACK());                                     \
-       FE_ }
-
 #define REGISTER_CC(cc)                                        \
        do {                                            \
        extern CostCentre cc[];                         \
@@ -84,27 +166,29 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
  * Declaring Cost Centres & Cost Centre Stacks.
  * -------------------------------------------------------------------------- */
 
-# define CC_DECLARE(cc_ident,name,module,group,subsumed,is_local)      \
-     is_local CostCentre cc_ident[1]                                   \
-       = {{ 0,                                                         \
-            name,                                                      \
-            module,                                                    \
-            group,                                                     \
-            subsumed,                                                  \
+# define CC_DECLARE(cc_ident,name,module,caf,is_local)         \
+     is_local CostCentre cc_ident[1]                           \
+       = {{ 0,                                                 \
+            name,                                              \
+            module,                                            \
+             0,                                                        \
+            0,                                                 \
+            caf,                                               \
             0 }};
 
-# define CCS_DECLARE(ccs_ident,cc_ident,subsumed,is_local)     \
+# define CCS_DECLARE(ccs_ident,cc_ident,is_local)              \
      is_local CostCentreStack ccs_ident[1]                     \
        = {{ ccsID              : 0,                            \
            cc                  : cc_ident,                     \
            prevStack           : NULL,                         \
            indexTable          : NULL,                         \
+            selected            : 0,                           \
            scc_count           : 0,                            \
-           sub_scc_count       : 0,                            \
-           sub_cafcc_count     : 0,                            \
            time_ticks          : 0,                            \
            mem_alloc           : 0,                            \
-           is_subsumed         : subsumed,                     \
+           inherited_ticks     : 0,                            \
+           inherited_alloc     : 0,                            \
+           root                : 0,                            \
        }};
 
 # define CC_EXTERN(cc_ident) \
@@ -114,8 +198,6 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
  * Time / Allocation Macros
  * ---------------------------------------------------------------------------*/
 
-#define CCS_TICK(ccs)  (ccs)->time_ticks++
-
 /* eliminate profiling overhead from allocation costs */
 #define CCS_ALLOC(ccs, size) (ccs)->mem_alloc += ((size)-sizeofW(StgProfHeader))
 
@@ -133,7 +215,6 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
 
 # define SET_CCC_X(cc,do_subcc_count,do_scc_count)             \
        do {                                                    \
-       if (do_subcc_count)   { CCCS->sub_scc_count++; }        \
        CCCS = PushCostCentre(CCCS,cc);                         \
        if (do_scc_count)     { CCCS->scc_count++; }            \
        } while(0)
@@ -175,7 +256,6 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
         do {                              \
         (stack)->scc_count = 0;           \
         (stack)->time_ticks = 0;          \
-        (stack)->sub_cafcc_count = 0;     \
         (stack)->mem_alloc = 0;           \
         } while(0)
 
@@ -189,17 +269,10 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
 #define CCCS_DETAIL_COUNT(inc_this) /*nothing*/
 #endif
 
-#define IS_CAF_OR_SUB_CCS(ccs)                 \
-        /* tests for lower case character */   \
-        ((ccs)->is_subsumed & ' ')
-       
-
 /* On entry to top level CAFs we count the scc ...*/
 
 #define ENTER_CCS_CAF_X(ccs)                                \
         do {                                                \
-        /* inc subcaf count of CCCS */                      \
-        CCCS->sub_cafcc_count++;                            \
         /* set CCCS to ident ccs */                         \
         CCCS = (CostCentreStack *)(ccs);                    \
         /* inc scc count of CAF ccs */                      \
@@ -215,10 +288,10 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
  * On entering a closure we only count the enter to thunks ...
  * ------------------------------------------------------------------------- */
 
-#define ENTER_CCS_T(ccs)                                    \
-        do {                                                \
-        CCCS = (CostCentreStack *)(ccs);                    \
-        CCCS_DETAIL_COUNT(CCCS->thunk_count);               \
+#define ENTER_CCS_T(ccs)                               \
+        do {                                           \
+        CCCS = (CostCentreStack *)(ccs);               \
+        CCCS_DETAIL_COUNT(CCCS->thunk_count);          \
         } while(0)      
  
 #define ENTER_CCS_TCL(closure)  ENTER_CCS_T(CCS_HDR(closure))
@@ -231,35 +304,31 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
  *  (b) The CCS is CAF-ish.
  * -------------------------------------------------------------------------- */
 
-#define ENTER_CCS_F(stack)                                     \
-        do {                                                   \
-        CostCentreStack *ccs = (CostCentreStack *) (stack);    \
-        if ( ! IS_CAF_OR_SUB_CCS(ccs) ) {                      \
-           CCCS = ccs;                                         \
-        } else {                                               \
-          CCCS = AppendCCS(CCCS,ccs);                          \
-          CCCS_DETAIL_COUNT(ccs->caffun_subsumed);             \
-          CCCS_DETAIL_COUNT(CCCS->subsumed_caf_count);         \
-        }                                                      \
-        CCCS_DETAIL_COUNT(CCCS->function_count);               \
+#define ENTER_CCS_F(stack)                                             \
+        do {                                                           \
+        CostCentreStack *ccs = (CostCentreStack *) (stack);            \
+        CCCS_DETAIL_COUNT(CCCS->function_count);                       \
+        CCCS = EnterFunCCS(CCCS,ccs);                                  \
         } while(0)
  
 #define ENTER_CCS_FCL(closure)  ENTER_CCS_F(CCS_HDR(closure))
 
 /* Entering a top-level function: costs are subsumed by the caller 
  */
-#define ENTER_CCS_FSUB()                                    \
-        do {                                                \
-        CCCS_DETAIL_COUNT(CCCS->subsumed_fun_count);        \
-        CCCS_DETAIL_COUNT(CCCS->function_count);            \
+#define ENTER_CCS_FSUB()                               \
+        do {                                           \
+        CCCS_DETAIL_COUNT(CCCS->subsumed_fun_count);   \
+        CCCS_DETAIL_COUNT(CCCS->function_count);       \
+       entering_PAP = 0;                               \
         } while(0)
  
-#define ENTER_CCS_FCAF(stack)                               \
-        do {                                                \
-        CostCentreStack *ccs = (CostCentreStack *) (stack); \
-        CCCS_DETAIL_COUNT(ccs->caffun_subsumed);            \
-        CCCS_DETAIL_COUNT(CCCS->subsumed_caf_count);        \
-        CCCS_DETAIL_COUNT(CCCS->function_count);            \
+#define ENTER_CCS_FCAF(stack)                                  \
+        do {                                                   \
+        CostCentreStack *ccs = (CostCentreStack *) (stack);    \
+        CCCS_DETAIL_COUNT(ccs->caffun_subsumed);               \
+        CCCS_DETAIL_COUNT(CCCS->subsumed_caf_count);           \
+        CCCS_DETAIL_COUNT(CCCS->function_count);               \
+       entering_PAP = 0;                                       \
         } while(0)
  
 #define ENTER_CCS_FLOAD(ccs)                                \
@@ -270,25 +339,24 @@ extern CostCentreStack *CCS_LIST;         /* registered CCS list */
  
 /* These ENTER_CC_PAP things are only used in the RTS */
  
-#define ENTER_CCS_PAP(stack)                                   \
-        do {                                                   \
-        CostCentreStack *ccs = (CostCentreStack *) (stack);    \
-        if ( ! IS_CAF_OR_SUB_CCS(ccs) ) {                      \
-            CCCS = ccs;                                                \
-        } else {                                               \
-          CCCS = AppendCCS(CCCS,ccs);                          \
-          CCCS_DETAIL_COUNT(ccs->caffun_subsumed);             \
-          CCCS_DETAIL_COUNT(CCCS->subsumed_caf_count);         \
-        }                                                      \
-        CCCS_DETAIL_COUNT(CCCS->pap_count);                    \
-        } while(0)                      
+#define ENTER_CCS_PAP(stack)                   \
+        do {                                   \
+       ENTER_CCS_F(stack);                     \
+       entering_PAP = rtsTrue;                 \
+       } while(0)
 
 #define ENTER_CCS_PAP_CL(closure)  \
         ENTER_CCS_PAP((closure)->header.prof.ccs)
 
- /* temp EW */
-#define STATIC_CCS_REF(ccs) (ccs)
+/* -----------------------------------------------------------------------------
+   When not profiling, these macros do nothing...
+   -------------------------------------------------------------------------- */
+#else /* !PROFILING */
 
+#define CCS_ALLOC(ccs, amount) doNothing()
+#define ENTER_CC_PAP_CL(r)     doNothing()
+#define ENTER_CCS_PAP_CL(r)    doNothing()
 #endif /* PROFILING */
 
 #endif /* STGPROF_H */