ghc/rts/RtsFlags.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: RtsFlags.c,v 1.58 2002/07/18 09:13:10 simonmar Exp $
   3  *
   4  * (c) The AQUA Project, Glasgow University, 1994-1997
   5  * (c) The GHC Team, 1998-1999
   6  *
   7  * Functions for parsing the argument list.
   8  *
   9  * ---------------------------------------------------------------------------*/
  10
  11 //@menu
  12 //* Includes::
  13 //* Constants::
  14 //* Static function decls::
  15 //* Command-line option parsing routines::
  16 //* GranSim specific options::
  17 //* Aux fcts::
  18 //@end menu
  19 //*/
  20
  21 //@node Includes, Constants
  22 //@subsection Includes
  23
  24 #include "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                   ) break;
 844
 845               case 'h': /* serial heap profile */
 846 #if !defined(PROFILING) && defined(DEBUG)
 847                 switch (rts_argv[arg][2]) {
 848                   case '\0':
 849                   case 'L':
 850                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
 851                     break;
 852                   case 'T':
 853                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
 854                     break;
 855                   default:
 856                     prog_belch("invalid heap profile option: %s",rts_argv[arg]);
 857                     error = rtsTrue;
 858                 }
 859 #else
 860                 PROFILING_BUILD_ONLY(
 861                 switch (rts_argv[arg][2]) {
 862                 case '\0':
 863                 case 'C':
 864                 case 'c':
 865                 case 'M':
 866                 case 'm':
 867                 case 'D':
 868                 case 'd':
 869                 case 'Y':
 870                 case 'y':
 871                 case 'R':
 872                 case 'r':
 873                 case 'B':
 874                 case 'b':
 875                     if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
 876                         {
 877                             char *left  = strchr(rts_argv[arg], '{');
 878                             char *right = strrchr(rts_argv[arg], '}');
 879
 880                             // curly braces are optional, for
 881                             // backwards compat.
 882                             if (left)
 883                                 left = left+1;
 884                             else
 885                                 left = rts_argv[arg] + 3;
 886
 887                             if (!right)
 888                                 right = rts_argv[arg] + strlen(rts_argv[arg]);
 889
 890                             *right = '\0';
 891
 892                             switch (rts_argv[arg][2]) {
 893                             case 'c': // cost centre label select
 894                                 RtsFlags.ProfFlags.ccSelector = left;
 895                                 break;
 896                             case 'C':
 897                                 RtsFlags.ProfFlags.ccsSelector = left;
 898                                 break;
 899                             case 'M':
 900                             case 'm': // cost centre module select
 901                                 RtsFlags.ProfFlags.modSelector = left;
 902                                 break;
 903                             case 'D':
 904                             case 'd': // closure descr select
 905                                 RtsFlags.ProfFlags.descrSelector = left;
 906                                 break;
 907                             case 'Y':
 908                             case 'y': // closure type select
 909                                 RtsFlags.ProfFlags.typeSelector = left;
 910                                 break;
 911                             case 'R':
 912                             case 'r': // retainer select
 913                                 RtsFlags.ProfFlags.retainerSelector = left;
 914                                 break;
 915                             case 'B':
 916                             case 'b': // biography select
 917                                 RtsFlags.ProfFlags.bioSelector = left;
 918                                 break;
 919                             }
 920                         }
 921                         break;
 922                     }
 923
 924                     if (RtsFlags.ProfFlags.doHeapProfile != 0) {
 925                         prog_belch("multiple heap profile options");
 926                         error = rtsTrue;
 927                         break;
 928                     }
 929
 930                     switch (rts_argv[arg][2]) {
 931                     case '\0':
 932                     case 'C':
 933                     case 'c':
 934                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
 935                         break;
 936                     case 'M':
 937                     case 'm':
 938                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
 939                           break;
 940                     case 'D':
 941                     case 'd':
 942                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
 943                           break;
 944                     case 'Y':
 945                     case 'y':
 946                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
 947                           break;
 948                     case 'R':
 949                     case 'r':
 950                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
 951                           break;
 952                     case 'B':
 953                     case 'b':
 954                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
 955                           break;
 956                     }
 957                     break;
 958
 959                 default:
 960                     prog_belch("invalid heap profile option: %s",rts_argv[arg]);
 961                     error = rtsTrue;
 962                 }
 963                 )
 964 #endif // PROFILING
 965                 break;
 966
 967 #if defined(PROFILING)
 968               case 'i': /* heap sample interval */
 969                 if (rts_argv[arg][2] == '\0') {
 970                   /* use default */
 971                 } else {
 972                     I_ cst; /* tmp */
 973
 974                     /* Convert to milliseconds */
 975                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 976                     cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
 977                     if (cst != 0 && cst < CS_MIN_MILLISECS)
 978                         cst = CS_MIN_MILLISECS;
 979
 980                     RtsFlags.ProfFlags.profileInterval = cst;
 981                 }
 982                 break;
 983 #endif
 984
 985               /* =========== CONCURRENT ========================= */
 986               case 'C': /* context switch interval */
 987                 if (rts_argv[arg][2] == '\0')
 988                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
 989                 else {
 990                     I_ cst; /* tmp */
 991
 992                     /* Convert to milliseconds */
 993                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 994                     cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
 995                     if (cst != 0 && cst < CS_MIN_MILLISECS)
 996                         cst = CS_MIN_MILLISECS;
 997
 998                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
 999                 }
