RtsFlags.c 40.4 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.heapSizeSuggestionAuto = rtsFalse;
74
    RtsFlags.GcFlags.pcFreeHeap		= 3;	/* 3% */
75
    RtsFlags.GcFlags.oldGenFactor       = 2;
76
    RtsFlags.GcFlags.generations        = 2;
77
    RtsFlags.GcFlags.steps              = 2;
78
    RtsFlags.GcFlags.squeezeUpdFrames	= rtsTrue;
79
    RtsFlags.GcFlags.compact            = rtsFalse;
80
    RtsFlags.GcFlags.compactThreshold   = 30.0;
81
    RtsFlags.GcFlags.sweep              = rtsFalse;
82 83 84
#ifdef RTS_GTK_FRONTPANEL
    RtsFlags.GcFlags.frontpanel         = rtsFalse;
#endif
85
    RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
86

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

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

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

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

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

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

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

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

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

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

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

260
#ifdef TRACING
Simon Marlow's avatar
Simon Marlow committed
261
"",
262 263 264 265 266
"  -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
267 268 269
"",
#endif

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

358 359 360 361 362 363 364 365 366 367 368 369 370 371
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
372
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
373 374 375 376 377 378 379 380 381 382 383
	    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');
}
    
384 385 386 387 388 389 390
void
setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
{
    rtsBool error = rtsFalse;
    I_ mode;
    I_ arg, total_arg;

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

    *argc = 1;
    *rts_argc = 0;

398 399 400 401 402 403 404 405 406
    // 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);
	}
    }

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

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

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

420 421 422 423 424 425 426 427 428 429 430 431
    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])) {
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
	    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);
	}
    }
447 448 449
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
450 451 452 453 454
    }
    argv[*argc] = (char *) 0;
    rts_argv[*rts_argc] = (char *) 0;

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

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

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

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

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

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

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

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

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

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
#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;
555 556 557
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
558 559 560 561 562 563 564 565
                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;
566 567 568 569 570 571
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

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

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

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

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

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

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

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

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

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

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

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

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

693
	      case 'H':
694 695 696 697 698 699 700
                  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;
701

702 703 704 705 706 707
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

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

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

720
	      case 'S':
721 722
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
723

724
	      case 's':
725 726
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
727 728

	      case 't':
729 730
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
731

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

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

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

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

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

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

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

877
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
878
			errorBelch("multiple heap profile options");
879 880 881 882 883 884 885 886 887 888 889 890
			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':
891 892
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
893 894
		    case 'D':
		    case 'd':
895 896
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
			  break;
897 898
		    case 'Y':
		    case 'y':
899 900
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
			  break;
901 902
		    case 'R':
		    case 'r':
903 904
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
			  break;
905 906
		    case 'B':
		    case 'b':
907 908
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
			  break;
909 910
		    }
		    break;
911
		      
912
		default:
913
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
914 915 916
		    error = rtsTrue;
		}
		) 
917
#endif /* PROFILING */
andy's avatar
andy committed
918 919 920 921 922 923 924 925 926 927
    	    	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));
928
		    RtsFlags.ProfFlags.profileInterval = cst;
andy's avatar
andy committed
929 930
		}
		break;
931 932 933 934 935 936 937 938 939 940 941 942 943 944

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

945 946 947 948 949 950 951 952 953 954 955 956 957
              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;

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

	      case 'g':
		THREADED_BUILD_ONLY(
985 986 987 988 989 990 991 992 993 994 995
		    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;
996

Simon Marlow's avatar
Simon Marlow committed
997
	      case 'q':
998 999 1000 1001 1002
		    switch (rts_argv[arg][2]) {
		    case '\0':
			errorBelch("incomplete RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
1003
                    case 'g':
1004 1005 1006 1007
                        if (rts_argv[arg][3] == '\0') {
                            RtsFlags.ParFlags.parGcEnabled = rtsFalse;
                        } else {
                            RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1008 1009 1010 1011
                            RtsFlags.ParFlags.parGcGen
                                = strtol(rts_argv[arg]+3, (char **) NULL, 10);
                        }
                        break;
1012
		    case 'b':
1013 1014 1015 1016 1017 1018 1019 1020 1021
                        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;
1022 1023 1024
		    case 'a':
			RtsFlags.ParFlags.setAffinity = rtsTrue;
			break;
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
		    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;
1037
#endif
1038