RtsFlags.c 39.8 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 "RtsUtils.h"
14
#include "Profiling.h"
15

16 17
#ifdef HAVE_CTYPE_H
#include <ctype.h>
18 19
#endif

20 21
#include <string.h>

22 23
// Flag Structure
RTS_FLAGS RtsFlags;
24 25 26 27

/*
 * Split argument lists
 */
sof's avatar
sof committed
28
int     prog_argc = 0;    /* an "int" so as to match normal "argc" */
29
char  **prog_argv = NULL;
30 31
int     full_prog_argc = 0;    /* an "int" so as to match normal "argc" */
char  **full_prog_argv = NULL;
sof's avatar
sof committed
32
char   *prog_name = NULL; /* 'basename' of prog_argv[0] */
33
int     rts_argc = 0;  /* ditto */
34 35 36 37 38 39 40 41 42 43 44 45
char   *rts_argv[MAX_RTS_ARGS];

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

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

46
static int		/* return NULL on error */
47 48 49 50
open_stats_file (
    I_ arg,
    int argc, char *argv[],
    int rts_argc, char *rts_argv[],
51 52
    const char *FILENAME_FMT,
    FILE **file_ret);
53

54
static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max);
55 56 57 58 59 60 61 62 63 64 65
static void bad_option(const char *s);

/* -----------------------------------------------------------------------------
 * Command-line option parsing routines.
 * ---------------------------------------------------------------------------*/

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

66
    RtsFlags.GcFlags.maxStkSize		= (8 * 1024 * 1024) / sizeof(W_);
67 68
    RtsFlags.GcFlags.initialStkSize	= 1024 / sizeof(W_);

69
    RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
70
    RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
71
    RtsFlags.GcFlags.maxHeapSize	= 0;    /* off by default */
72
    RtsFlags.GcFlags.heapSizeSuggestion	= 0;    /* none */
73
    RtsFlags.GcFlags.pcFreeHeap		= 3;	/* 3% */
74
    RtsFlags.GcFlags.oldGenFactor       = 2;
75
    RtsFlags.GcFlags.generations        = 2;
76
    RtsFlags.GcFlags.steps              = 2;
77
    RtsFlags.GcFlags.squeezeUpdFrames	= rtsTrue;
78
    RtsFlags.GcFlags.compact            = rtsFalse;
79
    RtsFlags.GcFlags.compactThreshold   = 30.0;
80
    RtsFlags.GcFlags.sweep              = rtsFalse;
81 82 83
#ifdef RTS_GTK_FRONTPANEL
    RtsFlags.GcFlags.frontpanel         = rtsFalse;
#endif
84
    RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
85

86 87 88 89 90 91 92 93 94 95 96 97
#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

98 99
#ifdef DEBUG
    RtsFlags.DebugFlags.scheduler	= rtsFalse;
100
    RtsFlags.DebugFlags.interpreter	= rtsFalse;
101 102 103 104 105 106
    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;
107
    RtsFlags.DebugFlags.stm             = rtsFalse;
108
    RtsFlags.DebugFlags.prof		= rtsFalse;
109
    RtsFlags.DebugFlags.apply		= rtsFalse;
110
    RtsFlags.DebugFlags.linker		= rtsFalse;
111
    RtsFlags.DebugFlags.squeeze		= rtsFalse;
112
    RtsFlags.DebugFlags.hpc		= rtsFalse;
113
    RtsFlags.DebugFlags.sparks		= rtsFalse;
114 115
#endif

Simon Marlow's avatar
Simon Marlow committed
116
#if defined(PROFILING)
117
    RtsFlags.CcFlags.doCostCentres	= 0;
Simon Marlow's avatar
Simon Marlow committed
118
#endif /* PROFILING */
119

120
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
121
    RtsFlags.ProfFlags.profileInterval    = 100;
122 123

#ifdef PROFILING
124
    RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
125
    RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
126
    RtsFlags.ProfFlags.maxRetainerSetSize = 8;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
127
    RtsFlags.ProfFlags.ccsLength          = 25;
128 129 130 131
    RtsFlags.ProfFlags.modSelector        = NULL;
    RtsFlags.ProfFlags.descrSelector      = NULL;
    RtsFlags.ProfFlags.typeSelector       = NULL;
    RtsFlags.ProfFlags.ccSelector         = NULL;
