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_);
73 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
74 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
75 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
76 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
77 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
78 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
79 RtsFlags.GcFlags.oldGenFactor = 2;
80 RtsFlags.GcFlags.generations = 2;
81 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
82 RtsFlags.GcFlags.compact = rtsFalse;
83 RtsFlags.GcFlags.compactThreshold = 30.0;
84 RtsFlags.GcFlags.sweep = rtsFalse;
85 #ifdef RTS_GTK_FRONTPANEL
86 RtsFlags.GcFlags.frontpanel = rtsFalse;
88 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
91 /* ToDo: Perhaps by adjusting this value we can make linking without
92 * -static work (i.e., not generate a core-dumping executable)? */
93 # if SIZEOF_VOID_P == 8
94 RtsFlags.GcFlags.heapBase = 0x180000000L;
96 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
99 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
103 RtsFlags.DebugFlags.scheduler = rtsFalse;
104 RtsFlags.DebugFlags.interpreter = rtsFalse;
105 RtsFlags.DebugFlags.weak = rtsFalse;
106 RtsFlags.DebugFlags.gccafs = rtsFalse;
107 RtsFlags.DebugFlags.gc = rtsFalse;
108 RtsFlags.DebugFlags.block_alloc = rtsFalse;
109 RtsFlags.DebugFlags.sanity = rtsFalse;
110 RtsFlags.DebugFlags.stable = rtsFalse;
111 RtsFlags.DebugFlags.stm = rtsFalse;
112 RtsFlags.DebugFlags.prof = rtsFalse;
113 RtsFlags.DebugFlags.apply = rtsFalse;
114 RtsFlags.DebugFlags.linker = rtsFalse;
115 RtsFlags.DebugFlags.squeeze = rtsFalse;
116 RtsFlags.DebugFlags.hpc = rtsFalse;
117 RtsFlags.DebugFlags.sparks = rtsFalse;
120 #if defined(PROFILING)
121 RtsFlags.CcFlags.doCostCentres = 0;
122 #endif /* PROFILING */
124 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
125 RtsFlags.ProfFlags.profileInterval = 100;
128 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
129 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
130 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
131 RtsFlags.ProfFlags.ccsLength = 25;
132 RtsFlags.ProfFlags.modSelector = NULL;
133 RtsFlags.ProfFlags.descrSelector = NULL;
134 RtsFlags.ProfFlags.typeSelector = NULL;
135 RtsFlags.ProfFlags.ccSelector = NULL;
136 RtsFlags.ProfFlags.ccsSelector = NULL;
137 RtsFlags.ProfFlags.retainerSelector = NULL;
138 RtsFlags.ProfFlags.bioSelector = NULL;
142 RtsFlags.TraceFlags.tracing = TRACE_NONE;
143 RtsFlags.TraceFlags.timestamp = rtsFalse;
144 RtsFlags.TraceFlags.scheduler = rtsFalse;
147 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
148 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
150 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
151 RtsFlags.MiscFlags.machineReadable = rtsFalse;
152 RtsFlags.MiscFlags.linkerMemBase = 0;
155 RtsFlags.ParFlags.nNodes = 1;
156 RtsFlags.ParFlags.migrate = rtsTrue;
157 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
158 RtsFlags.ParFlags.parGcEnabled = 1;
159 RtsFlags.ParFlags.parGcGen = 0;
160 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
161 RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
162 RtsFlags.ParFlags.setAffinity = 0;
165 #if defined(THREADED_RTS)
166 RtsFlags.ParFlags.maxLocalSparks = 4096;
167 #endif /* THREADED_RTS */
170 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
171 RtsFlags.TickyFlags.tickyFile = NULL;
175 /* By default no special measurements taken */
176 RtsFlags.PapiFlags.eventType = 0;
177 RtsFlags.PapiFlags.numUserEvents = 0;
184 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
186 " +RTS Indicates run time system options follow",
187 " -RTS Indicates program arguments follow",
188 " --RTS Indicates that ALL subsequent arguments will be given to the",
189 " program (including any of these RTS flags)",
191 "The following run time system options are available:",
193 " -? Prints this message and exits; the program is not executed",
194 " --info Print information about the RTS used by this program",
196 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
197 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
199 " -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
200 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
201 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
202 " -m<n> Minimum % of heap which must be available (default 3%)",
203 " -G<n> Number of generations (default: 2)",
204 " -c<n> Use in-place compaction instead of copying in the oldest generation",
205 " when live data is at least <n>% of the maximum heap size set with",
206 " -M (default: 30%)",
207 " -c Use in-place compaction for all oldest generation collections",
208 " (the default is to use copying)",
209 " -w Use mark-region for the oldest generation (experimental)",
210 #if defined(THREADED_RTS)
211 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
214 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
215 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
216 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
217 #ifdef RTS_GTK_FRONTPANEL
218 " -f Display front panel (requires X11 & GTK+)",
222 " -Z Don't squeeze out update frames on stack overflow",
223 " -B Sound the bell at the start of each garbage collection",
224 #if defined(PROFILING)
226 " -px Time/allocation profile (XML) (output file <program>.prof)",
227 " -p Time/allocation profile (output file <program>.prof)",
228 " -P More detailed Time/Allocation profile",
229 " -Pa Give information about *all* cost centres",
231 # if defined(PROFILING)
233 " -hx Heap residency profile (XML) (output file <program>.prof)",
234 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
235 " break-down: c = cost centre stack (default)",
237 " d = closure description",
238 " y = type description",
240 " b = biography (LAG,DRAG,VOID,USE)",
241 " A subset of closures may be selected thusly:",
242 " -hc<cc>,... specific cost centre(s) (top of stack only)",
243 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
244 " -hm<mod>... all cost centres from the specified modules(s)",
245 " -hd<des>,... closures with specified closure descriptions",
246 " -hy<typ>... closures with specified type descriptions",
247 " -hr<cc>... closures with specified retainers",
248 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
250 " -R<size> Set the maximum retainer set size (default: 8)",
252 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
255 " -xt Include threads (TSOs) in a heap profile",
257 " -xc Show current cost centre stack on raising an exception",
259 #endif /* PROFILING or PAR */
263 " -l[flags] Log events in binary format to the file <program>.eventlog",
265 " -v[flags] Log events to stderr",
267 " where [flags] can contain:",
268 " s scheduler events",
270 " t add time stamps (only useful with -v)",
274 #if !defined(PROFILING)
276 " -hT Heap residency profile (output file <program>.hp)",
278 " -i<sec> Time between heap samples (seconds, default: 0.1)",
280 #if defined(TICKY_TICKY)
281 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
284 " -C<secs> Context-switch interval in seconds.",
285 " 0 or no argument means switch as often as possible.",
286 " Default: 0.02 sec; resolution is set by -V below.",
287 " -V<secs> Master tick interval in seconds (0 == disable timer).",
288 " This sets the resolution for -C and the profile timer -i.",
289 " Default: 0.02 sec.",
292 " -Ds DEBUG: scheduler",
293 " -Di DEBUG: interpreter",
295 " -DG DEBUG: gccafs",
298 " -DS DEBUG: sanity",
299 " -Dt DEBUG: stable",
301 " -De DEBUG: event logging",
303 " -Dl DEBUG: linker",
305 " -Dz DEBUG: stack squezing",
306 " -Dc DEBUG: program coverage",
307 " -Dr DEBUG: sparks",
309 " NOTE: DEBUG events are sent to stderr by default; add -l to create a",
310 " binary event log file instead.",
313 #if defined(THREADED_RTS) && !defined(NOSMP)
314 " -N<n> Use <n> processors (default: 1)",
315 " -N Determine the number of processors to use automatically",
316 " -qg[<n>] Use parallel GC only for generations >= <n>",
317 " (default: 0, -qg alone turns off parallel GC)",
318 " -qb[<n>] Use load-balancing in the parallel GC only for generations >= <n>",
319 " (default: 1, -qb alone turns off load-balancing)",
320 " -qa Use the OS to set thread affinity (experimental)",
321 " -qm Don't automatically migrate threads between CPUs",
322 " -qw Migrate a thread to the current CPU when it is woken up",
324 " --install-signal-handlers=<yes|no>",
325 " Install signal handlers (default: yes)",
326 #if defined(THREADED_RTS)
327 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
329 #if defined(x86_64_HOST_ARCH)
330 " -xm Base address to mmap memory in the GHCi linker",
331 " (hex; must be <80000000)",
333 #if defined(USE_PAPI)
334 " -aX CPU performance counter measurements using PAPI",
335 " (use with the -s<file> option). X is one of:",
338 " 1 - level 1 cache misses",
339 " 2 - level 2 cache misses",
340 " b - branch mispredictions",
341 " s - stalled cycles",
342 " e - cache miss and branch misprediction events",
343 " +PAPI_EVENT - collect papi preset event PAPI_EVENT",
344 " #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
347 "RTS options may also be specified using the GHCRTS environment variable.",
349 "Other RTS options may be available for programs compiled a different way.",
350 "The GHC User's Guide has full details.",
355 STATIC_INLINE rtsBool
356 strequal(const char *a, const char * b)
358 return(strcmp(a, b) == 0);
362 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
368 while (isspace(*c1)) { c1++; };
370 while (!isspace(*c2) && *c2 != '\0') { c2++; };
372 if (c1 == c2) { break; }
374 if (*rts_argc < MAX_RTS_ARGS-1) {
375 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
376 strncpy(s, c1, c2-c1);
378 rts_argv[(*rts_argc)++] = s;
380 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
384 } while (*c1 != '\0');
388 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
390 rtsBool error = rtsFalse;
401 // process arguments from the ghc_rts_opts global variable first.
402 // (arguments from the GHCRTS environment variable and the command
403 // line override these).
405 if (ghc_rts_opts != NULL) {
406 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
410 // process arguments from the GHCRTS environment variable next
411 // (arguments from the command line override these).
413 char *ghc_rts = getenv("GHCRTS");
415 if (ghc_rts != NULL) {
416 if (rtsOptsEnabled) {
417 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
420 errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n Link with -rtsopts to enable them.");
421 // We don't actually exit, just warn
426 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
427 // argv[0] must be PGM argument -- leave in argv
429 for (mode = PGM; arg < total_arg; arg++) {
430 // The '--RTS' argument disables all future +RTS ... -RTS processing.
431 if (strequal("--RTS", argv[arg])) {
435 // The '--' argument is passed through to the program, but
436 // disables all further +RTS ... -RTS processing.
437 else if (strequal("--", argv[arg])) {
440 else if (strequal("+RTS", argv[arg])) {
441 if (rtsOptsEnabled) {
445 errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
446 stg_exit(EXIT_FAILURE);
449 else if (strequal("-RTS", argv[arg])) {
452 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
453 rts_argv[(*rts_argc)++] = argv[arg];
455 else if (mode == PGM) {
456 argv[(*argc)++] = argv[arg];
459 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
462 // process remaining program arguments
463 for (; arg < total_arg; arg++) {
464 argv[(*argc)++] = argv[arg];
466 argv[*argc] = (char *) 0;
467 rts_argv[*rts_argc] = (char *) 0;
469 // Process RTS (rts_argv) part: mainly to determine statsfile
470 for (arg = 0; arg < *rts_argc; arg++) {
471 if (rts_argv[arg][0] != '-') {
473 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
477 switch(rts_argv[arg][1]) {
479 /* process: general args, then PROFILING-only ones, then
480 CONCURRENT-only, TICKY-only (same order as defined in
481 RtsFlags.lh); within those groups, mostly in
482 case-insensitive alphabetical order. Final group is
483 x*, which allows for more options.
487 # define TICKY_BUILD_ONLY(x) x
489 # define TICKY_BUILD_ONLY(x) \
490 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
495 # define PROFILING_BUILD_ONLY(x) x
497 # define PROFILING_BUILD_ONLY(x) \
498 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
503 # define TRACING_BUILD_ONLY(x) x
505 # define TRACING_BUILD_ONLY(x) \
506 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
511 # define THREADED_BUILD_ONLY(x) x
513 # define THREADED_BUILD_ONLY(x) \
514 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
519 # define DEBUG_BUILD_ONLY(x) x
521 # define DEBUG_BUILD_ONLY(x) \
522 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
526 /* =========== GENERAL ========================== */
531 /* This isn't going to allow us to keep related options
532 together as we add more --* flags. We really need a
533 proper options parser. */
535 if (strequal("install-signal-handlers=yes",
536 &rts_argv[arg][2])) {
537 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
539 else if (strequal("install-signal-handlers=no",
540 &rts_argv[arg][2])) {
541 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
543 else if (strequal("machine-readable",
544 &rts_argv[arg][2])) {
545 RtsFlags.MiscFlags.machineReadable = rtsTrue;
547 else if (strequal("info",
548 &rts_argv[arg][2])) {
553 errorBelch("unknown RTS option: %s",rts_argv[arg]);
558 RtsFlags.GcFlags.minAllocAreaSize
559 = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
565 switch(rts_argv[arg][2]) {
567 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
570 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
573 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
576 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
579 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
583 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
584 errorBelch("maximum number of PAPI events reached");
585 stg_exit(EXIT_FAILURE);
587 nat eventNum = RtsFlags.PapiFlags.numUserEvents++;
588 char kind = rts_argv[arg][2];
589 nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;
591 RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
592 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
593 RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
596 bad_option( rts_argv[arg] );
602 RtsFlags.GcFlags.ringBell = rtsTrue;
606 if (rts_argv[arg][2] != '\0') {
607 RtsFlags.GcFlags.compactThreshold =
608 atof(rts_argv[arg]+2);
610 RtsFlags.GcFlags.compact = rtsTrue;
615 RtsFlags.GcFlags.sweep = rtsTrue;
619 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
621 if (RtsFlags.GcFlags.oldGenFactor < 0)
622 bad_option( rts_argv[arg] );
630 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
633 RtsFlags.DebugFlags.scheduler = rtsTrue;
636 RtsFlags.DebugFlags.interpreter = rtsTrue;
639 RtsFlags.DebugFlags.weak = rtsTrue;
642 RtsFlags.DebugFlags.gccafs = rtsTrue;
645 RtsFlags.DebugFlags.gc = rtsTrue;
648 RtsFlags.DebugFlags.block_alloc = rtsTrue;
651 RtsFlags.DebugFlags.sanity = rtsTrue;
654 RtsFlags.DebugFlags.stable = rtsTrue;
657 RtsFlags.DebugFlags.prof = rtsTrue;
660 RtsFlags.DebugFlags.linker = rtsTrue;
663 RtsFlags.DebugFlags.apply = rtsTrue;
666 RtsFlags.DebugFlags.stm = rtsTrue;
669 RtsFlags.DebugFlags.squeeze = rtsTrue;
672 RtsFlags.DebugFlags.hpc = rtsTrue;
675 RtsFlags.DebugFlags.sparks = rtsTrue;
678 bad_option( rts_argv[arg] );
681 // -Dx also turns on -v. Use -l to direct trace
682 // events to the .eventlog file instead.
683 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
688 RtsFlags.GcFlags.maxStkSize =
689 decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
693 RtsFlags.GcFlags.initialStkSize =
694 decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
698 RtsFlags.GcFlags.maxHeapSize =
699 decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
700 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
704 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
706 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
707 RtsFlags.GcFlags.pcFreeHeap > 100)
708 bad_option( rts_argv[arg] );
712 RtsFlags.GcFlags.generations =
713 decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
717 if (rts_argv[arg][2] == '\0') {
718 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
720 RtsFlags.GcFlags.heapSizeSuggestion =
721 (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
725 #ifdef RTS_GTK_FRONTPANEL
727 RtsFlags.GcFlags.frontpanel = rtsTrue;
731 case 'I': /* idle GC delay */
732 if (rts_argv[arg][2] == '\0') {
737 /* Convert to millisecs */
738 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
739 RtsFlags.GcFlags.idleGCDelayTime = cst;
744 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
748 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
752 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
758 r = open_stats_file(arg, *argc, argv,
759 *rts_argc, rts_argv, NULL,
760 &RtsFlags.GcFlags.statsFile);
761 if (r == -1) { error = rtsTrue; }
766 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
769 /* =========== PROFILING ========================== */
771 case 'P': /* detailed cost centre profiling (time/alloc) */
772 case 'p': /* cost centre profiling (time/alloc) */
773 PROFILING_BUILD_ONLY(
774 switch (rts_argv[arg][2]) {
776 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
779 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
782 if (rts_argv[arg][1] == 'P') {
783 RtsFlags.CcFlags.doCostCentres =
784 COST_CENTRES_VERBOSE;
786 RtsFlags.CcFlags.doCostCentres =
787 COST_CENTRES_SUMMARY;
794 PROFILING_BUILD_ONLY(
795 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
798 PROFILING_BUILD_ONLY(
799 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
800 if(RtsFlags.ProfFlags.ccsLength <= 0) {
801 bad_option(rts_argv[arg]);
804 case 'h': /* serial heap profile */
805 #if !defined(PROFILING)
806 switch (rts_argv[arg][2]) {
809 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
812 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
816 PROFILING_BUILD_ONLY(
817 switch (rts_argv[arg][2]) {
831 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
833 char *left = strchr(rts_argv[arg], '{');
834 char *right = strrchr(rts_argv[arg], '}');
836 // curly braces are optional, for
841 left = rts_argv[arg] + 3;
844 right = rts_argv[arg] + strlen(rts_argv[arg]);
848 switch (rts_argv[arg][2]) {
849 case 'c': // cost centre label select
850 RtsFlags.ProfFlags.ccSelector = left;
853 RtsFlags.ProfFlags.ccsSelector = left;
856 case 'm': // cost centre module select
857 RtsFlags.ProfFlags.modSelector = left;
860 case 'd': // closure descr select
861 RtsFlags.ProfFlags.descrSelector = left;
864 case 'y': // closure type select
865 RtsFlags.ProfFlags.typeSelector = left;
868 case 'r': // retainer select
869 RtsFlags.ProfFlags.retainerSelector = left;
872 case 'b': // biography select
873 RtsFlags.ProfFlags.bioSelector = left;
880 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
881 errorBelch("multiple heap profile options");
886 switch (rts_argv[arg][2]) {
890 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
894 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
898 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
902 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
906 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
910 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
916 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
920 #endif /* PROFILING */
923 case 'i': /* heap sample interval */
924 if (rts_argv[arg][2] == '\0') {
929 /* Convert to milliseconds */
930 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
931 RtsFlags.ProfFlags.profileInterval = cst;
935 /* =========== CONCURRENT ========================= */
936 case 'C': /* context switch interval */
937 if (rts_argv[arg][2] == '\0')
938 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
942 /* Convert to milliseconds */
943 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
944 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
948 case 'V': /* master tick interval */
949 if (rts_argv[arg][2] == '\0') {
950 // turns off ticks completely
951 RtsFlags.MiscFlags.tickInterval = 0;
955 /* Convert to milliseconds */
956 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
957 RtsFlags.MiscFlags.tickInterval = cst;
964 if (rts_argv[arg][2] == '\0') {
965 #if defined(PROFILING)
966 RtsFlags.ParFlags.nNodes = 1;
968 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
971 RtsFlags.ParFlags.nNodes
972 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
973 if (RtsFlags.ParFlags.nNodes <= 0) {
974 errorBelch("bad value for -N");
977 #if defined(PROFILING)
978 if (RtsFlags.ParFlags.nNodes > 1) {
979 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
988 switch (rts_argv[arg][2]) {
990 // backwards compat only
991 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
994 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1001 THREADED_BUILD_ONLY(
1002 switch (rts_argv[arg][2]) {
1004 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1008 if (rts_argv[arg][3] == '\0') {
1009 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1011 RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1012 RtsFlags.ParFlags.parGcGen
1013 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1017 if (rts_argv[arg][3] == '\0') {
1018 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1021 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1022 RtsFlags.ParFlags.parGcLoadBalancingGen
1023 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1027 RtsFlags.ParFlags.setAffinity = rtsTrue;
1030 RtsFlags.ParFlags.migrate = rtsFalse;
1033 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1036 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1042 /* =========== PARALLEL =========================== */
1044 THREADED_BUILD_ONLY(
1045 if (rts_argv[arg][2] != '\0') {
1046 RtsFlags.ParFlags.maxLocalSparks
1047 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1048 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1049 errorBelch("bad value for -e");
1055 /* =========== TICKY ============================== */
1057 case 'r': /* Basic profiling stats */
1060 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1064 r = open_stats_file(arg, *argc, argv,
1065 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1066 &RtsFlags.TickyFlags.tickyFile);
1067 if (r == -1) { error = rtsTrue; }
1071 /* =========== TRACING ---------=================== */
1075 RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1076 read_trace_flags(&rts_argv[arg][2]);
1082 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1083 read_trace_flags(&rts_argv[arg][2]);
1087 /* =========== EXTENDED OPTIONS =================== */
1089 case 'x': /* Extend the argument space */
1090 switch(rts_argv[arg][2]) {
1092 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1096 case 'b': /* heapBase in hex; undocumented */
1097 if (rts_argv[arg][3] != '\0') {
1098 RtsFlags.GcFlags.heapBase
1099 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1101 errorBelch("-xb: requires argument");
1106 #if defined(x86_64_HOST_ARCH)
1107 case 'm': /* linkerMemBase */
1108 if (rts_argv[arg][3] != '\0') {
1109 RtsFlags.MiscFlags.linkerMemBase
1110 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1111 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1112 errorBelch("-xm: value must be <80000000");
1116 RtsFlags.MiscFlags.linkerMemBase = 0;
1121 case 'c': /* Debugging tool: show current cost centre on an exception */
1122 PROFILING_BUILD_ONLY(
1123 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1127 case 't': /* Include memory used by TSOs in a heap profile */
1128 PROFILING_BUILD_ONLY(
1129 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1133 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1136 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1140 break; /* defensive programming */
1142 /* =========== OH DEAR ============================ */
1144 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1151 if (RtsFlags.MiscFlags.tickInterval < 0) {
1152 RtsFlags.MiscFlags.tickInterval = 50;
1155 // If the master timer is disabled, turn off the other timers.
1156 if (RtsFlags.MiscFlags.tickInterval == 0) {
1157 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1158 RtsFlags.GcFlags.idleGCDelayTime = 0;
1159 RtsFlags.ProfFlags.profileInterval = 0;
1162 // Determine what tick interval we should use for the RTS timer
1163 // by taking the shortest of the various intervals that we need to
1165 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1166 RtsFlags.MiscFlags.tickInterval =
1167 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1168 RtsFlags.MiscFlags.tickInterval);
1171 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1172 RtsFlags.MiscFlags.tickInterval =
1173 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1174 RtsFlags.MiscFlags.tickInterval);
1177 if (RtsFlags.ProfFlags.profileInterval > 0) {
1178 RtsFlags.MiscFlags.tickInterval =
1179 stg_min(RtsFlags.ProfFlags.profileInterval,
1180 RtsFlags.MiscFlags.tickInterval);
1183 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1184 RtsFlags.ConcFlags.ctxtSwitchTicks =
1185 RtsFlags.ConcFlags.ctxtSwitchTime /
1186 RtsFlags.MiscFlags.tickInterval;
1188 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1191 if (RtsFlags.ProfFlags.profileInterval > 0) {
1192 RtsFlags.ProfFlags.profileIntervalTicks =
1193 RtsFlags.ProfFlags.profileInterval /
1194 RtsFlags.MiscFlags.tickInterval;
1196 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1203 for (p = usage_text; *p; p++)
1204 errorBelch("%s", *p);
1205 stg_exit(EXIT_FAILURE);
1211 stats_fprintf(FILE *f, char *s, ...)
1223 static int /* return -1 on error */
1226 int argc, char *argv[],
1227 int rts_argc, char *rts_argv[],
1228 const char *FILENAME_FMT,
1233 if (strequal(rts_argv[arg]+2, "stderr")
1234 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1235 f = NULL; /* NULL means use debugBelch */
1237 if (rts_argv[arg][2] != '\0') { /* stats file specified */
1238 f = fopen(rts_argv[arg]+2,"w");
1240 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1241 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1242 f = fopen(stats_filename,"w");
1245 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1252 /* Write argv and rtsv into start of stats file */
1254 for(count = 0; count < argc; count++) {
1255 stats_fprintf(f, "%s ", argv[count]);
1257 stats_fprintf(f, "+RTS ");
1258 for(count = 0; count < rts_argc; count++)
1259 stats_fprintf(f, "%s ", rts_argv[count]);
1260 stats_fprintf(f, "\n");
1268 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1286 if (c == 'g' || c == 'G')
1287 m *= 1024*1024*1024;
1288 else if (c == 'm' || c == 'M')
1290 else if (c == 'k' || c == 'K')
1292 else if (c == 'w' || c == 'W')
1298 if (m < 0 || val < min || val > max) {
1299 // printf doesn't like 64-bit format specs on Windows
1300 // apparently, so fall back to unsigned long.
1301 errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1302 stg_exit(EXIT_FAILURE);
1308 #if defined(TRACING)
1309 static void read_trace_flags(char *arg)
1313 for (c = arg; *c != '\0'; c++) {
1318 RtsFlags.TraceFlags.scheduler = rtsTrue;
1321 RtsFlags.TraceFlags.timestamp = rtsTrue;
1324 // ignored for backwards-compat
1327 errorBelch("unknown trace option: %c",*c);
1334 static void GNU_ATTRIBUTE(__noreturn__)
1335 bad_option(const char *s)
1337 errorBelch("bad RTS option: %s", s);
1338 stg_exit(EXIT_FAILURE);
1341 /* -----------------------------------------------------------------------------
1342 Getting/Setting the program's arguments.
1344 These are used by System.Environment, and parts of the RTS.
1345 -------------------------------------------------------------------------- */
1348 setProgName(char *argv[])
1350 /* Remove directory from argv[0] -- default files in current directory */
1351 #if !defined(mingw32_HOST_OS)
1353 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1354 prog_name = last_slash+1;
1356 prog_name = argv[0];
1359 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1360 while ( last_slash > argv[0] ) {
1361 if ( *last_slash == '/' || *last_slash == '\\' ) {
1362 prog_name = last_slash+1;
1367 prog_name = argv[0];
1372 getProgArgv(int *argc, char **argv[])
1374 if (argc) { *argc = prog_argc; }
1375 if (argv) { *argv = prog_argv; }
1379 setProgArgv(int argc, char *argv[])
1381 /* Usually this is done by startupHaskell, so we don't need to call this.
1382 However, sometimes Hugs wants to change the arguments which Haskell
1383 getArgs >>= ... will be fed. So you can do that by calling here
1384 _after_ calling startupHaskell.
1388 setProgName(prog_argv);
1391 /* These functions record and recall the full arguments, including the
1392 +RTS ... -RTS options. The reason for adding them was so that the
1393 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1395 getFullProgArgv(int *argc, char **argv[])
1397 if (argc) { *argc = full_prog_argc; }
1398 if (argv) { *argv = full_prog_argv; }
1402 setFullProgArgv(int argc, char *argv[])
1405 full_prog_argc = argc;
1406 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1407 "setFullProgArgv 1");
1408 for (i = 0; i < argc; i++) {
1409 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1410 "setFullProgArgv 2");
1411 strcpy(full_prog_argv[i], argv[i]);
1413 full_prog_argv[argc] = NULL;
1417 freeFullProgArgv (void)
1421 if (full_prog_argv != NULL) {
1422 for (i = 0; i < full_prog_argc; i++) {
1423 stgFree(full_prog_argv[i]);
1425 stgFree(full_prog_argv);
1429 full_prog_argv = NULL;