rts/RtsFlags.c

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