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.wakeupMigrate = rtsFalse;
160 RtsFlags.ParFlags.parGcEnabled = 1;
161 RtsFlags.ParFlags.parGcGen = 0;
162 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
163 RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
164 RtsFlags.ParFlags.setAffinity = 0;
167 #if defined(THREADED_RTS)
168 RtsFlags.ParFlags.maxLocalSparks = 4096;
169 #endif /* THREADED_RTS */
172 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
173 RtsFlags.TickyFlags.tickyFile = NULL;
177 /* By default no special measurements taken */
178 RtsFlags.PapiFlags.eventType = 0;
179 RtsFlags.PapiFlags.numUserEvents = 0;
186 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
188 " +RTS Indicates run time system options follow",
189 " -RTS Indicates program arguments follow",
190 " --RTS Indicates that ALL subsequent arguments will be given to the",
191 " program (including any of these RTS flags)",
193 "The following run time system options are available:",
195 " -? Prints this message and exits; the program is not executed",
196 " --info Print information about the RTS used by this program",
198 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
199 " -ki<size> Sets the initial thread stack size (default 1k) Egs: -ki4k -ki2m",
200 " -kc<size> Sets the stack chunk size (default 32k)",
201 " -kb<size> Sets the stack chunk buffer size (default 1k)",
203 " -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
204 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
205 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
206 " -m<n> Minimum % of heap which must be available (default 3%)",
207 " -G<n> Number of generations (default: 2)",
208 " -c<n> Use in-place compaction instead of copying in the oldest generation",
209 " when live data is at least <n>% of the maximum heap size set with",
210 " -M (default: 30%)",
211 " -c Use in-place compaction for all oldest generation collections",
212 " (the default is to use copying)",
213 " -w Use mark-region for the oldest generation (experimental)",
214 #if defined(THREADED_RTS)
215 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
218 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
219 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
220 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
221 #ifdef RTS_GTK_FRONTPANEL
222 " -f Display front panel (requires X11 & GTK+)",
226 " -Z Don't squeeze out update frames on stack overflow",
227 " -B Sound the bell at the start of each garbage collection",
228 #if defined(PROFILING)
230 " -px Time/allocation profile (XML) (output file <program>.prof)",
231 " -p Time/allocation profile (output file <program>.prof)",
232 " -P More detailed Time/Allocation profile",
233 " -Pa Give information about *all* cost centres",
235 # if defined(PROFILING)
237 " -hx Heap residency profile (XML) (output file <program>.prof)",
238 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
239 " break-down: c = cost centre stack (default)",
241 " d = closure description",
242 " y = type description",
244 " b = biography (LAG,DRAG,VOID,USE)",
245 " A subset of closures may be selected thusly:",
246 " -hc<cc>,... specific cost centre(s) (top of stack only)",
247 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
248 " -hm<mod>... all cost centres from the specified modules(s)",
249 " -hd<des>,... closures with specified closure descriptions",
250 " -hy<typ>... closures with specified type descriptions",
251 " -hr<cc>... closures with specified retainers",
252 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
254 " -R<size> Set the maximum retainer set size (default: 8)",
256 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
259 " -xt Include threads (TSOs) in a heap profile",
261 " -xc Show current cost centre stack on raising an exception",
263 #endif /* PROFILING or PAR */
267 " -l[flags] Log events in binary format to the file <program>.eventlog",
269 " -v[flags] Log events to stderr",
271 " where [flags] can contain:",
272 " s scheduler events",
274 " t add time stamps (only useful with -v)",
278 #if !defined(PROFILING)
280 " -hT Heap residency profile (output file <program>.hp)",
282 " -i<sec> Time between heap samples (seconds, default: 0.1)",
284 #if defined(TICKY_TICKY)
285 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
288 " -C<secs> Context-switch interval in seconds.",
289 " 0 or no argument means switch as often as possible.",
290 " Default: 0.02 sec; resolution is set by -V below.",
291 " -V<secs> Master tick interval in seconds (0 == disable timer).",
292 " This sets the resolution for -C and the profile timer -i.",
293 " Default: 0.02 sec.",
296 " -Ds DEBUG: scheduler",
297 " -Di DEBUG: interpreter",
299 " -DG DEBUG: gccafs",
302 " -DS DEBUG: sanity",
303 " -Dt DEBUG: stable",
305 " -De DEBUG: event logging",
307 " -Dl DEBUG: linker",
309 " -Dz DEBUG: stack squezing",
310 " -Dc DEBUG: program coverage",
311 " -Dr DEBUG: sparks",
313 " NOTE: DEBUG events are sent to stderr by default; add -l to create a",
314 " binary event log file instead.",
317 #if defined(THREADED_RTS) && !defined(NOSMP)
318 " -N<n> Use <n> processors (default: 1)",
319 " -N Determine the number of processors to use automatically",
320 " -qg[<n>] Use parallel GC only for generations >= <n>",
321 " (default: 0, -qg alone turns off parallel GC)",
322 " -qb[<n>] Use load-balancing in the parallel GC only for generations >= <n>",
323 " (default: 1, -qb alone turns off load-balancing)",
324 " -qa Use the OS to set thread affinity (experimental)",
325 " -qm Don't automatically migrate threads between CPUs",
326 " -qw Migrate a thread to the current CPU when it is woken up",
328 " --install-signal-handlers=<yes|no>",
329 " Install signal handlers (default: yes)",
330 #if defined(THREADED_RTS)
331 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
333 #if defined(x86_64_HOST_ARCH)
334 " -xm Base address to mmap memory in the GHCi linker",
335 " (hex; must be <80000000)",
337 #if defined(USE_PAPI)
338 " -aX CPU performance counter measurements using PAPI",
339 " (use with the -s<file> option). X is one of:",
342 " 1 - level 1 cache misses",
343 " 2 - level 2 cache misses",
344 " b - branch mispredictions",
345 " s - stalled cycles",
346 " e - cache miss and branch misprediction events",
347 " +PAPI_EVENT - collect papi preset event PAPI_EVENT",
348 " #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
351 "RTS options may also be specified using the GHCRTS environment variable.",
353 "Other RTS options may be available for programs compiled a different way.",
354 "The GHC User's Guide has full details.",
359 STATIC_INLINE rtsBool
360 strequal(const char *a, const char * b)
362 return(strcmp(a, b) == 0);
366 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
372 while (isspace(*c1)) { c1++; };
374 while (!isspace(*c2) && *c2 != '\0') { c2++; };
376 if (c1 == c2) { break; }
378 if (*rts_argc < MAX_RTS_ARGS-1) {
379 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
380 strncpy(s, c1, c2-c1);
382 rts_argv[(*rts_argc)++] = s;
384 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
388 } while (*c1 != '\0');
392 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
394 rtsBool error = rtsFalse;
405 // process arguments from the ghc_rts_opts global variable first.
406 // (arguments from the GHCRTS environment variable and the command
407 // line override these).
409 if (ghc_rts_opts != NULL) {
410 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
414 // process arguments from the GHCRTS environment variable next
415 // (arguments from the command line override these).
417 char *ghc_rts = getenv("GHCRTS");
419 if (ghc_rts != NULL) {
420 if (rtsOptsEnabled != rtsOptsNone) {
421 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
424 errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n Link with -rtsopts to enable them.");
425 // We don't actually exit, just warn
430 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
431 // argv[0] must be PGM argument -- leave in argv
433 for (mode = PGM; arg < total_arg; arg++) {
434 // The '--RTS' argument disables all future +RTS ... -RTS processing.
435 if (strequal("--RTS", argv[arg])) {
439 // The '--' argument is passed through to the program, but
440 // disables all further +RTS ... -RTS processing.
441 else if (strequal("--", argv[arg])) {
444 else if (strequal("+RTS", argv[arg])) {
445 if (rtsOptsEnabled != rtsOptsNone) {
449 errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
450 stg_exit(EXIT_FAILURE);
453 else if (strequal("-RTS", argv[arg])) {
456 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
457 rts_argv[(*rts_argc)++] = argv[arg];
459 else if (mode == PGM) {
460 argv[(*argc)++] = argv[arg];
463 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
466 // process remaining program arguments
467 for (; arg < total_arg; arg++) {
468 argv[(*argc)++] = argv[arg];
470 argv[*argc] = (char *) 0;
471 rts_argv[*rts_argc] = (char *) 0;
473 // Process RTS (rts_argv) part: mainly to determine statsfile
474 for (arg = 0; arg < *rts_argc; arg++) {
475 if (rts_argv[arg][0] != '-') {
477 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
482 switch(rts_argv[arg][1]) {
484 if (strequal("info", &rts_argv[arg][2])) {
493 if (rtsOptsEnabled != rtsOptsAll)
495 errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
496 stg_exit(EXIT_FAILURE);
499 switch(rts_argv[arg][1]) {
501 /* process: general args, then PROFILING-only ones, then
502 CONCURRENT-only, TICKY-only (same order as defined in
503 RtsFlags.lh); within those groups, mostly in
504 case-insensitive alphabetical order. Final group is
505 x*, which allows for more options.
509 # define TICKY_BUILD_ONLY(x) x
511 # define TICKY_BUILD_ONLY(x) \
512 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
517 # define PROFILING_BUILD_ONLY(x) x
519 # define PROFILING_BUILD_ONLY(x) \
520 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
525 # define TRACING_BUILD_ONLY(x) x
527 # define TRACING_BUILD_ONLY(x) \
528 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
533 # define THREADED_BUILD_ONLY(x) x
535 # define THREADED_BUILD_ONLY(x) \
536 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
541 # define DEBUG_BUILD_ONLY(x) x
543 # define DEBUG_BUILD_ONLY(x) \
544 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
548 /* =========== GENERAL ========================== */
553 /* This isn't going to allow us to keep related options
554 together as we add more --* flags. We really need a
555 proper options parser. */
557 if (strequal("install-signal-handlers=yes",
558 &rts_argv[arg][2])) {
559 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
561 else if (strequal("install-signal-handlers=no",
562 &rts_argv[arg][2])) {
563 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
565 else if (strequal("machine-readable",
566 &rts_argv[arg][2])) {
567 RtsFlags.MiscFlags.machineReadable = rtsTrue;
569 else if (strequal("info",
570 &rts_argv[arg][2])) {
575 errorBelch("unknown RTS option: %s",rts_argv[arg]);
580 RtsFlags.GcFlags.minAllocAreaSize
581 = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
587 switch(rts_argv[arg][2]) {
589 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
592 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
595 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
598 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
601 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
605 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
606 errorBelch("maximum number of PAPI events reached");
607 stg_exit(EXIT_FAILURE);
609 nat eventNum = RtsFlags.PapiFlags.numUserEvents++;
610 char kind = rts_argv[arg][2];
611 nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;
613 RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
614 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
615 RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
618 bad_option( rts_argv[arg] );
624 RtsFlags.GcFlags.ringBell = rtsTrue;
628 if (rts_argv[arg][2] != '\0') {
629 RtsFlags.GcFlags.compactThreshold =
630 atof(rts_argv[arg]+2);
632 RtsFlags.GcFlags.compact = rtsTrue;
637 RtsFlags.GcFlags.sweep = rtsTrue;
641 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
643 if (RtsFlags.GcFlags.oldGenFactor < 0)
644 bad_option( rts_argv[arg] );
652 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
655 RtsFlags.DebugFlags.scheduler = rtsTrue;
658 RtsFlags.DebugFlags.interpreter = rtsTrue;
661 RtsFlags.DebugFlags.weak = rtsTrue;
664 RtsFlags.DebugFlags.gccafs = rtsTrue;
667 RtsFlags.DebugFlags.gc = rtsTrue;
670 RtsFlags.DebugFlags.block_alloc = rtsTrue;
673 RtsFlags.DebugFlags.sanity = rtsTrue;
676 RtsFlags.DebugFlags.stable = rtsTrue;
679 RtsFlags.DebugFlags.prof = rtsTrue;
682 RtsFlags.DebugFlags.linker = rtsTrue;
685 RtsFlags.DebugFlags.apply = rtsTrue;
688 RtsFlags.DebugFlags.stm = rtsTrue;
691 RtsFlags.DebugFlags.squeeze = rtsTrue;
694 RtsFlags.DebugFlags.hpc = rtsTrue;
697 RtsFlags.DebugFlags.sparks = rtsTrue;
700 bad_option( rts_argv[arg] );
703 // -Dx also turns on -v. Use -l to direct trace
704 // events to the .eventlog file instead.
705 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
710 RtsFlags.GcFlags.maxStkSize =
711 decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
715 switch(rts_argv[arg][2]) {
717 RtsFlags.GcFlags.stkChunkSize =
718 decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
721 RtsFlags.GcFlags.stkChunkBufferSize =
722 decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
725 RtsFlags.GcFlags.initialStkSize =
726 decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
729 RtsFlags.GcFlags.initialStkSize =
730 decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
736 RtsFlags.GcFlags.maxHeapSize =
737 decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
738 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
742 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
744 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
745 RtsFlags.GcFlags.pcFreeHeap > 100)
746 bad_option( rts_argv[arg] );
750 RtsFlags.GcFlags.generations =
751 decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
755 if (rts_argv[arg][2] == '\0') {
756 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
758 RtsFlags.GcFlags.heapSizeSuggestion =
759 (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
763 #ifdef RTS_GTK_FRONTPANEL
765 RtsFlags.GcFlags.frontpanel = rtsTrue;
769 case 'I': /* idle GC delay */
770 if (rts_argv[arg][2] == '\0') {
775 /* Convert to millisecs */
776 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
777 RtsFlags.GcFlags.idleGCDelayTime = cst;
782 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
786 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
790 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
796 r = open_stats_file(arg, *argc, argv,
797 *rts_argc, rts_argv, NULL,
798 &RtsFlags.GcFlags.statsFile);
799 if (r == -1) { error = rtsTrue; }
804 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
807 /* =========== PROFILING ========================== */
809 case 'P': /* detailed cost centre profiling (time/alloc) */
810 case 'p': /* cost centre profiling (time/alloc) */
811 PROFILING_BUILD_ONLY(
812 switch (rts_argv[arg][2]) {
814 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
817 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
820 if (rts_argv[arg][1] == 'P') {
821 RtsFlags.CcFlags.doCostCentres =
822 COST_CENTRES_VERBOSE;
824 RtsFlags.CcFlags.doCostCentres =
825 COST_CENTRES_SUMMARY;
832 PROFILING_BUILD_ONLY(
833 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
836 PROFILING_BUILD_ONLY(
837 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
838 if(RtsFlags.ProfFlags.ccsLength <= 0) {
839 bad_option(rts_argv[arg]);
842 case 'h': /* serial heap profile */
843 #if !defined(PROFILING)
844 switch (rts_argv[arg][2]) {
847 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
850 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
854 PROFILING_BUILD_ONLY(
855 switch (rts_argv[arg][2]) {
869 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
871 char *left = strchr(rts_argv[arg], '{');
872 char *right = strrchr(rts_argv[arg], '}');
874 // curly braces are optional, for
879 left = rts_argv[arg] + 3;
882 right = rts_argv[arg] + strlen(rts_argv[arg]);
886 switch (rts_argv[arg][2]) {
887 case 'c': // cost centre label select
888 RtsFlags.ProfFlags.ccSelector = left;
891 RtsFlags.ProfFlags.ccsSelector = left;
894 case 'm': // cost centre module select
895 RtsFlags.ProfFlags.modSelector = left;
898 case 'd': // closure descr select
899 RtsFlags.ProfFlags.descrSelector = left;
902 case 'y': // closure type select
903 RtsFlags.ProfFlags.typeSelector = left;
906 case 'r': // retainer select
907 RtsFlags.ProfFlags.retainerSelector = left;
910 case 'b': // biography select
911 RtsFlags.ProfFlags.bioSelector = left;
918 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
919 errorBelch("multiple heap profile options");
924 switch (rts_argv[arg][2]) {
928 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
932 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
936 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
940 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
944 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
948 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
954 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
958 #endif /* PROFILING */
961 case 'i': /* heap sample interval */
962 if (rts_argv[arg][2] == '\0') {
967 /* Convert to milliseconds */
968 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
969 RtsFlags.ProfFlags.profileInterval = cst;
973 /* =========== CONCURRENT ========================= */
974 case 'C': /* context switch interval */
975 if (rts_argv[arg][2] == '\0')
976 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
980 /* Convert to milliseconds */
981 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
982 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
986 case 'V': /* master tick interval */
987 if (rts_argv[arg][2] == '\0') {
988 // turns off ticks completely
989 RtsFlags.MiscFlags.tickInterval = 0;
993 /* Convert to milliseconds */
994 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
995 RtsFlags.MiscFlags.tickInterval = cst;
1001 THREADED_BUILD_ONLY(
1002 if (rts_argv[arg][2] == '\0') {
1003 #if defined(PROFILING)
1004 RtsFlags.ParFlags.nNodes = 1;
1006 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1009 RtsFlags.ParFlags.nNodes
1010 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1011 if (RtsFlags.ParFlags.nNodes <= 0) {
1012 errorBelch("bad value for -N");
1015 #if defined(PROFILING)
1016 if (RtsFlags.ParFlags.nNodes > 1) {
1017 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1025 THREADED_BUILD_ONLY(
1026 switch (rts_argv[arg][2]) {
1028 // backwards compat only
1029 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1032 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1039 THREADED_BUILD_ONLY(
1040 switch (rts_argv[arg][2]) {
1042 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1046 if (rts_argv[arg][3] == '\0') {
1047 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1049 RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1050 RtsFlags.ParFlags.parGcGen
1051 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1055 if (rts_argv[arg][3] == '\0') {
1056 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1059 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1060 RtsFlags.ParFlags.parGcLoadBalancingGen
1061 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1065 RtsFlags.ParFlags.setAffinity = rtsTrue;
1068 RtsFlags.ParFlags.migrate = rtsFalse;
1071 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1074 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1080 /* =========== PARALLEL =========================== */
1082 THREADED_BUILD_ONLY(
1083 if (rts_argv[arg][2] != '\0') {
1084 RtsFlags.ParFlags.maxLocalSparks
1085 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1086 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1087 errorBelch("bad value for -e");
1093 /* =========== TICKY ============================== */
1095 case 'r': /* Basic profiling stats */
1098 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1102 r = open_stats_file(arg, *argc, argv,
1103 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1104 &RtsFlags.TickyFlags.tickyFile);
1105 if (r == -1) { error = rtsTrue; }
1109 /* =========== TRACING ---------=================== */
1113 RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1114 read_trace_flags(&rts_argv[arg][2]);
1120 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1121 read_trace_flags(&rts_argv[arg][2]);
1125 /* =========== EXTENDED OPTIONS =================== */
1127 case 'x': /* Extend the argument space */
1128 switch(rts_argv[arg][2]) {
1130 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1134 case 'b': /* heapBase in hex; undocumented */
1135 if (rts_argv[arg][3] != '\0') {
1136 RtsFlags.GcFlags.heapBase
1137 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1139 errorBelch("-xb: requires argument");
1144 #if defined(x86_64_HOST_ARCH)
1145 case 'm': /* linkerMemBase */
1146 if (rts_argv[arg][3] != '\0') {
1147 RtsFlags.MiscFlags.linkerMemBase
1148 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1149 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1150 errorBelch("-xm: value must be <80000000");
1154 RtsFlags.MiscFlags.linkerMemBase = 0;
1159 case 'c': /* Debugging tool: show current cost centre on an exception */
1160 PROFILING_BUILD_ONLY(
1161 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1165 case 't': /* Include memory used by TSOs in a heap profile */
1166 PROFILING_BUILD_ONLY(
1167 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1171 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1174 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1178 break; /* defensive programming */
1180 /* =========== OH DEAR ============================ */
1182 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1189 if (RtsFlags.MiscFlags.tickInterval < 0) {
1190 RtsFlags.MiscFlags.tickInterval = 50;
1193 // If the master timer is disabled, turn off the other timers.
1194 if (RtsFlags.MiscFlags.tickInterval == 0) {
1195 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1196 RtsFlags.GcFlags.idleGCDelayTime = 0;
1197 RtsFlags.ProfFlags.profileInterval = 0;
1200 // Determine what tick interval we should use for the RTS timer
1201 // by taking the shortest of the various intervals that we need to
1203 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1204 RtsFlags.MiscFlags.tickInterval =
1205 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1206 RtsFlags.MiscFlags.tickInterval);
1209 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1210 RtsFlags.MiscFlags.tickInterval =
1211 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1212 RtsFlags.MiscFlags.tickInterval);
1215 if (RtsFlags.ProfFlags.profileInterval > 0) {
1216 RtsFlags.MiscFlags.tickInterval =
1217 stg_min(RtsFlags.ProfFlags.profileInterval,
1218 RtsFlags.MiscFlags.tickInterval);
1221 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1222 RtsFlags.ConcFlags.ctxtSwitchTicks =
1223 RtsFlags.ConcFlags.ctxtSwitchTime /
1224 RtsFlags.MiscFlags.tickInterval;
1226 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1229 if (RtsFlags.ProfFlags.profileInterval > 0) {
1230 RtsFlags.ProfFlags.profileIntervalTicks =
1231 RtsFlags.ProfFlags.profileInterval /
1232 RtsFlags.MiscFlags.tickInterval;
1234 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1237 if (RtsFlags.GcFlags.stkChunkBufferSize >
1238 RtsFlags.GcFlags.stkChunkSize / 2) {
1239 errorBelch("stack chunk buffer size (-kb) must be less than 50%% of the stack chunk size (-kc)");
1247 for (p = usage_text; *p; p++)
1248 errorBelch("%s", *p);
1249 stg_exit(EXIT_FAILURE);
1255 stats_fprintf(FILE *f, char *s, ...)
1267 static int /* return -1 on error */
1270 int argc, char *argv[],
1271 int rts_argc, char *rts_argv[],
1272 const char *FILENAME_FMT,
1277 if (strequal(rts_argv[arg]+2, "stderr")
1278 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1279 f = NULL; /* NULL means use debugBelch */
1281 if (rts_argv[arg][2] != '\0') { /* stats file specified */
1282 f = fopen(rts_argv[arg]+2,"w");
1284 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1285 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1286 f = fopen(stats_filename,"w");
1289 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1296 /* Write argv and rtsv into start of stats file */
1298 for(count = 0; count < argc; count++) {
1299 stats_fprintf(f, "%s ", argv[count]);
1301 stats_fprintf(f, "+RTS ");
1302 for(count = 0; count < rts_argc; count++)
1303 stats_fprintf(f, "%s ", rts_argv[count]);
1304 stats_fprintf(f, "\n");
1312 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1330 if (c == 'g' || c == 'G')
1331 m *= 1024*1024*1024;
1332 else if (c == 'm' || c == 'M')
1334 else if (c == 'k' || c == 'K')
1336 else if (c == 'w' || c == 'W')
1342 if (m < 0 || val < min || val > max) {
1343 // printf doesn't like 64-bit format specs on Windows
1344 // apparently, so fall back to unsigned long.
1345 errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1346 stg_exit(EXIT_FAILURE);
1352 #if defined(TRACING)
1353 static void read_trace_flags(char *arg)
1357 for (c = arg; *c != '\0'; c++) {
1362 RtsFlags.TraceFlags.scheduler = rtsTrue;
1365 RtsFlags.TraceFlags.timestamp = rtsTrue;
1368 // ignored for backwards-compat
1371 errorBelch("unknown trace option: %c",*c);
1378 static void GNU_ATTRIBUTE(__noreturn__)
1379 bad_option(const char *s)
1381 errorBelch("bad RTS option: %s", s);
1382 stg_exit(EXIT_FAILURE);
1385 /* -----------------------------------------------------------------------------
1386 Getting/Setting the program's arguments.
1388 These are used by System.Environment, and parts of the RTS.
1389 -------------------------------------------------------------------------- */
1392 setProgName(char *argv[])
1394 /* Remove directory from argv[0] -- default files in current directory */
1395 #if !defined(mingw32_HOST_OS)
1397 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1398 prog_name = last_slash+1;
1400 prog_name = argv[0];
1403 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1404 while ( last_slash > argv[0] ) {
1405 if ( *last_slash == '/' || *last_slash == '\\' ) {
1406 prog_name = last_slash+1;
1411 prog_name = argv[0];
1416 getProgArgv(int *argc, char **argv[])
1418 if (argc) { *argc = prog_argc; }
1419 if (argv) { *argv = prog_argv; }
1423 setProgArgv(int argc, char *argv[])
1425 /* Usually this is done by startupHaskell, so we don't need to call this.
1426 However, sometimes Hugs wants to change the arguments which Haskell
1427 getArgs >>= ... will be fed. So you can do that by calling here
1428 _after_ calling startupHaskell.
1432 setProgName(prog_argv);
1435 /* These functions record and recall the full arguments, including the
1436 +RTS ... -RTS options. The reason for adding them was so that the
1437 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1439 getFullProgArgv(int *argc, char **argv[])
1441 if (argc) { *argc = full_prog_argc; }
1442 if (argv) { *argv = full_prog_argv; }
1446 setFullProgArgv(int argc, char *argv[])
1449 full_prog_argc = argc;
1450 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1451 "setFullProgArgv 1");
1452 for (i = 0; i < argc; i++) {
1453 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1454 "setFullProgArgv 2");
1455 strcpy(full_prog_argv[i], argv[i]);
1457 full_prog_argv[argc] = NULL;
1461 freeFullProgArgv (void)
1465 if (full_prog_argv != NULL) {
1466 for (i = 0; i < full_prog_argc; i++) {
1467 stgFree(full_prog_argv[i]);
1469 stgFree(full_prog_argv);
1473 full_prog_argv = NULL;