rts/RtsFlags.c

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