ghc/rts/RtsFlags.c

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