RtsFlags.c 50.1 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2 3
 *
 * (c) The AQUA Project, Glasgow University, 1994-1997
Simon Marlow's avatar
Simon Marlow committed
4
 * (c) The GHC Team, 1998-2006
5 6 7 8 9
 *
 * Functions for parsing the argument list.
 *
 * ---------------------------------------------------------------------------*/

10
#include "PosixSource.h"
11
#include "Rts.h"
Simon Marlow's avatar
Simon Marlow committed
12

13
#include "RtsOpts.h"
14
#include "RtsUtils.h"
15
#include "Profiling.h"
16
#include "RtsFlags.h"
17

18 19
#ifdef HAVE_CTYPE_H
#include <ctype.h>
20 21
#endif

22 23
#include <string.h>

24 25
// Flag Structure
RTS_FLAGS RtsFlags;
26 27 28 29

/*
 * Split argument lists
 */
sof's avatar
sof committed
30
int     prog_argc = 0;    /* an "int" so as to match normal "argc" */
31
char  **prog_argv = NULL;
32 33
int     full_prog_argc = 0;    /* an "int" so as to match normal "argc" */
char  **full_prog_argv = NULL;
sof's avatar
sof committed
34
char   *prog_name = NULL; /* 'basename' of prog_argv[0] */
35
int     rts_argc = 0;  /* ditto */
36
char  **rts_argv = NULL;
37 38 39 40 41 42 43 44
#if defined(mingw32_HOST_OS)
// On Windows, we want to use GetCommandLineW rather than argc/argv,
// but we need to mutate the command line arguments for withProgName and
// friends. The System.Environment module achieves that using this bit of
// shared state:
int       win32_prog_argc = 0;
wchar_t **win32_prog_argv = NULL;
#endif
45 46 47 48 49 50 51 52 53 54 55

/*
 * constants, used later 
 */
#define RTS 1
#define PGM 0

/* -----------------------------------------------------------------------------
   Static function decls
   -------------------------------------------------------------------------- */

56 57 58 59 60 61 62 63 64 65 66 67 68
static void procRtsOpts      (int rts_argc0, RtsOptsEnabledEnum enabled);

static void normaliseRtsOpts (void);

static void initStatsFile    (FILE *f);

static int  openStatsFile    (char *filename, const char *FILENAME_FMT,
                              FILE **file_ret);

static StgWord64 decodeSize  (const char *flag, nat offset,
                              StgWord64 min, StgWord64 max);

static void bad_option       (const char *s);
69

70 71 72
#ifdef TRACING
static void read_trace_flags(char *arg);
#endif
73

74 75
static void errorUsage      (void) GNU_ATTRIBUTE(__noreturn__);

76 77 78 79
static char *  copyArg  (char *arg);
static char ** copyArgv (int argc, char *argv[]);
static void    freeArgv (int argc, char *argv[]);

80 81 82 83 84 85 86 87 88
/* -----------------------------------------------------------------------------
 * Command-line option parsing routines.
 * ---------------------------------------------------------------------------*/

