RtsFlags.c 47.3 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[MAX_RTS_ARGS];
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 80 81 82 83 84
/* -----------------------------------------------------------------------------
 * Command-line option parsing routines.
 * ---------------------------------------------------------------------------*/

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

85
    RtsFlags.GcFlags.maxStkSize		= (8 * 1024 * 1024) / sizeof(W_);
86
    RtsFlags.GcFlags.initialStkSize	= 1024 / sizeof(W_);
87 88
    RtsFlags.GcFlags.stkChunkSize       = (32 * 1024) / sizeof(W_);
    RtsFlags.GcFlags.stkChunkBufferSize = (1 * 1024) / sizeof(W_);
89

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

107 108 109 110 111 112 113 114 115 116 117 118
#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

119 120
#ifdef DEBUG
    RtsFlags.DebugFlags.scheduler	= rtsFalse;
121
    RtsFlags.DebugFlags.interpreter	= rtsFalse;
122 123 124 125 126 127
    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;
128
    RtsFlags.DebugFlags.stm             = rtsFalse;
129
    RtsFlags.DebugFlags.prof		= rtsFalse;
130
    RtsFlags.DebugFlags.apply		= rtsFalse;
131
    RtsFlags.DebugFlags.linker		= rtsFalse;
132
    RtsFlags.DebugFlags.squeeze		= rtsFalse;
133
    RtsFlags.DebugFlags.hpc		= rtsFalse;
134
    RtsFlags.DebugFlags.sparks		= rtsFalse;
135 136
#endif

Simon Marlow's avatar
Simon Marlow committed
137
#if defined(PROFILING)
138
    RtsFlags.CcFlags.doCostCentres	= 0;
Simon Marlow's avatar
Simon Marlow committed
139
#endif /* PROFILING */
140

141
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
142
    RtsFlags.ProfFlags.profileInterval    = 100;
143 144

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

158
#ifdef TRACING
159
    RtsFlags.TraceFlags.tracing       = TRACE_NONE;
160 161
    RtsFlags.TraceFlags.timestamp     = rtsFalse;
    RtsFlags.TraceFlags.scheduler     = rtsFalse;
Simon Marlow's avatar
Simon Marlow committed
162 163
#endif

164 165
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 20;  /* In milliseconds */
166

167
    RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
Ian Lynagh's avatar
Ian Lynagh committed
168
    RtsFlags.MiscFlags.machineReadable = rtsFalse;
169
    RtsFlags.MiscFlags.linkerMemBase    = 0;
170

171
#ifdef THREADED_RTS
172
    RtsFlags.ParFlags.nNodes	        = 1;
173
    RtsFlags.ParFlags.migrate           = rtsTrue;
174
    RtsFlags.ParFlags.parGcEnabled      = 1;
175 176 177
    RtsFlags.ParFlags.parGcGen          = 0;
    RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
    RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
178
    RtsFlags.ParFlags.setAffinity       = 0;
179
#endif
180

Simon Marlow's avatar
Simon Marlow committed
181
#if defined(THREADED_RTS)
182
    RtsFlags.ParFlags.maxLocalSparks	= 4096;
Simon Marlow's avatar
Simon Marlow committed
183
#endif /* THREADED_RTS */
184 185

#ifdef TICKY_TICKY
186 187
    RtsFlags.TickyFlags.showTickyStats	 = rtsFalse;
    RtsFlags.TickyFlags.tickyFile	 = NULL;
188
#endif
Simon Marlow's avatar
Simon Marlow committed
189

190
#ifdef USE_PAPI
191 192
    /* By default no special measurements taken */
    RtsFlags.PapiFlags.eventType        = 0;
193
    RtsFlags.PapiFlags.numUserEvents    = 0;
194
#endif
195 196 197 198 199 200 201 202 203 204 205 206 207 208
}

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

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

279
#ifdef TRACING
Simon Marlow's avatar
Simon Marlow committed
280
"",
281 282 283 284 285 286 287 288 289
"  -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",
#  ifdef DEBUG
"                t    add time stamps (only useful with -v)",
#  endif
Simon Marlow's avatar
Simon Marlow committed
290 291
#endif

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

