1 /* -----------------------------------------------------------------------------
3 * (c) The AQUA Project, Glasgow University, 1994-1997
4 * (c) The GHC Team, 1998-2006
6 * Functions for parsing the argument list.
8 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
15 #include "Profiling.h"
27 * Split argument lists
29 int prog_argc = 0; /* an "int" so as to match normal "argc" */
30 char **prog_argv = NULL;
31 int full_prog_argc = 0; /* an "int" so as to match normal "argc" */
32 char **full_prog_argv = NULL;
33 char *prog_name = NULL; /* 'basename' of prog_argv[0] */
34 int rts_argc = 0; /* ditto */
35 char *rts_argv[MAX_RTS_ARGS];
38 * constants, used later
43 /* -----------------------------------------------------------------------------
45 -------------------------------------------------------------------------- */
47 static int /* return NULL on error */
50 int argc, char *argv[],
51 int rts_argc, char *rts_argv[],
52 const char *FILENAME_FMT,
55 static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max);
56 static void bad_option(const char *s);
58 static void read_trace_flags(char *arg);
61 /* -----------------------------------------------------------------------------
62 * Command-line option parsing routines.
63 * ---------------------------------------------------------------------------*/
65 void initRtsFlagsDefaults(void)
67 RtsFlags.GcFlags.statsFile = NULL;
68 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
70 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
71 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
72 RtsFlags.GcFlags.stkChunkSize = (32 * 1024) / sizeof(W_);
73 RtsFlags.GcFlags.stkChunkBufferSize = (1 * 1024) / sizeof(W_);
75 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
76 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
77 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
78 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
79 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
80 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
81 RtsFlags.GcFlags.oldGenFactor = 2;
82 RtsFlags.GcFlags.generations = 2;
83 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
84 RtsFlags.GcFlags.compact = rtsFalse;
85 RtsFlags.GcFlags.compactThreshold = 30.0;
86 RtsFlags.GcFlags.sweep = rtsFalse;
87 #ifdef RTS_GTK_FRONTPANEL
88 RtsFlags.GcFlags.frontpanel = rtsFalse;
90 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
93 /* ToDo: Perhaps by adjusting this value we can make linking without
94 * -static work (i.e., not generate a core-dumping executable)? */
95 # if SIZEOF_VOID_P == 8
96 RtsFlags.GcFlags.heapBase = 0x180000000L;
98 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
101 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
105 RtsFlags.DebugFlags.scheduler = rtsFalse;
106 RtsFlags.DebugFlags.interpreter = rtsFalse;
107 RtsFlags.DebugFlags.weak = rtsFalse;
108 RtsFlags.DebugFlags.gccafs = rtsFalse;
109 RtsFlags.DebugFlags.gc = rtsFalse;
110 RtsFlags.DebugFlags.block_alloc = rtsFalse;
111 RtsFlags.DebugFlags.sanity = rtsFalse;
112 RtsFlags.DebugFlags.stable = rtsFalse;
113 RtsFlags.DebugFlags.stm = rtsFalse;
114 RtsFlags.DebugFlags.prof = rtsFalse;
115 RtsFlags.DebugFlags.apply = rtsFalse;
116 RtsFlags.DebugFlags.linker = rtsFalse;
117 RtsFlags.DebugFlags.squeeze = rtsFalse;
118 RtsFlags.DebugFlags.hpc = rtsFalse;
119 RtsFlags.DebugFlags.sparks = rtsFalse;
122 #if defined(PROFILING)
123 RtsFlags.CcFlags.doCostCentres = 0;
124 #endif /* PROFILING */
126 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
127 RtsFlags.ProfFlags.profileInterval = 100;
130 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
131 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
132 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
133 RtsFlags.ProfFlags.ccsLength = 25;
134 RtsFlags.ProfFlags.modSelector = NULL;
135 RtsFlags.ProfFlags.descrSelector = NULL;
136 RtsFlags.ProfFlags.typeSelector = NULL;
137 RtsFlags.ProfFlags.ccSelector = NULL;
138 RtsFlags.ProfFlags.ccsSelector = NULL;
139 RtsFlags.ProfFlags.retainerSelector = NULL;
140 RtsFlags.ProfFlags.bioSelector = NULL;
144 RtsFlags.TraceFlags.tracing = TRACE_NONE;
145 RtsFlags.TraceFlags.timestamp = rtsFalse;
146 RtsFlags.TraceFlags.scheduler = rtsFalse;
149 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
150 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
152 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
153 RtsFlags.MiscFlags.machineReadable = rtsFalse;
154 RtsFlags.MiscFlags.linkerMemBase = 0;
157 RtsFlags.ParFlags.nNodes = 1;
158 RtsFlags.ParFlags.migrate = rtsTrue;
159 RtsFlags.ParFlags.parGcEnabled = 1;
160 RtsFlags.ParFlags.parGcGen = 0;
161 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
162 RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
163 RtsFlags.ParFlags.setAffinity = 0;
166 #if defined(THREADED_RTS)
167 RtsFlags.ParFlags.maxLocalSparks = 4096;
168 #endif /* THREADED_RTS */
171 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
172 RtsFlags.TickyFlags.tickyFile = NULL;
176 /* By default no special measurements taken */
177 RtsFlags.PapiFlags.eventType = 0;
178 RtsFlags.PapiFlags.numUserEvents = 0;
185 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
187 " +RTS Indicates run time system options follow",
188 " -RTS Indicates program arguments follow",
189 " --RTS Indicates that ALL subsequent arguments will be given to the",
190 " program (including any of these RTS flags)",
192 "The following run time system options are available:",
194 " -? Prints this message and exits; the program is not executed",
195 " --info Print information about the RTS used by this program",
197 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
198 " -ki<size> Sets the initial thread stack size (default 1k) Egs: -ki4k -ki2m",
199 " -kc<size> Sets the stack chunk size (default 32k)",
200 " -kb<size> Sets the stack chunk buffer size (default 1k)",
202 " -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
203 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
204 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
205 " -m<n> Minimum % of heap which must be available (default 3%)",
206 " -G<n> Number of generations (default: 2)",
207 " -c<n> Use in-place compaction instead of copying in the oldest generation",
208 " when live data is at least <n>% of the maximum heap size set with",
209 " -M (default: 30%)",
210 " -c Use in-place compaction for all oldest generation collections",
211 " (the default is to use copying)",
212 " -w Use mark-region for the oldest generation (experimental)",
213 #if defined(THREADED_RTS)
214 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
217 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
218 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
219 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
220 #ifdef RTS_GTK_FRONTPANEL
221 " -f Display front panel (requires X11 & GTK+)",
225 " -Z Don't squeeze out update frames on stack overflow",
226 " -B Sound the bell at the start of each garbage collection",
227 #if defined(PROFILING)
229 " -px Time/allocation profile (XML) (output file <program>.prof)",
230 " -p Time/allocation profile (output file <program>.prof)",
231 " -P More detailed Time/Allocation profile",
232 " -Pa Give information about *all* cost centres",
234 # if defined(PROFILING)
236 " -hx Heap residency profile (XML) (output file <program>.prof)",
237 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
238 " break-down: c = cost centre stack (default)",
240 " d = closure description",
241 " y = type description",
243 " b = biography (LAG,DRAG,VOID,USE)",
244 " A subset of closures may be selected thusly:",
245 " -hc<cc>,... specific cost centre(s) (top of stack only)",
246 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
247 " -hm<mod>... all cost centres from the specified modules(s)",
248 " -hd<des>,... closures with specified closure descriptions",
249 " -hy<typ>... closures with specified type descriptions",
250 " -hr<cc>... closures with specified retainers",
251 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
253 " -R<size> Set the maximum retainer set size (default: 8)",
255 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
258 " -xt Include threads (TSOs) in a heap profile",
260 " -xc Show current cost centre stack on raising an exception",
262 #endif /* PROFILING or PAR */
266 " -l[flags] Log events in binary format to the file <program>.eventlog",
268 " -v[flags] Log events to stderr",
270 " where [flags] can contain:",
271 " s scheduler events",
273 " t add time stamps (only useful with -v)",
277 #if !defined(PROFILING)
279 " -hT Heap residency profile (output file <program>.hp)",
281 " -i<sec> Time between heap samples (seconds, default: 0.1)",
283 #if defined(TICKY_TICKY)
284 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
287 " -C<secs> Context-switch interval in seconds.",
288 " 0 or no argument means switch as often as possible.",
289 " Default: 0.02 sec; resolution is set by -V below.",
290 " -V<secs> Master tick interval in seconds (0 == disable timer).",
291 " This sets the resolution for -C and the profile timer -i.",
292 " Default: 0.02 sec.",
295 " -Ds DEBUG: scheduler",
296 " -Di DEBUG: interpreter",
298 " -DG DEBUG: gccafs",
301 " -DS DEBUG: sanity",
302 " -Dt DEBUG: stable",
304 " -De DEBUG: event logging",
306 " -Dl DEBUG: linker",
308 " -Dz DEBUG: stack squezing",
309 " -Dc DEBUG: program coverage",
310 " -Dr DEBUG: sparks",
312 " NOTE: DEBUG events are sent to stderr by default; add -l to create a",
313 " binary event log file instead.",
316 #if defined(THREADED_RTS) && !defined(NOSMP)
317 " -N<n> Use <n> processors (default: 1)",
318 " -N Determine the number of processors to use automatically",
319 " -qg[<n>] Use parallel GC only for generations >= <n>",
320 " (default: 0, -qg alone turns off parallel GC)",
321 " -qb[<n>] Use load-balancing in the parallel GC only for generations >= <n>",
322 " (default: 1, -qb alone turns off load-balancing)",
323 " -qa Use the OS to set thread affinity (experimental)",
324 " -qm Don't automatically migrate threads between CPUs",
326 " --install-signal-handlers=<yes|no>",
327 " Install signal handlers (default: yes)",
328 #if defined(THREADED_RTS)
329 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
331 #if defined(x86_64_HOST_ARCH)
332 " -xm Base address to mmap memory in the GHCi linker",
333 " (hex; must be <80000000)",
335 #if defined(USE_PAPI)
336 " -aX CPU performance counter measurements using PAPI",
337 " (use with the -s<file> option). X is one of:",
340 " 1 - level 1 cache misses",
341 " 2 - level 2 cache misses",
342 " b - branch mispredictions",
343 " s - stalled cycles",
344 " e - cache miss and branch misprediction events",
345 " +PAPI_EVENT - collect papi preset event PAPI_EVENT",
346 " #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
349 "RTS options may also be specified using the GHCRTS environment variable.",
351 "Other RTS options may be available for programs compiled a different way.",
352 "The GHC User's Guide has full details.",
357 STATIC_INLINE rtsBool
358 strequal(const char *a, const char * b)
360 return(strcmp(a, b) == 0);
364 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
370 while (isspace(*c1)) { c1++; };
372 while (!isspace(*c2) && *c2 != '\0') { c2++; };
374 if (c1 == c2) { break; }
376 if (*rts_argc < MAX_RTS_ARGS-1) {
377 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
378 strncpy(s, c1, c2-c1);
380 rts_argv[(*rts_argc)++] = s;
382 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
386 } while (*c1 != '\0');
390 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
392 rtsBool error = rtsFalse;
403 // process arguments from the ghc_rts_opts global variable first.
404 // (arguments from the GHCRTS environment variable and the command
405 // line override these).
407 if (ghc_rts_opts != NULL) {
408 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
412 // process arguments from the GHCRTS environment variable next
413 // (arguments from the command line override these).
415 char *ghc_rts = getenv("GHCRTS");
417 if (ghc_rts != NULL) {
418 if (rtsOptsEnabled != rtsOptsNone) {
419 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
422 errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n Link with -rtsopts to enable them.");
423 // We don't actually exit, just warn
428 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
429 // argv[0] must be PGM argument -- leave in argv
431 for (mode = PGM; arg < total_arg; arg++) {
432 // The '--RTS' argument disables all future +RTS ... -RTS processing.
433 if (strequal("--RTS", argv[arg])) {
437 // The '--' argument is passed through to the program, but
438 // disables all further +RTS ... -RTS processing.
439 else if (strequal("--", argv[arg])) {
442 else if (strequal("+RTS", argv[arg])) {
443 if (rtsOptsEnabled != rtsOptsNone) {
447 errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
448 stg_exit(EXIT_FAILURE);
451 else if (strequal("-RTS", argv[arg])) {
454 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
455 rts_argv[(*rts_argc)++] = argv[arg];
457 else if (mode == PGM) {
458 argv[(*argc)++] = argv[arg];
461 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
464 // process remaining program arguments
465 for (; arg < total_arg; arg++) {
466 argv[(*argc)++] = argv[arg];
468 argv[*argc] = (char *) 0;
469 rts_argv[*rts_argc] = (char *) 0;
471 // Process RTS (rts_argv) part: mainly to determine statsfile
472 for (arg = 0; arg < *rts_argc; arg++) {
473 if (rts_argv[arg][0] != '-') {
475 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
480 switch(rts_argv[arg][1]) {
482 if (strequal("info", &rts_argv[arg][2])) {
491 if (rtsOptsEnabled != rtsOptsAll)
493 errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
494 stg_exit(EXIT_FAILURE);
497 switch(rts_argv[arg][1]) {
499 /* process: general args, then PROFILING-only ones, then
500 CONCURRENT-only, TICKY-only (same order as defined in
501 RtsFlags.lh); within those groups, mostly in
502 case-insensitive alphabetical order. Final group is
503 x*, which allows for more options.
507 # define TICKY_BUILD_ONLY(x) x
509 # define TICKY_BUILD_ONLY(x) \
510 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
515 # define PROFILING_BUILD_ONLY(x) x
517 # define PROFILING_BUILD_ONLY(x) \
518 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
523 # define TRACING_BUILD_ONLY(x) x
525 # define TRACING_BUILD_ONLY(x) \
526 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
531 # define THREADED_BUILD_ONLY(x) x
533 # define THREADED_BUILD_ONLY(x) \
534 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
539 # define DEBUG_BUILD_ONLY(x) x
541 # define DEBUG_BUILD_ONLY(x) \
542 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
546 /* =========== GENERAL ========================== */
551 /* This isn't going to allow us to keep related options
552 together as we add more --* flags. We really need a
553 proper options parser. */
555 if (strequal("install-signal-handlers=yes",
556 &rts_argv[arg][2])) {
557 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
559 else if (strequal("install-signal-handlers=no",
560 &rts_argv[arg][2])) {
561 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
563 else if (strequal("machine-readable",
564 &rts_argv[arg][2])) {
565 RtsFlags.MiscFlags.machineReadable = rtsTrue;
567 else if (strequal("info",
568 &rts_argv[arg][2])) {
573 errorBelch("unknown RTS option: %s",rts_argv[arg]);
578 RtsFlags.GcFlags.minAllocAreaSize
579 = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
585 switch(rts_argv[arg][2]) {
587 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
590 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
593 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
596 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
599 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
603 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
604 errorBelch("maximum number of PAPI events reached");
605 stg_exit(EXIT_FAILURE);
607 nat eventNum = RtsFlags.PapiFlags.numUserEvents++;
608 char kind = rts_argv[arg][2];
609 nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;
611 RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
612 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
613 RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
616 bad_option( rts_argv[arg] );
622 RtsFlags.GcFlags.ringBell = rtsTrue;
626 if (rts_argv[arg][2] != '\0') {
627 RtsFlags.GcFlags.compactThreshold =
628 atof(rts_argv[arg]+2);
630 RtsFlags.GcFlags.compact = rtsTrue;
635 RtsFlags.GcFlags.sweep = rtsTrue;
639 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
641 if (RtsFlags.GcFlags.oldGenFactor < 0)
642 bad_option( rts_argv[arg] );
650 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
653 RtsFlags.DebugFlags.scheduler = rtsTrue;
656 RtsFlags.DebugFlags.interpreter = rtsTrue;
659 RtsFlags.DebugFlags.weak = rtsTrue;
662 RtsFlags.DebugFlags.gccafs = rtsTrue;
665 RtsFlags.DebugFlags.gc = rtsTrue;
668 RtsFlags.DebugFlags.block_alloc = rtsTrue;
671 RtsFlags.DebugFlags.sanity = rtsTrue;
674 RtsFlags.DebugFlags.stable = rtsTrue;
677 RtsFlags.DebugFlags.prof = rtsTrue;
680 RtsFlags.DebugFlags.linker = rtsTrue;
683 RtsFlags.DebugFlags.apply = rtsTrue;
686 RtsFlags.DebugFlags.stm = rtsTrue;
689 RtsFlags.DebugFlags.squeeze = rtsTrue;
692 RtsFlags.DebugFlags.hpc = rtsTrue;
695 RtsFlags.DebugFlags.sparks = rtsTrue;
698 bad_option( rts_argv[arg] );
701 // -Dx also turns on -v. Use -l to direct trace
702 // events to the .eventlog file instead.
703 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
708 RtsFlags.GcFlags.maxStkSize =
709 decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
713 switch(rts_argv[arg][2]) {
715 RtsFlags.GcFlags.stkChunkSize =
716 decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
719 RtsFlags.GcFlags.stkChunkBufferSize =
720 decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
723 RtsFlags.GcFlags.initialStkSize =
724 decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
727 RtsFlags.GcFlags.initialStkSize =
728 decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
734 RtsFlags.GcFlags.maxHeapSize =
735 decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
736 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
740 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
742 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
743 RtsFlags.GcFlags.pcFreeHeap > 100)
744 bad_option( rts_argv[arg] );
748 RtsFlags.GcFlags.generations =
749 decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
753 if (rts_argv[arg][2] == '\0') {
754 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
756 RtsFlags.GcFlags.heapSizeSuggestion =
757 (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
761 #ifdef RTS_GTK_FRONTPANEL
763 RtsFlags.GcFlags.frontpanel = rtsTrue;
767 case 'I': /* idle GC delay */
768 if (rts_argv[arg][2] == '\0') {
773 /* Convert to millisecs */
774 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
775 RtsFlags.GcFlags.idleGCDelayTime = cst;
780 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
784 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
788 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
794 r = open_stats_file(arg, *argc, argv,
795 *rts_argc, rts_argv, NULL,
796 &RtsFlags.GcFlags.statsFile);
797 if (r == -1) { error = rtsTrue; }
802 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
805 /* =========== PROFILING ========================== */
807 case 'P': /* detailed cost centre profiling (time/alloc) */
808 case 'p': /* cost centre profiling (time/alloc) */
809 PROFILING_BUILD_ONLY(
810 switch (rts_argv[arg][2]) {
812 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
815 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
818 if (rts_argv[arg][1] == 'P') {
819 RtsFlags.CcFlags.doCostCentres =
820 COST_CENTRES_VERBOSE;
822 RtsFlags.CcFlags.doCostCentres =
823 COST_CENTRES_SUMMARY;
830 PROFILING_BUILD_ONLY(
831 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
834 PROFILING_BUILD_ONLY(
835 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
836 if(RtsFlags.ProfFlags.ccsLength <= 0) {
837 bad_option(rts_argv[arg]);
840 case 'h': /* serial heap profile */
841 #if !defined(PROFILING)
842 switch (rts_argv[arg][2]) {
845 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
848 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
852 PROFILING_BUILD_ONLY(
853 switch (rts_argv[arg][2]) {
867 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
869 char *left = strchr(rts_argv[arg], '{');
870 char *right = strrchr(rts_argv[arg], '}');
872 // curly braces are optional, for
877 left = rts_argv[arg] + 3;
880 right = rts_argv[arg] + strlen(rts_argv[arg]);
884 switch (rts_argv[arg][2]) {
885 case 'c': // cost centre label select
886 RtsFlags.ProfFlags.ccSelector = left;
889 RtsFlags.ProfFlags.ccsSelector = left;
892 case 'm': // cost centre module select
893 RtsFlags.ProfFlags.modSelector = left;
896 case 'd': // closure descr select
897 RtsFlags.ProfFlags.descrSelector = left;
900 case 'y': // closure type select
901 RtsFlags.ProfFlags.typeSelector = left;
904 case 'r': // retainer select
905 RtsFlags.ProfFlags.retainerSelector = left;
908 case 'b': // biography select
909 RtsFlags.ProfFlags.bioSelector = left;
916 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
917 errorBelch("multiple heap profile options");
922 switch (rts_argv[arg][2]) {
926 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
930 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
934 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
938 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
942 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
946 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
952 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
956 #endif /* PROFILING */
959 case 'i': /* heap sample interval */
960 if (rts_argv[arg][2] == '\0') {
965 /* Convert to milliseconds */
966 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
967 RtsFlags.ProfFlags.profileInterval = cst;
971 /* =========== CONCURRENT ========================= */
972 case 'C': /* context switch interval */
973 if (rts_argv[arg][2] == '\0')
974 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
978 /* Convert to milliseconds */
979 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
980 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
984 case 'V': /* master tick interval */
985 if (rts_argv[arg][2] == '\0') {
986 // turns off ticks completely
987 RtsFlags.MiscFlags.tickInterval = 0;
991 /* Convert to milliseconds */
992 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
993 RtsFlags.MiscFlags.tickInterval = cst;
1000 if (rts_argv[arg][2] == '\0') {
1001 #if defined(PROFILING)
1002 RtsFlags.ParFlags.nNodes = 1;
1004 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1007 RtsFlags.ParFlags.nNodes
1008 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1009 if (RtsFlags.ParFlags.nNodes <= 0) {
1010 errorBelch("bad value for -N");
1013 #if defined(PROFILING)
1014 if (RtsFlags.ParFlags.nNodes > 1) {
1015 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1023 THREADED_BUILD_ONLY(
1024 switch (rts_argv[arg][2]) {
1026 // backwards compat only
1027 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1030 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1037 THREADED_BUILD_ONLY(
1038 switch (rts_argv[arg][2]) {
1040 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1044 if (rts_argv[arg][3] == '\0') {
1045 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1047 RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1048 RtsFlags.ParFlags.parGcGen
1049 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1053 if (rts_argv[arg][3] == '\0') {
1054 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1057 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1058 RtsFlags.ParFlags.parGcLoadBalancingGen
1059 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1063 RtsFlags.ParFlags.setAffinity = rtsTrue;
1066 RtsFlags.ParFlags.migrate = rtsFalse;
1069 // -qw was removed; accepted for backwards compat
1072 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1078 /* =========== PARALLEL =========================== */
1080 THREADED_BUILD_ONLY(
1081 if (rts_argv[arg][2] != '\0') {
1082 RtsFlags.ParFlags.maxLocalSparks
1083 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1084 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1085 errorBelch("bad value for -e");
1091 /* =========== TICKY ============================== */
1093 case 'r': /* Basic profiling stats */
1096 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1100 r = open_stats_file(arg, *argc, argv,
1101 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1102 &RtsFlags.TickyFlags.tickyFile);
1103 if (r == -1) { error = rtsTrue; }
1107 /* =========== TRACING ---------=================== */
1111 RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1112 read_trace_flags(&rts_argv[arg][2]);
1118 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1119 read_trace_flags(&rts_argv[arg][2]);
1123 /* =========== EXTENDED OPTIONS =================== */
1125 case 'x': /* Extend the argument space */
1126 switch(rts_argv[arg][2]) {
1128 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1132 case 'b': /* heapBase in hex; undocumented */
1133 if (rts_argv[arg][3] != '\0') {
1134 RtsFlags.GcFlags.heapBase
1135 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1137 errorBelch("-xb: requires argument");
1142 #if defined(x86_64_HOST_ARCH)
1143 case 'm': /* linkerMemBase */
1144 if (rts_argv[arg][3] != '\0') {
1145 RtsFlags.MiscFlags.linkerMemBase
1146 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1147 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1148 errorBelch("-xm: value must be <80000000");
1152 RtsFlags.MiscFlags.linkerMemBase = 0;
1157 case 'c': /* Debugging tool: show current cost centre on an exception */
1158 PROFILING_BUILD_ONLY(
1159 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1163 case 't': /* Include memory used by TSOs in a heap profile */
1164 PROFILING_BUILD_ONLY(
1165 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1169 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1172 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1176 break; /* defensive programming */
1178 /* =========== OH DEAR ============================ */
1180 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1187 if (RtsFlags.MiscFlags.tickInterval < 0) {
1188 RtsFlags.MiscFlags.tickInterval = 50;
1191 // If the master timer is disabled, turn off the other timers.
1192 if (RtsFlags.MiscFlags.tickInterval == 0) {
1193 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1194 RtsFlags.GcFlags.idleGCDelayTime = 0;
1195 RtsFlags.ProfFlags.profileInterval = 0;
1198 // Determine what tick interval we should use for the RTS timer
1199 // by taking the shortest of the various intervals that we need to
1201 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1202 RtsFlags.MiscFlags.tickInterval =
1203 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1204 RtsFlags.MiscFlags.tickInterval);
1207 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1208 RtsFlags.MiscFlags.tickInterval =
1209 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1210 RtsFlags.MiscFlags.tickInterval);
1213 if (RtsFlags.ProfFlags.profileInterval > 0) {
1214 RtsFlags.MiscFlags.tickInterval =
1215 stg_min(RtsFlags.ProfFlags.profileInterval,
1216 RtsFlags.MiscFlags.tickInterval);
1219 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1220 RtsFlags.ConcFlags.ctxtSwitchTicks =
1221 RtsFlags.ConcFlags.ctxtSwitchTime /
1222 RtsFlags.MiscFlags.tickInterval;
1224 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1227 if (RtsFlags.ProfFlags.profileInterval > 0) {
1228 RtsFlags.ProfFlags.profileIntervalTicks =
1229 RtsFlags.ProfFlags.profileInterval /
1230 RtsFlags.MiscFlags.tickInterval;
1232 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1235 if (RtsFlags.GcFlags.stkChunkBufferSize >
1236 RtsFlags.GcFlags.stkChunkSize / 2) {
1237 errorBelch("stack chunk buffer size (-kb) must be less than 50%% of the stack chunk size (-kc)");
1245 for (p = usage_text; *p; p++)
1246 errorBelch("%s", *p);
1247 stg_exit(EXIT_FAILURE);
1253 stats_fprintf(FILE *f, char *s, ...)
1265 static int /* return -1 on error */
1268 int argc, char *argv[],
1269 int rts_argc, char *rts_argv[],
1270 const char *FILENAME_FMT,
1275 if (strequal(rts_argv[arg]+2, "stderr")
1276 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1277 f = NULL; /* NULL means use debugBelch */
1279 if (rts_argv[arg][2] != '\0') { /* stats file specified */
1280 f = fopen(rts_argv[arg]+2,"w");
1282 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1283 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1284 f = fopen(stats_filename,"w");
1287 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1294 /* Write argv and rtsv into start of stats file */
1296 for(count = 0; count < argc; count++) {
1297 stats_fprintf(f, "%s ", argv[count]);
1299 stats_fprintf(f, "+RTS ");
1300 for(count = 0; count < rts_argc; count++)
1301 stats_fprintf(f, "%s ", rts_argv[count]);
1302 stats_fprintf(f, "\n");
1310 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1328 if (c == 'g' || c == 'G')
1329 m *= 1024*1024*1024;
1330 else if (c == 'm' || c == 'M')
1332 else if (c == 'k' || c == 'K')
1334 else if (c == 'w' || c == 'W')
1340 if (m < 0 || val < min || val > max) {
1341 // printf doesn't like 64-bit format specs on Windows
1342 // apparently, so fall back to unsigned long.
1343 errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1344 stg_exit(EXIT_FAILURE);
1350 #if defined(TRACING)
1351 static void read_trace_flags(char *arg)
1355 for (c = arg; *c != '\0'; c++) {
1360 RtsFlags.TraceFlags.scheduler = rtsTrue;
1363 RtsFlags.TraceFlags.timestamp = rtsTrue;
1366 // ignored for backwards-compat
1369 errorBelch("unknown trace option: %c",*c);
1376 static void GNU_ATTRIBUTE(__noreturn__)
1377 bad_option(const char *s)
1379 errorBelch("bad RTS option: %s", s);
1380 stg_exit(EXIT_FAILURE);
1383 /* -----------------------------------------------------------------------------
1384 Getting/Setting the program's arguments.
1386 These are used by System.Environment, and parts of the RTS.
1387 -------------------------------------------------------------------------- */
1390 setProgName(char *argv[])
1392 /* Remove directory from argv[0] -- default files in current directory */
1393 #if !defined(mingw32_HOST_OS)
1395 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1396 prog_name = last_slash+1;
1398 prog_name = argv[0];
1401 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1402 while ( last_slash > argv[0] ) {
1403 if ( *last_slash == '/' || *last_slash == '\\' ) {
1404 prog_name = last_slash+1;
1409 prog_name = argv[0];
1414 getProgArgv(int *argc, char **argv[])
1416 if (argc) { *argc = prog_argc; }
1417 if (argv) { *argv = prog_argv; }
1421 setProgArgv(int argc, char *argv[])
1423 /* Usually this is done by startupHaskell, so we don't need to call this.
1424 However, sometimes Hugs wants to change the arguments which Haskell
1425 getArgs >>= ... will be fed. So you can do that by calling here
1426 _after_ calling startupHaskell.
1430 setProgName(prog_argv);
1433 /* These functions record and recall the full arguments, including the
1434 +RTS ... -RTS options. The reason for adding them was so that the
1435 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1437 getFullProgArgv(int *argc, char **argv[])
1439 if (argc) { *argc = full_prog_argc; }
1440 if (argv) { *argv = full_prog_argv; }
1444 setFullProgArgv(int argc, char *argv[])
1447 full_prog_argc = argc;
1448 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1449 "setFullProgArgv 1");
1450 for (i = 0; i < argc; i++) {
1451 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1452 "setFullProgArgv 2");
1453 strcpy(full_prog_argv[i], argv[i]);
1455 full_prog_argv[argc] = NULL;
1459 freeFullProgArgv (void)
1463 if (full_prog_argv != NULL) {
1464 for (i = 0; i < full_prog_argc; i++) {
1465 stgFree(full_prog_argv[i]);
1467 stgFree(full_prog_argv);
1471 full_prog_argv = NULL;