ghc/rts/RtsFlags.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: RtsFlags.c,v 1.48 2001/08/13 12:34:37 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            = rtsFalse;
 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 unlimited)  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       Enable compaction for all major collections",
 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     total_arg = *argc;
 501     arg = 1;
 502
 503     *argc = 1;
 504     *rts_argc = 0;
 505
 506     // process arguments from the GHCRTS environment variable first
 507     // (arguments from the command line override these).
 508     {
 509         char *ghc_rts = getenv("GHCRTS");
 510         char *c1, *c2, *s;
 511
 512         if (ghc_rts != NULL) {
 513             c1 = ghc_rts;
 514             do {
 515                 while (isspace(*c1)) { c1++; };
 516                 c2 = c1;
 517                 while (!isspace(*c2) && *c2 != '\0') { c2++; };
 518
 519                 if (c1 == c2) { break; }
 520
 521                 if (*rts_argc < MAX_RTS_ARGS-1) {
 522                     s = malloc(c2-c1+1);
 523                     strncpy(s, c1, c2-c1);
 524                     s[c2-c1] = '\0';
 525                     rts_argv[(*rts_argc)++] = s;
 526                 } else {
 527                     barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 528                 }
 529
 530                 c1 = c2;
 531             } while (*c1 != '\0');
 532         }
 533     }
 534
 535     // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
 536     //   argv[0] must be PGM argument -- leave in argv
 537
 538     for (mode = PGM; arg < total_arg; arg++) {
 539         // The '--RTS' argument disables all future +RTS ... -RTS processing.
 540         if (strequal("--RTS", argv[arg])) {
 541             arg++;
 542             break;
 543         }
 544         // The '--' argument is passed through to the program, but
 545         // disables all further +RTS ... -RTS processing.
 546         else if (strequal("--", argv[arg])) {
 547             break;
 548         }
 549         else if (strequal("+RTS", argv[arg])) {
 550             mode = RTS;
 551         }
 552         else if (strequal("-RTS", argv[arg])) {
 553             mode = PGM;
 554         }
 555         else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
 556             rts_argv[(*rts_argc)++] = argv[arg];
 557         }
 558         else if (mode == PGM) {
 559             argv[(*argc)++] = argv[arg];
 560         }
 561         else {
 562           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 563         }
 564     }
 565     // process remaining program arguments
 566     for (; arg < total_arg; arg++) {
 567         argv[(*argc)++] = argv[arg];
 568     }
 569     argv[*argc] = (char *) 0;
 570     rts_argv[*rts_argc] = (char *) 0;
 571
 572     // Process RTS (rts_argv) part: mainly to determine statsfile
 573     for (arg = 0; arg < *rts_argc; arg++) {
 574         if (rts_argv[arg][0] != '-') {
 575             fflush(stdout);
 576             prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
 577             error = rtsTrue;
 578
 579         } else {
 580             switch(rts_argv[arg][1]) {
 581
 582               /* process: general args, then PROFILING-only ones,
 583                  then CONCURRENT-only, PARallel-only, GRAN-only,
 584                  TICKY-only (same order as defined in RtsFlags.lh);
 585                  within those groups, mostly in case-insensitive
 586                  alphabetical order.
 587                  Final group is x*, which allows for more options.
 588               */
 589
 590 #ifdef TICKY_TICKY
 591 # define TICKY_BUILD_ONLY(x) x
 592 #else
 593 # define TICKY_BUILD_ONLY(x) \
 594 prog_belch("GHC not built for: ticky-ticky stats"); \
 595 error = rtsTrue;
 596 #endif
 597
 598 #if defined(PROFILING)
 599 # define COST_CENTRE_USING_BUILD_ONLY(x) x
 600 #else
 601 # define COST_CENTRE_USING_BUILD_ONLY(x) \
 602 prog_belch("GHC not built for: -prof or -parallel"); \
 603 error = rtsTrue;
 604 #endif
 605
 606 #ifdef PROFILING
 607 # define PROFILING_BUILD_ONLY(x)   x
 608 #else
 609 # define PROFILING_BUILD_ONLY(x) \
 610 prog_belch("GHC not built for: -prof"); \
 611 error = rtsTrue;
 612 #endif
 613
 614 #ifdef SMP
 615 # define SMP_BUILD_ONLY(x)      x
 616 #else
 617 # define SMP_BUILD_ONLY(x) \
 618 prog_belch("GHC not built for: -smp"); \
 619 error = rtsTrue;
 620 #endif
 621
 622 #ifdef PAR
 623 # define PAR_BUILD_ONLY(x)      x
 624 #else
 625 # define PAR_BUILD_ONLY(x) \
 626 prog_belch("GHC not built for: -parallel"); \
 627 error = rtsTrue;
 628 #endif
 629
 630 #if defined(SMP) || defined(PAR)
 631 # define PAR_OR_SMP_BUILD_ONLY(x)      x
 632 #else
 633 # define PAR_OR_SMP_BUILD_ONLY(x) \
 634 prog_belch("GHC not built for: -parallel or -smp"); \
 635 error = rtsTrue;
 636 #endif
 637
 638 #ifdef GRAN
 639 # define GRAN_BUILD_ONLY(x)     x
 640 #else
 641 # define GRAN_BUILD_ONLY(x) \
 642 prog_belch("GHC not built for: -gransim"); \
 643 error = rtsTrue;
 644 #endif
 645
 646               /* =========== GENERAL ========================== */
 647               case '?':
 648                 error = rtsTrue;
 649                 break;
 650
 651               case 'A':
 652                 RtsFlags.GcFlags.minAllocAreaSize
 653                   = decode(rts_argv[arg]+2) / BLOCK_SIZE;
 654                 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
 655                   bad_option(rts_argv[arg]);
 656                 }
 657                 break;
 658
 659               case 'B':
 660                 RtsFlags.GcFlags.ringBell = rtsTrue;
 661                 break;
 662
 663               case 'c':
 664                   if (rts_argv[arg][2] != '\0') {
 665                       RtsFlags.GcFlags.compactThreshold =
 666                           atof(rts_argv[arg]+2);
 667                   } else {
 668                       RtsFlags.GcFlags.compact = rtsTrue;
 669                   }
 670                   break;
 671
 672               case 'F':
 673                 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
 674
 675                 if (RtsFlags.GcFlags.oldGenFactor < 0)
 676                   bad_option( rts_argv[arg] );
 677                 break;
 678
 679 #ifdef DEBUG
 680               case 'D':
 681                 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
 682                 /* hack warning: interpret the flags as a binary number */
 683                   nat n = decode(rts_argv[arg]+2);
 684                   set_debug_options(n);
 685                 }
 686                 break;
 687 #endif
 688
 689               case 'K':
 690                 RtsFlags.GcFlags.maxStkSize =
 691                   decode(rts_argv[arg]+2) / sizeof(W_);
 692
 693                 if (RtsFlags.GcFlags.maxStkSize == 0)
 694                   bad_option( rts_argv[arg] );
 695                 break;
 696
 697               case 'k':
 698                 RtsFlags.GcFlags.initialStkSize =
 699                   decode(rts_argv[arg]+2) / sizeof(W_);
 700
 701                 if (RtsFlags.GcFlags.initialStkSize == 0)
 702                   bad_option( rts_argv[arg] );
 703                 break;
 704
 705               case 'M':
 706                 RtsFlags.GcFlags.maxHeapSize =
 707                   decode(rts_argv[arg]+2) / BLOCK_SIZE;
 708                 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
 709
 710                 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
 711                   bad_option(rts_argv[arg]);
 712                 }
 713                 break;
 714
 715               case 'm':
 716                 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
 717
 718                 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
 719                     RtsFlags.GcFlags.pcFreeHeap > 100)
 720                   bad_option( rts_argv[arg] );
 721                 break;
 722
 723               case 'G':
 724                 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
 725                 if (RtsFlags.GcFlags.generations < 1) {
 726                   bad_option(rts_argv[arg]);
 727                 }
 728                 break;
 729
 730               case 'T':
 731                 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
 732                 if (RtsFlags.GcFlags.steps < 1) {
 733                   bad_option(rts_argv[arg]);
 734                 }
 735                 break;
 736
 737               case 'H':
 738                 RtsFlags.GcFlags.heapSizeSuggestion =
 739                   decode(rts_argv[arg]+2) / BLOCK_SIZE;
 740
 741                 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
 742                   bad_option(rts_argv[arg]);
 743                 }
 744                 break;
 745
 746 #ifdef RTS_GTK_FRONTPANEL
 747               case 'f':
 748                   RtsFlags.GcFlags.frontpanel = rtsTrue;
 749                   break;
 750 #endif
 751
 752               case 'S':
 753                   RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
 754                   goto stats;
 755
 756               case 's':
 757                   RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
 758                   goto stats;
 759
 760               case 't':
 761                   RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
 762                   goto stats;
 763
 764             stats:
 765 #ifdef PAR
 766                 /* Opening all those files would almost certainly fail... */
 767                 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
 768                 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
 769 #else
 770                   RtsFlags.GcFlags.statsFile
 771                       = open_stats_file(arg, *argc, argv,
 772                                         *rts_argc, rts_argv, STAT_FILENAME_FMT);
 773
 774                   if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
 775 #endif
 776                   break;
 777
 778               case 'Z':
 779                 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
 780                 break;
 781
 782               /* =========== PROFILING ========================== */
 783
 784               case 'P': /* detailed cost centre profiling (time/alloc) */
 785               case 'p': /* cost centre profiling (time/alloc) */
 786                 COST_CENTRE_USING_BUILD_ONLY(
 787                 switch (rts_argv[arg][2]) {
 788                   case 'x':
 789                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
 790                     break;
 791                   case 'a':
 792                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
 793                     break;
 794                   default:
 795                       if (rts_argv[arg][1] == 'P') {
 796                           RtsFlags.CcFlags.doCostCentres =
 797                               COST_CENTRES_VERBOSE;
 798                       } else {
 799                           RtsFlags.CcFlags.doCostCentres =
 800                               COST_CENTRES_SUMMARY;
 801                       }
 802                       break;
 803                 }
 804                 ) break;
 805
 806               case 'h': /* serial heap profile */
 807 #if !defined(PROFILING) && defined(DEBUG)
 808                 switch (rts_argv[arg][2]) {
 809                   case '\0':
 810                   case 'L':
 811                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
 812                     break;
 813                   case 'T':
 814                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
 815                     break;
 816                   default:
 817                     prog_belch("invalid heap profile option: %s",rts_argv[arg]);
 818                     error = rtsTrue;
 819                 }
 820 #else
 821                 PROFILING_BUILD_ONLY(
 822                 switch (rts_argv[arg][2]) {
 823                   case '\0':
 824                   case CCchar:
 825                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
 826                     break;
 827                   case MODchar:
 828                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
 829                     break;
 830                   case DESCRchar:
 831                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
 832                     break;
 833                   case TYPEchar:
 834                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
 835                     break;
 836                   case 'c': /* cost centre label select */
 837                   case 'm': /* cost centre module select */
 838                   case 'd': /* closure descr select */
 839                   case 'y': /* closure type select */
 840                     {char *left  = strchr(rts_argv[arg], '{');
 841                      char *right = strrchr(rts_argv[arg], '}');
 842                      if (! left || ! right ||
 843                           strrchr(rts_argv[arg], '{') != left ||
 844                            strchr(rts_argv[arg], '}') != right) {
 845                         prog_belch(
 846                            "Invalid heap profiling selection bracketing\n   %s\n",
 847                            rts_argv[arg]);
 848                         error = rtsTrue;
 849                      } else {
 850                         *right = '\0';
 851                         switch (rts_argv[arg][2]) {
 852                           case 'c': /* cost centre label select */
 853                             RtsFlags.ProfFlags.ccSelector = left + 1;
 854                             break;
 855                           case 'm': /* cost centre module select */
 856                             RtsFlags.ProfFlags.modSelector = left + 1;
 857                             break;
 858                           case 'd': /* closure descr select */
 859                             RtsFlags.ProfFlags.descrSelector = left + 1;
 860                             break;
 861                           case 'y': /* closure type select */
 862                             RtsFlags.ProfFlags.typeSelector = left + 1;
 863                             break;
 864                         }
 865                      }
 866                     }
 867                     break;
 868                   default:
 869                     prog_belch("invalid heap profile option: %s",rts_argv[arg]);
 870                     error = rtsTrue;
 871                 }
 872                 )
 873
 874 #endif
 875                 break;
 876
 877 #if defined(PROFILING)
 878               case 'i': /* heap sample interval */
 879                 if (rts_argv[arg][2] == '\0') {
 880                   /* use default */
 881                 } else {
 882                     I_ cst; /* tmp */
 883
 884                     /* Convert to milliseconds */
 885                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 886                     cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
 887                     if (cst != 0 && cst < CS_MIN_MILLISECS)
 888                         cst = CS_MIN_MILLISECS;
 889
 890                     RtsFlags.ProfFlags.profileFrequency = cst;
 891                 }
 892
 893                 break;
 894
 895 #endif
 896
 897               /* =========== CONCURRENT ========================= */
 898               case 'C': /* context switch interval */
 899                 if (rts_argv[arg][2] == '\0')
 900                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
 901                 else {
 902                     I_ cst; /* tmp */
 903
 904                     /* Convert to milliseconds */
 905                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 906                     cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
 907                     if (cst != 0 && cst < CS_MIN_MILLISECS)
 908                         cst = CS_MIN_MILLISECS;
 909
 910                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
 911                 }
 912                 break;
 913
 914 #ifdef SMP
 915               case 'N':
 916                 SMP_BUILD_ONLY(
 917                 if (rts_argv[arg][2] != '\0') {
 918                     RtsFlags.ParFlags.nNodes
 919                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
 920                     if (RtsFlags.ParFlags.nNodes <= 0) {
 921                       prog_belch("bad value for -N");
 922                       error = rtsTrue;
 923                     }
 924                 }
 925                 ) break;
 926 #endif
 927               /* =========== PARALLEL =========================== */
 928               case 'e':
 929                 PAR_OR_SMP_BUILD_ONLY(
 930                 if (rts_argv[arg][2] != '\0') {
 931                     RtsFlags.ParFlags.maxLocalSparks
 932                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
 933                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
 934                       prog_belch("bad value for -e");
 935                       error = rtsTrue;
 936                     }
 937                 }
 938                 ) break;
 939
 940               case 'q':
 941                 PAR_BUILD_ONLY(
 942                   process_par_option(arg, rts_argc, rts_argv, &error);
 943                 ) break;
 944
 945               /* =========== GRAN =============================== */
 946
 947               case 'b':
 948                 GRAN_BUILD_ONLY(
 949                   process_gran_option(arg, rts_argc, rts_argv, &error);
 950                 ) break;
 951
 952               /* =========== TICKY ============================== */
 953
 954               case 'r': /* Basic profiling stats */
 955                 TICKY_BUILD_ONLY(
 956
 957                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
 958                 RtsFlags.TickyFlags.tickyFile
 959                   = open_stats_file(arg, *argc, argv,
 960                         *rts_argc, rts_argv, TICKY_FILENAME_FMT);
 961
 962                 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
 963                 ) break;
 964
 965               /* =========== EXTENDED OPTIONS =================== */
 966
 967               case 'x': /* Extend the argument space */
 968                 switch(rts_argv[arg][2]) {
 969                   case '\0':
 970                     prog_belch("incomplete RTS option: %s",rts_argv[arg]);
 971                     error = rtsTrue;
 972                     break;
 973
 974                   case 'c': /* Debugging tool: show current cost centre on an exception */
 975                     PROFILING_BUILD_ONLY(
 976                     RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
 977                     ) break;
 978
 979                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
 980
 981                   default:
 982                     prog_belch("unknown RTS option: %s",rts_argv[arg]);
 983                     error = rtsTrue;
 984                     break;
 985                 }
 986                 break;  /* defensive programming */
 987
 988               /* =========== OH DEAR ============================ */
 989               default:
 990                 prog_belch("unknown RTS option: %s",rts_argv[arg]);
 991                 error = rtsTrue;
 992                 break;
 993             }
 994         }
 995     }
 996     if (error) {
 997         const char **p;
 998
 999         fflush(stdout);
1000         for (p = usage_text; *p; p++)
1001             belch("%s", *p);
1002         stg_exit(EXIT_FAILURE);
1003     }
1004 }
1005
1006 #if defined(GRAN)
1007
1008 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
1009 //@subsection GranSim specific options
1010
1011 static void
1012 enable_GranSimLight(void) {
1013
1014     fprintf(stderr,"GrAnSim Light enabled (infinite number of processors;  0 communication costs)\n");
1015     RtsFlags.GranFlags.Light=rtsTrue;
1016     RtsFlags.GranFlags.Costs.latency =
1017         RtsFlags.GranFlags.Costs.fetchtime =
1018         RtsFlags.GranFlags.Costs.additional_latency =
1019         RtsFlags.GranFlags.Costs.gunblocktime =
1020         RtsFlags.GranFlags.Costs.lunblocktime =
1021         RtsFlags.GranFlags.Costs.threadcreatetime =
1022         RtsFlags.GranFlags.Costs.threadqueuetime =
1023         RtsFlags.GranFlags.Costs.threadscheduletime =
1024         RtsFlags.GranFlags.Costs.threaddescheduletime =
1025         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1026
1027     RtsFlags.GranFlags.Costs.mpacktime =
1028         RtsFlags.GranFlags.Costs.munpacktime = 0;
1029
1030     RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1031     RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1032     RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1033     /* FetchStrategy is irrelevant in GrAnSim-Light */
1034
1035     /* GrAnSim Light often creates an abundance of parallel threads,
1036        each with its own stack etc. Therefore, it's in general a good
1037        idea to use small stack chunks (use the -o<size> option to
1038        increase it again).
1039     */
1040     // RtsFlags.ConcFlags.stkChunkSize = 100;
1041
1042     RtsFlags.GranFlags.proc = 1;
1043 }
1044
1045 static void
1046 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1047 {
1048     if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1049       return;
1050
1051     /* or a ridiculously idealised simulator */
1052     if(strcmp((rts_argv[arg]+2),"oring")==0) {
1053       RtsFlags.GranFlags.Costs.latency =
1054         RtsFlags.GranFlags.Costs.fetchtime =
1055         RtsFlags.GranFlags.Costs.additional_latency =
1056         RtsFlags.GranFlags.Costs.gunblocktime =
1057         RtsFlags.GranFlags.Costs.lunblocktime =
1058         RtsFlags.GranFlags.Costs.threadcreatetime =
1059         RtsFlags.GranFlags.Costs.threadqueuetime =
1060         RtsFlags.GranFlags.Costs.threadscheduletime =
1061         RtsFlags.GranFlags.Costs.threaddescheduletime =
1062         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1063
1064       RtsFlags.GranFlags.Costs.mpacktime =
1065         RtsFlags.GranFlags.Costs.munpacktime = 0;
1066
1067       RtsFlags.GranFlags.Costs.arith_cost =
1068         RtsFlags.GranFlags.Costs.float_cost =
1069         RtsFlags.GranFlags.Costs.load_cost =
1070         RtsFlags.GranFlags.Costs.store_cost =
1071         RtsFlags.GranFlags.Costs.branch_cost = 0;
1072
1073       RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1074
1075       /* ++RtsFlags.GranFlags.DoFairSchedule; */
1076       RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue;        /* -bZ */
1077       RtsFlags.GranFlags.DoThreadMigration   = rtsTrue;        /* -bM */
1078       RtsFlags.GranFlags.GranSimStats.Full   = rtsTrue;        /* -bP */
1079       return;
1080     }
1081
1082       /* or a somewhat idealised simulator */
1083       if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1084         RtsFlags.GranFlags.Costs.latency =
1085         RtsFlags.GranFlags.Costs.fetchtime =
1086         RtsFlags.GranFlags.Costs.additional_latency =
1087         RtsFlags.GranFlags.Costs.gunblocktime =
1088         RtsFlags.GranFlags.Costs.lunblocktime =
1089         RtsFlags.GranFlags.Costs.threadcreatetime =
1090         RtsFlags.GranFlags.Costs.threadqueuetime =
1091         RtsFlags.GranFlags.Costs.threadscheduletime =
1092         RtsFlags.GranFlags.Costs.threaddescheduletime =
1093         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1094
1095         RtsFlags.GranFlags.Costs.mpacktime =
1096         RtsFlags.GranFlags.Costs.munpacktime = 0;
1097
1098         RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1099
1100         /* RtsFlags.GranFlags.DoFairSchedule  = rtsTrue; */       /* -b-R */
1101         /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */   /* -b-T */
1102         RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;         /* -bZ */
1103         RtsFlags.GranFlags.DoThreadMigration  = rtsTrue;          /* -bM */
1104         RtsFlags.GranFlags.GranSimStats.Full  = rtsTrue;          /* -bP */
1105 #  if defined(GRAN_CHECK) && defined(GRAN)
1106         RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics   */
1107 #  endif
1108         return;
1109       }
1110
1111       /* Communication and task creation cost parameters */
1112       switch(rts_argv[arg][2]) {
1113         case '.':
1114           IgnoreYields = rtsTrue; // HWL HACK
1115           break;
1116
1117         case ':':
1118           enable_GranSimLight();       /* set flags for GrAnSim-Light mode */
1119           break;
1120
1121         case 'l':
1122           if (rts_argv[arg][3] != '\0')
1123             {
1124               RtsFlags.GranFlags.Costs.gunblocktime =
1125               RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1126               RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1127             }
1128           else
1129             RtsFlags.GranFlags.Costs.latency = LATENCY;
1130           break;
1131
1132         case 'a':
1133           if (rts_argv[arg][3] != '\0')
1134             RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1135           else
1136             RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1137           break;
1138
1139         case 'm':
1140           if (rts_argv[arg][3] != '\0')
1141             RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1142           else
1143             RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1144           break;
1145
1146         case 'x':
1147           if (rts_argv[arg][3] != '\0')
1148             RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1149           else
1150             RtsFlags.GranFlags.Costs.mtidytime = 0;
1151           break;
1152
1153         case 'r':
1154           if (rts_argv[arg][3] != '\0')
1155             RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1156           else
1157             RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1158           break;
1159
1160         case 'g':
1161           if (rts_argv[arg][3] != '\0')
1162             RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1163           else
1164             RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1165           break;
1166
1167         case 'n':
1168           if (rts_argv[arg][3] != '\0')
1169             RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1170           else
1171             RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1172           break;
1173
1174         case 'u':
1175           if (rts_argv[arg][3] != '\0')
1176             RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1177           else
1178             RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1179           break;
1180
1181         /* Thread-related metrics */
1182         case 't':
1183           if (rts_argv[arg][3] != '\0')
1184             RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1185           else
1186             RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1187           break;
1188
1189         case 'q':
1190           if (rts_argv[arg][3] != '\0')
1191             RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1192           else
1193             RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1194           break;
1195
1196         case 'c':
1197           if (rts_argv[arg][3] != '\0')
1198             RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1199           else
1200             RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1201
1202           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1203             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1204           break;
1205
1206         case 'd':
1207           if (rts_argv[arg][3] != '\0')
1208             RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1209           else
1210             RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1211
1212           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1213             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1214           break;
1215
1216         /* Instruction Cost Metrics */
1217         case 'A':
1218           if (rts_argv[arg][3] != '\0')
1219             RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1220           else
1221             RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1222           break;
1223
1224         case 'F':
1225           if (rts_argv[arg][3] != '\0')
1226             RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1227           else
1228             RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1229           break;
1230
1231         case 'B':
1232           if (rts_argv[arg][3] != '\0')
1233             RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1234           else
1235             RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1236           break;
1237
1238         case 'L':
1239           if (rts_argv[arg][3] != '\0')
1240             RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1241           else
1242             RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1243           break;
1244
1245         case 'S':
1246           if (rts_argv[arg][3] != '\0')
1247             RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1248           else
1249             RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1250           break;
1251
1252         case 'H':
1253           if (rts_argv[arg][3] != '\0')
1254             RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1255           else
1256             RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1257           break;
1258
1259         case 'y':
1260           RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1261           if (rts_argv[arg][3] != '\0')
1262             RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1263           else
1264             RtsFlags.GranFlags.FetchStrategy = 2;
1265           if (RtsFlags.GranFlags.FetchStrategy == 0)
1266             RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1267           break;
1268
1269         case 'K':   /* sort overhead (per elem in spark list) */
1270           if (rts_argv[arg][3] != '\0')
1271             RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1272           else
1273             RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1274           fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1275                          RtsFlags.GranFlags.Costs.pri_spark_overhead);
1276           break;
1277
1278         case 'O':  /* sort overhead (per elem in spark list) */
1279           if (rts_argv[arg][3] != '\0')
1280             RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1281           else
1282             RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1283           fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1284                        RtsFlags.GranFlags.Costs.pri_sched_overhead);
1285           break;
1286
1287         /* General Parameters */
1288         case 'p':
1289           if (rts_argv[arg][3] != '\0')
1290             {
1291               RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1292               if (RtsFlags.GranFlags.proc==0) {
1293                   enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1294               } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1295                          RtsFlags.GranFlags.proc < 1)
1296                 {
1297                   fprintf(stderr,"setupRtsFlags: no more than %u processors
1298 allowed\n",
1299                           MAX_PROC);
1300                   *error = rtsTrue;
1301                 }
1302             }
1303           else
1304             RtsFlags.GranFlags.proc = MAX_PROC;
1305           break;
1306
1307         case 'f':
1308           RtsFlags.GranFlags.Fishing = rtsTrue;
1309           if (rts_argv[arg][3] != '\0')
1310             RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1311           else
1312             RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1313           break;
1314
1315         case 'w':
1316           if (rts_argv[arg][3] != '\0')
1317             RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1318           else
1319             RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1320           break;
1321
1322         case 'C':
1323           RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1324           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1325           break;
1326
1327         case 'G':
1328           fprintf(stderr,"Bulk fetching enabled.\n");
1329           RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1330           break;
1331
1332         case 'M':
1333           fprintf(stderr,"Thread migration enabled.\n");
1334           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1335           break;
1336
1337         case 'R':
1338           fprintf(stderr,"Fair Scheduling enabled.\n");
1339           RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1340           break;
1341
1342         case 'I':
1343           fprintf(stderr,"Priority Scheduling enabled.\n");
1344           RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1345           break;
1346
1347         case 'T':
1348           RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1349           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1350           break;
1351
1352         case 'Z':
1353           RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1354           break;
1355
1356 /*          case 'z': */
1357 /*        RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1358 /*        break; */
1359
1360         case 'N':
1361           RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1362           break;
1363
1364         case 'b':
1365           RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1366           break;
1367
1368         case 'P':
1369           /* format is -bP<c> where <c> is one char describing kind of profile */
1370           RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1371           switch(rts_argv[arg][3]) {
1372           case '\0': break; // nothing special, just an ordinary profile
1373           case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1374             break;
1375           case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1376             break;
1377           case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1378             break;
1379           case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1380             break;
1381           case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1382             break;
1383           case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1384             break;
1385           default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1386           }
1387           break;
1388
1389         case 's':
1390           RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1391           break;
1392
1393         case 'h':
1394           RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1395           break;
1396
1397         case 'Y':   /* syntax: -bY<n>[,<n>]  n ... pos int */
1398           if (rts_argv[arg][3] != '\0') {
1399             char *arg0, *tmp;
1400
1401             arg0 = rts_argv[arg]+3;
1402             if ((tmp = strstr(arg0,","))==NULL) {
1403               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1404               fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1405             } else {
1406               *(tmp++) = '\0';
1407               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1408               RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1409               fprintf(stderr,"SparkPriority: %u.\n",
1410                       RtsFlags.GranFlags.SparkPriority);
1411               fprintf(stderr,"SparkPriority2:%u.\n",
1412                       RtsFlags.GranFlags.SparkPriority2);
1413               if (RtsFlags.GranFlags.SparkPriority2 <
1414                   RtsFlags.GranFlags.SparkPriority) {
1415                 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1416                         RtsFlags.GranFlags.SparkPriority2,
1417                         RtsFlags.GranFlags.SparkPriority);
1418               }
1419             }
1420           } else {
1421             /* plain pri spark is now invoked with -bX
1422                RtsFlags.GranFlags.DoPrioritySparking = 1;
1423                fprintf(stderr,"PrioritySparking.\n");
1424             */
1425           }
1426           break;
1427
1428         case 'Q':
1429           if (rts_argv[arg][3] != '\0') {
1430             RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1431           } else {
1432             RtsFlags.GranFlags.ThunksToPack = 1;
1433           }
1434           fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1435                   RtsFlags.GranFlags.ThunksToPack);
1436           break;
1437
1438         case 'e':
1439           RtsFlags.GranFlags.RandomSteal = rtsFalse;
1440           fprintf(stderr,"Deterministic mode (no random stealing)\n");
1441                       break;
1442
1443           /* The following class of options contains eXperimental */
1444           /* features in connection with exploiting granularity */
1445           /* information. I.e. if -bY is chosen these options */
1446           /* tell the RTS what to do with the supplied info --HWL */
1447
1448         case 'W':
1449           if (rts_argv[arg][3] != '\0') {
1450             RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1451           } else {
1452             RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1453           }
1454           fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1455                   RtsFlags.GranFlags.packBufferSize_internal);
1456           break;
1457
1458         case 'X':
1459           switch(rts_argv[arg][3]) {
1460
1461             case '\0':
1462               RtsFlags.GranFlags.DoPrioritySparking = 1;
1463               fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1464               RtsFlags.GranFlags.InversePriorities = rtsFalse;
1465               RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1466               RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1467               break;
1468
1469             case 'I':
1470               RtsFlags.GranFlags.DoPrioritySparking = 1;
1471               fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1472               RtsFlags.GranFlags.InversePriorities++;
1473               break;
1474
1475             case 'R':
1476               RtsFlags.GranFlags.DoPrioritySparking = 1;
1477               fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1478               RtsFlags.GranFlags.RandomPriorities++;
1479               break;
1480
1481             case 'N':
1482               RtsFlags.GranFlags.DoPrioritySparking = 1;
1483               fprintf(stderr,"Priority Sparking with No Priorities.\n");
1484               RtsFlags.GranFlags.IgnorePriorities++;
1485               break;
1486
1487             default:
1488               bad_option( rts_argv[arg] );
1489               break;
1490           }
1491           break;
1492
1493         case '-':
1494           switch(rts_argv[arg][3]) {
1495
1496             case 'C':
1497               RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1498               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1499               break;
1500
1501             case 'G':
1502               RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1503               break;
1504
1505             case 'M':
1506               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1507               break;
1508
1509             case 'R':
1510               RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1511               break;
1512
1513             case 'T':
1514               RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1515               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1516               break;
1517
1518             case 'Z':
1519               RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1520               break;
1521
1522             case 'N':
1523               RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1524                          break;
1525
1526             case 'P':
1527               RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1528               break;
1529
1530             case 's':
1531               RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1532               break;
1533
1534             case 'h':
1535               RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1536               break;
1537
1538             case 'b':
1539               RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1540               break;
1541
1542             case 'X':
1543               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1544               break;
1545
1546             case 'Y':
1547               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1548               RtsFlags.GranFlags.SparkPriority = rtsFalse;
1549               break;
1550
1551             case 'I':
1552               RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1553               break;
1554
1555             case 'e':
1556               RtsFlags.GranFlags.RandomSteal = rtsFalse;
1557               break;
1558
1559             default:
1560               bad_option( rts_argv[arg] );
1561               break;
1562           }
1563           break;
1564
1565 #  if defined(GRAN_CHECK) && defined(GRAN)
1566         case 'D':
1567           switch(rts_argv[arg][3]) {
1568             case 'Q':    /* Set pack buffer size (same as 'Q' in GUM) */
1569               if (rts_argv[arg][4] != '\0') {
1570                 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1571                 fprintf(stderr,"Pack buffer size: %d\n",
1572                         RtsFlags.GranFlags.packBufferSize);
1573               } else {
1574                 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1575                 *error = rtsTrue;
1576               }
1577               break;
1578
1579           default:
1580               if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1581                 /* hack warning: interpret the flags as a binary number */
1582                 nat n = decode(rts_argv[arg]+3);
1583                 set_GranSim_debug_options(n);
1584               } else {
1585                 nat i;
1586                 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1587                   if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1588                     break;
1589
1590                 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1591                   fprintf(stderr, "Valid GranSim debug options are:\n");
1592                   help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1593                   bad_option( rts_argv[arg] );
1594                 } else { // flag found; now set it
1595                   set_GranSim_debug_options(GRAN_DEBUG_MASK(i));  // 2^i
1596                 }
1597               }
1598               break;
1599
1600 #if 0
1601             case 'e':       /* event trace; also -bD1 */
1602               fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1603               RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1604               /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1605               break;
1606
1607             case 'E':       /* event statistics; also -bD2 */
1608               fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1609               RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1610               /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics   */
1611               break;
1612
1613             case 'f':       /* thunkStealing; also -bD4 */
1614               fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1615               RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1616               /* RtsFlags.GranFlags.Debug |= 0x2;  print fwd messages */
1617               break;
1618
1619             case 'z':       /* blockOnFetch; also -bD8 */
1620               fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1621               RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1622               /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1623               break;
1624
1625             case 't':       /* blockOnFetch_sanity; also -bD16 */
1626               fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1627               RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1628               /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch  */
1629               break;
1630
1631             case 'S':       /* priSpark; also -bD32 */
1632               fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1633               RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1634               break;
1635
1636             case 's':       /* priSched; also -bD64 */
1637               fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1638               RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1639               break;
1640
1641             case 'F':       /* findWork; also -bD128 */
1642               fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1643               RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1644               break;
1645
1646             case 'g':       /* globalBlock; also -bD256 */
1647               fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1648               RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1649               break;
1650
1651             case 'G':       /* pack; also -bD512 */
1652               fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1653               RtsFlags.GranFlags.Debug.pack = rtsTrue;
1654               break;
1655
1656             case 'P':       /* packBuffer; also -bD1024 */
1657               fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1658               RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1659               break;
1660
1661             case 'o':       /* sortedQ; also -bD2048 */
1662               fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1663               RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1664               break;
1665
1666             case 'r':       /* randomSteal; also -bD4096 */
1667               fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1668               RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1669               break;
1670
1671             case 'q':       /* checkSparkQ; also -bD8192 */
1672               fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1673               RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1674               break;
1675
1676             case ':':       /* checkLight; also -bD16384 */
1677               fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1678               RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1679               break;
1680
1681             case 'b':       /* bq; also -bD32768 */
1682               fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1683               RtsFlags.GranFlags.Debug.bq = rtsTrue;
1684               break;
1685
1686             case 'd':       /* all options turned on */
1687               fprintf(stderr,"DEBUG: all options turned on.\n");
1688               set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1689               /* RtsFlags.GranFlags.Debug |= 0x40; */
1690               break;
1691
1692 /*          case '\0': */
1693 /*            RtsFlags.GranFlags.Debug = 1; */
1694 /*            break; */
1695 #endif
1696
1697           }
1698           break;
1699 #  endif  /* GRAN_CHECK */
1700       default:
1701         bad_option( rts_argv[arg] );
1702         break;
1703       }
1704 }
1705
1706 /*
1707   Interpret n as a binary number masking GranSim debug options and set the
1708   correxponding option. See gran_debug_opts_strs for explanations of the flags.
1709 */
1710 static void
1711 set_GranSim_debug_options(nat n) {
1712   nat i;
1713
1714   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1715     if ((n>>i)&1) {
1716       fprintf(stderr, gran_debug_opts_strs[i]);
1717       switch (i) {
1718         case 0: RtsFlags.GranFlags.Debug.event_trace   = rtsTrue;  break;
1719         case 1: RtsFlags.GranFlags.Debug.event_stats   = rtsTrue;  break;
1720         case 2: RtsFlags.GranFlags.Debug.bq            = rtsTrue;  break;
1721         case 3: RtsFlags.GranFlags.Debug.pack          = rtsTrue;  break;
1722         case 4: RtsFlags.GranFlags.Debug.checkSparkQ   = rtsTrue;  break;
1723         case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;  break;
1724         case 6: RtsFlags.GranFlags.Debug.randomSteal   = rtsTrue;  break;
1725         case 7: RtsFlags.GranFlags.Debug.findWork      = rtsTrue;  break;
1726         case 8: RtsFlags.GranFlags.Debug.unused        = rtsTrue;  break;
1727         case 9: RtsFlags.GranFlags.Debug.pri           = rtsTrue;  break;
1728         case 10: RtsFlags.GranFlags.Debug.checkLight   = rtsTrue;  break;
1729         case 11: RtsFlags.GranFlags.Debug.sortedQ      = rtsTrue;  break;
1730         case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;  break;
1731         case 13: RtsFlags.GranFlags.Debug.packBuffer   = rtsTrue;  break;
1732         case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;  break;
1733         default: barf("set_GranSim_debug_options: only %d debug options expected");
1734       } /* switch */
1735     } /* if */
1736 }
1737
1738 /*
1739   Print one line explanation for each of the GranSim debug options specified
1740   in the bitmask n.
1741 */
1742 static void
1743 help_GranSim_debug_options(nat n) {
1744   nat i;
1745
1746   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1747     if ((n>>i)&1)
1748       fprintf(stderr, gran_debug_opts_strs[i]);
1749 }
1750
1751 # elif defined(PAR)
1752
1753 static void
1754 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1755 {
1756
1757   if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
1758     belch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
1759     return;
1760   }
1761
1762   /* Communication and task creation cost parameters */
1763   switch(rts_argv[arg][2]) {
1764   case 'e':  /* -qe<n>  ... allow <n> local sparks */
1765     if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1766       RtsFlags.ParFlags.maxLocalSparks
1767         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1768
1769       if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1770         belch("setupRtsFlags: bad value for -e\n");
1771         *error = rtsTrue;
1772       }
1773     }
1774     IF_PAR_DEBUG(verbose,
1775                  belch("-qe<n>: max %d local sparks",
1776                        RtsFlags.ParFlags.maxLocalSparks));
1777     break;
1778
1779   case 't':
1780     if (rts_argv[arg][3] != '\0') {
1781       RtsFlags.ParFlags.maxThreads
1782         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1783     } else {
1784       belch("setupRtsFlags: missing size for -qt\n");
1785       *error = rtsTrue;
1786     }
1787     IF_PAR_DEBUG(verbose,
1788                  belch("-qt<n>: max %d threads",
1789                        RtsFlags.ParFlags.maxThreads));
1790     break;
1791
1792   case 'f':
1793     if (rts_argv[arg][3] != '\0')
1794       RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1795     else
1796       RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1797     break;
1798     IF_PAR_DEBUG(verbose,
1799                  belch("-qf<n>: max %d fishes sent out at one time",
1800                        RtsFlags.ParFlags.maxFishes));
1801     break;
1802
1803   case 'F':
1804     if (rts_argv[arg][3] != '\0') {
1805       RtsFlags.ParFlags.fishDelay
1806         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1807     } else {
1808       belch("setupRtsFlags: missing fish delay time for -qF\n");
1809       *error = rtsTrue;
1810     }
1811     IF_PAR_DEBUG(verbose,
1812                  belch("-qF<n>: fish delay time %d us",
1813                        RtsFlags.ParFlags.fishDelay));
1814     break;
1815
1816   case 'O':
1817     RtsFlags.ParFlags.outputDisabled = rtsTrue;
1818     IF_PAR_DEBUG(verbose,
1819                  belch("-qO: output disabled"));
1820     break;
1821
1822   case 'g': /* -qg<n> ... globalisation scheme */
1823     if (rts_argv[arg][3] != '\0') {
1824       RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
1825     } else {
1826       belch("setupRtsFlags: missing identifier for globalisation scheme (for -qg)\n");
1827       *error = rtsTrue;
1828     }
1829     IF_PAR_DEBUG(verbose,
1830                  belch("-qg<n>: globalisation scheme set to  %d",
1831                        RtsFlags.ParFlags.globalising));
1832     break;
1833
1834   case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
1835     if (rts_argv[arg][3] != '\0') {
1836       RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
1837     } else {
1838       belch("setupRtsFlags: missing number of thunks per packet (for -qh)\n");
1839       *error = rtsTrue;
1840     }
1841     IF_PAR_DEBUG(verbose,
1842                  belch("-qh<n>: thunks per packet set to %d",
1843                        RtsFlags.ParFlags.thunksToPack));
1844     break;
1845
1846   case 'P': /* -qP for writing a log file */
1847     //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1848     /* same encoding as in GranSim after -bP */
1849     switch(rts_argv[arg][3]) {
1850     case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1851       break; // nothing special, just an ordinary profile
1852     case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1853         RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1854       break;
1855     case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1856       break;
1857     case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1858       break;
1859       //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1860       //  break;
1861     case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1862       break;
1863     case 'g':
1864 # if defined(PAR_TICKY)
1865       RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1866 # else
1867       fprintf(stderr,"-qPg is only possible for a PAR_TICKY RTS, which this is not");
1868       stg_exit(EXIT_FAILURE);
1869 # endif
1870       break;
1871     default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1872     }
1873     IF_PAR_DEBUG(verbose,
1874                  belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1875                        (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1876     break;
1877
1878   case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1879     if (rts_argv[arg][3] != '\0') {
1880       RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1881     } else {
1882       belch("setupRtsFlags: missing size of PackBuffer (for -qQ)\n");
1883       *error = rtsTrue;
1884     }
1885     IF_PAR_DEBUG(verbose,
1886                  belch("-qQ<n>: pack buffer size set to %d",
1887                        RtsFlags.ParFlags.packBufferSize));
1888     break;
1889
1890   case 'R':
1891     RtsFlags.ParFlags.doFairScheduling = rtsTrue;
1892     IF_PAR_DEBUG(verbose,
1893                  belch("-qR: fair-ish scheduling"));
1894     break;
1895
1896 # if defined(DEBUG)
1897   case 'w':
1898     if (rts_argv[arg][3] != '\0') {
1899       RtsFlags.ParFlags.wait
1900         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1901     } else {
1902       RtsFlags.ParFlags.wait = 1000;
1903     }
1904     IF_PAR_DEBUG(verbose,
1905                  belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1906                        RtsFlags.ParFlags.wait));
1907     break;
1908
1909   case 'D':  /* -qD ... all the debugging options */
1910     if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1911       /* hack warning: interpret the flags as a binary number */
1912       nat n = decode(rts_argv[arg]+3);
1913       set_par_debug_options(n);
1914     } else {
1915       nat i;
1916       for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1917         if (rts_argv[arg][3] == par_debug_opts_flags[i])
1918           break;
1919
1920       if (i==MAX_PAR_DEBUG_OPTION+1) {
1921         fprintf(stderr, "Valid GUM debug options are:\n");
1922         help_par_debug_options(MAX_PAR_DEBUG_MASK);
1923         bad_option( rts_argv[arg] );
1924       } else { // flag found; now set it
1925         set_par_debug_options(PAR_DEBUG_MASK(i));  // 2^i
1926       }
1927     }
1928     break;
1929 # endif
1930   default:
1931     belch("Unknown option -q%c (%d opts in total)",
1932           rts_argv[arg][2], *rts_argc);
1933     break;
1934   } /* switch */
1935 }
1936
1937 /*
1938   Interpret n as a binary number masking Par debug options and set the
1939   correxponding option. See par_debug_opts_strs for explanations of the flags.
1940 */
1941 static void
1942 set_par_debug_options(nat n) {
1943   nat i;
1944
1945   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1946     if ((n>>i)&1) {
1947       fprintf(stderr, par_debug_opts_strs[i]);
1948       switch (i) {
1949         case 0: RtsFlags.ParFlags.Debug.verbose       = rtsTrue;  break;
1950         case 1: RtsFlags.ParFlags.Debug.bq            = rtsTrue;  break;
1951         case 2: RtsFlags.ParFlags.Debug.schedule      = rtsTrue;  break;
1952         case 3: RtsFlags.ParFlags.Debug.free          = rtsTrue;  break;
1953         case 4: RtsFlags.ParFlags.Debug.resume        = rtsTrue;  break;
1954         case 5: RtsFlags.ParFlags.Debug.weight        = rtsTrue;  break;
1955         case 6: RtsFlags.ParFlags.Debug.fetch         = rtsTrue;  break;
1956           //case 7: RtsFlags.ParFlags.Debug.ack           = rtsTrue;  break;
1957         case 7: RtsFlags.ParFlags.Debug.fish          = rtsTrue;  break;
1958         case 8: RtsFlags.ParFlags.Debug.tables        = rtsTrue;  break;
1959         case 9: RtsFlags.ParFlags.Debug.packet        = rtsTrue;  break;
1960         case 10: RtsFlags.ParFlags.Debug.pack         = rtsTrue;  break;
1961         case 11: RtsFlags.ParFlags.Debug.paranoia     = rtsTrue;  break;
1962         default: barf("set_par_debug_options: only %d debug options expected",
1963                       MAX_PAR_DEBUG_OPTION);
1964       } /* switch */
1965     } /* if */
1966 }
1967
1968 /*
1969   Print one line explanation for each of the GranSim debug options specified
1970   in the bitmask n.
1971 */
1972 static void
1973 help_par_debug_options(nat n) {
1974   nat i;
1975
1976   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1977     if ((n>>i)&1)
1978       fprintf(stderr, par_debug_opts_strs[i]);
1979 }
1980
1981 #endif /* PAR */
1982
1983 #ifdef DEBUG
1984 static void
1985 set_debug_options(nat n) {
1986   nat i;
1987
1988   for (i=0; i<=MAX_DEBUG_OPTION; i++)
1989     if ((n>>i)&1) {
1990       fprintf(stderr, debug_opts_strs[i]);
1991       switch (i) {
1992         case 0: RtsFlags.DebugFlags.scheduler   = rtsTrue; break;
1993         case 1: RtsFlags.DebugFlags.evaluator   = rtsTrue; break;
1994         case 2: RtsFlags.DebugFlags.codegen     = rtsTrue; break;
1995         case 3: RtsFlags.DebugFlags.weak        = rtsTrue; break;
1996         case 4: RtsFlags.DebugFlags.gccafs      = rtsTrue; break;
1997         case 5: RtsFlags.DebugFlags.gc          = rtsTrue; break;
1998         case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1999         case 7: RtsFlags.DebugFlags.sanity      = rtsTrue; break;
2000         case 8: RtsFlags.DebugFlags.stable      = rtsTrue; break;
2001         case 9: RtsFlags.DebugFlags.prof        = rtsTrue; break;
2002         case 10:  RtsFlags.DebugFlags.gran       = rtsTrue; break;
2003         case 11:  RtsFlags.DebugFlags.par        = rtsTrue; break;
2004         default: barf("set_debug_options: only %d debug options expected",
2005                       MAX_DEBUG_OPTION);
2006       } /* switch */
2007     } /* if */
2008 }
2009
2010 static void
2011 help_debug_options(nat n) {
2012   nat i;
2013
2014   for (i=0; i<=MAX_DEBUG_OPTION; i++)
2015     if ((n>>i)&1)
2016       fprintf(stderr, debug_opts_strs[i]);
2017 }
2018 #endif /* DEBUG */
2019
2020 //@node Aux fcts,  , GranSim specific options
2021 //@subsection Aux fcts
2022
2023 static FILE *           /* return NULL on error */
2024 open_stats_file (
2025     I_ arg,
2026     int argc, char *argv[],
2027     int rts_argc, char *rts_argv[],
2028     const char *FILENAME_FMT)
2029 {
2030     FILE *f = NULL;
2031
2032     if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
2033         f = stderr;
2034     else if (rts_argv[arg][2] != '\0')      /* stats file specified */
2035         f = fopen(rts_argv[arg]+2,"w");
2036     else {
2037         char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2038         sprintf(stats_filename, FILENAME_FMT, argv[0]);
2039         f = fopen(stats_filename,"w");
2040     }
2041     if (f == NULL) {
2042         fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
2043     } else {
2044         /* Write argv and rtsv into start of stats file */
2045         I_ count;
2046         for(count = 0; count < argc; count++)
2047             fprintf(f, "%s ", argv[count]);
2048         fprintf(f, "+RTS ");
2049         for(count = 0; count < rts_argc; count++)
2050             fprintf(f, "%s ", rts_argv[count]);
2051         fprintf(f, "\n");
2052     }
2053
2054     return(f);
2055 }
2056
2057 static I_
2058 decode(const char *s)
2059 {
2060     I_ c;
2061     StgDouble m;
2062
2063     if (!*s)
2064         return 0;
2065
2066     m = atof(s);
2067     c = s[strlen(s)-1];
2068
2069     if (c == 'g' || c == 'G')
2070         m *= 1000*1000*1000;    /* UNchecked! */
2071     else if (c == 'm' || c == 'M')
2072         m *= 1000*1000;                 /* We do not use powers of 2 (1024) */
2073     else if (c == 'k' || c == 'K')      /* to avoid possible bad effects on */
2074         m *= 1000;                      /* a direct-mapped cache.           */
2075     else if (c == 'w' || c == 'W')
2076         m *= sizeof(W_);
2077
2078     return (I_)m;
2079 }
2080
2081 static void
2082 bad_option(const char *s)
2083 {
2084   prog_belch("bad RTS option: %s", s);
2085   stg_exit(EXIT_FAILURE);
2086 }