ghc/rts/RtsFlags.c

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