132
    RtsFlags.ProfFlags.ccsSelector        = NULL;
133 134
    RtsFlags.ProfFlags.retainerSelector   = NULL;
    RtsFlags.ProfFlags.bioSelector        = NULL;
135 136
#endif

137
#ifdef TRACING
138
    RtsFlags.TraceFlags.tracing       = TRACE_NONE;
139 140
    RtsFlags.TraceFlags.timestamp     = rtsFalse;
    RtsFlags.TraceFlags.scheduler     = rtsFalse;
Simon Marlow's avatar
Simon Marlow committed
141 142
#endif

143 144
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 20;  /* In milliseconds */
145

146
    RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
Ian Lynagh's avatar
Ian Lynagh committed
147
    RtsFlags.MiscFlags.machineReadable = rtsFalse;
148
    RtsFlags.MiscFlags.linkerMemBase    = 0;
149

150
#ifdef THREADED_RTS
151
    RtsFlags.ParFlags.nNodes	        = 1;
152 153
    RtsFlags.ParFlags.migrate           = rtsTrue;
    RtsFlags.ParFlags.wakeupMigrate     = rtsFalse;
154
    RtsFlags.ParFlags.parGcEnabled      = 1;
155 156 157
    RtsFlags.ParFlags.parGcGen          = 0;
    RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
    RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
158
    RtsFlags.ParFlags.setAffinity       = 0;
159
#endif
160

Simon Marlow's avatar
Simon Marlow committed
161
#if defined(THREADED_RTS)
162
    RtsFlags.ParFlags.maxLocalSparks	= 4096;
Simon Marlow's avatar
Simon Marlow committed
163
#endif /* THREADED_RTS */
164 165

#ifdef TICKY_TICKY
166 167
    RtsFlags.TickyFlags.showTickyStats	 = rtsFalse;
    RtsFlags.TickyFlags.tickyFile	 = NULL;
168
#endif
Simon Marlow's avatar
Simon Marlow committed
169

170
#ifdef USE_PAPI
171 172
    /* By default no special measurements taken */
    RtsFlags.PapiFlags.eventType        = 0;
173
    RtsFlags.PapiFlags.numUserEvents    = 0;
174
#endif
175 176 177 178 179 180 181 182 183 184 185 186 187 188
}

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:",
"",
189
"  -?       Prints this message and exits; the program is not executed",
190
"  --info   Print information about the RTS used by this program",
191
"",
192
"  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
sof's avatar
sof committed
193
"  -k<size> Sets the initial thread stack size (default 1k)  Egs: -k4k   -k2m",
194
"",
195
"  -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
196
"  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
197
"  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
198
"  -m<n>    Minimum % of heap which must be available (default 3%)",
199
"  -G<n>    Number of generations (default: 2)",
200
"  -T<n>    Number of steps in younger generations (default: 2)",
201 202 203 204 205
"  -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)",
206
"  -w       Use mark-region for the oldest generation (experimental)",
207
#if defined(THREADED_RTS)
208 209
"  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
#endif
210
"",
211 212 213
"  -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)",
214 215 216
#ifdef RTS_GTK_FRONTPANEL
"  -f       Display front panel (requires X11 & GTK+)",
#endif
217 218 219 220
"",
"",
"  -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
221
#if defined(PROFILING)
222
"",
223
"  -px      Time/allocation profile (XML)  (output file <program>.prof)",
andy's avatar
andy committed
224 225 226
"  -p       Time/allocation profile        (output file <program>.prof)",
"  -P       More detailed Time/Allocation profile",
"  -Pa      Give information about *all* cost centres",
227

228 229
# if defined(PROFILING)
"",
230 231 232 233 234 235 236 237
"  -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)",
238
"  A subset of closures may be selected thusly:",
239 240
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
241 242 243 244 245
"    -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)",
246 247
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
248 249 250
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
251
"",
252 253
"  -xt            Include threads (TSOs) in a heap profile",
"",
254
"  -xc      Show current cost centre stack on raising an exception",
255
"",
256 257
# endif
#endif /* PROFILING or PAR */
Simon Marlow's avatar
Simon Marlow committed
258

