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