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"
14 #include "Profiling.h"
26 * Split argument lists
28 int prog_argc = 0; /* an "int" so as to match normal "argc" */
29 char **prog_argv = NULL;
30 int full_prog_argc = 0; /* an "int" so as to match normal "argc" */
31 char **full_prog_argv = NULL;
32 char *prog_name = NULL; /* 'basename' of prog_argv[0] */
33 int rts_argc = 0; /* ditto */
34 char *rts_argv[MAX_RTS_ARGS];
37 * constants, used later
42 /* -----------------------------------------------------------------------------
44 -------------------------------------------------------------------------- */
46 static int /* return NULL on error */
49 int argc, char *argv[],
50 int rts_argc, char *rts_argv[],
51 const char *FILENAME_FMT,
54 static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max);
55 static void bad_option(const char *s);
57 /* -----------------------------------------------------------------------------
58 * Command-line option parsing routines.
59 * ---------------------------------------------------------------------------*/
61 void initRtsFlagsDefaults(void)
63 RtsFlags.GcFlags.statsFile = NULL;
64 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
66 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
67 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
69 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
70 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
71 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
72 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
73 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
74 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
75 RtsFlags.GcFlags.oldGenFactor = 2;
76 RtsFlags.GcFlags.generations = 2;
77 RtsFlags.GcFlags.steps = 2;
78 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
79 RtsFlags.GcFlags.compact = rtsFalse;
80 RtsFlags.GcFlags.compactThreshold = 30.0;
81 RtsFlags.GcFlags.sweep = rtsFalse;
82 #ifdef RTS_GTK_FRONTPANEL
83 RtsFlags.GcFlags.frontpanel = rtsFalse;
85 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
88 /* ToDo: Perhaps by adjusting this value we can make linking without
89 * -static work (i.e., not generate a core-dumping executable)? */
90 # if SIZEOF_VOID_P == 8
91 RtsFlags.GcFlags.heapBase = 0x180000000L;
93 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
96 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
100 RtsFlags.DebugFlags.scheduler = rtsFalse;
101 RtsFlags.DebugFlags.interpreter = rtsFalse;
102 RtsFlags.DebugFlags.weak = rtsFalse;
103 RtsFlags.DebugFlags.gccafs = rtsFalse;
104 RtsFlags.DebugFlags.gc = rtsFalse;
105 RtsFlags.DebugFlags.block_alloc = rtsFalse;
106 RtsFlags.DebugFlags.sanity = rtsFalse;
107 RtsFlags.DebugFlags.stable = rtsFalse;
108 RtsFlags.DebugFlags.stm = rtsFalse;
109 RtsFlags.DebugFlags.prof = rtsFalse;
110 RtsFlags.DebugFlags.apply = rtsFalse;
111 RtsFlags.DebugFlags.linker = rtsFalse;
112 RtsFlags.DebugFlags.squeeze = rtsFalse;
113 RtsFlags.DebugFlags.hpc = rtsFalse;
114 RtsFlags.DebugFlags.sparks = rtsFalse;
117 #if defined(PROFILING)
118 RtsFlags.CcFlags.doCostCentres = 0;
119 #endif /* PROFILING */
121 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
122 RtsFlags.ProfFlags.profileInterval = 100;
125 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
126 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
127 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
128 RtsFlags.ProfFlags.ccsLength = 25;
129 RtsFlags.ProfFlags.modSelector = NULL;
130 RtsFlags.ProfFlags.descrSelector = NULL;
131 RtsFlags.ProfFlags.typeSelector = NULL;
132 RtsFlags.ProfFlags.ccSelector = NULL;
133 RtsFlags.ProfFlags.ccsSelector = NULL;
134 RtsFlags.ProfFlags.retainerSelector = NULL;
135 RtsFlags.ProfFlags.bioSelector = NULL;
139 RtsFlags.TraceFlags.tracing = TRACE_NONE;
140 RtsFlags.TraceFlags.timestamp = rtsFalse;
141 RtsFlags.TraceFlags.scheduler = rtsFalse;
144 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
145 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
147 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
148 RtsFlags.MiscFlags.machineReadable = rtsFalse;
149 RtsFlags.MiscFlags.linkerMemBase = 0;
152 RtsFlags.ParFlags.nNodes = 1;
153 RtsFlags.ParFlags.migrate = rtsTrue;
154 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
155 RtsFlags.ParFlags.parGcEnabled = 1;
156 RtsFlags.ParFlags.parGcGen = 0;
157 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
158 RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
159 RtsFlags.ParFlags.setAffinity = 0;
162 #if defined(THREADED_RTS)
163 RtsFlags.ParFlags.maxLocalSparks = 4096;
164 #endif /* THREADED_RTS */
167 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
168 RtsFlags.TickyFlags.tickyFile = NULL;
172 /* By default no special measurements taken */
173 RtsFlags.PapiFlags.eventType = 0;
174 RtsFlags.PapiFlags.numUserEvents = 0;
181 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
183 " +RTS Indicates run time system options follow",
184 " -RTS Indicates program arguments follow",
185 " --RTS Indicates that ALL subsequent arguments will be given to the",
186 " program (including any of these RTS flags)",
188 "The following run time system options are available:",
190 " -? Prints this message and exits; the program is not executed",
191 " --info Print information about the RTS used by this program",
193 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
194 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
196 " -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
197 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
198 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
199 " -m<n> Minimum % of heap which must be available (default 3%)",
200 " -G<n> Number of generations (default: 2)",
201 " -T<n> Number of steps in younger generations (default: 2)",
202 " -c<n> Use in-place compaction instead of copying in the oldest generation",
203 " when live data is at least <n>% of the maximum heap size set with",
204 " -M (default: 30%)",
205 " -c Use in-place compaction for all oldest generation collections",
206 " (the default is to use copying)",
207 " -w Use mark-region for the oldest generation (experimental)",
208 #if defined(THREADED_RTS)
209 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
212 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
213 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
214 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
215 #ifdef RTS_GTK_FRONTPANEL
216 " -f Display front panel (requires X11 & GTK+)",
220 " -Z Don't squeeze out update frames on stack overflow",
221 " -B Sound the bell at the start of each garbage collection",
222 #if defined(PROFILING)
224 " -px Time/allocation profile (XML) (output file <program>.prof)",
225 " -p Time/allocation profile (output file <program>.prof)",
226 " -P More detailed Time/Allocation profile",
227 " -Pa Give information about *all* cost centres",
229 # if defined(PROFILING)
231 " -hx Heap residency profile (XML) (output file <program>.prof)",
232 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
233 " break-down: c = cost centre stack (default)",
235 " d = closure description",
236 " y = type description",
238 " b = biography (LAG,DRAG,VOID,USE)",
239 " A subset of closures may be selected thusly:",
240 " -hc<cc>,... specific cost centre(s) (top of stack only)",
241 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
242 " -hm<mod>... all cost centres from the specified modules(s)",
243 " -hd<des>,... closures with specified closure descriptions",
244 " -hy<typ>... closures with specified type descriptions",
245 " -hr<cc>... closures with specified retainers",
246 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
248 " -R<size> Set the maximum retainer set size (default: 8)",
250 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
253 " -xt Include threads (TSOs) in a heap profile",
255 " -xc Show current cost centre stack on raising an exception",
258 #endif /* PROFILING or PAR */
262 " -v Log events to stderr",
263 " -l Log events in binary format to the file <program>.eventlog",
264 " -vt Include time stamps when tracing events to stderr with -v",
266 " -ls Log scheduler events",
270 #if !defined(PROFILING)
272 " -hT Heap residency profile (output file <program>.hp)",
274 " -i<sec> Time between heap samples (seconds, default: 0.1)",
276 #if defined(TICKY_TICKY)
277 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
280 " -C<secs> Context-switch interval in seconds.",
281 " 0 or no argument means switch as often as possible.",
282 " Default: 0.02 sec; resolution is set by -V below.",
283 " -V<secs> Master tick interval in seconds (0 == disable timer).",
284 " This sets the resolution for -C and the profile timer -i.",
285 " Default: 0.02 sec.",
288 " -Ds DEBUG: scheduler",
289 " -Di DEBUG: interpreter",
291 " -DG DEBUG: gccafs",
294 " -DS DEBUG: sanity",
295 " -Dt DEBUG: stable",
297 " -De DEBUG: event logging",
299 " -Dl DEBUG: linker",
301 " -Dz DEBUG: stack squezing",
302 " -Dc DEBUG: program coverage",
303 " -Dr DEBUG: sparks",
305 " NOTE: all -D options also enable -v automatically. Use -l to create a",
306 " binary event log file instead.",
309 #if defined(THREADED_RTS) && !defined(NOSMP)
310 " -N<n> Use <n> processors (default: 1)",
311 " -N Determine the number of processors to use automatically",
312 " -qg[<n>] Use parallel GC only for generations >= <n>",
313 " (default: 0, -qg alone turns off parallel GC)",
314 " -qb[<n>] Use load-balancing in the parallel GC only for generations >= <n>",
315 " (default: 1, -qb alone turns off load-balancing)",
316 " -qa Use the OS to set thread affinity (experimental)",
317 " -qm Don't automatically migrate threads between CPUs",
318 " -qw Migrate a thread to the current CPU when it is woken up",
320 " --install-signal-handlers=<yes|no>",
321 " Install signal handlers (default: yes)",
322 #if defined(THREADED_RTS)
323 " -e<size> Size of spark pools (default 100)",
325 #if defined(THREADED_RTS)
326 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
328 #if defined(x86_64_HOST_ARCH)
329 " -xm Base address to mmap memory in the GHCi linker",
330 " (hex; must be <80000000)",
332 #if defined(USE_PAPI)
333 " -aX CPU performance counter measurements using PAPI",
334 " (use with the -s<file> option). X is one of:",
337 " 1 - level 1 cache misses",
338 " 2 - level 2 cache misses",
339 " b - branch mispredictions",
340 " s - stalled cycles",
341 " e - cache miss and branch misprediction events",
344 "RTS options may also be specified using the GHCRTS environment variable.",
346 "Other RTS options may be available for programs compiled a different way.",
347 "The GHC User's Guide has full details.",
352 STATIC_INLINE rtsBool
353 strequal(const char *a, const char * b)
355 return(strcmp(a, b) == 0);
359 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
365 while (isspace(*c1)) { c1++; };
367 while (!isspace(*c2) && *c2 != '\0') { c2++; };
369 if (c1 == c2) { break; }
371 if (*rts_argc < MAX_RTS_ARGS-1) {
372 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
373 strncpy(s, c1, c2-c1);
375 rts_argv[(*rts_argc)++] = s;
377 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
381 } while (*c1 != '\0');
385 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
387 rtsBool error = rtsFalse;
398 // process arguments from the ghc_rts_opts global variable first.
399 // (arguments from the GHCRTS environment variable and the command
400 // line override these).
402 if (ghc_rts_opts != NULL) {
403 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
407 // process arguments from the GHCRTS environment variable next
408 // (arguments from the command line override these).
410 char *ghc_rts = getenv("GHCRTS");
412 if (ghc_rts != NULL) {
413 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
417 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
418 // argv[0] must be PGM argument -- leave in argv
420 for (mode = PGM; arg < total_arg; arg++) {
421 // The '--RTS' argument disables all future +RTS ... -RTS processing.
422 if (strequal("--RTS", argv[arg])) {
426 // The '--' argument is passed through to the program, but
427 // disables all further +RTS ... -RTS processing.
428 else if (strequal("--", argv[arg])) {
431 else if (strequal("+RTS", argv[arg])) {
434 else if (strequal("-RTS", argv[arg])) {
437 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
438 rts_argv[(*rts_argc)++] = argv[arg];
440 else if (mode == PGM) {
441 argv[(*argc)++] = argv[arg];
444 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
447 // process remaining program arguments
448 for (; arg < total_arg; arg++) {
449 argv[(*argc)++] = argv[arg];
451 argv[*argc] = (char *) 0;
452 rts_argv[*rts_argc] = (char *) 0;
454 // Process RTS (rts_argv) part: mainly to determine statsfile
455 for (arg = 0; arg < *rts_argc; arg++) {
456 if (rts_argv[arg][0] != '-') {
458 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
462 switch(rts_argv[arg][1]) {
464 /* process: general args, then PROFILING-only ones, then
465 CONCURRENT-only, TICKY-only (same order as defined in
466 RtsFlags.lh); within those groups, mostly in
467 case-insensitive alphabetical order. Final group is
468 x*, which allows for more options.
472 # define TICKY_BUILD_ONLY(x) x
474 # define TICKY_BUILD_ONLY(x) \
475 errorBelch("not built for: ticky-ticky stats"); \
480 # define PROFILING_BUILD_ONLY(x) x
482 # define PROFILING_BUILD_ONLY(x) \
483 errorBelch("not built for: -prof"); \
488 # define TRACING_BUILD_ONLY(x) x
490 # define TRACING_BUILD_ONLY(x) \
491 errorBelch("not built for: -par-prof"); \
496 # define THREADED_BUILD_ONLY(x) x
498 # define THREADED_BUILD_ONLY(x) \
499 errorBelch("not built for: -smp"); \
503 /* =========== GENERAL ========================== */
508 /* This isn't going to allow us to keep related options
509 together as we add more --* flags. We really need a
510 proper options parser. */
512 if (strequal("install-signal-handlers=yes",
513 &rts_argv[arg][2])) {
514 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
516 else if (strequal("install-signal-handlers=no",
517 &rts_argv[arg][2])) {
518 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
520 else if (strequal("machine-readable",
521 &rts_argv[arg][2])) {
522 RtsFlags.MiscFlags.machineReadable = rtsTrue;
524 else if (strequal("info",
525 &rts_argv[arg][2])) {
530 errorBelch("unknown RTS option: %s",rts_argv[arg]);
535 RtsFlags.GcFlags.minAllocAreaSize
536 = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
542 switch(rts_argv[arg][2]) {
544 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
547 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
550 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
553 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
556 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
559 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
560 errorBelch("maximum number of PAPI events reached");
561 stg_exit(EXIT_FAILURE);
563 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
564 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
567 bad_option( rts_argv[arg] );
573 RtsFlags.GcFlags.ringBell = rtsTrue;
577 if (rts_argv[arg][2] != '\0') {
578 RtsFlags.GcFlags.compactThreshold =
579 atof(rts_argv[arg]+2);
581 RtsFlags.GcFlags.compact = rtsTrue;
586 RtsFlags.GcFlags.sweep = rtsTrue;
590 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
592 if (RtsFlags.GcFlags.oldGenFactor < 0)
593 bad_option( rts_argv[arg] );
601 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
604 RtsFlags.DebugFlags.scheduler = rtsTrue;
607 RtsFlags.DebugFlags.interpreter = rtsTrue;
610 RtsFlags.DebugFlags.weak = rtsTrue;
613 RtsFlags.DebugFlags.gccafs = rtsTrue;
616 RtsFlags.DebugFlags.gc = rtsTrue;
619 RtsFlags.DebugFlags.block_alloc = rtsTrue;
622 RtsFlags.DebugFlags.sanity = rtsTrue;
625 RtsFlags.DebugFlags.stable = rtsTrue;
628 RtsFlags.DebugFlags.prof = rtsTrue;
631 RtsFlags.DebugFlags.linker = rtsTrue;
634 RtsFlags.DebugFlags.apply = rtsTrue;
637 RtsFlags.DebugFlags.stm = rtsTrue;
640 RtsFlags.DebugFlags.squeeze = rtsTrue;
643 RtsFlags.DebugFlags.hpc = rtsTrue;
646 RtsFlags.DebugFlags.sparks = rtsTrue;
649 bad_option( rts_argv[arg] );
652 // -Dx also turns on -v. Use -l to direct trace
653 // events to the .eventlog file instead.
654 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
660 RtsFlags.GcFlags.maxStkSize =
661 decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
665 RtsFlags.GcFlags.initialStkSize =
666 decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
670 RtsFlags.GcFlags.maxHeapSize =
671 decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
672 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
676 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
678 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
679 RtsFlags.GcFlags.pcFreeHeap > 100)
680 bad_option( rts_argv[arg] );
684 RtsFlags.GcFlags.generations =
685 decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
689 RtsFlags.GcFlags.steps =
690 decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
694 if (rts_argv[arg][2] == '\0') {
695 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
697 RtsFlags.GcFlags.heapSizeSuggestion =
698 (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
702 #ifdef RTS_GTK_FRONTPANEL
704 RtsFlags.GcFlags.frontpanel = rtsTrue;
708 case 'I': /* idle GC delay */
709 if (rts_argv[arg][2] == '\0') {
714 /* Convert to millisecs */
715 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
716 RtsFlags.GcFlags.idleGCDelayTime = cst;
721 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
725 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
729 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
735 r = open_stats_file(arg, *argc, argv,
736 *rts_argc, rts_argv, NULL,
737 &RtsFlags.GcFlags.statsFile);
738 if (r == -1) { error = rtsTrue; }
743 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
746 /* =========== PROFILING ========================== */
750 switch(rts_argv[arg][2]) {
752 RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
755 RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
756 RtsFlags.TraceFlags.scheduler = rtsTrue;
759 errorBelch("unknown RTS option: %s",rts_argv[arg]);
764 errorBelch("not built for: -eventlog");
768 case 'P': /* detailed cost centre profiling (time/alloc) */
769 case 'p': /* cost centre profiling (time/alloc) */
770 PROFILING_BUILD_ONLY(
771 switch (rts_argv[arg][2]) {
773 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
776 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
779 if (rts_argv[arg][1] == 'P') {
780 RtsFlags.CcFlags.doCostCentres =
781 COST_CENTRES_VERBOSE;
783 RtsFlags.CcFlags.doCostCentres =
784 COST_CENTRES_SUMMARY;
791 PROFILING_BUILD_ONLY(
792 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
795 PROFILING_BUILD_ONLY(
796 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
797 if(RtsFlags.ProfFlags.ccsLength <= 0) {
798 bad_option(rts_argv[arg]);
801 case 'h': /* serial heap profile */
802 #if !defined(PROFILING)
803 switch (rts_argv[arg][2]) {
806 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
809 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
813 PROFILING_BUILD_ONLY(
814 switch (rts_argv[arg][2]) {
828 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
830 char *left = strchr(rts_argv[arg], '{');
831 char *right = strrchr(rts_argv[arg], '}');
833 // curly braces are optional, for
838 left = rts_argv[arg] + 3;
841 right = rts_argv[arg] + strlen(rts_argv[arg]);
845 switch (rts_argv[arg][2]) {
846 case 'c': // cost centre label select
847 RtsFlags.ProfFlags.ccSelector = left;
850 RtsFlags.ProfFlags.ccsSelector = left;
853 case 'm': // cost centre module select
854 RtsFlags.ProfFlags.modSelector = left;
857 case 'd': // closure descr select
858 RtsFlags.ProfFlags.descrSelector = left;
861 case 'y': // closure type select
862 RtsFlags.ProfFlags.typeSelector = left;
865 case 'r': // retainer select
866 RtsFlags.ProfFlags.retainerSelector = left;
869 case 'b': // biography select
870 RtsFlags.ProfFlags.bioSelector = left;
877 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
878 errorBelch("multiple heap profile options");
883 switch (rts_argv[arg][2]) {
887 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
891 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
895 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
899 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
903 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
907 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
913 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
917 #endif /* PROFILING */
920 case 'i': /* heap sample interval */
921 if (rts_argv[arg][2] == '\0') {
926 /* Convert to milliseconds */
927 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
928 RtsFlags.ProfFlags.profileInterval = cst;
932 /* =========== CONCURRENT ========================= */
933 case 'C': /* context switch interval */
934 if (rts_argv[arg][2] == '\0')
935 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
939 /* Convert to milliseconds */
940 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
941 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
945 case 'V': /* master tick interval */
946 if (rts_argv[arg][2] == '\0') {
947 // turns off ticks completely
948 RtsFlags.MiscFlags.tickInterval = 0;
952 /* Convert to milliseconds */
953 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
954 RtsFlags.MiscFlags.tickInterval = cst;
958 #if defined(THREADED_RTS) && !defined(NOSMP)
961 if (rts_argv[arg][2] == '\0') {
962 #if defined(PROFILING)
963 RtsFlags.ParFlags.nNodes = 1;
965 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
968 RtsFlags.ParFlags.nNodes
969 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
970 if (RtsFlags.ParFlags.nNodes <= 0) {
971 errorBelch("bad value for -N");
974 #if defined(PROFILING)
975 if (RtsFlags.ParFlags.nNodes > 1) {
976 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
985 switch (rts_argv[arg][2]) {
987 // backwards compat only
988 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
991 errorBelch("unknown RTS option: %s",rts_argv[arg]);
998 switch (rts_argv[arg][2]) {
1000 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1004 if (rts_argv[arg][3] == '\0') {
1005 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1007 RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1008 RtsFlags.ParFlags.parGcGen
1009 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1013 if (rts_argv[arg][3] == '\0') {
1014 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1017 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1018 RtsFlags.ParFlags.parGcLoadBalancingGen
1019 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1023 RtsFlags.ParFlags.setAffinity = rtsTrue;
1026 RtsFlags.ParFlags.migrate = rtsFalse;
1029 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1032 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1038 /* =========== PARALLEL =========================== */
1040 THREADED_BUILD_ONLY(
1041 if (rts_argv[arg][2] != '\0') {
1042 RtsFlags.ParFlags.maxLocalSparks
1043 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1044 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1045 errorBelch("bad value for -e");
1051 /* =========== TICKY ============================== */
1053 case 'r': /* Basic profiling stats */
1056 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1060 r = open_stats_file(arg, *argc, argv,
1061 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1062 &RtsFlags.TickyFlags.tickyFile);
1063 if (r == -1) { error = rtsTrue; }
1067 /* =========== TRACING ---------=================== */
1070 switch(rts_argv[arg][2]) {
1073 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1076 RtsFlags.TraceFlags.timestamp = rtsTrue;
1081 // ignored for backwards-compat
1084 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1090 /* =========== EXTENDED OPTIONS =================== */
1092 case 'x': /* Extend the argument space */
1093 switch(rts_argv[arg][2]) {
1095 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1099 case 'b': /* heapBase in hex; undocumented */
1100 if (rts_argv[arg][3] != '\0') {
1101 RtsFlags.GcFlags.heapBase
1102 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1104 errorBelch("-xb: requires argument");
1109 #if defined(x86_64_HOST_ARCH)
1110 case 'm': /* linkerMemBase */
1111 if (rts_argv[arg][3] != '\0') {
1112 RtsFlags.MiscFlags.linkerMemBase
1113 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1114 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1115 errorBelch("-xm: value must be <80000000");
1119 RtsFlags.MiscFlags.linkerMemBase = 0;
1124 case 'c': /* Debugging tool: show current cost centre on an exception */
1125 PROFILING_BUILD_ONLY(
1126 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1130 case 't': /* Include memory used by TSOs in a heap profile */
1131 PROFILING_BUILD_ONLY(
1132 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1136 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1139 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1143 break; /* defensive programming */
1145 /* =========== OH DEAR ============================ */
1147 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1154 if (RtsFlags.MiscFlags.tickInterval < 0) {
1155 RtsFlags.MiscFlags.tickInterval = 50;
1158 // If the master timer is disabled, turn off the other timers.
1159 if (RtsFlags.MiscFlags.tickInterval == 0) {
1160 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1161 RtsFlags.GcFlags.idleGCDelayTime = 0;
1162 RtsFlags.ProfFlags.profileInterval = 0;
1165 // Determine what tick interval we should use for the RTS timer
1166 // by taking the shortest of the various intervals that we need to
1168 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1169 RtsFlags.MiscFlags.tickInterval =
1170 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1171 RtsFlags.MiscFlags.tickInterval);
1174 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1175 RtsFlags.MiscFlags.tickInterval =
1176 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1177 RtsFlags.MiscFlags.tickInterval);
1180 if (RtsFlags.ProfFlags.profileInterval > 0) {
1181 RtsFlags.MiscFlags.tickInterval =
1182 stg_min(RtsFlags.ProfFlags.profileInterval,
1183 RtsFlags.MiscFlags.tickInterval);
1186 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1187 RtsFlags.ConcFlags.ctxtSwitchTicks =
1188 RtsFlags.ConcFlags.ctxtSwitchTime /
1189 RtsFlags.MiscFlags.tickInterval;
1191 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1194 if (RtsFlags.ProfFlags.profileInterval > 0) {
1195 RtsFlags.ProfFlags.profileIntervalTicks =
1196 RtsFlags.ProfFlags.profileInterval /
1197 RtsFlags.MiscFlags.tickInterval;
1199 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1206 for (p = usage_text; *p; p++)
1207 errorBelch("%s", *p);
1208 stg_exit(EXIT_FAILURE);
1214 stats_fprintf(FILE *f, char *s, ...)
1226 static int /* return -1 on error */
1229 int argc, char *argv[],
1230 int rts_argc, char *rts_argv[],
1231 const char *FILENAME_FMT,
1236 if (strequal(rts_argv[arg]+2, "stderr")
1237 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1238 f = NULL; /* NULL means use debugBelch */
1240 if (rts_argv[arg][2] != '\0') { /* stats file specified */
1241 f = fopen(rts_argv[arg]+2,"w");
1243 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1244 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1245 f = fopen(stats_filename,"w");
1248 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1255 /* Write argv and rtsv into start of stats file */
1257 for(count = 0; count < argc; count++) {
1258 stats_fprintf(f, "%s ", argv[count]);
1260 stats_fprintf(f, "+RTS ");
1261 for(count = 0; count < rts_argc; count++)
1262 stats_fprintf(f, "%s ", rts_argv[count]);
1263 stats_fprintf(f, "\n");
1271 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1289 if (c == 'g' || c == 'G')
1290 m *= 1024*1024*1024;
1291 else if (c == 'm' || c == 'M')
1293 else if (c == 'k' || c == 'K')
1295 else if (c == 'w' || c == 'W')
1301 if (m < 0 || val < min || val > max) {
1302 // printf doesn't like 64-bit format specs on Windows
1303 // apparently, so fall back to unsigned long.
1304 errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1305 stg_exit(EXIT_FAILURE);
1311 static void GNU_ATTRIBUTE(__noreturn__)
1312 bad_option(const char *s)
1314 errorBelch("bad RTS option: %s", s);
1315 stg_exit(EXIT_FAILURE);
1318 /* -----------------------------------------------------------------------------
1319 Getting/Setting the program's arguments.
1321 These are used by System.Environment, and parts of the RTS.
1322 -------------------------------------------------------------------------- */
1325 setProgName(char *argv[])
1327 /* Remove directory from argv[0] -- default files in current directory */
1328 #if !defined(mingw32_HOST_OS)
1330 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1331 prog_name = last_slash+1;
1333 prog_name = argv[0];
1336 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1337 while ( last_slash > argv[0] ) {
1338 if ( *last_slash == '/' || *last_slash == '\\' ) {
1339 prog_name = last_slash+1;
1344 prog_name = argv[0];
1349 getProgArgv(int *argc, char **argv[])
1351 if (argc) { *argc = prog_argc; }
1352 if (argv) { *argv = prog_argv; }
1356 setProgArgv(int argc, char *argv[])
1358 /* Usually this is done by startupHaskell, so we don't need to call this.
1359 However, sometimes Hugs wants to change the arguments which Haskell
1360 getArgs >>= ... will be fed. So you can do that by calling here
1361 _after_ calling startupHaskell.
1365 setProgName(prog_argv);
1368 /* These functions record and recall the full arguments, including the
1369 +RTS ... -RTS options. The reason for adding them was so that the
1370 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1372 getFullProgArgv(int *argc, char **argv[])
1374 if (argc) { *argc = full_prog_argc; }
1375 if (argv) { *argv = full_prog_argv; }
1379 setFullProgArgv(int argc, char *argv[])
1382 full_prog_argc = argc;
1383 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1384 "setFullProgArgv 1");
1385 for (i = 0; i < argc; i++) {
1386 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1387 "setFullProgArgv 2");
1388 strcpy(full_prog_argv[i], argv[i]);
1390 full_prog_argv[argc] = NULL;
1394 freeFullProgArgv (void)
1398 if (full_prog_argv != NULL) {
1399 for (i = 0; i < full_prog_argc; i++) {
1400 stgFree(full_prog_argv[i]);
1402 stgFree(full_prog_argv);
1406 full_prog_argv = NULL;