ghc/rts/RtsFlags.c

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