rts/RtsFlags.c

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