void initRtsFlagsDefaults(void)
{
    RtsFlags.GcFlags.statsFile		= NULL;
    RtsFlags.GcFlags.giveStats		= NO_GC_STATS;

89
    RtsFlags.GcFlags.maxStkSize		= (8 * 1024 * 1024) / sizeof(W_);
90
    RtsFlags.GcFlags.initialStkSize	= 1024 / sizeof(W_);
91 92
    RtsFlags.GcFlags.stkChunkSize       = (32 * 1024) / sizeof(W_);
    RtsFlags.GcFlags.stkChunkBufferSize = (1 * 1024) / sizeof(W_);
93

94
    RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
95
    RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
96
    RtsFlags.GcFlags.maxHeapSize	= 0;    /* off by default */
97
    RtsFlags.GcFlags.heapSizeSuggestion	= 0;    /* none */
98
    RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
99
    RtsFlags.GcFlags.pcFreeHeap		= 3;	/* 3% */
100
    RtsFlags.GcFlags.oldGenFactor       = 2;
101
    RtsFlags.GcFlags.generations        = 2;
102
    RtsFlags.GcFlags.squeezeUpdFrames	= rtsTrue;
103
    RtsFlags.GcFlags.compact            = rtsFalse;
104
    RtsFlags.GcFlags.compactThreshold   = 30.0;
105
    RtsFlags.GcFlags.sweep              = rtsFalse;
106 107 108
#ifdef RTS_GTK_FRONTPANEL
    RtsFlags.GcFlags.frontpanel         = rtsFalse;
#endif
109
    RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
110

111 112 113 114 115 116 117 118 119 120 121 122
#if osf3_HOST_OS
/* ToDo: Perhaps by adjusting this value we can make linking without
 * -static work (i.e., not generate a core-dumping executable)? */
# if SIZEOF_VOID_P == 8
    RtsFlags.GcFlags.heapBase           = 0x180000000L;
# else
#  error I have no idea where to begin the heap on a non-64-bit osf3 machine.
# endif
#else
    RtsFlags.GcFlags.heapBase           = 0;   /* means don't care */
#endif

123 124
#ifdef DEBUG
    RtsFlags.DebugFlags.scheduler	= rtsFalse;
125
    RtsFlags.DebugFlags.interpreter	= rtsFalse;
126 127 128 129 130 131
    RtsFlags.DebugFlags.weak		= rtsFalse;
    RtsFlags.DebugFlags.gccafs		= rtsFalse;
    RtsFlags.DebugFlags.gc		= rtsFalse;
    RtsFlags.DebugFlags.block_alloc	= rtsFalse;
    RtsFlags.DebugFlags.sanity		= rtsFalse;
    RtsFlags.DebugFlags.stable		= rtsFalse;
132
    RtsFlags.DebugFlags.stm             = rtsFalse;
133
    RtsFlags.DebugFlags.prof		= rtsFalse;
134
    RtsFlags.DebugFlags.apply		= rtsFalse;
135
    RtsFlags.DebugFlags.linker		= rtsFalse;
136
    RtsFlags.DebugFlags.squeeze		= rtsFalse;
137
    RtsFlags.DebugFlags.hpc		= rtsFalse;
138
    RtsFlags.DebugFlags.sparks		= rtsFalse;
139 140
#endif

Simon Marlow's avatar
Simon Marlow committed
141
#if defined(PROFILING)
142
    RtsFlags.CcFlags.doCostCentres	= 0;
Simon Marlow's avatar
Simon Marlow committed
143
#endif /* PROFILING */
144

145
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
146
    RtsFlags.ProfFlags.profileInterval    = 100;
147 148

#ifdef PROFILING
149
    RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
150
    RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
151
    RtsFlags.ProfFlags.maxRetainerSetSize = 8;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
152
    RtsFlags.ProfFlags.ccsLength          = 25;
153 154 155 156
    RtsFlags.ProfFlags.modSelector        = NULL;
    RtsFlags.ProfFlags.descrSelector      = NULL;
    RtsFlags.ProfFlags.typeSelector       = NULL;
    RtsFlags.ProfFlags.ccSelector         = NULL;
157
    RtsFlags.ProfFlags.ccsSelector        = NULL;
158 159
    RtsFlags.ProfFlags.retainerSelector   = NULL;
    RtsFlags.ProfFlags.bioSelector        = NULL;
160 161
#endif

162
#ifdef TRACING
163
    RtsFlags.TraceFlags.tracing       = TRACE_NONE;
164 165
    RtsFlags.TraceFlags.timestamp     = rtsFalse;
    RtsFlags.TraceFlags.scheduler     = rtsFalse;
166
    RtsFlags.TraceFlags.sparks        = rtsFalse;
Simon Marlow's avatar
Simon Marlow committed
167 168
#endif

169 170
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 20;  /* In milliseconds */
171

172
    RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
Ian Lynagh's avatar
Ian Lynagh committed
173
    RtsFlags.MiscFlags.machineReadable = rtsFalse;
174
    RtsFlags.MiscFlags.linkerMemBase    = 0;
175

176
#ifdef THREADED_RTS
177
    RtsFlags.ParFlags.nNodes	        = 1;
178
    RtsFlags.ParFlags.migrate           = rtsTrue;
179
    RtsFlags.ParFlags.parGcEnabled      = 1;
180 181 182
    RtsFlags.ParFlags.parGcGen          = 0;
    RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
    RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
183
    RtsFlags.ParFlags.setAffinity       = 0;
184
#endif
185

Simon Marlow's avatar
Simon Marlow committed
186
#if defined(THREADED_RTS)
187
    RtsFlags.ParFlags.maxLocalSparks	= 4096;
Simon Marlow's avatar
Simon Marlow committed
188
#endif /* THREADED_RTS */
189 190

#ifdef TICKY_TICKY
191 192
    RtsFlags.TickyFlags.showTickyStats	 = rtsFalse;
    RtsFlags.TickyFlags.tickyFile	 = NULL;
193
#endif
Simon Marlow's avatar
Simon Marlow committed
194

195
#ifdef USE_PAPI
196 197
    /* By default no special measurements taken */
    RtsFlags.PapiFlags.eventType        = 0;
198
    RtsFlags.PapiFlags.numUserEvents    = 0;
199
#endif
200 201 202 203 204 205 206 207 208 209 210 211 212 213
}

