includes/RtsFlags.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-1999
   4  *
   5  * Datatypes that holds the command-line flag settings.
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef RTSFLAGS_H
  10 #define RTSFLAGS_H
  11
  12 #include <stdio.h>
  13
  14 /* For defaults, see the @initRtsFlagsDefaults@ routine. */
  15
  16 struct GC_FLAGS {
  17     FILE   *statsFile;
  18     nat     giveStats;
  19 #define NO_GC_STATS      0
  20 #define COLLECT_GC_STATS 1
  21 #define ONELINE_GC_STATS 2
  22 #define SUMMARY_GC_STATS 3
  23 #define VERBOSE_GC_STATS 4
  24
  25     nat     maxStkSize;         /* in *words* */
  26     nat     initialStkSize;     /* in *words* */
  27
  28     nat     maxHeapSize;        /* in *blocks* */
  29     nat     minAllocAreaSize;   /* in *blocks* */
  30     nat     minOldGenSize;      /* in *blocks* */
  31     nat     heapSizeSuggestion; /* in *blocks* */
  32     double  oldGenFactor;
  33     double  pcFreeHeap;
  34
  35     nat     generations;
  36     nat     steps;
  37     rtsBool squeezeUpdFrames;
  38
  39     rtsBool compact;            /* True <=> "compact all the time" */
  40     double  compactThreshold;
  41
  42     rtsBool sweep;              /* use "mostly mark-sweep" instead of copying
  43                                  * for the oldest generation */
  44     rtsBool ringBell;
  45     rtsBool frontpanel;
  46
  47     int idleGCDelayTime;        /* in milliseconds */
  48
  49     StgWord heapBase;           /* address to ask the OS for memory */
  50 };
  51
  52 struct DEBUG_FLAGS {
  53     /* flags to control debugging output & extra checking in various subsystems */
  54     rtsBool scheduler;      /* 's' */
  55     rtsBool interpreter;    /* 'i' */
  56     rtsBool weak;           /* 'w' */
  57     rtsBool gccafs;         /* 'G' */
  58     rtsBool gc;             /* 'g' */
  59     rtsBool block_alloc;    /* 'b' */
  60     rtsBool sanity;         /* 'S'   warning: might be expensive! */
  61     rtsBool stable;         /* 't' */
  62     rtsBool prof;           /* 'p' */
  63     rtsBool eventlog;       /* 'e' */
  64     rtsBool gran;           /* 'r' */
  65     rtsBool par;            /* 'P' */
  66     rtsBool linker;         /* 'l'   the object linker */
  67     rtsBool apply;          /* 'a' */
  68     rtsBool stm;            /* 'm' */
  69     rtsBool squeeze;        /* 'z'  stack squeezing & lazy blackholing */
  70     rtsBool hpc;            /* 'c' coverage */
  71     rtsBool timestamp;          /* add timestamps to traces */
  72 };
  73
  74 struct COST_CENTRE_FLAGS {
  75     unsigned int            doCostCentres;
  76 # define COST_CENTRES_SUMMARY   1
  77 # define COST_CENTRES_VERBOSE   2 /* incl. serial time profile */
  78 # define COST_CENTRES_ALL       3
  79 # define COST_CENTRES_XML       4
  80
  81     int     profilerTicks;   /* derived */
  82     int     msecsPerTick;    /* derived */
  83 };
  84
  85 struct PROFILING_FLAGS {
  86     unsigned int        doHeapProfile;
  87 # define NO_HEAP_PROFILING      0       /* N.B. Used as indexes into arrays */
  88 # define HEAP_BY_CCS            1
  89 # define HEAP_BY_MOD            2
  90 # define HEAP_BY_DESCR          4
  91 # define HEAP_BY_TYPE           5
  92 # define HEAP_BY_RETAINER       6
  93 # define HEAP_BY_LDV            7
  94
  95 # define HEAP_BY_CLOSURE_TYPE   8
  96
  97     nat                 profileInterval;      /* delta between samples (in ms) */
  98     nat                 profileIntervalTicks; /* delta between samples (in 'ticks') */
  99     rtsBool             includeTSOs;
 100
 101
 102     rtsBool             showCCSOnException;
 103
 104     nat                 maxRetainerSetSize;
 105
 106     nat                 ccsLength;
 107
 108     char*               modSelector;
 109     char*               descrSelector;
 110     char*               typeSelector;
 111     char*               ccSelector;
 112     char*               ccsSelector;
 113     char*               retainerSelector;
 114     char*               bioSelector;
 115
 116 };
 117
 118 #ifdef EVENTLOG
 119 struct EVENTLOG_FLAGS {
 120   rtsBool doEventLogging;
 121 };
 122 #endif
 123
 124 struct CONCURRENT_FLAGS {
 125     int ctxtSwitchTime;         /* in milliseconds */
 126     int ctxtSwitchTicks;        /* derived */
 127 };
 128
 129 struct MISC_FLAGS {
 130     int tickInterval;     /* in milliseconds */
 131     rtsBool install_signal_handlers;
 132     rtsBool machineReadable;
 133     StgWord linkerMemBase;       /* address to ask the OS for memory
 134                                   * for the linker, NULL ==> off */
 135 };
 136
 137 #ifdef PAR
 138 /* currently the same as GRAN_STATS_FLAGS */
 139 struct PAR_STATS_FLAGS {
 140   rtsBool Full;       /* Full .gr profile (rtsTrue) or only END events? */
 141   rtsBool Suppressed; /* No .gr profile at all */
 142   rtsBool Binary;     /* Binary profile? (not yet implemented) */
 143   rtsBool Sparks;     /* Info on sparks in profile? */
 144   rtsBool Heap;       /* Info on heap allocs in profile? */
 145   rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
 146   rtsBool Global;     /* Global statistics? (printed on shutdown; no log file) */
 147 };
 148
 149 struct PAR_DEBUG_FLAGS {
 150   /* flags to control debugging output in various subsystems */
 151   rtsBool verbose    : 1; /*    1 */
 152   rtsBool bq         : 1; /*    2 */
 153   rtsBool schedule   : 1; /*    4 */
 154   rtsBool free       : 1; /*    8 */
 155   rtsBool resume     : 1; /*   16 */
 156   rtsBool weight     : 1; /*   32 */
 157   rtsBool fetch      : 1; /*   64 */
 158   rtsBool fish       : 1; /*  128 */
 159   rtsBool tables     : 1; /*  256 */
 160   rtsBool packet     : 1; /*  512 */
 161   rtsBool pack       : 1; /* 1024 */
 162   rtsBool paranoia   : 1; /* 2048 */
 163 };
 164
 165 #define MAX_PAR_DEBUG_OPTION     11
 166 #define PAR_DEBUG_MASK(n)        ((nat)(ldexp(1,n)))
 167 #define MAX_PAR_DEBUG_MASK       ((nat)(ldexp(1,(MAX_PAR_DEBUG_OPTION+1))-1))
 168
 169 struct PAR_FLAGS {
 170   struct PAR_STATS_FLAGS ParStats;  /* profile and stats output */
 171   struct PAR_DEBUG_FLAGS Debug;         /* debugging options */
 172   rtsBool  outputDisabled;        /* Disable output for performance purposes */
 173   rtsBool  doFairScheduling;      /* Fair-ish scheduling (round robin; no time-slices) */
 174   nat      packBufferSize;
 175   nat      thunksToPack;          /* number of thunks in packet + 1 */
 176   nat      globalising;           /* globalisation scheme */
 177   nat      maxLocalSparks;        /* spark pool size */
 178   nat      maxThreads;            /* thread pool size */
 179   nat      maxFishes;             /* max number of active fishes */
 180   rtsTime  fishDelay;             /* delay before sending a new fish */
 181   long   wait;
 182 };
 183 #endif /* PAR */
 184
 185 #ifdef THREADED_RTS
 186 struct PAR_FLAGS {
 187   nat            nNodes;         /* number of threads to run simultaneously */
 188   rtsBool        migrate;        /* migrate threads between capabilities */
 189   rtsBool        wakeupMigrate;  /* migrate a thread on wakeup */
 190   unsigned int   maxLocalSparks;
 191   rtsBool        parGcEnabled;   /* enable parallel GC */
 192   rtsBool        parGcGen;       /* do parallel GC in this generation
 193                                   * and higher only */
 194   rtsBool        parGcLoadBalancing; /* do load-balancing in parallel GC */
 195 };
 196 #endif /* THREADED_RTS */
 197
 198 #ifdef GRAN
 199 struct GRAN_STATS_FLAGS {
 200   rtsBool Full;       /* Full .gr profile (rtsTrue) or only END events? */
 201   rtsBool Suppressed; /* No .gr profile at all */
 202   rtsBool Binary;     /* Binary profile? (not yet implemented) */
 203   rtsBool Sparks;     /* Info on sparks in profile? */
 204   rtsBool Heap;       /* Info on heap allocs in profile? */
 205   rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
 206   rtsBool Global;     /* Global statistics? (printed on shutdown; no log file) */
 207 };
 208
 209 struct GRAN_COST_FLAGS {
 210   /* Communication Cost Variables -- set in main program */
 211   nat latency;              /* Latency for single packet */
 212   nat additional_latency;   /* Latency for additional packets */
 213   nat fetchtime;
 214   nat lunblocktime;         /* Time for local unblock */
 215   nat gunblocktime;         /* Time for global unblock */
 216   nat mpacktime;            /* Cost of creating a packet */
 217   nat munpacktime;          /* Cost of receiving a packet */
 218   nat mtidytime;            /* Cost of cleaning up after send */
 219
 220   nat threadcreatetime;     /* Thread creation costs */
 221   nat threadqueuetime;      /* Cost of adding a thread to the running/runnable queue */
 222   nat threaddescheduletime; /* Cost of descheduling a thread */
 223   nat threadscheduletime;   /* Cost of scheduling a thread */
 224   nat threadcontextswitchtime;  /* Cost of context switch  */
 225
 226   /* Instruction Costs */
 227   nat arith_cost;        /* arithmetic instructions (+,i,< etc) */
 228   nat branch_cost;       /* branch instructions */
 229   nat load_cost;         /* load into register */
 230   nat store_cost;        /* store into memory */
 231   nat float_cost;        /* floating point operations */
 232
 233   nat heapalloc_cost;    /* heap allocation costs */
 234
 235   /* Overhead for granularity control mechanisms */
 236   /* overhead per elem of spark queue */
 237   nat pri_spark_overhead;
 238   /* overhead per elem of thread queue */
 239   nat pri_sched_overhead;
 240 };
 241
 242 struct GRAN_DEBUG_FLAGS {
 243   /* flags to control debugging output in various subsystems */
 244   rtsBool event_trace    : 1; /*    1 */
 245   rtsBool event_stats    : 1; /*    2 */
 246   rtsBool bq             : 1; /*    4 */
 247   rtsBool pack           : 1; /*    8 */
 248   rtsBool checkSparkQ    : 1; /*   16 */
 249   rtsBool thunkStealing  : 1; /*   32 */
 250   rtsBool randomSteal    : 1; /*   64 */
 251   rtsBool findWork       : 1; /*  128 */
 252   rtsBool unused         : 1; /*  256 */
 253   rtsBool pri            : 1; /*  512 */
 254   rtsBool checkLight     : 1; /* 1024 */
 255   rtsBool sortedQ        : 1; /* 2048 */
 256   rtsBool blockOnFetch   : 1; /* 4096 */
 257   rtsBool packBuffer     : 1; /* 8192 */
 258   rtsBool blockOnFetch_sanity : 1; /*  16384 */
 259 };
 260
 261 #define MAX_GRAN_DEBUG_OPTION     14
 262 #define GRAN_DEBUG_MASK(n)        ((nat)(ldexp(1,n)))
 263 #define MAX_GRAN_DEBUG_MASK       ((nat)(ldexp(1,(MAX_GRAN_DEBUG_OPTION+1))-1))
 264
 265 struct GRAN_FLAGS {
 266   struct GRAN_STATS_FLAGS GranSimStats;  /* profile and stats output */
 267   struct GRAN_COST_FLAGS Costs;          /* cost metric for simulation */
 268   struct GRAN_DEBUG_FLAGS Debug;         /* debugging options */
 269
 270   nat  maxThreads;              /* ToDo: share with THREADED_RTS and GUM */
 271   /* rtsBool labelling; */
 272   nat  packBufferSize;
 273   nat  packBufferSize_internal;
 274
 275   PEs proc;                     /* number of processors */
 276   rtsBool Fishing;              /* Simulate GUM style fishing mechanism? */
 277   nat maxFishes;                /* max number of spark or thread steals */
 278   rtsTime time_slice;           /* max time slice of one reduction thread */
 279
 280     /* GrAnSim-Light: This version puts no bound on the number of
 281          processors but in exchange doesn't model communication costs
 282          (all communication is 0 cost). Mainly intended to show maximal
 283          degree of parallelism in the program (*not* to simulate the
 284          execution on a real machine). */
 285
 286     rtsBool Light;
 287
 288     rtsBool DoFairSchedule ;        /* fair scheduling alg? default: unfair */
 289     rtsBool DoAsyncFetch;           /* async. communication? */
 290     rtsBool DoStealThreadsFirst;    /* prefer threads over sparks when stealing */
 291   rtsBool DoAlwaysCreateThreads;  /* eager thread creation */
 292   rtsBool DoBulkFetching;         /* bulk fetching */
 293   rtsBool DoThreadMigration;      /* allow to move threads */
 294   nat     FetchStrategy;         /* what to do when waiting for data */
 295   rtsBool PreferSparksOfLocalNodes; /* prefer local over global sparks */
 296   rtsBool DoPrioritySparking;     /* sparks sorted by priorities */
 297   rtsBool DoPriorityScheduling;   /* threads sorted by priorities */
 298   nat     SparkPriority;         /* threshold for cut-off mechanism */
 299   nat     SparkPriority2;
 300   rtsBool RandomPriorities;
 301   rtsBool InversePriorities;
 302   rtsBool IgnorePriorities;
 303   nat     ThunksToPack;      /* number of thunks in packet + 1 */
 304   rtsBool RandomSteal;        /* steal spark/thread from random proc */
 305   rtsBool NoForward;        /* no forwarding of fetch messages */
 306
 307   /* unsigned int           debug; */
 308   /*  rtsBool event_trace; */
 309   /*  rtsBool event_trace_all; */
 310 };
 311 #endif /* GRAN */
 312
 313 struct TICKY_FLAGS {
 314     rtsBool showTickyStats;
 315     FILE   *tickyFile;
 316 };
 317
 318 #ifdef USE_PAPI
 319 #define MAX_PAPI_USER_EVENTS 8
 320
 321 struct PAPI_FLAGS {
 322     nat     eventType;          /* The type of events to count */
 323     nat     numUserEvents;
 324     char *  userEvents[MAX_PAPI_USER_EVENTS];
 325 };
 326
 327 #define PAPI_FLAG_CACHE_L1 1
 328 #define PAPI_FLAG_CACHE_L2 2
 329 #define PAPI_FLAG_BRANCH 3
 330 #define PAPI_FLAG_STALLS 4
 331 #define PAPI_FLAG_CB_EVENTS 5
 332 #define PAPI_USER_EVENTS 6
 333
 334 #endif
 335
 336 /* Put them together: */
 337
 338 typedef struct _RTS_FLAGS {
 339     /* The first portion of RTS_FLAGS is invariant. */
 340     struct GC_FLAGS          GcFlags;
 341     struct CONCURRENT_FLAGS  ConcFlags;
 342     struct MISC_FLAGS        MiscFlags;
 343     struct DEBUG_FLAGS       DebugFlags;
 344     struct COST_CENTRE_FLAGS CcFlags;
 345     struct PROFILING_FLAGS   ProfFlags;
 346 #ifdef EVENTLOG
 347     struct EVENTLOG_FLAGS    EventLogFlags;
 348 #endif
 349     struct TICKY_FLAGS       TickyFlags;
 350
 351 #if defined(THREADED_RTS) || defined(PAR)
 352     struct PAR_FLAGS    ParFlags;
 353 #endif
 354 #ifdef GRAN
 355     struct GRAN_FLAGS   GranFlags;
 356 #endif
 357 #ifdef USE_PAPI
 358     struct PAPI_FLAGS   PapiFlags;
 359 #endif
 360 } RTS_FLAGS;
 361
 362 #ifdef COMPILING_RTS_MAIN
 363 extern DLLIMPORT RTS_FLAGS RtsFlags;
 364 #elif IN_STG_CODE
 365 /* Hack because the C code generator can't generate '&label'. */
 366 extern RTS_FLAGS RtsFlags[];
 367 #else
 368 extern RTS_FLAGS RtsFlags;
 369 #endif
 370
 371 /* Routines that operate-on/to-do-with RTS flags: */
 372
 373 extern void initRtsFlagsDefaults(void);
 374 extern void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]);
 375 extern void setProgName(char *argv[]);
 376
 377
 378 /*
 379  * The printf formats are here, so we are less likely to make
 380  * overly-long filenames (with disastrous results).  No more than 128
 381  * chars, please!
 382  */
 383
 384 #define STATS_FILENAME_MAXLEN   128
 385
 386 #define GR_FILENAME_FMT         "%0.124s.gr"
 387 #define GR_FILENAME_FMT_GUM     "%0.120s.%03d.%s"
 388 #define HP_FILENAME_FMT         "%0.124s.hp"
 389 #define LIFE_FILENAME_FMT       "%0.122s.life"
 390 #define PROF_FILENAME_FMT       "%0.122s.prof"
 391 #define PROF_FILENAME_FMT_GUM   "%0.118s.%03d.prof"
 392 #define QP_FILENAME_FMT         "%0.124s.qp"
 393 #define STAT_FILENAME_FMT       "%0.122s.stat"
 394 #define TICKY_FILENAME_FMT      "%0.121s.ticky"
 395 #define TIME_FILENAME_FMT       "%0.122s.time"
 396 #define TIME_FILENAME_FMT_GUM   "%0.118s.%03d.time"
 397
 398 /* an "int" so as to match normal "argc" */
 399 /* Now defined in Stg.h (lib/std/cbits need these too.)
 400 extern int     prog_argc;
 401 extern char  **prog_argv;
 402 */
 403 extern int     rts_argc;  /* ditto */
 404 extern char   *rts_argv[];
 405
 406 #endif  /* RTSFLAGS_H */