RtsFlags.c 37.9 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 55 56 57 58 59 60 61 62 63 64 65

static I_ decode(const char *s);
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;
Simon Marlow's avatar
Simon Marlow committed
109
    RtsFlags.DebugFlags.eventlog        = rtsFalse;
110
    RtsFlags.DebugFlags.apply		= rtsFalse;
111
    RtsFlags.DebugFlags.linker		= rtsFalse;
112
    RtsFlags.DebugFlags.squeeze		= rtsFalse;
113
    RtsFlags.DebugFlags.hpc		= rtsFalse;
Simon Marlow's avatar
Simon Marlow committed
114
    RtsFlags.DebugFlags.timestamp	= rtsFalse;
115 116
#endif

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

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

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

Simon Marlow's avatar
Simon Marlow committed
138 139 140 141
#ifdef EVENTLOG
    RtsFlags.EventLogFlags.doEventLogging = rtsFalse;
#endif

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

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

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

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

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

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

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

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

#ifdef EVENTLOG
"",
"  -l       Log runtime events (generates binary trace file <program>.eventlog)",
"",
#endif

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

346 347 348 349 350 351 352 353 354 355 356 357 358 359
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
360
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
361 362 363 364 365 366 367 368 369 370 371
	    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');
}
    
372 373 374 375 376 377 378
void
setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
{
    rtsBool error = rtsFalse;
    I_ mode;
    I_ arg, total_arg;

379
    setProgName (argv);
380 381 382 383 384 385
    total_arg = *argc;
    arg = 1;

    *argc = 1;
    *rts_argc = 0;

386 387 388 389 390 391 392 393 394
    // 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);
	}
    }

395
    // process arguments from the GHCRTS environment variable next
396
    // (arguments from the command line override these).
397 398 399 400
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
401
	    splitRtsFlags(ghc_rts, rts_argc, rts_argv);
402 403
	}
    }
404

405 406 407
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

408 409 410 411 412 413 414 415 416 417 418 419
    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])) {
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	    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);
	}
    }
435 436 437
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
438 439 440 441 442
    }
    argv[*argc] = (char *) 0;
    rts_argv[*rts_argc] = (char *) 0;

    // Process RTS (rts_argv) part: mainly to determine statsfile
