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