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