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 RtsFlags.GcFlags.sweep = rtsFalse;
151 #ifdef RTS_GTK_FRONTPANEL
152 RtsFlags.GcFlags.frontpanel = rtsFalse;
154 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
157 /* ToDo: Perhaps by adjusting this value we can make linking without
158 * -static work (i.e., not generate a core-dumping executable)? */
159 # if SIZEOF_VOID_P == 8
160 RtsFlags.GcFlags.heapBase = 0x180000000L;
162 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
165 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
169 RtsFlags.DebugFlags.scheduler = rtsFalse;
170 RtsFlags.DebugFlags.interpreter = rtsFalse;
171 RtsFlags.DebugFlags.weak = rtsFalse;
172 RtsFlags.DebugFlags.gccafs = rtsFalse;
173 RtsFlags.DebugFlags.gc = rtsFalse;
174 RtsFlags.DebugFlags.block_alloc = rtsFalse;
175 RtsFlags.DebugFlags.sanity = rtsFalse;
176 RtsFlags.DebugFlags.stable = rtsFalse;
177 RtsFlags.DebugFlags.stm = rtsFalse;
178 RtsFlags.DebugFlags.prof = rtsFalse;
179 RtsFlags.DebugFlags.gran = rtsFalse;
180 RtsFlags.DebugFlags.par = rtsFalse;
181 RtsFlags.DebugFlags.linker = rtsFalse;
182 RtsFlags.DebugFlags.squeeze = rtsFalse;
183 RtsFlags.DebugFlags.hpc = rtsFalse;
186 #if defined(PROFILING) || defined(PAR)
187 RtsFlags.CcFlags.doCostCentres = 0;
188 #endif /* PROFILING or PAR */
190 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
191 RtsFlags.ProfFlags.profileInterval = 100;
194 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
195 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
196 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
197 RtsFlags.ProfFlags.ccsLength = 25;
198 RtsFlags.ProfFlags.modSelector = NULL;
199 RtsFlags.ProfFlags.descrSelector = NULL;
200 RtsFlags.ProfFlags.typeSelector = NULL;
201 RtsFlags.ProfFlags.ccSelector = NULL;
202 RtsFlags.ProfFlags.ccsSelector = NULL;
203 RtsFlags.ProfFlags.retainerSelector = NULL;
204 RtsFlags.ProfFlags.bioSelector = NULL;
207 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
208 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
210 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
213 RtsFlags.ParFlags.nNodes = 1;
214 RtsFlags.ParFlags.migrate = rtsTrue;
215 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
216 RtsFlags.ParFlags.gcThreads = 1;
220 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
221 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
222 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
223 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
224 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
225 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
226 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
228 RtsFlags.ParFlags.outputDisabled = rtsFalse;
230 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
232 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
234 RtsFlags.ParFlags.packBufferSize = 1024;
235 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
236 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
237 RtsFlags.ParFlags.maxThreads = 1024;
238 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
239 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
242 #if defined(PAR) || defined(THREADED_RTS)
243 RtsFlags.ParFlags.maxLocalSparks = 4096;
244 #endif /* PAR || THREADED_RTS */
247 /* ToDo: check defaults for GranSim and GUM */
248 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
249 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
251 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
252 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
253 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
254 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
255 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
256 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
257 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
258 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
260 RtsFlags.GranFlags.packBufferSize = 1024;
261 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
263 RtsFlags.GranFlags.proc = MAX_PROC;
264 RtsFlags.GranFlags.Fishing = rtsFalse;
265 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
266 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
267 RtsFlags.GranFlags.Light = rtsFalse;
269 RtsFlags.GranFlags.Costs.latency = LATENCY;
270 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
271 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
272 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
273 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
274 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
275 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
276 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
278 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
279 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
280 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
281 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
282 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
284 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
285 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
286 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
287 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
288 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
290 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
292 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
293 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
295 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
296 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
297 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
298 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
299 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
300 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
301 RtsFlags.GranFlags.FetchStrategy = 2;
302 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
303 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
304 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
305 RtsFlags.GranFlags.SparkPriority = 0;
306 RtsFlags.GranFlags.SparkPriority2 = 0;
307 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
308 RtsFlags.GranFlags.InversePriorities = rtsFalse;
309 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
310 RtsFlags.GranFlags.ThunksToPack = 0;
311 RtsFlags.GranFlags.RandomSteal = rtsTrue;
315 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
316 RtsFlags.TickyFlags.tickyFile = NULL;
319 RtsFlags.TraceFlags.timestamp = rtsFalse;
320 RtsFlags.TraceFlags.sched = rtsFalse;
321 RtsFlags.TraceFlags.gc = rtsFalse;
324 /* By default no special measurements taken */
325 RtsFlags.PapiFlags.eventType = 0;
326 RtsFlags.PapiFlags.numUserEvents = 0;
333 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
335 " +RTS Indicates run time system options follow",
336 " -RTS Indicates program arguments follow",
337 " --RTS Indicates that ALL subsequent arguments will be given to the",
338 " program (including any of these RTS flags)",
340 "The following run time system options are available:",
342 " -? Prints this message and exits; the program is not executed",
343 " --info Print information about the RTS used by this program",
345 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
346 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
348 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
349 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
350 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
351 " -m<n> Minimum % of heap which must be available (default 3%)",
352 " -G<n> Number of generations (default: 2)",
353 " -T<n> Number of steps in younger generations (default: 2)",
354 " -c<n> Auto-enable compaction of the oldest generation when live data is",
355 " at least <n>% of the maximum heap size set with -M (default: 30%)",
356 " -c Enable compaction for all major collections",
357 " -w Use mark-region for the oldest generation (experimental)",
358 #if defined(THREADED_RTS)
359 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
362 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
363 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
364 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
365 #ifdef RTS_GTK_FRONTPANEL
366 " -f Display front panel (requires X11 & GTK+)",
370 " -Z Don't squeeze out update frames on stack overflow",
371 " -B Sound the bell at the start of each garbage collection",
372 #if defined(PROFILING) || defined(PAR)
374 " -px Time/allocation profile (XML) (output file <program>.prof)",
375 " -p Time/allocation profile (output file <program>.prof)",
376 " -P More detailed Time/Allocation profile",
377 " -Pa Give information about *all* cost centres",
379 # if defined(PROFILING)
381 " -hx Heap residency profile (XML) (output file <program>.prof)",
382 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
383 " break-down: c = cost centre stack (default)",
385 " d = closure description",
386 " y = type description",
388 " b = biography (LAG,DRAG,VOID,USE)",
389 " A subset of closures may be selected thusly:",
390 " -hc<cc>,... specific cost centre(s) (top of stack only)",
391 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
392 " -hm<mod>... all cost centres from the specified modules(s)",
393 " -hd<des>,... closures with specified closure descriptions",
394 " -hy<typ>... closures with specified type descriptions",
395 " -hr<cc>... closures with specified retainers",
396 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
398 " -R<size> Set the maximum retainer set size (default: 8)",
400 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
403 " -xt Include threads (TSOs) in a heap profile",
405 " -xc Show current cost centre stack on raising an exception",
408 #endif /* PROFILING or PAR */
409 #if !defined(PROFILING)
411 " -hT Heap residency profile (output file <program>.hp)",
413 " -i<sec> Time between heap samples (seconds, default: 0.1)",
415 #if defined(TICKY_TICKY)
416 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
420 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
421 /* NB: the -N<n> is implemented by the driver!! */
423 " -C<secs> Context-switch interval in seconds.",
424 " 0 or no argument means switch as often as possible.",
425 " Default: 0.02 sec; resolution is set by -V below.",
426 " -V<secs> Master tick interval in seconds (0 == disable timer).",
427 " This sets the resolution for -C and the profile timer -i.",
428 " Default: 0.02 sec.",
430 " -vs Trace scheduler events (see also -Ds with -debug)",
431 " -vt Time-stamp trace messages",
434 " -Ds DEBUG: scheduler",
435 " -Di DEBUG: interpreter",
437 " -DG DEBUG: gccafs",
440 " -DS DEBUG: sanity",
441 " -Dt DEBUG: stable",
445 " -Dl DEBUG: linker",
447 " -Dz DEBUG: stack squezing",
448 " -Dc DEBUG: program coverage",
451 #if defined(THREADED_RTS) && !defined(NOSMP)
452 " -N<n> Use <n> OS threads (default: 1) (also sets -g)",
453 " -g<n> Use <n> OS threads for GC (default: 1)",
454 " -qm Don't automatically migrate threads between CPUs",
455 " -qw Migrate a thread to the current CPU when it is woken up",
457 " --install-signal-handlers=<yes|no>",
458 " Install signal handlers (default: yes)",
459 #if defined(THREADED_RTS) || defined(PAR)
460 " -e<size> Size of spark pools (default 100)",
463 " -t<num> Set maximum number of advisory threads per PE (default 32)",
464 " -qP Enable activity profile (output files in ~/<program>*.gr)",
465 " -qQ<size> Set pack-buffer size (default: 1024)",
466 " -qd Turn on PVM-ish debugging",
467 " -qO Disable output for performance measurement",
469 #if defined(THREADED_RTS) || defined(PAR)
470 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
473 " -d Turn on PVM-ish debugging",
474 " -O Disable output for performance measurement",
476 #if defined(GRAN) /* ToDo: fill in decent Docu here */
477 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
479 #if defined(USE_PAPI)
480 " -aX CPU performance counter measurements using PAPI",
481 " (use with the -s<file> option). X is one of:",
484 " 1 - level 1 cache misses",
485 " 2 - level 2 cache misses",
486 " b - branch mispredictions",
487 " s - stalled cycles",
488 " e - cache miss and branch misprediction events",
491 "RTS options may also be specified using the GHCRTS environment variable.",
493 "Other RTS options may be available for programs compiled a different way.",
494 "The GHC User's Guide has full details.",
499 STATIC_INLINE rtsBool
500 strequal(const char *a, const char * b)
502 return(strcmp(a, b) == 0);
506 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
512 while (isspace(*c1)) { c1++; };
514 while (!isspace(*c2) && *c2 != '\0') { c2++; };
516 if (c1 == c2) { break; }
518 if (*rts_argc < MAX_RTS_ARGS-1) {
519 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
520 strncpy(s, c1, c2-c1);
522 rts_argv[(*rts_argc)++] = s;
524 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
528 } while (*c1 != '\0');
532 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
534 rtsBool error = rtsFalse;
545 // process arguments from the ghc_rts_opts global variable first.
546 // (arguments from the GHCRTS environment variable and the command
547 // line override these).
549 if (ghc_rts_opts != NULL) {
550 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
554 // process arguments from the GHCRTS environment variable next
555 // (arguments from the command line override these).
557 char *ghc_rts = getenv("GHCRTS");
559 if (ghc_rts != NULL) {
560 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
564 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
565 // argv[0] must be PGM argument -- leave in argv
567 for (mode = PGM; arg < total_arg; arg++) {
568 // The '--RTS' argument disables all future +RTS ... -RTS processing.
569 if (strequal("--RTS", argv[arg])) {
573 // The '--' argument is passed through to the program, but
574 // disables all further +RTS ... -RTS processing.
575 else if (strequal("--", argv[arg])) {
578 else if (strequal("+RTS", argv[arg])) {
581 else if (strequal("-RTS", argv[arg])) {
584 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
585 rts_argv[(*rts_argc)++] = argv[arg];
587 else if (mode == PGM) {
588 argv[(*argc)++] = argv[arg];
591 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
594 // process remaining program arguments
595 for (; arg < total_arg; arg++) {
596 argv[(*argc)++] = argv[arg];
598 argv[*argc] = (char *) 0;
599 rts_argv[*rts_argc] = (char *) 0;
601 // Process RTS (rts_argv) part: mainly to determine statsfile
602 for (arg = 0; arg < *rts_argc; arg++) {
603 if (rts_argv[arg][0] != '-') {
605 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
609 switch(rts_argv[arg][1]) {
611 /* process: general args, then PROFILING-only ones,
612 then CONCURRENT-only, PARallel-only, GRAN-only,
613 TICKY-only (same order as defined in RtsFlags.lh);
614 within those groups, mostly in case-insensitive
616 Final group is x*, which allows for more options.
620 # define TICKY_BUILD_ONLY(x) x
622 # define TICKY_BUILD_ONLY(x) \
623 errorBelch("not built for: ticky-ticky stats"); \
627 #if defined(PROFILING)
628 # define COST_CENTRE_USING_BUILD_ONLY(x) x
630 # define COST_CENTRE_USING_BUILD_ONLY(x) \
631 errorBelch("not built for: -prof or -parallel"); \
636 # define PROFILING_BUILD_ONLY(x) x
638 # define PROFILING_BUILD_ONLY(x) \
639 errorBelch("not built for: -prof"); \
644 # define PAR_BUILD_ONLY(x) x
646 # define PAR_BUILD_ONLY(x) \
647 errorBelch("not built for: -parallel"); \
652 # define THREADED_BUILD_ONLY(x) x
654 # define THREADED_BUILD_ONLY(x) \
655 errorBelch("not built for: -smp"); \
659 #if defined(THREADED_RTS) || defined(PAR)
660 # define PAR_OR_THREADED_BUILD_ONLY(x) x
662 # define PAR_OR_THREADED_BUILD_ONLY(x) \
663 errorBelch("not built for: -parallel or -smp"); \
668 # define GRAN_BUILD_ONLY(x) x
670 # define GRAN_BUILD_ONLY(x) \
671 errorBelch("not built for: -gransim"); \
675 /* =========== GENERAL ========================== */
680 /* This isn't going to allow us to keep related options
681 together as we add more --* flags. We really need a
682 proper options parser. */
684 if (strequal("install-signal-handlers=yes",
685 &rts_argv[arg][2])) {
686 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
688 else if (strequal("install-signal-handlers=no",
689 &rts_argv[arg][2])) {
690 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
692 else if (strequal("info",
693 &rts_argv[arg][2])) {
698 errorBelch("unknown RTS option: %s",rts_argv[arg]);
703 RtsFlags.GcFlags.minAllocAreaSize
704 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
705 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
706 bad_option(rts_argv[arg]);
712 switch(rts_argv[arg][2]) {
714 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
717 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
720 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
723 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
726 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
729 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
730 errorBelch("maximum number of PAPI events reached");
731 stg_exit(EXIT_FAILURE);
733 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
734 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
737 bad_option( rts_argv[arg] );
743 RtsFlags.GcFlags.ringBell = rtsTrue;
747 if (rts_argv[arg][2] != '\0') {
748 RtsFlags.GcFlags.compactThreshold =
749 atof(rts_argv[arg]+2);
751 RtsFlags.GcFlags.compact = rtsTrue;
756 RtsFlags.GcFlags.sweep = rtsTrue;
760 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
762 if (RtsFlags.GcFlags.oldGenFactor < 0)
763 bad_option( rts_argv[arg] );
771 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
774 RtsFlags.DebugFlags.scheduler = rtsTrue;
777 RtsFlags.DebugFlags.interpreter = rtsTrue;
780 RtsFlags.DebugFlags.weak = rtsTrue;
783 RtsFlags.DebugFlags.gccafs = rtsTrue;
786 RtsFlags.DebugFlags.gc = rtsTrue;
789 RtsFlags.DebugFlags.block_alloc = rtsTrue;
792 RtsFlags.DebugFlags.sanity = rtsTrue;
795 RtsFlags.DebugFlags.stable = rtsTrue;
798 RtsFlags.DebugFlags.prof = rtsTrue;
801 RtsFlags.DebugFlags.gran = rtsTrue;
804 RtsFlags.DebugFlags.par = rtsTrue;
807 RtsFlags.DebugFlags.linker = rtsTrue;
810 RtsFlags.DebugFlags.apply = rtsTrue;
813 RtsFlags.DebugFlags.stm = rtsTrue;
816 RtsFlags.DebugFlags.squeeze = rtsTrue;
819 RtsFlags.DebugFlags.hpc = rtsTrue;
822 bad_option( rts_argv[arg] );
830 RtsFlags.GcFlags.maxStkSize =
831 decode(rts_argv[arg]+2) / sizeof(W_);
833 if (RtsFlags.GcFlags.maxStkSize == 0)
834 bad_option( rts_argv[arg] );
838 RtsFlags.GcFlags.initialStkSize =
839 decode(rts_argv[arg]+2) / sizeof(W_);
841 if (RtsFlags.GcFlags.initialStkSize == 0)
842 bad_option( rts_argv[arg] );
846 RtsFlags.GcFlags.maxHeapSize =
847 decode(rts_argv[arg]+2) / BLOCK_SIZE;
848 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
850 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
851 bad_option(rts_argv[arg]);
856 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
858 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
859 RtsFlags.GcFlags.pcFreeHeap > 100)
860 bad_option( rts_argv[arg] );
864 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
865 if (RtsFlags.GcFlags.generations < 1) {
866 bad_option(rts_argv[arg]);
871 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
872 if (RtsFlags.GcFlags.steps < 1) {
873 bad_option(rts_argv[arg]);
878 RtsFlags.GcFlags.heapSizeSuggestion =
879 decode(rts_argv[arg]+2) / BLOCK_SIZE;
882 #ifdef RTS_GTK_FRONTPANEL
884 RtsFlags.GcFlags.frontpanel = rtsTrue;
888 case 'I': /* idle GC delay */
889 if (rts_argv[arg][2] == '\0') {
894 /* Convert to millisecs */
895 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
896 RtsFlags.GcFlags.idleGCDelayTime = cst;
901 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
905 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
909 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
914 /* Opening all those files would almost certainly fail... */
915 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
916 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
920 r = open_stats_file(arg, *argc, argv,
921 *rts_argc, rts_argv, NULL,
922 &RtsFlags.GcFlags.statsFile);
923 if (r == -1) { error = rtsTrue; }
929 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
932 /* =========== PROFILING ========================== */
934 case 'P': /* detailed cost centre profiling (time/alloc) */
935 case 'p': /* cost centre profiling (time/alloc) */
936 COST_CENTRE_USING_BUILD_ONLY(
937 switch (rts_argv[arg][2]) {
939 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
942 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
945 if (rts_argv[arg][1] == 'P') {
946 RtsFlags.CcFlags.doCostCentres =
947 COST_CENTRES_VERBOSE;
949 RtsFlags.CcFlags.doCostCentres =
950 COST_CENTRES_SUMMARY;
957 PROFILING_BUILD_ONLY(
958 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
961 PROFILING_BUILD_ONLY(
962 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
963 if(RtsFlags.ProfFlags.ccsLength <= 0) {
964 bad_option(rts_argv[arg]);
967 case 'h': /* serial heap profile */
968 #if !defined(PROFILING)
969 switch (rts_argv[arg][2]) {
972 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
975 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
979 PROFILING_BUILD_ONLY(
980 switch (rts_argv[arg][2]) {
994 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
996 char *left = strchr(rts_argv[arg], '{');
997 char *right = strrchr(rts_argv[arg], '}');
999 // curly braces are optional, for
1000 // backwards compat.
1004 left = rts_argv[arg] + 3;
1007 right = rts_argv[arg] + strlen(rts_argv[arg]);
1011 switch (rts_argv[arg][2]) {
1012 case 'c': // cost centre label select
1013 RtsFlags.ProfFlags.ccSelector = left;
1016 RtsFlags.ProfFlags.ccsSelector = left;
1019 case 'm': // cost centre module select
1020 RtsFlags.ProfFlags.modSelector = left;
1023 case 'd': // closure descr select
1024 RtsFlags.ProfFlags.descrSelector = left;
1027 case 'y': // closure type select
1028 RtsFlags.ProfFlags.typeSelector = left;
1031 case 'r': // retainer select
1032 RtsFlags.ProfFlags.retainerSelector = left;
1035 case 'b': // biography select
1036 RtsFlags.ProfFlags.bioSelector = left;
1043 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1044 errorBelch("multiple heap profile options");
1049 switch (rts_argv[arg][2]) {
1053 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1057 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1061 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1065 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1069 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1073 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1079 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1083 #endif /* PROFILING */
1086 case 'i': /* heap sample interval */
1087 if (rts_argv[arg][2] == '\0') {
1092 /* Convert to milliseconds */
1093 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1094 RtsFlags.ProfFlags.profileInterval = cst;
1098 /* =========== CONCURRENT ========================= */
1099 case 'C': /* context switch interval */
1100 if (rts_argv[arg][2] == '\0')
1101 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1105 /* Convert to milliseconds */
1106 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1107 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1111 case 'V': /* master tick interval */
1112 if (rts_argv[arg][2] == '\0') {
1113 // turns off ticks completely
1114 RtsFlags.MiscFlags.tickInterval = 0;
1118 /* Convert to milliseconds */
1119 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1120 RtsFlags.MiscFlags.tickInterval = cst;
1124 #if defined(THREADED_RTS) && !defined(NOSMP)
1126 THREADED_BUILD_ONLY(
1127 if (rts_argv[arg][2] != '\0') {
1128 RtsFlags.ParFlags.nNodes
1129 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1130 // set -g at the same time as -N by default
1131 RtsFlags.ParFlags.gcThreads = RtsFlags.ParFlags.nNodes;
1132 if (RtsFlags.ParFlags.nNodes <= 0) {
1133 errorBelch("bad value for -N");
1136 #if defined(PROFILING)
1137 if (RtsFlags.ParFlags.nNodes > 1) {
1138 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1146 THREADED_BUILD_ONLY(
1147 if (rts_argv[arg][2] != '\0') {
1148 RtsFlags.ParFlags.gcThreads
1149 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1150 if (RtsFlags.ParFlags.nNodes <= 0) {
1151 errorBelch("bad value for -g");
1158 switch (rts_argv[arg][2]) {
1160 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1164 RtsFlags.ParFlags.migrate = rtsFalse;
1167 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1170 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1176 /* =========== PARALLEL =========================== */
1178 PAR_OR_THREADED_BUILD_ONLY(
1179 if (rts_argv[arg][2] != '\0') {
1180 RtsFlags.ParFlags.maxLocalSparks
1181 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1182 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1183 errorBelch("bad value for -e");
1192 process_par_option(arg, rts_argc, rts_argv, &error);
1196 /* =========== GRAN =============================== */
1200 process_gran_option(arg, rts_argc, rts_argv, &error);
1203 /* =========== TICKY ============================== */
1205 case 'r': /* Basic profiling stats */
1208 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1212 r = open_stats_file(arg, *argc, argv,
1213 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1214 &RtsFlags.TickyFlags.tickyFile);
1215 if (r == -1) { error = rtsTrue; }
1219 /* =========== TRACING ---------=================== */
1222 switch(rts_argv[arg][2]) {
1224 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1228 RtsFlags.TraceFlags.timestamp = rtsTrue;
1231 RtsFlags.TraceFlags.sched = rtsTrue;
1234 RtsFlags.TraceFlags.gc = rtsTrue;
1237 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1243 /* =========== EXTENDED OPTIONS =================== */
1245 case 'x': /* Extend the argument space */
1246 switch(rts_argv[arg][2]) {
1248 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1252 case 'b': /* heapBase in hex; undocumented */
1253 if (rts_argv[arg][3] != '\0') {
1254 RtsFlags.GcFlags.heapBase
1255 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1257 errorBelch("-xb: requires argument");
1262 case 'c': /* Debugging tool: show current cost centre on an exception */
1263 PROFILING_BUILD_ONLY(
1264 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1268 case 't': /* Include memory used by TSOs in a heap profile */
1269 PROFILING_BUILD_ONLY(
1270 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1274 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1277 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1281 break; /* defensive programming */
1283 /* =========== OH DEAR ============================ */
1285 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1292 if (RtsFlags.MiscFlags.tickInterval < 0) {
1293 RtsFlags.MiscFlags.tickInterval = 50;
1296 // If the master timer is disabled, turn off the other timers.
1297 if (RtsFlags.MiscFlags.tickInterval == 0) {
1298 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1299 RtsFlags.GcFlags.idleGCDelayTime = 0;
1300 RtsFlags.ProfFlags.profileInterval = 0;
1303 // Determine what tick interval we should use for the RTS timer
1304 // by taking the shortest of the various intervals that we need to
1306 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1307 RtsFlags.MiscFlags.tickInterval =
1308 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1309 RtsFlags.MiscFlags.tickInterval);
1312 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1313 RtsFlags.MiscFlags.tickInterval =
1314 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1315 RtsFlags.MiscFlags.tickInterval);
1318 if (RtsFlags.ProfFlags.profileInterval > 0) {
1319 RtsFlags.MiscFlags.tickInterval =
1320 stg_min(RtsFlags.ProfFlags.profileInterval,
1321 RtsFlags.MiscFlags.tickInterval);
1324 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1325 RtsFlags.ConcFlags.ctxtSwitchTicks =
1326 RtsFlags.ConcFlags.ctxtSwitchTime /
1327 RtsFlags.MiscFlags.tickInterval;
1329 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1332 if (RtsFlags.ProfFlags.profileInterval > 0) {
1333 RtsFlags.ProfFlags.profileIntervalTicks =
1334 RtsFlags.ProfFlags.profileInterval /
1335 RtsFlags.MiscFlags.tickInterval;
1337 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1344 for (p = usage_text; *p; p++)
1345 errorBelch("%s", *p);
1346 stg_exit(EXIT_FAILURE);
1353 enable_GranSimLight(void) {
1355 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1356 RtsFlags.GranFlags.Light=rtsTrue;
1357 RtsFlags.GranFlags.Costs.latency =
1358 RtsFlags.GranFlags.Costs.fetchtime =
1359 RtsFlags.GranFlags.Costs.additional_latency =
1360 RtsFlags.GranFlags.Costs.gunblocktime =
1361 RtsFlags.GranFlags.Costs.lunblocktime =
1362 RtsFlags.GranFlags.Costs.threadcreatetime =
1363 RtsFlags.GranFlags.Costs.threadqueuetime =
1364 RtsFlags.GranFlags.Costs.threadscheduletime =
1365 RtsFlags.GranFlags.Costs.threaddescheduletime =
1366 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1368 RtsFlags.GranFlags.Costs.mpacktime =
1369 RtsFlags.GranFlags.Costs.munpacktime = 0;
1371 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1372 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1373 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1374 /* FetchStrategy is irrelevant in GrAnSim-Light */
1376 /* GrAnSim Light often creates an abundance of parallel threads,
1377 each with its own stack etc. Therefore, it's in general a good
1378 idea to use small stack chunks (use the -o<size> option to
1381 // RtsFlags.ConcFlags.stkChunkSize = 100;
1383 RtsFlags.GranFlags.proc = 1;
1387 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1389 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1392 /* or a ridiculously idealised simulator */
1393 if(strcmp((rts_argv[arg]+2),"oring")==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.arith_cost =
1409 RtsFlags.GranFlags.Costs.float_cost =
1410 RtsFlags.GranFlags.Costs.load_cost =
1411 RtsFlags.GranFlags.Costs.store_cost =
1412 RtsFlags.GranFlags.Costs.branch_cost = 0;
1414 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1416 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1417 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1418 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1419 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1423 /* or a somewhat idealised simulator */
1424 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1425 RtsFlags.GranFlags.Costs.latency =
1426 RtsFlags.GranFlags.Costs.fetchtime =
1427 RtsFlags.GranFlags.Costs.additional_latency =
1428 RtsFlags.GranFlags.Costs.gunblocktime =
1429 RtsFlags.GranFlags.Costs.lunblocktime =
1430 RtsFlags.GranFlags.Costs.threadcreatetime =
1431 RtsFlags.GranFlags.Costs.threadqueuetime =
1432 RtsFlags.GranFlags.Costs.threadscheduletime =
1433 RtsFlags.GranFlags.Costs.threaddescheduletime =
1434 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1436 RtsFlags.GranFlags.Costs.mpacktime =
1437 RtsFlags.GranFlags.Costs.munpacktime = 0;
1439 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1441 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1442 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1443 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1444 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1445 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1446 # if defined(GRAN_CHECK) && defined(GRAN)
1447 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1452 /* Communication and task creation cost parameters */
1453 switch(rts_argv[arg][2]) {
1455 IgnoreYields = rtsTrue; // HWL HACK
1459 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1463 if (rts_argv[arg][3] != '\0')
1465 RtsFlags.GranFlags.Costs.gunblocktime =
1466 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1467 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1470 RtsFlags.GranFlags.Costs.latency = LATENCY;
1474 if (rts_argv[arg][3] != '\0')
1475 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1477 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1481 if (rts_argv[arg][3] != '\0')
1482 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1484 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1488 if (rts_argv[arg][3] != '\0')
1489 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1491 RtsFlags.GranFlags.Costs.mtidytime = 0;
1495 if (rts_argv[arg][3] != '\0')
1496 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1498 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1502 if (rts_argv[arg][3] != '\0')
1503 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1505 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1509 if (rts_argv[arg][3] != '\0')
1510 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1512 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1516 if (rts_argv[arg][3] != '\0')
1517 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1519 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1522 /* Thread-related metrics */
1524 if (rts_argv[arg][3] != '\0')
1525 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1527 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1531 if (rts_argv[arg][3] != '\0')
1532 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1534 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1538 if (rts_argv[arg][3] != '\0')
1539 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1541 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1543 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1544 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1548 if (rts_argv[arg][3] != '\0')
1549 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1551 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1553 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1554 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1557 /* Instruction Cost Metrics */
1559 if (rts_argv[arg][3] != '\0')
1560 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1562 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1566 if (rts_argv[arg][3] != '\0')
1567 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1569 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1573 if (rts_argv[arg][3] != '\0')
1574 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1576 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1580 if (rts_argv[arg][3] != '\0')
1581 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1583 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1587 if (rts_argv[arg][3] != '\0')
1588 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1590 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1594 if (rts_argv[arg][3] != '\0')
1595 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1597 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1601 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1602 if (rts_argv[arg][3] != '\0')
1603 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1605 RtsFlags.GranFlags.FetchStrategy = 2;
1606 if (RtsFlags.GranFlags.FetchStrategy == 0)
1607 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1610 case 'K': /* sort overhead (per elem in spark list) */
1611 if (rts_argv[arg][3] != '\0')
1612 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1614 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1615 debugBelch("Overhead for pri spark: %d (per elem).\n",
1616 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1619 case 'O': /* sort overhead (per elem in spark list) */
1620 if (rts_argv[arg][3] != '\0')
1621 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1623 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1624 debugBelch("Overhead for pri sched: %d (per elem).\n",
1625 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1628 /* General Parameters */
1630 if (rts_argv[arg][3] != '\0')
1632 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1633 if (RtsFlags.GranFlags.proc==0) {
1634 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1635 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1636 RtsFlags.GranFlags.proc < 1)
1638 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1644 RtsFlags.GranFlags.proc = MAX_PROC;
1648 RtsFlags.GranFlags.Fishing = rtsTrue;
1649 if (rts_argv[arg][3] != '\0')
1650 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1652 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1656 if (rts_argv[arg][3] != '\0')
1657 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1659 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1663 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1664 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1668 debugBelch("Bulk fetching enabled.\n");
1669 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1673 debugBelch("Thread migration enabled.\n");
1674 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1678 debugBelch("Fair Scheduling enabled.\n");
1679 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1683 debugBelch("Priority Scheduling enabled.\n");
1684 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1688 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1689 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1693 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1697 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1701 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1705 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1709 /* format is -bP<c> where <c> is one char describing kind of profile */
1710 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1711 switch(rts_argv[arg][3]) {
1712 case '\0': break; // nothing special, just an ordinary profile
1713 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1715 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1717 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1719 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1721 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1723 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1725 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1730 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1734 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1737 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1738 if (rts_argv[arg][3] != '\0') {
1741 arg0 = rts_argv[arg]+3;
1742 if ((tmp = strstr(arg0,","))==NULL) {
1743 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1744 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1747 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1748 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1749 debugBelch("SparkPriority: %u.\n",
1750 RtsFlags.GranFlags.SparkPriority);
1751 debugBelch("SparkPriority2:%u.\n",
1752 RtsFlags.GranFlags.SparkPriority2);
1753 if (RtsFlags.GranFlags.SparkPriority2 <
1754 RtsFlags.GranFlags.SparkPriority) {
1755 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1756 RtsFlags.GranFlags.SparkPriority2,
1757 RtsFlags.GranFlags.SparkPriority);
1761 /* plain pri spark is now invoked with -bX
1762 RtsFlags.GranFlags.DoPrioritySparking = 1;
1763 debugBelch("PrioritySparking.\n");
1769 if (rts_argv[arg][3] != '\0') {
1770 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1772 RtsFlags.GranFlags.ThunksToPack = 1;
1774 debugBelch("Thunks To Pack in one packet: %u.\n",
1775 RtsFlags.GranFlags.ThunksToPack);
1779 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1780 debugBelch("Deterministic mode (no random stealing)\n");
1783 /* The following class of options contains eXperimental */
1784 /* features in connection with exploiting granularity */
1785 /* information. I.e. if -bY is chosen these options */
1786 /* tell the RTS what to do with the supplied info --HWL */
1789 if (rts_argv[arg][3] != '\0') {
1790 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1792 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1794 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1795 RtsFlags.GranFlags.packBufferSize_internal);
1799 switch(rts_argv[arg][3]) {
1802 RtsFlags.GranFlags.DoPrioritySparking = 1;
1803 debugBelch("Priority Sparking with Normal Priorities.\n");
1804 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1805 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1806 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1810 RtsFlags.GranFlags.DoPrioritySparking = 1;
1811 debugBelch("Priority Sparking with Inverse Priorities.\n");
1812 RtsFlags.GranFlags.InversePriorities++;
1816 RtsFlags.GranFlags.DoPrioritySparking = 1;
1817 debugBelch("Priority Sparking with Random Priorities.\n");
1818 RtsFlags.GranFlags.RandomPriorities++;
1822 RtsFlags.GranFlags.DoPrioritySparking = 1;
1823 debugBelch("Priority Sparking with No Priorities.\n");
1824 RtsFlags.GranFlags.IgnorePriorities++;
1828 bad_option( rts_argv[arg] );
1834 switch(rts_argv[arg][3]) {
1837 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1838 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1842 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1846 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1850 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1854 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1855 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1859 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1863 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1867 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1871 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1875 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1879 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1883 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1887 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1888 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1892 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1896 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1900 bad_option( rts_argv[arg] );
1905 # if defined(GRAN_CHECK) && defined(GRAN)
1907 switch(rts_argv[arg][3]) {
1908 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1909 if (rts_argv[arg][4] != '\0') {
1910 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1911 debugBelch("Pack buffer size: %d\n",
1912 RtsFlags.GranFlags.packBufferSize);
1914 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1920 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1921 /* hack warning: interpret the flags as a binary number */
1922 nat n = decode(rts_argv[arg]+3);
1923 set_GranSim_debug_options(n);
1926 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1927 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1930 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1931 debugBelch("Valid GranSim debug options are:\n");
1932 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1933 bad_option( rts_argv[arg] );
1934 } else { // flag found; now set it
1935 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1941 case 'e': /* event trace; also -bD1 */
1942 debugBelch("DEBUG: event_trace; printing event trace.\n");
1943 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1944 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1947 case 'E': /* event statistics; also -bD2 */
1948 debugBelch("DEBUG: event_stats; printing event statistics.\n");
1949 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1950 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1953 case 'f': /* thunkStealing; also -bD4 */
1954 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1955 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1956 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1959 case 'z': /* blockOnFetch; also -bD8 */
1960 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1961 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1962 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1965 case 't': /* blockOnFetch_sanity; also -bD16 */
1966 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1967 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1968 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1971 case 'S': /* priSpark; also -bD32 */
1972 debugBelch("DEBUG: priSpark; priority sparking.\n");
1973 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1976 case 's': /* priSched; also -bD64 */
1977 debugBelch("DEBUG: priSched; priority scheduling.\n");
1978 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1981 case 'F': /* findWork; also -bD128 */
1982 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1983 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1986 case 'g': /* globalBlock; also -bD256 */
1987 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1988 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1991 case 'G': /* pack; also -bD512 */
1992 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
1993 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1996 case 'P': /* packBuffer; also -bD1024 */
1997 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1998 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
2001 case 'o': /* sortedQ; also -bD2048 */
2002 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
2003 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
2006 case 'r': /* randomSteal; also -bD4096 */
2007 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2008 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2011 case 'q': /* checkSparkQ; also -bD8192 */
2012 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2013 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2016 case ':': /* checkLight; also -bD16384 */
2017 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2018 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2021 case 'b': /* bq; also -bD32768 */
2022 debugBelch("DEBUG: bq; check blocking queues\n");
2023 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2026 case 'd': /* all options turned on */
2027 debugBelch("DEBUG: all options turned on.\n");
2028 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2029 /* RtsFlags.GranFlags.Debug |= 0x40; */
2033 /* RtsFlags.GranFlags.Debug = 1; */
2039 # endif /* GRAN_CHECK */
2041 bad_option( rts_argv[arg] );
2047 Interpret n as a binary number masking GranSim debug options and set the
2048 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2051 set_GranSim_debug_options(nat n) {
2054 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2056 errorBelch(gran_debug_opts_strs[i]);
2058 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2059 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2060 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2061 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2062 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2063 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2064 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2065 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2066 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2067 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2068 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2069 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2070 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2071 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2072 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2073 default: barf("set_GranSim_debug_options: only %d debug options expected");
2079 Print one line explanation for each of the GranSim debug options specified
2083 help_GranSim_debug_options(nat n) {
2086 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2088 debugBelch(gran_debug_opts_strs[i]);
2094 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2097 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2098 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2102 /* Communication and task creation cost parameters */
2103 switch(rts_argv[arg][2]) {
2104 case 'e': /* -qe<n> ... allow <n> local sparks */
2105 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2106 RtsFlags.ParFlags.maxLocalSparks
2107 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2109 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2110 errorBelch("setupRtsFlags: bad value for -e\n");
2114 IF_PAR_DEBUG(verbose,
2115 errorBelch("-qe<n>: max %d local sparks",
2116 RtsFlags.ParFlags.maxLocalSparks));
2120 if (rts_argv[arg][3] != '\0') {
2121 RtsFlags.ParFlags.maxThreads
2122 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2124 errorBelch("missing size for -qt\n");
2127 IF_PAR_DEBUG(verbose,
2128 errorBelch("-qt<n>: max %d threads",
2129 RtsFlags.ParFlags.maxThreads));
2133 if (rts_argv[arg][3] != '\0')
2134 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2136 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2138 IF_PAR_DEBUG(verbose,
2139 errorBelch("-qf<n>: max %d fishes sent out at one time",
2140 RtsFlags.ParFlags.maxFishes));
2144 if (rts_argv[arg][3] != '\0') {
2145 RtsFlags.ParFlags.fishDelay
2146 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2148 errorBelch("missing fish delay time for -qF\n");
2151 IF_PAR_DEBUG(verbose,
2152 errorBelch("-qF<n>: fish delay time %d us",
2153 RtsFlags.ParFlags.fishDelay));
2157 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2158 IF_PAR_DEBUG(verbose,
2159 errorBelch("-qO: output disabled"));
2162 case 'g': /* -qg<n> ... globalisation scheme */
2163 if (rts_argv[arg][3] != '\0') {
2164 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2166 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2169 IF_PAR_DEBUG(verbose,
2170 debugBelch("-qg<n>: globalisation scheme set to %d",
2171 RtsFlags.ParFlags.globalising));
2174 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2175 if (rts_argv[arg][3] != '\0') {
2176 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2178 errorBelch("missing number of thunks per packet (for -qh)\n");
2181 IF_PAR_DEBUG(verbose,
2182 debugBelch("-qh<n>: thunks per packet set to %d",
2183 RtsFlags.ParFlags.thunksToPack));
2186 case 'P': /* -qP for writing a log file */
2187 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2188 /* same encoding as in GranSim after -bP */
2189 switch(rts_argv[arg][3]) {
2190 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2191 break; // nothing special, just an ordinary profile
2192 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2193 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2195 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2197 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2199 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2201 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2204 # if defined(PAR_TICKY)
2205 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2207 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2208 stg_exit(EXIT_FAILURE);
2211 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2213 IF_PAR_DEBUG(verbose,
2214 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2215 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2218 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2219 if (rts_argv[arg][3] != '\0') {
2220 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2222 errorBelch("missing size of PackBuffer (for -qQ)\n");
2225 IF_PAR_DEBUG(verbose,
2226 debugBelch("-qQ<n>: pack buffer size set to %d",
2227 RtsFlags.ParFlags.packBufferSize));
2231 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2232 IF_PAR_DEBUG(verbose,
2233 debugBelch("-qR: fair-ish scheduling"));
2238 if (rts_argv[arg][3] != '\0') {
2239 RtsFlags.ParFlags.wait
2240 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2242 RtsFlags.ParFlags.wait = 1000;
2244 IF_PAR_DEBUG(verbose,
2245 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2246 RtsFlags.ParFlags.wait));
2249 case 'D': /* -qD ... all the debugging options */
2250 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2251 /* hack warning: interpret the flags as a binary number */
2252 nat n = decode(rts_argv[arg]+3);
2253 set_par_debug_options(n);
2256 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2257 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2260 if (i==MAX_PAR_DEBUG_OPTION+1) {
2261 errorBelch("Valid GUM debug options are:\n");
2262 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2263 bad_option( rts_argv[arg] );
2264 } else { // flag found; now set it
2265 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2271 errorBelch("Unknown option -q%c (%d opts in total)",
2272 rts_argv[arg][2], *rts_argc);
2278 Interpret n as a binary number masking Par debug options and set the
2279 correxponding option. See par_debug_opts_strs for explanations of the flags.
2282 set_par_debug_options(nat n) {
2285 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2287 debugBelch(par_debug_opts_strs[i]);
2289 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2290 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2291 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2292 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2293 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2294 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2295 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2296 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2297 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2298 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2299 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2300 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2301 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2302 default: barf("set_par_debug_options: only %d debug options expected",
2303 MAX_PAR_DEBUG_OPTION);
2309 Print one line explanation for each of the GranSim debug options specified
2313 help_par_debug_options(nat n) {
2316 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2318 debugBelch(par_debug_opts_strs[i]);
2324 stats_fprintf(FILE *f, char *s, ...)
2336 static int /* return -1 on error */
2339 int argc, char *argv[],
2340 int rts_argc, char *rts_argv[],
2341 const char *FILENAME_FMT,
2346 if (strequal(rts_argv[arg]+2, "stderr")
2347 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
2348 f = NULL; /* NULL means use debugBelch */
2350 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2351 f = fopen(rts_argv[arg]+2,"w");
2353 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2354 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2355 f = fopen(stats_filename,"w");
2358 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2365 /* Write argv and rtsv into start of stats file */
2367 for(count = 0; count < argc; count++) {
2368 stats_fprintf(f, "%s ", argv[count]);
2370 stats_fprintf(f, "+RTS ");
2371 for(count = 0; count < rts_argc; count++)
2372 stats_fprintf(f, "%s ", rts_argv[count]);
2373 stats_fprintf(f, "\n");
2381 decode(const char *s)
2392 if (c == 'g' || c == 'G')
2393 m *= 1000*1000*1000; /* UNchecked! */
2394 else if (c == 'm' || c == 'M')
2395 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2396 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2397 m *= 1000; /* a direct-mapped cache. */
2398 else if (c == 'w' || c == 'W')
2405 bad_option(const char *s)
2407 errorBelch("bad RTS option: %s", s);
2408 stg_exit(EXIT_FAILURE);
2411 /* -----------------------------------------------------------------------------
2412 Getting/Setting the program's arguments.
2414 These are used by System.Environment, and parts of the RTS.
2415 -------------------------------------------------------------------------- */
2418 setProgName(char *argv[])
2420 /* Remove directory from argv[0] -- default files in current directory */
2421 #if !defined(mingw32_HOST_OS)
2423 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2424 prog_name = last_slash+1;
2426 prog_name = argv[0];
2429 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2430 while ( last_slash > argv[0] ) {
2431 if ( *last_slash == '/' || *last_slash == '\\' ) {
2432 prog_name = last_slash+1;
2437 prog_name = argv[0];
2442 getProgArgv(int *argc, char **argv[])
2444 if (argc) { *argc = prog_argc; }
2445 if (argv) { *argv = prog_argv; }
2449 setProgArgv(int argc, char *argv[])
2451 /* Usually this is done by startupHaskell, so we don't need to call this.
2452 However, sometimes Hugs wants to change the arguments which Haskell
2453 getArgs >>= ... will be fed. So you can do that by calling here
2454 _after_ calling startupHaskell.
2458 setProgName(prog_argv);
2461 /* These functions record and recall the full arguments, including the
2462 +RTS ... -RTS options. The reason for adding them was so that the
2463 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2465 getFullProgArgv(int *argc, char **argv[])
2467 if (argc) { *argc = full_prog_argc; }
2468 if (argv) { *argv = full_prog_argv; }
2472 setFullProgArgv(int argc, char *argv[])
2475 full_prog_argc = argc;
2476 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2477 "setFullProgArgv 1");
2478 for (i = 0; i < argc; i++) {
2479 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2480 "setFullProgArgv 2");
2481 strcpy(full_prog_argv[i], argv[i]);
2483 full_prog_argv[argc] = NULL;