ghc/rts/RtsFlags.c

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