static const char *
usage_text[] = {
"",
"Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
"",
"   +RTS    Indicates run time system options follow",
"   -RTS    Indicates program arguments follow",
"  --RTS    Indicates that ALL subsequent arguments will be given to the",
"           program (including any of these RTS flags)",
"",
"The following run time system options are available:",
"",
214
"  -?       Prints this message and exits; the program is not executed",
215
"  --info   Print information about the RTS used by this program",
216
"",
217
"  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
218 219 220
"  -ki<size> Sets the initial thread stack size (default 1k)  Egs: -ki4k -ki2m",
"  -kc<size> Sets the stack chunk size (default 32k)",
"  -kb<size> Sets the stack chunk buffer size (default 1k)",
221
"",
222
"  -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
223
"  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
224
"  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
225
"  -m<n>    Minimum % of heap which must be available (default 3%)",
226
"  -G<n>    Number of generations (default: 2)",
227 228 229 230 231
"  -c<n>    Use in-place compaction instead of copying in the oldest generation",
"           when live data is at least <n>% of the maximum heap size set with",
"           -M (default: 30%)",
"  -c       Use in-place compaction for all oldest generation collections",
"           (the default is to use copying)",
232
"  -w       Use mark-region for the oldest generation (experimental)",
233
#if defined(THREADED_RTS)
234 235
"  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
#endif
236
"",
237 238 239
"  -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
"  -s[<file>] Summary  GC statistics (if <file> omitted, uses stderr)",
"  -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
240 241 242
#ifdef RTS_GTK_FRONTPANEL
"  -f       Display front panel (requires X11 & GTK+)",
#endif
243 244 245 246
"",
"",
"  -Z       Don't squeeze out update frames on stack overflow",
"  -B       Sound the bell at the start of each garbage collection",
Simon Marlow's avatar
Simon Marlow committed
247
#if defined(PROFILING)
248
"",
249
"  -px      Time/allocation profile (XML)  (output file <program>.prof)",
andy's avatar
andy committed
250 251 252
"  -p       Time/allocation profile        (output file <program>.prof)",
"  -P       More detailed Time/Allocation profile",
"  -Pa      Give information about *all* cost centres",
253

254 255
# if defined(PROFILING)
"",
256 257 258 259 260 261 262 263
"  -hx            Heap residency profile (XML)   (output file <program>.prof)",
"  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
"     break-down: c = cost centre stack (default)",
"                 m = module",
"                 d = closure description",
"                 y = type description",
"                 r = retainer",
"                 b = biography (LAG,DRAG,VOID,USE)",
264
"  A subset of closures may be selected thusly:",
265 266
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
267 268 269 270 271
"    -hm<mod>...  all cost centres from the specified modules(s)",
"    -hd<des>,... closures with specified closure descriptions",
"    -hy<typ>...  closures with specified type descriptions",
"    -hr<cc>...   closures with specified retainers",
"    -hb<bio>...  closures with specified biographies (lag,drag,void,use)",
272 273
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
274 275 276
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
277
"",
278 279
"  -xt            Include threads (TSOs) in a heap profile",
"",
280
"  -xc      Show current cost centre stack on raising an exception",
281 282
# endif
#endif /* PROFILING or PAR */
Simon Marlow's avatar
Simon Marlow committed
283

284
#ifdef TRACING
Simon Marlow's avatar
Simon Marlow committed
285
"",
286 287 288 289 290 291
"  -l[flags]  Log events in binary format to the file <program>.eventlog",
#  ifdef DEBUG
"  -v[flags]  Log events to stderr",
#  endif
"             where [flags] can contain:",
"                s    scheduler events",
292
"                p    par spark events",
293 294 295
#  ifdef DEBUG
"                t    add time stamps (only useful with -v)",
#  endif
Simon Marlow's avatar
Simon Marlow committed
296 297
#endif

298
#if !defined(PROFILING)
299
"",
300
"  -hT      Heap residency profile (output file <program>.hp)",
301
#endif
302
"  -i<sec>  Time between heap samples (seconds, default: 0.1)",
303 304
"",
#if defined(TICKY_TICKY)
305
"  -r<file>  Produce ticky-ticky statistics (with -rstderr for stderr)",
306 307
"",
#endif
308 309 310
"  -C<secs>  Context-switch interval in seconds.",
"            0 or no argument means switch as often as possible.",
"            Default: 0.02 sec; resolution is set by -V below.",
311
"  -V<secs>  Master tick interval in seconds (0 == disable timer).",
312 313
"            This sets the resolution for -C and the profile timer -i.",
"            Default: 0.02 sec.",
314 315 316
"",
#if defined(DEBUG)
"  -Ds  DEBUG: scheduler",
317
"  -Di  DEBUG: interpreter",
318 319 320 321 322 323 324
"  -Dw  DEBUG: weak",
"  -DG  DEBUG: gccafs",
"  -Dg  DEBUG: gc",
"  -Db  DEBUG: block",
"  -DS  DEBUG: sanity",
"  -Dt  DEBUG: stable",
"  -Dp  DEBUG: prof",
Simon Marlow's avatar
Simon Marlow committed
325
"  -De  DEBUG: event logging",
326
"  -Da  DEBUG: apply",
327
"  -Dl  DEBUG: linker",
328
"  -Dm  DEBUG: stm",
Simon Marlow's avatar
Simon Marlow committed
329
"  -Dz  DEBUG: stack squeezing",
330
"  -Dc  DEBUG: program coverage",
331 332
"  -Dr  DEBUG: sparks",
"",
333
"     NOTE: DEBUG events are sent to stderr by default; add -l to create a",
334
"     binary event log file instead.",
335
"",
336
#endif /* DEBUG */
337
#if defined(THREADED_RTS) && !defined(NOSMP)
338 339
"  -N<n>     Use <n> processors (default: 1)",
"  -N        Determine the number of processors to use automatically",
340 341 342 343 344
"  -qg[<n>]  Use parallel GC only for generations >= <n>",
"            (default: 0, -qg alone turns off parallel GC)",
"  -qb[<n>]  Use load-balancing in the parallel GC only for generations >= <n>",
"            (default: 1, -qb alone turns off load-balancing)",
"  -qa       Use the OS to set thread affinity (experimental)",
345
"  -qm       Don't automatically migrate threads between CPUs",
346
#endif
347 348
"  --install-signal-handlers=<yes|no>",
"            Install signal handlers (default: yes)",
Simon Marlow's avatar
Simon Marlow committed
349
#if defined(THREADED_RTS)
350 351
"  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
#endif
352 353 354 355
#if defined(x86_64_HOST_ARCH)
"  -xm       Base address to mmap memory in the GHCi linker",
"            (hex; must be <80000000)",
#endif
356
#if defined(USE_PAPI)
357 358
"  -aX       CPU performance counter measurements using PAPI",
"            (use with the -s<file> option).  X is one of:",
359 360 361 362 363 364
"",
/* "            y - cycles", */
"            1 - level 1 cache misses",
"            2 - level 2 cache misses",
"            b - branch mispredictions",
"            s - stalled cycles",
365
"            e - cache miss and branch misprediction events",
366 367
"            +PAPI_EVENT   - collect papi preset event PAPI_EVENT",
"            #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
368
#endif
369
"",
370 371
"RTS options may also be specified using the GHCRTS environment variable.",
"",
372 373 374 375 376 377
"Other RTS options may be available for programs compiled a different way.",
"The GHC User's Guide has full details.",
"",
0
};

