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<size>  Size of spark pools (default 100)",
 328 #endif
 329 #if defined(THREADED_RTS)
 330 "  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
 331 #endif
 332 #if defined(x86_64_HOST_ARCH)
 333 "  -xm       Base address to mmap memory in the GHCi linker",
 334 "            (hex; must be <80000000)",
 335 #endif
 336 #if defined(USE_PAPI)
 337 "  -aX       CPU performance counter measurements using PAPI",
 338 "            (use with the -s<file> option).  X is one of:",
 339 "",
 340 /* "            y - cycles", */
 341 "            1 - level 1 cache misses",
 342 "            2 - level 2 cache misses",
 343 "            b - branch mispredictions",
 344 "            s - stalled cycles",
 345 "            e - cache miss and branch misprediction events",
 346 #endif
 347 "",
 348 "RTS options may also be specified using the GHCRTS environment variable.",
 349 "",
 350 "Other RTS options may be available for programs compiled a different way.",
 351 "The GHC User's Guide has full details.",
 352 "",
 353 0
 354 };
 355
 356 STATIC_INLINE rtsBool
 357 strequal(const char *a, const char * b)
 358 {
 359     return(strcmp(a, b) == 0);
 360 }
 361
 362 static void
 363 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
 364 {
 365     char *c1, *c2;
 366
 367     c1 = s;
 368     do {
 369         while (isspace(*c1)) { c1++; };
 370         c2 = c1;
 371         while (!isspace(*c2) && *c2 != '\0') { c2++; };
 372
 373         if (c1 == c2) { break; }
 374
 375         if (*rts_argc < MAX_RTS_ARGS-1) {
 376             s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
 377             strncpy(s, c1, c2-c1);
 378             s[c2-c1] = '\0';
 379             rts_argv[(*rts_argc)++] = s;
 380         } else {
 381             barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 382         }
 383
 384         c1 = c2;
 385     } while (*c1 != '\0');
 386 }
 387
 388 void
 389 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
 390 {
 391     rtsBool error = rtsFalse;
 392     I_ mode;
 393     I_ arg, total_arg;
 394
 395     setProgName (argv);
 396     total_arg = *argc;
 397     arg = 1;
 398
 399     *argc = 1;
 400     *rts_argc = 0;
 401
 402     // process arguments from the ghc_rts_opts global variable first.
 403     // (arguments from the GHCRTS environment variable and the command
 404     // line override these).
 405     {
 406         if (ghc_rts_opts != NULL) {
 407             splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
 408         }
 409     }
 410
 411     // process arguments from the GHCRTS environment variable next
 412     // (arguments from the command line override these).
 413     {
 414         char *ghc_rts = getenv("GHCRTS");
 415
 416         if (ghc_rts != NULL) {
 417             if (rtsOptsEnabled) {
 418                 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
 419             }
 420             else {
 421                 errorBelch("Warning: Ignoring GHCRTS variable");
 422                 // We don't actually exit, just warn
 423             }
 424         }
 425     }
 426
 427     // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
 428     //   argv[0] must be PGM argument -- leave in argv
 429
 430     for (mode = PGM; arg < total_arg; arg++) {
 431         // The '--RTS' argument disables all future +RTS ... -RTS processing.
 432         if (strequal("--RTS", argv[arg])) {
 433             arg++;
 434             break;
 435         }
 436         // The '--' argument is passed through to the program, but
 437         // disables all further +RTS ... -RTS processing.
 438         else if (strequal("--", argv[arg])) {
 439             break;
 440         }
 441         else if (strequal("+RTS", argv[arg])) {
 442             if (rtsOptsEnabled) {
 443                 mode = RTS;
 444             }
 445             else {
 446                 errorBelch("RTS options are disabled");
 447                 stg_exit(EXIT_FAILURE);
 448             }
 449         }
 450         else if (strequal("-RTS", argv[arg])) {
 451             mode = PGM;
 452         }
 453         else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
 454             rts_argv[(*rts_argc)++] = argv[arg];
 455         }
 456         else if (mode == PGM) {
 457             argv[(*argc)++] = argv[arg];
 458         }
 459         else {
 460           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 461         }
 462     }
 463     // process remaining program arguments
 464     for (; arg < total_arg; arg++) {
 465         argv[(*argc)++] = argv[arg];
 466     }
 467     argv[*argc] = (char *) 0;
 468     rts_argv[*rts_argc] = (char *) 0;
 469
 470     // Process RTS (rts_argv) part: mainly to determine statsfile
 471     for (arg = 0; arg < *rts_argc; arg++) {
 472         if (rts_argv[arg][0] != '-') {
 473             fflush(stdout);
 474             errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
 475             error = rtsTrue;
 476
 477         } else {
 478             switch(rts_argv[arg][1]) {
 479
 480               /* process: general args, then PROFILING-only ones, then
 481                  CONCURRENT-only, TICKY-only (same order as defined in
 482                  RtsFlags.lh); within those groups, mostly in
 483                  case-insensitive alphabetical order.  Final group is
 484                  x*, which allows for more options.
 485               */
 486
 487 #ifdef TICKY_TICKY
 488 # define TICKY_BUILD_ONLY(x) x
 489 #else
 490 # define TICKY_BUILD_ONLY(x) \
 491 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
 492 error = rtsTrue;
 493 #endif
 494
 495 #ifdef PROFILING
 496 # define PROFILING_BUILD_ONLY(x)   x
 497 #else
 498 # define PROFILING_BUILD_ONLY(x) \
 499 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
 500 error = rtsTrue;
 501 #endif
 502
 503 #ifdef TRACING
 504 # define TRACING_BUILD_ONLY(x)   x
 505 #else
 506 # define TRACING_BUILD_ONLY(x) \
 507 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
 508 error = rtsTrue;
 509 #endif
 510
 511 #ifdef THREADED_RTS
 512 # define THREADED_BUILD_ONLY(x)      x
 513 #else
 514 # define THREADED_BUILD_ONLY(x) \
 515 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
 516 error = rtsTrue;
 517 #endif
 518
 519 #ifdef DEBUG
 520 # define DEBUG_BUILD_ONLY(x) x
 521 #else
 522 # define DEBUG_BUILD_ONLY(x) \
 523 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
 524 error = rtsTrue;
 525 #endif
 526
 527               /* =========== GENERAL ========================== */
 528               case '?':
 529                 error = rtsTrue;
 530                 break;
 531
 532               /* This isn't going to allow us to keep related options
 533                  together as we add more --* flags. We really need a
 534                  proper options parser. */
 535               case '-':
 536                   if (strequal("install-signal-handlers=yes",
 537                                &rts_argv[arg][2])) {
 538                       RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
 539                   }
 540                   else if (strequal("install-signal-handlers=no",
 541                                &rts_argv[arg][2])) {
 542                       RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
 543                   }
 544                   else if (strequal("machine-readable",
 545                                &rts_argv[arg][2])) {
 546                       RtsFlags.MiscFlags.machineReadable = rtsTrue;
 547                   }
 548                   else if (strequal("info",
 549                                &rts_argv[arg][2])) {
 550                       printRtsInfo();
 551                       exit(0);
 552                   }
 553                   else {
 554                       errorBelch("unknown RTS option: %s",rts_argv[arg]);
 555                       error = rtsTrue;
 556                   }
 557                   break;
 558               case 'A':
 559                   RtsFlags.GcFlags.minAllocAreaSize
 560                       = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
 561                            / BLOCK_SIZE;
 562                   break;
 563
 564 #ifdef USE_PAPI
 565               case 'a':
 566                 switch(rts_argv[arg][2]) {
 567                 case '1':
 568                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
 569                   break;
 570                 case '2':
 571                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
 572                   break;
 573                 case 'b':
 574                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
 575                   break;
 576                 case 's':
 577                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
 578                   break;
 579                 case 'e':
 580                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
 581                   break;
 582                 case '+':
 583                   if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
 584                       errorBelch("maximum number of PAPI events reached");
 585                       stg_exit(EXIT_FAILURE);
 586                   }
 587                   RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
 588                   RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
 589                   break;
 590                 default:
 591                   bad_option( rts_argv[arg] );
 592                 }
 593                 break;
 594 #endif
 595
 596               case 'B':
 597                 RtsFlags.GcFlags.ringBell = rtsTrue;
 598                 break;
 599
 600               case 'c':
 601                   if (rts_argv[arg][2] != '\0') {
 602                       RtsFlags.GcFlags.compactThreshold =
 603                           atof(rts_argv[arg]+2);
 604                   } else {
 605                       RtsFlags.GcFlags.compact = rtsTrue;
 606                   }
 607                   break;
 608
 609               case 'w':
 610                 RtsFlags.GcFlags.sweep = rtsTrue;
 611                 break;
 612
 613               case 'F':
 614                 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
 615
 616                 if (RtsFlags.GcFlags.oldGenFactor < 0)
 617                   bad_option( rts_argv[arg] );
 618                 break;
 619
 620               case 'D':
 621               DEBUG_BUILD_ONLY(
 622               {
 623                   char *c;
 624
 625                   for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
 626                       switch (*c) {
 627                       case 's':
 628                           RtsFlags.DebugFlags.scheduler = rtsTrue;
 629                           break;
 630                       case 'i':
 631                           RtsFlags.DebugFlags.interpreter = rtsTrue;
 632                           break;
 633                       case 'w':
 634                           RtsFlags.DebugFlags.weak = rtsTrue;
 635                           break;
 636                       case 'G':
 637                           RtsFlags.DebugFlags.gccafs = rtsTrue;
 638                           break;
 639                       case 'g':
 640                           RtsFlags.DebugFlags.gc = rtsTrue;
 641                           break;
 642                       case 'b':
 643                           RtsFlags.DebugFlags.block_alloc = rtsTrue;
 644                           break;
 645                       case 'S':
 646                           RtsFlags.DebugFlags.sanity = rtsTrue;
 647                           break;
 648                       case 't':
 649                           RtsFlags.DebugFlags.stable = rtsTrue;
 650                           break;
 651                       case 'p':
 652                           RtsFlags.DebugFlags.prof = rtsTrue;
 653                           break;
 654                       case 'l':
 655                           RtsFlags.DebugFlags.linker = rtsTrue;
 656                           break;
 657                       case 'a':
 658                           RtsFlags.DebugFlags.apply = rtsTrue;
 659                           break;
 660                       case 'm':
 661                           RtsFlags.DebugFlags.stm = rtsTrue;
 662                           break;
 663                       case 'z':
 664                           RtsFlags.DebugFlags.squeeze = rtsTrue;
 665                           break;
 666                       case 'c':
 667                           RtsFlags.DebugFlags.hpc = rtsTrue;
 668                           break;
 669                       case 'r':
 670                           RtsFlags.DebugFlags.sparks = rtsTrue;
 671                           break;
 672                       default:
 673                           bad_option( rts_argv[arg] );
 674                       }
 675                   }
 676                   // -Dx also turns on -v.  Use -l to direct trace
 677                   // events to the .eventlog file instead.
 678                   RtsFlags.TraceFlags.tracing = TRACE_STDERR;
 679               })
 680               break;
 681
 682               case 'K':
 683                   RtsFlags.GcFlags.maxStkSize =
 684                       decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
 685                   break;
 686
 687               case 'k':
 688                   RtsFlags.GcFlags.initialStkSize =
 689                       decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
 690                   break;
 691
 692               case 'M':
 693                   RtsFlags.GcFlags.maxHeapSize =
 694                       decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
 695                   /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
 696                   break;
 697
 698               case 'm':
 699                   RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
 700
 701                   if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
 702                       RtsFlags.GcFlags.pcFreeHeap > 100)
 703                       bad_option( rts_argv[arg] );
 704                   break;
 705
 706               case 'G':
 707                   RtsFlags.GcFlags.generations =
 708                       decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
 709                   break;
 710
 711               case 'H':
 712                   if (rts_argv[arg][2] == '\0') {
 713                       RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
 714                   } else {
 715                       RtsFlags.GcFlags.heapSizeSuggestion =
 716                           (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
 717                   }
 718                   break;
 719
 720 #ifdef RTS_GTK_FRONTPANEL
 721               case 'f':
 722                   RtsFlags.GcFlags.frontpanel = rtsTrue;
 723                   break;
 724 #endif
 725
 726               case 'I': /* idle GC delay */
 727                 if (rts_argv[arg][2] == '\0') {
 728                   /* use default */
 729                 } else {
 730                     I_ cst; /* tmp */
 731
 732                     /* Convert to millisecs */
 733                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 734                     RtsFlags.GcFlags.idleGCDelayTime = cst;
 735                 }
 736                 break;
 737
 738               case 'S':
 739                   RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
 740                   goto stats;
 741
 742               case 's':
 743                   RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
 744                   goto stats;
 745
 746               case 't':
 747                   RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
 748                   goto stats;
 749
 750             stats:
 751                 {
 752                     int r;
 753                     r = open_stats_file(arg, *argc, argv,
 754                                         *rts_argc, rts_argv, NULL,
 755                                         &RtsFlags.GcFlags.statsFile);
 756                     if (r == -1) { error = rtsTrue; }
 757                 }
 758                 break;
 759
 760               case 'Z':
 761                 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
 762                 break;
 763
 764               /* =========== PROFILING ========================== */
 765
 766               case 'P': /* detailed cost centre profiling (time/alloc) */
 767               case 'p': /* cost centre profiling (time/alloc) */
 768                 PROFILING_BUILD_ONLY(
 769                 switch (rts_argv[arg][2]) {
 770                   case 'x':
 771                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
 772                     break;
 773                   case 'a':
 774                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
 775                     break;
 776                   default:
 777                       if (rts_argv[arg][1] == 'P') {
 778                           RtsFlags.CcFlags.doCostCentres =
 779                               COST_CENTRES_VERBOSE;
 780                       } else {
 781                           RtsFlags.CcFlags.doCostCentres =
 782                               COST_CENTRES_SUMMARY;
 783                       }
 784                       break;
 785                 }
 786                 ) break;
 787
 788               case 'R':
 789                   PROFILING_BUILD_ONLY(
 790                       RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
 791                   ) break;
 792               case 'L':
 793                   PROFILING_BUILD_ONLY(
 794                       RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
 795                       if(RtsFlags.ProfFlags.ccsLength <= 0) {
 796                         bad_option(rts_argv[arg]);
 797                       }
 798                   ) break;
 799               case 'h': /* serial heap profile */
 800 #if !defined(PROFILING)
 801                 switch (rts_argv[arg][2]) {
 802                   case '\0':
 803                   case 'T':
 804                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
 805                     break;
 806                   default:
 807                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 808                     error = rtsTrue;
 809                 }
 810 #else
 811                 PROFILING_BUILD_ONLY(
 812                 switch (rts_argv[arg][2]) {
 813                 case '\0':
 814                 case 'C':
 815                 case 'c':
 816                 case 'M':
 817                 case 'm':
 818                 case 'D':
 819                 case 'd':
 820                 case 'Y':
 821                 case 'y':
 822                 case 'R':
 823                 case 'r':
 824                 case 'B':
 825                 case 'b':
 826                     if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
 827                         {
 828                             char *left  = strchr(rts_argv[arg], '{');
 829                             char *right = strrchr(rts_argv[arg], '}');
 830
 831                             // curly braces are optional, for
 832                             // backwards compat.
 833                             if (left)
 834                                 left = left+1;
 835                             else
 836                                 left = rts_argv[arg] + 3;
 837
 838                             if (!right)
 839                                 right = rts_argv[arg] + strlen(rts_argv[arg]);
 840
 841                             *right = '\0';
 842
 843                             switch (rts_argv[arg][2]) {
 844                             case 'c': // cost centre label select
 845                                 RtsFlags.ProfFlags.ccSelector = left;
 846                                 break;
 847                             case 'C':
 848                                 RtsFlags.ProfFlags.ccsSelector = left;
 849                                 break;
 850                             case 'M':
 851                             case 'm': // cost centre module select
 852                                 RtsFlags.ProfFlags.modSelector = left;
 853                                 break;
 854                             case 'D':
 855                             case 'd': // closure descr select
 856                                 RtsFlags.ProfFlags.descrSelector = left;
 857                                 break;
 858                             case 'Y':
 859                             case 'y': // closure type select
 860                                 RtsFlags.ProfFlags.typeSelector = left;
 861                                 break;
 862                             case 'R':
 863                             case 'r': // retainer select
 864                                 RtsFlags.ProfFlags.retainerSelector = left;
 865                                 break;
 866                             case 'B':
 867                             case 'b': // biography select
 868                                 RtsFlags.ProfFlags.bioSelector = left;
 869                                 break;
 870                             }
 871                         }
 872                         break;
 873                     }
 874
 875                     if (RtsFlags.ProfFlags.doHeapProfile != 0) {
 876                         errorBelch("multiple heap profile options");
 877                         error = rtsTrue;
 878                         break;
 879                     }
 880
 881                     switch (rts_argv[arg][2]) {
 882                     case '\0':
 883                     case 'C':
 884                     case 'c':
 885                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
 886                         break;
 887                     case 'M':
 888                     case 'm':
 889                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
 890                           break;
 891                     case 'D':
 892                     case 'd':
 893                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
 894                           break;
 895                     case 'Y':
 896                     case 'y':
 897                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
 898                           break;
 899                     case 'R':
 900                     case 'r':
 901                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
 902                           break;
 903                     case 'B':
 904                     case 'b':
 905                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
 906                           break;
 907                     }
 908                     break;
 909
 910                 default:
 911                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 912                     error = rtsTrue;
 913                 }
 914                 )
 915 #endif /* PROFILING */
 916                 break;
 917
 918               case 'i': /* heap sample interval */
 919                 if (rts_argv[arg][2] == '\0') {
 920                   /* use default */
 921                 } else {
 922                     I_ cst; /* tmp */
 923
 924                     /* Convert to milliseconds */
 925                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 926                     RtsFlags.ProfFlags.profileInterval = cst;
 927                 }
 928                 break;
 929
 930               /* =========== CONCURRENT ========================= */
 931               case 'C': /* context switch interval */
 932                 if (rts_argv[arg][2] == '\0')
 933                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
 934                 else {
 935                     I_ cst; /* tmp */
 936
 937                     /* Convert to milliseconds */
 938                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 939                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
 940                 }
 941                 break;
 942
 943               case 'V': /* master tick interval */
 944                 if (rts_argv[arg][2] == '\0') {
 945                     // turns off ticks completely
 946                     RtsFlags.MiscFlags.tickInterval = 0;
 947                 } else {
 948                     I_ cst; /* tmp */
 949
 950                     /* Convert to milliseconds */
 951                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 952                     RtsFlags.MiscFlags.tickInterval = cst;
 953                 }
 954                 break;
 955
 956 #if !defined(NOSMP)
 957               case 'N':
 958                 THREADED_BUILD_ONLY(
 959                 if (rts_argv[arg][2] == '\0') {
 960 #if defined(PROFILING)
 961                     RtsFlags.ParFlags.nNodes = 1;
 962 #else
 963                     RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
 964 #endif
 965                 } else {
 966                     RtsFlags.ParFlags.nNodes
 967                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
 968                     if (RtsFlags.ParFlags.nNodes <= 0) {
 969                       errorBelch("bad value for -N");
 970                       error = rtsTrue;
 971                     }
 972 #if defined(PROFILING)
 973                     if (RtsFlags.ParFlags.nNodes > 1) {
 974                         errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
 975                       error = rtsTrue;
 976                     }
 977 #endif
 978                 }
 979                 ) break;
 980
 981               case 'g':
 982                 THREADED_BUILD_ONLY(
 983                     switch (rts_argv[arg][2]) {
 984                     case '1':
 985                         // backwards compat only
 986                         RtsFlags.ParFlags.parGcEnabled = rtsFalse;
 987                         break;
 988                     default:
 989                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
 990                         error = rtsTrue;
 991                         break;
 992                     }
 993                     ) break;
 994
 995               case 'q':
 996                 THREADED_BUILD_ONLY(
 997                     switch (rts_argv[arg][2]) {
 998                     case '\0':
 999                         errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1000                         error = rtsTrue;
1001                         break;
1002                     case 'g':
1003                         if (rts_argv[arg][3] == '\0') {
1004                             RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1005                         } else {
1006                             RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1007                             RtsFlags.ParFlags.parGcGen
1008                                 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1009                         }
1010                         break;
1011                     case 'b':
1012                         if (rts_argv[arg][3] == '\0') {
1013                             RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1014                         }
1015                         else {
1016                             RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1017                             RtsFlags.ParFlags.parGcLoadBalancingGen
1018                                 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1019                         }
1020                         break;
1021                     case 'a':
1022                         RtsFlags.ParFlags.setAffinity = rtsTrue;
1023                         break;
1024                     case 'm':
1025                         RtsFlags.ParFlags.migrate = rtsFalse;
1026                         break;
1027                     case 'w':
1028                         RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1029                         break;
1030                     default:
1031                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
1032                         error = rtsTrue;
1033                         break;
1034                     }
1035                     ) break;
1036 #endif
1037               /* =========== PARALLEL =========================== */
1038               case 'e':
1039                 THREADED_BUILD_ONLY(
1040                 if (rts_argv[arg][2] != '\0') {
1041                     RtsFlags.ParFlags.maxLocalSparks
1042                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1043                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1044                       errorBelch("bad value for -e");
1045                       error = rtsTrue;
1046                     }
1047                 }
1048                 ) break;
1049
1050               /* =========== TICKY ============================== */
1051
1052               case 'r': /* Basic profiling stats */
1053                 TICKY_BUILD_ONLY(
1054
1055                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1056
1057                 {
1058                     int r;
1059                     r = open_stats_file(arg, *argc, argv,
1060                                         *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1061                                         &RtsFlags.TickyFlags.tickyFile);
1062                     if (r == -1) { error = rtsTrue; }
1063                 }
1064                 ) break;
1065
1066               /* =========== TRACING ---------=================== */
1067
1068               case 'l':
1069                   TRACING_BUILD_ONLY(
1070                       RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1071                       read_trace_flags(&rts_argv[arg][2]);
1072                       );
1073                   break;
1074
1075               case 'v':
1076                   DEBUG_BUILD_ONLY(
1077                       RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1078                       read_trace_flags(&rts_argv[arg][2]);
1079                       );
1080                   break;
1081
1082               /* =========== EXTENDED OPTIONS =================== */
1083
1084               case 'x': /* Extend the argument space */
1085                 switch(rts_argv[arg][2]) {
1086                   case '\0':
1087                     errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1088                     error = rtsTrue;
1089                     break;
1090
1091                 case 'b': /* heapBase in hex; undocumented */
1092                     if (rts_argv[arg][3] != '\0') {
1093                         RtsFlags.GcFlags.heapBase
1094                             = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1095                     } else {
1096                         errorBelch("-xb: requires argument");
1097                         error = rtsTrue;
1098                     }
1099                     break;
1100
1101 #if defined(x86_64_HOST_ARCH)
1102                 case 'm': /* linkerMemBase */
1103                     if (rts_argv[arg][3] != '\0') {
1104                         RtsFlags.MiscFlags.linkerMemBase
1105                             = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1106                         if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1107                             errorBelch("-xm: value must be <80000000");
1108                             error = rtsTrue;
1109                         }
1110                     } else {
1111                         RtsFlags.MiscFlags.linkerMemBase = 0;
1112                     }
1113                     break;
1114 #endif
1115
1116                 case 'c': /* Debugging tool: show current cost centre on an exception */
1117                     PROFILING_BUILD_ONLY(
1118                         RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1119                         );
1120                     break;
1121
1122                 case 't':  /* Include memory used by TSOs in a heap profile */
1123                     PROFILING_BUILD_ONLY(
1124                         RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1125                         );
1126                     break;
1127
1128                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
1129
1130                   default:
1131                     errorBelch("unknown RTS option: %s",rts_argv[arg]);
1132                     error = rtsTrue;
1133                     break;
1134                 }
1135                 break;  /* defensive programming */
1136
1137               /* =========== OH DEAR ============================ */
1138               default:
1139                 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1140                 error = rtsTrue;
1141                 break;
1142             }
1143         }
1144     }
1145
1146     if (RtsFlags.MiscFlags.tickInterval < 0) {
1147         RtsFlags.MiscFlags.tickInterval = 50;
1148     }
1149
1150     // If the master timer is disabled, turn off the other timers.
1151     if (RtsFlags.MiscFlags.tickInterval == 0) {
1152         RtsFlags.ConcFlags.ctxtSwitchTime  = 0;
1153         RtsFlags.GcFlags.idleGCDelayTime   = 0;
1154         RtsFlags.ProfFlags.profileInterval = 0;
1155     }
1156
1157     // Determine what tick interval we should use for the RTS timer
1158     // by taking the shortest of the various intervals that we need to
1159     // monitor.
1160     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1161         RtsFlags.MiscFlags.tickInterval =
1162             stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1163                     RtsFlags.MiscFlags.tickInterval);
1164     }
1165
1166     if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1167         RtsFlags.MiscFlags.tickInterval =
1168             stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1169                     RtsFlags.MiscFlags.tickInterval);
1170     }
1171
1172     if (RtsFlags.ProfFlags.profileInterval > 0) {
1173         RtsFlags.MiscFlags.tickInterval =
1174             stg_min(RtsFlags.ProfFlags.profileInterval,
1175                     RtsFlags.MiscFlags.tickInterval);
1176     }
1177
1178     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1179         RtsFlags.ConcFlags.ctxtSwitchTicks =
1180             RtsFlags.ConcFlags.ctxtSwitchTime /
1181             RtsFlags.MiscFlags.tickInterval;
1182     } else {
1183         RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1184     }
1185
1186     if (RtsFlags.ProfFlags.profileInterval > 0) {
1187         RtsFlags.ProfFlags.profileIntervalTicks =
1188             RtsFlags.ProfFlags.profileInterval /
1189             RtsFlags.MiscFlags.tickInterval;
1190     } else {
1191         RtsFlags.ProfFlags.profileIntervalTicks = 0;
1192     }
1193
1194     if (error) {
1195         const char **p;
1196
1197         fflush(stdout);
1198         for (p = usage_text; *p; p++)
1199             errorBelch("%s", *p);
1200         stg_exit(EXIT_FAILURE);
1201     }
1202 }
1203
1204
1205 static void
1206 stats_fprintf(FILE *f, char *s, ...)
1207 {
1208     va_list ap;
1209     va_start(ap,s);
1210     if (f == NULL) {
1211         vdebugBelch(s, ap);
1212     } else {
1213         vfprintf(f, s, ap);
1214     }
1215     va_end(ap);
1216 }
1217
1218 static int              /* return -1 on error */
1219 open_stats_file (
1220     I_ arg,
1221     int argc, char *argv[],
1222     int rts_argc, char *rts_argv[],
1223     const char *FILENAME_FMT,
1224     FILE **file_ret)
1225 {
1226     FILE *f = NULL;
1227
1228     if (strequal(rts_argv[arg]+2, "stderr")
1229         || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1230         f = NULL; /* NULL means use debugBelch */
1231     } else {
1232         if (rts_argv[arg][2] != '\0') {  /* stats file specified */
1233             f = fopen(rts_argv[arg]+2,"w");
1234         } else {
1235             char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1236             sprintf(stats_filename, FILENAME_FMT, argv[0]);
1237             f = fopen(stats_filename,"w");
1238         }
1239         if (f == NULL) {
1240             errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1241             return -1;
1242         }
1243     }
1244     *file_ret = f;
1245
1246     {
1247         /* Write argv and rtsv into start of stats file */
1248         int count;
1249         for(count = 0; count < argc; count++) {
1250             stats_fprintf(f, "%s ", argv[count]);
1251         }
1252         stats_fprintf(f, "+RTS ");
1253         for(count = 0; count < rts_argc; count++)
1254             stats_fprintf(f, "%s ", rts_argv[count]);
1255         stats_fprintf(f, "\n");
1256     }
1257     return 0;
1258 }
1259
1260
1261
1262 static StgWord64
1263 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1264 {
1265     char c;
1266     const char *s;
1267     StgDouble m;
1268     StgWord64 val;
1269
1270     s = flag + offset;
1271
1272     if (!*s)
1273     {
1274         m = 0;
1275     }
1276     else
1277     {
1278         m = atof(s);
1279         c = s[strlen(s)-1];
1280
1281         if (c == 'g' || c == 'G')
1282             m *= 1024*1024*1024;
1283         else if (c == 'm' || c == 'M')
1284             m *= 1024*1024;
1285         else if (c == 'k' || c == 'K')
1286             m *= 1024;
1287         else if (c == 'w' || c == 'W')
1288             m *= sizeof(W_);
1289     }
1290
1291     val = (StgWord64)m;
1292
1293     if (m < 0 || val < min || val > max) {
1294         // printf doesn't like 64-bit format specs on Windows
1295         // apparently, so fall back to unsigned long.
1296         errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1297         stg_exit(EXIT_FAILURE);
1298     }
1299
1300     return val;
1301 }
1302
1303 #if defined(TRACING)
1304 static void read_trace_flags(char *arg)
1305 {
1306     char *c;
1307
1308     for (c  = arg; *c != '\0'; c++) {
1309         switch(*c) {
1310         case '\0':
1311             break;
1312         case 's':
1313             RtsFlags.TraceFlags.scheduler = rtsTrue;
1314             break;
1315         case 't':
1316             RtsFlags.TraceFlags.timestamp = rtsTrue;
1317             break;
1318         case 'g':
1319             // ignored for backwards-compat
1320             break;
1321         default:
1322             errorBelch("unknown trace option: %c",*c);
1323             break;
1324         }
1325     }
1326 }
1327 #endif
1328
1329 static void GNU_ATTRIBUTE(__noreturn__)
1330 bad_option(const char *s)
1331 {
1332   errorBelch("bad RTS option: %s", s);
1333   stg_exit(EXIT_FAILURE);
1334 }
1335
1336 /* -----------------------------------------------------------------------------
1337    Getting/Setting the program's arguments.
1338
1339    These are used by System.Environment, and parts of the RTS.
1340    -------------------------------------------------------------------------- */
1341
1342 void
1343 setProgName(char *argv[])
1344 {
1345     /* Remove directory from argv[0] -- default files in current directory */
1346 #if !defined(mingw32_HOST_OS)
1347     char *last_slash;
1348     if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1349         prog_name = last_slash+1;
1350    } else {
1351         prog_name = argv[0];
1352    }
1353 #else
1354     char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1355     while ( last_slash > argv[0] ) {
1356         if ( *last_slash == '/' || *last_slash == '\\' ) {
1357             prog_name = last_slash+1;
1358             return;
1359         }
1360         last_slash--;
1361     }
1362     prog_name = argv[0];
1363 #endif
1364 }
1365
1366 void
1367 getProgArgv(int *argc, char **argv[])
1368 {
1369     if (argc) { *argc = prog_argc; }
1370     if (argv) { *argv = prog_argv; }
1371 }
1372
1373 void
1374 setProgArgv(int argc, char *argv[])
1375 {
1376    /* Usually this is done by startupHaskell, so we don't need to call this.
1377       However, sometimes Hugs wants to change the arguments which Haskell
1378       getArgs >>= ... will be fed.  So you can do that by calling here
1379       _after_ calling startupHaskell.
1380    */
1381    prog_argc = argc;
1382    prog_argv = argv;
1383    setProgName(prog_argv);
1384 }
1385
1386 /* These functions record and recall the full arguments, including the
1387    +RTS ... -RTS options. The reason for adding them was so that the
1388    ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1389 void
1390 getFullProgArgv(int *argc, char **argv[])
1391 {
1392     if (argc) { *argc = full_prog_argc; }
1393     if (argv) { *argv = full_prog_argv; }
1394 }
1395
1396 void
1397 setFullProgArgv(int argc, char *argv[])
1398 {
1399     int i;
1400     full_prog_argc = argc;
1401     full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1402                                     "setFullProgArgv 1");
1403     for (i = 0; i < argc; i++) {
1404         full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1405                                            "setFullProgArgv 2");
1406         strcpy(full_prog_argv[i], argv[i]);
1407     }
1408     full_prog_argv[argc] = NULL;
1409 }
1410
1411 void
1412 freeFullProgArgv (void)
1413 {
1414     int i;
1415
1416     if (full_prog_argv != NULL) {
1417         for (i = 0; i < full_prog_argc; i++) {
1418             stgFree(full_prog_argv[i]);
1419         }
1420         stgFree(full_prog_argv);
1421     }
1422
1423     full_prog_argc = 0;
1424     full_prog_argv = NULL;
1425 }