259
#ifdef TRACING
Simon Marlow's avatar
Simon Marlow committed
260
"",
261 262 263 264 265
"  -v       Log events to stderr",
"  -l       Log events in binary format to the file <program>.eventlog",
"  -vt      Include time stamps when tracing events to stderr with -v",
"",
"  -ls      Log scheduler events",
Simon Marlow's avatar
Simon Marlow committed
266 267 268
"",
#endif

269
#if !defined(PROFILING)
270
"",
271
"  -hT      Heap residency profile (output file <program>.hp)",
272
#endif
273
"  -i<sec>  Time between heap samples (seconds, default: 0.1)",
274 275
"",
#if defined(TICKY_TICKY)
276
"  -r<file>  Produce ticky-ticky statistics (with -rstderr for stderr)",
277 278
"",
#endif
279 280 281
"  -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.",
282
"  -V<secs>  Master tick interval in seconds (0 == disable timer).",
283 284
"            This sets the resolution for -C and the profile timer -i.",
"            Default: 0.02 sec.",
285 286 287
"",
#if defined(DEBUG)
"  -Ds  DEBUG: scheduler",
288
"  -Di  DEBUG: interpreter",
289 290 291 292 293 294 295
"  -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
296
"  -De  DEBUG: event logging",
297
"  -Da  DEBUG: apply",
298
"  -Dl  DEBUG: linker",
299
"  -Dm  DEBUG: stm",
300
"  -Dz  DEBUG: stack squezing",
301
"  -Dc  DEBUG: program coverage",
302 303 304 305
"  -Dr  DEBUG: sparks",
"",
"     NOTE: all -D options also enable -v automatically.  Use -l to create a",
"     binary event log file instead.",
306
"",
307
#endif /* DEBUG */
308
#if defined(THREADED_RTS) && !defined(NOSMP)
309 310
"  -N<n>     Use <n> processors (default: 1)",
"  -N        Determine the number of processors to use automatically",
311 312 313 314 315
"  -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)",
316 317
"  -qm       Don't automatically migrate threads between CPUs",
"  -qw       Migrate a thread to the current CPU when it is woken up",
318
#endif
319 320
"  --install-signal-handlers=<yes|no>",
"            Install signal handlers (default: yes)",
Simon Marlow's avatar
Simon Marlow committed
321
#if defined(THREADED_RTS)
322 323
"  -e<size>  Size of spark pools (default 100)",
#endif
Simon Marlow's avatar
Simon Marlow committed
324
#if defined(THREADED_RTS)
325 326
"  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
#endif
327 328 329 330
#if defined(x86_64_HOST_ARCH)
"  -xm       Base address to mmap memory in the GHCi linker",
"            (hex; must be <80000000)",
#endif
331
#if defined(USE_PAPI)
332 333
"  -aX       CPU performance counter measurements using PAPI",
"            (use with the -s<file> option).  X is one of:",
334 335 336 337 338 339
"",
/* "            y - cycles", */
"            1 - level 1 cache misses",
"            2 - level 2 cache misses",
"            b - branch mispredictions",
"            s - stalled cycles",
340
"            e - cache miss and branch misprediction events",
341
#endif
342
"",
343 344
"RTS options may also be specified using the GHCRTS environment variable.",
"",
345 346 347 348 349 350
"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
351
STATIC_INLINE rtsBool
352 353 354 355 356
strequal(const char *a, const char * b)
{
    return(strcmp(a, b) == 0);
}

357 358 359 360 361 362 363 364 365 366 367 368 369 370
static void
splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
{
    char *c1, *c2;

    c1 = s;
    do {
	while (isspace(*c1)) { c1++; };
	c2 = c1;
	while (!isspace(*c2) && *c2 != '\0') { c2++; };
	
	if (c1 == c2) { break; }
	
	if (*rts_argc < MAX_RTS_ARGS-1) {
sof's avatar
sof committed
371
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
372 373 374 375 376 377 378 379 380 381 382
	    strncpy(s, c1, c2-c1);
	    s[c2-c1] = '\0';
	    rts_argv[(*rts_argc)++] = s;
	} else {
	    barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
	}
	
	c1 = c2;
    } while (*c1 != '\0');
}
    
