ghc/rts/RtsFlags.c

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