ghc/rts/RtsFlags.c

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