383 384 385 386 387 388 389
void
setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
{
    rtsBool error = rtsFalse;
    I_ mode;
    I_ arg, total_arg;

390
    setProgName (argv);
391 392 393 394 395 396
    total_arg = *argc;
    arg = 1;

    *argc = 1;
    *rts_argc = 0;

397 398 399 400 401 402 403 404 405
    // 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) {
	    splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
	}
    }

406
    // process arguments from the GHCRTS environment variable next
407
    // (arguments from the command line override these).
408 409 410 411
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
412
	    splitRtsFlags(ghc_rts, rts_argc, rts_argv);
413 414
	}
    }
415

416 417 418
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

419 420 421 422 423 424 425 426 427 428 429 430
    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])) {
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
	    mode = RTS;
	}
	else if (strequal("-RTS", argv[arg])) {
	    mode = PGM;
	}
	else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
	    rts_argv[(*rts_argc)++] = argv[arg];
	}
	else if (mode == PGM) {
	    argv[(*argc)++] = argv[arg];
	}
	else {
	  barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
	}
    }
446 447 448
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
449 450 451 452 453
    }
    argv[*argc] = (char *) 0;
    rts_argv[*rts_argc] = (char *) 0;

    // Process RTS (rts_argv) part: mainly to determine statsfile
454 455 456
    for (arg = 0; arg < *rts_argc; arg++) {
	if (rts_argv[arg][0] != '-') {
	    fflush(stdout);
457
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
458 459 460 461 462
	    error = rtsTrue;

        } else {
	    switch(rts_argv[arg][1]) {

Simon Marlow's avatar
Simon Marlow committed
463 464 465 466 467
	      /* 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.
468 469 470 471 472 473
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
474
errorBelch("not built for: ticky-ticky stats"); \
475 476 477 478 479 480 481
error = rtsTrue;
#endif

#ifdef PROFILING
# define PROFILING_BUILD_ONLY(x)   x
#else
# define PROFILING_BUILD_ONLY(x) \
482
errorBelch("not built for: -prof"); \
483 484 485
error = rtsTrue;
#endif

486 487
#ifdef TRACING
# define TRACING_BUILD_ONLY(x)   x
Simon Marlow's avatar
Simon Marlow committed
488
#else
489
# define TRACING_BUILD_ONLY(x) \
Simon Marlow's avatar
Simon Marlow committed
490 491 492 493
errorBelch("not built for: -par-prof"); \
error = rtsTrue;
#endif

494 495 496 497 498 499
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
errorBelch("not built for: -smp"); \
error = rtsTrue;
500 501 502 503 504 505 506
#endif

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

507 508 509 510 511 512 513 514 515 516 517 518
              /* 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
519 520 521 522
                  else if (strequal("machine-readable",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.machineReadable = rtsTrue;
                  }
523 524
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
525
                      printRtsInfo();
526 527
                      exit(0);
                  }
528 529 530 531 532
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
533
	      case 'A':
534 535 536 537
                  RtsFlags.GcFlags.minAllocAreaSize
                      = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
                           / BLOCK_SIZE;
                  break;
538

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
#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;
554 555 556
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
557 558 559 560 561 562 563 564
                case '+':
                  if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
                      errorBelch("maximum number of PAPI events reached");
                      stg_exit(EXIT_FAILURE);
                  }
                  RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
                  RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
                  break;
565 566 567 568 569 570
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

571 572 573 574
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

575
	      case 'c':
576 577 578 579
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
580
		      RtsFlags.GcFlags.compact = rtsTrue;
581 582
		  }
		  break;
583

584 585 586 587
              case 'w':
		RtsFlags.GcFlags.sweep = rtsTrue;
		break;

588 589 590 591 592 593 594
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
595 596
#ifdef DEBUG
	      case 'D':
597 598 599 600 601 602 603 604
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
605 606
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
			  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;
632 633 634
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
635 636 637
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
638 639 640
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
641 642 643
		      case 'c':
			  RtsFlags.DebugFlags.hpc = rtsTrue;
			  break;
644 645 646
		      case 'r':
			  RtsFlags.DebugFlags.sparks = rtsTrue;
			  break;
647 648 649 650
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
651 652
                  // -Dx also turns on -v.  Use -l to direct trace
                  // events to the .eventlog file instead.
653
                  RtsFlags.TraceFlags.tracing = TRACE_STDERR;
654 655
		  break;
	      }
656 657 658
#endif

	      case 'K':
659 660 661
                  RtsFlags.GcFlags.maxStkSize =
                      decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
                  break;
662 663

	      case 'k':
664 665 666
                  RtsFlags.GcFlags.initialStkSize =
                      decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
                  break;
667 668

	      case 'M':
669 670 671 672
                  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;
673 674

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

677 678 679 680
                  if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
                      RtsFlags.GcFlags.pcFreeHeap > 100)
                      bad_option( rts_argv[arg] );
                  break;
681

682
	      case 'G':
683 684 685
                  RtsFlags.GcFlags.generations =
                      decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
                  break;
686

687 688 689
              case 'T':
                  RtsFlags.GcFlags.steps =
                      decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
690 691
		break;

692
	      case 'H':
693 694
		RtsFlags.GcFlags.heapSizeSuggestion =
                    (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
695 696
		break;

697 698 699 700 701 702
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

703 704 705 706 707 708
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

709
		    /* Convert to millisecs */
710
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
711
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
712 713 714
		}
		break;

715
	      case 'S':
716 717
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
718

719
	      case 's':
720 721
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
722 723

	      case 't':
724 725
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
726

727
	    stats:
728 729 730
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
731
					*rts_argc, rts_argv, NULL,
732 733 734
					&RtsFlags.GcFlags.statsFile);
		    if (r == -1) { error = rtsTrue; }
		}
