ghc/rts/RtsFlags.c

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