includes/rts/Flags.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2009
   4  *
   5  * Datatypes that holds the command-line flag settings.
   6  *
   7  * Do not #include this file directly: #include "Rts.h" instead.
   8  *
   9  * To understand the structure of the RTS headers, see the wiki:
  10  *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
  11  *
  12  * ---------------------------------------------------------------------------*/
  13
  14 #ifndef RTS_FLAGS_H
  15 #define RTS_FLAGS_H
  16
  17 #include <stdio.h>
  18
  19 /* For defaults, see the @initRtsFlagsDefaults@ routine. */
  20
  21 struct GC_FLAGS {
  22     FILE   *statsFile;
  23     nat     giveStats;
  24 #define NO_GC_STATS      0
  25 #define COLLECT_GC_STATS 1
  26 #define ONELINE_GC_STATS 2
  27 #define SUMMARY_GC_STATS 3
  28 #define VERBOSE_GC_STATS 4
  29
  30     nat     maxStkSize;         /* in *words* */
  31     nat     initialStkSize;     /* in *words* */
  32
  33     nat     maxHeapSize;        /* in *blocks* */
  34     nat     minAllocAreaSize;   /* in *blocks* */
  35     nat     minOldGenSize;      /* in *blocks* */
  36     nat     heapSizeSuggestion; /* in *blocks* */
  37     double  oldGenFactor;
  38     double  pcFreeHeap;
  39
  40     nat     generations;
  41     nat     steps;
  42     rtsBool squeezeUpdFrames;
  43
  44     rtsBool compact;            /* True <=> "compact all the time" */
  45     double  compactThreshold;
  46
  47     rtsBool sweep;              /* use "mostly mark-sweep" instead of copying
  48                                  * for the oldest generation */
  49     rtsBool ringBell;
  50     rtsBool frontpanel;
  51
  52     int idleGCDelayTime;        /* in milliseconds */
  53
  54     StgWord heapBase;           /* address to ask the OS for memory */
  55 };
  56
  57 struct DEBUG_FLAGS {
  58     /* flags to control debugging output & extra checking in various subsystems */
  59     rtsBool scheduler;      /* 's' */
  60     rtsBool interpreter;    /* 'i' */
  61     rtsBool weak;           /* 'w' */
  62     rtsBool gccafs;         /* 'G' */
  63     rtsBool gc;             /* 'g' */
  64     rtsBool block_alloc;    /* 'b' */
  65     rtsBool sanity;         /* 'S'   warning: might be expensive! */
  66     rtsBool stable;         /* 't' */
  67     rtsBool prof;           /* 'p' */
  68     rtsBool linker;         /* 'l'   the object linker */
  69     rtsBool apply;          /* 'a' */
  70     rtsBool stm;            /* 'm' */
  71     rtsBool squeeze;        /* 'z'  stack squeezing & lazy blackholing */
  72     rtsBool hpc;            /* 'c' coverage */
  73     rtsBool sparks;         /* 'r' */
  74 };
  75
  76 struct COST_CENTRE_FLAGS {
  77     unsigned int            doCostCentres;
  78 # define COST_CENTRES_SUMMARY   1
  79 # define COST_CENTRES_VERBOSE   2 /* incl. serial time profile */
  80 # define COST_CENTRES_ALL       3
  81 # define COST_CENTRES_XML       4
  82
  83     int     profilerTicks;   /* derived */
  84     int     msecsPerTick;    /* derived */
  85 };
  86
  87 struct PROFILING_FLAGS {
  88     unsigned int        doHeapProfile;
  89 # define NO_HEAP_PROFILING      0       /* N.B. Used as indexes into arrays */
  90 # define HEAP_BY_CCS            1
  91 # define HEAP_BY_MOD            2
  92 # define HEAP_BY_DESCR          4
  93 # define HEAP_BY_TYPE           5
  94 # define HEAP_BY_RETAINER       6
  95 # define HEAP_BY_LDV            7
  96
  97 # define HEAP_BY_CLOSURE_TYPE   8
  98
  99     nat                 profileInterval;      /* delta between samples (in ms) */
 100     nat                 profileIntervalTicks; /* delta between samples (in 'ticks') */
 101     rtsBool             includeTSOs;
 102
 103
 104     rtsBool             showCCSOnException;
 105
 106     nat                 maxRetainerSetSize;
 107
 108     nat                 ccsLength;
 109
 110     char*               modSelector;
 111     char*               descrSelector;
 112     char*               typeSelector;
 113     char*               ccSelector;
 114     char*               ccsSelector;
 115     char*               retainerSelector;
 116     char*               bioSelector;
 117
 118 };
 119
 120 struct TRACE_FLAGS {
 121     rtsBool trace_stderr;
 122     rtsBool timestamp;      /* show timestamp in stderr output */
 123
 124     rtsBool scheduler;      /* trace scheduler events */
 125 };
 126
 127 struct CONCURRENT_FLAGS {
 128     int ctxtSwitchTime;         /* in milliseconds */
 129     int ctxtSwitchTicks;        /* derived */
 130 };
 131
 132 struct MISC_FLAGS {
 133     int tickInterval;     /* in milliseconds */
 134     rtsBool install_signal_handlers;
 135     rtsBool machineReadable;
 136     StgWord linkerMemBase;       /* address to ask the OS for memory
 137                                   * for the linker, NULL ==> off */
 138 };
 139
 140 #ifdef THREADED_RTS
 141 struct PAR_FLAGS {
 142   nat            nNodes;         /* number of threads to run simultaneously */
 143   rtsBool        migrate;        /* migrate threads between capabilities */
 144   rtsBool        wakeupMigrate;  /* migrate a thread on wakeup */
 145   unsigned int   maxLocalSparks;
 146   rtsBool        parGcEnabled;   /* enable parallel GC */
 147   unsigned int   parGcGen;       /* do parallel GC in this generation
 148                                   * and higher only */
 149   rtsBool        parGcLoadBalancingEnabled;
 150                                  /* enable load-balancing in the
 151                                   * parallel GC */
 152   unsigned int   parGcLoadBalancingGen;
 153                                  /* do load-balancing in this
 154                                   * generation and higher only */
 155   rtsBool        setAffinity;    /* force thread affinity with CPUs */
 156 };
 157 #endif /* THREADED_RTS */
 158
 159 struct TICKY_FLAGS {
 160     rtsBool showTickyStats;
 161     FILE   *tickyFile;
 162 };
 163
 164 #ifdef USE_PAPI
 165 #define MAX_PAPI_USER_EVENTS 8
 166
 167 struct PAPI_FLAGS {
 168     nat     eventType;          /* The type of events to count */
 169     nat     numUserEvents;
 170     char *  userEvents[MAX_PAPI_USER_EVENTS];
 171 };
 172
 173 #define PAPI_FLAG_CACHE_L1 1
 174 #define PAPI_FLAG_CACHE_L2 2
 175 #define PAPI_FLAG_BRANCH 3
 176 #define PAPI_FLAG_STALLS 4
 177 #define PAPI_FLAG_CB_EVENTS 5
 178 #define PAPI_USER_EVENTS 6
 179
 180 #endif
 181
 182 /* Put them together: */
 183
 184 typedef struct _RTS_FLAGS {
 185     /* The first portion of RTS_FLAGS is invariant. */
 186     struct GC_FLAGS          GcFlags;
 187     struct CONCURRENT_FLAGS  ConcFlags;
 188     struct MISC_FLAGS        MiscFlags;
 189     struct DEBUG_FLAGS       DebugFlags;
 190     struct COST_CENTRE_FLAGS CcFlags;
 191     struct PROFILING_FLAGS   ProfFlags;
 192     struct TRACE_FLAGS       TraceFlags;
 193     struct TICKY_FLAGS       TickyFlags;
 194
 195 #if defined(THREADED_RTS)
 196     struct PAR_FLAGS    ParFlags;
 197 #endif
 198 #ifdef USE_PAPI
 199     struct PAPI_FLAGS   PapiFlags;
 200 #endif
 201 } RTS_FLAGS;
 202
 203 #ifdef COMPILING_RTS_MAIN
 204 extern DLLIMPORT RTS_FLAGS RtsFlags;
 205 #elif IN_STG_CODE
 206 /* Hack because the C code generator can't generate '&label'. */
 207 extern RTS_FLAGS RtsFlags[];
 208 #else
 209 extern RTS_FLAGS RtsFlags;
 210 #endif
 211
 212 /* Routines that operate-on/to-do-with RTS flags: */
 213
 214 void initRtsFlagsDefaults(void);
 215 void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]);
 216 void setProgName(char *argv[]);
 217
 218
 219 /*
 220  * The printf formats are here, so we are less likely to make
 221  * overly-long filenames (with disastrous results).  No more than 128
 222  * chars, please!
 223  */
 224
 225 #define STATS_FILENAME_MAXLEN   128
 226
 227 #define GR_FILENAME_FMT         "%0.124s.gr"
 228 #define GR_FILENAME_FMT_GUM     "%0.120s.%03d.%s"
 229 #define HP_FILENAME_FMT         "%0.124s.hp"
 230 #define LIFE_FILENAME_FMT       "%0.122s.life"
 231 #define PROF_FILENAME_FMT       "%0.122s.prof"
 232 #define PROF_FILENAME_FMT_GUM   "%0.118s.%03d.prof"
 233 #define QP_FILENAME_FMT         "%0.124s.qp"
 234 #define STAT_FILENAME_FMT       "%0.122s.stat"
 235 #define TICKY_FILENAME_FMT      "%0.121s.ticky"
 236 #define TIME_FILENAME_FMT       "%0.122s.time"
 237 #define TIME_FILENAME_FMT_GUM   "%0.118s.%03d.time"
 238
 239 /* an "int" so as to match normal "argc" */
 240 /* Now defined in Stg.h (lib/std/cbits need these too.)
 241 extern int     prog_argc;
 242 extern char  **prog_argv;
 243 */
 244 extern int     rts_argc;  /* ditto */
 245 extern char   *rts_argv[];
 246
 247 #endif  /* RTS_FLAGS_H */