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 char *prog_name = NULL; /* 'basename' of prog_argv[0] */
32 int rts_argc = 0; /* ditto */
33 char *rts_argv[MAX_RTS_ARGS];
36 * constants, used later
43 static char *gran_debug_opts_strs[] = {
44 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
45 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
46 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
47 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
48 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
49 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
50 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
51 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
52 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
53 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
54 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
55 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
56 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
57 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
58 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
61 /* one character codes for the available debug options */
62 static char gran_debug_opts_flags[] = {
63 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
68 static char *par_debug_opts_strs[] = {
69 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
70 "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
71 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
72 "DEBUG (-qDe, -qD8): free; free messages.\n",
73 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
74 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
75 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
76 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
77 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
78 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
79 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
80 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
81 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
82 "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
85 /* one character codes for the available debug options */
86 static char par_debug_opts_flags[] = {
87 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
92 /* -----------------------------------------------------------------------------
94 -------------------------------------------------------------------------- */
96 static int /* return NULL on error */
99 int argc, char *argv[],
100 int rts_argc, char *rts_argv[],
101 const char *FILENAME_FMT,
104 static I_ decode(const char *s);
105 static void bad_option(const char *s);
108 static void enable_GranSimLight(void);
109 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
110 static void set_GranSim_debug_options(nat n);
111 static void help_GranSim_debug_options(nat n);
113 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
114 static void set_par_debug_options(nat n);
115 static void help_par_debug_options(nat n);
118 /* -----------------------------------------------------------------------------
119 * Command-line option parsing routines.
120 * ---------------------------------------------------------------------------*/
122 void initRtsFlagsDefaults(void)
124 RtsFlags.GcFlags.statsFile = NULL;
125 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
127 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
128 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
130 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
131 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
132 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
133 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
134 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
135 RtsFlags.GcFlags.oldGenFactor = 2;
137 /* A hack currently needed for GUM -- HWL */
138 RtsFlags.GcFlags.generations = 1;
139 RtsFlags.GcFlags.steps = 2;
140 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
142 RtsFlags.GcFlags.generations = 2;
143 RtsFlags.GcFlags.steps = 2;
144 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
146 RtsFlags.GcFlags.compact = rtsFalse;
147 RtsFlags.GcFlags.compactThreshold = 30.0;
148 #ifdef RTS_GTK_FRONTPANEL
149 RtsFlags.GcFlags.frontpanel = rtsFalse;
151 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
154 RtsFlags.DebugFlags.scheduler = rtsFalse;
155 RtsFlags.DebugFlags.interpreter = rtsFalse;
156 RtsFlags.DebugFlags.weak = rtsFalse;
157 RtsFlags.DebugFlags.gccafs = rtsFalse;
158 RtsFlags.DebugFlags.gc = rtsFalse;
159 RtsFlags.DebugFlags.block_alloc = rtsFalse;
160 RtsFlags.DebugFlags.sanity = rtsFalse;
161 RtsFlags.DebugFlags.stable = rtsFalse;
162 RtsFlags.DebugFlags.stm = rtsFalse;
163 RtsFlags.DebugFlags.prof = rtsFalse;
164 RtsFlags.DebugFlags.gran = rtsFalse;
165 RtsFlags.DebugFlags.par = rtsFalse;
166 RtsFlags.DebugFlags.linker = rtsFalse;
167 RtsFlags.DebugFlags.squeeze = rtsFalse;
168 RtsFlags.DebugFlags.hpc = rtsFalse;
171 #if defined(PROFILING) || defined(PAR)
172 RtsFlags.CcFlags.doCostCentres = 0;
173 #endif /* PROFILING or PAR */
176 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
177 RtsFlags.ProfFlags.profileInterval = 100;
178 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
179 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
180 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
181 RtsFlags.ProfFlags.ccsLength = 25;
182 RtsFlags.ProfFlags.modSelector = NULL;
183 RtsFlags.ProfFlags.descrSelector = NULL;
184 RtsFlags.ProfFlags.typeSelector = NULL;
185 RtsFlags.ProfFlags.ccSelector = NULL;
186 RtsFlags.ProfFlags.ccsSelector = NULL;
187 RtsFlags.ProfFlags.retainerSelector = NULL;
188 RtsFlags.ProfFlags.bioSelector = NULL;
191 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
194 RtsFlags.MiscFlags.tickInterval = 50; /* In milliseconds */
195 RtsFlags.ConcFlags.ctxtSwitchTime = 50; /* In milliseconds */
197 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
200 RtsFlags.ParFlags.nNodes = 1;
201 RtsFlags.ParFlags.migrate = rtsTrue;
202 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
206 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
207 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
208 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
209 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
210 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
211 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
212 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
214 RtsFlags.ParFlags.outputDisabled = rtsFalse;
216 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
218 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
220 RtsFlags.ParFlags.packBufferSize = 1024;
221 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
222 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
223 RtsFlags.ParFlags.maxThreads = 1024;
224 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
225 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
228 #if defined(PAR) || defined(THREADED_RTS)
229 RtsFlags.ParFlags.maxLocalSparks = 4096;
230 #endif /* PAR || THREADED_RTS */
233 /* ToDo: check defaults for GranSim and GUM */
234 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
235 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
237 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
238 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
239 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
240 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
241 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
242 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
243 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
244 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
246 RtsFlags.GranFlags.packBufferSize = 1024;
247 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
249 RtsFlags.GranFlags.proc = MAX_PROC;
250 RtsFlags.GranFlags.Fishing = rtsFalse;
251 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
252 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
253 RtsFlags.GranFlags.Light = rtsFalse;
255 RtsFlags.GranFlags.Costs.latency = LATENCY;
256 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
257 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
258 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
259 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
260 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
261 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
262 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
264 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
265 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
266 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
267 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
268 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
270 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
271 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
272 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
273 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
274 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
276 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
278 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
279 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
281 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
282 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
283 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
284 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
285 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
286 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
287 RtsFlags.GranFlags.FetchStrategy = 2;
288 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
289 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
290 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
291 RtsFlags.GranFlags.SparkPriority = 0;
292 RtsFlags.GranFlags.SparkPriority2 = 0;
293 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
294 RtsFlags.GranFlags.InversePriorities = rtsFalse;
295 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
296 RtsFlags.GranFlags.ThunksToPack = 0;
297 RtsFlags.GranFlags.RandomSteal = rtsTrue;
301 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
302 RtsFlags.TickyFlags.tickyFile = NULL;
305 RtsFlags.TraceFlags.timestamp = rtsFalse;
306 RtsFlags.TraceFlags.sched = rtsFalse;
309 /* By default no special measurements taken */
310 RtsFlags.PapiFlags.eventType = 0;
317 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
319 " +RTS Indicates run time system options follow",
320 " -RTS Indicates program arguments follow",
321 " --RTS Indicates that ALL subsequent arguments will be given to the",
322 " program (including any of these RTS flags)",
324 "The following run time system options are available:",
326 " -? Prints this message and exits; the program is not executed",
328 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
329 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
331 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
332 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
333 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
334 " -m<n> Minimum % of heap which must be available (default 3%)",
335 " -G<n> Number of generations (default: 2)",
336 " -T<n> Number of steps in younger generations (default: 2)",
337 " -c<n> Auto-enable compaction of the oldest generation when live data is",
338 " at least <n>% of the maximum heap size set with -M (default: 30%)",
339 " -c Enable compaction for all major collections",
340 #if defined(THREADED_RTS)
341 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
344 " -t<file> One-line GC statistics (default file: <program>.stat)",
345 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
346 " -S<file> Detailed GC statistics",
347 #ifdef RTS_GTK_FRONTPANEL
348 " -f Display front panel (requires X11 & GTK+)",
352 " -Z Don't squeeze out update frames on stack overflow",
353 " -B Sound the bell at the start of each garbage collection",
354 #if defined(PROFILING) || defined(PAR)
356 " -px Time/allocation profile (XML) (output file <program>.prof)",
357 " -p Time/allocation profile (output file <program>.prof)",
358 " -P More detailed Time/Allocation profile",
359 " -Pa Give information about *all* cost centres",
361 # if defined(PROFILING)
363 " -hx Heap residency profile (XML) (output file <program>.prof)",
364 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
365 " break-down: c = cost centre stack (default)",
367 " d = closure description",
368 " y = type description",
370 " b = biography (LAG,DRAG,VOID,USE)",
371 " A subset of closures may be selected thusly:",
372 " -hc<cc>,... specific cost centre(s) (top of stack only)",
373 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
374 " -hm<mod>... all cost centres from the specified modules(s)",
375 " -hd<des>,... closures with specified closure descriptions",
376 " -hy<typ>... closures with specified type descriptions",
377 " -hr<cc>... closures with specified retainers",
378 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
380 " -R<size> Set the maximum retainer set size (default: 8)",
382 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
385 " -i<sec> Time between heap samples (seconds, default: 0.1)",
387 " -xt Include threads (TSOs) in a heap profile",
389 " -xc Show current cost centre stack on raising an exception",
391 #endif /* PROFILING or PAR */
392 #if !defined(PROFILING) && defined(DEBUG)
394 " -h<break-down> Debugging Heap residency profile",
395 " (output file <program>.hp)",
396 " break-down: L = closure label (default)",
397 " T = closure type (constructor, thunk etc.)",
400 #if defined(TICKY_TICKY)
401 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
405 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
406 /* NB: the -N<n> is implemented by the driver!! */
408 " -C<secs> Context-switch interval in seconds.",
409 " 0 or no argument means switch as often as possible.",
410 " Default: 0.02 sec; resolution is set by -V below.",
411 " -V<secs> Master tick interval in seconds.",
412 " This sets the resolution for -C and the profile timer -i.",
413 " Default: 0.02 sec.",
415 " -vs Trace scheduler events (see also -Ds with -debug)",
416 " -vt Time-stamp trace messages",
419 " -Ds DEBUG: scheduler",
420 " -Di DEBUG: interpreter",
422 " -DG DEBUG: gccafs",
425 " -DS DEBUG: sanity",
426 " -Dt DEBUG: stable",
430 " -Dl DEBUG: linker",
432 " -Dz DEBUG: stack squezing",
433 " -Dc DEBUG: program coverage",
436 #if defined(THREADED_RTS) && !defined(NOSMP)
437 " -N<n> Use <n> OS threads (default: 1)",
438 " -qm Don't automatically migrate threads between CPUs",
439 " -qw Migrate a thread to the current CPU when it is woken up",
441 " --install-signal-handlers=<yes|no>",
442 " Install signal handlers (default: yes)",
443 #if defined(THREADED_RTS) || defined(PAR)
444 " -e<size> Size of spark pools (default 100)",
447 " -t<num> Set maximum number of advisory threads per PE (default 32)",
448 " -qP Enable activity profile (output files in ~/<program>*.gr)",
449 " -qQ<size> Set pack-buffer size (default: 1024)",
450 " -qd Turn on PVM-ish debugging",
451 " -qO Disable output for performance measurement",
453 #if defined(THREADED_RTS) || defined(PAR)
454 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
457 " -d Turn on PVM-ish debugging",
458 " -O Disable output for performance measurement",
460 #if defined(GRAN) /* ToDo: fill in decent Docu here */
461 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
463 #if defined(USE_PAPI)
464 " -aX CPU performance counter measurements using PAPI",
465 " (use with the -s<file> option). X is one of:",
468 " 1 - level 1 cache misses",
469 " 2 - level 2 cache misses",
470 " b - branch mispredictions",
471 " s - stalled cycles",
472 " e - cache miss and branch misprediction events",
475 "RTS options may also be specified using the GHCRTS environment variable.",
477 "Other RTS options may be available for programs compiled a different way.",
478 "The GHC User's Guide has full details.",
483 STATIC_INLINE rtsBool
484 strequal(const char *a, const char * b)
486 return(strcmp(a, b) == 0);
490 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
496 while (isspace(*c1)) { c1++; };
498 while (!isspace(*c2) && *c2 != '\0') { c2++; };
500 if (c1 == c2) { break; }
502 if (*rts_argc < MAX_RTS_ARGS-1) {
503 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
504 strncpy(s, c1, c2-c1);
506 rts_argv[(*rts_argc)++] = s;
508 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
512 } while (*c1 != '\0');
516 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
518 rtsBool error = rtsFalse;
529 // process arguments from the ghc_rts_opts global variable first.
530 // (arguments from the GHCRTS environment variable and the command
531 // line override these).
533 if (ghc_rts_opts != NULL) {
534 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
538 // process arguments from the GHCRTS environment variable next
539 // (arguments from the command line override these).
541 char *ghc_rts = getenv("GHCRTS");
543 if (ghc_rts != NULL) {
544 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
548 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
549 // argv[0] must be PGM argument -- leave in argv
551 for (mode = PGM; arg < total_arg; arg++) {
552 // The '--RTS' argument disables all future +RTS ... -RTS processing.
553 if (strequal("--RTS", argv[arg])) {
557 // The '--' argument is passed through to the program, but
558 // disables all further +RTS ... -RTS processing.
559 else if (strequal("--", argv[arg])) {
562 else if (strequal("+RTS", argv[arg])) {
565 else if (strequal("-RTS", argv[arg])) {
568 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
569 rts_argv[(*rts_argc)++] = argv[arg];
571 else if (mode == PGM) {
572 argv[(*argc)++] = argv[arg];
575 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
578 // process remaining program arguments
579 for (; arg < total_arg; arg++) {
580 argv[(*argc)++] = argv[arg];
582 argv[*argc] = (char *) 0;
583 rts_argv[*rts_argc] = (char *) 0;
585 // Process RTS (rts_argv) part: mainly to determine statsfile
586 for (arg = 0; arg < *rts_argc; arg++) {
587 if (rts_argv[arg][0] != '-') {
589 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
593 switch(rts_argv[arg][1]) {
595 /* process: general args, then PROFILING-only ones,
596 then CONCURRENT-only, PARallel-only, GRAN-only,
597 TICKY-only (same order as defined in RtsFlags.lh);
598 within those groups, mostly in case-insensitive
600 Final group is x*, which allows for more options.
604 # define TICKY_BUILD_ONLY(x) x
606 # define TICKY_BUILD_ONLY(x) \
607 errorBelch("not built for: ticky-ticky stats"); \
611 #if defined(PROFILING)
612 # define COST_CENTRE_USING_BUILD_ONLY(x) x
614 # define COST_CENTRE_USING_BUILD_ONLY(x) \
615 errorBelch("not built for: -prof or -parallel"); \
620 # define PROFILING_BUILD_ONLY(x) x
622 # define PROFILING_BUILD_ONLY(x) \
623 errorBelch("not built for: -prof"); \
628 # define PAR_BUILD_ONLY(x) x
630 # define PAR_BUILD_ONLY(x) \
631 errorBelch("not built for: -parallel"); \
636 # define THREADED_BUILD_ONLY(x) x
638 # define THREADED_BUILD_ONLY(x) \
639 errorBelch("not built for: -smp"); \
643 #if defined(THREADED_RTS) || defined(PAR)
644 # define PAR_OR_THREADED_BUILD_ONLY(x) x
646 # define PAR_OR_THREADED_BUILD_ONLY(x) \
647 errorBelch("not built for: -parallel or -smp"); \
652 # define GRAN_BUILD_ONLY(x) x
654 # define GRAN_BUILD_ONLY(x) \
655 errorBelch("not built for: -gransim"); \
659 /* =========== GENERAL ========================== */
664 /* This isn't going to allow us to keep related options
665 together as we add more --* flags. We really need a
666 proper options parser. */
668 if (strequal("install-signal-handlers=yes",
669 &rts_argv[arg][2])) {
670 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
672 else if (strequal("install-signal-handlers=no",
673 &rts_argv[arg][2])) {
674 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
677 errorBelch("unknown RTS option: %s",rts_argv[arg]);
682 RtsFlags.GcFlags.minAllocAreaSize
683 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
684 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
685 bad_option(rts_argv[arg]);
691 switch(rts_argv[arg][2]) {
693 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
696 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
699 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
702 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
705 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
708 bad_option( rts_argv[arg] );
714 RtsFlags.GcFlags.ringBell = rtsTrue;
718 if (rts_argv[arg][2] != '\0') {
719 RtsFlags.GcFlags.compactThreshold =
720 atof(rts_argv[arg]+2);
722 RtsFlags.GcFlags.compact = rtsTrue;
727 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
729 if (RtsFlags.GcFlags.oldGenFactor < 0)
730 bad_option( rts_argv[arg] );
738 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
741 RtsFlags.DebugFlags.scheduler = rtsTrue;
744 RtsFlags.DebugFlags.interpreter = rtsTrue;
747 RtsFlags.DebugFlags.weak = rtsTrue;
750 RtsFlags.DebugFlags.gccafs = rtsTrue;
753 RtsFlags.DebugFlags.gc = rtsTrue;
756 RtsFlags.DebugFlags.block_alloc = rtsTrue;
759 RtsFlags.DebugFlags.sanity = rtsTrue;
762 RtsFlags.DebugFlags.stable = rtsTrue;
765 RtsFlags.DebugFlags.prof = rtsTrue;
768 RtsFlags.DebugFlags.gran = rtsTrue;
771 RtsFlags.DebugFlags.par = rtsTrue;
774 RtsFlags.DebugFlags.linker = rtsTrue;
777 RtsFlags.DebugFlags.apply = rtsTrue;
780 RtsFlags.DebugFlags.stm = rtsTrue;
783 RtsFlags.DebugFlags.squeeze = rtsTrue;
786 RtsFlags.DebugFlags.hpc = rtsTrue;
789 bad_option( rts_argv[arg] );
797 RtsFlags.GcFlags.maxStkSize =
798 decode(rts_argv[arg]+2) / sizeof(W_);
800 if (RtsFlags.GcFlags.maxStkSize == 0)
801 bad_option( rts_argv[arg] );
805 RtsFlags.GcFlags.initialStkSize =
806 decode(rts_argv[arg]+2) / sizeof(W_);
808 if (RtsFlags.GcFlags.initialStkSize == 0)
809 bad_option( rts_argv[arg] );
813 RtsFlags.GcFlags.maxHeapSize =
814 decode(rts_argv[arg]+2) / BLOCK_SIZE;
815 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
817 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
818 bad_option(rts_argv[arg]);
823 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
825 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
826 RtsFlags.GcFlags.pcFreeHeap > 100)
827 bad_option( rts_argv[arg] );
831 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
832 if (RtsFlags.GcFlags.generations < 1) {
833 bad_option(rts_argv[arg]);
838 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
839 if (RtsFlags.GcFlags.steps < 1) {
840 bad_option(rts_argv[arg]);
845 RtsFlags.GcFlags.heapSizeSuggestion =
846 decode(rts_argv[arg]+2) / BLOCK_SIZE;
848 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
849 bad_option(rts_argv[arg]);
853 #ifdef RTS_GTK_FRONTPANEL
855 RtsFlags.GcFlags.frontpanel = rtsTrue;
859 case 'I': /* idle GC delay */
860 if (rts_argv[arg][2] == '\0') {
865 /* Convert to millisecs */
866 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
867 RtsFlags.GcFlags.idleGCDelayTime = cst;
872 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
876 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
880 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
885 /* Opening all those files would almost certainly fail... */
886 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
887 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
891 r = open_stats_file(arg, *argc, argv,
892 *rts_argc, rts_argv, STAT_FILENAME_FMT,
893 &RtsFlags.GcFlags.statsFile);
894 if (r == -1) { error = rtsTrue; }
900 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
903 /* =========== PROFILING ========================== */
905 case 'P': /* detailed cost centre profiling (time/alloc) */
906 case 'p': /* cost centre profiling (time/alloc) */
907 COST_CENTRE_USING_BUILD_ONLY(
908 switch (rts_argv[arg][2]) {
910 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
913 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
916 if (rts_argv[arg][1] == 'P') {
917 RtsFlags.CcFlags.doCostCentres =
918 COST_CENTRES_VERBOSE;
920 RtsFlags.CcFlags.doCostCentres =
921 COST_CENTRES_SUMMARY;
928 PROFILING_BUILD_ONLY(
929 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
932 PROFILING_BUILD_ONLY(
933 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
934 if(RtsFlags.ProfFlags.ccsLength <= 0) {
935 bad_option(rts_argv[arg]);
938 case 'h': /* serial heap profile */
939 #if !defined(PROFILING) && defined(DEBUG)
940 switch (rts_argv[arg][2]) {
943 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
946 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
949 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
953 PROFILING_BUILD_ONLY(
954 switch (rts_argv[arg][2]) {
968 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
970 char *left = strchr(rts_argv[arg], '{');
971 char *right = strrchr(rts_argv[arg], '}');
973 // curly braces are optional, for
978 left = rts_argv[arg] + 3;
981 right = rts_argv[arg] + strlen(rts_argv[arg]);
985 switch (rts_argv[arg][2]) {
986 case 'c': // cost centre label select
987 RtsFlags.ProfFlags.ccSelector = left;
990 RtsFlags.ProfFlags.ccsSelector = left;
993 case 'm': // cost centre module select
994 RtsFlags.ProfFlags.modSelector = left;
997 case 'd': // closure descr select
998 RtsFlags.ProfFlags.descrSelector = left;
1001 case 'y': // closure type select
1002 RtsFlags.ProfFlags.typeSelector = left;
1005 case 'r': // retainer select
1006 RtsFlags.ProfFlags.retainerSelector = left;
1009 case 'b': // biography select
1010 RtsFlags.ProfFlags.bioSelector = left;
1017 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1018 errorBelch("multiple heap profile options");
1023 switch (rts_argv[arg][2]) {
1027 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1031 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1035 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1039 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1043 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1047 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1053 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1057 #endif /* PROFILING */
1060 #if defined(PROFILING)
1061 case 'i': /* heap sample interval */
1062 if (rts_argv[arg][2] == '\0') {
1067 /* Convert to milliseconds */
1068 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1069 RtsFlags.ProfFlags.profileInterval = cst;
1074 /* =========== CONCURRENT ========================= */
1075 case 'C': /* context switch interval */
1076 if (rts_argv[arg][2] == '\0')
1077 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1081 /* Convert to milliseconds */
1082 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1083 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1087 case 'V': /* master tick interval */
1088 if (rts_argv[arg][2] == '\0') {
1089 // turns off ticks completely
1090 RtsFlags.MiscFlags.tickInterval = 0;
1094 /* Convert to milliseconds */
1095 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1096 RtsFlags.MiscFlags.tickInterval = cst;
1100 #if defined(THREADED_RTS) && !defined(NOSMP)
1102 THREADED_BUILD_ONLY(
1103 if (rts_argv[arg][2] != '\0') {
1104 RtsFlags.ParFlags.nNodes
1105 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1106 if (RtsFlags.ParFlags.nNodes <= 0) {
1107 errorBelch("bad value for -N");
1114 switch (rts_argv[arg][2]) {
1116 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1120 RtsFlags.ParFlags.migrate = rtsFalse;
1123 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1126 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1132 /* =========== PARALLEL =========================== */
1134 PAR_OR_THREADED_BUILD_ONLY(
1135 if (rts_argv[arg][2] != '\0') {
1136 RtsFlags.ParFlags.maxLocalSparks
1137 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1138 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1139 errorBelch("bad value for -e");
1148 process_par_option(arg, rts_argc, rts_argv, &error);
1152 /* =========== GRAN =============================== */
1156 process_gran_option(arg, rts_argc, rts_argv, &error);
1159 /* =========== TICKY ============================== */
1161 case 'r': /* Basic profiling stats */
1164 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1168 r = open_stats_file(arg, *argc, argv,
1169 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1170 &RtsFlags.TickyFlags.tickyFile);
1171 if (r == -1) { error = rtsTrue; }
1175 /* =========== TRACING ---------=================== */
1178 switch(rts_argv[arg][2]) {
1180 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1184 RtsFlags.TraceFlags.timestamp = rtsTrue;
1187 RtsFlags.TraceFlags.sched = rtsTrue;
1190 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1196 /* =========== EXTENDED OPTIONS =================== */
1198 case 'x': /* Extend the argument space */
1199 switch(rts_argv[arg][2]) {
1201 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1205 case 'c': /* Debugging tool: show current cost centre on an exception */
1206 PROFILING_BUILD_ONLY(
1207 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1211 case 't': /* Include memory used by TSOs in a heap profile */
1212 PROFILING_BUILD_ONLY(
1213 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1217 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1220 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1224 break; /* defensive programming */
1226 /* =========== OH DEAR ============================ */
1228 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1235 // Determine what tick interval we should use for the RTS timer
1236 // by taking the shortest of the various intervals that we need to
1238 if (RtsFlags.MiscFlags.tickInterval <= 0) {
1239 RtsFlags.MiscFlags.tickInterval = 50;
1242 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1243 RtsFlags.MiscFlags.tickInterval =
1244 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1245 RtsFlags.MiscFlags.tickInterval);
1248 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1249 RtsFlags.MiscFlags.tickInterval =
1250 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1251 RtsFlags.MiscFlags.tickInterval);
1255 if (RtsFlags.ProfFlags.profileInterval > 0) {
1256 RtsFlags.MiscFlags.tickInterval =
1257 stg_min(RtsFlags.ProfFlags.profileInterval,
1258 RtsFlags.MiscFlags.tickInterval);
1262 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1263 RtsFlags.ConcFlags.ctxtSwitchTicks =
1264 RtsFlags.ConcFlags.ctxtSwitchTime /
1265 RtsFlags.MiscFlags.tickInterval;
1267 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1271 RtsFlags.ProfFlags.profileIntervalTicks =
1272 RtsFlags.ProfFlags.profileInterval / RtsFlags.MiscFlags.tickInterval;
1279 for (p = usage_text; *p; p++)
1280 errorBelch("%s", *p);
1281 stg_exit(EXIT_FAILURE);
1288 enable_GranSimLight(void) {
1290 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1291 RtsFlags.GranFlags.Light=rtsTrue;
1292 RtsFlags.GranFlags.Costs.latency =
1293 RtsFlags.GranFlags.Costs.fetchtime =
1294 RtsFlags.GranFlags.Costs.additional_latency =
1295 RtsFlags.GranFlags.Costs.gunblocktime =
1296 RtsFlags.GranFlags.Costs.lunblocktime =
1297 RtsFlags.GranFlags.Costs.threadcreatetime =
1298 RtsFlags.GranFlags.Costs.threadqueuetime =
1299 RtsFlags.GranFlags.Costs.threadscheduletime =
1300 RtsFlags.GranFlags.Costs.threaddescheduletime =
1301 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1303 RtsFlags.GranFlags.Costs.mpacktime =
1304 RtsFlags.GranFlags.Costs.munpacktime = 0;
1306 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1307 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1308 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1309 /* FetchStrategy is irrelevant in GrAnSim-Light */
1311 /* GrAnSim Light often creates an abundance of parallel threads,
1312 each with its own stack etc. Therefore, it's in general a good
1313 idea to use small stack chunks (use the -o<size> option to
1316 // RtsFlags.ConcFlags.stkChunkSize = 100;
1318 RtsFlags.GranFlags.proc = 1;
1322 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1324 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1327 /* or a ridiculously idealised simulator */
1328 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1329 RtsFlags.GranFlags.Costs.latency =
1330 RtsFlags.GranFlags.Costs.fetchtime =
1331 RtsFlags.GranFlags.Costs.additional_latency =
1332 RtsFlags.GranFlags.Costs.gunblocktime =
1333 RtsFlags.GranFlags.Costs.lunblocktime =
1334 RtsFlags.GranFlags.Costs.threadcreatetime =
1335 RtsFlags.GranFlags.Costs.threadqueuetime =
1336 RtsFlags.GranFlags.Costs.threadscheduletime =
1337 RtsFlags.GranFlags.Costs.threaddescheduletime =
1338 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1340 RtsFlags.GranFlags.Costs.mpacktime =
1341 RtsFlags.GranFlags.Costs.munpacktime = 0;
1343 RtsFlags.GranFlags.Costs.arith_cost =
1344 RtsFlags.GranFlags.Costs.float_cost =
1345 RtsFlags.GranFlags.Costs.load_cost =
1346 RtsFlags.GranFlags.Costs.store_cost =
1347 RtsFlags.GranFlags.Costs.branch_cost = 0;
1349 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1351 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1352 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1353 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1354 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1358 /* or a somewhat idealised simulator */
1359 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1360 RtsFlags.GranFlags.Costs.latency =
1361 RtsFlags.GranFlags.Costs.fetchtime =
1362 RtsFlags.GranFlags.Costs.additional_latency =
1363 RtsFlags.GranFlags.Costs.gunblocktime =
1364 RtsFlags.GranFlags.Costs.lunblocktime =
1365 RtsFlags.GranFlags.Costs.threadcreatetime =
1366 RtsFlags.GranFlags.Costs.threadqueuetime =
1367 RtsFlags.GranFlags.Costs.threadscheduletime =
1368 RtsFlags.GranFlags.Costs.threaddescheduletime =
1369 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1371 RtsFlags.GranFlags.Costs.mpacktime =
1372 RtsFlags.GranFlags.Costs.munpacktime = 0;
1374 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1376 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1377 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1378 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1379 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1380 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1381 # if defined(GRAN_CHECK) && defined(GRAN)
1382 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1387 /* Communication and task creation cost parameters */
1388 switch(rts_argv[arg][2]) {
1390 IgnoreYields = rtsTrue; // HWL HACK
1394 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1398 if (rts_argv[arg][3] != '\0')
1400 RtsFlags.GranFlags.Costs.gunblocktime =
1401 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1402 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1405 RtsFlags.GranFlags.Costs.latency = LATENCY;
1409 if (rts_argv[arg][3] != '\0')
1410 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1412 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1416 if (rts_argv[arg][3] != '\0')
1417 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1419 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1423 if (rts_argv[arg][3] != '\0')
1424 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1426 RtsFlags.GranFlags.Costs.mtidytime = 0;
1430 if (rts_argv[arg][3] != '\0')
1431 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1433 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1437 if (rts_argv[arg][3] != '\0')
1438 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1440 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1444 if (rts_argv[arg][3] != '\0')
1445 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1447 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1451 if (rts_argv[arg][3] != '\0')
1452 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1454 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1457 /* Thread-related metrics */
1459 if (rts_argv[arg][3] != '\0')
1460 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1462 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1466 if (rts_argv[arg][3] != '\0')
1467 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1469 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1473 if (rts_argv[arg][3] != '\0')
1474 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1476 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1478 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1479 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1483 if (rts_argv[arg][3] != '\0')
1484 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1486 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1488 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1489 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1492 /* Instruction Cost Metrics */
1494 if (rts_argv[arg][3] != '\0')
1495 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1497 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1501 if (rts_argv[arg][3] != '\0')
1502 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1504 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1508 if (rts_argv[arg][3] != '\0')
1509 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1511 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1515 if (rts_argv[arg][3] != '\0')
1516 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1518 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1522 if (rts_argv[arg][3] != '\0')
1523 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1525 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1529 if (rts_argv[arg][3] != '\0')
1530 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1532 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1536 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1537 if (rts_argv[arg][3] != '\0')
1538 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1540 RtsFlags.GranFlags.FetchStrategy = 2;
1541 if (RtsFlags.GranFlags.FetchStrategy == 0)
1542 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1545 case 'K': /* sort overhead (per elem in spark list) */
1546 if (rts_argv[arg][3] != '\0')
1547 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1549 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1550 debugBelch("Overhead for pri spark: %d (per elem).\n",
1551 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1554 case 'O': /* sort overhead (per elem in spark list) */
1555 if (rts_argv[arg][3] != '\0')
1556 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1558 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1559 debugBelch("Overhead for pri sched: %d (per elem).\n",
1560 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1563 /* General Parameters */
1565 if (rts_argv[arg][3] != '\0')
1567 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1568 if (RtsFlags.GranFlags.proc==0) {
1569 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1570 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1571 RtsFlags.GranFlags.proc < 1)
1573 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1579 RtsFlags.GranFlags.proc = MAX_PROC;
1583 RtsFlags.GranFlags.Fishing = rtsTrue;
1584 if (rts_argv[arg][3] != '\0')
1585 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1587 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1591 if (rts_argv[arg][3] != '\0')
1592 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1594 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1598 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1599 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1603 debugBelch("Bulk fetching enabled.\n");
1604 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1608 debugBelch("Thread migration enabled.\n");
1609 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1613 debugBelch("Fair Scheduling enabled.\n");
1614 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1618 debugBelch("Priority Scheduling enabled.\n");
1619 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1623 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1624 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1628 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1632 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1636 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1640 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1644 /* format is -bP<c> where <c> is one char describing kind of profile */
1645 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1646 switch(rts_argv[arg][3]) {
1647 case '\0': break; // nothing special, just an ordinary profile
1648 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1650 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1652 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1654 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1656 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1658 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1660 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1665 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1669 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1672 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1673 if (rts_argv[arg][3] != '\0') {
1676 arg0 = rts_argv[arg]+3;
1677 if ((tmp = strstr(arg0,","))==NULL) {
1678 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1679 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1682 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1683 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1684 debugBelch("SparkPriority: %u.\n",
1685 RtsFlags.GranFlags.SparkPriority);
1686 debugBelch("SparkPriority2:%u.\n",
1687 RtsFlags.GranFlags.SparkPriority2);
1688 if (RtsFlags.GranFlags.SparkPriority2 <
1689 RtsFlags.GranFlags.SparkPriority) {
1690 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1691 RtsFlags.GranFlags.SparkPriority2,
1692 RtsFlags.GranFlags.SparkPriority);
1696 /* plain pri spark is now invoked with -bX
1697 RtsFlags.GranFlags.DoPrioritySparking = 1;
1698 debugBelch("PrioritySparking.\n");
1704 if (rts_argv[arg][3] != '\0') {
1705 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1707 RtsFlags.GranFlags.ThunksToPack = 1;
1709 debugBelch("Thunks To Pack in one packet: %u.\n",
1710 RtsFlags.GranFlags.ThunksToPack);
1714 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1715 debugBelch("Deterministic mode (no random stealing)\n");
1718 /* The following class of options contains eXperimental */
1719 /* features in connection with exploiting granularity */
1720 /* information. I.e. if -bY is chosen these options */
1721 /* tell the RTS what to do with the supplied info --HWL */
1724 if (rts_argv[arg][3] != '\0') {
1725 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1727 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1729 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1730 RtsFlags.GranFlags.packBufferSize_internal);
1734 switch(rts_argv[arg][3]) {
1737 RtsFlags.GranFlags.DoPrioritySparking = 1;
1738 debugBelch("Priority Sparking with Normal Priorities.\n");
1739 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1740 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1741 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1745 RtsFlags.GranFlags.DoPrioritySparking = 1;
1746 debugBelch("Priority Sparking with Inverse Priorities.\n");
1747 RtsFlags.GranFlags.InversePriorities++;
1751 RtsFlags.GranFlags.DoPrioritySparking = 1;
1752 debugBelch("Priority Sparking with Random Priorities.\n");
1753 RtsFlags.GranFlags.RandomPriorities++;
1757 RtsFlags.GranFlags.DoPrioritySparking = 1;
1758 debugBelch("Priority Sparking with No Priorities.\n");
1759 RtsFlags.GranFlags.IgnorePriorities++;
1763 bad_option( rts_argv[arg] );
1769 switch(rts_argv[arg][3]) {
1772 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1773 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1777 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1781 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1785 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1789 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1790 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1794 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1798 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1802 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1806 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1810 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1814 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1818 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1822 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1823 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1827 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1831 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1835 bad_option( rts_argv[arg] );
1840 # if defined(GRAN_CHECK) && defined(GRAN)
1842 switch(rts_argv[arg][3]) {
1843 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1844 if (rts_argv[arg][4] != '\0') {
1845 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1846 debugBelch("Pack buffer size: %d\n",
1847 RtsFlags.GranFlags.packBufferSize);
1849 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1855 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1856 /* hack warning: interpret the flags as a binary number */
1857 nat n = decode(rts_argv[arg]+3);
1858 set_GranSim_debug_options(n);
1861 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1862 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1865 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1866 debugBelch("Valid GranSim debug options are:\n");
1867 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1868 bad_option( rts_argv[arg] );
1869 } else { // flag found; now set it
1870 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1876 case 'e': /* event trace; also -bD1 */
1877 debugBelch("DEBUG: event_trace; printing event trace.\n");
1878 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1879 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1882 case 'E': /* event statistics; also -bD2 */
1883 debugBelch("DEBUG: event_stats; printing event statistics.\n");
1884 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1885 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1888 case 'f': /* thunkStealing; also -bD4 */
1889 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1890 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1891 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1894 case 'z': /* blockOnFetch; also -bD8 */
1895 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1896 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1897 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1900 case 't': /* blockOnFetch_sanity; also -bD16 */
1901 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1902 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1903 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1906 case 'S': /* priSpark; also -bD32 */
1907 debugBelch("DEBUG: priSpark; priority sparking.\n");
1908 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1911 case 's': /* priSched; also -bD64 */
1912 debugBelch("DEBUG: priSched; priority scheduling.\n");
1913 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1916 case 'F': /* findWork; also -bD128 */
1917 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1918 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1921 case 'g': /* globalBlock; also -bD256 */
1922 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1923 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1926 case 'G': /* pack; also -bD512 */
1927 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
1928 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1931 case 'P': /* packBuffer; also -bD1024 */
1932 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1933 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1936 case 'o': /* sortedQ; also -bD2048 */
1937 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1938 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1941 case 'r': /* randomSteal; also -bD4096 */
1942 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1943 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1946 case 'q': /* checkSparkQ; also -bD8192 */
1947 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1948 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1951 case ':': /* checkLight; also -bD16384 */
1952 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
1953 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1956 case 'b': /* bq; also -bD32768 */
1957 debugBelch("DEBUG: bq; check blocking queues\n");
1958 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1961 case 'd': /* all options turned on */
1962 debugBelch("DEBUG: all options turned on.\n");
1963 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1964 /* RtsFlags.GranFlags.Debug |= 0x40; */
1968 /* RtsFlags.GranFlags.Debug = 1; */
1974 # endif /* GRAN_CHECK */
1976 bad_option( rts_argv[arg] );
1982 Interpret n as a binary number masking GranSim debug options and set the
1983 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1986 set_GranSim_debug_options(nat n) {
1989 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1991 errorBelch(gran_debug_opts_strs[i]);
1993 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1994 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1995 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1996 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1997 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1998 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1999 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2000 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2001 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2002 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2003 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2004 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2005 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2006 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2007 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2008 default: barf("set_GranSim_debug_options: only %d debug options expected");
2014 Print one line explanation for each of the GranSim debug options specified
2018 help_GranSim_debug_options(nat n) {
2021 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2023 debugBelch(gran_debug_opts_strs[i]);
2029 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2032 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2033 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2037 /* Communication and task creation cost parameters */
2038 switch(rts_argv[arg][2]) {
2039 case 'e': /* -qe<n> ... allow <n> local sparks */
2040 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2041 RtsFlags.ParFlags.maxLocalSparks
2042 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2044 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2045 errorBelch("setupRtsFlags: bad value for -e\n");
2049 IF_PAR_DEBUG(verbose,
2050 errorBelch("-qe<n>: max %d local sparks",
2051 RtsFlags.ParFlags.maxLocalSparks));
2055 if (rts_argv[arg][3] != '\0') {
2056 RtsFlags.ParFlags.maxThreads
2057 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2059 errorBelch("missing size for -qt\n");
2062 IF_PAR_DEBUG(verbose,
2063 errorBelch("-qt<n>: max %d threads",
2064 RtsFlags.ParFlags.maxThreads));
2068 if (rts_argv[arg][3] != '\0')
2069 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2071 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2073 IF_PAR_DEBUG(verbose,
2074 errorBelch("-qf<n>: max %d fishes sent out at one time",
2075 RtsFlags.ParFlags.maxFishes));
2079 if (rts_argv[arg][3] != '\0') {
2080 RtsFlags.ParFlags.fishDelay
2081 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2083 errorBelch("missing fish delay time for -qF\n");
2086 IF_PAR_DEBUG(verbose,
2087 errorBelch("-qF<n>: fish delay time %d us",
2088 RtsFlags.ParFlags.fishDelay));
2092 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2093 IF_PAR_DEBUG(verbose,
2094 errorBelch("-qO: output disabled"));
2097 case 'g': /* -qg<n> ... globalisation scheme */
2098 if (rts_argv[arg][3] != '\0') {
2099 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2101 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2104 IF_PAR_DEBUG(verbose,
2105 debugBelch("-qg<n>: globalisation scheme set to %d",
2106 RtsFlags.ParFlags.globalising));
2109 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2110 if (rts_argv[arg][3] != '\0') {
2111 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2113 errorBelch("missing number of thunks per packet (for -qh)\n");
2116 IF_PAR_DEBUG(verbose,
2117 debugBelch("-qh<n>: thunks per packet set to %d",
2118 RtsFlags.ParFlags.thunksToPack));
2121 case 'P': /* -qP for writing a log file */
2122 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2123 /* same encoding as in GranSim after -bP */
2124 switch(rts_argv[arg][3]) {
2125 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2126 break; // nothing special, just an ordinary profile
2127 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2128 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2130 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2132 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2134 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2136 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2139 # if defined(PAR_TICKY)
2140 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2142 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2143 stg_exit(EXIT_FAILURE);
2146 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2148 IF_PAR_DEBUG(verbose,
2149 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2150 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2153 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2154 if (rts_argv[arg][3] != '\0') {
2155 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2157 errorBelch("missing size of PackBuffer (for -qQ)\n");
2160 IF_PAR_DEBUG(verbose,
2161 debugBelch("-qQ<n>: pack buffer size set to %d",
2162 RtsFlags.ParFlags.packBufferSize));
2166 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2167 IF_PAR_DEBUG(verbose,
2168 debugBelch("-qR: fair-ish scheduling"));
2173 if (rts_argv[arg][3] != '\0') {
2174 RtsFlags.ParFlags.wait
2175 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2177 RtsFlags.ParFlags.wait = 1000;
2179 IF_PAR_DEBUG(verbose,
2180 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2181 RtsFlags.ParFlags.wait));
2184 case 'D': /* -qD ... all the debugging options */
2185 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2186 /* hack warning: interpret the flags as a binary number */
2187 nat n = decode(rts_argv[arg]+3);
2188 set_par_debug_options(n);
2191 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2192 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2195 if (i==MAX_PAR_DEBUG_OPTION+1) {
2196 errorBelch("Valid GUM debug options are:\n");
2197 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2198 bad_option( rts_argv[arg] );
2199 } else { // flag found; now set it
2200 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2206 errorBelch("Unknown option -q%c (%d opts in total)",
2207 rts_argv[arg][2], *rts_argc);
2213 Interpret n as a binary number masking Par debug options and set the
2214 correxponding option. See par_debug_opts_strs for explanations of the flags.
2217 set_par_debug_options(nat n) {
2220 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2222 debugBelch(par_debug_opts_strs[i]);
2224 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2225 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2226 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2227 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2228 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2229 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2230 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2231 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2232 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2233 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2234 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2235 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2236 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2237 default: barf("set_par_debug_options: only %d debug options expected",
2238 MAX_PAR_DEBUG_OPTION);
2244 Print one line explanation for each of the GranSim debug options specified
2248 help_par_debug_options(nat n) {
2251 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2253 debugBelch(par_debug_opts_strs[i]);
2259 stats_fprintf(FILE *f, char *s, ...)
2271 static int /* return -1 on error */
2274 int argc, char *argv[],
2275 int rts_argc, char *rts_argv[],
2276 const char *FILENAME_FMT,
2281 if (strequal(rts_argv[arg]+2, "stderr")) { /* use debugBelch */
2282 f = NULL; /* NULL means use debugBelch */
2284 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2285 f = fopen(rts_argv[arg]+2,"w");
2287 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2288 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2289 f = fopen(stats_filename,"w");
2292 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2299 /* Write argv and rtsv into start of stats file */
2301 for(count = 0; count < argc; count++) {
2302 stats_fprintf(f, "%s ", argv[count]);
2304 stats_fprintf(f, "+RTS ");
2305 for(count = 0; count < rts_argc; count++)
2306 stats_fprintf(f, "%s ", rts_argv[count]);
2307 stats_fprintf(f, "\n");
2315 decode(const char *s)
2326 if (c == 'g' || c == 'G')
2327 m *= 1000*1000*1000; /* UNchecked! */
2328 else if (c == 'm' || c == 'M')
2329 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2330 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2331 m *= 1000; /* a direct-mapped cache. */
2332 else if (c == 'w' || c == 'W')
2339 bad_option(const char *s)
2341 errorBelch("bad RTS option: %s", s);
2342 stg_exit(EXIT_FAILURE);
2345 /* -----------------------------------------------------------------------------
2346 Getting/Setting the program's arguments.
2348 These are used by System.Environment, and parts of the RTS.
2349 -------------------------------------------------------------------------- */
2352 setProgName(char *argv[])
2354 /* Remove directory from argv[0] -- default files in current directory */
2355 #if !defined(mingw32_HOST_OS)
2357 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2358 prog_name = last_slash+1;
2360 prog_name = argv[0];
2363 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2364 while ( last_slash > argv[0] ) {
2365 if ( *last_slash == '/' || *last_slash == '\\' ) {
2366 prog_name = last_slash+1;
2371 prog_name = argv[0];
2376 getProgArgv(int *argc, char **argv[])
2378 if (argc) { *argc = prog_argc; }
2379 if (argv) { *argv = prog_argv; }
2383 setProgArgv(int argc, char *argv[])
2385 /* Usually this is done by startupHaskell, so we don't need to call this.
2386 However, sometimes Hugs wants to change the arguments which Haskell
2387 getArgs >>= ... will be fed. So you can do that by calling here
2388 _after_ calling startupHaskell.
2392 setProgName(prog_argv);