RtsFlags.c 51 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.gc            = rtsFalse;
167 168
    RtsFlags.TraceFlags.sparks_sampled= rtsFalse;
    RtsFlags.TraceFlags.sparks_full   = rtsFalse;
Simon Marlow's avatar
Simon Marlow committed
169 170
#endif

171 172
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 20;  /* In milliseconds */
173

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

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

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

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

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

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:",
"",
216
"  -?       Prints this message and exits; the program is not executed",
217
"  --info   Print information about the RTS used by this program",
218
"",
219
"  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
220 221 222
"  -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)",
223
"",
224
"  -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
225
"  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
226
"  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
227
"  -m<n>    Minimum % of heap which must be available (default 3%)",
228
"  -G<n>    Number of generations (default: 2)",
229 230 231 232 233
"  -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)",
234
"  -w       Use mark-region for the oldest generation (experimental)",
235
#if defined(THREADED_RTS)
236 237
"  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
#endif
238
"",
239
"  -T         Collect GC statistics (useful for in-program statistics access)"
240 241 242
"  -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)",
243 244 245
#ifdef RTS_GTK_FRONTPANEL
"  -f       Display front panel (requires X11 & GTK+)",
#endif
246 247 248 249
"",
"",
"  -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
250
#if defined(PROFILING)
251
"",
252
"  -px      Time/allocation profile (XML)  (output file <program>.prof)",
andy's avatar
andy committed
253 254 255
"  -p       Time/allocation profile        (output file <program>.prof)",
"  -P       More detailed Time/Allocation profile",
"  -Pa      Give information about *all* cost centres",
256

257 258
# if defined(PROFILING)
"",
259 260 261 262 263 264 265 266
"  -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)",
267
"  A subset of closures may be selected thusly:",
268 269
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
270 271 272 273 274
"    -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)",
275 276
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
277 278 279
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
280
"",
281 282
"  -xt            Include threads (TSOs) in a heap profile",
"",
283
"  -xc      Show current cost centre stack on raising an exception",
284 285
# endif
#endif /* PROFILING or PAR */
Simon Marlow's avatar
Simon Marlow committed
286

287
#ifdef TRACING
Simon Marlow's avatar
Simon Marlow committed
288
"",
289 290 291 292 293 294
"  -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",
295
"                g    GC events",
296 297
"                p    par spark events (sampled)",
"                f    par spark events (full detail)",
298 299 300
#  ifdef DEBUG
"                t    add time stamps (only useful with -v)",
#  endif
301 302 303
"                a    all event classes above",
"               -x    disable an event class, for any flag above",
"             the initial enabled event classes are 'sgp'",
Simon Marlow's avatar
Simon Marlow committed
304 305
#endif

306
#if !defined(PROFILING)
307
"",
308
"  -hT      Heap residency profile (output file <program>.hp)",
309
#endif
310
"  -i<sec>  Time between heap samples (seconds, default: 0.1)",
311 312
"",
#if defined(TICKY_TICKY)
313
"  -r<file>  Produce ticky-ticky statistics (with -rstderr for stderr)",
314 315
"",
#endif
316 317 318
"  -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.",
319
"  -V<secs>  Master tick interval in seconds (0 == disable timer).",
320 321
"            This sets the resolution for -C and the profile timer -i.",
"            Default: 0.02 sec.",
322 323 324
"",
#if defined(DEBUG)
"  -Ds  DEBUG: scheduler",
325
"  -Di  DEBUG: interpreter",
326 327 328 329 330 331 332
"  -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
333
"  -De  DEBUG: event logging",
334
"  -Da  DEBUG: apply",
335
"  -Dl  DEBUG: linker",
336
"  -Dm  DEBUG: stm",
Simon Marlow's avatar
Simon Marlow committed
337
"  -Dz  DEBUG: stack squeezing",
338
"  -Dc  DEBUG: program coverage",
339 340
"  -Dr  DEBUG: sparks",
"",
341
"     NOTE: DEBUG events are sent to stderr by default; add -l to create a",
342
"     binary event log file instead.",
343
"",
344
#endif /* DEBUG */
345
#if defined(THREADED_RTS) && !defined(NOSMP)
346 347
"  -N<n>     Use <n> processors (default: 1)",
"  -N        Determine the number of processors to use automatically",
348 349 350 351 352
"  -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)",
353
"  -qm       Don't automatically migrate threads between CPUs",
354
#endif
355 356
"  --install-signal-handlers=<yes|no>",
"            Install signal handlers (default: yes)",
Simon Marlow's avatar
Simon Marlow committed
357
#if defined(THREADED_RTS)
358 359
"  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
#endif
360 361 362 363
#if defined(x86_64_HOST_ARCH)
"  -xm       Base address to mmap memory in the GHCi linker",
"            (hex; must be <80000000)",
#endif
364
#if defined(USE_PAPI)
365 366
"  -aX       CPU performance counter measurements using PAPI",
"            (use with the -s<file> option).  X is one of:",
367 368 369 370 371 372
"",
/* "            y - cycles", */
"            1 - level 1 cache misses",
"            2 - level 2 cache misses",
"            b - branch mispredictions",
"            s - stalled cycles",
373
"            e - cache miss and branch misprediction events",
374 375
"            +PAPI_EVENT   - collect papi preset event PAPI_EVENT",
"            #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
376
#endif
377
"",
378 379
"RTS options may also be specified using the GHCRTS environment variable.",
"",
380 381 382 383 384 385
"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
386
STATIC_INLINE rtsBool
387 388 389 390 391
strequal(const char *a, const char * b)
{
    return(strcmp(a, b) == 0);
}

