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