ghc/rts/RtsFlags.c

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