ghc/rts/RtsFlags.c

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