sof's avatar
sof committed
378
STATIC_INLINE rtsBool
379 380 381 382 383
strequal(const char *a, const char * b)
{
    return(strcmp(a, b) == 0);
}

384
static void splitRtsFlags(char *s)
385 386 387 388 389 390 391 392 393 394 395
{
    char *c1, *c2;

    c1 = s;
    do {
	while (isspace(*c1)) { c1++; };
	c2 = c1;
	while (!isspace(*c2) && *c2 != '\0') { c2++; };
	
	if (c1 == c2) { break; }
	
396 397 398 399 400
        s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
        strncpy(s, c1, c2-c1);
        s[c2-c1] = '\0';
        rts_argv[rts_argc++] = s;

401 402 403 404
	c1 = c2;
    } while (*c1 != '\0');
}
    
405 406 407 408 409 410 411
/* -----------------------------------------------------------------------------
   Parse the command line arguments, collecting options for the RTS.

   On return:
     - argv[] is *modified*, any RTS options have been stripped out
     - *argc  contains the new count of arguments in argv[]

412
     - rts_argv[]  (global) contains a copy of the collected RTS args
413 414
     - rts_argc    (global) contains the count of args in rts_argv

415
     - prog_argv[] (global) contains a copy of the non-RTS args (== argv)
416 417
     - prog_argc   (global) contains the count of args in prog_argv

418
     - prog_name   (global) contains the basename of prog_argv[0]
419 420 421 422

  -------------------------------------------------------------------------- */

