ghc/rts/RtsFlags.c

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