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