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