ghc/rts/RtsFlags.c

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