ghc/rts/RtsFlags.c

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