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