void setupRtsFlags (int *argc, char *argv[])
423
{
424 425 426
    nat mode;
    nat total_arg;
    nat arg, rts_argc0;
427

428
    setProgName (argv);
429 430 431 432
    total_arg = *argc;
    arg = 1;

    *argc = 1;
433 434
    rts_argc = 0;

435 436
    rts_argv = stgCallocBytes(total_arg + 1, sizeof (char *), "setupRtsFlags");

437
    rts_argc0 = rts_argc;
438

439 440 441 442 443
    // process arguments from the ghc_rts_opts global variable first.
    // (arguments from the GHCRTS environment variable and the command
    // line override these).
    {
	if (ghc_rts_opts != NULL) {
444 445 446 447 448
            splitRtsFlags(ghc_rts_opts);
            // opts from ghc_rts_opts are always enabled:
            procRtsOpts(rts_argc0, RtsOptsAll);
            rts_argc0 = rts_argc;
        }
449 450
    }

451
    // process arguments from the GHCRTS environment variable next
452
    // (arguments from the command line override these).
453 454 455 456
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
457
            if (rtsOptsEnabled == RtsOptsNone) {
458
                errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n         Link with -rtsopts to enable them.");
459
                // We don't actually exit, just warn
460 461 462 463
            } else {
                splitRtsFlags(ghc_rts);
                procRtsOpts(rts_argc0, rtsOptsEnabled);
                rts_argc0 = rts_argc;
464
            }
465
        }
466
    }
467

468 469 470
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

471 472 473 474 475 476 477 478 479 480 481 482
    for (mode = PGM; arg < total_arg; arg++) {
	// The '--RTS' argument disables all future +RTS ... -RTS processing.
	if (strequal("--RTS", argv[arg])) {
	    arg++;
	    break;
	}
	// The '--' argument is passed through to the program, but
	// disables all further +RTS ... -RTS processing.
	else if (strequal("--", argv[arg])) {
	    break;
	}
	else if (strequal("+RTS", argv[arg])) {
483 484
            mode = RTS;
        }
485 486 487
	else if (strequal("-RTS", argv[arg])) {
	    mode = PGM;
	}
488 489
        else if (mode == RTS) {
            rts_argv[rts_argc++] = copyArg(argv[arg]);
Ian Lynagh's avatar
Ian Lynagh committed
490
        }
491 492
        else {
            argv[(*argc)++] = argv[arg];
493 494
	}
    }
