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