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