392
static void splitRtsFlags(char *s)
393 394 395 396 397 398 399 400 401 402 403
{
    char *c1, *c2;

    c1 = s;
    do {
	while (isspace(*c1)) { c1++; };
	c2 = c1;
	while (!isspace(*c2) && *c2 != '\0') { c2++; };
	
	if (c1 == c2) { break; }
	
404 405 406 407 408
        s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
        strncpy(s, c1, c2-c1);
        s[c2-c1] = '\0';
        rts_argv[rts_argc++] = s;

409 410 411 412
	c1 = c2;
    } while (*c1 != '\0');
}
    
413 414 415 416 417 418 419
/* -----------------------------------------------------------------------------
   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[]

420
     - rts_argv[]  (global) contains a copy of the collected RTS args
421 422
     - rts_argc    (global) contains the count of args in rts_argv

423
     - prog_argv[] (global) contains a copy of the non-RTS args (== argv)
424 425
     - prog_argc   (global) contains the count of args in prog_argv

426
     - prog_name   (global) contains the basename of prog_argv[0]
427 428 429 430

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

void setupRtsFlags (int *argc, char *argv[])
431
{
432 433 434
    nat mode;
    nat total_arg;
    nat arg, rts_argc0;
435

436
    setProgName (argv);
437 438 439 440
    total_arg = *argc;
    arg = 1;

    *argc = 1;
441 442
    rts_argc = 0;

443 444
    rts_argv = stgCallocBytes(total_arg + 1, sizeof (char *), "setupRtsFlags");

445
    rts_argc0 = rts_argc;
446

447 448 449 450 451
    // 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) {
452 453 454 455 456
            splitRtsFlags(ghc_rts_opts);
            // opts from ghc_rts_opts are always enabled:
            procRtsOpts(rts_argc0, RtsOptsAll);
            rts_argc0 = rts_argc;
        }
457 458
    }

459
    // process arguments from the GHCRTS environment variable next
460
    // (arguments from the command line override these).
461 462 463 464
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
465
            if (rtsOptsEnabled == RtsOptsNone) {
466
                errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n         Link with -rtsopts to enable them.");
467
                // We don't actually exit, just warn
468 469 470 471
            } else {
                splitRtsFlags(ghc_rts);
                procRtsOpts(rts_argc0, rtsOptsEnabled);
                rts_argc0 = rts_argc;
472
            }
473
        }
474
    }
475

476 477 478
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

479 480 481 482 483 484 485 486 487 488 489 490
    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])) {
491 492
            mode = RTS;
        }
493 494 495
	else if (strequal("-RTS", argv[arg])) {
	    mode = PGM;
	}
496 497
        else if (mode == RTS) {
            rts_argv[rts_argc++] = copyArg(argv[arg]);
Ian Lynagh's avatar
Ian Lynagh committed
498
        }
499 500
        else {
            argv[(*argc)++] = argv[arg];
501 502
	}
    }
503 504 505
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
506 507
    }
    argv[*argc] = (char *) 0;
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
    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;
532 533

    // Process RTS (rts_argv) part: mainly to determine statsfile
534 535
    for (arg = rts_argc0; arg < rts_argc; arg++) {
        if (rts_argv[arg][0] != '-') {
536
	    fflush(stdout);
537
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
538 539 540
	    error = rtsTrue;

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

542 543 544 545 546
            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
547 548 549 550 551 552 553 554 555 556 557
            switch(rts_argv[arg][1]) {
            case '-':
                if (strequal("info", &rts_argv[arg][2])) {
                    printRtsInfo();
                    stg_exit(0);
                }
                break;
            default:
                break;
            }

558
            if (enabled == RtsOptsSafeOnly) {
Simon Marlow's avatar
Simon Marlow committed
559 560 561 562 563
                errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
                stg_exit(EXIT_FAILURE);
            }

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

Simon Marlow's avatar
Simon Marlow committed
565 566 567 568 569
	      /* 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.
570 571 572 573 574 575
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
576
errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
577 578 579 580 581 582 583
error = rtsTrue;
#endif

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

588 589
#ifdef TRACING
# define TRACING_BUILD_ONLY(x)   x
Simon Marlow's avatar
Simon Marlow committed
590
#else
591
# define TRACING_BUILD_ONLY(x) \
592
errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
Simon Marlow's avatar
Simon Marlow committed
593 594 595
error = rtsTrue;
#endif

596 597 598 599
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
600 601 602 603 604 605 606 607 608
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]); \
609
error = rtsTrue;
610 611 612 613 614 615 616
#endif

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

617 618 619 620 621 622 623 624 625 626 627 628
              /* 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
629 630 631 632
                  else if (strequal("machine-readable",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.machineReadable = rtsTrue;
                  }
633 634
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
635
                      printRtsInfo();
636
                      stg_exit(0);
637
                  }
638 639 640 641 642
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
643
	      case 'A':
644 645 646 647
                  RtsFlags.GcFlags.minAllocAreaSize
                      = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
                           / BLOCK_SIZE;
                  break;
648

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
#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;
664 665 666
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
667
                case '+':
668
                case '#':
669 670 671 672
                  if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
                      errorBelch("maximum number of PAPI events reached");
                      stg_exit(EXIT_FAILURE);
                  }
673 674 675 676 677
                  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;
678
                  RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
679
                  RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
680
                  break;
681 682 683 684 685 686
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

687 688 689 690
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

691
	      case 'c':
692 693 694 695
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
696
		      RtsFlags.GcFlags.compact = rtsTrue;
697 698
		  }
		  break;
699

700 701 702 703
              case 'w':
		RtsFlags.GcFlags.sweep = rtsTrue;
		break;

704 705 706 707 708 709 710
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
711
	      case 'D':
712
              DEBUG_BUILD_ONLY(
713 714 715 716 717 718 719 720
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
721 722
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
			  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;
748 749 750
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
751 752 753
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
754 755 756
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
757 758 759
		      case 'c':
			  RtsFlags.DebugFlags.hpc = rtsTrue;
			  break;
760 761 762
		      case 'r':
			  RtsFlags.DebugFlags.sparks = rtsTrue;
			  break;
763 764 765 766
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
767 768
                  // -Dx also turns on -v.  Use -l to direct trace
                  // events to the .eventlog file instead.
769
                  RtsFlags.TraceFlags.tracing = TRACE_STDERR;
770 771
	      })
              break;
772 773

	      case 'K':
774
                  RtsFlags.GcFlags.maxStkSize =
775
                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
776
                  break;
777 778

	      case 'k':
779 780 781 782 783 784 785 786 787 788 789 790 791 792
		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:
793
                  RtsFlags.GcFlags.initialStkSize =
794
                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
795
                  break;
796 797
                }
                break;
798

799
              case 'M':
800 801 802 803
                  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;
804 805

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

808 809 810 811
                  if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
                      RtsFlags.GcFlags.pcFreeHeap > 100)
                      bad_option( rts_argv[arg] );
                  break;
812

813
	      case 'G':
814 815 816
                  RtsFlags.GcFlags.generations =
                      decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
                  break;
817

818
	      case 'H':
819 820 821 822 823 824 825
                  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;
826

827 828 829 830 831 832
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

833 834 835 836 837 838
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

839
		    /* Convert to millisecs */
