ghc/rts/RtsFlags.c

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