1000                 break;
1001
1002 #ifdef SMP
1003               case 'N':
1004                 SMP_BUILD_ONLY(
1005                 if (rts_argv[arg][2] != '\0') {
1006                     RtsFlags.ParFlags.nNodes
1007                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1008                     if (RtsFlags.ParFlags.nNodes <= 0) {
1009                       prog_belch("bad value for -N");
1010                       error = rtsTrue;
1011                     }
1012                 }
1013                 ) break;
1014 #endif
1015               /* =========== PARALLEL =========================== */
1016               case 'e':
1017                 PAR_OR_SMP_BUILD_ONLY(
1018                 if (rts_argv[arg][2] != '\0') {
1019                     RtsFlags.ParFlags.maxLocalSparks
1020                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1021                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1022                       prog_belch("bad value for -e");
1023                       error = rtsTrue;
1024                     }
1025                 }
1026                 ) break;
1027
1028               case 'q':
1029                 PAR_BUILD_ONLY(
1030                   process_par_option(arg, rts_argc, rts_argv, &error);
1031                 ) break;
1032
1033               /* =========== GRAN =============================== */
1034
1035               case 'b':
1036                 GRAN_BUILD_ONLY(
1037                   process_gran_option(arg, rts_argc, rts_argv, &error);
1038                 ) break;
1039
1040               /* =========== TICKY ============================== */
1041
1042               case 'r': /* Basic profiling stats */
1043                 TICKY_BUILD_ONLY(
1044
1045                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1046                 RtsFlags.TickyFlags.tickyFile
1047                   = open_stats_file(arg, *argc, argv,
1048                         *rts_argc, rts_argv, TICKY_FILENAME_FMT);
1049
1050                 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
1051                 ) break;
1052
1053               /* =========== EXTENDED OPTIONS =================== */
1054
1055               case 'x': /* Extend the argument space */
1056                 switch(rts_argv[arg][2]) {
1057                   case '\0':
1058                     prog_belch("incomplete RTS option: %s",rts_argv[arg]);
1059                     error = rtsTrue;
1060                     break;
1061
1062                   case 'c': /* Debugging tool: show current cost centre on an exception */
1063                     PROFILING_BUILD_ONLY(
1064                     RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1065                     ) break;
1066
1067                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
1068
1069                   default:
1070                     prog_belch("unknown RTS option: %s",rts_argv[arg]);
1071                     error = rtsTrue;
1072                     break;
1073                 }
1074                 break;  /* defensive programming */
1075
1076               /* =========== OH DEAR ============================ */
1077               default:
1078                 prog_belch("unknown RTS option: %s",rts_argv[arg]);
1079                 error = rtsTrue;
1080                 break;
1081             }
1082         }
1083     }
1084     if (error) {
1085         const char **p;
1086
1087         fflush(stdout);
1088         for (p = usage_text; *p; p++)
1089             belch("%s", *p);
1090         stg_exit(EXIT_FAILURE);
1091     }
1092 }
1093
1094 #if defined(GRAN)
1095
1096 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
1097 //@subsection GranSim specific options
1098
1099 static void
1100 enable_GranSimLight(void) {
1101
1102     fprintf(stderr,"GrAnSim Light enabled (infinite number of processors;  0 communication costs)\n");
1103     RtsFlags.GranFlags.Light=rtsTrue;
1104     RtsFlags.GranFlags.Costs.latency =
1105         RtsFlags.GranFlags.Costs.fetchtime =
1106         RtsFlags.GranFlags.Costs.additional_latency =
1107         RtsFlags.GranFlags.Costs.gunblocktime =
1108         RtsFlags.GranFlags.Costs.lunblocktime =
1109         RtsFlags.GranFlags.Costs.threadcreatetime =
1110         RtsFlags.GranFlags.Costs.threadqueuetime =
1111         RtsFlags.GranFlags.Costs.threadscheduletime =
1112         RtsFlags.GranFlags.Costs.threaddescheduletime =
1113         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1114
1115     RtsFlags.GranFlags.Costs.mpacktime =
1116         RtsFlags.GranFlags.Costs.munpacktime = 0;
1117
1118     RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1119     RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1120     RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1121     /* FetchStrategy is irrelevant in GrAnSim-Light */
1122
1123     /* GrAnSim Light often creates an abundance of parallel threads,
1124        each with its own stack etc. Therefore, it's in general a good
1125        idea to use small stack chunks (use the -o<size> option to
1126        increase it again).
1127     */
1128     // RtsFlags.ConcFlags.stkChunkSize = 100;
1129
1130     RtsFlags.GranFlags.proc = 1;
1131 }
1132
1133 static void
1134 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1135 {
1136     if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1137       return;
1138
1139     /* or a ridiculously idealised simulator */
1140     if(strcmp((rts_argv[arg]+2),"oring")==0) {
1141       RtsFlags.GranFlags.Costs.latency =
1142         RtsFlags.GranFlags.Costs.fetchtime =
1143         RtsFlags.GranFlags.Costs.additional_latency =
1144         RtsFlags.GranFlags.Costs.gunblocktime =
1145         RtsFlags.GranFlags.Costs.lunblocktime =
1146         RtsFlags.GranFlags.Costs.threadcreatetime =
1147         RtsFlags.GranFlags.Costs.threadqueuetime =
1148         RtsFlags.GranFlags.Costs.threadscheduletime =
1149         RtsFlags.GranFlags.Costs.threaddescheduletime =
1150         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1151
1152       RtsFlags.GranFlags.Costs.mpacktime =
1153         RtsFlags.GranFlags.Costs.munpacktime = 0;
1154
1155       RtsFlags.GranFlags.Costs.arith_cost =
1156         RtsFlags.GranFlags.Costs.float_cost =
1157         RtsFlags.GranFlags.Costs.load_cost =
1158         RtsFlags.GranFlags.Costs.store_cost =
1159         RtsFlags.GranFlags.Costs.branch_cost = 0;
1160
1161       RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1162
1163       /* ++RtsFlags.GranFlags.DoFairSchedule; */
1164       RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue;        /* -bZ */
1165       RtsFlags.GranFlags.DoThreadMigration   = rtsTrue;        /* -bM */
1166       RtsFlags.GranFlags.GranSimStats.Full   = rtsTrue;        /* -bP */
1167       return;
1168     }
1169
1170       /* or a somewhat idealised simulator */
1171       if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1172         RtsFlags.GranFlags.Costs.latency =
1173         RtsFlags.GranFlags.Costs.fetchtime =
1174         RtsFlags.GranFlags.Costs.additional_latency =
1175         RtsFlags.GranFlags.Costs.gunblocktime =
1176         RtsFlags.GranFlags.Costs.lunblocktime =
1177         RtsFlags.GranFlags.Costs.threadcreatetime =
1178         RtsFlags.GranFlags.Costs.threadqueuetime =
1179         RtsFlags.GranFlags.Costs.threadscheduletime =
1180         RtsFlags.GranFlags.Costs.threaddescheduletime =
1181         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1182
1183         RtsFlags.GranFlags.Costs.mpacktime =
1184         RtsFlags.GranFlags.Costs.munpacktime = 0;
1185
1186         RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1187
1188         /* RtsFlags.GranFlags.DoFairSchedule  = rtsTrue; */       /* -b-R */
1189         /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */   /* -b-T */
1190         RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;         /* -bZ */
1191         RtsFlags.GranFlags.DoThreadMigration  = rtsTrue;          /* -bM */
1192         RtsFlags.GranFlags.GranSimStats.Full  = rtsTrue;          /* -bP */
1193 #  if defined(GRAN_CHECK) && defined(GRAN)
1194         RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics   */
1195 #  endif
1196         return;
1197       }
1198
1199       /* Communication and task creation cost parameters */
1200       switch(rts_argv[arg][2]) {
1201         case '.':
1202           IgnoreYields = rtsTrue; // HWL HACK
1203           break;
1204
1205         case ':':
1206           enable_GranSimLight();       /* set flags for GrAnSim-Light mode */
1207           break;
1208
1209         case 'l':
1210           if (rts_argv[arg][3] != '\0')
1211             {
1212               RtsFlags.GranFlags.Costs.gunblocktime =
1213               RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1214               RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1215             }
1216           else
1217             RtsFlags.GranFlags.Costs.latency = LATENCY;
1218           break;
1219
1220         case 'a':
1221           if (rts_argv[arg][3] != '\0')
1222             RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1223           else
1224             RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1225           break;
1226
1227         case 'm':
1228           if (rts_argv[arg][3] != '\0')
1229             RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1230           else
1231             RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1232           break;
1233
1234         case 'x':
1235           if (rts_argv[arg][3] != '\0')
1236             RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1237           else
1238             RtsFlags.GranFlags.Costs.mtidytime = 0;
1239           break;
1240
1241         case 'r':
1242           if (rts_argv[arg][3] != '\0')
1243             RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1244           else
1245             RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1246           break;
1247
1248         case 'g':
1249           if (rts_argv[arg][3] != '\0')
1250             RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1251           else
1252             RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1253           break;
1254
1255         case 'n':
1256           if (rts_argv[arg][3] != '\0')
1257             RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1258           else
1259             RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1260           break;
1261
1262         case 'u':
1263           if (rts_argv[arg][3] != '\0')
1264             RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1265           else
1266             RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1267           break;
1268
1269         /* Thread-related metrics */
1270         case 't':
1271           if (rts_argv[arg][3] != '\0')
1272             RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1273           else
1274             RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1275           break;
1276
1277         case 'q':
1278           if (rts_argv[arg][3] != '\0')
1279             RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1280           else
1281             RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1282           break;
1283
1284         case 'c':
1285           if (rts_argv[arg][3] != '\0')
1286             RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1287           else
1288             RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1289
1290           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1291             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1292           break;
1293
1294         case 'd':
1295           if (rts_argv[arg][3] != '\0')
1296             RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1297           else
1298             RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1299
1300           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1301             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1302           break;
1303
1304         /* Instruction Cost Metrics */
1305         case 'A':
1306           if (rts_argv[arg][3] != '\0')
1307             RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1308           else
1309             RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1310           break;
1311
1312         case 'F':
1313           if (rts_argv[arg][3] != '\0')
1314             RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1315           else
1316             RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1317           break;
1318
1319         case 'B':
1320           if (rts_argv[arg][3] != '\0')
1321             RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1322           else
1323             RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1324           break;
1325
1326         case 'L':
1327           if (rts_argv[arg][3] != '\0')
1328             RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1329           else
1330             RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1331           break;
1332
1333         case 'S':
1334           if (rts_argv[arg][3] != '\0')
1335             RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1336           else
1337             RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1338           break;
1339
1340         case 'H':
1341           if (rts_argv[arg][3] != '\0')
1342             RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1343           else
1344             RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1345           break;
1346
1347         case 'y':
1348           RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1349           if (rts_argv[arg][3] != '\0')
1350             RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1351           else
1352             RtsFlags.GranFlags.FetchStrategy = 2;
1353           if (RtsFlags.GranFlags.FetchStrategy == 0)
1354             RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1355           break;
1356
1357         case 'K':   /* sort overhead (per elem in spark list) */
1358           if (rts_argv[arg][3] != '\0')
1359             RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1360           else
1361             RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1362           fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1363                          RtsFlags.GranFlags.Costs.pri_spark_overhead);
1364           break;
1365
1366         case 'O':  /* sort overhead (per elem in spark list) */
1367           if (rts_argv[arg][3] != '\0')
1368             RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1369           else
1370             RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1371           fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1372                        RtsFlags.GranFlags.Costs.pri_sched_overhead);
1373           break;
1374
1375         /* General Parameters */
1376         case 'p':
1377           if (rts_argv[arg][3] != '\0')
1378             {
1379               RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1380               if (RtsFlags.GranFlags.proc==0) {
1381                   enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1382               } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1383                          RtsFlags.GranFlags.proc < 1)
1384                 {
1385                   fprintf(stderr,"setupRtsFlags: no more than %u processors
1386 allowed\n",
1387                           MAX_PROC);
1388                   *error = rtsTrue;
1389                 }
1390             }
1391           else
1392             RtsFlags.GranFlags.proc = MAX_PROC;
1393           break;
1394
1395         case 'f':
1396           RtsFlags.GranFlags.Fishing = rtsTrue;
1397           if (rts_argv[arg][3] != '\0')
1398             RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1399           else
1400             RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1401           break;
1402
1403         case 'w':
1404           if (rts_argv[arg][3] != '\0')
1405             RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1406           else
1407             RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1408           break;
1409
1410         case 'C':
1411           RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1412           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1413           break;
1414
1415         case 'G':
1416           fprintf(stderr,"Bulk fetching enabled.\n");
1417           RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1418           break;
1419
1420         case 'M':
1421           fprintf(stderr,"Thread migration enabled.\n");
1422           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1423           break;
1424
1425         case 'R':
1426           fprintf(stderr,"Fair Scheduling enabled.\n");
1427           RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1428           break;
1429
1430         case 'I':
1431           fprintf(stderr,"Priority Scheduling enabled.\n");
1432           RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1433           break;
1434
1435         case 'T':
1436           RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1437           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1438           break;
1439
1440         case 'Z':
1441           RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1442           break;
1443
1444 /*          case 'z': */
1445 /*        RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1446 /*        break; */
1447
1448         case 'N':
1449           RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1450           break;
1451
1452         case 'b':
1453           RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1454           break;
1455
1456         case 'P':
1457           /* format is -bP<c> where <c> is one char describing kind of profile */
1458           RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1459           switch(rts_argv[arg][3]) {
1460           case '\0': break; // nothing special, just an ordinary profile
1461           case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1462             break;
1463           case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1464             break;
1465           case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1466             break;
1467           case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1468             break;
1469           case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1470             break;
1471           case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1472             break;
1473           default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1474           }
1475           break;
1476
1477         case 's':
1478           RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1479           break;
1480
1481         case 'h':
1482           RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1483           break;
1484
1485         case 'Y':   /* syntax: -bY<n>[,<n>]  n ... pos int */
1486           if (rts_argv[arg][3] != '\0') {
1487             char *arg0, *tmp;
1488
1489             arg0 = rts_argv[arg]+3;
1490             if ((tmp = strstr(arg0,","))==NULL) {
1491               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1492               fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1493             } else {
1494               *(tmp++) = '\0';
1495               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1496               RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1497               fprintf(stderr,"SparkPriority: %u.\n",
1498                       RtsFlags.GranFlags.SparkPriority);
1499               fprintf(stderr,"SparkPriority2:%u.\n",
1500                       RtsFlags.GranFlags.SparkPriority2);
1501               if (RtsFlags.GranFlags.SparkPriority2 <
1502                   RtsFlags.GranFlags.SparkPriority) {
1503                 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1504                         RtsFlags.GranFlags.SparkPriority2,
1505                         RtsFlags.GranFlags.SparkPriority);
1506               }
1507             }
1508           } else {
1509             /* plain pri spark is now invoked with -bX
1510                RtsFlags.GranFlags.DoPrioritySparking = 1;
1511                fprintf(stderr,"PrioritySparking.\n");
1512             */
1513           }
1514           break;
1515
1516         case 'Q':
1517           if (rts_argv[arg][3] != '\0') {
1518             RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1519           } else {
1520             RtsFlags.GranFlags.ThunksToPack = 1;
1521           }
1522           fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1523                   RtsFlags.GranFlags.ThunksToPack);
1524           break;
1525
1526         case 'e':
1527           RtsFlags.GranFlags.RandomSteal = rtsFalse;
1528           fprintf(stderr,"Deterministic mode (no random stealing)\n");
1529                       break;
1530
1531           /* The following class of options contains eXperimental */
1532           /* features in connection with exploiting granularity */
1533           /* information. I.e. if -bY is chosen these options */
1534           /* tell the RTS what to do with the supplied info --HWL */
1535
1536         case 'W':
1537           if (rts_argv[arg][3] != '\0') {
1538             RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1539           } else {
1540             RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1541           }
1542           fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1543                   RtsFlags.GranFlags.packBufferSize_internal);
1544           break;
1545
1546         case 'X':
1547           switch(rts_argv[arg][3]) {
1548
1549             case '\0':
1550               RtsFlags.GranFlags.DoPrioritySparking = 1;
1551               fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1552               RtsFlags.GranFlags.InversePriorities = rtsFalse;
1553               RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1554               RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1555               break;
1556
1557             case 'I':
1558               RtsFlags.GranFlags.DoPrioritySparking = 1;
1559               fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1560               RtsFlags.GranFlags.InversePriorities++;
1561               break;
1562
1563             case 'R':
1564               RtsFlags.GranFlags.DoPrioritySparking = 1;
1565               fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1566               RtsFlags.GranFlags.RandomPriorities++;
1567               break;
1568
1569             case 'N':
1570               RtsFlags.GranFlags.DoPrioritySparking = 1;
1571               fprintf(stderr,"Priority Sparking with No Priorities.\n");
1572               RtsFlags.GranFlags.IgnorePriorities++;
1573               break;
1574
1575             default:
1576               bad_option( rts_argv[arg] );
1577               break;
1578           }
1579           break;
1580
1581         case '-':
1582           switch(rts_argv[arg][3]) {
1583
1584             case 'C':
1585               RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1586               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1587               break;
1588
1589             case 'G':
1590               RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1591               break;
1592
1593             case 'M':
1594               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1595               break;
1596
1597             case 'R':
1598               RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1599               break;
1600
1601             case 'T':
1602               RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1603               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1604               break;
1605
1606             case 'Z':
1607               RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1608               break;
1609
1610             case 'N':
1611               RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1612                          break;
1613
1614             case 'P':
1615               RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1616               break;
1617
1618             case 's':
1619               RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1620               break;
1621
1622             case 'h':
1623               RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1624               break;
1625
1626             case 'b':
1627               RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1628               break;
1629
1630             case 'X':
1631               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1632               break;
1633
1634             case 'Y':
1635               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1636               RtsFlags.GranFlags.SparkPriority = rtsFalse;
1637               break;
1638
1639             case 'I':
1640               RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1641               break;
1642
1643             case 'e':
1644               RtsFlags.GranFlags.RandomSteal = rtsFalse;
1645               break;
1646
1647             default:
1648               bad_option( rts_argv[arg] );
1649               break;
1650           }
1651           break;
1652
1653 #  if defined(GRAN_CHECK) && defined(GRAN)
1654         case 'D':
1655           switch(rts_argv[arg][3]) {
1656             case 'Q':    /* Set pack buffer size (same as 'Q' in GUM) */
1657               if (rts_argv[arg][4] != '\0') {
1658                 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1659                 fprintf(stderr,"Pack buffer size: %d\n",
1660                         RtsFlags.GranFlags.packBufferSize);
1661               } else {
1662                 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1663                 *error = rtsTrue;
1664               }
1665               break;
1666
1667           default:
1668               if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1669                 /* hack warning: interpret the flags as a binary number */
1670                 nat n = decode(rts_argv[arg]+3);
1671                 set_GranSim_debug_options(n);
1672               } else {
1673                 nat i;
1674                 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1675                   if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1676                     break;
1677
1678                 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1679                   fprintf(stderr, "Valid GranSim debug options are:\n");
1680                   help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1681                   bad_option( rts_argv[arg] );
1682                 } else { // flag found; now set it
1683                   set_GranSim_debug_options(GRAN_DEBUG_MASK(i));  // 2^i
1684                 }
1685               }
1686               break;
1687
1688 #if 0
1689             case 'e':       /* event trace; also -bD1 */
1690               fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1691               RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1692               /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1693               break;
1694
1695             case 'E':       /* event statistics; also -bD2 */
1696               fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1697               RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1698               /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics   */
1699               break;
1700
1701             case 'f':       /* thunkStealing; also -bD4 */
1702               fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1703               RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1704               /* RtsFlags.GranFlags.Debug |= 0x2;  print fwd messages */
1705               break;
1706
1707             case 'z':       /* blockOnFetch; also -bD8 */
1708               fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1709               RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1710               /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1711               break;
1712
1713             case 't':       /* blockOnFetch_sanity; also -bD16 */
1714               fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1715               RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1716               /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch  */
1717               break;
1718
1719             case 'S':       /* priSpark; also -bD32 */
1720               fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1721               RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1722               break;
1723
1724             case 's':       /* priSched; also -bD64 */
1725               fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1726               RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1727               break;
1728
1729             case 'F':       /* findWork; also -bD128 */
1730               fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1731               RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1732               break;
1733
1734             case 'g':       /* globalBlock; also -bD256 */
1735               fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1736               RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1737               break;
1738
1739             case 'G':       /* pack; also -bD512 */
1740               fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1741               RtsFlags.GranFlags.Debug.pack = rtsTrue;
1742               break;
1743
1744             case 'P':       /* packBuffer; also -bD1024 */
1745               fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1746               RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1747               break;
1748
1749             case 'o':       /* sortedQ; also -bD2048 */
1750               fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1751               RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1752               break;
1753
1754             case 'r':       /* randomSteal; also -bD4096 */
1755               fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1756               RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1757               break;
1758
1759             case 'q':       /* checkSparkQ; also -bD8192 */
1760               fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1761               RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1762               break;
1763
1764             case ':':       /* checkLight; also -bD16384 */
1765               fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1766               RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1767               break;
1768
1769             case 'b':       /* bq; also -bD32768 */
1770               fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1771               RtsFlags.GranFlags.Debug.bq = rtsTrue;
1772               break;
1773
1774             case 'd':       /* all options turned on */
1775               fprintf(stderr,"DEBUG: all options turned on.\n");
1776               set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1777               /* RtsFlags.GranFlags.Debug |= 0x40; */
1778               break;
1779
1780 /*          case '\0': */
1781 /*            RtsFlags.GranFlags.Debug = 1; */
1782 /*            break; */
1783 #endif
1784
1785           }
1786           break;
1787 #  endif  /* GRAN_CHECK */
1788       default:
1789         bad_option( rts_argv[arg] );
1790         break;
1791       }
1792 }
1793
1794 /*
1795   Interpret n as a binary number masking GranSim debug options and set the
1796   correxponding option. See gran_debug_opts_strs for explanations of the flags.
1797 */
1798 static void
1799 set_GranSim_debug_options(nat n) {
1800   nat i;
1801
1802   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1803     if ((n>>i)&1) {
1804       fprintf(stderr, gran_debug_opts_strs[i]);
1805       switch (i) {
1806         case 0: RtsFlags.GranFlags.Debug.event_trace   = rtsTrue;  break;
1807         case 1: RtsFlags.GranFlags.Debug.event_stats   = rtsTrue;  break;
1808         case 2: RtsFlags.GranFlags.Debug.bq            = rtsTrue;  break;
1809         case 3: RtsFlags.GranFlags.Debug.pack          = rtsTrue;  break;
1810         case 4: RtsFlags.GranFlags.Debug.checkSparkQ   = rtsTrue;  break;
1811         case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;  break;
1812         case 6: RtsFlags.GranFlags.Debug.randomSteal   = rtsTrue;  break;
1813         case 7: RtsFlags.GranFlags.Debug.findWork      = rtsTrue;  break;
1814         case 8: RtsFlags.GranFlags.Debug.unused        = rtsTrue;  break;
1815         case 9: RtsFlags.GranFlags.Debug.pri           = rtsTrue;  break;
1816         case 10: RtsFlags.GranFlags.Debug.checkLight   = rtsTrue;  break;
1817         case 11: RtsFlags.GranFlags.Debug.sortedQ      = rtsTrue;  break;
1818         case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;  break;
1819         case 13: RtsFlags.GranFlags.Debug.packBuffer   = rtsTrue;  break;
1820         case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;  break;
1821         default: barf("set_GranSim_debug_options: only %d debug options expected");
1822       } /* switch */
1823     } /* if */
1824 }
1825
1826 /*
1827   Print one line explanation for each of the GranSim debug options specified
1828   in the bitmask n.
1829 */
1830 static void
1831 help_GranSim_debug_options(nat n) {
1832   nat i;
1833
1834   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1835     if ((n>>i)&1)
1836       fprintf(stderr, gran_debug_opts_strs[i]);
1837 }
1838
1839 # elif defined(PAR)
1840
1841 static void
1842 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1843 {
1844
1845   if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
1846     belch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
1847     return;
1848   }
1849
1850   /* Communication and task creation cost parameters */
1851   switch(rts_argv[arg][2]) {
1852   case 'e':  /* -qe<n>  ... allow <n> local sparks */
1853     if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1854       RtsFlags.ParFlags.maxLocalSparks
1855         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1856
1857       if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1858         belch("setupRtsFlags: bad value for -e\n");
1859         *error = rtsTrue;
1860       }
1861     }
1862     IF_PAR_DEBUG(verbose,
1863                  belch("-qe<n>: max %d local sparks",
1864                        RtsFlags.ParFlags.maxLocalSparks));
1865     break;
1866
1867   case 't':
1868     if (rts_argv[arg][3] != '\0') {
1869       RtsFlags.ParFlags.maxThreads
1870         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1871     } else {
1872       belch("setupRtsFlags: missing size for -qt\n");
1873       *error = rtsTrue;
1874     }
1875     IF_PAR_DEBUG(verbose,
1876                  belch("-qt<n>: max %d threads",
1877                        RtsFlags.ParFlags.maxThreads));
1878     break;
1879
1880   case 'f':
1881     if (rts_argv[arg][3] != '\0')
1882       RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1883     else
1884       RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1885     break;
1886     IF_PAR_DEBUG(verbose,
1887                  belch("-qf<n>: max %d fishes sent out at one time",
1888                        RtsFlags.ParFlags.maxFishes));
1889     break;
1890
1891   case 'F':
1892     if (rts_argv[arg][3] != '\0') {
1893       RtsFlags.ParFlags.fishDelay
1894         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1895     } else {
1896       belch("setupRtsFlags: missing fish delay time for -qF\n");
1897       *error = rtsTrue;
1898     }
1899     IF_PAR_DEBUG(verbose,
1900                  belch("-qF<n>: fish delay time %d us",
1901                        RtsFlags.ParFlags.fishDelay));
1902     break;
1903
1904   case 'O':
1905     RtsFlags.ParFlags.outputDisabled = rtsTrue;
1906     IF_PAR_DEBUG(verbose,
1907                  belch("-qO: output disabled"));
1908     break;
1909
1910   case 'g': /* -qg<n> ... globalisation scheme */
1911     if (rts_argv[arg][3] != '\0') {
1912       RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
1913     } else {
1914       belch("setupRtsFlags: missing identifier for globalisation scheme (for -qg)\n");
1915       *error = rtsTrue;
1916     }
1917     IF_PAR_DEBUG(verbose,
1918                  belch("-qg<n>: globalisation scheme set to  %d",
1919                        RtsFlags.ParFlags.globalising));
1920     break;
1921
1922   case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
1923     if (rts_argv[arg][3] != '\0') {
1924       RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
1925     } else {
1926       belch("setupRtsFlags: missing number of thunks per packet (for -qh)\n");
1927       *error = rtsTrue;
1928     }
1929     IF_PAR_DEBUG(verbose,
1930                  belch("-qh<n>: thunks per packet set to %d",
1931                        RtsFlags.ParFlags.thunksToPack));
1932     break;
1933
1934   case 'P': /* -qP for writing a log file */
1935     //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1936     /* same encoding as in GranSim after -bP */
1937     switch(rts_argv[arg][3]) {
1938     case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1939       break; // nothing special, just an ordinary profile
1940     case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1941         RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1942       break;
1943     case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1944       break;
1945     case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1946       break;
1947       //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1948       //  break;
1949     case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1950       break;
1951     case 'g':
1952 # if defined(PAR_TICKY)
1953       RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1954 # else
1955       fprintf(stderr,"-qPg is only possible for a PAR_TICKY RTS, which this is not");
1956       stg_exit(EXIT_FAILURE);
1957 # endif
1958       break;
1959     default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1960     }
1961     IF_PAR_DEBUG(verbose,
1962                  belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1963                        (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1964     break;
1965
1966   case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1967     if (rts_argv[arg][3] != '\0') {
1968       RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1969     } else {
1970       belch("setupRtsFlags: missing size of PackBuffer (for -qQ)\n");
1971       *error = rtsTrue;
1972     }
1973     IF_PAR_DEBUG(verbose,
1974                  belch("-qQ<n>: pack buffer size set to %d",
1975                        RtsFlags.ParFlags.packBufferSize));
1976     break;
1977
1978   case 'R':
1979     RtsFlags.ParFlags.doFairScheduling = rtsTrue;
1980     IF_PAR_DEBUG(verbose,
1981                  belch("-qR: fair-ish scheduling"));
1982     break;
1983
1984 # if defined(DEBUG)
1985   case 'w':
1986     if (rts_argv[arg][3] != '\0') {
1987       RtsFlags.ParFlags.wait
1988         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1989     } else {
1990       RtsFlags.ParFlags.wait = 1000;
1991     }
1992     IF_PAR_DEBUG(verbose,
1993                  belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1994                        RtsFlags.ParFlags.wait));
1995     break;
1996
1997   case 'D':  /* -qD ... all the debugging options */
1998     if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1999       /* hack warning: interpret the flags as a binary number */
2000       nat n = decode(rts_argv[arg]+3);
2001       set_par_debug_options(n);
2002     } else {
2003       nat i;
2004       for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2005         if (rts_argv[arg][3] == par_debug_opts_flags[i])
2006           break;
2007
2008       if (i==MAX_PAR_DEBUG_OPTION+1) {
2009         fprintf(stderr, "Valid GUM debug options are:\n");
2010         help_par_debug_options(MAX_PAR_DEBUG_MASK);
2011         bad_option( rts_argv[arg] );
2012       } else { // flag found; now set it
2013         set_par_debug_options(PAR_DEBUG_MASK(i));  // 2^i
2014       }
2015     }
2016     break;
2017 # endif
2018   default:
2019     belch("Unknown option -q%c (%d opts in total)",
2020           rts_argv[arg][2], *rts_argc);
2021     break;
2022   } /* switch */
2023 }
2024
2025 /*
2026   Interpret n as a binary number masking Par debug options and set the
2027   correxponding option. See par_debug_opts_strs for explanations of the flags.
2028 */
2029 static void
2030 set_par_debug_options(nat n) {
2031   nat i;
2032
2033   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2034     if ((n>>i)&1) {
2035       fprintf(stderr, par_debug_opts_strs[i]);
2036       switch (i) {
2037         case 0: RtsFlags.ParFlags.Debug.verbose       = rtsTrue;  break;
2038         case 1: RtsFlags.ParFlags.Debug.bq            = rtsTrue;  break;
2039         case 2: RtsFlags.ParFlags.Debug.schedule      = rtsTrue;  break;
2040         case 3: RtsFlags.ParFlags.Debug.free          = rtsTrue;  break;
2041         case 4: RtsFlags.ParFlags.Debug.resume        = rtsTrue;  break;
2042         case 5: RtsFlags.ParFlags.Debug.weight        = rtsTrue;  break;
2043         case 6: RtsFlags.ParFlags.Debug.fetch         = rtsTrue;  break;
2044           //case 7: RtsFlags.ParFlags.Debug.ack           = rtsTrue;  break;
2045         case 7: RtsFlags.ParFlags.Debug.fish          = rtsTrue;  break;
2046         case 8: RtsFlags.ParFlags.Debug.tables        = rtsTrue;  break;
2047         case 9: RtsFlags.ParFlags.Debug.packet        = rtsTrue;  break;
2048         case 10: RtsFlags.ParFlags.Debug.pack         = rtsTrue;  break;
2049         case 11: RtsFlags.ParFlags.Debug.paranoia     = rtsTrue;  break;
2050         default: barf("set_par_debug_options: only %d debug options expected",
2051                       MAX_PAR_DEBUG_OPTION);
2052       } /* switch */
2053     } /* if */
2054 }
2055
2056 /*
2057   Print one line explanation for each of the GranSim debug options specified
2058   in the bitmask n.
2059 */
2060 static void
2061 help_par_debug_options(nat n) {
2062   nat i;
2063
2064   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2065     if ((n>>i)&1)
2066       fprintf(stderr, par_debug_opts_strs[i]);
2067 }
2068
2069 #endif /* PAR */
2070
2071 #ifdef DEBUG
2072 static void
2073 set_debug_options(nat n) {
2074   nat i;
2075
2076   for (i=0; i<=MAX_DEBUG_OPTION; i++)
2077     if ((n>>i)&1) {
2078       fprintf(stderr, debug_opts_strs[i]);
2079       switch (i) {
2080         case 0: RtsFlags.DebugFlags.scheduler   = rtsTrue; break;
2081         case 1: RtsFlags.DebugFlags.evaluator   = rtsTrue; break;
2082         case 2: RtsFlags.DebugFlags.codegen     = rtsTrue; break;
2083         case 3: RtsFlags.DebugFlags.weak        = rtsTrue; break;
2084         case 4: RtsFlags.DebugFlags.gccafs      = rtsTrue; break;
2085         case 5: RtsFlags.DebugFlags.gc          = rtsTrue; break;
2086         case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
2087         case 7: RtsFlags.DebugFlags.sanity      = rtsTrue; break;
2088         case 8: RtsFlags.DebugFlags.stable      = rtsTrue; break;
2089         case 9: RtsFlags.DebugFlags.prof        = rtsTrue; break;
2090         case 10:  RtsFlags.DebugFlags.gran       = rtsTrue; break;
2091         case 11:  RtsFlags.DebugFlags.par        = rtsTrue; break;
2092         case 12:  RtsFlags.DebugFlags.linker     = rtsTrue; break;
2093         default: barf("set_debug_options: only %d debug options expected",
2094                       MAX_DEBUG_OPTION);
2095       } /* switch */
2096     } /* if */
2097 }
2098
2099 static void
2100 help_debug_options(nat n) {
2101   nat i;
2102
2103   for (i=0; i<=MAX_DEBUG_OPTION; i++)
2104     if ((n>>i)&1)
2105       fprintf(stderr, debug_opts_strs[i]);
2106 }
2107 #endif /* DEBUG */
2108
2109 //@node Aux fcts,  , GranSim specific options
2110 //@subsection Aux fcts
2111
2112 static FILE *           /* return NULL on error */
2113 open_stats_file (
2114     I_ arg,
2115     int argc, char *argv[],
2116     int rts_argc, char *rts_argv[],
2117     const char *FILENAME_FMT)
2118 {
2119     FILE *f = NULL;
2120
2121     if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
2122         f = stderr;
2123     else if (rts_argv[arg][2] != '\0')      /* stats file specified */
2124         f = fopen(rts_argv[arg]+2,"w");
2125     else {
2126         char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2127         sprintf(stats_filename, FILENAME_FMT, argv[0]);
2128         f = fopen(stats_filename,"w");
2129     }
2130     if (f == NULL) {
2131         fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
2132     } else {
2133         /* Write argv and rtsv into start of stats file */
2134         I_ count;
2135         for(count = 0; count < argc; count++)
2136             fprintf(f, "%s ", argv[count]);
2137         fprintf(f, "+RTS ");
2138         for(count = 0; count < rts_argc; count++)
2139             fprintf(f, "%s ", rts_argv[count]);
2140         fprintf(f, "\n");
2141     }
2142
2143     return(f);
2144 }
2145
2146 static I_
2147 decode(const char *s)
2148 {
2149     I_ c;
2150     StgDouble m;
2151
2152     if (!*s)
2153         return 0;
2154
2155     m = atof(s);
2156     c = s[strlen(s)-1];
2157
2158     if (c == 'g' || c == 'G')
2159         m *= 1000*1000*1000;    /* UNchecked! */
2160     else if (c == 'm' || c == 'M')
2161         m *= 1000*1000;                 /* We do not use powers of 2 (1024) */
2162     else if (c == 'k' || c == 'K')      /* to avoid possible bad effects on */
2163         m *= 1000;                      /* a direct-mapped cache.           */
2164     else if (c == 'w' || c == 'W')
2165         m *= sizeof(W_);
2166
2167     return (I_)m;
2168 }
2169
2170 static void
2171 bad_option(const char *s)
2172 {
2173   prog_belch("bad RTS option: %s", s);
2174   stg_exit(EXIT_FAILURE);
2175 }