ghc/rts/RtsFlags.c

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