ghc/rts/RtsFlags.c

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