Simon Marlow's avatar
Simon Marlow committed
735
                break;
736 737 738 739 740 741 742

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

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

Simon Marlow's avatar
Simon Marlow committed
743
              case 'l':
744 745 746
#ifdef TRACING
                switch(rts_argv[arg][2]) {
		case '\0':
747 748
                    RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
                    break;
749
                case 's':
750 751 752
                    RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
                    RtsFlags.TraceFlags.scheduler = rtsTrue;
                    break;
753 754 755 756 757
		default:
		    errorBelch("unknown RTS option: %s",rts_argv[arg]);
		    error = rtsTrue;
		    break;
                }
Simon Marlow's avatar
Simon Marlow committed
758
#else
759
                errorBelch("not built for: -eventlog");
Simon Marlow's avatar
Simon Marlow committed
760
#endif
761
                break;
Simon Marlow's avatar
Simon Marlow committed
762

763 764
	      case 'P': /* detailed cost centre profiling (time/alloc) */
	      case 'p': /* cost centre profiling (time/alloc) */
Simon Marlow's avatar
Simon Marlow committed
765
		PROFILING_BUILD_ONLY(
766
		switch (rts_argv[arg][2]) {
767 768
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
769
		    break;
andy's avatar
andy committed
770 771 772
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
773
		  default:
774 775 776 777 778 779 780 781
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
782 783 784
		}
		) break;

785 786 787 788
	      case 'R':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
  	          ) break;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
789 790 791 792 793 794 795
	      case 'L':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
                      if(RtsFlags.ProfFlags.ccsLength <= 0) {
			bad_option(rts_argv[arg]);
                      }
		  ) break;
796
	      case 'h': /* serial heap profile */
797
#if !defined(PROFILING)
798 799 800 801 802 803
		switch (rts_argv[arg][2]) {
		  case '\0':
		  case 'T':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
		    break;
		  default:
804
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
805 806 807 808 809
		    error = rtsTrue;
		}
#else
		PROFILING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
		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], '}');
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843

			    // 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;
844 845 846
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
			    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;
867 868 869 870
			    }
			}
			break;
		    }
871

872
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
873
			errorBelch("multiple heap profile options");
874 875 876 877 878 879 880 881 882 883 884 885
			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':
886 887
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
888 889
		    case 'D':
		    case 'd':
890 891
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
			  break;
892 893
		    case 'Y':
		    case 'y':
894 895
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
			  break;
896 897
		    case 'R':
		    case 'r':
898 899
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
			  break;
900 901
		    case 'B':
		    case 'b':
902 903
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
			  break;
904 905
		    }
		    break;
906
		      
907
		default:
