ghc/rts/RtsFlags.c

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