RtsFlags.c 40.7 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
static void bad_option(const char *s);
56 57 58
#ifdef TRACING
static void read_trace_flags(char *arg);
#endif
59 60 61 62 63 64 65 66 67 68

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

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

69
    RtsFlags.GcFlags.maxStkSize		= (8 * 1024 * 1024) / sizeof(W_);
70 71
    RtsFlags.GcFlags.initialStkSize	= 1024 / sizeof(W_);

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

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

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

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

123
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
124
    RtsFlags.ProfFlags.profileInterval    = 100;
125 126

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

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

146 147
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 20;  /* In milliseconds */
148

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

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

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

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

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

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

230 231
# if defined(PROFILING)
"",
232 233 234 235 236 237 238 239
"  -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)",
240
"  A subset of closures may be selected thusly:",
241 242
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
243 244 245 246 247
"    -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)",
248 249
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
250 251 252
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
253
"",
254 255
"  -xt            Include threads (TSOs) in a heap profile",
"",
256
"  -xc      Show current cost centre stack on raising an exception",
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 267 268 269 270
"  -l[flags]  Log events in binary format to the file <program>.eventlog",
#  ifdef DEBUG
"  -v[flags]  Log events to stderr",
#  endif
"             where [flags] can contain:",
"                s    scheduler events",
#  ifdef DEBUG
"                t    add time stamps (only useful with -v)",
#  endif
Simon Marlow's avatar
Simon Marlow committed
271 272
#endif

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

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

394
    setProgName (argv);
395 396 397 398 399 400
    total_arg = *argc;
    arg = 1;

    *argc = 1;
    *rts_argc = 0;

401 402 403 404 405 406 407 408 409
    // 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);
	}
    }

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

	if (ghc_rts != NULL) {
416
	    splitRtsFlags(ghc_rts, rts_argc, rts_argv);
417 418
	}
    }
419

420 421 422
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

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

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

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

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

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
478
errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
479 480 481 482 483 484 485
error = rtsTrue;
#endif

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

490 491
#ifdef TRACING
# define TRACING_BUILD_ONLY(x)   x
Simon Marlow's avatar
Simon Marlow committed
492
#else
493
# define TRACING_BUILD_ONLY(x) \
494
errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
Simon Marlow's avatar
Simon Marlow committed
495 496 497
error = rtsTrue;
#endif

498 499 500 501
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
502 503 504 505 506 507 508 509 510
errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
error = rtsTrue;
#endif

#ifdef DEBUG
# define DEBUG_BUILD_ONLY(x) x
#else
# define DEBUG_BUILD_ONLY(x) \
errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
511
error = rtsTrue;
512 513 514 515 516 517 518
#endif

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

519 520 521 522 523 524 525 526 527 528 529 530
              /* 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
531 532 533 534
                  else if (strequal("machine-readable",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.machineReadable = rtsTrue;
                  }
535 536
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
537
                      printRtsInfo();
538 539
                      exit(0);
                  }
540 541 542 543 544
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
545
	      case 'A':
546 547 548 549
                  RtsFlags.GcFlags.minAllocAreaSize
                      = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
                           / BLOCK_SIZE;
                  break;
550

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
#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;
566 567 568
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
569 570 571 572 573 574 575 576
                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;
577 578 579 580 581 582
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

583 584 585 586
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

587
	      case 'c':
588 589 590 591
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
592
		      RtsFlags.GcFlags.compact = rtsTrue;
593 594
		  }
		  break;
595

596 597 598 599
              case 'w':
		RtsFlags.GcFlags.sweep = rtsTrue;
		break;

600 601 602 603 604 605 606
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
607
	      case 'D':
608
              DEBUG_BUILD_ONLY(
609 610 611 612 613 614 615 616
	      { 
		  char *c;

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

	      case 'K':
670 671 672
                  RtsFlags.GcFlags.maxStkSize =
                      decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
                  break;
673 674

	      case 'k':
675 676 677
                  RtsFlags.GcFlags.initialStkSize =
                      decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
                  break;
678 679

	      case 'M':
680 681 682 683
                  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;
684 685

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

688 689 690 691
                  if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
                      RtsFlags.GcFlags.pcFreeHeap > 100)
                      bad_option( rts_argv[arg] );
                  break;
692

693
	      case 'G':
694 695 696
                  RtsFlags.GcFlags.generations =
                      decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
                  break;
697

698
	      case 'H':
699 700 701 702 703 704 705
                  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;
706

707 708 709 710 711 712
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

713 714 715 716 717 718
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

719
		    /* Convert to millisecs */
720
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
721
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
722 723 724
		}
		break;

725
	      case 'S':
726 727
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
728

729
	      case 's':
730 731
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
732 733

	      case 't':
734 735
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
736

737
	    stats:
738 739 740
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
741
					*rts_argc, rts_argv, NULL,
742 743 744
					&RtsFlags.GcFlags.statsFile);
		    if (r == -1) { error = rtsTrue; }
		}
Simon Marlow's avatar
Simon Marlow committed
745
                break;
746 747 748 749 750 751 752 753 754

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

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

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