840
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
841
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
842 843 844
		}
		break;

845 846 847 848
              case 'T':
                  RtsFlags.GcFlags.giveStats = COLLECT_GC_STATS;
                  break; /* Don't initialize statistics file. */

849
	      case 'S':
850 851
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
852

853
	      case 's':
854 855
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
856 857

	      case 't':
858 859
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
860

861
	    stats:
862 863
		{ 
		    int r;
864 865
                    r = openStatsFile(rts_argv[arg]+2, NULL,
                                      &RtsFlags.GcFlags.statsFile);
866 867
		    if (r == -1) { error = rtsTrue; }
		}
Simon Marlow's avatar
Simon Marlow committed
868
                break;
869 870 871 872 873 874 875 876 877

	      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
878
		PROFILING_BUILD_ONLY(
879
		switch (rts_argv[arg][2]) {
880 881
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
882
		    break;
andy's avatar
andy committed
883 884 885
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
886
		  default:
887 888 889 890 891 892 893 894
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
895 896 897
		}
		) break;

898 899 900 901
	      case 'R':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
  	          ) break;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
902 903 904 905 906 907 908
	      case 'L':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
                      if(RtsFlags.ProfFlags.ccsLength <= 0) {
			bad_option(rts_argv[arg]);
                      }
		  ) break;
909
	      case 'h': /* serial heap profile */
910
#if !defined(PROFILING)
911 912 913 914 915 916
		switch (rts_argv[arg][2]) {
		  case '\0':
		  case 'T':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
		    break;
		  default:
917
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
918 919 920 921 922
		    error = rtsTrue;
		}
#else
		PROFILING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
		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], '}');
940 941 942 943 944 945 946