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