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"
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
45 static char *gran_debug_opts_strs[] = {
46 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
47 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
48 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
49 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
50 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
51 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
52 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
53 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
54 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
55 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
56 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
57 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
58 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
59 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
60 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
63 /* one character codes for the available debug options */
64 static char gran_debug_opts_flags[] = {
65 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
70 static char *par_debug_opts_strs[] = {
71 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
72 "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
73 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
74 "DEBUG (-qDe, -qD8): free; free messages.\n",
75 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
76 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
77 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
78 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
79 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
80 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
81 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
82 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
83 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
84 "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
87 /* one character codes for the available debug options */
88 static char par_debug_opts_flags[] = {
89 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
94 /* -----------------------------------------------------------------------------
96 -------------------------------------------------------------------------- */
98 static int /* return NULL on error */
101 int argc, char *argv[],
102 int rts_argc, char *rts_argv[],
103 const char *FILENAME_FMT,
106 static I_ decode(const char *s);
107 static void bad_option(const char *s);
110 static void enable_GranSimLight(void);
111 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
112 static void set_GranSim_debug_options(nat n);
113 static void help_GranSim_debug_options(nat n);
115 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
116 static void set_par_debug_options(nat n);
117 static void help_par_debug_options(nat n);
120 /* -----------------------------------------------------------------------------
121 * Command-line option parsing routines.
122 * ---------------------------------------------------------------------------*/
124 void initRtsFlagsDefaults(void)
126 RtsFlags.GcFlags.statsFile = NULL;
127 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
129 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
130 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
132 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
133 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
134 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
135 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
136 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
137 RtsFlags.GcFlags.oldGenFactor = 2;
139 /* A hack currently needed for GUM -- HWL */
140 RtsFlags.GcFlags.generations = 1;
141 RtsFlags.GcFlags.steps = 2;
142 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
144 RtsFlags.GcFlags.generations = 2;
145 RtsFlags.GcFlags.steps = 2;
146 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
148 RtsFlags.GcFlags.compact = rtsFalse;
149 RtsFlags.GcFlags.compactThreshold = 30.0;
150 #ifdef RTS_GTK_FRONTPANEL
151 RtsFlags.GcFlags.frontpanel = rtsFalse;
153 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
156 /* ToDo: Perhaps by adjusting this value we can make linking without
157 * -static work (i.e., not generate a core-dumping executable)? */
158 # if SIZEOF_VOID_P == 8
159 RtsFlags.GcFlags.heapBase = 0x180000000L;
161 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
164 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
168 RtsFlags.DebugFlags.scheduler = rtsFalse;
169 RtsFlags.DebugFlags.interpreter = rtsFalse;
170 RtsFlags.DebugFlags.weak = rtsFalse;
171 RtsFlags.DebugFlags.gccafs = rtsFalse;
172 RtsFlags.DebugFlags.gc = rtsFalse;
173 RtsFlags.DebugFlags.block_alloc = rtsFalse;
174 RtsFlags.DebugFlags.sanity = rtsFalse;
175 RtsFlags.DebugFlags.stable = rtsFalse;
176 RtsFlags.DebugFlags.stm = rtsFalse;
177 RtsFlags.DebugFlags.prof = rtsFalse;
178 RtsFlags.DebugFlags.gran = rtsFalse;
179 RtsFlags.DebugFlags.par = rtsFalse;
180 RtsFlags.DebugFlags.linker = rtsFalse;
181 RtsFlags.DebugFlags.squeeze = rtsFalse;
182 RtsFlags.DebugFlags.hpc = rtsFalse;
185 #if defined(PROFILING) || defined(PAR)
186 RtsFlags.CcFlags.doCostCentres = 0;
187 #endif /* PROFILING or PAR */
189 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
190 RtsFlags.ProfFlags.profileInterval = 100;
193 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
194 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
195 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
196 RtsFlags.ProfFlags.ccsLength = 25;
197 RtsFlags.ProfFlags.modSelector = NULL;
198 RtsFlags.ProfFlags.descrSelector = NULL;
199 RtsFlags.ProfFlags.typeSelector = NULL;
200 RtsFlags.ProfFlags.ccSelector = NULL;
201 RtsFlags.ProfFlags.ccsSelector = NULL;
202 RtsFlags.ProfFlags.retainerSelector = NULL;
203 RtsFlags.ProfFlags.bioSelector = NULL;
206 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
207 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
209 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
212 RtsFlags.ParFlags.nNodes = 1;
213 RtsFlags.ParFlags.migrate = rtsTrue;
214 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
218 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
219 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
220 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
221 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
222 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
223 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
224 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
226 RtsFlags.ParFlags.outputDisabled = rtsFalse;
228 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
230 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
232 RtsFlags.ParFlags.packBufferSize = 1024;
233 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
234 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
235 RtsFlags.ParFlags.maxThreads = 1024;
236 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
237 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
240 #if defined(PAR) || defined(THREADED_RTS)
241 RtsFlags.ParFlags.maxLocalSparks = 4096;
242 #endif /* PAR || THREADED_RTS */
245 /* ToDo: check defaults for GranSim and GUM */
246 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
247 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
249 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
250 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
251 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
252 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
253 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
254 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
255 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
256 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
258 RtsFlags.GranFlags.packBufferSize = 1024;
259 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
261 RtsFlags.GranFlags.proc = MAX_PROC;
262 RtsFlags.GranFlags.Fishing = rtsFalse;
263 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
264 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
265 RtsFlags.GranFlags.Light = rtsFalse;
267 RtsFlags.GranFlags.Costs.latency = LATENCY;
268 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
269 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
270 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
271 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
272 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
273 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
274 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
276 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
277 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
278 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
279 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
280 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
282 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
283 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
284 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
285 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
286 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
288 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
290 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
291 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
293 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
294 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
295 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
296 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
297 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
298 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
299 RtsFlags.GranFlags.FetchStrategy = 2;
300 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
301 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
302 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
303 RtsFlags.GranFlags.SparkPriority = 0;
304 RtsFlags.GranFlags.SparkPriority2 = 0;
305 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
306 RtsFlags.GranFlags.InversePriorities = rtsFalse;
307 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
308 RtsFlags.GranFlags.ThunksToPack = 0;
309 RtsFlags.GranFlags.RandomSteal = rtsTrue;
313 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
314 RtsFlags.TickyFlags.tickyFile = NULL;
317 RtsFlags.TraceFlags.timestamp = rtsFalse;
318 RtsFlags.TraceFlags.sched = rtsFalse;
321 /* By default no special measurements taken */
322 RtsFlags.PapiFlags.eventType = 0;
329 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
331 " +RTS Indicates run time system options follow",
332 " -RTS Indicates program arguments follow",
333 " --RTS Indicates that ALL subsequent arguments will be given to the",
334 " program (including any of these RTS flags)",
336 "The following run time system options are available:",
338 " -? Prints this message and exits; the program is not executed",
339 " --info Print information about the RTS used by this program",
341 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
342 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
344 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
345 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
346 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
347 " -m<n> Minimum % of heap which must be available (default 3%)",
348 " -G<n> Number of generations (default: 2)",
349 " -T<n> Number of steps in younger generations (default: 2)",
350 " -c<n> Auto-enable compaction of the oldest generation when live data is",
351 " at least <n>% of the maximum heap size set with -M (default: 30%)",
352 " -c Enable compaction for all major collections",
353 #if defined(THREADED_RTS)
354 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
357 " -t<file> One-line GC statistics (default file: <program>.stat)",
358 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
359 " -S<file> Detailed GC statistics",
360 #ifdef RTS_GTK_FRONTPANEL
361 " -f Display front panel (requires X11 & GTK+)",
365 " -Z Don't squeeze out update frames on stack overflow",
366 " -B Sound the bell at the start of each garbage collection",
367 #if defined(PROFILING) || defined(PAR)
369 " -px Time/allocation profile (XML) (output file <program>.prof)",
370 " -p Time/allocation profile (output file <program>.prof)",
371 " -P More detailed Time/Allocation profile",
372 " -Pa Give information about *all* cost centres",
374 # if defined(PROFILING)
376 " -hx Heap residency profile (XML) (output file <program>.prof)",
377 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
378 " break-down: c = cost centre stack (default)",
380 " d = closure description",
381 " y = type description",
383 " b = biography (LAG,DRAG,VOID,USE)",
384 " A subset of closures may be selected thusly:",
385 " -hc<cc>,... specific cost centre(s) (top of stack only)",
386 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
387 " -hm<mod>... all cost centres from the specified modules(s)",
388 " -hd<des>,... closures with specified closure descriptions",
389 " -hy<typ>... closures with specified type descriptions",
390 " -hr<cc>... closures with specified retainers",
391 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
393 " -R<size> Set the maximum retainer set size (default: 8)",
395 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
398 " -xt Include threads (TSOs) in a heap profile",
400 " -xc Show current cost centre stack on raising an exception",
403 #endif /* PROFILING or PAR */
404 #if !defined(PROFILING)
406 " -hT Heap residency profile (output file <program>.hp)",
408 " -i<sec> Time between heap samples (seconds, default: 0.1)",
410 #if defined(TICKY_TICKY)
411 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
415 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
416 /* NB: the -N<n> is implemented by the driver!! */
418 " -C<secs> Context-switch interval in seconds.",
419 " 0 or no argument means switch as often as possible.",
420 " Default: 0.02 sec; resolution is set by -V below.",
421 " -V<secs> Master tick interval in seconds (0 == disable timer).",
422 " This sets the resolution for -C and the profile timer -i.",
423 " Default: 0.02 sec.",
425 " -vs Trace scheduler events (see also -Ds with -debug)",
426 " -vt Time-stamp trace messages",
429 " -Ds DEBUG: scheduler",
430 " -Di DEBUG: interpreter",
432 " -DG DEBUG: gccafs",
435 " -DS DEBUG: sanity",
436 " -Dt DEBUG: stable",
440 " -Dl DEBUG: linker",
442 " -Dz DEBUG: stack squezing",
443 " -Dc DEBUG: program coverage",
446 #if defined(THREADED_RTS) && !defined(NOSMP)
447 " -N<n> Use <n> OS threads (default: 1)",
448 " -qm Don't automatically migrate threads between CPUs",
449 " -qw Migrate a thread to the current CPU when it is woken up",
451 " --install-signal-handlers=<yes|no>",
452 " Install signal handlers (default: yes)",
453 #if defined(THREADED_RTS) || defined(PAR)
454 " -e<size> Size of spark pools (default 100)",
457 " -t<num> Set maximum number of advisory threads per PE (default 32)",
458 " -qP Enable activity profile (output files in ~/<program>*.gr)",
459 " -qQ<size> Set pack-buffer size (default: 1024)",
460 " -qd Turn on PVM-ish debugging",
461 " -qO Disable output for performance measurement",
463 #if defined(THREADED_RTS) || defined(PAR)
464 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
467 " -d Turn on PVM-ish debugging",
468 " -O Disable output for performance measurement",
470 #if defined(GRAN) /* ToDo: fill in decent Docu here */
471 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
473 #if defined(USE_PAPI)
474 " -aX CPU performance counter measurements using PAPI",
475 " (use with the -s<file> option). X is one of:",
478 " 1 - level 1 cache misses",
479 " 2 - level 2 cache misses",
480 " b - branch mispredictions",
481 " s - stalled cycles",
482 " e - cache miss and branch misprediction events",
485 "RTS options may also be specified using the GHCRTS environment variable.",
487 "Other RTS options may be available for programs compiled a different way.",
488 "The GHC User's Guide has full details.",
493 STATIC_INLINE rtsBool
494 strequal(const char *a, const char * b)
496 return(strcmp(a, b) == 0);
500 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
506 while (isspace(*c1)) { c1++; };
508 while (!isspace(*c2) && *c2 != '\0') { c2++; };
510 if (c1 == c2) { break; }
512 if (*rts_argc < MAX_RTS_ARGS-1) {
513 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
514 strncpy(s, c1, c2-c1);
516 rts_argv[(*rts_argc)++] = s;
518 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
522 } while (*c1 != '\0');
526 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
528 rtsBool error = rtsFalse;
539 // process arguments from the ghc_rts_opts global variable first.
540 // (arguments from the GHCRTS environment variable and the command
541 // line override these).
543 if (ghc_rts_opts != NULL) {
544 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
548 // process arguments from the GHCRTS environment variable next
549 // (arguments from the command line override these).
551 char *ghc_rts = getenv("GHCRTS");
553 if (ghc_rts != NULL) {
554 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
558 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
559 // argv[0] must be PGM argument -- leave in argv
561 for (mode = PGM; arg < total_arg; arg++) {
562 // The '--RTS' argument disables all future +RTS ... -RTS processing.
563 if (strequal("--RTS", argv[arg])) {
567 // The '--' argument is passed through to the program, but
568 // disables all further +RTS ... -RTS processing.
569 else if (strequal("--", argv[arg])) {
572 else if (strequal("+RTS", argv[arg])) {
575 else if (strequal("-RTS", argv[arg])) {
578 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
579 rts_argv[(*rts_argc)++] = argv[arg];
581 else if (mode == PGM) {
582 argv[(*argc)++] = argv[arg];
585 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
588 // process remaining program arguments
589 for (; arg < total_arg; arg++) {
590 argv[(*argc)++] = argv[arg];
592 argv[*argc] = (char *) 0;
593 rts_argv[*rts_argc] = (char *) 0;
595 // Process RTS (rts_argv) part: mainly to determine statsfile
596 for (arg = 0; arg < *rts_argc; arg++) {
597 if (rts_argv[arg][0] != '-') {
599 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
603 switch(rts_argv[arg][1]) {
605 /* process: general args, then PROFILING-only ones,
606 then CONCURRENT-only, PARallel-only, GRAN-only,
607 TICKY-only (same order as defined in RtsFlags.lh);
608 within those groups, mostly in case-insensitive
610 Final group is x*, which allows for more options.
614 # define TICKY_BUILD_ONLY(x) x
616 # define TICKY_BUILD_ONLY(x) \
617 errorBelch("not built for: ticky-ticky stats"); \
621 #if defined(PROFILING)
622 # define COST_CENTRE_USING_BUILD_ONLY(x) x
624 # define COST_CENTRE_USING_BUILD_ONLY(x) \
625 errorBelch("not built for: -prof or -parallel"); \
630 # define PROFILING_BUILD_ONLY(x) x
632 # define PROFILING_BUILD_ONLY(x) \
633 errorBelch("not built for: -prof"); \
638 # define PAR_BUILD_ONLY(x) x
640 # define PAR_BUILD_ONLY(x) \
641 errorBelch("not built for: -parallel"); \
646 # define THREADED_BUILD_ONLY(x) x
648 # define THREADED_BUILD_ONLY(x) \
649 errorBelch("not built for: -smp"); \
653 #if defined(THREADED_RTS) || defined(PAR)
654 # define PAR_OR_THREADED_BUILD_ONLY(x) x
656 # define PAR_OR_THREADED_BUILD_ONLY(x) \
657 errorBelch("not built for: -parallel or -smp"); \
662 # define GRAN_BUILD_ONLY(x) x
664 # define GRAN_BUILD_ONLY(x) \
665 errorBelch("not built for: -gransim"); \
669 /* =========== GENERAL ========================== */
674 /* This isn't going to allow us to keep related options
675 together as we add more --* flags. We really need a
676 proper options parser. */
678 if (strequal("install-signal-handlers=yes",
679 &rts_argv[arg][2])) {
680 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
682 else if (strequal("install-signal-handlers=no",
683 &rts_argv[arg][2])) {
684 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
686 else if (strequal("info",
687 &rts_argv[arg][2])) {
692 errorBelch("unknown RTS option: %s",rts_argv[arg]);
697 RtsFlags.GcFlags.minAllocAreaSize
698 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
699 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
700 bad_option(rts_argv[arg]);
706 switch(rts_argv[arg][2]) {
708 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
711 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
714 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
717 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
720 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
723 bad_option( rts_argv[arg] );
729 RtsFlags.GcFlags.ringBell = rtsTrue;
733 if (rts_argv[arg][2] != '\0') {
734 RtsFlags.GcFlags.compactThreshold =
735 atof(rts_argv[arg]+2);
737 RtsFlags.GcFlags.compact = rtsTrue;
742 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
744 if (RtsFlags.GcFlags.oldGenFactor < 0)
745 bad_option( rts_argv[arg] );
753 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
756 RtsFlags.DebugFlags.scheduler = rtsTrue;
759 RtsFlags.DebugFlags.interpreter = rtsTrue;
762 RtsFlags.DebugFlags.weak = rtsTrue;
765 RtsFlags.DebugFlags.gccafs = rtsTrue;
768 RtsFlags.DebugFlags.gc = rtsTrue;
771 RtsFlags.DebugFlags.block_alloc = rtsTrue;
774 RtsFlags.DebugFlags.sanity = rtsTrue;
777 RtsFlags.DebugFlags.stable = rtsTrue;
780 RtsFlags.DebugFlags.prof = rtsTrue;
783 RtsFlags.DebugFlags.gran = rtsTrue;
786 RtsFlags.DebugFlags.par = rtsTrue;
789 RtsFlags.DebugFlags.linker = rtsTrue;
792 RtsFlags.DebugFlags.apply = rtsTrue;
795 RtsFlags.DebugFlags.stm = rtsTrue;
798 RtsFlags.DebugFlags.squeeze = rtsTrue;
801 RtsFlags.DebugFlags.hpc = rtsTrue;
804 bad_option( rts_argv[arg] );
812 RtsFlags.GcFlags.maxStkSize =
813 decode(rts_argv[arg]+2) / sizeof(W_);
815 if (RtsFlags.GcFlags.maxStkSize == 0)
816 bad_option( rts_argv[arg] );
820 RtsFlags.GcFlags.initialStkSize =
821 decode(rts_argv[arg]+2) / sizeof(W_);
823 if (RtsFlags.GcFlags.initialStkSize == 0)
824 bad_option( rts_argv[arg] );
828 RtsFlags.GcFlags.maxHeapSize =
829 decode(rts_argv[arg]+2) / BLOCK_SIZE;
830 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
832 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
833 bad_option(rts_argv[arg]);
838 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
840 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
841 RtsFlags.GcFlags.pcFreeHeap > 100)
842 bad_option( rts_argv[arg] );
846 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
847 if (RtsFlags.GcFlags.generations < 1) {
848 bad_option(rts_argv[arg]);
853 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
854 if (RtsFlags.GcFlags.steps < 1) {
855 bad_option(rts_argv[arg]);
860 RtsFlags.GcFlags.heapSizeSuggestion =
861 decode(rts_argv[arg]+2) / BLOCK_SIZE;
863 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
864 bad_option(rts_argv[arg]);
868 #ifdef RTS_GTK_FRONTPANEL
870 RtsFlags.GcFlags.frontpanel = rtsTrue;
874 case 'I': /* idle GC delay */
875 if (rts_argv[arg][2] == '\0') {
880 /* Convert to millisecs */
881 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
882 RtsFlags.GcFlags.idleGCDelayTime = cst;
887 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
891 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
895 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
900 /* Opening all those files would almost certainly fail... */
901 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
902 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
906 r = open_stats_file(arg, *argc, argv,
907 *rts_argc, rts_argv, STAT_FILENAME_FMT,
908 &RtsFlags.GcFlags.statsFile);
909 if (r == -1) { error = rtsTrue; }
915 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
918 /* =========== PROFILING ========================== */
920 case 'P': /* detailed cost centre profiling (time/alloc) */
921 case 'p': /* cost centre profiling (time/alloc) */
922 COST_CENTRE_USING_BUILD_ONLY(
923 switch (rts_argv[arg][2]) {
925 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
928 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
931 if (rts_argv[arg][1] == 'P') {
932 RtsFlags.CcFlags.doCostCentres =
933 COST_CENTRES_VERBOSE;
935 RtsFlags.CcFlags.doCostCentres =
936 COST_CENTRES_SUMMARY;
943 PROFILING_BUILD_ONLY(
944 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
947 PROFILING_BUILD_ONLY(
948 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
949 if(RtsFlags.ProfFlags.ccsLength <= 0) {
950 bad_option(rts_argv[arg]);
953 case 'h': /* serial heap profile */
954 #if !defined(PROFILING)
955 switch (rts_argv[arg][2]) {
958 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
961 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
965 PROFILING_BUILD_ONLY(
966 switch (rts_argv[arg][2]) {
980 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
982 char *left = strchr(rts_argv[arg], '{');
983 char *right = strrchr(rts_argv[arg], '}');
985 // curly braces are optional, for
990 left = rts_argv[arg] + 3;
993 right = rts_argv[arg] + strlen(rts_argv[arg]);
997 switch (rts_argv[arg][2]) {
998 case 'c': // cost centre label select
999 RtsFlags.ProfFlags.ccSelector = left;
1002 RtsFlags.ProfFlags.ccsSelector = left;
1005 case 'm': // cost centre module select
1006 RtsFlags.ProfFlags.modSelector = left;
1009 case 'd': // closure descr select
1010 RtsFlags.ProfFlags.descrSelector = left;
1013 case 'y': // closure type select
1014 RtsFlags.ProfFlags.typeSelector = left;
1017 case 'r': // retainer select
1018 RtsFlags.ProfFlags.retainerSelector = left;
1021 case 'b': // biography select
1022 RtsFlags.ProfFlags.bioSelector = left;
1029 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1030 errorBelch("multiple heap profile options");
1035 switch (rts_argv[arg][2]) {
1039 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1043 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1047 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1051 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1055 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1059 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1065 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1069 #endif /* PROFILING */
1072 case 'i': /* heap sample interval */
1073 if (rts_argv[arg][2] == '\0') {
1078 /* Convert to milliseconds */
1079 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1080 RtsFlags.ProfFlags.profileInterval = cst;
1084 /* =========== CONCURRENT ========================= */
1085 case 'C': /* context switch interval */
1086 if (rts_argv[arg][2] == '\0')
1087 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1091 /* Convert to milliseconds */
1092 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1093 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1097 case 'V': /* master tick interval */
1098 if (rts_argv[arg][2] == '\0') {
1099 // turns off ticks completely
1100 RtsFlags.MiscFlags.tickInterval = 0;
1104 /* Convert to milliseconds */
1105 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1106 RtsFlags.MiscFlags.tickInterval = cst;
1110 #if defined(THREADED_RTS) && !defined(NOSMP)
1112 THREADED_BUILD_ONLY(
1113 if (rts_argv[arg][2] != '\0') {
1114 RtsFlags.ParFlags.nNodes
1115 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1116 if (RtsFlags.ParFlags.nNodes <= 0) {
1117 errorBelch("bad value for -N");
1120 #if defined(PROFILING)
1121 if (RtsFlags.ParFlags.nNodes > 1) {
1122 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1130 switch (rts_argv[arg][2]) {
1132 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1136 RtsFlags.ParFlags.migrate = rtsFalse;
1139 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1142 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1148 /* =========== PARALLEL =========================== */
1150 PAR_OR_THREADED_BUILD_ONLY(
1151 if (rts_argv[arg][2] != '\0') {
1152 RtsFlags.ParFlags.maxLocalSparks
1153 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1154 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1155 errorBelch("bad value for -e");
1164 process_par_option(arg, rts_argc, rts_argv, &error);
1168 /* =========== GRAN =============================== */
1172 process_gran_option(arg, rts_argc, rts_argv, &error);
1175 /* =========== TICKY ============================== */
1177 case 'r': /* Basic profiling stats */
1180 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1184 r = open_stats_file(arg, *argc, argv,
1185 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1186 &RtsFlags.TickyFlags.tickyFile);
1187 if (r == -1) { error = rtsTrue; }
1191 /* =========== TRACING ---------=================== */
1194 switch(rts_argv[arg][2]) {
1196 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1200 RtsFlags.TraceFlags.timestamp = rtsTrue;
1203 RtsFlags.TraceFlags.sched = rtsTrue;
1206 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1212 /* =========== EXTENDED OPTIONS =================== */
1214 case 'x': /* Extend the argument space */
1215 switch(rts_argv[arg][2]) {
1217 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1221 case 'b': /* heapBase in hex; undocumented */
1222 if (rts_argv[arg][3] != '\0') {
1223 RtsFlags.GcFlags.heapBase
1224 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1226 errorBelch("-xb: requires argument");
1231 case 'c': /* Debugging tool: show current cost centre on an exception */
1232 PROFILING_BUILD_ONLY(
1233 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1237 case 't': /* Include memory used by TSOs in a heap profile */
1238 PROFILING_BUILD_ONLY(
1239 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1243 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1246 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1250 break; /* defensive programming */
1252 /* =========== OH DEAR ============================ */
1254 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1261 if (RtsFlags.MiscFlags.tickInterval < 0) {
1262 RtsFlags.MiscFlags.tickInterval = 50;
1265 // If the master timer is disabled, turn off the other timers.
1266 if (RtsFlags.MiscFlags.tickInterval == 0) {
1267 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1268 RtsFlags.GcFlags.idleGCDelayTime = 0;
1269 RtsFlags.ProfFlags.profileInterval = 0;
1272 // Determine what tick interval we should use for the RTS timer
1273 // by taking the shortest of the various intervals that we need to
1275 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1276 RtsFlags.MiscFlags.tickInterval =
1277 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1278 RtsFlags.MiscFlags.tickInterval);
1281 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1282 RtsFlags.MiscFlags.tickInterval =
1283 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1284 RtsFlags.MiscFlags.tickInterval);
1287 if (RtsFlags.ProfFlags.profileInterval > 0) {
1288 RtsFlags.MiscFlags.tickInterval =
1289 stg_min(RtsFlags.ProfFlags.profileInterval,
1290 RtsFlags.MiscFlags.tickInterval);
1293 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1294 RtsFlags.ConcFlags.ctxtSwitchTicks =
1295 RtsFlags.ConcFlags.ctxtSwitchTime /
1296 RtsFlags.MiscFlags.tickInterval;
1298 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1301 if (RtsFlags.ProfFlags.profileInterval > 0) {
1302 RtsFlags.ProfFlags.profileIntervalTicks =
1303 RtsFlags.ProfFlags.profileInterval /
1304 RtsFlags.MiscFlags.tickInterval;
1306 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1313 for (p = usage_text; *p; p++)
1314 errorBelch("%s", *p);
1315 stg_exit(EXIT_FAILURE);
1322 enable_GranSimLight(void) {
1324 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1325 RtsFlags.GranFlags.Light=rtsTrue;
1326 RtsFlags.GranFlags.Costs.latency =
1327 RtsFlags.GranFlags.Costs.fetchtime =
1328 RtsFlags.GranFlags.Costs.additional_latency =
1329 RtsFlags.GranFlags.Costs.gunblocktime =
1330 RtsFlags.GranFlags.Costs.lunblocktime =
1331 RtsFlags.GranFlags.Costs.threadcreatetime =
1332 RtsFlags.GranFlags.Costs.threadqueuetime =
1333 RtsFlags.GranFlags.Costs.threadscheduletime =
1334 RtsFlags.GranFlags.Costs.threaddescheduletime =
1335 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1337 RtsFlags.GranFlags.Costs.mpacktime =
1338 RtsFlags.GranFlags.Costs.munpacktime = 0;
1340 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1341 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1342 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1343 /* FetchStrategy is irrelevant in GrAnSim-Light */
1345 /* GrAnSim Light often creates an abundance of parallel threads,
1346 each with its own stack etc. Therefore, it's in general a good
1347 idea to use small stack chunks (use the -o<size> option to
1350 // RtsFlags.ConcFlags.stkChunkSize = 100;
1352 RtsFlags.GranFlags.proc = 1;
1356 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1358 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1361 /* or a ridiculously idealised simulator */
1362 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1363 RtsFlags.GranFlags.Costs.latency =
1364 RtsFlags.GranFlags.Costs.fetchtime =
1365 RtsFlags.GranFlags.Costs.additional_latency =
1366 RtsFlags.GranFlags.Costs.gunblocktime =
1367 RtsFlags.GranFlags.Costs.lunblocktime =
1368 RtsFlags.GranFlags.Costs.threadcreatetime =
1369 RtsFlags.GranFlags.Costs.threadqueuetime =
1370 RtsFlags.GranFlags.Costs.threadscheduletime =
1371 RtsFlags.GranFlags.Costs.threaddescheduletime =
1372 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1374 RtsFlags.GranFlags.Costs.mpacktime =
1375 RtsFlags.GranFlags.Costs.munpacktime = 0;
1377 RtsFlags.GranFlags.Costs.arith_cost =
1378 RtsFlags.GranFlags.Costs.float_cost =
1379 RtsFlags.GranFlags.Costs.load_cost =
1380 RtsFlags.GranFlags.Costs.store_cost =
1381 RtsFlags.GranFlags.Costs.branch_cost = 0;
1383 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1385 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1386 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1387 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1388 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1392 /* or a somewhat idealised simulator */
1393 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1394 RtsFlags.GranFlags.Costs.latency =
1395 RtsFlags.GranFlags.Costs.fetchtime =
1396 RtsFlags.GranFlags.Costs.additional_latency =
1397 RtsFlags.GranFlags.Costs.gunblocktime =
1398 RtsFlags.GranFlags.Costs.lunblocktime =
1399 RtsFlags.GranFlags.Costs.threadcreatetime =
1400 RtsFlags.GranFlags.Costs.threadqueuetime =
1401 RtsFlags.GranFlags.Costs.threadscheduletime =
1402 RtsFlags.GranFlags.Costs.threaddescheduletime =
1403 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1405 RtsFlags.GranFlags.Costs.mpacktime =
1406 RtsFlags.GranFlags.Costs.munpacktime = 0;
1408 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1410 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1411 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1412 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1413 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1414 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1415 # if defined(GRAN_CHECK) && defined(GRAN)
1416 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1421 /* Communication and task creation cost parameters */
1422 switch(rts_argv[arg][2]) {
1424 IgnoreYields = rtsTrue; // HWL HACK
1428 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1432 if (rts_argv[arg][3] != '\0')
1434 RtsFlags.GranFlags.Costs.gunblocktime =
1435 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1436 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1439 RtsFlags.GranFlags.Costs.latency = LATENCY;
1443 if (rts_argv[arg][3] != '\0')
1444 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1446 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1450 if (rts_argv[arg][3] != '\0')
1451 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1453 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1457 if (rts_argv[arg][3] != '\0')
1458 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1460 RtsFlags.GranFlags.Costs.mtidytime = 0;
1464 if (rts_argv[arg][3] != '\0')
1465 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1467 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1471 if (rts_argv[arg][3] != '\0')
1472 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1474 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1478 if (rts_argv[arg][3] != '\0')
1479 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1481 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1485 if (rts_argv[arg][3] != '\0')
1486 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1488 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1491 /* Thread-related metrics */
1493 if (rts_argv[arg][3] != '\0')
1494 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1496 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1500 if (rts_argv[arg][3] != '\0')
1501 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1503 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1507 if (rts_argv[arg][3] != '\0')
1508 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1510 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1512 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1513 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1517 if (rts_argv[arg][3] != '\0')
1518 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1520 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1522 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1523 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1526 /* Instruction Cost Metrics */
1528 if (rts_argv[arg][3] != '\0')
1529 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1531 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1535 if (rts_argv[arg][3] != '\0')
1536 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1538 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1542 if (rts_argv[arg][3] != '\0')
1543 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1545 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1549 if (rts_argv[arg][3] != '\0')
1550 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1552 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1556 if (rts_argv[arg][3] != '\0')
1557 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1559 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1563 if (rts_argv[arg][3] != '\0')
1564 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1566 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1570 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1571 if (rts_argv[arg][3] != '\0')
1572 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1574 RtsFlags.GranFlags.FetchStrategy = 2;
1575 if (RtsFlags.GranFlags.FetchStrategy == 0)
1576 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1579 case 'K': /* sort overhead (per elem in spark list) */
1580 if (rts_argv[arg][3] != '\0')
1581 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1583 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1584 debugBelch("Overhead for pri spark: %d (per elem).\n",
1585 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1588 case 'O': /* sort overhead (per elem in spark list) */
1589 if (rts_argv[arg][3] != '\0')
1590 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1592 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1593 debugBelch("Overhead for pri sched: %d (per elem).\n",
1594 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1597 /* General Parameters */
1599 if (rts_argv[arg][3] != '\0')
1601 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1602 if (RtsFlags.GranFlags.proc==0) {
1603 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1604 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1605 RtsFlags.GranFlags.proc < 1)
1607 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1613 RtsFlags.GranFlags.proc = MAX_PROC;
1617 RtsFlags.GranFlags.Fishing = rtsTrue;
1618 if (rts_argv[arg][3] != '\0')
1619 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1621 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1625 if (rts_argv[arg][3] != '\0')
1626 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1628 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1632 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1633 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1637 debugBelch("Bulk fetching enabled.\n");
1638 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1642 debugBelch("Thread migration enabled.\n");
1643 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1647 debugBelch("Fair Scheduling enabled.\n");
1648 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1652 debugBelch("Priority Scheduling enabled.\n");
1653 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1657 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1658 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1662 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1666 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1670 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1674 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1678 /* format is -bP<c> where <c> is one char describing kind of profile */
1679 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1680 switch(rts_argv[arg][3]) {
1681 case '\0': break; // nothing special, just an ordinary profile
1682 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1684 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1686 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1688 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1690 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1692 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1694 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1699 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1703 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1706 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1707 if (rts_argv[arg][3] != '\0') {
1710 arg0 = rts_argv[arg]+3;
1711 if ((tmp = strstr(arg0,","))==NULL) {
1712 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1713 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1716 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1717 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1718 debugBelch("SparkPriority: %u.\n",
1719 RtsFlags.GranFlags.SparkPriority);
1720 debugBelch("SparkPriority2:%u.\n",
1721 RtsFlags.GranFlags.SparkPriority2);
1722 if (RtsFlags.GranFlags.SparkPriority2 <
1723 RtsFlags.GranFlags.SparkPriority) {
1724 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1725 RtsFlags.GranFlags.SparkPriority2,
1726 RtsFlags.GranFlags.SparkPriority);
1730 /* plain pri spark is now invoked with -bX
1731 RtsFlags.GranFlags.DoPrioritySparking = 1;
1732 debugBelch("PrioritySparking.\n");
1738 if (rts_argv[arg][3] != '\0') {
1739 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1741 RtsFlags.GranFlags.ThunksToPack = 1;
1743 debugBelch("Thunks To Pack in one packet: %u.\n",
1744 RtsFlags.GranFlags.ThunksToPack);
1748 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1749 debugBelch("Deterministic mode (no random stealing)\n");
1752 /* The following class of options contains eXperimental */
1753 /* features in connection with exploiting granularity */
1754 /* information. I.e. if -bY is chosen these options */
1755 /* tell the RTS what to do with the supplied info --HWL */
1758 if (rts_argv[arg][3] != '\0') {
1759 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1761 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1763 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1764 RtsFlags.GranFlags.packBufferSize_internal);
1768 switch(rts_argv[arg][3]) {
1771 RtsFlags.GranFlags.DoPrioritySparking = 1;
1772 debugBelch("Priority Sparking with Normal Priorities.\n");
1773 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1774 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1775 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1779 RtsFlags.GranFlags.DoPrioritySparking = 1;
1780 debugBelch("Priority Sparking with Inverse Priorities.\n");
1781 RtsFlags.GranFlags.InversePriorities++;
1785 RtsFlags.GranFlags.DoPrioritySparking = 1;
1786 debugBelch("Priority Sparking with Random Priorities.\n");
1787 RtsFlags.GranFlags.RandomPriorities++;
1791 RtsFlags.GranFlags.DoPrioritySparking = 1;
1792 debugBelch("Priority Sparking with No Priorities.\n");
1793 RtsFlags.GranFlags.IgnorePriorities++;
1797 bad_option( rts_argv[arg] );
1803 switch(rts_argv[arg][3]) {
1806 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1807 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1811 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1815 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1819 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1823 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1824 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1828 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1832 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1836 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1840 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1844 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1848 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1852 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1856 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1857 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1861 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1865 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1869 bad_option( rts_argv[arg] );
1874 # if defined(GRAN_CHECK) && defined(GRAN)
1876 switch(rts_argv[arg][3]) {
1877 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1878 if (rts_argv[arg][4] != '\0') {
1879 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1880 debugBelch("Pack buffer size: %d\n",
1881 RtsFlags.GranFlags.packBufferSize);
1883 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1889 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1890 /* hack warning: interpret the flags as a binary number */
1891 nat n = decode(rts_argv[arg]+3);
1892 set_GranSim_debug_options(n);
1895 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1896 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1899 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1900 debugBelch("Valid GranSim debug options are:\n");
1901 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1902 bad_option( rts_argv[arg] );
1903 } else { // flag found; now set it
1904 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1910 case 'e': /* event trace; also -bD1 */
1911 debugBelch("DEBUG: event_trace; printing event trace.\n");
1912 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1913 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1916 case 'E': /* event statistics; also -bD2 */
1917 debugBelch("DEBUG: event_stats; printing event statistics.\n");
1918 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1919 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1922 case 'f': /* thunkStealing; also -bD4 */
1923 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1924 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1925 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1928 case 'z': /* blockOnFetch; also -bD8 */
1929 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1930 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1931 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1934 case 't': /* blockOnFetch_sanity; also -bD16 */
1935 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1936 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1937 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1940 case 'S': /* priSpark; also -bD32 */
1941 debugBelch("DEBUG: priSpark; priority sparking.\n");
1942 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1945 case 's': /* priSched; also -bD64 */
1946 debugBelch("DEBUG: priSched; priority scheduling.\n");
1947 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1950 case 'F': /* findWork; also -bD128 */
1951 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1952 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1955 case 'g': /* globalBlock; also -bD256 */
1956 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1957 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1960 case 'G': /* pack; also -bD512 */
1961 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
1962 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1965 case 'P': /* packBuffer; also -bD1024 */
1966 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1967 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1970 case 'o': /* sortedQ; also -bD2048 */
1971 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1972 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1975 case 'r': /* randomSteal; also -bD4096 */
1976 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1977 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1980 case 'q': /* checkSparkQ; also -bD8192 */
1981 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1982 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1985 case ':': /* checkLight; also -bD16384 */
1986 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
1987 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1990 case 'b': /* bq; also -bD32768 */
1991 debugBelch("DEBUG: bq; check blocking queues\n");
1992 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1995 case 'd': /* all options turned on */
1996 debugBelch("DEBUG: all options turned on.\n");
1997 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1998 /* RtsFlags.GranFlags.Debug |= 0x40; */
2002 /* RtsFlags.GranFlags.Debug = 1; */
2008 # endif /* GRAN_CHECK */
2010 bad_option( rts_argv[arg] );
2016 Interpret n as a binary number masking GranSim debug options and set the
2017 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2020 set_GranSim_debug_options(nat n) {
2023 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2025 errorBelch(gran_debug_opts_strs[i]);
2027 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2028 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2029 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2030 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2031 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2032 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2033 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2034 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2035 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2036 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2037 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2038 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2039 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2040 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2041 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2042 default: barf("set_GranSim_debug_options: only %d debug options expected");
2048 Print one line explanation for each of the GranSim debug options specified
2052 help_GranSim_debug_options(nat n) {
2055 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2057 debugBelch(gran_debug_opts_strs[i]);
2063 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2066 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2067 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2071 /* Communication and task creation cost parameters */
2072 switch(rts_argv[arg][2]) {
2073 case 'e': /* -qe<n> ... allow <n> local sparks */
2074 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2075 RtsFlags.ParFlags.maxLocalSparks
2076 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2078 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2079 errorBelch("setupRtsFlags: bad value for -e\n");
2083 IF_PAR_DEBUG(verbose,
2084 errorBelch("-qe<n>: max %d local sparks",
2085 RtsFlags.ParFlags.maxLocalSparks));
2089 if (rts_argv[arg][3] != '\0') {
2090 RtsFlags.ParFlags.maxThreads
2091 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2093 errorBelch("missing size for -qt\n");
2096 IF_PAR_DEBUG(verbose,
2097 errorBelch("-qt<n>: max %d threads",
2098 RtsFlags.ParFlags.maxThreads));
2102 if (rts_argv[arg][3] != '\0')
2103 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2105 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2107 IF_PAR_DEBUG(verbose,
2108 errorBelch("-qf<n>: max %d fishes sent out at one time",
2109 RtsFlags.ParFlags.maxFishes));
2113 if (rts_argv[arg][3] != '\0') {
2114 RtsFlags.ParFlags.fishDelay
2115 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2117 errorBelch("missing fish delay time for -qF\n");
2120 IF_PAR_DEBUG(verbose,
2121 errorBelch("-qF<n>: fish delay time %d us",
2122 RtsFlags.ParFlags.fishDelay));
2126 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2127 IF_PAR_DEBUG(verbose,
2128 errorBelch("-qO: output disabled"));
2131 case 'g': /* -qg<n> ... globalisation scheme */
2132 if (rts_argv[arg][3] != '\0') {
2133 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2135 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2138 IF_PAR_DEBUG(verbose,
2139 debugBelch("-qg<n>: globalisation scheme set to %d",
2140 RtsFlags.ParFlags.globalising));
2143 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2144 if (rts_argv[arg][3] != '\0') {
2145 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2147 errorBelch("missing number of thunks per packet (for -qh)\n");
2150 IF_PAR_DEBUG(verbose,
2151 debugBelch("-qh<n>: thunks per packet set to %d",
2152 RtsFlags.ParFlags.thunksToPack));
2155 case 'P': /* -qP for writing a log file */
2156 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2157 /* same encoding as in GranSim after -bP */
2158 switch(rts_argv[arg][3]) {
2159 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2160 break; // nothing special, just an ordinary profile
2161 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2162 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2164 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2166 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2168 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2170 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2173 # if defined(PAR_TICKY)
2174 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2176 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2177 stg_exit(EXIT_FAILURE);
2180 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2182 IF_PAR_DEBUG(verbose,
2183 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2184 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2187 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2188 if (rts_argv[arg][3] != '\0') {
2189 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2191 errorBelch("missing size of PackBuffer (for -qQ)\n");
2194 IF_PAR_DEBUG(verbose,
2195 debugBelch("-qQ<n>: pack buffer size set to %d",
2196 RtsFlags.ParFlags.packBufferSize));
2200 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2201 IF_PAR_DEBUG(verbose,
2202 debugBelch("-qR: fair-ish scheduling"));
2207 if (rts_argv[arg][3] != '\0') {
2208 RtsFlags.ParFlags.wait
2209 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2211 RtsFlags.ParFlags.wait = 1000;
2213 IF_PAR_DEBUG(verbose,
2214 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2215 RtsFlags.ParFlags.wait));
2218 case 'D': /* -qD ... all the debugging options */
2219 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2220 /* hack warning: interpret the flags as a binary number */
2221 nat n = decode(rts_argv[arg]+3);
2222 set_par_debug_options(n);
2225 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2226 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2229 if (i==MAX_PAR_DEBUG_OPTION+1) {
2230 errorBelch("Valid GUM debug options are:\n");
2231 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2232 bad_option( rts_argv[arg] );
2233 } else { // flag found; now set it
2234 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2240 errorBelch("Unknown option -q%c (%d opts in total)",
2241 rts_argv[arg][2], *rts_argc);
2247 Interpret n as a binary number masking Par debug options and set the
2248 correxponding option. See par_debug_opts_strs for explanations of the flags.
2251 set_par_debug_options(nat n) {
2254 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2256 debugBelch(par_debug_opts_strs[i]);
2258 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2259 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2260 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2261 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2262 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2263 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2264 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2265 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2266 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2267 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2268 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2269 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2270 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2271 default: barf("set_par_debug_options: only %d debug options expected",
2272 MAX_PAR_DEBUG_OPTION);
2278 Print one line explanation for each of the GranSim debug options specified
2282 help_par_debug_options(nat n) {
2285 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2287 debugBelch(par_debug_opts_strs[i]);
2293 stats_fprintf(FILE *f, char *s, ...)
2305 static int /* return -1 on error */
2308 int argc, char *argv[],
2309 int rts_argc, char *rts_argv[],
2310 const char *FILENAME_FMT,
2315 if (strequal(rts_argv[arg]+2, "stderr")) { /* use debugBelch */
2316 f = NULL; /* NULL means use debugBelch */
2318 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2319 f = fopen(rts_argv[arg]+2,"w");
2321 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2322 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2323 f = fopen(stats_filename,"w");
2326 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2333 /* Write argv and rtsv into start of stats file */
2335 for(count = 0; count < argc; count++) {
2336 stats_fprintf(f, "%s ", argv[count]);
2338 stats_fprintf(f, "+RTS ");
2339 for(count = 0; count < rts_argc; count++)
2340 stats_fprintf(f, "%s ", rts_argv[count]);
2341 stats_fprintf(f, "\n");
2349 decode(const char *s)
2360 if (c == 'g' || c == 'G')
2361 m *= 1000*1000*1000; /* UNchecked! */
2362 else if (c == 'm' || c == 'M')
2363 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2364 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2365 m *= 1000; /* a direct-mapped cache. */
2366 else if (c == 'w' || c == 'W')
2373 bad_option(const char *s)
2375 errorBelch("bad RTS option: %s", s);
2376 stg_exit(EXIT_FAILURE);
2379 /* -----------------------------------------------------------------------------
2380 Getting/Setting the program's arguments.
2382 These are used by System.Environment, and parts of the RTS.
2383 -------------------------------------------------------------------------- */
2386 setProgName(char *argv[])
2388 /* Remove directory from argv[0] -- default files in current directory */
2389 #if !defined(mingw32_HOST_OS)
2391 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2392 prog_name = last_slash+1;
2394 prog_name = argv[0];
2397 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2398 while ( last_slash > argv[0] ) {
2399 if ( *last_slash == '/' || *last_slash == '\\' ) {
2400 prog_name = last_slash+1;
2405 prog_name = argv[0];
2410 getProgArgv(int *argc, char **argv[])
2412 if (argc) { *argc = prog_argc; }
2413 if (argv) { *argv = prog_argv; }
2417 setProgArgv(int argc, char *argv[])
2419 /* Usually this is done by startupHaskell, so we don't need to call this.
2420 However, sometimes Hugs wants to change the arguments which Haskell
2421 getArgs >>= ... will be fed. So you can do that by calling here
2422 _after_ calling startupHaskell.
2426 setProgName(prog_argv);
2429 /* These functions record and recall the full arguments, including the
2430 +RTS ... -RTS options. The reason for adding them was so that the
2431 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2433 getFullProgArgv(int *argc, char **argv[])
2435 if (argc) { *argc = full_prog_argc; }
2436 if (argv) { *argv = full_prog_argv; }
2440 setFullProgArgv(int argc, char *argv[])
2443 full_prog_argc = argc;
2444 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2445 "setFullProgArgv 1");
2446 for (i = 0; i < argc; i++) {
2447 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2448 "setFullProgArgv 2");
2449 strcpy(full_prog_argv[i], argv[i]);
2451 full_prog_argv[argc] = NULL;