378
static void splitRtsFlags(char *s)
379 380 381 382 383 384 385 386 387 388 389
{
    char *c1, *c2;

    c1 = s;
    do {
	while (isspace(*c1)) { c1++; };
	c2 = c1;
	while (!isspace(*c2) && *c2 != '\0') { c2++; };
	
	if (c1 == c2) { break; }
	
390
        if (rts_argc < MAX_RTS_ARGS-1) {
sof's avatar
sof committed
391
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
392 393
	    strncpy(s, c1, c2-c1);
	    s[c2-c1] = '\0';
394
            rts_argv[rts_argc++] = s;
395 396 397 398 399 400 401 402
	} else {
	    barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
	}
	
	c1 = c2;
    } while (*c1 != '\0');
}
    
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
/* -----------------------------------------------------------------------------
   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[]

     - rts_argv[]  (global) contains the collected RTS args
     - rts_argc    (global) contains the count of args in rts_argv

     - prog_argv[] (global) contains the non-RTS args (== argv)
     - prog_argc   (global) contains the count of args in prog_argv

     - prog_name   (global) contains the basename of argv[0]

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

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

426
    setProgName (argv);
427 428 429 430
    total_arg = *argc;
    arg = 1;

    *argc = 1;
431 432 433
    rts_argc = 0;

    rts_argc0 = rts_argc;
434

435 436 437 438 439
    // 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) {
440 441 442 443 444
            splitRtsFlags(ghc_rts_opts);
            // opts from ghc_rts_opts are always enabled:
            procRtsOpts(rts_argc0, RtsOptsAll);
            rts_argc0 = rts_argc;
        }
445 446
    }

447
    // process arguments from the GHCRTS environment variable next
448
    // (arguments from the command line override these).
449 450 451 452
    {
	char *ghc_rts = getenv("GHCRTS");

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

464 465 466
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

467 468 469 470 471 472 473 474 475 476 477 478
    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])) {
479 480
            mode = RTS;
        }
481 482 483
	else if (strequal("-RTS", argv[arg])) {
	    mode = PGM;
	}
484 485
        else if (mode == RTS && rts_argc < MAX_RTS_ARGS-1) {
            rts_argv[rts_argc++] = argv[arg];
Ian Lynagh's avatar
Ian Lynagh committed
486
        }
Simon Marlow's avatar
Simon Marlow committed
487
        else if (mode == PGM) {
488 489 490 491 492 493
	    argv[(*argc)++] = argv[arg];
	}
	else {
	  barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
	}
    }
494 495 496
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
497 498
    }
    argv[*argc] = (char *) 0;
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
    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;
523 524

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

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

533 534 535 536 537
            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
538 539 540 541 542 543 544 545 546 547 548
            switch(rts_argv[arg][1]) {
            case '-':
                if (strequal("info", &rts_argv[arg][2])) {
                    printRtsInfo();
                    stg_exit(0);
                }
                break;
            default:
                break;
            }

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

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

Simon Marlow's avatar
Simon Marlow committed
556 557 558 559 560
	      /* 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.
561 562 563 564 565 566
	      */

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

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

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

587 588 589 590
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
591 592 593 594 595 596 597 598 599
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]); \
600
error = rtsTrue;
601 602 603 604 605 606 607
#endif

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

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

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

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

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

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

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

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

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

	      case 'k':
770 771 772 773 774 775 776 777 778 779 780 781 782 783
		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:
784
                  RtsFlags.GcFlags.initialStkSize =
785
                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
786
                  break;
787 788
                }
                break;
789

790
              case 'M':
791 792 793 794
                  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;
795 796

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

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

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

809
	      case 'H':
810 811 812 813 814 815 816
                  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;
817

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

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

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

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

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

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

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

	      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
865
		PROFILING_BUILD_ONLY(
866
		switch (rts_argv[arg][2]) {
867 868
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
869
		    break;
andy's avatar
andy committed
870 871 872
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
873
		  default:
874 875 876 877 878 879 880 881
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
882 883 884
		}
		) break;

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

			    // 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;
944 945 946
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
			    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;
967 968 969 970
			    }
			}
			break;
		    }
971

972
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
973
			errorBelch("multiple heap profile options");
974 975 976 977 978 979 980 981 982 983 984 985
			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':
986 987
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
988 989
		    case 'D':
		    case 'd':
990 991
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
			  break;
992 993
		    case 'Y':
		    case 'y':
994 995
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
			  break;
996 997
		    case 'R':
		    case 'r':
998 999
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
			  break;
1000 1001
		    case 'B':
		    case 'b':
1002 1003
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
			  break;
1004 1005
		    }
		    break;
1006
		      
1007
		default:
1008
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1009 1010 1011
		    error = rtsTrue;
		}
		) 
1012
#endif /* PROFILING */
andy's avatar
andy committed
1013 1014 1015 1016 1017 1018 1019 1020