ghc/rts/RtsFlags.c

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