443 444 445
    for (arg = 0; arg < *rts_argc; arg++) {
	if (rts_argv[arg][0] != '-') {
	    fflush(stdout);
446
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
447 448 449 450 451
	    error = rtsTrue;

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

Simon Marlow's avatar
Simon Marlow committed
452 453 454 455 456
	      /* 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.
457 458 459 460 461 462
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
463
errorBelch("not built for: ticky-ticky stats"); \
464 465 466 467 468 469 470
error = rtsTrue;
#endif

#ifdef PROFILING
# define PROFILING_BUILD_ONLY(x)   x
#else
# define PROFILING_BUILD_ONLY(x) \
471
errorBelch("not built for: -prof"); \
472 473 474
error = rtsTrue;
#endif

Simon Marlow's avatar
Simon Marlow committed
475 476 477 478 479 480 481 482
#ifdef EVENTLOG
# define EVENTLOG_BUILD_ONLY(x)   x
#else
# define EVENTLOG_BUILD_ONLY(x) \
errorBelch("not built for: -par-prof"); \
error = rtsTrue;
#endif

483 484 485 486 487 488
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
errorBelch("not built for: -smp"); \
error = rtsTrue;
489 490 491 492 493 494 495
#endif

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

496 497 498 499 500 501 502 503 504 505 506 507
              /* 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
508 509 510 511
                  else if (strequal("machine-readable",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.machineReadable = rtsTrue;
                  }
512 513
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
514
                      printRtsInfo();
515 516
                      exit(0);
                  }
517 518 519 520 521
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
522 523 524 525 526 527 528 529
	      case 'A':
		RtsFlags.GcFlags.minAllocAreaSize
		  = decode(rts_argv[arg]+2) / BLOCK_SIZE;
		if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
		  bad_option(rts_argv[arg]);
		}
		break;

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
#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;
545 546 547
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
548 549 550 551 552 553 554 555
                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;
556 557 558 559 560 561
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

562 563 564 565
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

566
	      case 'c':
567 568 569 570
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
571
		      RtsFlags.GcFlags.compact = rtsTrue;
572 573
		  }
		  break;
574

575 576 577 578
              case 'w':
		RtsFlags.GcFlags.sweep = rtsTrue;
		break;

579 580 581 582 583 584 585
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
586 587
#ifdef DEBUG
	      case 'D':
588 589 590 591 592 593 594 595
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
596 597
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
			  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;
Simon Marlow's avatar
Simon Marlow committed
620 621 622
		      case 'e':
			  RtsFlags.DebugFlags.eventlog = rtsTrue;
                          break;
623 624 625
		      case 'l':
			  RtsFlags.DebugFlags.linker = rtsTrue;
			  break;
626 627 628
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
629 630 631
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
632 633 634
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
635 636 637
		      case 'c':
			  RtsFlags.DebugFlags.hpc = rtsTrue;
			  break;
638 639 640 641 642 643
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
		  break;
	      }
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
#endif

	      case 'K':
		RtsFlags.GcFlags.maxStkSize = 
		  decode(rts_argv[arg]+2) / sizeof(W_);

		if (RtsFlags.GcFlags.maxStkSize == 0) 
		  bad_option( rts_argv[arg] );
		break;

	      case 'k':
		RtsFlags.GcFlags.initialStkSize = 
		  decode(rts_argv[arg]+2) / sizeof(W_);

		if (RtsFlags.GcFlags.initialStkSize == 0) 
		  bad_option( rts_argv[arg] );
		break;

	      case 'M':
		RtsFlags.GcFlags.maxHeapSize = 
		  decode(rts_argv[arg]+2) / BLOCK_SIZE;
		/* user give size in *bytes* but "maxHeapSize" is in *blocks* */

		if (RtsFlags.GcFlags.maxHeapSize <= 0) {
		  bad_option(rts_argv[arg]);
		}
		break;

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

		if (RtsFlags.GcFlags.pcFreeHeap < 0 || 
		    RtsFlags.GcFlags.pcFreeHeap > 100)
		  bad_option( rts_argv[arg] );
		break;

680 681
	      case 'G':
		RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
682
		if (RtsFlags.GcFlags.generations < 1) {
683 684 685 686
		  bad_option(rts_argv[arg]);
		}
		break;

687 688 689 690 691 692 693
	      case 'T':
		RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
		if (RtsFlags.GcFlags.steps < 1) {
		  bad_option(rts_argv[arg]);
		}
		break;

694
	      case 'H':
695 696
		RtsFlags.GcFlags.heapSizeSuggestion = 
		  decode(rts_argv[arg]+2) / BLOCK_SIZE;
697 698
		break;

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

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

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

717
	      case 'S':
718 719
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
720

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

	      case 't':
726 727
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
728

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

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

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

Simon Marlow's avatar
Simon Marlow committed
745 746 747 748 749 750 751 752
              case 'l':
#ifdef EVENTLOG
                  RtsFlags.EventLogFlags.doEventLogging = rtsTrue;
#else
                  errorBelch("not built for: -eventlog");
#endif
                  break;

753 754
	      case 'P': /* detailed cost centre profiling (time/alloc) */
	      case 'p': /* cost centre profiling (time/alloc) */
Simon Marlow's avatar
Simon Marlow committed
755
		PROFILING_BUILD_ONLY(
756
		switch (rts_argv[arg][2]) {
757 758
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
759
		    break;
andy's avatar
andy committed
760 761 762
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
763
		  default:
764 765 766 767 768 769 770 771
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
772 773 774
		}
		) break;

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

			    // 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;
834 835 836
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
			    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;
857 858 859 860
			    }
			}
			break;
		    }
