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 static void read_trace_flags(char *arg);
60 /* -----------------------------------------------------------------------------
61 * Command-line option parsing routines.
62 * ---------------------------------------------------------------------------*/
64 void initRtsFlagsDefaults(void)
66 RtsFlags.GcFlags.statsFile = NULL;
67 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
69 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
70 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
72 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
73 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
74 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
75 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
76 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
77 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
78 RtsFlags.GcFlags.oldGenFactor = 2;
79 RtsFlags.GcFlags.generations = 2;
80 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
81 RtsFlags.GcFlags.compact = rtsFalse;
82 RtsFlags.GcFlags.compactThreshold = 30.0;
83 RtsFlags.GcFlags.sweep = rtsFalse;
84 #ifdef RTS_GTK_FRONTPANEL
85 RtsFlags.GcFlags.frontpanel = rtsFalse;
87 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
90 /* ToDo: Perhaps by adjusting this value we can make linking without
91 * -static work (i.e., not generate a core-dumping executable)? */
92 # if SIZEOF_VOID_P == 8
93 RtsFlags.GcFlags.heapBase = 0x180000000L;
95 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
98 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
102 RtsFlags.DebugFlags.scheduler = rtsFalse;
103 RtsFlags.DebugFlags.interpreter = rtsFalse;
104 RtsFlags.DebugFlags.weak = rtsFalse;
105 RtsFlags.DebugFlags.gccafs = rtsFalse;
106 RtsFlags.DebugFlags.gc = rtsFalse;
107 RtsFlags.DebugFlags.block_alloc = rtsFalse;
108 RtsFlags.DebugFlags.sanity = rtsFalse;
109 RtsFlags.DebugFlags.stable = rtsFalse;
110 RtsFlags.DebugFlags.stm = rtsFalse;
111 RtsFlags.DebugFlags.prof = rtsFalse;
112 RtsFlags.DebugFlags.apply = rtsFalse;
113 RtsFlags.DebugFlags.linker = rtsFalse;
114 RtsFlags.DebugFlags.squeeze = rtsFalse;
115 RtsFlags.DebugFlags.hpc = rtsFalse;
116 RtsFlags.DebugFlags.sparks = rtsFalse;
119 #if defined(PROFILING)
120 RtsFlags.CcFlags.doCostCentres = 0;
121 #endif /* PROFILING */
123 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
124 RtsFlags.ProfFlags.profileInterval = 100;
127 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
128 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
129 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
130 RtsFlags.ProfFlags.ccsLength = 25;
131 RtsFlags.ProfFlags.modSelector = NULL;
132 RtsFlags.ProfFlags.descrSelector = NULL;
133 RtsFlags.ProfFlags.typeSelector = NULL;
134 RtsFlags.ProfFlags.ccSelector = NULL;
135 RtsFlags.ProfFlags.ccsSelector = NULL;
136 RtsFlags.ProfFlags.retainerSelector = NULL;
137 RtsFlags.ProfFlags.bioSelector = NULL;
141 RtsFlags.TraceFlags.tracing = TRACE_NONE;
142 RtsFlags.TraceFlags.timestamp = rtsFalse;
143 RtsFlags.TraceFlags.scheduler = rtsFalse;
146 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
147 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
149 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
150 RtsFlags.MiscFlags.machineReadable = rtsFalse;
151 RtsFlags.MiscFlags.linkerMemBase = 0;
154 RtsFlags.ParFlags.nNodes = 1;
155 RtsFlags.ParFlags.migrate = rtsTrue;
156 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
157 RtsFlags.ParFlags.parGcEnabled = 1;
158 RtsFlags.ParFlags.parGcGen = 0;
159 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
160 RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
161 RtsFlags.ParFlags.setAffinity = 0;
164 #if defined(THREADED_RTS)
165 RtsFlags.ParFlags.maxLocalSparks = 4096;
166 #endif /* THREADED_RTS */
169 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
170 RtsFlags.TickyFlags.tickyFile = NULL;
174 /* By default no special measurements taken */
175 RtsFlags.PapiFlags.eventType = 0;
176 RtsFlags.PapiFlags.numUserEvents = 0;
183 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
185 " +RTS Indicates run time system options follow",
186 " -RTS Indicates program arguments follow",
187 " --RTS Indicates that ALL subsequent arguments will be given to the",
188 " program (including any of these RTS flags)",
190 "The following run time system options are available:",
192 " -? Prints this message and exits; the program is not executed",
193 " --info Print information about the RTS used by this program",
195 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
196 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
198 " -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
199 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
200 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
201 " -m<n> Minimum % of heap which must be available (default 3%)",
202 " -G<n> Number of generations (default: 2)",
203 " -c<n> Use in-place compaction instead of copying in the oldest generation",
204 " when live data is at least <n>% of the maximum heap size set with",
205 " -M (default: 30%)",
206 " -c Use in-place compaction for all oldest generation collections",
207 " (the default is to use copying)",
208 " -w Use mark-region for the oldest generation (experimental)",
209 #if defined(THREADED_RTS)
210 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
213 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
214 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
215 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
216 #ifdef RTS_GTK_FRONTPANEL
217 " -f Display front panel (requires X11 & GTK+)",
221 " -Z Don't squeeze out update frames on stack overflow",
222 " -B Sound the bell at the start of each garbage collection",
223 #if defined(PROFILING)
225 " -px Time/allocation profile (XML) (output file <program>.prof)",
226 " -p Time/allocation profile (output file <program>.prof)",
227 " -P More detailed Time/Allocation profile",
228 " -Pa Give information about *all* cost centres",
230 # if defined(PROFILING)
232 " -hx Heap residency profile (XML) (output file <program>.prof)",
233 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
234 " break-down: c = cost centre stack (default)",
236 " d = closure description",
237 " y = type description",
239 " b = biography (LAG,DRAG,VOID,USE)",
240 " A subset of closures may be selected thusly:",
241 " -hc<cc>,... specific cost centre(s) (top of stack only)",
242 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
243 " -hm<mod>... all cost centres from the specified modules(s)",
244 " -hd<des>,... closures with specified closure descriptions",
245 " -hy<typ>... closures with specified type descriptions",
246 " -hr<cc>... closures with specified retainers",
247 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
249 " -R<size> Set the maximum retainer set size (default: 8)",
251 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
254 " -xt Include threads (TSOs) in a heap profile",
256 " -xc Show current cost centre stack on raising an exception",
258 #endif /* PROFILING or PAR */
262 " -l[flags] Log events in binary format to the file <program>.eventlog",
264 " -v[flags] Log events to stderr",
266 " where [flags] can contain:",
267 " s scheduler events",
269 " t add time stamps (only useful with -v)",
273 #if !defined(PROFILING)
275 " -hT Heap residency profile (output file <program>.hp)",
277 " -i<sec> Time between heap samples (seconds, default: 0.1)",
279 #if defined(TICKY_TICKY)
280 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
283 " -C<secs> Context-switch interval in seconds.",
284 " 0 or no argument means switch as often as possible.",
285 " Default: 0.02 sec; resolution is set by -V below.",
286 " -V<secs> Master tick interval in seconds (0 == disable timer).",
287 " This sets the resolution for -C and the profile timer -i.",
288 " Default: 0.02 sec.",
291 " -Ds DEBUG: scheduler",
292 " -Di DEBUG: interpreter",
294 " -DG DEBUG: gccafs",
297 " -DS DEBUG: sanity",
298 " -Dt DEBUG: stable",
300 " -De DEBUG: event logging",
302 " -Dl DEBUG: linker",
304 " -Dz DEBUG: stack squezing",
305 " -Dc DEBUG: program coverage",
306 " -Dr DEBUG: sparks",
308 " NOTE: DEBUG events are sent to stderr by default; add -l to create a",
309 " binary event log file instead.",
312 #if defined(THREADED_RTS) && !defined(NOSMP)
313 " -N<n> Use <n> processors (default: 1)",
314 " -N Determine the number of processors to use automatically",
315 " -qg[<n>] Use parallel GC only for generations >= <n>",
316 " (default: 0, -qg alone turns off parallel GC)",
317 " -qb[<n>] Use load-balancing in the parallel GC only for generations >= <n>",
318 " (default: 1, -qb alone turns off load-balancing)",
319 " -qa Use the OS to set thread affinity (experimental)",
320 " -qm Don't automatically migrate threads between CPUs",
321 " -qw Migrate a thread to the current CPU when it is woken up",
323 " --install-signal-handlers=<yes|no>",
324 " Install signal handlers (default: yes)",
325 #if defined(THREADED_RTS)
326 " -e<size> Size of spark pools (default 100)",
328 #if defined(THREADED_RTS)
329 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
331 #if defined(x86_64_HOST_ARCH)
332 " -xm Base address to mmap memory in the GHCi linker",
333 " (hex; must be <80000000)",
335 #if defined(USE_PAPI)
336 " -aX CPU performance counter measurements using PAPI",
337 " (use with the -s<file> option). X is one of:",
340 " 1 - level 1 cache misses",
341 " 2 - level 2 cache misses",
342 " b - branch mispredictions",
343 " s - stalled cycles",
344 " e - cache miss and branch misprediction events",
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 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
420 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
421 // argv[0] must be PGM argument -- leave in argv
423 for (mode = PGM; arg < total_arg; arg++) {
424 // The '--RTS' argument disables all future +RTS ... -RTS processing.
425 if (strequal("--RTS", argv[arg])) {
429 // The '--' argument is passed through to the program, but
430 // disables all further +RTS ... -RTS processing.
431 else if (strequal("--", argv[arg])) {
434 else if (strequal("+RTS", argv[arg])) {
437 else if (strequal("-RTS", argv[arg])) {
440 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
441 rts_argv[(*rts_argc)++] = argv[arg];
443 else if (mode == PGM) {
444 argv[(*argc)++] = argv[arg];
447 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
450 // process remaining program arguments
451 for (; arg < total_arg; arg++) {
452 argv[(*argc)++] = argv[arg];
454 argv[*argc] = (char *) 0;
455 rts_argv[*rts_argc] = (char *) 0;
457 // Process RTS (rts_argv) part: mainly to determine statsfile
458 for (arg = 0; arg < *rts_argc; arg++) {
459 if (rts_argv[arg][0] != '-') {
461 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
465 switch(rts_argv[arg][1]) {
467 /* process: general args, then PROFILING-only ones, then
468 CONCURRENT-only, TICKY-only (same order as defined in
469 RtsFlags.lh); within those groups, mostly in
470 case-insensitive alphabetical order. Final group is
471 x*, which allows for more options.
475 # define TICKY_BUILD_ONLY(x) x
477 # define TICKY_BUILD_ONLY(x) \
478 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
483 # define PROFILING_BUILD_ONLY(x) x
485 # define PROFILING_BUILD_ONLY(x) \
486 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
491 # define TRACING_BUILD_ONLY(x) x
493 # define TRACING_BUILD_ONLY(x) \
494 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
499 # define THREADED_BUILD_ONLY(x) x
501 # define THREADED_BUILD_ONLY(x) \
502 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
507 # define DEBUG_BUILD_ONLY(x) x
509 # define DEBUG_BUILD_ONLY(x) \
510 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
514 /* =========== GENERAL ========================== */
519 /* This isn't going to allow us to keep related options
520 together as we add more --* flags. We really need a
521 proper options parser. */
523 if (strequal("install-signal-handlers=yes",
524 &rts_argv[arg][2])) {
525 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
527 else if (strequal("install-signal-handlers=no",
528 &rts_argv[arg][2])) {
529 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
531 else if (strequal("machine-readable",
532 &rts_argv[arg][2])) {
533 RtsFlags.MiscFlags.machineReadable = rtsTrue;
535 else if (strequal("info",
536 &rts_argv[arg][2])) {
541 errorBelch("unknown RTS option: %s",rts_argv[arg]);
546 RtsFlags.GcFlags.minAllocAreaSize
547 = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
553 switch(rts_argv[arg][2]) {
555 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
558 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
561 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
564 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
567 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
570 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
571 errorBelch("maximum number of PAPI events reached");
572 stg_exit(EXIT_FAILURE);
574 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
575 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
578 bad_option( rts_argv[arg] );
584 RtsFlags.GcFlags.ringBell = rtsTrue;
588 if (rts_argv[arg][2] != '\0') {
589 RtsFlags.GcFlags.compactThreshold =
590 atof(rts_argv[arg]+2);
592 RtsFlags.GcFlags.compact = rtsTrue;
597 RtsFlags.GcFlags.sweep = rtsTrue;
601 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
603 if (RtsFlags.GcFlags.oldGenFactor < 0)
604 bad_option( rts_argv[arg] );
612 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
615 RtsFlags.DebugFlags.scheduler = rtsTrue;
618 RtsFlags.DebugFlags.interpreter = rtsTrue;
621 RtsFlags.DebugFlags.weak = rtsTrue;
624 RtsFlags.DebugFlags.gccafs = rtsTrue;
627 RtsFlags.DebugFlags.gc = rtsTrue;
630 RtsFlags.DebugFlags.block_alloc = rtsTrue;
633 RtsFlags.DebugFlags.sanity = rtsTrue;
636 RtsFlags.DebugFlags.stable = rtsTrue;
639 RtsFlags.DebugFlags.prof = rtsTrue;
642 RtsFlags.DebugFlags.linker = rtsTrue;
645 RtsFlags.DebugFlags.apply = rtsTrue;
648 RtsFlags.DebugFlags.stm = rtsTrue;
651 RtsFlags.DebugFlags.squeeze = rtsTrue;
654 RtsFlags.DebugFlags.hpc = rtsTrue;
657 RtsFlags.DebugFlags.sparks = rtsTrue;
660 bad_option( rts_argv[arg] );
663 // -Dx also turns on -v. Use -l to direct trace
664 // events to the .eventlog file instead.
665 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
670 RtsFlags.GcFlags.maxStkSize =
671 decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
675 RtsFlags.GcFlags.initialStkSize =
676 decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
680 RtsFlags.GcFlags.maxHeapSize =
681 decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
682 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
686 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
688 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
689 RtsFlags.GcFlags.pcFreeHeap > 100)
690 bad_option( rts_argv[arg] );
694 RtsFlags.GcFlags.generations =
695 decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
699 if (rts_argv[arg][2] == '\0') {
700 RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
702 RtsFlags.GcFlags.heapSizeSuggestion =
703 (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
707 #ifdef RTS_GTK_FRONTPANEL
709 RtsFlags.GcFlags.frontpanel = rtsTrue;
713 case 'I': /* idle GC delay */
714 if (rts_argv[arg][2] == '\0') {
719 /* Convert to millisecs */
720 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
721 RtsFlags.GcFlags.idleGCDelayTime = cst;
726 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
730 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
734 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
740 r = open_stats_file(arg, *argc, argv,
741 *rts_argc, rts_argv, NULL,
742 &RtsFlags.GcFlags.statsFile);
743 if (r == -1) { error = rtsTrue; }
748 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
751 /* =========== PROFILING ========================== */
753 case 'P': /* detailed cost centre profiling (time/alloc) */
754 case 'p': /* cost centre profiling (time/alloc) */
755 PROFILING_BUILD_ONLY(
756 switch (rts_argv[arg][2]) {
758 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
761 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
764 if (rts_argv[arg][1] == 'P') {
765 RtsFlags.CcFlags.doCostCentres =
766 COST_CENTRES_VERBOSE;
768 RtsFlags.CcFlags.doCostCentres =
769 COST_CENTRES_SUMMARY;
776 PROFILING_BUILD_ONLY(
777 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
780 PROFILING_BUILD_ONLY(
781 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
782 if(RtsFlags.ProfFlags.ccsLength <= 0) {
783 bad_option(rts_argv[arg]);
786 case 'h': /* serial heap profile */
787 #if !defined(PROFILING)
788 switch (rts_argv[arg][2]) {
791 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
794 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
798 PROFILING_BUILD_ONLY(
799 switch (rts_argv[arg][2]) {
813 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
815 char *left = strchr(rts_argv[arg], '{');
816 char *right = strrchr(rts_argv[arg], '}');
818 // curly braces are optional, for
823 left = rts_argv[arg] + 3;
826 right = rts_argv[arg] + strlen(rts_argv[arg]);
830 switch (rts_argv[arg][2]) {
831 case 'c': // cost centre label select
832 RtsFlags.ProfFlags.ccSelector = left;
835 RtsFlags.ProfFlags.ccsSelector = left;
838 case 'm': // cost centre module select
839 RtsFlags.ProfFlags.modSelector = left;
842 case 'd': // closure descr select
843 RtsFlags.ProfFlags.descrSelector = left;
846 case 'y': // closure type select
847 RtsFlags.ProfFlags.typeSelector = left;
850 case 'r': // retainer select
851 RtsFlags.ProfFlags.retainerSelector = left;
854 case 'b': // biography select
855 RtsFlags.ProfFlags.bioSelector = left;
862 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
863 errorBelch("multiple heap profile options");
868 switch (rts_argv[arg][2]) {
872 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
876 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
880 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
884 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
888 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
892 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
898 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
902 #endif /* PROFILING */
905 case 'i': /* heap sample interval */
906 if (rts_argv[arg][2] == '\0') {
911 /* Convert to milliseconds */
912 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
913 RtsFlags.ProfFlags.profileInterval = cst;
917 /* =========== CONCURRENT ========================= */
918 case 'C': /* context switch interval */
919 if (rts_argv[arg][2] == '\0')
920 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
924 /* Convert to milliseconds */
925 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
926 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
930 case 'V': /* master tick interval */
931 if (rts_argv[arg][2] == '\0') {
932 // turns off ticks completely
933 RtsFlags.MiscFlags.tickInterval = 0;
937 /* Convert to milliseconds */
938 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
939 RtsFlags.MiscFlags.tickInterval = cst;
946 if (rts_argv[arg][2] == '\0') {
947 #if defined(PROFILING)
948 RtsFlags.ParFlags.nNodes = 1;
950 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
953 RtsFlags.ParFlags.nNodes
954 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
955 if (RtsFlags.ParFlags.nNodes <= 0) {
956 errorBelch("bad value for -N");
959 #if defined(PROFILING)
960 if (RtsFlags.ParFlags.nNodes > 1) {
961 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
970 switch (rts_argv[arg][2]) {
972 // backwards compat only
973 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
976 errorBelch("unknown RTS option: %s",rts_argv[arg]);
984 switch (rts_argv[arg][2]) {
986 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
990 if (rts_argv[arg][3] == '\0') {
991 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
993 RtsFlags.ParFlags.parGcEnabled = rtsTrue;
994 RtsFlags.ParFlags.parGcGen
995 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
999 if (rts_argv[arg][3] == '\0') {
1000 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1003 RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1004 RtsFlags.ParFlags.parGcLoadBalancingGen
1005 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1009 RtsFlags.ParFlags.setAffinity = rtsTrue;
1012 RtsFlags.ParFlags.migrate = rtsFalse;
1015 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1018 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1024 /* =========== PARALLEL =========================== */
1026 THREADED_BUILD_ONLY(
1027 if (rts_argv[arg][2] != '\0') {
1028 RtsFlags.ParFlags.maxLocalSparks
1029 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1030 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1031 errorBelch("bad value for -e");
1037 /* =========== TICKY ============================== */
1039 case 'r': /* Basic profiling stats */
1042 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1046 r = open_stats_file(arg, *argc, argv,
1047 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1048 &RtsFlags.TickyFlags.tickyFile);
1049 if (r == -1) { error = rtsTrue; }
1053 /* =========== TRACING ---------=================== */
1057 RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1058 read_trace_flags(&rts_argv[arg][2]);
1064 RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1065 read_trace_flags(&rts_argv[arg][2]);
1069 /* =========== EXTENDED OPTIONS =================== */
1071 case 'x': /* Extend the argument space */
1072 switch(rts_argv[arg][2]) {
1074 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1078 case 'b': /* heapBase in hex; undocumented */
1079 if (rts_argv[arg][3] != '\0') {
1080 RtsFlags.GcFlags.heapBase
1081 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1083 errorBelch("-xb: requires argument");
1088 #if defined(x86_64_HOST_ARCH)
1089 case 'm': /* linkerMemBase */
1090 if (rts_argv[arg][3] != '\0') {
1091 RtsFlags.MiscFlags.linkerMemBase
1092 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1093 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1094 errorBelch("-xm: value must be <80000000");
1098 RtsFlags.MiscFlags.linkerMemBase = 0;
1103 case 'c': /* Debugging tool: show current cost centre on an exception */
1104 PROFILING_BUILD_ONLY(
1105 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1109 case 't': /* Include memory used by TSOs in a heap profile */
1110 PROFILING_BUILD_ONLY(
1111 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1115 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1118 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1122 break; /* defensive programming */
1124 /* =========== OH DEAR ============================ */
1126 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1133 if (RtsFlags.MiscFlags.tickInterval < 0) {
1134 RtsFlags.MiscFlags.tickInterval = 50;
1137 // If the master timer is disabled, turn off the other timers.
1138 if (RtsFlags.MiscFlags.tickInterval == 0) {
1139 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1140 RtsFlags.GcFlags.idleGCDelayTime = 0;
1141 RtsFlags.ProfFlags.profileInterval = 0;
1144 // Determine what tick interval we should use for the RTS timer
1145 // by taking the shortest of the various intervals that we need to
1147 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1148 RtsFlags.MiscFlags.tickInterval =
1149 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1150 RtsFlags.MiscFlags.tickInterval);
1153 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1154 RtsFlags.MiscFlags.tickInterval =
1155 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1156 RtsFlags.MiscFlags.tickInterval);
1159 if (RtsFlags.ProfFlags.profileInterval > 0) {
1160 RtsFlags.MiscFlags.tickInterval =
1161 stg_min(RtsFlags.ProfFlags.profileInterval,
1162 RtsFlags.MiscFlags.tickInterval);
1165 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1166 RtsFlags.ConcFlags.ctxtSwitchTicks =
1167 RtsFlags.ConcFlags.ctxtSwitchTime /
1168 RtsFlags.MiscFlags.tickInterval;
1170 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1173 if (RtsFlags.ProfFlags.profileInterval > 0) {
1174 RtsFlags.ProfFlags.profileIntervalTicks =
1175 RtsFlags.ProfFlags.profileInterval /
1176 RtsFlags.MiscFlags.tickInterval;
1178 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1185 for (p = usage_text; *p; p++)
1186 errorBelch("%s", *p);
1187 stg_exit(EXIT_FAILURE);
1193 stats_fprintf(FILE *f, char *s, ...)
1205 static int /* return -1 on error */
1208 int argc, char *argv[],
1209 int rts_argc, char *rts_argv[],
1210 const char *FILENAME_FMT,
1215 if (strequal(rts_argv[arg]+2, "stderr")
1216 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1217 f = NULL; /* NULL means use debugBelch */
1219 if (rts_argv[arg][2] != '\0') { /* stats file specified */
1220 f = fopen(rts_argv[arg]+2,"w");
1222 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1223 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1224 f = fopen(stats_filename,"w");
1227 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1234 /* Write argv and rtsv into start of stats file */
1236 for(count = 0; count < argc; count++) {
1237 stats_fprintf(f, "%s ", argv[count]);
1239 stats_fprintf(f, "+RTS ");
1240 for(count = 0; count < rts_argc; count++)
1241 stats_fprintf(f, "%s ", rts_argv[count]);
1242 stats_fprintf(f, "\n");
1250 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1268 if (c == 'g' || c == 'G')
1269 m *= 1024*1024*1024;
1270 else if (c == 'm' || c == 'M')
1272 else if (c == 'k' || c == 'K')
1274 else if (c == 'w' || c == 'W')
1280 if (m < 0 || val < min || val > max) {
1281 // printf doesn't like 64-bit format specs on Windows
1282 // apparently, so fall back to unsigned long.
1283 errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1284 stg_exit(EXIT_FAILURE);
1290 #if defined(TRACING)
1291 static void read_trace_flags(char *arg)
1295 for (c = arg; *c != '\0'; c++) {
1300 RtsFlags.TraceFlags.scheduler = rtsTrue;
1303 RtsFlags.TraceFlags.timestamp = rtsTrue;
1306 // ignored for backwards-compat
1309 errorBelch("unknown trace option: %c",*c);
1316 static void GNU_ATTRIBUTE(__noreturn__)
1317 bad_option(const char *s)
1319 errorBelch("bad RTS option: %s", s);
1320 stg_exit(EXIT_FAILURE);
1323 /* -----------------------------------------------------------------------------
1324 Getting/Setting the program's arguments.
1326 These are used by System.Environment, and parts of the RTS.
1327 -------------------------------------------------------------------------- */
1330 setProgName(char *argv[])
1332 /* Remove directory from argv[0] -- default files in current directory */
1333 #if !defined(mingw32_HOST_OS)
1335 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1336 prog_name = last_slash+1;
1338 prog_name = argv[0];
1341 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1342 while ( last_slash > argv[0] ) {
1343 if ( *last_slash == '/' || *last_slash == '\\' ) {
1344 prog_name = last_slash+1;
1349 prog_name = argv[0];
1354 getProgArgv(int *argc, char **argv[])
1356 if (argc) { *argc = prog_argc; }
1357 if (argv) { *argv = prog_argv; }
1361 setProgArgv(int argc, char *argv[])
1363 /* Usually this is done by startupHaskell, so we don't need to call this.
1364 However, sometimes Hugs wants to change the arguments which Haskell
1365 getArgs >>= ... will be fed. So you can do that by calling here
1366 _after_ calling startupHaskell.
1370 setProgName(prog_argv);
1373 /* These functions record and recall the full arguments, including the
1374 +RTS ... -RTS options. The reason for adding them was so that the
1375 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1377 getFullProgArgv(int *argc, char **argv[])
1379 if (argc) { *argc = full_prog_argc; }
1380 if (argv) { *argv = full_prog_argv; }
1384 setFullProgArgv(int argc, char *argv[])
1387 full_prog_argc = argc;
1388 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1389 "setFullProgArgv 1");
1390 for (i = 0; i < argc; i++) {
1391 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1392 "setFullProgArgv 2");
1393 strcpy(full_prog_argv[i], argv[i]);
1395 full_prog_argv[argc] = NULL;
1399 freeFullProgArgv (void)
1403 if (full_prog_argv != NULL) {
1404 for (i = 0; i < full_prog_argc; i++) {
1405 stgFree(full_prog_argv[i]);
1407 stgFree(full_prog_argv);
1411 full_prog_argv = NULL;