908
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
909 910 911
		    error = rtsTrue;
		}
		) 
912
#endif /* PROFILING */
andy's avatar
andy committed
913 914 915 916 917 918 919 920 921 922
    	    	break;

    	      case 'i':	/* heap sample interval */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

		    /* Convert to milliseconds */
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
923
		    RtsFlags.ProfFlags.profileInterval = cst;
andy's avatar
andy committed
924 925
		}
		break;
926 927 928 929 930 931 932 933 934 935 936 937 938 939

	      /* =========== CONCURRENT ========================= */
    	      case 'C':	/* context switch interval */
		if (rts_argv[arg][2] == '\0')
    	    	    RtsFlags.ConcFlags.ctxtSwitchTime = 0;
		else {
		    I_ cst; /* tmp */

		    /* Convert to milliseconds */
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
		    RtsFlags.ConcFlags.ctxtSwitchTime = cst;
		}
    	    	break;

940 941 942 943 944 945 946 947 948 949 950 951 952
              case 'V': /* master tick interval */
                if (rts_argv[arg][2] == '\0') {
                    // turns off ticks completely
                    RtsFlags.MiscFlags.tickInterval = 0;
                } else {
                    I_ cst; /* tmp */

                    /* Convert to milliseconds */
                    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
                    RtsFlags.MiscFlags.tickInterval = cst;
                }
                break;

953
#if defined(THREADED_RTS) && !defined(NOSMP)
954
	      case 'N':
955
		THREADED_BUILD_ONLY(
956 957 958 959
		if (rts_argv[arg][2] == '\0') {
#if defined(PROFILING)
		    RtsFlags.ParFlags.nNodes = 1;
#else
960
                    RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
961 962
#endif
		} else {
963
		    RtsFlags.ParFlags.nNodes
964
		      = strtol(rts_argv[arg]+2, (char **) NULL, 10);
965
		    if (RtsFlags.ParFlags.nNodes <= 0) {
966
		      errorBelch("bad value for -N");
967
		      error = rtsTrue;
968
		    }
Simon Marlow's avatar
Simon Marlow committed
969 970 971 972 973 974
#if defined(PROFILING)
                    if (RtsFlags.ParFlags.nNodes > 1) {
                        errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
		      error = rtsTrue;
                    }
#endif
975 976 977 978 979
		}
		) break;

	      case 'g':
		THREADED_BUILD_ONLY(
980 981 982 983 984 985 986 987 988 989 990
		    switch (rts_argv[arg][2]) {
                    case '1':
                        // backwards compat only
                        RtsFlags.ParFlags.parGcEnabled = rtsFalse;
                        break;
		    default:
			errorBelch("unknown RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
                    }
                    ) break;
991

Simon Marlow's avatar
Simon Marlow committed
992
	      case 'q':
993 994 995 996 997
		    switch (rts_argv[arg][2]) {
		    case '\0':
			errorBelch("incomplete RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
998
                    case 'g':
999 1000 1001 1002
                        if (rts_argv[arg][3] == '\0') {
                            RtsFlags.ParFlags.parGcEnabled = rtsFalse;
                        } else {
                            RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1003 1004 1005 1006
                            RtsFlags.ParFlags.parGcGen
                                = strtol(rts_argv[arg]+3, (char **) NULL, 10);
                        }
                        break;
1007
		    case 'b':
1008 1009 1010 1011 1012 1013 1014 1015 1016
                        if (rts_argv[arg][3] == '\0') {
                            RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
                        }
                        else {
                            RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
                            RtsFlags.ParFlags.parGcLoadBalancingGen
                                = strtol(rts_argv[arg]+3, (char **) NULL, 10);
                        }
                        break;
1017 1018 1019
		    case 'a':
			RtsFlags.ParFlags.setAffinity = rtsTrue;
			break;
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
		    case 'm':
			RtsFlags.ParFlags.migrate = rtsFalse;
			break;
		    case 'w':
			RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
			break;
		    default:
			errorBelch("unknown RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
		    }
		    break;
1032
#endif
1033 1034
	      /* =========== PARALLEL =========================== */
	      case 'e':
Simon Marlow's avatar
Simon Marlow committed
1035
		THREADED_BUILD_ONLY(
10