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