495 496 497
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
498 499
    }
    argv[*argc] = (char *) 0;
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
    rts_argv[rts_argc] = (char *) 0;

    procRtsOpts(rts_argc0, rtsOptsEnabled);

    normaliseRtsOpts();

    setProgArgv(*argc, argv);

    if (RtsFlags.GcFlags.statsFile != NULL) {
        initStatsFile (RtsFlags.GcFlags.statsFile);
    }
    if (RtsFlags.TickyFlags.tickyFile != NULL) {
        initStatsFile (RtsFlags.GcFlags.statsFile);
    }
}

/* -----------------------------------------------------------------------------
 * procRtsOpts: Process rts_argv between rts_argc0 and rts_argc.
 * -------------------------------------------------------------------------- */

static void procRtsOpts (int rts_argc0, RtsOptsEnabledEnum enabled)
{
    rtsBool error = rtsFalse;
    int arg;
524 525

    // Process RTS (rts_argv) part: mainly to determine statsfile
526 527
    for (arg = rts_argc0; arg < rts_argc; arg++) {
        if (rts_argv[arg][0] != '-') {
528
	    fflush(stdout);
529
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
530 531 532
	    error = rtsTrue;

        } else {
Simon Marlow's avatar
Simon Marlow committed
533

534 535 536 537 538
            if (enabled == RtsOptsNone) {
                errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
                stg_exit(EXIT_FAILURE);
            }

Simon Marlow's avatar
Simon Marlow committed
539 540 541 542 543 544 545 546 547 548 549
            switch(rts_argv[arg][1]) {
            case '-':
                if (strequal("info", &rts_argv[arg][2])) {
                    printRtsInfo();
                    stg_exit(0);
                }
                break;
            default:
                break;
            }

550
            if (enabled == RtsOptsSafeOnly) {
Simon Marlow's avatar
Simon Marlow committed
551 552 553 554 555
                errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
                stg_exit(EXIT_FAILURE);
            }

            switch(rts_argv[arg][1]) {
556

Simon Marlow's avatar
Simon Marlow committed
557 558 559 560 561
	      /* process: general args, then PROFILING-only ones, then
		 CONCURRENT-only, TICKY-only (same order as defined in
		 RtsFlags.lh); within those groups, mostly in
		 case-insensitive alphabetical order.  Final group is
		 x*, which allows for more options.
562 563 564 565 566 567
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
568
errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
569 570 571 572 573 574 575
error = rtsTrue;
#endif

#ifdef PROFILING
# define PROFILING_BUILD_ONLY(x)   x
#else
# define PROFILING_BUILD_ONLY(x) \
576
errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
577 578 579
error = rtsTrue;
#endif

580 581
#ifdef TRACING
# define TRACING_BUILD_ONLY(x)   x
Simon Marlow's avatar
Simon Marlow committed
582
#else
583
# define TRACING_BUILD_ONLY(x) \
584
errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
Simon Marlow's avatar
Simon Marlow committed
585 586 587
error = rtsTrue;
#endif

588 589 590 591
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
592 593 594 595 596 597 598 599 600
errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
error = rtsTrue;
#endif

#ifdef DEBUG
# define DEBUG_BUILD_ONLY(x) x
#else
# define DEBUG_BUILD_ONLY(x) \
errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
601
error = rtsTrue;
602 603 604 605 606 607 608
#endif

	      /* =========== GENERAL ========================== */
	      case '?':
		error = rtsTrue;
		break;

609 610 611 612 613 614 615 616 617 618 619 620
              /* This isn't going to allow us to keep related options
                 together as we add more --* flags. We really need a
                 proper options parser. */
	      case '-':
                  if (strequal("install-signal-handlers=yes",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
                  }
                  else if (strequal("install-signal-handlers=no",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
                  }
Ian Lynagh's avatar
Ian Lynagh committed
621 622 623 624
                  else if (strequal("machine-readable",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.machineReadable = rtsTrue;
                  }
625 626
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
627
                      printRtsInfo();
628
                      stg_exit(0);
629
                  }
630 631 632 633 634
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
635
	      case 'A':
636 637 638 639
                  RtsFlags.GcFlags.minAllocAreaSize
                      = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
                           / BLOCK_SIZE;
                  break;
640

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
#ifdef USE_PAPI
	      case 'a':
		switch(rts_argv[arg][2]) {
		case '1':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
		  break;
		case '2':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
		  break;
		case 'b':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
		  break;
		case 's':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
		  break;
656 657 658
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
659
                case '+':
660
                case '#':
661 662 663 664
                  if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
                      errorBelch("maximum number of PAPI events reached");
                      stg_exit(EXIT_FAILURE);
                  }
665 666 667 668 669
                  nat eventNum  = RtsFlags.PapiFlags.numUserEvents++;
                  char kind     = rts_argv[arg][2];
                  nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;

                  RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
670
                  RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
671
                  RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
672
                  break;
673 674 675 676 677 678
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

679 680 681 682
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

683
	      case 'c':
684 685 686 687
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
688
		      RtsFlags.GcFlags.compact = rtsTrue;
689 690
		  }
		  break;
691

692 693 694 695
              case 'w':
		RtsFlags.GcFlags.sweep = rtsTrue;
		break;

696 697 698 699 700 701 702
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
703
	      case 'D':
704
              DEBUG_BUILD_ONLY(
705 706 707 708 709 710 711 712
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
713 714
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
			  break;
		      case 'w':
			  RtsFlags.DebugFlags.weak = rtsTrue;
			  break;
		      case 'G':
			  RtsFlags.DebugFlags.gccafs = rtsTrue;
			  break;
		      case 'g':
			  RtsFlags.DebugFlags.gc = rtsTrue;
			  break;
		      case 'b':
			  RtsFlags.DebugFlags.block_alloc = rtsTrue;
			  break;
		      case 'S':
			  RtsFlags.DebugFlags.sanity = rtsTrue;
			  break;
		      case 't':
			  RtsFlags.DebugFlags.stable = rtsTrue;
			  break;
		      case 'p':
			  RtsFlags.DebugFlags.prof = rtsTrue;
			  break;
		      case 'l':
			  RtsFlags.DebugFlags.linker = rtsTrue;
			  break;
740 741 742
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
743 744 745
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
746 747 748
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
749 750 751
		      case 'c':
			  RtsFlags.DebugFlags.hpc = rtsTrue;
			  break;
752 753 754
		      case 'r':
			  RtsFlags.DebugFlags.sparks = rtsTrue;
			  break;
755 756 757 758
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
759 760
                  // -Dx also turns on -v.  Use -l to direct trace
                  // events to the .eventlog file instead.
761
                  RtsFlags.TraceFlags.tracing = TRACE_STDERR;
762 763
	      })
              break;
764 765

	      case 'K':
766
                  RtsFlags.GcFlags.maxStkSize =
767
                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
768
                  break;
769 770

	      case 'k':
771 772 773 774 775 776 777 778 779 780 781 782 783 784
		switch(rts_argv[arg][2]) {
                case 'c':
                  RtsFlags.GcFlags.stkChunkSize =
                      decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
                  break;
                case 'b':
                  RtsFlags.GcFlags.stkChunkBufferSize =
                      decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
                  break;
                case 'i':
                  RtsFlags.GcFlags.initialStkSize =
                      decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
                  break;
                default:
785
                  RtsFlags.GcFlags.initialStkSize =
786
                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
787
                  break;
788 789
                }
                break;
790

791
              case 'M':
792 793 794 795
                  RtsFlags.GcFlags.maxHeapSize =
                      decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
                  /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
                  break;
796 797

	      case 'm':
798
                  RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
799

800 801 802 803
                  if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
                      RtsFlags.GcFlags.pcFreeHeap > 100)
                      bad_option( rts_argv[arg] );
                  break;
804

805
	      case 'G':
806 807 808
                  RtsFlags.GcFlags.generations =
                      decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
                  break;
809

810
	      case 'H':
811 812 813 814 815 816 817
                  if (rts_argv[arg][2] == '\0') {
                      RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
                  } else {
                      RtsFlags.GcFlags.heapSizeSuggestion =
                          (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
                  }
                  break;
818

819 820 821 822 823 824
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

825 826 827 828 829 830
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

831
		    /* Convert to millisecs */
832
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
833
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
834 835 836
		}
		break;

837
	      case 'S':
838 839
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
840

841
	      case 's':
842 843
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
844 845

	      case 't':
846 847
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
848

849
	    stats:
850 851
		{ 
		    int r;
852 853
                    r = openStatsFile(rts_argv[arg]+2, NULL,
                                      &RtsFlags.GcFlags.statsFile);
854 855
		    if (r == -1) { error = rtsTrue; }
		}
Simon Marlow's avatar
Simon Marlow committed
856
                break;
857 858 859 860 861 862 863 864 865

	      case 'Z':
		RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
		break;

	      /* =========== PROFILING ========================== */

	      case 'P': /* detailed cost centre profiling (time/alloc) */
	      case 'p': /* cost centre profiling (time/alloc) */
Simon Marlow's avatar
Simon Marlow committed
866
		PROFILING_BUILD_ONLY(
867
		switch (rts_argv[arg][2]) {
868 869
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
870
		    break;
andy's avatar
andy committed
871 872 873
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
874
		  default:
875 876 877 878 879 880 881 882
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
883 884 885
		}
		) break;

886 887 888 889
	      case 'R':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
  	          ) break;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
890 891 892 893 894 895 896
	      case 'L':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
                      if(RtsFlags.ProfFlags.ccsLength <= 0) {
			bad_option(rts_argv[arg]);
                      }
		  ) break;
897
	      case 'h': /* serial heap profile */
898
#if !defined(PROFILING)
899 900 901 902 903 904
		switch (rts_argv[arg][2]) {
		  case '\0':
		  case 'T':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
		    break;
		  default:
905
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
906 907 908 909 910
		    error = rtsTrue;
		}
#else
		PROFILING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
		case '\0':
		case 'C':
		case 'c':
		case 'M':
		case 'm':
		case 'D':
		case 'd':
		case 'Y':
		case 'y':
		case 'R':
		case 'r':
		case 'B':
		case 'b':
		    if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
			{
			    char *left  = strchr(rts_argv[arg], '{');
			    char *right = strrchr(rts_argv[arg], '}');
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944

			    // curly braces are optional, for
			    // backwards compat.
			    if (left)
				left = left+1;
			    else
				left = rts_argv[arg] + 3;

			    if (!right)
				right = rts_argv[arg] + strlen(rts_argv[arg]);

			    *right = '\0';

			    switch (rts_argv[arg][2]) {
			    case 'c': // cost centre label select
				RtsFlags.ProfFlags.ccSelector = left;
				break;
945 946 947
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
			    case 'M':
			    case 'm': // cost centre module select
				RtsFlags.ProfFlags.modSelector = left;
				break;
			    case 'D':
			    case 'd': // closure descr select 
				RtsFlags.ProfFlags.descrSelector = left;
				break;
			    case 'Y':
			    case 'y': // closure type select
				RtsFlags.ProfFlags.typeSelector = left;
				break;
			    case 'R':
			    case 'r': // retainer select
				RtsFlags.ProfFlags.retainerSelector = left;
				break;
			    case 'B':
			    case 'b': // biography select
				RtsFlags.ProfFlags.bioSelector = left;
				break;
968 969 970 971
			    }
			}
			break;
		    }
972

973
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
974
			errorBelch("multiple heap profile options");
975 976 977 978 979 980 981 982 983 984 985 986
			error = rtsTrue;
			break;
		    }

		    switch (rts_argv[arg][2]) {
		    case '\0':
		    case 'C':
		    case 'c':
			RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
			break;
		    case 'M':
		    case 'm':
987 988
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
989 990
		    case 'D':
		    case 'd':
991 992
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
			  break;
993 994
		    case 'Y':
		    case 'y':
995 996
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
			  break;
997 998
		    case 'R':
		    case 'r':
999 1000
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
			  break;
1001 1002
		    case 'B':
		    case 'b':
1003 1004
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
			  break;