rts/RtsFlags.c

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