ghc/rts/RtsFlags.c

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