861

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

	      /* =========== 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;

930 931 932 933 934 935 936 937 938 939 940 941 942
              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;

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

	      case 'g':
		THREADED_BUILD_ONLY(
970 971 972 973 974 975 976 977 978 979 980
		    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;
981

Simon Marlow's avatar
Simon Marlow committed
982
	      case 'q':
983 984 985 986 987
		    switch (rts_argv[arg][2]) {
		    case '\0':
			errorBelch("incomplete RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
988 989 990 991 992 993 994 995 996 997 998 999
                    case '1':
                        RtsFlags.ParFlags.parGcEnabled = rtsFalse;
                        break;
                    case 'g':
                        if (rts_argv[arg][3] != '\0') {
                            RtsFlags.ParFlags.parGcGen
                                = strtol(rts_argv[arg]+3, (char **) NULL, 10);
                        } else {
                            errorBelch("bad value for -qg");
                            error = rtsTrue;
                        }
                        break;
1000 1001 1002
		    case 'b':
			RtsFlags.ParFlags.parGcLoadBalancing = rtsFalse;
			break;
1003 1004 1005
		    case 'a':
			RtsFlags.ParFlags.setAffinity = rtsTrue;
			break;
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
		    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;
1018
#endif
1019 1020
	      /* =========== PARALLEL =========================== */
	      case 'e':
Simon Marlow's avatar
Simon Marlow committed
1021
		THREADED_BUILD_ONLY(
1022
		if (rts_argv[arg][2] != '\0') {
1023 1024 1025
		    RtsFlags.ParFlags.maxLocalSparks
		      = strtol(rts_argv[arg]+2, (char **) NULL, 10);
		    if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1026
		      errorBelch("bad value for -e");
1027
		      error = rtsTrue;
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
		    }
		}
		) break;

	      /* =========== TICKY ============================== */

	      case 'r': /* Basic profiling stats */
		TICKY_BUILD_ONLY(

		RtsFlags.TickyFlags.showTickyStats = rtsTrue;

1039 1040 1041 1042 1043 1044 1045
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
					*rts_argc, rts_argv, TICKY_FILENAME_FMT,
					&RtsFlags.TickyFlags.tickyFile);
		    if (r == -1) { error = rtsTrue; }
		}
1046 1047
	        ) break;

Simon Marlow's avatar
Simon Marlow committed
1048 1049 1050 1051 1052 1053 1054 1055 1056
	      /* =========== TRACING ---------=================== */

	      case 'v':
                switch(rts_argv[arg][2]) {
		case '\0':
		    errorBelch("incomplete RTS option: %s",rts_argv[arg]);
		    error = rtsTrue;
		    break;
		case 't':
Simon Marlow's avatar
Simon Marlow committed
1057
		    RtsFlags.DebugFlags.timestamp = rtsTrue;
Simon Marlow's avatar
Simon Marlow committed
1058 1059
		    break;
		case 's':
1060
		case 'g':
Simon Marlow's avatar
Simon Marlow committed
1061
                    // ignored for backwards-compat
1062
		    break;
Simon Marlow's avatar
Simon Marlow committed
1063 1064 1065 1066 1067 1068 1069
		default:
		    errorBelch("unknown RTS option: %s",rts_argv[arg]);
		    error = rtsTrue;
		    break;
		}
                break;

1070 1071 1072 1073 1074
	      /* =========== EXTENDED OPTIONS =================== */

              case 'x': /* Extend the argument space */
                switch(rts_argv[arg][2]) {
                  case '\0':
1075
		    errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1076 1077 1078
		    error = rtsTrue;
		    break;

1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
                case 'b': /* heapBase in hex; undocumented */
                    if (rts_argv[arg][3] != '\0') {
                        RtsFlags.GcFlags.heapBase
                            = strtol(rts_argv[arg]+3, (char **) NULL, 16);
                    } else {
                        errorBelch("-xb: requires argument");
                        error = rtsTrue;
                    }
                    break;

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
#if defined(x86_64_HOST_ARCH)
                case 'm': /* linkerMemBase */
                    if (rts_argv[arg][3] != '\0') {
                        RtsFlags.MiscFlags.linkerMemBase
                            = strtol(rts_argv[arg]+3, (char **)