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