1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.21 1999/11/29 12:02:44 keithw Exp $
4 * (c) The AQUA Project, Glasgow University, 1994-1997
5 * (c) The GHC Team, 1998-1999
7 * Functions for parsing the argument list.
9 * ---------------------------------------------------------------------------*/
14 #include "BlockAlloc.h"
17 #if defined(PROFILING)
29 extern struct RTS_FLAGS RtsFlags;
32 * Split argument lists
34 int prog_argc; /* an "int" so as to match normal "argc" */
35 char **prog_argv = NULL;
36 int rts_argc; /* ditto */
37 char *rts_argv[MAX_RTS_ARGS];
40 * constants, used later
45 /* -----------------------------------------------------------------------------
47 -------------------------------------------------------------------------- */
49 static FILE * /* return NULL on error */
52 int argc, char *argv[],
53 int rts_argc, char *rts_argv[],
54 const char *FILENAME_FMT);
56 static I_ decode(const char *s);
57 static void bad_option(const char *s);
59 /* -----------------------------------------------------------------------------
60 * Command-line option parsing routines.
61 * ---------------------------------------------------------------------------*/
63 void initRtsFlagsDefaults(void)
65 RtsFlags.GcFlags.statsFile = NULL;
66 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
68 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
69 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
71 RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE;
72 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
73 RtsFlags.GcFlags.maxHeapSize = (64 * 1024 * 1024) / BLOCK_SIZE;
74 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
75 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
76 RtsFlags.GcFlags.oldGenFactor = 2;
77 RtsFlags.GcFlags.generations = 2;
78 RtsFlags.GcFlags.steps = 2;
80 RtsFlags.GcFlags.forceGC = rtsFalse;
81 RtsFlags.GcFlags.forcingInterval = 5000000; /* 5MB (or words?) */
82 RtsFlags.GcFlags.ringBell = rtsFalse;
84 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
86 #if defined(PROFILING) || defined(PAR)
87 RtsFlags.CcFlags.doCostCentres = 0;
88 RtsFlags.CcFlags.sortBy = SORTCC_TIME;
89 #endif /* PROFILING or PAR */
92 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
93 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
95 RtsFlags.ProfFlags.ccSelector = NULL;
96 RtsFlags.ProfFlags.modSelector = NULL;
97 RtsFlags.ProfFlags.grpSelector = NULL;
98 RtsFlags.ProfFlags.descrSelector = NULL;
99 RtsFlags.ProfFlags.typeSelector = NULL;
100 RtsFlags.ProfFlags.kindSelector = NULL;
102 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
105 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
107 RtsFlags.ConcFlags.nNodes = 1;
110 RtsFlags.ParFlags.parallelStats = rtsFalse;
111 RtsFlags.ParFlags.granSimStats = rtsFalse;
112 RtsFlags.ParFlags.granSimStats_Binary = rtsFalse;
114 RtsFlags.ParFlags.outputDisabled = rtsFalse;
116 RtsFlags.ParFlags.packBufferSize = 1024;
117 RtsFlags.ParFlags.maxLocalSparks = 4096;
121 RtsFlags.GranFlags.granSimStats = rtsFalse;
122 RtsFlags.GranFlags.granSimStats_suppressed = rtsFalse;
123 RtsFlags.GranFlags.granSimStats_Binary = rtsFalse;
124 RtsFlags.GranFlags.granSimStats_Sparks = rtsFalse;
125 RtsFlags.GranFlags.granSimStats_Heap = rtsFalse;
126 RtsFlags.GranFlags.labelling = rtsFalse;
127 RtsFlags.GranFlags.packBufferSize = 1024;
128 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
130 RtsFlags.GranFlags.proc = MAX_PROC;
131 RtsFlags.GranFlags.max_fishes = MAX_FISHES;
132 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
133 RtsFlags.GranFlags.Light = rtsFalse;
135 RtsFlags.GranFlags.gran_latency = LATENCY;
136 RtsFlags.GranFlags.gran_additional_latency = ADDITIONAL_LATENCY;
137 RtsFlags.GranFlags.gran_fetchtime = FETCHTIME;
138 RtsFlags.GranFlags.gran_lunblocktime = LOCALUNBLOCKTIME;
139 RtsFlags.GranFlags.gran_gunblocktime = GLOBALUNBLOCKTIME;
140 RtsFlags.GranFlags.gran_mpacktime = MSGPACKTIME;
141 RtsFlags.GranFlags.gran_munpacktime = MSGUNPACKTIME;
142 RtsFlags.GranFlags.gran_mtidytime = MSGTIDYTIME;
144 RtsFlags.GranFlags.gran_threadcreatetime = THREADCREATETIME;
145 RtsFlags.GranFlags.gran_threadqueuetime = THREADQUEUETIME;
146 RtsFlags.GranFlags.gran_threaddescheduletime = THREADDESCHEDULETIME;
147 RtsFlags.GranFlags.gran_threadscheduletime = THREADSCHEDULETIME;
148 RtsFlags.GranFlags.gran_threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
150 RtsFlags.GranFlags.gran_arith_cost = ARITH_COST;
151 RtsFlags.GranFlags.gran_branch_cost = BRANCH_COST;
152 RtsFlags.GranFlags.gran_load_cost = LOAD_COST;
153 RtsFlags.GranFlags.gran_store_cost = STORE_COST;
154 RtsFlags.GranFlags.gran_float_cost = FLOAT_COST;
156 RtsFlags.GranFlags.gran_heapalloc_cost = HEAPALLOC_COST;
158 RtsFlags.GranFlags.gran_pri_spark_overhead = PRI_SPARK_OVERHEAD;
159 RtsFlags.GranFlags.gran_pri_sched_overhead = PRI_SCHED_OVERHEAD;
161 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
162 RtsFlags.GranFlags.DoReScheduleOnFetch = rtsFalse;
163 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
164 RtsFlags.GranFlags.SimplifiedFetch = rtsFalse;
165 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
166 RtsFlags.GranFlags.DoGUMMFetching = rtsFalse;
167 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
168 RtsFlags.GranFlags.FetchStrategy = 2;
169 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
170 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
171 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
172 RtsFlags.GranFlags.SparkPriority = 0;
173 RtsFlags.GranFlags.SparkPriority2 = 0;
174 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
175 RtsFlags.GranFlags.InversePriorities = rtsFalse;
176 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
177 RtsFlags.GranFlags.ThunksToPack = 0;
178 RtsFlags.GranFlags.RandomSteal = rtsTrue;
179 RtsFlags.GranFlags.NoForward = rtsFalse;
180 RtsFlags.GranFlags.PrintFetchMisses = rtsFalse;
182 RtsFlags.GranFlags.debug = 0x0;
183 RtsFlags.GranFlags.event_trace = rtsFalse;
184 RtsFlags.GranFlags.event_trace_all = rtsFalse;
188 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
189 RtsFlags.TickyFlags.tickyFile = NULL;
196 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
198 " +RTS Indicates run time system options follow",
199 " -RTS Indicates program arguments follow",
200 " --RTS Indicates that ALL subsequent arguments will be given to the",
201 " program (including any of these RTS flags)",
203 "The following run time system options are available:",
205 " -? -f Prints this message and exits; the program is not executed",
207 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
208 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
210 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
211 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
212 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
213 " -m<n>% Minimum % of heap which must be available (default 3%)",
214 " -G<n> Number of generations (default: 2)",
215 " -T<n> Number of steps in younger generations (default: 2)",
216 " -s<file> Summary GC statistics (default file: <program>.stat)",
217 " -S<file> Detailed GC statistics (with -Sstderr going to stderr)",
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) || defined(PAR)
224 " -p<sort> Produce cost centre time profile (output file <program>.prof)",
225 " sort: T = time (default), A = alloc, C = cost centre label",
226 " -P<sort> Produce serial time profile (output file <program>.time)",
227 " and a -p profile with detailed tick/alloc info",
228 # if defined(PROFILING)
230 " -h<break-down> Heap residency profile (output file <program>.hp)",
231 " break-down: C = cost centre stack (default), M = module, G = group",
232 " D = closure description, Y = type description",
233 " T<ints>,<start> = time closure created",
234 " ints: no. of interval bands plotted (default 18)",
235 " start: seconds after which intervals start (default 0.0)",
236 " A subset of closures may be selected by the attached cost centre using:",
237 " -c{mod:lab,mod:lab...}, specific module:label cost centre(s)",
238 " -m{mod,mod...} all cost centres from the specified modules(s)",
239 " -g{grp,grp...} all cost centres from the specified group(s)",
240 " Selections can also be made by description, type, kind and age:",
241 " -d{des,des...} closures with specified closure descriptions",
242 " -y{typ,typ...} closures with specified type descriptions",
243 " -k{knd,knd...} closures of the specified kinds",
244 " -a<age> closures which survived <age> complete intervals",
245 " The selection logic used is summarised as follows:",
246 " ([-c] or [-m] or [-g]) and ([-d] or [-y] or [-k]) and [-a]",
247 " where an option is true if not specified",
249 " -xc Show current cost centre stack on raising an exception",
252 " -z<tbl><size> set hash table <size> for <tbl> (C, M, G, D or Y)",
254 " -i<secs> Number of seconds in a profiling interval (default 1.0):",
255 " heap profile (-h) and/or serial time profile (-P) frequency",
256 #endif /* PROFILING or PAR */
257 #if !defined(PROFILING) && defined(DEBUG)
259 " -h<break-down> Debugging Heap residency profile",
260 " (output file <program>.hp)",
261 " break-down: L = closure label (default)",
262 " T = closure type (constructor, thunk etc.)",
265 #if defined(TICKY_TICKY)
266 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
270 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
271 /* NB: the -N<n> is implemented by the driver!! */
273 " -C<secs> Context-switch interval in seconds",
274 " (0 or no argument means switch as often as possible)",
275 " the default is .01 sec; resolution is .01 sec",
277 " -N<n> Use <n> OS threads (default: 1)",
280 " -q Enable activity profile (output files in ~/<program>*.gr)",
281 " -qb Enable binary activity profile (output file /tmp/<program>.gb)",
282 " -Q<size> Set pack-buffer size (default: 1024)",
285 " -d Turn on PVM-ish debugging",
286 " -O Disable output for performance measurement",
288 # ifdef GRAN /* ToDo: fill in decent Docu here */
289 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
292 "Other RTS options may be available for programs compiled a different way.",
293 "The GHC User's Guide has full details.",
298 static __inline__ rtsBool
299 strequal(const char *a, const char * b)
301 return(strcmp(a, b) == 0);
305 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
307 rtsBool error = rtsFalse;
312 /* Remove directory from argv[0] -- default files in current directory */
314 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
315 strcpy(argv[0], last_slash+1);
317 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
318 /* argv[0] must be PGM argument -- leave in argv */
326 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
327 if (strequal("+RTS", argv[arg])) {
330 else if (strequal("-RTS", argv[arg])) {
333 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
334 rts_argv[(*rts_argc)++] = argv[arg];
336 else if (mode == PGM) {
337 argv[(*argc)++] = argv[arg];
340 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
343 if (arg < total_arg) {
344 /* arg must be --RTS; process remaining program arguments */
345 while (++arg < total_arg) {
346 argv[(*argc)++] = argv[arg];
349 argv[*argc] = (char *) 0;
350 rts_argv[*rts_argc] = (char *) 0;
352 /* Process RTS (rts_argv) part: mainly to determine statsfile */
354 for (arg = 0; arg < *rts_argc; arg++) {
355 if (rts_argv[arg][0] != '-') {
357 fprintf(stderr, "setupRtsFlags: Unexpected RTS argument: %s\n",
362 switch(rts_argv[arg][1]) {
364 /* process: general args, then PROFILING-only ones,
365 then CONCURRENT-only, PARallel-only, GRAN-only,
366 TICKY-only (same order as defined in RtsFlags.lh);
367 within those groups, mostly in case-insensitive
369 Final group is x*, which allows for more options.
373 # define TICKY_BUILD_ONLY(x) x
375 # define TICKY_BUILD_ONLY(x) \
376 fprintf(stderr, "setupRtsFlags: GHC not built for: ticky-ticky stats\n"); \
380 #if defined(PROFILING)
381 # define COST_CENTRE_USING_BUILD_ONLY(x) x
383 # define COST_CENTRE_USING_BUILD_ONLY(x) \
384 fprintf(stderr, "setupRtsFlags: GHC not built for: -prof or -parallel\n"); \
389 # define PROFILING_BUILD_ONLY(x) x
391 # define PROFILING_BUILD_ONLY(x) \
392 fprintf(stderr, "setupRtsFlags: GHC not built for: -prof\n"); \
397 # define PAR_BUILD_ONLY(x) x
399 # define PAR_BUILD_ONLY(x) \
400 fprintf(stderr, "setupRtsFlags: GHC not built for: -parallel\n"); \
405 # define GRAN_BUILD_ONLY(x) x
407 # define GRAN_BUILD_ONLY(x) \
408 fprintf(stderr, "setupRtsFlags: GHC not built for: -gransim\n"); \
412 /* =========== GENERAL ========================== */
419 RtsFlags.GcFlags.minAllocAreaSize
420 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
421 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
422 bad_option(rts_argv[arg]);
427 RtsFlags.GcFlags.ringBell = rtsTrue;
431 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
433 if (RtsFlags.GcFlags.oldGenFactor < 0)
434 bad_option( rts_argv[arg] );
439 /* hack warning: interpret the flags as a binary number */
441 I_ n = decode(rts_argv[arg]+2);
442 if (n &1) RtsFlags.DebugFlags.scheduler = rtsTrue;
443 if ((n>>1)&1) RtsFlags.DebugFlags.evaluator = rtsTrue;
444 if ((n>>2)&1) RtsFlags.DebugFlags.codegen = rtsTrue;
445 if ((n>>3)&1) RtsFlags.DebugFlags.weak = rtsTrue;
446 if ((n>>4)&1) RtsFlags.DebugFlags.gccafs = rtsTrue;
447 if ((n>>5)&1) RtsFlags.DebugFlags.gc = rtsTrue;
448 if ((n>>6)&1) RtsFlags.DebugFlags.block_alloc = rtsTrue;
449 if ((n>>7)&1) RtsFlags.DebugFlags.sanity = rtsTrue;
450 if ((n>>8)&1) RtsFlags.DebugFlags.stable = rtsTrue;
451 if ((n>>9)&1) RtsFlags.DebugFlags.prof = rtsTrue;
457 RtsFlags.GcFlags.maxStkSize =
458 decode(rts_argv[arg]+2) / sizeof(W_);
460 if (RtsFlags.GcFlags.maxStkSize == 0)
461 bad_option( rts_argv[arg] );
465 RtsFlags.GcFlags.initialStkSize =
466 decode(rts_argv[arg]+2) / sizeof(W_);
468 if (RtsFlags.GcFlags.initialStkSize == 0)
469 bad_option( rts_argv[arg] );
473 RtsFlags.GcFlags.maxHeapSize =
474 decode(rts_argv[arg]+2) / BLOCK_SIZE;
475 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
477 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
478 bad_option(rts_argv[arg]);
483 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
485 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
486 RtsFlags.GcFlags.pcFreeHeap > 100)
487 bad_option( rts_argv[arg] );
491 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
492 if (RtsFlags.GcFlags.generations < 1) {
493 bad_option(rts_argv[arg]);
498 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
499 if (RtsFlags.GcFlags.steps < 1) {
500 bad_option(rts_argv[arg]);
505 RtsFlags.GcFlags.heapSizeSuggestion =
506 decode(rts_argv[arg]+2) / BLOCK_SIZE;
508 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
509 bad_option(rts_argv[arg]);
513 case 'j': /* force GC option */
514 RtsFlags.GcFlags.forceGC = rtsTrue;
515 if (rts_argv[arg][2]) {
516 RtsFlags.GcFlags.forcingInterval
517 = decode(rts_argv[arg]+2) / sizeof(W_);
522 RtsFlags.GcFlags.giveStats ++;
525 RtsFlags.GcFlags.giveStats ++;
527 /* Opening all those files would almost certainly fail... */
528 RtsFlags.ParFlags.parallelStats = rtsTrue;
529 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
531 RtsFlags.GcFlags.statsFile
532 = open_stats_file(arg, *argc, argv,
533 *rts_argc, rts_argv, STAT_FILENAME_FMT);
535 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
540 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
543 /* =========== PROFILING ========================== */
545 case 'P': /* detailed cost centre profiling (time/alloc) */
546 COST_CENTRE_USING_BUILD_ONLY(
547 RtsFlags.CcFlags.doCostCentres++;
549 case 'p': /* cost centre profiling (time/alloc) */
550 COST_CENTRE_USING_BUILD_ONLY(
551 RtsFlags.CcFlags.doCostCentres++;
553 switch (rts_argv[arg][2]) {
557 RtsFlags.CcFlags.sortBy = rts_argv[arg][2];
560 RtsFlags.CcFlags.sortBy = SORTCC_TIME;
565 case 'i': /* serial profiling -- initial timer interval */
566 COST_CENTRE_USING_BUILD_ONLY(
567 interval_ticks = (I_) ((atof(rts_argv[arg]+2) * TICK_FREQUENCY));
568 if (interval_ticks <= 0)
572 case 'h': /* serial heap profile */
573 #if !defined(PROFILING) && defined(DEBUG)
574 switch (rts_argv[arg][2]) {
577 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
580 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
583 fprintf(stderr, "Invalid heap profile option: %s\n",
588 PROFILING_BUILD_ONLY(
589 switch (rts_argv[arg][2]) {
592 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
595 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
598 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_GRP;
601 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
604 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
607 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TIME;
608 if (rts_argv[arg][3]) {
609 char *start_str = strchr(rts_argv[arg]+3, ',');
611 if (start_str) *start_str = '\0';
613 if ((intervals = decode(rts_argv[arg]+3)) != 0) {
614 time_intervals = (hash_t) intervals;
615 /* ToDo: and what if it *is* zero intervals??? */
618 earlier_ticks = (I_)((atof(start_str + 1) * TICK_FREQUENCY));
623 fprintf(stderr, "Invalid heap profile option: %s\n",
631 case 'z': /* size of index tables */
632 PROFILING_BUILD_ONLY(
633 switch (rts_argv[arg][2]) {
635 max_cc_no = (hash_t) decode(rts_argv[arg]+3);
636 if (max_cc_no == 0) {
637 fprintf(stderr, "Bad number of cost centres %s\n", rts_argv[arg]);
642 max_mod_no = (hash_t) decode(rts_argv[arg]+3);
643 if (max_mod_no == 0) {
644 fprintf(stderr, "Bad number of modules %s\n", rts_argv[arg]);
649 max_grp_no = (hash_t) decode(rts_argv[arg]+3);
650 if (max_grp_no == 0) {
651 fprintf(stderr, "Bad number of groups %s\n", rts_argv[arg]);
656 max_descr_no = (hash_t) decode(rts_argv[arg]+3);
657 if (max_descr_no == 0) {
658 fprintf(stderr, "Bad number of closure descriptions %s\n", rts_argv[arg]);
663 max_type_no = (hash_t) decode(rts_argv[arg]+3);
664 if (max_type_no == 0) {
665 fprintf(stderr, "Bad number of type descriptions %s\n", rts_argv[arg]);
670 fprintf(stderr, "Invalid index table size option: %s\n",
676 case 'c': /* cost centre label select */
677 case 'g': /* cost centre group select */
678 case 'd': /* closure descr select */
679 case 'y': /* closure type select */
680 PROFILING_BUILD_ONLY(
681 {char *left = strchr(rts_argv[arg], '{');
682 char *right = strrchr(rts_argv[arg], '}');
684 if (! left || ! right ||
685 strrchr(rts_argv[arg], '{') != left ||
686 strchr(rts_argv[arg], '}') != right) {
687 fprintf(stderr, "Invalid heap profiling selection bracketing\n %s\n", rts_argv[arg]);
691 switch (rts_argv[arg][1]) {
692 case 'c': /* cost centre label select */
693 RtsFlags.ProfFlags.ccSelector = left + 1;
695 case 'm': /* cost centre module select */
696 RtsFlags.ProfFlags.modSelector = left + 1;
698 case 'g': /* cost centre group select */
699 RtsFlags.ProfFlags.grpSelector = left + 1;
701 case 'd': /* closure descr select */
702 RtsFlags.ProfFlags.descrSelector = left + 1;
704 case 'y': /* closure type select */
705 RtsFlags.ProfFlags.typeSelector = left + 1;
707 case 'k': /* closure kind select */
708 RtsFlags.ProfFlags.kindSelector = left + 1;
714 /* =========== CONCURRENT ========================= */
715 case 'C': /* context switch interval */
716 if (rts_argv[arg][2] == '\0')
717 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
721 /* Convert to milliseconds */
722 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
723 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
724 if (cst < CS_MIN_MILLISECS)
725 cst = CS_MIN_MILLISECS;
727 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
733 if (rts_argv[arg][2] != '\0') {
734 RtsFlags.ConcFlags.nNodes
735 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
736 if (RtsFlags.ConcFlags.nNodes <= 0) {
737 fprintf(stderr, "setupRtsFlags: bad value for -N\n");
743 /* =========== PARALLEL =========================== */
746 if (rts_argv[arg][2] != '\0') { /* otherwise, stick w/ the default */
748 RtsFlags.ParFlags.maxLocalSparks
749 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
751 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
752 fprintf(stderr, "setupRtsFlags: bad value for -e\n");
760 RtsFlags.ParFlags.outputDisabled = rtsTrue;
763 case 'q': /* activity profile option */
765 if (rts_argv[arg][2] == 'b')
766 RtsFlags.ParFlags.granSimStats_Binary = rtsTrue;
768 RtsFlags.ParFlags.granSimStats = rtsTrue;
772 case 'q': /* quasi-parallel profile option */
774 if (rts_argv[arg][2] == 'v')
781 case 'Q': /* Set pack buffer size */
783 if (rts_argv[arg][2] != '\0') {
784 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+2);
786 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
791 /* =========== GRAN =============================== */
795 process_gran_option(arg, rts_argc, rts_argv, &error);
798 /* =========== TICKY ============================== */
800 case 'r': /* Basic profiling stats */
803 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
804 RtsFlags.TickyFlags.tickyFile
805 = open_stats_file(arg, *argc, argv,
806 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
808 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
811 /* =========== EXTENDED OPTIONS =================== */
813 case 'x': /* Extend the argument space */
814 switch(rts_argv[arg][2]) {
816 fprintf(stderr, "setupRtsFlags: Incomplete RTS option: %s\n",rts_argv[arg]);
820 case 'c': /* Debugging tool: show current cost centre on an exception */
821 PROFILING_BUILD_ONLY(
822 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
825 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
828 fprintf(stderr, "setupRtsFlags: Unknown RTS option: %s\n",rts_argv[arg]);
832 break; /* defensive programming */
834 /* =========== OH DEAR ============================ */
836 fprintf(stderr, "setupRtsFlags: Unknown RTS option: %s\n",rts_argv[arg]);
846 for (p = usage_text; *p; p++)
847 fprintf(stderr, "%s\n", *p);
848 stg_exit(EXIT_FAILURE);
853 static FILE * /* return NULL on error */
856 int argc, char *argv[],
857 int rts_argc, char *rts_argv[],
858 const char *FILENAME_FMT)
862 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
864 else if (rts_argv[arg][2] != '\0') /* stats file specified */
865 f = fopen(rts_argv[arg]+2,"w");
867 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
868 sprintf(stats_filename, FILENAME_FMT, argv[0]);
869 f = fopen(stats_filename,"w");
872 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
874 /* Write argv and rtsv into start of stats file */
876 for(count = 0; count < argc; count++)
877 fprintf(f, "%s ", argv[count]);
879 for(count = 0; count < rts_argc; count++)
880 fprintf(f, "%s ", rts_argv[count]);
888 decode(const char *s)
899 if (c == 'g' || c == 'G')
900 m *= 1000*1000*1000; /* UNchecked! */
901 else if (c == 'm' || c == 'M')
902 m *= 1000*1000; /* We do not use powers of 2 (1024) */
903 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
904 m *= 1000; /* a direct-mapped cache. */
905 else if (c == 'w' || c == 'W')
912 bad_option(const char *s)
915 fprintf(stderr, "initSM: Bad RTS option: %s\n", s);
916 stg_exit(EXIT_FAILURE);