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