rts/RtsFlags.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The AQUA Project, Glasgow University, 1994-1997
   4  * (c) The GHC Team, 1998-2006
   5  *
   6  * Functions for parsing the argument list.
   7  *
   8  * ---------------------------------------------------------------------------*/
   9
  10 #include "PosixSource.h"
  11 #include "Rts.h"
  12 #include "RtsFlags.h"
  13 #include "RtsUtils.h"
  14 #include "Profiling.h"
  15
  16 #ifdef HAVE_CTYPE_H
  17 #include <ctype.h>
  18 #endif
  19
  20 #include <stdlib.h>
  21 #include <string.h>
  22
  23 // Flag Structure
  24 RTS_FLAGS RtsFlags;
  25
  26 /*
  27  * Split argument lists
  28  */
  29 int     prog_argc = 0;    /* an "int" so as to match normal "argc" */
  30 char  **prog_argv = NULL;
  31 char   *prog_name = NULL; /* 'basename' of prog_argv[0] */
  32 int     rts_argc = 0;  /* ditto */
  33 char   *rts_argv[MAX_RTS_ARGS];
  34
  35 /*
  36  * constants, used later
  37  */
  38 #define RTS 1
  39 #define PGM 0
  40
  41 #if defined(GRAN)
  42
  43 static char *gran_debug_opts_strs[] = {
  44   "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
  45   "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
  46   "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
  47   "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
  48   "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
  49   "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
  50   "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
  51   "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
  52   "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
  53   "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
  54   "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
  55   "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
  56   "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
  57   "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
  58   "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
  59 };
  60
  61 /* one character codes for the available debug options */
  62 static char gran_debug_opts_flags[] = {
  63   'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
  64 };
  65
  66 #elif defined(PAR)
  67
  68 static char *par_debug_opts_strs[] = {
  69   "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
  70   "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
  71   "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
  72   "DEBUG (-qDe, -qD8): free; free messages.\n",
  73   "DEBUG (-qDr, -qD16): resume; resume messages.\n",
  74   "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
  75   "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
  76   // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
  77   "DEBUG (-qDf, -qD128): fish; fish messages.\n",
  78   //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
  79   "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
  80   "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
  81   "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
  82   "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
  83 };
  84
  85 /* one character codes for the available debug options */
  86 static char par_debug_opts_flags[] = {
  87   'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
  88 };
  89
  90 #endif /* PAR */
  91
  92 /* -----------------------------------------------------------------------------
  93    Static function decls
  94    -------------------------------------------------------------------------- */
  95
  96 static int              /* return NULL on error */
  97 open_stats_file (
  98     I_ arg,
  99     int argc, char *argv[],
 100     int rts_argc, char *rts_argv[],
 101     const char *FILENAME_FMT,
 102     FILE **file_ret);
 103
 104 static I_ decode(const char *s);
 105 static void bad_option(const char *s);
 106
 107 #if defined(GRAN)
 108 static void enable_GranSimLight(void);
 109 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
 110 static void set_GranSim_debug_options(nat n);
 111 static void help_GranSim_debug_options(nat n);
 112 #elif defined(PAR)
 113 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
 114 static void set_par_debug_options(nat n);
 115 static void help_par_debug_options(nat n);
 116 #endif
 117
 118 /* -----------------------------------------------------------------------------
 119  * Command-line option parsing routines.
 120  * ---------------------------------------------------------------------------*/
 121
 122 void initRtsFlagsDefaults(void)
 123 {
 124     RtsFlags.GcFlags.statsFile          = NULL;
 125     RtsFlags.GcFlags.giveStats          = NO_GC_STATS;
 126
 127     RtsFlags.GcFlags.maxStkSize         = (8 * 1024 * 1024) / sizeof(W_);
 128     RtsFlags.GcFlags.initialStkSize     = 1024 / sizeof(W_);
 129
 130     RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
 131     RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
 132     RtsFlags.GcFlags.maxHeapSize        = 0;    /* off by default */
 133     RtsFlags.GcFlags.heapSizeSuggestion = 0;    /* none */
 134     RtsFlags.GcFlags.pcFreeHeap         = 3;    /* 3% */
 135     RtsFlags.GcFlags.oldGenFactor       = 2;
 136 #if defined(PAR)
 137     /* A hack currently needed for GUM -- HWL */
 138     RtsFlags.GcFlags.generations        = 1;
 139     RtsFlags.GcFlags.steps              = 2;
 140     RtsFlags.GcFlags.squeezeUpdFrames   = rtsFalse;
 141 #else
 142     RtsFlags.GcFlags.generations        = 2;
 143     RtsFlags.GcFlags.steps              = 2;
 144     RtsFlags.GcFlags.squeezeUpdFrames   = rtsTrue;
 145 #endif
 146     RtsFlags.GcFlags.compact            = rtsFalse;
 147     RtsFlags.GcFlags.compactThreshold   = 30.0;
 148 #ifdef RTS_GTK_FRONTPANEL
 149     RtsFlags.GcFlags.frontpanel         = rtsFalse;
 150 #endif
 151     RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
 152
 153 #ifdef DEBUG
 154     RtsFlags.DebugFlags.scheduler       = rtsFalse;
 155     RtsFlags.DebugFlags.interpreter     = rtsFalse;
 156     RtsFlags.DebugFlags.weak            = rtsFalse;
 157     RtsFlags.DebugFlags.gccafs          = rtsFalse;
 158     RtsFlags.DebugFlags.gc              = rtsFalse;
 159     RtsFlags.DebugFlags.block_alloc     = rtsFalse;
 160     RtsFlags.DebugFlags.sanity          = rtsFalse;
 161     RtsFlags.DebugFlags.stable          = rtsFalse;
 162     RtsFlags.DebugFlags.stm             = rtsFalse;
 163     RtsFlags.DebugFlags.prof            = rtsFalse;
 164     RtsFlags.DebugFlags.gran            = rtsFalse;
 165     RtsFlags.DebugFlags.par             = rtsFalse;
 166     RtsFlags.DebugFlags.linker          = rtsFalse;
 167     RtsFlags.DebugFlags.squeeze         = rtsFalse;
 168     RtsFlags.DebugFlags.hpc             = rtsFalse;
 169 #endif
 170
 171 #if defined(PROFILING) || defined(PAR)
 172     RtsFlags.CcFlags.doCostCentres      = 0;
 173 #endif /* PROFILING or PAR */
 174
 175 #ifdef PROFILING
 176     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
 177     RtsFlags.ProfFlags.profileInterval    = 100;
 178     RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
 179     RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
 180     RtsFlags.ProfFlags.maxRetainerSetSize = 8;
 181     RtsFlags.ProfFlags.ccsLength          = 25;
 182     RtsFlags.ProfFlags.modSelector        = NULL;
 183     RtsFlags.ProfFlags.descrSelector      = NULL;
 184     RtsFlags.ProfFlags.typeSelector       = NULL;
 185     RtsFlags.ProfFlags.ccSelector         = NULL;
 186     RtsFlags.ProfFlags.ccsSelector        = NULL;
 187     RtsFlags.ProfFlags.retainerSelector   = NULL;
 188     RtsFlags.ProfFlags.bioSelector        = NULL;
 189
 190 #elif defined(DEBUG)
 191     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
 192 #endif
 193
 194     RtsFlags.MiscFlags.tickInterval     = 50;  /* In milliseconds */
 195     RtsFlags.ConcFlags.ctxtSwitchTime   = 50;  /* In milliseconds */
 196
 197 #ifdef THREADED_RTS
 198     RtsFlags.ParFlags.nNodes            = 1;
 199     RtsFlags.ParFlags.migrate           = rtsTrue;
 200     RtsFlags.ParFlags.wakeupMigrate     = rtsFalse;
 201 #endif
 202
 203 #ifdef PAR
 204     RtsFlags.ParFlags.ParStats.Full       = rtsFalse;
 205     RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
 206     RtsFlags.ParFlags.ParStats.Binary     = rtsFalse;
 207     RtsFlags.ParFlags.ParStats.Sparks     = rtsFalse;
 208     RtsFlags.ParFlags.ParStats.Heap       = rtsFalse;
 209     RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
 210     RtsFlags.ParFlags.ParStats.Global     = rtsFalse;
 211
 212     RtsFlags.ParFlags.outputDisabled    = rtsFalse;
 213 #ifdef DIST
 214     RtsFlags.ParFlags.doFairScheduling  = rtsTrue;  /* fair sched by def */
 215 #else
 216     RtsFlags.ParFlags.doFairScheduling  = rtsFalse;  /* unfair sched by def */
 217 #endif
 218     RtsFlags.ParFlags.packBufferSize    = 1024;
 219     RtsFlags.ParFlags.thunksToPack      = 1; /* 0 ... infinity; */
 220     RtsFlags.ParFlags.globalising       = 1; /* 0 ... everything */
 221     RtsFlags.ParFlags.maxThreads        = 1024;
 222     RtsFlags.ParFlags.maxFishes        = MAX_FISHES;
 223     RtsFlags.ParFlags.fishDelay         = FISH_DELAY;
 224 #endif
 225
 226 #if defined(PAR) || defined(THREADED_RTS)
 227     RtsFlags.ParFlags.maxLocalSparks    = 4096;
 228 #endif /* PAR || THREADED_RTS */
 229
 230 #if defined(GRAN)
 231     /* ToDo: check defaults for GranSim and GUM */
 232     RtsFlags.GcFlags.maxStkSize         = (8 * 1024 * 1024) / sizeof(W_);
 233     RtsFlags.GcFlags.initialStkSize     = 1024 / sizeof(W_);
 234
 235     RtsFlags.GranFlags.maxThreads       = 65536; // refers to mandatory threads
 236     RtsFlags.GranFlags.GranSimStats.Full        = rtsFalse;
 237     RtsFlags.GranFlags.GranSimStats.Suppressed  = rtsFalse;
 238     RtsFlags.GranFlags.GranSimStats.Binary      = rtsFalse;
 239     RtsFlags.GranFlags.GranSimStats.Sparks      = rtsFalse;
 240     RtsFlags.GranFlags.GranSimStats.Heap        = rtsFalse;
 241     RtsFlags.GranFlags.GranSimStats.NewLogfile  = rtsFalse;
 242     RtsFlags.GranFlags.GranSimStats.Global      = rtsFalse;
 243
 244     RtsFlags.GranFlags.packBufferSize   = 1024;
 245     RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
 246
 247     RtsFlags.GranFlags.proc         = MAX_PROC;
 248     RtsFlags.GranFlags.Fishing      = rtsFalse;
 249     RtsFlags.GranFlags.maxFishes   = MAX_FISHES;
 250     RtsFlags.GranFlags.time_slice   = GRAN_TIME_SLICE;
 251     RtsFlags.GranFlags.Light        = rtsFalse;
 252
 253     RtsFlags.GranFlags.Costs.latency =             LATENCY;
 254     RtsFlags.GranFlags.Costs.additional_latency =  ADDITIONAL_LATENCY;
 255     RtsFlags.GranFlags.Costs.fetchtime =           FETCHTIME;
 256     RtsFlags.GranFlags.Costs.lunblocktime =        LOCALUNBLOCKTIME;
 257     RtsFlags.GranFlags.Costs.gunblocktime =        GLOBALUNBLOCKTIME;
 258     RtsFlags.GranFlags.Costs.mpacktime =           MSGPACKTIME;
 259     RtsFlags.GranFlags.Costs.munpacktime =         MSGUNPACKTIME;
 260     RtsFlags.GranFlags.Costs.mtidytime =           MSGTIDYTIME;
 261
 262     RtsFlags.GranFlags.Costs.threadcreatetime =         THREADCREATETIME;
 263     RtsFlags.GranFlags.Costs.threadqueuetime =          THREADQUEUETIME;
 264     RtsFlags.GranFlags.Costs.threaddescheduletime =     THREADDESCHEDULETIME;
 265     RtsFlags.GranFlags.Costs.threadscheduletime =       THREADSCHEDULETIME;
 266     RtsFlags.GranFlags.Costs.threadcontextswitchtime =  THREADCONTEXTSWITCHTIME;
 267
 268     RtsFlags.GranFlags.Costs.arith_cost =         ARITH_COST;
 269     RtsFlags.GranFlags.Costs.branch_cost =        BRANCH_COST;
 270     RtsFlags.GranFlags.Costs.load_cost =          LOAD_COST;
 271     RtsFlags.GranFlags.Costs.store_cost =         STORE_COST;
 272     RtsFlags.GranFlags.Costs.float_cost =         FLOAT_COST;
 273
 274     RtsFlags.GranFlags.Costs.heapalloc_cost =     HEAPALLOC_COST;
 275
 276     RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
 277     RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
 278
 279     RtsFlags.GranFlags.DoFairSchedule           = rtsFalse;
 280     RtsFlags.GranFlags.DoAsyncFetch             = rtsFalse;
 281     RtsFlags.GranFlags.DoStealThreadsFirst      = rtsFalse;
 282     RtsFlags.GranFlags.DoAlwaysCreateThreads    = rtsFalse;
 283     RtsFlags.GranFlags.DoBulkFetching           = rtsFalse;
 284     RtsFlags.GranFlags.DoThreadMigration        = rtsFalse;
 285     RtsFlags.GranFlags.FetchStrategy            = 2;
 286     RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
 287     RtsFlags.GranFlags.DoPrioritySparking       = rtsFalse;
 288     RtsFlags.GranFlags.DoPriorityScheduling     = rtsFalse;
 289     RtsFlags.GranFlags.SparkPriority            = 0;
 290     RtsFlags.GranFlags.SparkPriority2           = 0;
 291     RtsFlags.GranFlags.RandomPriorities         = rtsFalse;
 292     RtsFlags.GranFlags.InversePriorities        = rtsFalse;
 293     RtsFlags.GranFlags.IgnorePriorities         = rtsFalse;
 294     RtsFlags.GranFlags.ThunksToPack             = 0;
 295     RtsFlags.GranFlags.RandomSteal              = rtsTrue;
 296 #endif
 297
 298 #ifdef TICKY_TICKY
 299     RtsFlags.TickyFlags.showTickyStats   = rtsFalse;
 300     RtsFlags.TickyFlags.tickyFile        = NULL;
 301 #endif
 302
 303     RtsFlags.TraceFlags.timestamp       = rtsFalse;
 304     RtsFlags.TraceFlags.sched           = rtsFalse;
 305
 306 #ifdef USE_PAPI
 307     /* By default no special measurements taken */
 308     RtsFlags.PapiFlags.eventType        = 0;
 309 #endif
 310 }
 311
 312 static const char *
 313 usage_text[] = {
 314 "",
 315 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
 316 "",
 317 "   +RTS    Indicates run time system options follow",
 318 "   -RTS    Indicates program arguments follow",
 319 "  --RTS    Indicates that ALL subsequent arguments will be given to the",
 320 "           program (including any of these RTS flags)",
 321 "",
 322 "The following run time system options are available:",
 323 "",
 324 "  -?       Prints this message and exits; the program is not executed",
 325 "",
 326 "  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
 327 "  -k<size> Sets the initial thread stack size (default 1k)  Egs: -k4k   -k2m",
 328 "",
 329 "  -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
 330 "  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
 331 "  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
 332 "  -m<n>    Minimum % of heap which must be available (default 3%)",
 333 "  -G<n>    Number of generations (default: 2)",
 334 "  -T<n>    Number of steps in younger generations (default: 2)",
 335 "  -c<n>    Auto-enable compaction of the oldest generation when live data is",
 336 "           at least <n>% of the maximum heap size set with -M (default: 30%)",
 337 "  -c       Enable compaction for all major collections",
 338 #if defined(THREADED_RTS)
 339 "  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
 340 #endif
 341 "",
 342 "  -t<file> One-line GC statistics  (default file: <program>.stat)",
 343 "  -s<file> Summary  GC statistics  (with -Sstderr going to stderr)",
 344 "  -S<file> Detailed GC statistics",
 345 #ifdef RTS_GTK_FRONTPANEL
 346 "  -f       Display front panel (requires X11 & GTK+)",
 347 #endif
 348 "",
 349 "",
 350 "  -Z       Don't squeeze out update frames on stack overflow",
 351 "  -B       Sound the bell at the start of each garbage collection",
 352 #if defined(PROFILING) || defined(PAR)
 353 "",
 354 "  -px      Time/allocation profile (XML)  (output file <program>.prof)",
 355 "  -p       Time/allocation profile        (output file <program>.prof)",
 356 "  -P       More detailed Time/Allocation profile",
 357 "  -Pa      Give information about *all* cost centres",
 358
 359 # if defined(PROFILING)
 360 "",
 361 "  -hx            Heap residency profile (XML)   (output file <program>.prof)",
 362 "  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
 363 "     break-down: c = cost centre stack (default)",
 364 "                 m = module",
 365 "                 d = closure description",
 366 "                 y = type description",
 367 "                 r = retainer",
 368 "                 b = biography (LAG,DRAG,VOID,USE)",
 369 "  A subset of closures may be selected thusly:",
 370 "    -hc<cc>,...  specific cost centre(s) (top of stack only)",
 371 "    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
 372 "    -hm<mod>...  all cost centres from the specified modules(s)",
 373 "    -hd<des>,... closures with specified closure descriptions",
 374 "    -hy<typ>...  closures with specified type descriptions",
 375 "    -hr<cc>...   closures with specified retainers",
 376 "    -hb<bio>...  closures with specified biographies (lag,drag,void,use)",
 377 "",
 378 "  -R<size>       Set the maximum retainer set size (default: 8)",
 379 "",
 380 "  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
 381 "                 (default: 25)",
 382 "",
 383 "  -i<sec>        Time between heap samples (seconds, default: 0.1)",
 384 "",
 385 "  -xt            Include threads (TSOs) in a heap profile",
 386 "",
 387 "  -xc      Show current cost centre stack on raising an exception",
 388 # endif
 389 #endif /* PROFILING or PAR */
 390 #if !defined(PROFILING) && defined(DEBUG)
 391 "",
 392 "  -h<break-down> Debugging Heap residency profile",
 393 "                 (output file <program>.hp)",
 394 "     break-down: L = closure label (default)",
 395 "                 T = closure type (constructor, thunk etc.)",
 396 #endif
 397 "",
 398 #if defined(TICKY_TICKY)
 399 "  -r<file>  Produce reduction profiling statistics (with -rstderr for stderr)",
 400 "",
 401 #endif
 402 #if defined(PAR)
 403 "  -N<n>     Use <n> PVMish processors in parallel (default: 2)",
 404 /* NB: the -N<n> is implemented by the driver!! */
 405 #endif
 406 "  -C<secs>  Context-switch interval in seconds.",
 407 "            0 or no argument means switch as often as possible.",
 408 "            Default: 0.02 sec; resolution is set by -V below.",
 409 "  -V<secs>  Master tick interval in seconds.",
 410 "            This sets the resolution for -C and the profile timer -i.",
 411 "            Default: 0.02 sec.",
 412 "",
 413 "  -vs       Trace scheduler events (see also -Ds with -debug)",
 414 "  -vt       Time-stamp trace messages",
 415 "",
 416 #if defined(DEBUG)
 417 "  -Ds  DEBUG: scheduler",
 418 "  -Di  DEBUG: interpreter",
 419 "  -Dw  DEBUG: weak",
 420 "  -DG  DEBUG: gccafs",
 421 "  -Dg  DEBUG: gc",
 422 "  -Db  DEBUG: block",
 423 "  -DS  DEBUG: sanity",
 424 "  -Dt  DEBUG: stable",
 425 "  -Dp  DEBUG: prof",
 426 "  -Dr  DEBUG: gran",
 427 "  -DP  DEBUG: par",
 428 "  -Dl  DEBUG: linker",
 429 "  -Dm  DEBUG: stm",
 430 "  -Dz  DEBUG: stack squezing",
 431 "  -Dc  DEBUG: program coverage",
 432 "",
 433 #endif /* DEBUG */
 434 #if defined(THREADED_RTS) && !defined(NOSMP)
 435 "  -N<n>     Use <n> OS threads (default: 1)",
 436 "  -qm       Don't automatically migrate threads between CPUs",
 437 "  -qw       Migrate a thread to the current CPU when it is woken up",
 438 #endif
 439 #if defined(THREADED_RTS) || defined(PAR)
 440 "  -e<size>  Size of spark pools (default 100)",
 441 #endif
 442 #if defined(PAR)
 443 "  -t<num>   Set maximum number of advisory threads per PE (default 32)",
 444 "  -qP       Enable activity profile (output files in ~/<program>*.gr)",
 445 "  -qQ<size> Set pack-buffer size (default: 1024)",
 446 "  -qd       Turn on PVM-ish debugging",
 447 "  -qO       Disable output for performance measurement",
 448 #endif
 449 #if defined(THREADED_RTS) || defined(PAR)
 450 "  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
 451 #endif
 452 #if defined(PAR)
 453 "  -d        Turn on PVM-ish debugging",
 454 "  -O        Disable output for performance measurement",
 455 #endif /* PAR */
 456 #if defined(GRAN)  /* ToDo: fill in decent Docu here */
 457 "  -b...     All GranSim options start with -b; see GranSim User's Guide for details",
 458 #endif
 459 #if defined(USE_PAPI)
 460 "  -aX       CPU performance counter measurements using PAPI",
 461 "            (use with the -s<file> option).  X is one of:",
 462 "",
 463 /* "            y - cycles", */
 464 "            1 - level 1 cache misses",
 465 "            2 - level 2 cache misses",
 466 "            b - branch mispredictions",
 467 "            s - stalled cycles",
 468 "            e - cache miss and branch misprediction events",
 469 #endif
 470 "",
 471 "RTS options may also be specified using the GHCRTS environment variable.",
 472 "",
 473 "Other RTS options may be available for programs compiled a different way.",
 474 "The GHC User's Guide has full details.",
 475 "",
 476 0
 477 };
 478
 479 STATIC_INLINE rtsBool
 480 strequal(const char *a, const char * b)
 481 {
 482     return(strcmp(a, b) == 0);
 483 }
 484
 485 static void
 486 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
 487 {
 488     char *c1, *c2;
 489
 490     c1 = s;
 491     do {
 492         while (isspace(*c1)) { c1++; };
 493         c2 = c1;
 494         while (!isspace(*c2) && *c2 != '\0') { c2++; };
 495
 496         if (c1 == c2) { break; }
 497
 498         if (*rts_argc < MAX_RTS_ARGS-1) {
 499             s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
 500             strncpy(s, c1, c2-c1);
 501             s[c2-c1] = '\0';
 502             rts_argv[(*rts_argc)++] = s;
 503         } else {
 504             barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 505         }
 506
 507         c1 = c2;
 508     } while (*c1 != '\0');
 509 }
 510
 511 void
 512 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
 513 {
 514     rtsBool error = rtsFalse;
 515     I_ mode;
 516     I_ arg, total_arg;
 517
 518     setProgName (argv);
 519     total_arg = *argc;
 520     arg = 1;
 521
 522     *argc = 1;
 523     *rts_argc = 0;
 524
 525     // process arguments from the ghc_rts_opts global variable first.
 526     // (arguments from the GHCRTS environment variable and the command
 527     // line override these).
 528     {
 529         if (ghc_rts_opts != NULL) {
 530             splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
 531         }
 532     }
 533
 534     // process arguments from the GHCRTS environment variable next
 535     // (arguments from the command line override these).
 536     {
 537         char *ghc_rts = getenv("GHCRTS");
 538
 539         if (ghc_rts != NULL) {
 540             splitRtsFlags(ghc_rts, rts_argc, rts_argv);
 541         }
 542     }
 543
 544     // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
 545     //   argv[0] must be PGM argument -- leave in argv
 546
 547     for (mode = PGM; arg < total_arg; arg++) {
 548         // The '--RTS' argument disables all future +RTS ... -RTS processing.
 549         if (strequal("--RTS", argv[arg])) {
 550             arg++;
 551             break;
 552         }
 553         // The '--' argument is passed through to the program, but
 554         // disables all further +RTS ... -RTS processing.
 555         else if (strequal("--", argv[arg])) {
 556             break;
 557         }
 558         else if (strequal("+RTS", argv[arg])) {
 559             mode = RTS;
 560         }
 561         else if (strequal("-RTS", argv[arg])) {
 562             mode = PGM;
 563         }
 564         else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
 565             rts_argv[(*rts_argc)++] = argv[arg];
 566         }
 567         else if (mode == PGM) {
 568             argv[(*argc)++] = argv[arg];
 569         }
 570         else {
 571           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 572         }
 573     }
 574     // process remaining program arguments
 575     for (; arg < total_arg; arg++) {
 576         argv[(*argc)++] = argv[arg];
 577     }
 578     argv[*argc] = (char *) 0;
 579     rts_argv[*rts_argc] = (char *) 0;
 580
 581     // Process RTS (rts_argv) part: mainly to determine statsfile
 582     for (arg = 0; arg < *rts_argc; arg++) {
 583         if (rts_argv[arg][0] != '-') {
 584             fflush(stdout);
 585             errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
 586             error = rtsTrue;
 587
 588         } else {
 589             switch(rts_argv[arg][1]) {
 590
 591               /* process: general args, then PROFILING-only ones,
 592                  then CONCURRENT-only, PARallel-only, GRAN-only,
 593                  TICKY-only (same order as defined in RtsFlags.lh);
 594                  within those groups, mostly in case-insensitive
 595                  alphabetical order.
 596                  Final group is x*, which allows for more options.
 597               */
 598
 599 #ifdef TICKY_TICKY
 600 # define TICKY_BUILD_ONLY(x) x
 601 #else
 602 # define TICKY_BUILD_ONLY(x) \
 603 errorBelch("not built for: ticky-ticky stats"); \
 604 error = rtsTrue;
 605 #endif
 606
 607 #if defined(PROFILING)
 608 # define COST_CENTRE_USING_BUILD_ONLY(x) x
 609 #else
 610 # define COST_CENTRE_USING_BUILD_ONLY(x) \
 611 errorBelch("not built for: -prof or -parallel"); \
 612 error = rtsTrue;
 613 #endif
 614
 615 #ifdef PROFILING
 616 # define PROFILING_BUILD_ONLY(x)   x
 617 #else
 618 # define PROFILING_BUILD_ONLY(x) \
 619 errorBelch("not built for: -prof"); \
 620 error = rtsTrue;
 621 #endif
 622
 623 #ifdef PAR
 624 # define PAR_BUILD_ONLY(x)      x
 625 #else
 626 # define PAR_BUILD_ONLY(x) \
 627 errorBelch("not built for: -parallel"); \
 628 error = rtsTrue;
 629 #endif
 630
 631 #ifdef THREADED_RTS
 632 # define THREADED_BUILD_ONLY(x)      x
 633 #else
 634 # define THREADED_BUILD_ONLY(x) \
 635 errorBelch("not built for: -smp"); \
 636 error = rtsTrue;
 637 #endif
 638
 639 #if defined(THREADED_RTS) || defined(PAR)
 640 # define PAR_OR_THREADED_BUILD_ONLY(x)      x
 641 #else
 642 # define PAR_OR_THREADED_BUILD_ONLY(x) \
 643 errorBelch("not built for: -parallel or -smp"); \
 644 error = rtsTrue;
 645 #endif
 646
 647 #ifdef GRAN
 648 # define GRAN_BUILD_ONLY(x)     x
 649 #else
 650 # define GRAN_BUILD_ONLY(x) \
 651 errorBelch("not built for: -gransim"); \
 652 error = rtsTrue;
 653 #endif
 654
 655               /* =========== GENERAL ========================== */
 656               case '?':
 657                 error = rtsTrue;
 658                 break;
 659
 660               case 'A':
 661                 RtsFlags.GcFlags.minAllocAreaSize
 662                   = decode(rts_argv[arg]+2) / BLOCK_SIZE;
 663                 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
 664                   bad_option(rts_argv[arg]);
 665                 }
 666                 break;
 667
 668 #ifdef USE_PAPI
 669               case 'a':
 670                 switch(rts_argv[arg][2]) {
 671                 case '1':
 672                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
 673                   break;
 674                 case '2':
 675                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
 676                   break;
 677                 case 'b':
 678                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
 679                   break;
 680                 case 's':
 681                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
 682                   break;
 683                 case 'e':
 684                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
 685                   break;
 686                 default:
 687                   bad_option( rts_argv[arg] );
 688                 }
 689                 break;
 690 #endif
 691
 692               case 'B':
 693                 RtsFlags.GcFlags.ringBell = rtsTrue;
 694                 break;
 695
 696               case 'c':
 697                   if (rts_argv[arg][2] != '\0') {
 698                       RtsFlags.GcFlags.compactThreshold =
 699                           atof(rts_argv[arg]+2);
 700                   } else {
 701                       RtsFlags.GcFlags.compact = rtsTrue;
 702                   }
 703                   break;
 704
 705               case 'F':
 706                 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
 707
 708                 if (RtsFlags.GcFlags.oldGenFactor < 0)
 709                   bad_option( rts_argv[arg] );
 710                 break;
 711
 712 #ifdef DEBUG
 713               case 'D':
 714               {
 715                   char *c;
 716
 717                   for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
 718                       switch (*c) {
 719                       case 's':
 720                           RtsFlags.DebugFlags.scheduler = rtsTrue;
 721                           break;
 722                       case 'i':
 723                           RtsFlags.DebugFlags.interpreter = rtsTrue;
 724                           break;
 725                       case 'w':
 726                           RtsFlags.DebugFlags.weak = rtsTrue;
 727                           break;
 728                       case 'G':
 729                           RtsFlags.DebugFlags.gccafs = rtsTrue;
 730                           break;
 731                       case 'g':
 732                           RtsFlags.DebugFlags.gc = rtsTrue;
 733                           break;
 734                       case 'b':
 735                           RtsFlags.DebugFlags.block_alloc = rtsTrue;
 736                           break;
 737                       case 'S':
 738                           RtsFlags.DebugFlags.sanity = rtsTrue;
 739                           break;
 740                       case 't':
 741                           RtsFlags.DebugFlags.stable = rtsTrue;
 742                           break;
 743                       case 'p':
 744                           RtsFlags.DebugFlags.prof = rtsTrue;
 745                           break;
 746                       case 'r':
 747                           RtsFlags.DebugFlags.gran = rtsTrue;
 748                           break;
 749                       case 'P':
 750                           RtsFlags.DebugFlags.par = rtsTrue;
 751                           break;
 752                       case 'l':
 753                           RtsFlags.DebugFlags.linker = rtsTrue;
 754                           break;
 755                       case 'a':
 756                           RtsFlags.DebugFlags.apply = rtsTrue;
 757                           break;
 758                       case 'm':
 759                           RtsFlags.DebugFlags.stm = rtsTrue;
 760                           break;
 761                       case 'z':
 762                           RtsFlags.DebugFlags.squeeze = rtsTrue;
 763                           break;
 764                       case 'c':
 765                           RtsFlags.DebugFlags.hpc = rtsTrue;
 766                           break;
 767                       default:
 768                           bad_option( rts_argv[arg] );
 769                       }
 770                   }
 771                   break;
 772               }
 773 #endif
 774
 775               case 'K':
 776                 RtsFlags.GcFlags.maxStkSize =
 777                   decode(rts_argv[arg]+2) / sizeof(W_);
 778
 779                 if (RtsFlags.GcFlags.maxStkSize == 0)
 780                   bad_option( rts_argv[arg] );
 781                 break;
 782
 783               case 'k':
 784                 RtsFlags.GcFlags.initialStkSize =
 785                   decode(rts_argv[arg]+2) / sizeof(W_);
 786
 787                 if (RtsFlags.GcFlags.initialStkSize == 0)
 788                   bad_option( rts_argv[arg] );
 789                 break;
 790
 791               case 'M':
 792                 RtsFlags.GcFlags.maxHeapSize =
 793                   decode(rts_argv[arg]+2) / BLOCK_SIZE;
 794                 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
 795
 796                 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
 797                   bad_option(rts_argv[arg]);
 798                 }
 799                 break;
 800
 801               case 'm':
 802                 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
 803
 804                 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
 805                     RtsFlags.GcFlags.pcFreeHeap > 100)
 806                   bad_option( rts_argv[arg] );
 807                 break;
 808
 809               case 'G':
 810                 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
 811                 if (RtsFlags.GcFlags.generations < 1) {
 812                   bad_option(rts_argv[arg]);
 813                 }
 814                 break;
 815
 816               case 'T':
 817                 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
 818                 if (RtsFlags.GcFlags.steps < 1) {
 819                   bad_option(rts_argv[arg]);
 820                 }
 821                 break;
 822
 823               case 'H':
 824                 RtsFlags.GcFlags.heapSizeSuggestion =
 825                   decode(rts_argv[arg]+2) / BLOCK_SIZE;
 826
 827                 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
 828                   bad_option(rts_argv[arg]);
 829                 }
 830                 break;
 831
 832 #ifdef RTS_GTK_FRONTPANEL
 833               case 'f':
 834                   RtsFlags.GcFlags.frontpanel = rtsTrue;
 835                   break;
 836 #endif
 837
 838               case 'I': /* idle GC delay */
 839                 if (rts_argv[arg][2] == '\0') {
 840                   /* use default */
 841                 } else {
 842                     I_ cst; /* tmp */
 843
 844                     /* Convert to millisecs */
 845                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 846                     RtsFlags.GcFlags.idleGCDelayTime = cst;
 847                 }
 848                 break;
 849
 850               case 'S':
 851                   RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
 852                   goto stats;
 853
 854               case 's':
 855                   RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
 856                   goto stats;
 857
 858               case 't':
 859                   RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
 860                   goto stats;
 861
 862             stats:
 863 #ifdef PAR
 864                 /* Opening all those files would almost certainly fail... */
 865                 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
 866                 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
 867 #else
 868                 {
 869                     int r;
 870                     r = open_stats_file(arg, *argc, argv,
 871                                         *rts_argc, rts_argv, STAT_FILENAME_FMT,
 872                                         &RtsFlags.GcFlags.statsFile);
 873                     if (r == -1) { error = rtsTrue; }
 874                 }
 875 #endif
 876                   break;
 877
 878               case 'Z':
 879                 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
 880                 break;
 881
 882               /* =========== PROFILING ========================== */
 883
 884               case 'P': /* detailed cost centre profiling (time/alloc) */
 885               case 'p': /* cost centre profiling (time/alloc) */
 886                 COST_CENTRE_USING_BUILD_ONLY(
 887                 switch (rts_argv[arg][2]) {
 888                   case 'x':
 889                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
 890                     break;
 891                   case 'a':
 892                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
 893                     break;
 894                   default:
 895                       if (rts_argv[arg][1] == 'P') {
 896                           RtsFlags.CcFlags.doCostCentres =
 897                               COST_CENTRES_VERBOSE;
 898                       } else {
 899                           RtsFlags.CcFlags.doCostCentres =
 900                               COST_CENTRES_SUMMARY;
 901                       }
 902                       break;
 903                 }
 904                 ) break;
 905
 906               case 'R':
 907                   PROFILING_BUILD_ONLY(
 908                       RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
 909                   ) break;
 910               case 'L':
 911                   PROFILING_BUILD_ONLY(
 912                       RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
 913                       if(RtsFlags.ProfFlags.ccsLength <= 0) {
 914                         bad_option(rts_argv[arg]);
 915                       }
 916                   ) break;
 917               case 'h': /* serial heap profile */
 918 #if !defined(PROFILING) && defined(DEBUG)
 919                 switch (rts_argv[arg][2]) {
 920                   case '\0':
 921                   case 'L':
 922                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
 923                     break;
 924                   case 'T':
 925                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
 926                     break;
 927                   default:
 928                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 929                     error = rtsTrue;
 930                 }
 931 #else
 932                 PROFILING_BUILD_ONLY(
 933                 switch (rts_argv[arg][2]) {
 934                 case '\0':
 935                 case 'C':
 936                 case 'c':
 937                 case 'M':
 938                 case 'm':
 939                 case 'D':
 940                 case 'd':
 941                 case 'Y':
 942                 case 'y':
 943                 case 'R':
 944                 case 'r':
 945                 case 'B':
 946                 case 'b':
 947                     if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
 948                         {
 949                             char *left  = strchr(rts_argv[arg], '{');
 950                             char *right = strrchr(rts_argv[arg], '}');
 951
 952                             // curly braces are optional, for
 953                             // backwards compat.
 954                             if (left)
 955                                 left = left+1;
 956                             else
 957                                 left = rts_argv[arg] + 3;
 958
 959                             if (!right)
 960                                 right = rts_argv[arg] + strlen(rts_argv[arg]);
 961
 962                             *right = '\0';
 963
 964                             switch (rts_argv[arg][2]) {
 965                             case 'c': // cost centre label select
 966                                 RtsFlags.ProfFlags.ccSelector = left;
 967                                 break;
 968                             case 'C':
 969                                 RtsFlags.ProfFlags.ccsSelector = left;
 970                                 break;
 971                             case 'M':
 972                             case 'm': // cost centre module select
 973                                 RtsFlags.ProfFlags.modSelector = left;
 974                                 break;
 975                             case 'D':
 976                             case 'd': // closure descr select
 977                                 RtsFlags.ProfFlags.descrSelector = left;
 978                                 break;
 979                             case 'Y':
 980                             case 'y': // closure type select
 981                                 RtsFlags.ProfFlags.typeSelector = left;
 982                                 break;
 983                             case 'R':
 984                             case 'r': // retainer select
 985                                 RtsFlags.ProfFlags.retainerSelector = left;
 986                                 break;
 987                             case 'B':
 988                             case 'b': // biography select
 989                                 RtsFlags.ProfFlags.bioSelector = left;
 990                                 break;
 991                             }
 992                         }
 993                         break;
 994                     }
 995
 996                     if (RtsFlags.ProfFlags.doHeapProfile != 0) {
 997                         errorBelch("multiple heap profile options");
 998                         error = rtsTrue;
 999                         break;
1000                     }
1001
1002                     switch (rts_argv[arg][2]) {
1003                     case '\0':
1004                     case 'C':
1005                     case 'c':
1006                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1007                         break;
1008                     case 'M':
1009                     case 'm':
1010                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1011                           break;
1012                     case 'D':
1013                     case 'd':
1014                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1015                           break;
1016                     case 'Y':
1017                     case 'y':
1018                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1019                           break;
1020                     case 'R':
1021                     case 'r':
1022                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1023                           break;
1024                     case 'B':
1025                     case 'b':
1026                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1027                           break;
1028                     }
1029                     break;
1030
1031                 default:
1032                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1033                     error = rtsTrue;
1034                 }
1035                 )
1036 #endif /* PROFILING */
1037                 break;
1038
1039 #if defined(PROFILING)
1040               case 'i': /* heap sample interval */
1041                 if (rts_argv[arg][2] == '\0') {
1042                   /* use default */
1043                 } else {
1044                     I_ cst; /* tmp */
1045
1046                     /* Convert to milliseconds */
1047                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1048                     RtsFlags.ProfFlags.profileInterval = cst;
1049                 }
1050                 break;
1051 #endif
1052
1053               /* =========== CONCURRENT ========================= */
1054               case 'C': /* context switch interval */
1055                 if (rts_argv[arg][2] == '\0')
1056                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1057                 else {
1058                     I_ cst; /* tmp */
1059
1060                     /* Convert to milliseconds */
1061                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1062                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1063                 }
1064                 break;
1065
1066               case 'V': /* master tick interval */
1067                 if (rts_argv[arg][2] == '\0') {
1068                     // turns off ticks completely
1069                     RtsFlags.MiscFlags.tickInterval = 0;
1070                 } else {
1071                     I_ cst; /* tmp */
1072
1073                     /* Convert to milliseconds */
1074                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1075                     RtsFlags.MiscFlags.tickInterval = cst;
1076                 }
1077                 break;
1078
1079 #if defined(THREADED_RTS) && !defined(NOSMP)
1080               case 'N':
1081                 THREADED_BUILD_ONLY(
1082                 if (rts_argv[arg][2] != '\0') {
1083                     RtsFlags.ParFlags.nNodes
1084                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1085                     if (RtsFlags.ParFlags.nNodes <= 0) {
1086                       errorBelch("bad value for -N");
1087                       error = rtsTrue;
1088                     }
1089                 }
1090                 ) break;
1091
1092               case 'q':
1093                     switch (rts_argv[arg][2]) {
1094                     case '\0':
1095                         errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1096                         error = rtsTrue;
1097                         break;
1098                     case 'm':
1099                         RtsFlags.ParFlags.migrate = rtsFalse;
1100                         break;
1101                     case 'w':
1102                         RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1103                         break;
1104                     default:
1105                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
1106                         error = rtsTrue;
1107                         break;
1108                     }
1109                     break;
1110 #endif
1111               /* =========== PARALLEL =========================== */
1112               case 'e':
1113                 PAR_OR_THREADED_BUILD_ONLY(
1114                 if (rts_argv[arg][2] != '\0') {
1115                     RtsFlags.ParFlags.maxLocalSparks
1116                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1117                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1118                       errorBelch("bad value for -e");
1119                       error = rtsTrue;
1120                     }
1121                 }
1122                 ) break;
1123
1124 #ifdef PAR
1125               case 'q':
1126                 PAR_BUILD_ONLY(
1127                   process_par_option(arg, rts_argc, rts_argv, &error);
1128                 ) break;
1129 #endif
1130
1131               /* =========== GRAN =============================== */
1132
1133               case 'b':
1134                 GRAN_BUILD_ONLY(
1135                   process_gran_option(arg, rts_argc, rts_argv, &error);
1136                 ) break;
1137
1138               /* =========== TICKY ============================== */
1139
1140               case 'r': /* Basic profiling stats */
1141                 TICKY_BUILD_ONLY(
1142
1143                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1144
1145                 {
1146                     int r;
1147                     r = open_stats_file(arg, *argc, argv,
1148                                         *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1149                                         &RtsFlags.TickyFlags.tickyFile);
1150                     if (r == -1) { error = rtsTrue; }
1151                 }
1152                 ) break;
1153
1154               /* =========== TRACING ---------=================== */
1155
1156               case 'v':
1157                 switch(rts_argv[arg][2]) {
1158                 case '\0':
1159                     errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1160                     error = rtsTrue;
1161                     break;
1162                 case 't':
1163                     RtsFlags.TraceFlags.timestamp = rtsTrue;
1164                     break;
1165                 case 's':
1166                     RtsFlags.TraceFlags.sched = rtsTrue;
1167                     break;
1168                 default:
1169                     errorBelch("unknown RTS option: %s",rts_argv[arg]);
1170                     error = rtsTrue;
1171                     break;
1172                 }
1173                 break;
1174
1175               /* =========== EXTENDED OPTIONS =================== */
1176
1177               case 'x': /* Extend the argument space */
1178                 switch(rts_argv[arg][2]) {
1179                   case '\0':
1180                     errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1181                     error = rtsTrue;
1182                     break;
1183
1184                   case 'c': /* Debugging tool: show current cost centre on an exception */
1185                     PROFILING_BUILD_ONLY(
1186                         RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1187                         );
1188                     break;
1189
1190                 case 't':  /* Include memory used by TSOs in a heap profile */
1191                     PROFILING_BUILD_ONLY(
1192                         RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1193                         );
1194                     break;
1195
1196                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
1197
1198                   default:
1199                     errorBelch("unknown RTS option: %s",rts_argv[arg]);
1200                     error = rtsTrue;
1201                     break;
1202                 }
1203                 break;  /* defensive programming */
1204
1205               /* =========== OH DEAR ============================ */
1206               default:
1207                 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1208                 error = rtsTrue;
1209                 break;
1210             }
1211         }
1212     }
1213
1214     // Determine what tick interval we should use for the RTS timer
1215     // by taking the shortest of the various intervals that we need to
1216     // monitor.
1217     if (RtsFlags.MiscFlags.tickInterval <= 0) {
1218         RtsFlags.MiscFlags.tickInterval = 50;
1219     }
1220
1221     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1222         RtsFlags.MiscFlags.tickInterval =
1223             stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1224                     RtsFlags.MiscFlags.tickInterval);
1225     }
1226
1227     if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1228         RtsFlags.MiscFlags.tickInterval =
1229             stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1230                     RtsFlags.MiscFlags.tickInterval);
1231     }
1232
1233 #ifdef PROFILING
1234     if (RtsFlags.ProfFlags.profileInterval > 0) {
1235         RtsFlags.MiscFlags.tickInterval =
1236             stg_min(RtsFlags.ProfFlags.profileInterval,
1237                     RtsFlags.MiscFlags.tickInterval);
1238     }
1239 #endif
1240
1241     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1242         RtsFlags.ConcFlags.ctxtSwitchTicks =
1243             RtsFlags.ConcFlags.ctxtSwitchTime /
1244             RtsFlags.MiscFlags.tickInterval;
1245     } else {
1246         RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1247     }
1248
1249 #ifdef PROFILING
1250     RtsFlags.ProfFlags.profileIntervalTicks =
1251         RtsFlags.ProfFlags.profileInterval / RtsFlags.MiscFlags.tickInterval;
1252 #endif
1253
1254     if (error) {
1255         const char **p;
1256
1257         fflush(stdout);
1258         for (p = usage_text; *p; p++)
1259             errorBelch("%s", *p);
1260         stg_exit(EXIT_FAILURE);
1261     }
1262 }
1263
1264 #if defined(GRAN)
1265
1266 static void
1267 enable_GranSimLight(void) {
1268
1269     debugBelch("GrAnSim Light enabled (infinite number of processors;  0 communication costs)\n");
1270     RtsFlags.GranFlags.Light=rtsTrue;
1271     RtsFlags.GranFlags.Costs.latency =
1272         RtsFlags.GranFlags.Costs.fetchtime =
1273         RtsFlags.GranFlags.Costs.additional_latency =
1274         RtsFlags.GranFlags.Costs.gunblocktime =
1275         RtsFlags.GranFlags.Costs.lunblocktime =
1276         RtsFlags.GranFlags.Costs.threadcreatetime =
1277         RtsFlags.GranFlags.Costs.threadqueuetime =
1278         RtsFlags.GranFlags.Costs.threadscheduletime =
1279         RtsFlags.GranFlags.Costs.threaddescheduletime =
1280         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1281
1282     RtsFlags.GranFlags.Costs.mpacktime =
1283         RtsFlags.GranFlags.Costs.munpacktime = 0;
1284
1285     RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1286     RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1287     RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1288     /* FetchStrategy is irrelevant in GrAnSim-Light */
1289
1290     /* GrAnSim Light often creates an abundance of parallel threads,
1291        each with its own stack etc. Therefore, it's in general a good
1292        idea to use small stack chunks (use the -o<size> option to
1293        increase it again).
1294     */
1295     // RtsFlags.ConcFlags.stkChunkSize = 100;
1296
1297     RtsFlags.GranFlags.proc = 1;
1298 }
1299
1300 static void
1301 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1302 {
1303     if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1304       return;
1305
1306     /* or a ridiculously idealised simulator */
1307     if(strcmp((rts_argv[arg]+2),"oring")==0) {
1308       RtsFlags.GranFlags.Costs.latency =
1309         RtsFlags.GranFlags.Costs.fetchtime =
1310         RtsFlags.GranFlags.Costs.additional_latency =
1311         RtsFlags.GranFlags.Costs.gunblocktime =
1312         RtsFlags.GranFlags.Costs.lunblocktime =
1313         RtsFlags.GranFlags.Costs.threadcreatetime =
1314         RtsFlags.GranFlags.Costs.threadqueuetime =
1315         RtsFlags.GranFlags.Costs.threadscheduletime =
1316         RtsFlags.GranFlags.Costs.threaddescheduletime =
1317         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1318
1319       RtsFlags.GranFlags.Costs.mpacktime =
1320         RtsFlags.GranFlags.Costs.munpacktime = 0;
1321
1322       RtsFlags.GranFlags.Costs.arith_cost =
1323         RtsFlags.GranFlags.Costs.float_cost =
1324         RtsFlags.GranFlags.Costs.load_cost =
1325         RtsFlags.GranFlags.Costs.store_cost =
1326         RtsFlags.GranFlags.Costs.branch_cost = 0;
1327
1328       RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1329
1330       /* ++RtsFlags.GranFlags.DoFairSchedule; */
1331       RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue;        /* -bZ */
1332       RtsFlags.GranFlags.DoThreadMigration   = rtsTrue;        /* -bM */
1333       RtsFlags.GranFlags.GranSimStats.Full   = rtsTrue;        /* -bP */
1334       return;
1335     }
1336
1337       /* or a somewhat idealised simulator */
1338       if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1339         RtsFlags.GranFlags.Costs.latency =
1340         RtsFlags.GranFlags.Costs.fetchtime =
1341         RtsFlags.GranFlags.Costs.additional_latency =
1342         RtsFlags.GranFlags.Costs.gunblocktime =
1343         RtsFlags.GranFlags.Costs.lunblocktime =
1344         RtsFlags.GranFlags.Costs.threadcreatetime =
1345         RtsFlags.GranFlags.Costs.threadqueuetime =
1346         RtsFlags.GranFlags.Costs.threadscheduletime =
1347         RtsFlags.GranFlags.Costs.threaddescheduletime =
1348         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1349
1350         RtsFlags.GranFlags.Costs.mpacktime =
1351         RtsFlags.GranFlags.Costs.munpacktime = 0;
1352
1353         RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1354
1355         /* RtsFlags.GranFlags.DoFairSchedule  = rtsTrue; */       /* -b-R */
1356         /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */   /* -b-T */
1357         RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;         /* -bZ */
1358         RtsFlags.GranFlags.DoThreadMigration  = rtsTrue;          /* -bM */
1359         RtsFlags.GranFlags.GranSimStats.Full  = rtsTrue;          /* -bP */
1360 #  if defined(GRAN_CHECK) && defined(GRAN)
1361         RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics   */
1362 #  endif
1363         return;
1364       }
1365
1366       /* Communication and task creation cost parameters */
1367       switch(rts_argv[arg][2]) {
1368         case '.':
1369           IgnoreYields = rtsTrue; // HWL HACK
1370           break;
1371
1372         case ':':
1373           enable_GranSimLight();       /* set flags for GrAnSim-Light mode */
1374           break;
1375
1376         case 'l':
1377           if (rts_argv[arg][3] != '\0')
1378             {
1379               RtsFlags.GranFlags.Costs.gunblocktime =
1380               RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1381               RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1382             }
1383           else
1384             RtsFlags.GranFlags.Costs.latency = LATENCY;
1385           break;
1386
1387         case 'a':
1388           if (rts_argv[arg][3] != '\0')
1389             RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1390           else
1391             RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1392           break;
1393
1394         case 'm':
1395           if (rts_argv[arg][3] != '\0')
1396             RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1397           else
1398             RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1399           break;
1400
1401         case 'x':
1402           if (rts_argv[arg][3] != '\0')
1403             RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1404           else
1405             RtsFlags.GranFlags.Costs.mtidytime = 0;
1406           break;
1407
1408         case 'r':
1409           if (rts_argv[arg][3] != '\0')
1410             RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1411           else
1412             RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1413           break;
1414
1415         case 'g':
1416           if (rts_argv[arg][3] != '\0')
1417             RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1418           else
1419             RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1420           break;
1421
1422         case 'n':
1423           if (rts_argv[arg][3] != '\0')
1424             RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1425           else
1426             RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1427           break;
1428
1429         case 'u':
1430           if (rts_argv[arg][3] != '\0')
1431             RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1432           else
1433             RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1434           break;
1435
1436         /* Thread-related metrics */
1437         case 't':
1438           if (rts_argv[arg][3] != '\0')
1439             RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1440           else
1441             RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1442           break;
1443
1444         case 'q':
1445           if (rts_argv[arg][3] != '\0')
1446             RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1447           else
1448             RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1449           break;
1450
1451         case 'c':
1452           if (rts_argv[arg][3] != '\0')
1453             RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1454           else
1455             RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1456
1457           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1458             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1459           break;
1460
1461         case 'd':
1462           if (rts_argv[arg][3] != '\0')
1463             RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1464           else
1465             RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1466
1467           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1468             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1469           break;
1470
1471         /* Instruction Cost Metrics */
1472         case 'A':
1473           if (rts_argv[arg][3] != '\0')
1474             RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1475           else
1476             RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1477           break;
1478
1479         case 'F':
1480           if (rts_argv[arg][3] != '\0')
1481             RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1482           else
1483             RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1484           break;
1485
1486         case 'B':
1487           if (rts_argv[arg][3] != '\0')
1488             RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1489           else
1490             RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1491           break;
1492
1493         case 'L':
1494           if (rts_argv[arg][3] != '\0')
1495             RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1496           else
1497             RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1498           break;
1499
1500         case 'S':
1501           if (rts_argv[arg][3] != '\0')
1502             RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1503           else
1504             RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1505           break;
1506
1507         case 'H':
1508           if (rts_argv[arg][3] != '\0')
1509             RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1510           else
1511             RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1512           break;
1513
1514         case 'y':
1515           RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1516           if (rts_argv[arg][3] != '\0')
1517             RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1518           else
1519             RtsFlags.GranFlags.FetchStrategy = 2;
1520           if (RtsFlags.GranFlags.FetchStrategy == 0)
1521             RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1522           break;
1523
1524         case 'K':   /* sort overhead (per elem in spark list) */
1525           if (rts_argv[arg][3] != '\0')
1526             RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1527           else
1528             RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1529           debugBelch("Overhead for pri spark: %d (per elem).\n",
1530                          RtsFlags.GranFlags.Costs.pri_spark_overhead);
1531           break;
1532
1533         case 'O':  /* sort overhead (per elem in spark list) */
1534           if (rts_argv[arg][3] != '\0')
1535             RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1536           else
1537             RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1538           debugBelch("Overhead for pri sched: %d (per elem).\n",
1539                        RtsFlags.GranFlags.Costs.pri_sched_overhead);
1540           break;
1541
1542         /* General Parameters */
1543         case 'p':
1544           if (rts_argv[arg][3] != '\0')
1545             {
1546               RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1547               if (RtsFlags.GranFlags.proc==0) {
1548                   enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1549               } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1550                          RtsFlags.GranFlags.proc < 1)
1551                 {
1552                   debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1553                           MAX_PROC);
1554                   *error = rtsTrue;
1555                 }
1556             }
1557           else
1558             RtsFlags.GranFlags.proc = MAX_PROC;
1559           break;
1560
1561         case 'f':
1562           RtsFlags.GranFlags.Fishing = rtsTrue;
1563           if (rts_argv[arg][3] != '\0')
1564             RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1565           else
1566             RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1567           break;
1568
1569         case 'w':
1570           if (rts_argv[arg][3] != '\0')
1571             RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1572           else
1573             RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1574           break;
1575
1576         case 'C':
1577           RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1578           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1579           break;
1580
1581         case 'G':
1582           debugBelch("Bulk fetching enabled.\n");
1583           RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1584           break;
1585
1586         case 'M':
1587           debugBelch("Thread migration enabled.\n");
1588           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1589           break;
1590
1591         case 'R':
1592           debugBelch("Fair Scheduling enabled.\n");
1593           RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1594           break;
1595
1596         case 'I':
1597           debugBelch("Priority Scheduling enabled.\n");
1598           RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1599           break;
1600
1601         case 'T':
1602           RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1603           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1604           break;
1605
1606         case 'Z':
1607           RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1608           break;
1609
1610 /*          case 'z': */
1611 /*        RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1612 /*        break; */
1613
1614         case 'N':
1615           RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1616           break;
1617
1618         case 'b':
1619           RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1620           break;
1621
1622         case 'P':
1623           /* format is -bP<c> where <c> is one char describing kind of profile */
1624           RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1625           switch(rts_argv[arg][3]) {
1626           case '\0': break; // nothing special, just an ordinary profile
1627           case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1628             break;
1629           case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1630             break;
1631           case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1632             break;
1633           case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1634             break;
1635           case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1636             break;
1637           case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1638             break;
1639           default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1640           }
1641           break;
1642
1643         case 's':
1644           RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1645           break;
1646
1647         case 'h':
1648           RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1649           break;
1650
1651         case 'Y':   /* syntax: -bY<n>[,<n>]  n ... pos int */
1652           if (rts_argv[arg][3] != '\0') {
1653             char *arg0, *tmp;
1654
1655             arg0 = rts_argv[arg]+3;
1656             if ((tmp = strstr(arg0,","))==NULL) {
1657               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1658               debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1659             } else {
1660               *(tmp++) = '\0';
1661               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1662               RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1663               debugBelch("SparkPriority: %u.\n",
1664                       RtsFlags.GranFlags.SparkPriority);
1665               debugBelch("SparkPriority2:%u.\n",
1666                       RtsFlags.GranFlags.SparkPriority2);
1667               if (RtsFlags.GranFlags.SparkPriority2 <
1668                   RtsFlags.GranFlags.SparkPriority) {
1669                 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1670                         RtsFlags.GranFlags.SparkPriority2,
1671                         RtsFlags.GranFlags.SparkPriority);
1672               }
1673             }
1674           } else {
1675             /* plain pri spark is now invoked with -bX
1676                RtsFlags.GranFlags.DoPrioritySparking = 1;
1677                debugBelch("PrioritySparking.\n");
1678             */
1679           }
1680           break;
1681
1682         case 'Q':
1683           if (rts_argv[arg][3] != '\0') {
1684             RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1685           } else {
1686             RtsFlags.GranFlags.ThunksToPack = 1;
1687           }
1688           debugBelch("Thunks To Pack in one packet: %u.\n",
1689                   RtsFlags.GranFlags.ThunksToPack);
1690           break;
1691
1692         case 'e':
1693           RtsFlags.GranFlags.RandomSteal = rtsFalse;
1694           debugBelch("Deterministic mode (no random stealing)\n");
1695                       break;
1696
1697           /* The following class of options contains eXperimental */
1698           /* features in connection with exploiting granularity */
1699           /* information. I.e. if -bY is chosen these options */
1700           /* tell the RTS what to do with the supplied info --HWL */
1701
1702         case 'W':
1703           if (rts_argv[arg][3] != '\0') {
1704             RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1705           } else {
1706             RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1707           }
1708           debugBelch("Size of GranSim internal pack buffer: %u.\n",
1709                   RtsFlags.GranFlags.packBufferSize_internal);
1710           break;
1711
1712         case 'X':
1713           switch(rts_argv[arg][3]) {
1714
1715             case '\0':
1716               RtsFlags.GranFlags.DoPrioritySparking = 1;
1717               debugBelch("Priority Sparking with Normal Priorities.\n");
1718               RtsFlags.GranFlags.InversePriorities = rtsFalse;
1719               RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1720               RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1721               break;
1722
1723             case 'I':
1724               RtsFlags.GranFlags.DoPrioritySparking = 1;
1725               debugBelch("Priority Sparking with Inverse Priorities.\n");
1726               RtsFlags.GranFlags.InversePriorities++;
1727               break;
1728
1729             case 'R':
1730               RtsFlags.GranFlags.DoPrioritySparking = 1;
1731               debugBelch("Priority Sparking with Random Priorities.\n");
1732               RtsFlags.GranFlags.RandomPriorities++;
1733               break;
1734
1735             case 'N':
1736               RtsFlags.GranFlags.DoPrioritySparking = 1;
1737               debugBelch("Priority Sparking with No Priorities.\n");
1738               RtsFlags.GranFlags.IgnorePriorities++;
1739               break;
1740
1741             default:
1742               bad_option( rts_argv[arg] );
1743               break;
1744           }
1745           break;
1746
1747         case '-':
1748           switch(rts_argv[arg][3]) {
1749
1750             case 'C':
1751               RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1752               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1753               break;
1754
1755             case 'G':
1756               RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1757               break;
1758
1759             case 'M':
1760               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1761               break;
1762
1763             case 'R':
1764               RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1765               break;
1766
1767             case 'T':
1768               RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1769               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1770               break;
1771
1772             case 'Z':
1773               RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1774               break;
1775
1776             case 'N':
1777               RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1778                          break;
1779
1780             case 'P':
1781               RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1782               break;
1783
1784             case 's':
1785               RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1786               break;
1787
1788             case 'h':
1789               RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1790               break;
1791
1792             case 'b':
1793               RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1794               break;
1795
1796             case 'X':
1797               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1798               break;
1799
1800             case 'Y':
1801               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1802               RtsFlags.GranFlags.SparkPriority = rtsFalse;
1803               break;
1804
1805             case 'I':
1806               RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1807               break;
1808
1809             case 'e':
1810               RtsFlags.GranFlags.RandomSteal = rtsFalse;
1811               break;
1812
1813             default:
1814               bad_option( rts_argv[arg] );
1815               break;
1816           }
1817           break;
1818
1819 #  if defined(GRAN_CHECK) && defined(GRAN)
1820         case 'D':
1821           switch(rts_argv[arg][3]) {
1822             case 'Q':    /* Set pack buffer size (same as 'Q' in GUM) */
1823               if (rts_argv[arg][4] != '\0') {
1824                 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1825                 debugBelch("Pack buffer size: %d\n",
1826                         RtsFlags.GranFlags.packBufferSize);
1827               } else {
1828                 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1829                 *error = rtsTrue;
1830               }
1831               break;
1832
1833           default:
1834               if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1835                 /* hack warning: interpret the flags as a binary number */
1836                 nat n = decode(rts_argv[arg]+3);
1837                 set_GranSim_debug_options(n);
1838               } else {
1839                 nat i;
1840                 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1841                   if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1842                     break;
1843
1844                 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1845                   debugBelch("Valid GranSim debug options are:\n");
1846                   help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1847                   bad_option( rts_argv[arg] );
1848                 } else { // flag found; now set it
1849                   set_GranSim_debug_options(GRAN_DEBUG_MASK(i));  // 2^i
1850                 }
1851               }
1852               break;
1853
1854 #if 0
1855             case 'e':       /* event trace; also -bD1 */
1856               debugBelch("DEBUG: event_trace; printing event trace.\n");
1857               RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1858               /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1859               break;
1860
1861             case 'E':       /* event statistics; also -bD2 */
1862               debugBelch("DEBUG: event_stats; printing event statistics.\n");
1863               RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1864               /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics   */
1865               break;
1866
1867             case 'f':       /* thunkStealing; also -bD4 */
1868               debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1869               RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1870               /* RtsFlags.GranFlags.Debug |= 0x2;  print fwd messages */
1871               break;
1872
1873             case 'z':       /* blockOnFetch; also -bD8 */
1874               debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1875               RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1876               /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1877               break;
1878
1879             case 't':       /* blockOnFetch_sanity; also -bD16 */
1880               debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1881               RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1882               /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch  */
1883               break;
1884
1885             case 'S':       /* priSpark; also -bD32 */
1886               debugBelch("DEBUG: priSpark; priority sparking.\n");
1887               RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1888               break;
1889
1890             case 's':       /* priSched; also -bD64 */
1891               debugBelch("DEBUG: priSched; priority scheduling.\n");
1892               RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1893               break;
1894
1895             case 'F':       /* findWork; also -bD128 */
1896               debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1897               RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1898               break;
1899
1900             case 'g':       /* globalBlock; also -bD256 */
1901               debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1902               RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1903               break;
1904
1905             case 'G':       /* pack; also -bD512 */
1906               debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
1907               RtsFlags.GranFlags.Debug.pack = rtsTrue;
1908               break;
1909
1910             case 'P':       /* packBuffer; also -bD1024 */
1911               debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1912               RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1913               break;
1914
1915             case 'o':       /* sortedQ; also -bD2048 */
1916               debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1917               RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1918               break;
1919
1920             case 'r':       /* randomSteal; also -bD4096 */
1921               debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1922               RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1923               break;
1924
1925             case 'q':       /* checkSparkQ; also -bD8192 */
1926               debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1927               RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1928               break;
1929
1930             case ':':       /* checkLight; also -bD16384 */
1931               debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
1932               RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1933               break;
1934
1935             case 'b':       /* bq; also -bD32768 */
1936               debugBelch("DEBUG: bq; check blocking queues\n");
1937               RtsFlags.GranFlags.Debug.bq = rtsTrue;
1938               break;
1939
1940             case 'd':       /* all options turned on */
1941               debugBelch("DEBUG: all options turned on.\n");
1942               set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1943               /* RtsFlags.GranFlags.Debug |= 0x40; */
1944               break;
1945
1946 /*          case '\0': */
1947 /*            RtsFlags.GranFlags.Debug = 1; */
1948 /*            break; */
1949 #endif
1950
1951           }
1952           break;
1953 #  endif  /* GRAN_CHECK */
1954       default:
1955         bad_option( rts_argv[arg] );
1956         break;
1957       }
1958 }
1959
1960 /*
1961   Interpret n as a binary number masking GranSim debug options and set the
1962   correxponding option. See gran_debug_opts_strs for explanations of the flags.
1963 */
1964 static void
1965 set_GranSim_debug_options(nat n) {
1966   nat i;
1967
1968   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1969     if ((n>>i)&1) {
1970       errorBelch(gran_debug_opts_strs[i]);
1971       switch (i) {
1972         case 0: RtsFlags.GranFlags.Debug.event_trace   = rtsTrue;  break;
1973         case 1: RtsFlags.GranFlags.Debug.event_stats   = rtsTrue;  break;
1974         case 2: RtsFlags.GranFlags.Debug.bq            = rtsTrue;  break;
1975         case 3: RtsFlags.GranFlags.Debug.pack          = rtsTrue;  break;
1976         case 4: RtsFlags.GranFlags.Debug.checkSparkQ   = rtsTrue;  break;
1977         case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;  break;
1978         case 6: RtsFlags.GranFlags.Debug.randomSteal   = rtsTrue;  break;
1979         case 7: RtsFlags.GranFlags.Debug.findWork      = rtsTrue;  break;
1980         case 8: RtsFlags.GranFlags.Debug.unused        = rtsTrue;  break;
1981         case 9: RtsFlags.GranFlags.Debug.pri           = rtsTrue;  break;
1982         case 10: RtsFlags.GranFlags.Debug.checkLight   = rtsTrue;  break;
1983         case 11: RtsFlags.GranFlags.Debug.sortedQ      = rtsTrue;  break;
1984         case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;  break;
1985         case 13: RtsFlags.GranFlags.Debug.packBuffer   = rtsTrue;  break;
1986         case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;  break;
1987         default: barf("set_GranSim_debug_options: only %d debug options expected");
1988       } /* switch */
1989     } /* if */
1990 }
1991
1992 /*
1993   Print one line explanation for each of the GranSim debug options specified
1994   in the bitmask n.
1995 */
1996 static void
1997 help_GranSim_debug_options(nat n) {
1998   nat i;
1999
2000   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2001     if ((n>>i)&1)
2002       debugBelch(gran_debug_opts_strs[i]);
2003 }
2004
2005 # elif defined(PAR)
2006
2007 static void
2008 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2009 {
2010
2011   if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2012     errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2013     return;
2014   }
2015
2016   /* Communication and task creation cost parameters */
2017   switch(rts_argv[arg][2]) {
2018   case 'e':  /* -qe<n>  ... allow <n> local sparks */
2019     if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2020       RtsFlags.ParFlags.maxLocalSparks
2021         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2022
2023       if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2024         errorBelch("setupRtsFlags: bad value for -e\n");
2025         *error = rtsTrue;
2026       }
2027     }
2028     IF_PAR_DEBUG(verbose,
2029                  errorBelch("-qe<n>: max %d local sparks",
2030                        RtsFlags.ParFlags.maxLocalSparks));
2031     break;
2032
2033   case 't':
2034     if (rts_argv[arg][3] != '\0') {
2035       RtsFlags.ParFlags.maxThreads
2036         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2037     } else {
2038       errorBelch("missing size for -qt\n");
2039       *error = rtsTrue;
2040     }
2041     IF_PAR_DEBUG(verbose,
2042                  errorBelch("-qt<n>: max %d threads",
2043                        RtsFlags.ParFlags.maxThreads));
2044     break;
2045
2046   case 'f':
2047     if (rts_argv[arg][3] != '\0')
2048       RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2049     else
2050       RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2051     break;
2052     IF_PAR_DEBUG(verbose,
2053                  errorBelch("-qf<n>: max %d fishes sent out at one time",
2054                        RtsFlags.ParFlags.maxFishes));
2055     break;
2056
2057   case 'F':
2058     if (rts_argv[arg][3] != '\0') {
2059       RtsFlags.ParFlags.fishDelay
2060         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2061     } else {
2062       errorBelch("missing fish delay time for -qF\n");
2063       *error = rtsTrue;
2064     }
2065     IF_PAR_DEBUG(verbose,
2066                  errorBelch("-qF<n>: fish delay time %d us",
2067                        RtsFlags.ParFlags.fishDelay));
2068     break;
2069
2070   case 'O':
2071     RtsFlags.ParFlags.outputDisabled = rtsTrue;
2072     IF_PAR_DEBUG(verbose,
2073                  errorBelch("-qO: output disabled"));
2074     break;
2075
2076   case 'g': /* -qg<n> ... globalisation scheme */
2077     if (rts_argv[arg][3] != '\0') {
2078       RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2079     } else {
2080       errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2081       *error = rtsTrue;
2082     }
2083     IF_PAR_DEBUG(verbose,
2084                  debugBelch("-qg<n>: globalisation scheme set to  %d",
2085                        RtsFlags.ParFlags.globalising));
2086     break;
2087
2088   case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2089     if (rts_argv[arg][3] != '\0') {
2090       RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2091     } else {
2092       errorBelch("missing number of thunks per packet (for -qh)\n");
2093       *error = rtsTrue;
2094     }
2095     IF_PAR_DEBUG(verbose,
2096                  debugBelch("-qh<n>: thunks per packet set to %d",
2097                        RtsFlags.ParFlags.thunksToPack));
2098     break;
2099
2100   case 'P': /* -qP for writing a log file */
2101     //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2102     /* same encoding as in GranSim after -bP */
2103     switch(rts_argv[arg][3]) {
2104     case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2105       break; // nothing special, just an ordinary profile
2106     case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2107         RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2108       break;
2109     case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2110       break;
2111     case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2112       break;
2113       //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2114       //  break;
2115     case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2116       break;
2117     case 'g':
2118 # if defined(PAR_TICKY)
2119       RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2120 # else
2121       errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2122       stg_exit(EXIT_FAILURE);
2123 # endif
2124       break;
2125     default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2126     }
2127     IF_PAR_DEBUG(verbose,
2128                  debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2129                        (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2130     break;
2131
2132   case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2133     if (rts_argv[arg][3] != '\0') {
2134       RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2135     } else {
2136       errorBelch("missing size of PackBuffer (for -qQ)\n");
2137       *error = rtsTrue;
2138     }
2139     IF_PAR_DEBUG(verbose,
2140                  debugBelch("-qQ<n>: pack buffer size set to %d",
2141                        RtsFlags.ParFlags.packBufferSize));
2142     break;
2143
2144   case 'R':
2145     RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2146     IF_PAR_DEBUG(verbose,
2147                  debugBelch("-qR: fair-ish scheduling"));
2148     break;
2149
2150 # if defined(DEBUG)
2151   case 'w':
2152     if (rts_argv[arg][3] != '\0') {
2153       RtsFlags.ParFlags.wait
2154         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2155     } else {
2156       RtsFlags.ParFlags.wait = 1000;
2157     }
2158     IF_PAR_DEBUG(verbose,
2159                  debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2160                        RtsFlags.ParFlags.wait));
2161     break;
2162
2163   case 'D':  /* -qD ... all the debugging options */
2164     if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2165       /* hack warning: interpret the flags as a binary number */
2166       nat n = decode(rts_argv[arg]+3);
2167       set_par_debug_options(n);
2168     } else {
2169       nat i;
2170       for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2171         if (rts_argv[arg][3] == par_debug_opts_flags[i])
2172           break;
2173
2174       if (i==MAX_PAR_DEBUG_OPTION+1) {
2175         errorBelch("Valid GUM debug options are:\n");
2176         help_par_debug_options(MAX_PAR_DEBUG_MASK);
2177         bad_option( rts_argv[arg] );
2178       } else { // flag found; now set it
2179         set_par_debug_options(PAR_DEBUG_MASK(i));  // 2^i
2180       }
2181     }
2182     break;
2183 # endif
2184   default:
2185     errorBelch("Unknown option -q%c (%d opts in total)",
2186           rts_argv[arg][2], *rts_argc);
2187     break;
2188   } /* switch */
2189 }
2190
2191 /*
2192   Interpret n as a binary number masking Par debug options and set the
2193   correxponding option. See par_debug_opts_strs for explanations of the flags.
2194 */
2195 static void
2196 set_par_debug_options(nat n) {
2197   nat i;
2198
2199   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2200     if ((n>>i)&1) {
2201       debugBelch(par_debug_opts_strs[i]);
2202       switch (i) {
2203         case 0: RtsFlags.ParFlags.Debug.verbose       = rtsTrue;  break;
2204         case 1: RtsFlags.ParFlags.Debug.bq            = rtsTrue;  break;
2205         case 2: RtsFlags.ParFlags.Debug.schedule      = rtsTrue;  break;
2206         case 3: RtsFlags.ParFlags.Debug.free          = rtsTrue;  break;
2207         case 4: RtsFlags.ParFlags.Debug.resume        = rtsTrue;  break;
2208         case 5: RtsFlags.ParFlags.Debug.weight        = rtsTrue;  break;
2209         case 6: RtsFlags.ParFlags.Debug.fetch         = rtsTrue;  break;
2210           //case 7: RtsFlags.ParFlags.Debug.ack           = rtsTrue;  break;
2211         case 7: RtsFlags.ParFlags.Debug.fish          = rtsTrue;  break;
2212         case 8: RtsFlags.ParFlags.Debug.tables        = rtsTrue;  break;
2213         case 9: RtsFlags.ParFlags.Debug.packet        = rtsTrue;  break;
2214         case 10: RtsFlags.ParFlags.Debug.pack         = rtsTrue;  break;
2215         case 11: RtsFlags.ParFlags.Debug.paranoia     = rtsTrue;  break;
2216         default: barf("set_par_debug_options: only %d debug options expected",
2217                       MAX_PAR_DEBUG_OPTION);
2218       } /* switch */
2219     } /* if */
2220 }
2221
2222 /*
2223   Print one line explanation for each of the GranSim debug options specified
2224   in the bitmask n.
2225 */
2226 static void
2227 help_par_debug_options(nat n) {
2228   nat i;
2229
2230   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2231     if ((n>>i)&1)
2232       debugBelch(par_debug_opts_strs[i]);
2233 }
2234
2235 #endif /* PAR */
2236
2237 static void
2238 stats_fprintf(FILE *f, char *s, ...)
2239 {
2240     va_list ap;
2241     va_start(ap,s);
2242     if (f == NULL) {
2243         vdebugBelch(s, ap);
2244     } else {
2245         vfprintf(f, s, ap);
2246     }
2247     va_end(ap);
2248 }
2249
2250 static int              /* return -1 on error */
2251 open_stats_file (
2252     I_ arg,
2253     int argc, char *argv[],
2254     int rts_argc, char *rts_argv[],
2255     const char *FILENAME_FMT,
2256     FILE **file_ret)
2257 {
2258     FILE *f = NULL;
2259
2260     if (strequal(rts_argv[arg]+2, "stderr")) { /* use debugBelch */
2261         f = NULL; /* NULL means use debugBelch */
2262     } else {
2263         if (rts_argv[arg][2] != '\0') {  /* stats file specified */
2264             f = fopen(rts_argv[arg]+2,"w");
2265         } else {
2266             char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2267             sprintf(stats_filename, FILENAME_FMT, argv[0]);
2268             f = fopen(stats_filename,"w");
2269         }
2270         if (f == NULL) {
2271             errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2272             return -1;
2273         }
2274     }
2275     *file_ret = f;
2276
2277     {
2278         /* Write argv and rtsv into start of stats file */
2279         int count;
2280         for(count = 0; count < argc; count++) {
2281             stats_fprintf(f, "%s ", argv[count]);
2282         }
2283         stats_fprintf(f, "+RTS ");
2284         for(count = 0; count < rts_argc; count++)
2285             stats_fprintf(f, "%s ", rts_argv[count]);
2286         stats_fprintf(f, "\n");
2287     }
2288     return 0;
2289 }
2290
2291
2292
2293 static I_
2294 decode(const char *s)
2295 {
2296     I_ c;
2297     StgDouble m;
2298
2299     if (!*s)
2300         return 0;
2301
2302     m = atof(s);
2303     c = s[strlen(s)-1];
2304
2305     if (c == 'g' || c == 'G')
2306         m *= 1000*1000*1000;    /* UNchecked! */
2307     else if (c == 'm' || c == 'M')
2308         m *= 1000*1000;                 /* We do not use powers of 2 (1024) */
2309     else if (c == 'k' || c == 'K')      /* to avoid possible bad effects on */
2310         m *= 1000;                      /* a direct-mapped cache.           */
2311     else if (c == 'w' || c == 'W')
2312         m *= sizeof(W_);
2313
2314     return (I_)m;
2315 }
2316
2317 static void
2318 bad_option(const char *s)
2319 {
2320   errorBelch("bad RTS option: %s", s);
2321   stg_exit(EXIT_FAILURE);
2322 }
2323
2324 /* -----------------------------------------------------------------------------
2325    Getting/Setting the program's arguments.
2326
2327    These are used by System.Environment, and parts of the RTS.
2328    -------------------------------------------------------------------------- */
2329
2330 void
2331 setProgName(char *argv[])
2332 {
2333     /* Remove directory from argv[0] -- default files in current directory */
2334 #if !defined(mingw32_HOST_OS)
2335     char *last_slash;
2336     if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2337         prog_name = last_slash+1;
2338    } else {
2339         prog_name = argv[0];
2340    }
2341 #else
2342     char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2343     while ( last_slash > argv[0] ) {
2344         if ( *last_slash == '/' || *last_slash == '\\' ) {
2345             prog_name = last_slash+1;
2346             return;
2347         }
2348         last_slash--;
2349     }
2350     prog_name = argv[0];
2351 #endif
2352 }
2353
2354 void
2355 getProgArgv(int *argc, char **argv[])
2356 {
2357     if (argc) { *argc = prog_argc; }
2358     if (argv) { *argv = prog_argv; }
2359 }
2360
2361 void
2362 setProgArgv(int argc, char *argv[])
2363 {
2364    /* Usually this is done by startupHaskell, so we don't need to call this.
2365       However, sometimes Hugs wants to change the arguments which Haskell
2366       getArgs >>= ... will be fed.  So you can do that by calling here
2367       _after_ calling startupHaskell.
2368    */
2369    prog_argc = argc;
2370    prog_argv = argv;
2371    setProgName(prog_argv);
2372 }