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
  13 #include "RtsOpts.h"
  14 #include "RtsUtils.h"
  15 #include "Profiling.h"
  16
  17 #ifdef HAVE_CTYPE_H
  18 #include <ctype.h>
  19 #endif
  20
  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 /* -----------------------------------------------------------------------------
  44    Static function decls
  45    -------------------------------------------------------------------------- */
  46
  47 static int              /* return NULL on error */
  48 open_stats_file (
  49     I_ arg,
  50     int argc, char *argv[],
  51     int rts_argc, char *rts_argv[],
  52     const char *FILENAME_FMT,
  53     FILE **file_ret);
  54
  55 static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max);
  56 static void bad_option(const char *s);
  57 #ifdef TRACING
  58 static void read_trace_flags(char *arg);
  59 #endif
  60
  61 /* -----------------------------------------------------------------------------
  62  * Command-line option parsing routines.
  63  * ---------------------------------------------------------------------------*/
  64
  65 void initRtsFlagsDefaults(void)
  66 {
  67     RtsFlags.GcFlags.statsFile          = NULL;
  68     RtsFlags.GcFlags.giveStats          = NO_GC_STATS;
  69
  70     RtsFlags.GcFlags.maxStkSize         = (8 * 1024 * 1024) / sizeof(W_);
  71     RtsFlags.GcFlags.initialStkSize     = 1024 / sizeof(W_);
  72     RtsFlags.GcFlags.stkChunkSize       = (32 * 1024) / sizeof(W_);
  73     RtsFlags.GcFlags.stkChunkBufferSize = (1 * 1024) / sizeof(W_);
  74
  75     RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
  76     RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
  77     RtsFlags.GcFlags.maxHeapSize        = 0;    /* off by default */
  78     RtsFlags.GcFlags.heapSizeSuggestion = 0;    /* none */
  79     RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
  80     RtsFlags.GcFlags.pcFreeHeap         = 3;    /* 3% */
  81     RtsFlags.GcFlags.oldGenFactor       = 2;
  82     RtsFlags.GcFlags.generations        = 2;
  83     RtsFlags.GcFlags.squeezeUpdFrames   = rtsTrue;
  84     RtsFlags.GcFlags.compact            = rtsFalse;
  85     RtsFlags.GcFlags.compactThreshold   = 30.0;
  86     RtsFlags.GcFlags.sweep              = rtsFalse;
  87 #ifdef RTS_GTK_FRONTPANEL
  88     RtsFlags.GcFlags.frontpanel         = rtsFalse;
  89 #endif
  90     RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
  91
  92 #if osf3_HOST_OS
  93 /* ToDo: Perhaps by adjusting this value we can make linking without
  94  * -static work (i.e., not generate a core-dumping executable)? */
  95 # if SIZEOF_VOID_P == 8
  96     RtsFlags.GcFlags.heapBase           = 0x180000000L;
  97 # else
  98 #  error I have no idea where to begin the heap on a non-64-bit osf3 machine.
  99 # endif
 100 #else
 101     RtsFlags.GcFlags.heapBase           = 0;   /* means don't care */
 102 #endif
 103
 104 #ifdef DEBUG
 105     RtsFlags.DebugFlags.scheduler       = rtsFalse;
 106     RtsFlags.DebugFlags.interpreter     = rtsFalse;
 107     RtsFlags.DebugFlags.weak            = rtsFalse;
 108     RtsFlags.DebugFlags.gccafs          = rtsFalse;
 109     RtsFlags.DebugFlags.gc              = rtsFalse;
 110     RtsFlags.DebugFlags.block_alloc     = rtsFalse;
 111     RtsFlags.DebugFlags.sanity          = rtsFalse;
 112     RtsFlags.DebugFlags.stable          = rtsFalse;
 113     RtsFlags.DebugFlags.stm             = rtsFalse;
 114     RtsFlags.DebugFlags.prof            = rtsFalse;
 115     RtsFlags.DebugFlags.apply           = rtsFalse;
 116     RtsFlags.DebugFlags.linker          = rtsFalse;
 117     RtsFlags.DebugFlags.squeeze         = rtsFalse;
 118     RtsFlags.DebugFlags.hpc             = rtsFalse;
 119     RtsFlags.DebugFlags.sparks          = rtsFalse;
 120 #endif
 121
 122 #if defined(PROFILING)
 123     RtsFlags.CcFlags.doCostCentres      = 0;
 124 #endif /* PROFILING */
 125
 126     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
 127     RtsFlags.ProfFlags.profileInterval    = 100;
 128
 129 #ifdef PROFILING
 130     RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
 131     RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
 132     RtsFlags.ProfFlags.maxRetainerSetSize = 8;
 133     RtsFlags.ProfFlags.ccsLength          = 25;
 134     RtsFlags.ProfFlags.modSelector        = NULL;
 135     RtsFlags.ProfFlags.descrSelector      = NULL;
 136     RtsFlags.ProfFlags.typeSelector       = NULL;
 137     RtsFlags.ProfFlags.ccSelector         = NULL;
 138     RtsFlags.ProfFlags.ccsSelector        = NULL;
 139     RtsFlags.ProfFlags.retainerSelector   = NULL;
 140     RtsFlags.ProfFlags.bioSelector        = NULL;
 141 #endif
 142
 143 #ifdef TRACING
 144     RtsFlags.TraceFlags.tracing       = TRACE_NONE;
 145     RtsFlags.TraceFlags.timestamp     = rtsFalse;
 146     RtsFlags.TraceFlags.scheduler     = rtsFalse;
 147 #endif
 148
 149     RtsFlags.MiscFlags.tickInterval     = 20;  /* In milliseconds */
 150     RtsFlags.ConcFlags.ctxtSwitchTime   = 20;  /* In milliseconds */
 151
 152     RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
 153     RtsFlags.MiscFlags.machineReadable = rtsFalse;
 154     RtsFlags.MiscFlags.linkerMemBase    = 0;
 155
 156 #ifdef THREADED_RTS
 157     RtsFlags.ParFlags.nNodes            = 1;
 158     RtsFlags.ParFlags.migrate           = rtsTrue;
 159     RtsFlags.ParFlags.wakeupMigrate     = rtsFalse;
 160     RtsFlags.ParFlags.parGcEnabled      = 1;
 161     RtsFlags.ParFlags.parGcGen          = 0;
 162     RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
 163     RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
 164     RtsFlags.ParFlags.setAffinity       = 0;
 165 #endif
 166
 167 #if defined(THREADED_RTS)
 168     RtsFlags.ParFlags.maxLocalSparks    = 4096;
 169 #endif /* THREADED_RTS */
 170
 171 #ifdef TICKY_TICKY
 172     RtsFlags.TickyFlags.showTickyStats   = rtsFalse;
 173     RtsFlags.TickyFlags.tickyFile        = NULL;
 174 #endif
 175
 176 #ifdef USE_PAPI
 177     /* By default no special measurements taken */
 178     RtsFlags.PapiFlags.eventType        = 0;
 179     RtsFlags.PapiFlags.numUserEvents    = 0;
 180 #endif
 181 }
 182
 183 static const char *
 184 usage_text[] = {
 185 "",
 186 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
 187 "",
 188 "   +RTS    Indicates run time system options follow",
 189 "   -RTS    Indicates program arguments follow",
 190 "  --RTS    Indicates that ALL subsequent arguments will be given to the",
 191 "           program (including any of these RTS flags)",
 192 "",
 193 "The following run time system options are available:",
 194 "",
 195 "  -?       Prints this message and exits; the program is not executed",
 196 "  --info   Print information about the RTS used by this program",
 197 "",
 198 "  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
 199 "  -ki<size> Sets the initial thread stack size (default 1k)  Egs: -ki4k -ki2m",
 200 "  -kc<size> Sets the stack chunk size (default 32k)",
 201 "  -kb<size> Sets the stack chunk buffer size (default 1k)",
 202 "",
 203 "  -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
 204 "  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
 205 "  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
 206 "  -m<n>    Minimum % of heap which must be available (default 3%)",
 207 "  -G<n>    Number of generations (default: 2)",
 208 "  -c<n>    Use in-place compaction instead of copying in the oldest generation",
 209 "           when live data is at least <n>% of the maximum heap size set with",
 210 "           -M (default: 30%)",
 211 "  -c       Use in-place compaction for all oldest generation collections",
 212 "           (the default is to use copying)",
 213 "  -w       Use mark-region for the oldest generation (experimental)",
 214 #if defined(THREADED_RTS)
 215 "  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
 216 #endif
 217 "",
 218 "  -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
 219 "  -s[<file>] Summary  GC statistics (if <file> omitted, uses stderr)",
 220 "  -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
 221 #ifdef RTS_GTK_FRONTPANEL
 222 "  -f       Display front panel (requires X11 & GTK+)",
 223 #endif
 224 "",
 225 "",
 226 "  -Z       Don't squeeze out update frames on stack overflow",
 227 "  -B       Sound the bell at the start of each garbage collection",
 228 #if defined(PROFILING)
 229 "",
 230 "  -px      Time/allocation profile (XML)  (output file <program>.prof)",
 231 "  -p       Time/allocation profile        (output file <program>.prof)",
 232 "  -P       More detailed Time/Allocation profile",
 233 "  -Pa      Give information about *all* cost centres",
 234
 235 # if defined(PROFILING)
 236 "",
 237 "  -hx            Heap residency profile (XML)   (output file <program>.prof)",
 238 "  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
 239 "     break-down: c = cost centre stack (default)",
 240 "                 m = module",
 241 "                 d = closure description",
 242 "                 y = type description",
 243 "                 r = retainer",
 244 "                 b = biography (LAG,DRAG,VOID,USE)",
 245 "  A subset of closures may be selected thusly:",
 246 "    -hc<cc>,...  specific cost centre(s) (top of stack only)",
 247 "    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
 248 "    -hm<mod>...  all cost centres from the specified modules(s)",
 249 "    -hd<des>,... closures with specified closure descriptions",
 250 "    -hy<typ>...  closures with specified type descriptions",
 251 "    -hr<cc>...   closures with specified retainers",
 252 "    -hb<bio>...  closures with specified biographies (lag,drag,void,use)",
 253 "",
 254 "  -R<size>       Set the maximum retainer set size (default: 8)",
 255 "",
 256 "  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
 257 "                 (default: 25)",
 258 "",
 259 "  -xt            Include threads (TSOs) in a heap profile",
 260 "",
 261 "  -xc      Show current cost centre stack on raising an exception",
 262 # endif
 263 #endif /* PROFILING or PAR */
 264
 265 #ifdef TRACING
 266 "",
 267 "  -l[flags]  Log events in binary format to the file <program>.eventlog",
 268 #  ifdef DEBUG
 269 "  -v[flags]  Log events to stderr",
 270 #  endif
 271 "             where [flags] can contain:",
 272 "                s    scheduler events",
 273 #  ifdef DEBUG
 274 "                t    add time stamps (only useful with -v)",
 275 #  endif
 276 #endif
 277
 278 #if !defined(PROFILING)
 279 "",
 280 "  -hT      Heap residency profile (output file <program>.hp)",
 281 #endif
 282 "  -i<sec>  Time between heap samples (seconds, default: 0.1)",
 283 "",
 284 #if defined(TICKY_TICKY)
 285 "  -r<file>  Produce ticky-ticky statistics (with -rstderr for stderr)",
 286 "",
 287 #endif
 288 "  -C<secs>  Context-switch interval in seconds.",
 289 "            0 or no argument means switch as often as possible.",
 290 "            Default: 0.02 sec; resolution is set by -V below.",
 291 "  -V<secs>  Master tick interval in seconds (0 == disable timer).",
 292 "            This sets the resolution for -C and the profile timer -i.",
 293 "            Default: 0.02 sec.",
 294 "",
 295 #if defined(DEBUG)
 296 "  -Ds  DEBUG: scheduler",
 297 "  -Di  DEBUG: interpreter",
 298 "  -Dw  DEBUG: weak",
 299 "  -DG  DEBUG: gccafs",
 300 "  -Dg  DEBUG: gc",
 301 "  -Db  DEBUG: block",
 302 "  -DS  DEBUG: sanity",
 303 "  -Dt  DEBUG: stable",
 304 "  -Dp  DEBUG: prof",
 305 "  -De  DEBUG: event logging",
 306 "  -Da  DEBUG: apply",
 307 "  -Dl  DEBUG: linker",
 308 "  -Dm  DEBUG: stm",
 309 "  -Dz  DEBUG: stack squezing",
 310 "  -Dc  DEBUG: program coverage",
 311 "  -Dr  DEBUG: sparks",
 312 "",
 313 "     NOTE: DEBUG events are sent to stderr by default; add -l to create a",
 314 "     binary event log file instead.",
 315 "",
 316 #endif /* DEBUG */
 317 #if defined(THREADED_RTS) && !defined(NOSMP)
 318 "  -N<n>     Use <n> processors (default: 1)",
 319 "  -N        Determine the number of processors to use automatically",
 320 "  -qg[<n>]  Use parallel GC only for generations >= <n>",
 321 "            (default: 0, -qg alone turns off parallel GC)",
 322 "  -qb[<n>]  Use load-balancing in the parallel GC only for generations >= <n>",
 323 "            (default: 1, -qb alone turns off load-balancing)",
 324 "  -qa       Use the OS to set thread affinity (experimental)",
 325 "  -qm       Don't automatically migrate threads between CPUs",
 326 "  -qw       Migrate a thread to the current CPU when it is woken up",
 327 #endif
 328 "  --install-signal-handlers=<yes|no>",
 329 "            Install signal handlers (default: yes)",
 330 #if defined(THREADED_RTS)
 331 "  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
 332 #endif
 333 #if defined(x86_64_HOST_ARCH)
 334 "  -xm       Base address to mmap memory in the GHCi linker",
 335 "            (hex; must be <80000000)",
 336 #endif
 337 #if defined(USE_PAPI)
 338 "  -aX       CPU performance counter measurements using PAPI",
 339 "            (use with the -s<file> option).  X is one of:",
 340 "",
 341 /* "            y - cycles", */
 342 "            1 - level 1 cache misses",
 343 "            2 - level 2 cache misses",
 344 "            b - branch mispredictions",
 345 "            s - stalled cycles",
 346 "            e - cache miss and branch misprediction events",
 347 "            +PAPI_EVENT   - collect papi preset event PAPI_EVENT",
 348 "            #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
 349 #endif
 350 "",
 351 "RTS options may also be specified using the GHCRTS environment variable.",
 352 "",
 353 "Other RTS options may be available for programs compiled a different way.",
 354 "The GHC User's Guide has full details.",
 355 "",
 356 0
 357 };
 358
 359 STATIC_INLINE rtsBool
 360 strequal(const char *a, const char * b)
 361 {
 362     return(strcmp(a, b) == 0);
 363 }
 364
 365 static void
 366 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
 367 {
 368     char *c1, *c2;
 369
 370     c1 = s;
 371     do {
 372         while (isspace(*c1)) { c1++; };
 373         c2 = c1;
 374         while (!isspace(*c2) && *c2 != '\0') { c2++; };
 375
 376         if (c1 == c2) { break; }
 377
 378         if (*rts_argc < MAX_RTS_ARGS-1) {
 379             s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
 380             strncpy(s, c1, c2-c1);
 381             s[c2-c1] = '\0';
 382             rts_argv[(*rts_argc)++] = s;
 383         } else {
 384             barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 385         }
 386
 387         c1 = c2;
 388     } while (*c1 != '\0');
 389 }
 390
 391 void
 392 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
 393 {
 394     rtsBool error = rtsFalse;
 395     I_ mode;
 396     I_ arg, total_arg;
 397
 398     setProgName (argv);
 399     total_arg = *argc;
 400     arg = 1;
 401
 402     *argc = 1;
 403     *rts_argc = 0;
 404
 405     // process arguments from the ghc_rts_opts global variable first.
 406     // (arguments from the GHCRTS environment variable and the command
 407     // line override these).
 408     {
 409         if (ghc_rts_opts != NULL) {
 410             splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
 411         }
 412     }
 413
 414     // process arguments from the GHCRTS environment variable next
 415     // (arguments from the command line override these).
 416     {
 417         char *ghc_rts = getenv("GHCRTS");
 418
 419         if (ghc_rts != NULL) {
 420             if (rtsOptsEnabled != rtsOptsNone) {
 421                 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
 422             }
 423             else {
 424                 errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n         Link with -rtsopts to enable them.");
 425                 // We don't actually exit, just warn
 426             }
 427         }
 428     }
 429
 430     // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
 431     //   argv[0] must be PGM argument -- leave in argv
 432
 433     for (mode = PGM; arg < total_arg; arg++) {
 434         // The '--RTS' argument disables all future +RTS ... -RTS processing.
 435         if (strequal("--RTS", argv[arg])) {
 436             arg++;
 437             break;
 438         }
 439         // The '--' argument is passed through to the program, but
 440         // disables all further +RTS ... -RTS processing.
 441         else if (strequal("--", argv[arg])) {
 442             break;
 443         }
 444         else if (strequal("+RTS", argv[arg])) {
 445             if (rtsOptsEnabled != rtsOptsNone) {
 446                 mode = RTS;
 447             }
 448             else {
 449                 errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
 450                 stg_exit(EXIT_FAILURE);
 451             }
 452         }
 453         else if (strequal("-RTS", argv[arg])) {
 454             mode = PGM;
 455         }
 456         else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
 457             rts_argv[(*rts_argc)++] = argv[arg];
 458         }
 459         else if (mode == PGM) {
 460             argv[(*argc)++] = argv[arg];
 461         }
 462         else {
 463           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 464         }
 465     }
 466     // process remaining program arguments
 467     for (; arg < total_arg; arg++) {
 468         argv[(*argc)++] = argv[arg];
 469     }
 470     argv[*argc] = (char *) 0;
 471     rts_argv[*rts_argc] = (char *) 0;
 472
 473     // Process RTS (rts_argv) part: mainly to determine statsfile
 474     for (arg = 0; arg < *rts_argc; arg++) {
 475         if (rts_argv[arg][0] != '-') {
 476             fflush(stdout);
 477             errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
 478             error = rtsTrue;
 479
 480         } else {
 481
 482             switch(rts_argv[arg][1]) {
 483             case '-':
 484                 if (strequal("info", &rts_argv[arg][2])) {
 485                     printRtsInfo();
 486                     stg_exit(0);
 487                 }
 488                 break;
 489             default:
 490                 break;
 491             }
 492
 493             if (rtsOptsEnabled != rtsOptsAll)
 494             {
 495                 errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
 496                 stg_exit(EXIT_FAILURE);
 497             }
 498
 499             switch(rts_argv[arg][1]) {
 500
 501               /* process: general args, then PROFILING-only ones, then
 502                  CONCURRENT-only, TICKY-only (same order as defined in
 503                  RtsFlags.lh); within those groups, mostly in
 504                  case-insensitive alphabetical order.  Final group is
 505                  x*, which allows for more options.
 506               */
 507
 508 #ifdef TICKY_TICKY
 509 # define TICKY_BUILD_ONLY(x) x
 510 #else
 511 # define TICKY_BUILD_ONLY(x) \
 512 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
 513 error = rtsTrue;
 514 #endif
 515
 516 #ifdef PROFILING
 517 # define PROFILING_BUILD_ONLY(x)   x
 518 #else
 519 # define PROFILING_BUILD_ONLY(x) \
 520 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
 521 error = rtsTrue;
 522 #endif
 523
 524 #ifdef TRACING
 525 # define TRACING_BUILD_ONLY(x)   x
 526 #else
 527 # define TRACING_BUILD_ONLY(x) \
 528 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
 529 error = rtsTrue;
 530 #endif
 531
 532 #ifdef THREADED_RTS
 533 # define THREADED_BUILD_ONLY(x)      x
 534 #else
 535 # define THREADED_BUILD_ONLY(x) \
 536 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
 537 error = rtsTrue;
 538 #endif
 539
 540 #ifdef DEBUG
 541 # define DEBUG_BUILD_ONLY(x) x
 542 #else
 543 # define DEBUG_BUILD_ONLY(x) \
 544 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
 545 error = rtsTrue;
 546 #endif
 547
 548               /* =========== GENERAL ========================== */
 549               case '?':
 550                 error = rtsTrue;
 551                 break;
 552
 553               /* This isn't going to allow us to keep related options
 554                  together as we add more --* flags. We really need a
 555                  proper options parser. */
 556               case '-':
 557                   if (strequal("install-signal-handlers=yes",
 558                                &rts_argv[arg][2])) {
 559                       RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
 560                   }
 561                   else if (strequal("install-signal-handlers=no",
 562                                &rts_argv[arg][2])) {
 563                       RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
 564                   }
 565                   else if (strequal("machine-readable",
 566                                &rts_argv[arg][2])) {
 567                       RtsFlags.MiscFlags.machineReadable = rtsTrue;
 568                   }
 569                   else if (strequal("info",
 570                                &rts_argv[arg][2])) {
 571                       printRtsInfo();
 572                       stg_exit(0);
 573                   }
 574                   else {
 575                       errorBelch("unknown RTS option: %s",rts_argv[arg]);
 576                       error = rtsTrue;
 577                   }
 578                   break;
 579               case 'A':
 580                   RtsFlags.GcFlags.minAllocAreaSize
 581                       = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
 582                            / BLOCK_SIZE;
 583                   break;
 584
 585 #ifdef USE_PAPI
 586               case 'a':
 587                 switch(rts_argv[arg][2]) {
 588                 case '1':
 589                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
 590                   break;
 591                 case '2':
 592                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
 593                   break;
 594                 case 'b':
 595                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
 596                   break;
 597                 case 's':
 598                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
 599                   break;
 600                 case 'e':
 601                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
 602                   break;
 603                 case '+':
 604                 case '#':
 605                   if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
 606                       errorBelch("maximum number of PAPI events reached");
 607                       stg_exit(EXIT_FAILURE);
 608                   }
 609                   nat eventNum  = RtsFlags.PapiFlags.numUserEvents++;
 610                   char kind     = rts_argv[arg][2];
 611                   nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;
 612
 613                   RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
 614                   RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
 615                   RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
 616                   break;
 617                 default:
 618                   bad_option( rts_argv[arg] );
 619                 }
 620                 break;
 621 #endif
 622
 623               case 'B':
 624                 RtsFlags.GcFlags.ringBell = rtsTrue;
 625                 break;
 626
 627               case 'c':
 628                   if (rts_argv[arg][2] != '\0') {
 629                       RtsFlags.GcFlags.compactThreshold =
 630                           atof(rts_argv[arg]+2);
 631                   } else {
 632                       RtsFlags.GcFlags.compact = rtsTrue;
 633                   }
 634                   break;
 635
 636               case 'w':
 637                 RtsFlags.GcFlags.sweep = rtsTrue;
 638                 break;
 639
 640               case 'F':
 641                 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
 642
 643                 if (RtsFlags.GcFlags.oldGenFactor < 0)
 644                   bad_option( rts_argv[arg] );
 645                 break;
 646
 647               case 'D':
 648               DEBUG_BUILD_ONLY(
 649               {
 650                   char *c;
 651
 652                   for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
 653                       switch (*c) {
 654                       case 's':
 655                           RtsFlags.DebugFlags.scheduler = rtsTrue;
 656                           break;
 657                       case 'i':
 658                           RtsFlags.DebugFlags.interpreter = rtsTrue;
 659                           break;
 660                       case 'w':
 661                           RtsFlags.DebugFlags.weak = rtsTrue;
 662                           break;
 663                       case 'G':
 664                           RtsFlags.DebugFlags.gccafs = rtsTrue;
 665                           break;
 666                       case 'g':
 667                           RtsFlags.DebugFlags.gc = rtsTrue;
 668                           break;
 669                       case 'b':
 670                           RtsFlags.DebugFlags.block_alloc = rtsTrue;
 671                           break;
 672                       case 'S':
 673                           RtsFlags.DebugFlags.sanity = rtsTrue;
 674                           break;
 675                       case 't':
 676                           RtsFlags.DebugFlags.stable = rtsTrue;
 677                           break;
 678                       case 'p':
 679                           RtsFlags.DebugFlags.prof = rtsTrue;
 680                           break;
 681                       case 'l':
 682                           RtsFlags.DebugFlags.linker = rtsTrue;
 683                           break;
 684                       case 'a':
 685                           RtsFlags.DebugFlags.apply = rtsTrue;
 686                           break;
 687                       case 'm':
 688                           RtsFlags.DebugFlags.stm = rtsTrue;
 689                           break;
 690                       case 'z':
 691                           RtsFlags.DebugFlags.squeeze = rtsTrue;
 692                           break;
 693                       case 'c':
 694                           RtsFlags.DebugFlags.hpc = rtsTrue;
 695                           break;
 696                       case 'r':
 697                           RtsFlags.DebugFlags.sparks = rtsTrue;
 698                           break;
 699                       default:
 700                           bad_option( rts_argv[arg] );
 701                       }
 702                   }
 703                   // -Dx also turns on -v.  Use -l to direct trace
 704                   // events to the .eventlog file instead.
 705                   RtsFlags.TraceFlags.tracing = TRACE_STDERR;
 706               })
 707               break;
 708
 709               case 'K':
 710                   RtsFlags.GcFlags.maxStkSize =
 711                       decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
 712                   break;
 713
 714               case 'k':
 715                 switch(rts_argv[arg][2]) {
 716                 case 'c':
 717                   RtsFlags.GcFlags.stkChunkSize =
 718                       decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
 719                   break;
 720                 case 'b':
 721                   RtsFlags.GcFlags.stkChunkBufferSize =
 722                       decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
 723                   break;
 724                 case 'i':
 725                   RtsFlags.GcFlags.initialStkSize =
 726                       decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
 727                   break;
 728                 default:
 729                   RtsFlags.GcFlags.initialStkSize =
 730                       decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
 731                   break;
 732                 }
 733                 break;
 734
 735               case 'M':
 736                   RtsFlags.GcFlags.maxHeapSize =
 737                       decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
 738                   /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
 739                   break;
 740
 741               case 'm':
 742                   RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
 743
 744                   if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
 745                       RtsFlags.GcFlags.pcFreeHeap > 100)
 746                       bad_option( rts_argv[arg] );
 747                   break;
 748
 749               case 'G':
 750                   RtsFlags.GcFlags.generations =
 751                       decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
 752                   break;
 753
 754               case 'H':
 755                   if (rts_argv[arg][2] == '\0') {
 756                       RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
 757                   } else {
 758                       RtsFlags.GcFlags.heapSizeSuggestion =
 759                           (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
 760                   }
 761                   break;
 762
 763 #ifdef RTS_GTK_FRONTPANEL
 764               case 'f':
 765                   RtsFlags.GcFlags.frontpanel = rtsTrue;
 766                   break;
 767 #endif
 768
 769               case 'I': /* idle GC delay */
 770                 if (rts_argv[arg][2] == '\0') {
 771                   /* use default */
 772                 } else {
 773                     I_ cst; /* tmp */
 774
 775                     /* Convert to millisecs */
 776                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 777                     RtsFlags.GcFlags.idleGCDelayTime = cst;
 778                 }
 779                 break;
 780
 781               case 'S':
 782                   RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
 783                   goto stats;
 784
 785               case 's':
 786                   RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
 787                   goto stats;
 788
 789               case 't':
 790                   RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
 791                   goto stats;
 792
 793             stats:
 794                 {
 795                     int r;
 796                     r = open_stats_file(arg, *argc, argv,
 797                                         *rts_argc, rts_argv, NULL,
 798                                         &RtsFlags.GcFlags.statsFile);
 799                     if (r == -1) { error = rtsTrue; }
 800                 }
 801                 break;
 802
 803               case 'Z':
 804                 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
 805                 break;
 806
 807               /* =========== PROFILING ========================== */
 808
 809               case 'P': /* detailed cost centre profiling (time/alloc) */
 810               case 'p': /* cost centre profiling (time/alloc) */
 811                 PROFILING_BUILD_ONLY(
 812                 switch (rts_argv[arg][2]) {
 813                   case 'x':
 814                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
 815                     break;
 816                   case 'a':
 817                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
 818                     break;
 819                   default:
 820                       if (rts_argv[arg][1] == 'P') {
 821                           RtsFlags.CcFlags.doCostCentres =
 822                               COST_CENTRES_VERBOSE;
 823                       } else {
 824                           RtsFlags.CcFlags.doCostCentres =
 825                               COST_CENTRES_SUMMARY;
 826                       }
 827                       break;
 828                 }
 829                 ) break;
 830
 831               case 'R':
 832                   PROFILING_BUILD_ONLY(
 833                       RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
 834                   ) break;
 835               case 'L':
 836                   PROFILING_BUILD_ONLY(
 837                       RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
 838                       if(RtsFlags.ProfFlags.ccsLength <= 0) {
 839                         bad_option(rts_argv[arg]);
 840                       }
 841                   ) break;
 842               case 'h': /* serial heap profile */
 843 #if !defined(PROFILING)
 844                 switch (rts_argv[arg][2]) {
 845                   case '\0':
 846                   case 'T':
 847                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
 848                     break;
 849                   default:
 850                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 851                     error = rtsTrue;
 852                 }
 853 #else
 854                 PROFILING_BUILD_ONLY(
 855                 switch (rts_argv[arg][2]) {
 856                 case '\0':
 857                 case 'C':
 858                 case 'c':
 859                 case 'M':
 860                 case 'm':
 861                 case 'D':
 862                 case 'd':
 863                 case 'Y':
 864                 case 'y':
 865                 case 'R':
 866                 case 'r':
 867                 case 'B':
 868                 case 'b':
 869                     if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
 870                         {
 871                             char *left  = strchr(rts_argv[arg], '{');
 872                             char *right = strrchr(rts_argv[arg], '}');
 873
 874                             // curly braces are optional, for
 875                             // backwards compat.
 876                             if (left)
 877                                 left = left+1;
 878                             else
 879                                 left = rts_argv[arg] + 3;
 880
 881                             if (!right)
 882                                 right = rts_argv[arg] + strlen(rts_argv[arg]);
 883
 884                             *right = '\0';
 885
 886                             switch (rts_argv[arg][2]) {
 887                             case 'c': // cost centre label select
 888                                 RtsFlags.ProfFlags.ccSelector = left;
 889                                 break;
 890                             case 'C':
 891                                 RtsFlags.ProfFlags.ccsSelector = left;
 892                                 break;
 893                             case 'M':
 894                             case 'm': // cost centre module select
 895                                 RtsFlags.ProfFlags.modSelector = left;
 896                                 break;
 897                             case 'D':
 898                             case 'd': // closure descr select
 899                                 RtsFlags.ProfFlags.descrSelector = left;
 900                                 break;
 901                             case 'Y':
 902                             case 'y': // closure type select
 903                                 RtsFlags.ProfFlags.typeSelector = left;
 904                                 break;
 905                             case 'R':
 906                             case 'r': // retainer select
 907                                 RtsFlags.ProfFlags.retainerSelector = left;
 908                                 break;
 909                             case 'B':
 910                             case 'b': // biography select
 911                                 RtsFlags.ProfFlags.bioSelector = left;
 912                                 break;
 913                             }
 914                         }
 915                         break;
 916                     }
 917
 918                     if (RtsFlags.ProfFlags.doHeapProfile != 0) {
 919                         errorBelch("multiple heap profile options");
 920                         error = rtsTrue;
 921                         break;
 922                     }
 923
 924                     switch (rts_argv[arg][2]) {
 925                     case '\0':
 926                     case 'C':
 927                     case 'c':
 928                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
 929                         break;
 930                     case 'M':
 931                     case 'm':
 932                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
 933                           break;
 934                     case 'D':
 935                     case 'd':
 936                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
 937                           break;
 938                     case 'Y':
 939                     case 'y':
 940                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
 941                           break;
 942                     case 'R':
 943                     case 'r':
 944                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
 945                           break;
 946                     case 'B':
 947                     case 'b':
 948                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
 949                           break;
 950                     }
 951                     break;
 952
 953                 default:
 954                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 955                     error = rtsTrue;
 956                 }
 957                 )
 958 #endif /* PROFILING */
 959                 break;
 960
 961               case 'i': /* heap sample interval */
 962                 if (rts_argv[arg][2] == '\0') {
 963                   /* use default */
 964                 } else {
 965                     I_ cst; /* tmp */
 966
 967                     /* Convert to milliseconds */
 968                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 969                     RtsFlags.ProfFlags.profileInterval = cst;
 970                 }
 971                 break;
 972
 973               /* =========== CONCURRENT ========================= */
 974               case 'C': /* context switch interval */
 975                 if (rts_argv[arg][2] == '\0')
 976                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
 977                 else {
 978                     I_ cst; /* tmp */
 979
 980                     /* Convert to milliseconds */
 981                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 982                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
 983                 }
 984                 break;
 985
 986               case 'V': /* master tick interval */
 987                 if (rts_argv[arg][2] == '\0') {
 988                     // turns off ticks completely
 989                     RtsFlags.MiscFlags.tickInterval = 0;
 990                 } else {
 991                     I_ cst; /* tmp */
 992
 993                     /* Convert to milliseconds */
 994                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 995                     RtsFlags.MiscFlags.tickInterval = cst;
 996                 }
 997                 break;
 998
 999 #if !defined(NOSMP)
