rts/RtsFlags.c

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