1000               case 'N':
1001                 THREADED_BUILD_ONLY(
1002                 if (rts_argv[arg][2] == '\0') {
1003 #if defined(PROFILING)
1004                     RtsFlags.ParFlags.nNodes = 1;
1005 #else
1006                     RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1007 #endif
1008                 } else {
1009                     RtsFlags.ParFlags.nNodes
1010                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1011                     if (RtsFlags.ParFlags.nNodes <= 0) {
1012                       errorBelch("bad value for -N");
1013                       error = rtsTrue;
1014                     }
1015 #if defined(PROFILING)
1016                     if (RtsFlags.ParFlags.nNodes > 1) {
1017                         errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1018                       error = rtsTrue;
1019                     }
1020 #endif
1021                 }
1022                 ) break;
1023
1024               case 'g':
1025                 THREADED_BUILD_ONLY(
1026                     switch (rts_argv[arg][2]) {
1027                     case '1':
1028                         // backwards compat only
1029                         RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1030                         break;
1031                     default:
1032                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
1033                         error = rtsTrue;
1034                         break;
1035                     }
1036                     ) break;
1037
1038               case 'q':
1039                 THREADED_BUILD_ONLY(
1040                     switch (rts_argv[arg][2]) {
1041                     case '\0':
1042                         errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1043                         error = rtsTrue;
1044                         break;
1045                     case 'g':
1046                         if (rts_argv[arg][3] == '\0') {
1047                             RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1048                         } else {
1049                             RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1050                             RtsFlags.ParFlags.parGcGen
1051                                 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1052                         }
1053                         break;
1054                     case 'b':
1055                         if (rts_argv[arg][3] == '\0') {
1056                             RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1057                         }
1058                         else {
1059                             RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1060                             RtsFlags.ParFlags.parGcLoadBalancingGen
1061                                 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1062                         }
1063                         break;
1064                     case 'a':
1065                         RtsFlags.ParFlags.setAffinity = rtsTrue;
1066                         break;
1067                     case 'm':
1068                         RtsFlags.ParFlags.migrate = rtsFalse;
1069                         break;
1070                     case 'w':
1071                         RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1072                         break;
1073                     default:
1074                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
1075                         error = rtsTrue;
1076                         break;
1077                     }
1078                     ) break;
1079 #endif
1080               /* =========== PARALLEL =========================== */
1081               case 'e':
1082                 THREADED_BUILD_ONLY(
1083                 if (rts_argv[arg][2] != '\0') {
1084                     RtsFlags.ParFlags.maxLocalSparks
1085                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1086                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1087                       errorBelch("bad value for -e");
1088                       error = rtsTrue;
1089                     }
1090                 }
1091                 ) break;
1092
1093               /* =========== TICKY ============================== */
1094
1095               case 'r': /* Basic profiling stats */
1096                 TICKY_BUILD_ONLY(
1097
1098                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1099
1100                 {
1101                     int r;
1102                     r = open_stats_file(arg, *argc, argv,
1103                                         *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1104                                         &RtsFlags.TickyFlags.tickyFile);
1105                     if (r == -1) { error = rtsTrue; }
1106                 }
1107                 ) break;
1108
1109               /* =========== TRACING ---------=================== */
1110
1111               case 'l':
1112                   TRACING_BUILD_ONLY(
1113                       RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1114                       read_trace_flags(&rts_argv[arg][2]);
1115                       );
1116                   break;
1117
1118               case 'v':
1119                   DEBUG_BUILD_ONLY(
1120                       RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1121                       read_trace_flags(&rts_argv[arg][2]);
1122                       );
1123                   break;
1124
1125               /* =========== EXTENDED OPTIONS =================== */
1126
1127               case 'x': /* Extend the argument space */
1128                 switch(rts_argv[arg][2]) {
1129                   case '\0':
1130                     errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1131                     error = rtsTrue;
1132                     break;
1133
1134                 case 'b': /* heapBase in hex; undocumented */
1135                     if (rts_argv[arg][3] != '\0') {
1136                         RtsFlags.GcFlags.heapBase
1137                             = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1138                     } else {
1139                         errorBelch("-xb: requires argument");
1140                         error = rtsTrue;
1141                     }
1142                     break;
1143
1144 #if defined(x86_64_HOST_ARCH)
1145                 case 'm': /* linkerMemBase */
1146                     if (rts_argv[arg][3] != '\0') {
1147                         RtsFlags.MiscFlags.linkerMemBase
1148                             = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1149                         if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1150                             errorBelch("-xm: value must be <80000000");
1151                             error = rtsTrue;
1152                         }
1153                     } else {
1154                         RtsFlags.MiscFlags.linkerMemBase = 0;
1155                     }
1156                     break;
1157 #endif
1158
1159                 case 'c': /* Debugging tool: show current cost centre on an exception */
1160                     PROFILING_BUILD_ONLY(
1161                         RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1162                         );
1163                     break;
1164
1165                 case 't':  /* Include memory used by TSOs in a heap profile */
1166                     PROFILING_BUILD_ONLY(
1167                         RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1168                         );
1169                     break;
1170
1171                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
1172
1173                   default:
1174                     errorBelch("unknown RTS option: %s",rts_argv[arg]);
1175                     error = rtsTrue;
1176                     break;
1177                 }
1178                 break;  /* defensive programming */
1179
1180               /* =========== OH DEAR ============================ */
1181               default:
1182                 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1183                 error = rtsTrue;
1184                 break;
1185             }
1186         }
1187     }
1188
1189     if (RtsFlags.MiscFlags.tickInterval < 0) {
1190         RtsFlags.MiscFlags.tickInterval = 50;
1191     }
1192
1193     // If the master timer is disabled, turn off the other timers.
1194     if (RtsFlags.MiscFlags.tickInterval == 0) {
1195         RtsFlags.ConcFlags.ctxtSwitchTime  = 0;
1196         RtsFlags.GcFlags.idleGCDelayTime   = 0;
1197         RtsFlags.ProfFlags.profileInterval = 0;
1198     }
1199
1200     // Determine what tick interval we should use for the RTS timer
1201     // by taking the shortest of the various intervals that we need to
1202     // monitor.
1203     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1204         RtsFlags.MiscFlags.tickInterval =
1205             stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1206                     RtsFlags.MiscFlags.tickInterval);
1207     }
1208
1209     if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1210         RtsFlags.MiscFlags.tickInterval =
1211             stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1212                     RtsFlags.MiscFlags.tickInterval);
1213     }
1214
1215     if (RtsFlags.ProfFlags.profileInterval > 0) {
1216         RtsFlags.MiscFlags.tickInterval =
1217             stg_min(RtsFlags.ProfFlags.profileInterval,
1218                     RtsFlags.MiscFlags.tickInterval);
1219     }
1220
1221     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1222         RtsFlags.ConcFlags.ctxtSwitchTicks =
1223             RtsFlags.ConcFlags.ctxtSwitchTime /
1224             RtsFlags.MiscFlags.tickInterval;
1225     } else {
1226         RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1227     }
1228
1229     if (RtsFlags.ProfFlags.profileInterval > 0) {
1230         RtsFlags.ProfFlags.profileIntervalTicks =
1231             RtsFlags.ProfFlags.profileInterval /
1232             RtsFlags.MiscFlags.tickInterval;
1233     } else {
1234         RtsFlags.ProfFlags.profileIntervalTicks = 0;
1235     }
1236
1237     if (RtsFlags.GcFlags.stkChunkBufferSize >
1238         RtsFlags.GcFlags.stkChunkSize / 2) {
1239         errorBelch("stack chunk buffer size (-kb) must be less than 50%% of the stack chunk size (-kc)");
1240         error = rtsTrue;
1241     }
1242
1243     if (error) {
1244         const char **p;
1245
1246         fflush(stdout);
1247         for (p = usage_text; *p; p++)
1248             errorBelch("%s", *p);
1249         stg_exit(EXIT_FAILURE);
1250     }
1251 }
1252
1253
1254 static void
1255 stats_fprintf(FILE *f, char *s, ...)
1256 {
1257     va_list ap;
1258     va_start(ap,s);
1259     if (f == NULL) {
1260         vdebugBelch(s, ap);
1261     } else {
1262         vfprintf(f, s, ap);
1263     }
1264     va_end(ap);
1265 }
1266
1267 static int              /* return -1 on error */
1268 open_stats_file (
1269     I_ arg,
1270     int argc, char *argv[],
1271     int rts_argc, char *rts_argv[],
1272     const char *FILENAME_FMT,
1273     FILE **file_ret)
1274 {
1275     FILE *f = NULL;
1276
1277     if (strequal(rts_argv[arg]+2, "stderr")
1278         || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1279         f = NULL; /* NULL means use debugBelch */
1280     } else {
1281         if (rts_argv[arg][2] != '\0') {  /* stats file specified */
1282             f = fopen(rts_argv[arg]+2,"w");
1283         } else {
1284             char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1285             sprintf(stats_filename, FILENAME_FMT, argv[0]);
1286             f = fopen(stats_filename,"w");
1287         }
1288         if (f == NULL) {
1289             errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1290             return -1;
1291         }
1292     }
1293     *file_ret = f;
1294
1295     {
1296         /* Write argv and rtsv into start of stats file */
1297         int count;
1298         for(count = 0; count < argc; count++) {
1299             stats_fprintf(f, "%s ", argv[count]);
1300         }
1301         stats_fprintf(f, "+RTS ");
1302         for(count = 0; count < rts_argc; count++)
1303             stats_fprintf(f, "%s ", rts_argv[count]);
1304         stats_fprintf(f, "\n");
1305     }
1306     return 0;
1307 }
1308
1309
1310
1311 static StgWord64
1312 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1313 {
1314     char c;
1315     const char *s;
1316     StgDouble m;
1317     StgWord64 val;
1318
1319     s = flag + offset;
1320
1321     if (!*s)
1322     {
1323         m = 0;
1324     }
1325     else
1326     {
1327         m = atof(s);
1328         c = s[strlen(s)-1];
1329
1330         if (c == 'g' || c == 'G')
1331             m *= 1024*1024*1024;
1332         else if (c == 'm' || c == 'M')
1333             m *= 1024*1024;
1334         else if (c == 'k' || c == 'K')
1335             m *= 1024;
1336         else if (c == 'w' || c == 'W')
1337             m *= sizeof(W_);
1338     }
1339
1340     val = (StgWord64)m;
1341
1342     if (m < 0 || val < min || val > max) {
1343         // printf doesn't like 64-bit format specs on Windows
1344         // apparently, so fall back to unsigned long.
1345         errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1346         stg_exit(EXIT_FAILURE);
1347     }
1348
1349     return val;
1350 }
1351
1352 #if defined(TRACING)
1353 static void read_trace_flags(char *arg)
1354 {
1355     char *c;
1356
1357     for (c  = arg; *c != '\0'; c++) {
1358         switch(*c) {
1359         case '\0':
1360             break;
1361         case 's':
1362             RtsFlags.TraceFlags.scheduler = rtsTrue;
1363             break;
1364         case 't':
1365             RtsFlags.TraceFlags.timestamp = rtsTrue;
1366             break;
1367         case 'g':
1368             // ignored for backwards-compat
1369             break;
1370         default:
1371             errorBelch("unknown trace option: %c",*c);
1372             break;
1373         }
1374     }
1375 }
1376 #endif
1377
1378 static void GNU_ATTRIBUTE(__noreturn__)
1379 bad_option(const char *s)
1380 {
1381   errorBelch("bad RTS option: %s", s);
1382   stg_exit(EXIT_FAILURE);
1383 }
1384
1385 /* -----------------------------------------------------------------------------
1386    Getting/Setting the program's arguments.
1387
1388    These are used by System.Environment, and parts of the RTS.
1389    -------------------------------------------------------------------------- */
1390
1391 void
1392 setProgName(char *argv[])
1393 {
1394     /* Remove directory from argv[0] -- default files in current directory */
1395 #if !defined(mingw32_HOST_OS)
1396     char *last_slash;
1397     if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1398         prog_name = last_slash+1;
1399    } else {
1400         prog_name = argv[0];
1401    }
1402 #else
1403     char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1404     while ( last_slash > argv[0] ) {
1405         if ( *last_slash == '/' || *last_slash == '\\' ) {
1406             prog_name = last_slash+1;
1407             return;
1408         }
1409         last_slash--;
1410     }
1411     prog_name = argv[0];
1412 #endif
1413 }
1414
1415 void
1416 getProgArgv(int *argc, char **argv[])
1417 {
1418     if (argc) { *argc = prog_argc; }
1419     if (argv) { *argv = prog_argv; }
1420 }
1421
1422 void
1423 setProgArgv(int argc, char *argv[])
1424 {
1425    /* Usually this is done by startupHaskell, so we don't need to call this.
1426       However, sometimes Hugs wants to change the arguments which Haskell
1427       getArgs >>= ... will be fed.  So you can do that by calling here
1428       _after_ calling startupHaskell.
1429    */
1430    prog_argc = argc;
1431    prog_argv = argv;
1432    setProgName(prog_argv);
1433 }
1434
1435 /* These functions record and recall the full arguments, including the
1436    +RTS ... -RTS options. The reason for adding them was so that the
1437    ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1438 void
1439 getFullProgArgv(int *argc, char **argv[])
1440 {
1441     if (argc) { *argc = full_prog_argc; }
1442     if (argv) { *argv = full_prog_argv; }
1443 }
1444
1445 void
1446 setFullProgArgv(int argc, char *argv[])
1447 {
1448     int i;
1449     full_prog_argc = argc;
1450     full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1451                                     "setFullProgArgv 1");
1452     for (i = 0; i < argc; i++) {
1453         full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1454                                            "setFullProgArgv 2");
1455         strcpy(full_prog_argv[i], argv[i]);
1456     }
1457     full_prog_argv[argc] = NULL;
1458 }
1459
1460 void
1461 freeFullProgArgv (void)
1462 {
1463     int i;
1464
1465     if (full_prog_argv != NULL) {
1466         for (i = 0; i < full_prog_argc; i++) {
1467             stgFree(full_prog_argv[i]);
1468         }
1469         stgFree(full_prog_argv);
1470     }
1471
1472     full_prog_argc = 0;
1473     full_prog_argv = NULL;
1474 }