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.apply = rtsFalse;
182 RtsFlags.DebugFlags.linker = rtsFalse;
183 RtsFlags.DebugFlags.squeeze = rtsFalse;
184 RtsFlags.DebugFlags.hpc = rtsFalse;
187 #if defined(PROFILING) || defined(PAR)
188 RtsFlags.CcFlags.doCostCentres = 0;
189 #endif /* PROFILING or PAR */
191 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
192 RtsFlags.ProfFlags.profileInterval = 100;
195 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
196 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
197 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
198 RtsFlags.ProfFlags.ccsLength = 25;
199 RtsFlags.ProfFlags.modSelector = NULL;
200 RtsFlags.ProfFlags.descrSelector = NULL;
201 RtsFlags.ProfFlags.typeSelector = NULL;
202 RtsFlags.ProfFlags.ccSelector = NULL;
203 RtsFlags.ProfFlags.ccsSelector = NULL;
204 RtsFlags.ProfFlags.retainerSelector = NULL;
205 RtsFlags.ProfFlags.bioSelector = NULL;
208 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
209 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
211 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
212 RtsFlags.MiscFlags.machineReadable = rtsFalse;
213 RtsFlags.MiscFlags.linkerMemBase = 0;
216 RtsFlags.ParFlags.nNodes = 1;
217 RtsFlags.ParFlags.migrate = rtsTrue;
218 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
219 RtsFlags.ParFlags.parGcEnabled = 1;
220 RtsFlags.ParFlags.parGcGen = 1;
224 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
225 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
226 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
227 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
228 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
229 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
230 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
232 RtsFlags.ParFlags.outputDisabled = rtsFalse;
234 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
236 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
238 RtsFlags.ParFlags.packBufferSize = 1024;
239 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
240 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
241 RtsFlags.ParFlags.maxThreads = 1024;
242 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
243 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
246 #if defined(PAR) || defined(THREADED_RTS)
247 RtsFlags.ParFlags.maxLocalSparks = 4096;
248 #endif /* PAR || THREADED_RTS */
251 /* ToDo: check defaults for GranSim and GUM */
252 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
253 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
255 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
256 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
257 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
258 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
259 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
260 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
261 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
262 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
264 RtsFlags.GranFlags.packBufferSize = 1024;
265 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
267 RtsFlags.GranFlags.proc = MAX_PROC;
268 RtsFlags.GranFlags.Fishing = rtsFalse;
269 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
270 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
271 RtsFlags.GranFlags.Light = rtsFalse;
273 RtsFlags.GranFlags.Costs.latency = LATENCY;
274 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
275 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
276 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
277 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
278 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
279 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
280 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
282 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
283 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
284 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
285 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
286 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
288 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
289 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
290 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
291 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
292 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
294 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
296 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
297 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
299 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
300 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
301 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
302 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
303 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
304 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
305 RtsFlags.GranFlags.FetchStrategy = 2;
306 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
307 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
308 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
309 RtsFlags.GranFlags.SparkPriority = 0;
310 RtsFlags.GranFlags.SparkPriority2 = 0;
311 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
312 RtsFlags.GranFlags.InversePriorities = rtsFalse;
313 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
314 RtsFlags.GranFlags.ThunksToPack = 0;
315 RtsFlags.GranFlags.RandomSteal = rtsTrue;
319 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
320 RtsFlags.TickyFlags.tickyFile = NULL;
323 RtsFlags.TraceFlags.timestamp = rtsFalse;
324 RtsFlags.TraceFlags.sched = rtsFalse;
325 RtsFlags.TraceFlags.gc = rtsFalse;
328 /* By default no special measurements taken */
329 RtsFlags.PapiFlags.eventType = 0;
330 RtsFlags.PapiFlags.numUserEvents = 0;
337 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
339 " +RTS Indicates run time system options follow",
340 " -RTS Indicates program arguments follow",
341 " --RTS Indicates that ALL subsequent arguments will be given to the",
342 " program (including any of these RTS flags)",
344 "The following run time system options are available:",
346 " -? Prints this message and exits; the program is not executed",
347 " --info Print information about the RTS used by this program",
349 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
350 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
352 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
353 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
354 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
355 " -m<n> Minimum % of heap which must be available (default 3%)",
356 " -G<n> Number of generations (default: 2)",
357 " -T<n> Number of steps in younger generations (default: 2)",
358 " -c<n> Auto-enable compaction of the oldest generation when live data is",
359 " at least <n>% of the maximum heap size set with -M (default: 30%)",
360 " -c Enable compaction for all major collections",
361 " -w Use mark-region for the oldest generation (experimental)",
362 #if defined(THREADED_RTS)
363 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
366 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
367 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
368 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
369 #ifdef RTS_GTK_FRONTPANEL
370 " -f Display front panel (requires X11 & GTK+)",
374 " -Z Don't squeeze out update frames on stack overflow",
375 " -B Sound the bell at the start of each garbage collection",
376 #if defined(PROFILING) || defined(PAR)
378 " -px Time/allocation profile (XML) (output file <program>.prof)",
379 " -p Time/allocation profile (output file <program>.prof)",
380 " -P More detailed Time/Allocation profile",
381 " -Pa Give information about *all* cost centres",
383 # if defined(PROFILING)
385 " -hx Heap residency profile (XML) (output file <program>.prof)",
386 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
387 " break-down: c = cost centre stack (default)",
389 " d = closure description",
390 " y = type description",
392 " b = biography (LAG,DRAG,VOID,USE)",
393 " A subset of closures may be selected thusly:",
394 " -hc<cc>,... specific cost centre(s) (top of stack only)",
395 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
396 " -hm<mod>... all cost centres from the specified modules(s)",
397 " -hd<des>,... closures with specified closure descriptions",
398 " -hy<typ>... closures with specified type descriptions",
399 " -hr<cc>... closures with specified retainers",
400 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
402 " -R<size> Set the maximum retainer set size (default: 8)",
404 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
407 " -xt Include threads (TSOs) in a heap profile",
409 " -xc Show current cost centre stack on raising an exception",
412 #endif /* PROFILING or PAR */
413 #if !defined(PROFILING)
415 " -hT Heap residency profile (output file <program>.hp)",
417 " -i<sec> Time between heap samples (seconds, default: 0.1)",
419 #if defined(TICKY_TICKY)
420 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
424 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
425 /* NB: the -N<n> is implemented by the driver!! */
427 " -C<secs> Context-switch interval in seconds.",
428 " 0 or no argument means switch as often as possible.",
429 " Default: 0.02 sec; resolution is set by -V below.",
430 " -V<secs> Master tick interval in seconds (0 == disable timer).",
431 " This sets the resolution for -C and the profile timer -i.",
432 " Default: 0.02 sec.",
434 " -vs Trace scheduler events (see also -Ds with -debug)",
435 " -vt Time-stamp trace messages",
438 " -Ds DEBUG: scheduler",
439 " -Di DEBUG: interpreter",
441 " -DG DEBUG: gccafs",
444 " -DS DEBUG: sanity",
445 " -Dt DEBUG: stable",
450 " -Dl DEBUG: linker",
452 " -Dz DEBUG: stack squezing",
453 " -Dc DEBUG: program coverage",
456 #if defined(THREADED_RTS) && !defined(NOSMP)
457 " -N<n> Use <n> OS threads (default: 1)",
458 " -q1 Use one OS thread for GC (turns off parallel GC)",
459 " -qg<n> Use parallel GC only for generations >= <n> (default: 1)",
460 " -qm Don't automatically migrate threads between CPUs",
461 " -qw Migrate a thread to the current CPU when it is woken up",
463 " --install-signal-handlers=<yes|no>",
464 " Install signal handlers (default: yes)",
465 #if defined(THREADED_RTS) || defined(PAR)
466 " -e<size> Size of spark pools (default 100)",
469 " -t<num> Set maximum number of advisory threads per PE (default 32)",
470 " -qP Enable activity profile (output files in ~/<program>*.gr)",
471 " -qQ<size> Set pack-buffer size (default: 1024)",
472 " -qd Turn on PVM-ish debugging",
473 " -qO Disable output for performance measurement",
475 #if defined(THREADED_RTS) || defined(PAR)
476 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
479 " -d Turn on PVM-ish debugging",
480 " -O Disable output for performance measurement",
482 #if defined(GRAN) /* ToDo: fill in decent Docu here */
483 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
485 #if defined(x86_64_HOST_ARCH)
486 " -xm Base address to mmap memory in the GHCi linker",
487 " (hex; must be <80000000)",
489 #if defined(USE_PAPI)
490 " -aX CPU performance counter measurements using PAPI",
491 " (use with the -s<file> option). X is one of:",
494 " 1 - level 1 cache misses",
495 " 2 - level 2 cache misses",
496 " b - branch mispredictions",
497 " s - stalled cycles",
498 " e - cache miss and branch misprediction events",
501 "RTS options may also be specified using the GHCRTS environment variable.",
503 "Other RTS options may be available for programs compiled a different way.",
504 "The GHC User's Guide has full details.",
509 STATIC_INLINE rtsBool
510 strequal(const char *a, const char * b)
512 return(strcmp(a, b) == 0);
516 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
522 while (isspace(*c1)) { c1++; };
524 while (!isspace(*c2) && *c2 != '\0') { c2++; };
526 if (c1 == c2) { break; }
528 if (*rts_argc < MAX_RTS_ARGS-1) {
529 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
530 strncpy(s, c1, c2-c1);
532 rts_argv[(*rts_argc)++] = s;
534 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
538 } while (*c1 != '\0');
542 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
544 rtsBool error = rtsFalse;
555 // process arguments from the ghc_rts_opts global variable first.
556 // (arguments from the GHCRTS environment variable and the command
557 // line override these).
559 if (ghc_rts_opts != NULL) {
560 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
564 // process arguments from the GHCRTS environment variable next
565 // (arguments from the command line override these).
567 char *ghc_rts = getenv("GHCRTS");
569 if (ghc_rts != NULL) {
570 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
574 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
575 // argv[0] must be PGM argument -- leave in argv
577 for (mode = PGM; arg < total_arg; arg++) {
578 // The '--RTS' argument disables all future +RTS ... -RTS processing.
579 if (strequal("--RTS", argv[arg])) {
583 // The '--' argument is passed through to the program, but
584 // disables all further +RTS ... -RTS processing.
585 else if (strequal("--", argv[arg])) {
588 else if (strequal("+RTS", argv[arg])) {
591 else if (strequal("-RTS", argv[arg])) {
594 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
595 rts_argv[(*rts_argc)++] = argv[arg];
597 else if (mode == PGM) {
598 argv[(*argc)++] = argv[arg];
601 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
604 // process remaining program arguments
605 for (; arg < total_arg; arg++) {
606 argv[(*argc)++] = argv[arg];
608 argv[*argc] = (char *) 0;
609 rts_argv[*rts_argc] = (char *) 0;
611 // Process RTS (rts_argv) part: mainly to determine statsfile
612 for (arg = 0; arg < *rts_argc; arg++) {
613 if (rts_argv[arg][0] != '-') {
615 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
619 switch(rts_argv[arg][1]) {
621 /* process: general args, then PROFILING-only ones,
622 then CONCURRENT-only, PARallel-only, GRAN-only,
623 TICKY-only (same order as defined in RtsFlags.lh);
624 within those groups, mostly in case-insensitive
626 Final group is x*, which allows for more options.
630 # define TICKY_BUILD_ONLY(x) x
632 # define TICKY_BUILD_ONLY(x) \
633 errorBelch("not built for: ticky-ticky stats"); \
637 #if defined(PROFILING)
638 # define COST_CENTRE_USING_BUILD_ONLY(x) x
640 # define COST_CENTRE_USING_BUILD_ONLY(x) \
641 errorBelch("not built for: -prof or -parallel"); \
646 # define PROFILING_BUILD_ONLY(x) x
648 # define PROFILING_BUILD_ONLY(x) \
649 errorBelch("not built for: -prof"); \
654 # define PAR_BUILD_ONLY(x) x
656 # define PAR_BUILD_ONLY(x) \
657 errorBelch("not built for: -parallel"); \
662 # define THREADED_BUILD_ONLY(x) x
664 # define THREADED_BUILD_ONLY(x) \
665 errorBelch("not built for: -smp"); \
669 #if defined(THREADED_RTS) || defined(PAR)
670 # define PAR_OR_THREADED_BUILD_ONLY(x) x
672 # define PAR_OR_THREADED_BUILD_ONLY(x) \
673 errorBelch("not built for: -parallel or -smp"); \
678 # define GRAN_BUILD_ONLY(x) x
680 # define GRAN_BUILD_ONLY(x) \
681 errorBelch("not built for: -gransim"); \
685 /* =========== GENERAL ========================== */
690 /* This isn't going to allow us to keep related options
691 together as we add more --* flags. We really need a
692 proper options parser. */
694 if (strequal("install-signal-handlers=yes",
695 &rts_argv[arg][2])) {
696 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
698 else if (strequal("install-signal-handlers=no",
699 &rts_argv[arg][2])) {
700 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
702 else if (strequal("machine-readable",
703 &rts_argv[arg][2])) {
704 RtsFlags.MiscFlags.machineReadable = rtsTrue;
706 else if (strequal("info",
707 &rts_argv[arg][2])) {
712 errorBelch("unknown RTS option: %s",rts_argv[arg]);
717 RtsFlags.GcFlags.minAllocAreaSize
718 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
719 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
720 bad_option(rts_argv[arg]);
726 switch(rts_argv[arg][2]) {
728 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
731 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
734 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
737 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
740 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
743 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
744 errorBelch("maximum number of PAPI events reached");
745 stg_exit(EXIT_FAILURE);
747 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
748 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
751 bad_option( rts_argv[arg] );
757 RtsFlags.GcFlags.ringBell = rtsTrue;
761 if (rts_argv[arg][2] != '\0') {
762 RtsFlags.GcFlags.compactThreshold =
763 atof(rts_argv[arg]+2);
765 RtsFlags.GcFlags.compact = rtsTrue;
770 RtsFlags.GcFlags.sweep = rtsTrue;
774 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
776 if (RtsFlags.GcFlags.oldGenFactor < 0)
777 bad_option( rts_argv[arg] );
785 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
788 RtsFlags.DebugFlags.scheduler = rtsTrue;
791 RtsFlags.DebugFlags.interpreter = rtsTrue;
794 RtsFlags.DebugFlags.weak = rtsTrue;
797 RtsFlags.DebugFlags.gccafs = rtsTrue;
800 RtsFlags.DebugFlags.gc = rtsTrue;
803 RtsFlags.DebugFlags.block_alloc = rtsTrue;
806 RtsFlags.DebugFlags.sanity = rtsTrue;
809 RtsFlags.DebugFlags.stable = rtsTrue;
812 RtsFlags.DebugFlags.prof = rtsTrue;
815 RtsFlags.DebugFlags.gran = rtsTrue;
818 RtsFlags.DebugFlags.par = rtsTrue;
821 RtsFlags.DebugFlags.linker = rtsTrue;
824 RtsFlags.DebugFlags.apply = rtsTrue;
827 RtsFlags.DebugFlags.stm = rtsTrue;
830 RtsFlags.DebugFlags.squeeze = rtsTrue;
833 RtsFlags.DebugFlags.hpc = rtsTrue;
836 bad_option( rts_argv[arg] );
844 RtsFlags.GcFlags.maxStkSize =
845 decode(rts_argv[arg]+2) / sizeof(W_);
847 if (RtsFlags.GcFlags.maxStkSize == 0)
848 bad_option( rts_argv[arg] );
852 RtsFlags.GcFlags.initialStkSize =
853 decode(rts_argv[arg]+2) / sizeof(W_);
855 if (RtsFlags.GcFlags.initialStkSize == 0)
856 bad_option( rts_argv[arg] );
860 RtsFlags.GcFlags.maxHeapSize =
861 decode(rts_argv[arg]+2) / BLOCK_SIZE;
862 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
864 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
865 bad_option(rts_argv[arg]);
870 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
872 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
873 RtsFlags.GcFlags.pcFreeHeap > 100)
874 bad_option( rts_argv[arg] );
878 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
879 if (RtsFlags.GcFlags.generations < 1) {
880 bad_option(rts_argv[arg]);
885 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
886 if (RtsFlags.GcFlags.steps < 1) {
887 bad_option(rts_argv[arg]);
892 RtsFlags.GcFlags.heapSizeSuggestion =
893 decode(rts_argv[arg]+2) / BLOCK_SIZE;
896 #ifdef RTS_GTK_FRONTPANEL
898 RtsFlags.GcFlags.frontpanel = rtsTrue;
902 case 'I': /* idle GC delay */
903 if (rts_argv[arg][2] == '\0') {
908 /* Convert to millisecs */
909 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
910 RtsFlags.GcFlags.idleGCDelayTime = cst;
915 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
919 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
923 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
928 /* Opening all those files would almost certainly fail... */
929 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
930 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
934 r = open_stats_file(arg, *argc, argv,
935 *rts_argc, rts_argv, NULL,
936 &RtsFlags.GcFlags.statsFile);
937 if (r == -1) { error = rtsTrue; }
943 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
946 /* =========== PROFILING ========================== */
948 case 'P': /* detailed cost centre profiling (time/alloc) */
949 case 'p': /* cost centre profiling (time/alloc) */
950 COST_CENTRE_USING_BUILD_ONLY(
951 switch (rts_argv[arg][2]) {
953 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
956 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
959 if (rts_argv[arg][1] == 'P') {
960 RtsFlags.CcFlags.doCostCentres =
961 COST_CENTRES_VERBOSE;
963 RtsFlags.CcFlags.doCostCentres =
964 COST_CENTRES_SUMMARY;
971 PROFILING_BUILD_ONLY(
972 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
975 PROFILING_BUILD_ONLY(
976 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
977 if(RtsFlags.ProfFlags.ccsLength <= 0) {
978 bad_option(rts_argv[arg]);
981 case 'h': /* serial heap profile */
982 #if !defined(PROFILING)
983 switch (rts_argv[arg][2]) {
986 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
989 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
993 PROFILING_BUILD_ONLY(
994 switch (rts_argv[arg][2]) {
1008 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
1010 char *left = strchr(rts_argv[arg], '{');
1011 char *right = strrchr(rts_argv[arg], '}');
1013 // curly braces are optional, for
1014 // backwards compat.
1018 left = rts_argv[arg] + 3;
1021 right = rts_argv[arg] + strlen(rts_argv[arg]);
1025 switch (rts_argv[arg][2]) {
1026 case 'c': // cost centre label select
1027 RtsFlags.ProfFlags.ccSelector = left;
1030 RtsFlags.ProfFlags.ccsSelector = left;
1033 case 'm': // cost centre module select
1034 RtsFlags.ProfFlags.modSelector = left;
1037 case 'd': // closure descr select
1038 RtsFlags.ProfFlags.descrSelector = left;
1041 case 'y': // closure type select
1042 RtsFlags.ProfFlags.typeSelector = left;
1045 case 'r': // retainer select
1046 RtsFlags.ProfFlags.retainerSelector = left;
1049 case 'b': // biography select
1050 RtsFlags.ProfFlags.bioSelector = left;
1057 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1058 errorBelch("multiple heap profile options");
1063 switch (rts_argv[arg][2]) {
1067 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1071 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1075 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1079 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1083 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1087 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1093 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1097 #endif /* PROFILING */
1100 case 'i': /* heap sample interval */
1101 if (rts_argv[arg][2] == '\0') {
1106 /* Convert to milliseconds */
1107 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1108 RtsFlags.ProfFlags.profileInterval = cst;
1112 /* =========== CONCURRENT ========================= */
1113 case 'C': /* context switch interval */
1114 if (rts_argv[arg][2] == '\0')
1115 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1119 /* Convert to milliseconds */
1120 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1121 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1125 case 'V': /* master tick interval */
1126 if (rts_argv[arg][2] == '\0') {
1127 // turns off ticks completely
1128 RtsFlags.MiscFlags.tickInterval = 0;
1132 /* Convert to milliseconds */
1133 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1134 RtsFlags.MiscFlags.tickInterval = cst;
1138 #if defined(THREADED_RTS) && !defined(NOSMP)
1140 THREADED_BUILD_ONLY(
1141 if (rts_argv[arg][2] != '\0') {
1142 RtsFlags.ParFlags.nNodes
1143 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1144 if (RtsFlags.ParFlags.nNodes <= 0) {
1145 errorBelch("bad value for -N");
1148 #if defined(PROFILING)
1149 if (RtsFlags.ParFlags.nNodes > 1) {
1150 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1158 THREADED_BUILD_ONLY(
1159 switch (rts_argv[arg][2]) {
1161 // backwards compat only
1162 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1165 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1172 switch (rts_argv[arg][2]) {
1174 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1178 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1181 if (rts_argv[arg][3] != '\0') {
1182 RtsFlags.ParFlags.parGcGen
1183 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1185 errorBelch("bad value for -qg");
1190 RtsFlags.ParFlags.migrate = rtsFalse;
1193 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1196 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1202 /* =========== PARALLEL =========================== */
1204 PAR_OR_THREADED_BUILD_ONLY(
1205 if (rts_argv[arg][2] != '\0') {
1206 RtsFlags.ParFlags.maxLocalSparks
1207 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1208 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1209 errorBelch("bad value for -e");
1218 process_par_option(arg, rts_argc, rts_argv, &error);
1222 /* =========== GRAN =============================== */
1226 process_gran_option(arg, rts_argc, rts_argv, &error);
1229 /* =========== TICKY ============================== */
1231 case 'r': /* Basic profiling stats */
1234 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1238 r = open_stats_file(arg, *argc, argv,
1239 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1240 &RtsFlags.TickyFlags.tickyFile);
1241 if (r == -1) { error = rtsTrue; }
1245 /* =========== TRACING ---------=================== */
1248 switch(rts_argv[arg][2]) {
1250 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1254 RtsFlags.TraceFlags.timestamp = rtsTrue;
1257 RtsFlags.TraceFlags.sched = rtsTrue;
1260 RtsFlags.TraceFlags.gc = rtsTrue;
1263 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1269 /* =========== EXTENDED OPTIONS =================== */
1271 case 'x': /* Extend the argument space */
1272 switch(rts_argv[arg][2]) {
1274 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1278 case 'b': /* heapBase in hex; undocumented */
1279 if (rts_argv[arg][3] != '\0') {
1280 RtsFlags.GcFlags.heapBase
1281 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1283 errorBelch("-xb: requires argument");
1288 #if defined(x86_64_HOST_ARCH)
1289 case 'm': /* linkerMemBase */
1290 if (rts_argv[arg][3] != '\0') {
1291 RtsFlags.MiscFlags.linkerMemBase
1292 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1293 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1294 errorBelch("-xm: value must be <80000000");
1298 RtsFlags.MiscFlags.linkerMemBase = 0;
1303 case 'c': /* Debugging tool: show current cost centre on an exception */
1304 PROFILING_BUILD_ONLY(
1305 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1309 case 't': /* Include memory used by TSOs in a heap profile */
1310 PROFILING_BUILD_ONLY(
1311 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1315 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1318 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1322 break; /* defensive programming */
1324 /* =========== OH DEAR ============================ */
1326 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1333 if (RtsFlags.MiscFlags.tickInterval < 0) {
1334 RtsFlags.MiscFlags.tickInterval = 50;
1337 // If the master timer is disabled, turn off the other timers.
1338 if (RtsFlags.MiscFlags.tickInterval == 0) {
1339 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1340 RtsFlags.GcFlags.idleGCDelayTime = 0;
1341 RtsFlags.ProfFlags.profileInterval = 0;
1344 // Determine what tick interval we should use for the RTS timer
1345 // by taking the shortest of the various intervals that we need to
1347 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1348 RtsFlags.MiscFlags.tickInterval =
1349 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1350 RtsFlags.MiscFlags.tickInterval);
1353 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1354 RtsFlags.MiscFlags.tickInterval =
1355 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1356 RtsFlags.MiscFlags.tickInterval);
1359 if (RtsFlags.ProfFlags.profileInterval > 0) {
1360 RtsFlags.MiscFlags.tickInterval =
1361 stg_min(RtsFlags.ProfFlags.profileInterval,
1362 RtsFlags.MiscFlags.tickInterval);
1365 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1366 RtsFlags.ConcFlags.ctxtSwitchTicks =
1367 RtsFlags.ConcFlags.ctxtSwitchTime /
1368 RtsFlags.MiscFlags.tickInterval;
1370 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1373 if (RtsFlags.ProfFlags.profileInterval > 0) {
1374 RtsFlags.ProfFlags.profileIntervalTicks =
1375 RtsFlags.ProfFlags.profileInterval /
1376 RtsFlags.MiscFlags.tickInterval;
1378 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1385 for (p = usage_text; *p; p++)
1386 errorBelch("%s", *p);
1387 stg_exit(EXIT_FAILURE);
1394 enable_GranSimLight(void) {
1396 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1397 RtsFlags.GranFlags.Light=rtsTrue;
1398 RtsFlags.GranFlags.Costs.latency =
1399 RtsFlags.GranFlags.Costs.fetchtime =
1400 RtsFlags.GranFlags.Costs.additional_latency =
1401 RtsFlags.GranFlags.Costs.gunblocktime =
1402 RtsFlags.GranFlags.Costs.lunblocktime =
1403 RtsFlags.GranFlags.Costs.threadcreatetime =
1404 RtsFlags.GranFlags.Costs.threadqueuetime =
1405 RtsFlags.GranFlags.Costs.threadscheduletime =
1406 RtsFlags.GranFlags.Costs.threaddescheduletime =
1407 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1409 RtsFlags.GranFlags.Costs.mpacktime =
1410 RtsFlags.GranFlags.Costs.munpacktime = 0;
1412 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1413 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1414 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1415 /* FetchStrategy is irrelevant in GrAnSim-Light */
1417 /* GrAnSim Light often creates an abundance of parallel threads,
1418 each with its own stack etc. Therefore, it's in general a good
1419 idea to use small stack chunks (use the -o<size> option to
1422 // RtsFlags.ConcFlags.stkChunkSize = 100;
1424 RtsFlags.GranFlags.proc = 1;
1428 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1430 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1433 /* or a ridiculously idealised simulator */
1434 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1435 RtsFlags.GranFlags.Costs.latency =
1436 RtsFlags.GranFlags.Costs.fetchtime =
1437 RtsFlags.GranFlags.Costs.additional_latency =
1438 RtsFlags.GranFlags.Costs.gunblocktime =
1439 RtsFlags.GranFlags.Costs.lunblocktime =
1440 RtsFlags.GranFlags.Costs.threadcreatetime =
1441 RtsFlags.GranFlags.Costs.threadqueuetime =
1442 RtsFlags.GranFlags.Costs.threadscheduletime =
1443 RtsFlags.GranFlags.Costs.threaddescheduletime =
1444 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1446 RtsFlags.GranFlags.Costs.mpacktime =
1447 RtsFlags.GranFlags.Costs.munpacktime = 0;
1449 RtsFlags.GranFlags.Costs.arith_cost =
1450 RtsFlags.GranFlags.Costs.float_cost =
1451 RtsFlags.GranFlags.Costs.load_cost =
1452 RtsFlags.GranFlags.Costs.store_cost =
1453 RtsFlags.GranFlags.Costs.branch_cost = 0;
1455 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1457 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1458 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1459 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1460 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1464 /* or a somewhat idealised simulator */
1465 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1466 RtsFlags.GranFlags.Costs.latency =
1467 RtsFlags.GranFlags.Costs.fetchtime =
1468 RtsFlags.GranFlags.Costs.additional_latency =
1469 RtsFlags.GranFlags.Costs.gunblocktime =
1470 RtsFlags.GranFlags.Costs.lunblocktime =
1471 RtsFlags.GranFlags.Costs.threadcreatetime =
1472 RtsFlags.GranFlags.Costs.threadqueuetime =
1473 RtsFlags.GranFlags.Costs.threadscheduletime =
1474 RtsFlags.GranFlags.Costs.threaddescheduletime =
1475 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1477 RtsFlags.GranFlags.Costs.mpacktime =
1478 RtsFlags.GranFlags.Costs.munpacktime = 0;
1480 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1482 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1483 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1484 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1485 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1486 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1487 # if defined(GRAN_CHECK) && defined(GRAN)
1488 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1493 /* Communication and task creation cost parameters */
1494 switch(rts_argv[arg][2]) {
1496 IgnoreYields = rtsTrue; // HWL HACK
1500 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1504 if (rts_argv[arg][3] != '\0')
1506 RtsFlags.GranFlags.Costs.gunblocktime =
1507 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1508 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1511 RtsFlags.GranFlags.Costs.latency = LATENCY;
1515 if (rts_argv[arg][3] != '\0')
1516 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1518 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1522 if (rts_argv[arg][3] != '\0')
1523 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1525 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1529 if (rts_argv[arg][3] != '\0')
1530 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1532 RtsFlags.GranFlags.Costs.mtidytime = 0;
1536 if (rts_argv[arg][3] != '\0')
1537 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1539 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1543 if (rts_argv[arg][3] != '\0')
1544 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1546 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1550 if (rts_argv[arg][3] != '\0')
1551 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1553 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1557 if (rts_argv[arg][3] != '\0')
1558 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1560 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1563 /* Thread-related metrics */
1565 if (rts_argv[arg][3] != '\0')
1566 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1568 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1572 if (rts_argv[arg][3] != '\0')
1573 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1575 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1579 if (rts_argv[arg][3] != '\0')
1580 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1582 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1584 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1585 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1589 if (rts_argv[arg][3] != '\0')
1590 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1592 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1594 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1595 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1598 /* Instruction Cost Metrics */
1600 if (rts_argv[arg][3] != '\0')
1601 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1603 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1607 if (rts_argv[arg][3] != '\0')
1608 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1610 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1614 if (rts_argv[arg][3] != '\0')
1615 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1617 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1621 if (rts_argv[arg][3] != '\0')
1622 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1624 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1628 if (rts_argv[arg][3] != '\0')
1629 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1631 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1635 if (rts_argv[arg][3] != '\0')
1636 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1638 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1642 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1643 if (rts_argv[arg][3] != '\0')
1644 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1646 RtsFlags.GranFlags.FetchStrategy = 2;
1647 if (RtsFlags.GranFlags.FetchStrategy == 0)
1648 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1651 case 'K': /* sort overhead (per elem in spark list) */
1652 if (rts_argv[arg][3] != '\0')
1653 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1655 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1656 debugBelch("Overhead for pri spark: %d (per elem).\n",
1657 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1660 case 'O': /* sort overhead (per elem in spark list) */
1661 if (rts_argv[arg][3] != '\0')
1662 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1664 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1665 debugBelch("Overhead for pri sched: %d (per elem).\n",
1666 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1669 /* General Parameters */
1671 if (rts_argv[arg][3] != '\0')
1673 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1674 if (RtsFlags.GranFlags.proc==0) {
1675 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1676 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1677 RtsFlags.GranFlags.proc < 1)
1679 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1685 RtsFlags.GranFlags.proc = MAX_PROC;
1689 RtsFlags.GranFlags.Fishing = rtsTrue;
1690 if (rts_argv[arg][3] != '\0')
1691 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1693 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1697 if (rts_argv[arg][3] != '\0')
1698 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1700 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1704 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1705 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1709 debugBelch("Bulk fetching enabled.\n");
1710 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1714 debugBelch("Thread migration enabled.\n");
1715 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1719 debugBelch("Fair Scheduling enabled.\n");
1720 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1724 debugBelch("Priority Scheduling enabled.\n");
1725 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1729 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1730 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1734 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1738 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1742 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1746 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1750 /* format is -bP<c> where <c> is one char describing kind of profile */
1751 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1752 switch(rts_argv[arg][3]) {
1753 case '\0': break; // nothing special, just an ordinary profile
1754 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1756 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1758 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1760 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1762 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1764 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1766 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1771 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1775 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1778 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1779 if (rts_argv[arg][3] != '\0') {
1782 arg0 = rts_argv[arg]+3;
1783 if ((tmp = strstr(arg0,","))==NULL) {
1784 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1785 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1788 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1789 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1790 debugBelch("SparkPriority: %u.\n",
1791 RtsFlags.GranFlags.SparkPriority);
1792 debugBelch("SparkPriority2:%u.\n",
1793 RtsFlags.GranFlags.SparkPriority2);
1794 if (RtsFlags.GranFlags.SparkPriority2 <
1795 RtsFlags.GranFlags.SparkPriority) {
1796 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1797 RtsFlags.GranFlags.SparkPriority2,
1798 RtsFlags.GranFlags.SparkPriority);
1802 /* plain pri spark is now invoked with -bX
1803 RtsFlags.GranFlags.DoPrioritySparking = 1;
1804 debugBelch("PrioritySparking.\n");
1810 if (rts_argv[arg][3] != '\0') {
1811 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1813 RtsFlags.GranFlags.ThunksToPack = 1;
1815 debugBelch("Thunks To Pack in one packet: %u.\n",
1816 RtsFlags.GranFlags.ThunksToPack);
1820 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1821 debugBelch("Deterministic mode (no random stealing)\n");
1824 /* The following class of options contains eXperimental */
1825 /* features in connection with exploiting granularity */
1826 /* information. I.e. if -bY is chosen these options */
1827 /* tell the RTS what to do with the supplied info --HWL */
1830 if (rts_argv[arg][3] != '\0') {
1831 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1833 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1835 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1836 RtsFlags.GranFlags.packBufferSize_internal);
1840 switch(rts_argv[arg][3]) {
1843 RtsFlags.GranFlags.DoPrioritySparking = 1;
1844 debugBelch("Priority Sparking with Normal Priorities.\n");
1845 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1846 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1847 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1851 RtsFlags.GranFlags.DoPrioritySparking = 1;
1852 debugBelch("Priority Sparking with Inverse Priorities.\n");
1853 RtsFlags.GranFlags.InversePriorities++;
1857 RtsFlags.GranFlags.DoPrioritySparking = 1;
1858 debugBelch("Priority Sparking with Random Priorities.\n");
1859 RtsFlags.GranFlags.RandomPriorities++;
1863 RtsFlags.GranFlags.DoPrioritySparking = 1;
1864 debugBelch("Priority Sparking with No Priorities.\n");
1865 RtsFlags.GranFlags.IgnorePriorities++;
1869 bad_option( rts_argv[arg] );
1875 switch(rts_argv[arg][3]) {
1878 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1879 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1883 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1887 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1891 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1895 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1896 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1900 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1904 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1908 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1912 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1916 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1920 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1924 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1928 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1929 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1933 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1937 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1941 bad_option( rts_argv[arg] );
1946 # if defined(GRAN_CHECK) && defined(GRAN)
1948 switch(rts_argv[arg][3]) {
1949 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1950 if (rts_argv[arg][4] != '\0') {
1951 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1952 debugBelch("Pack buffer size: %d\n",
1953 RtsFlags.GranFlags.packBufferSize);
1955 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1961 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1962 /* hack warning: interpret the flags as a binary number */
1963 nat n = decode(rts_argv[arg]+3);
1964 set_GranSim_debug_options(n);
1967 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1968 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1971 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1972 debugBelch("Valid GranSim debug options are:\n");
1973 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1974 bad_option( rts_argv[arg] );
1975 } else { // flag found; now set it
1976 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1982 case 'e': /* event trace; also -bD1 */
1983 debugBelch("DEBUG: event_trace; printing event trace.\n");
1984 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1985 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1988 case 'E': /* event statistics; also -bD2 */
1989 debugBelch("DEBUG: event_stats; printing event statistics.\n");
1990 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1991 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1994 case 'f': /* thunkStealing; also -bD4 */
1995 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1996 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1997 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
2000 case 'z': /* blockOnFetch; also -bD8 */
2001 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
2002 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
2003 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
2006 case 't': /* blockOnFetch_sanity; also -bD16 */
2007 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
2008 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
2009 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
2012 case 'S': /* priSpark; also -bD32 */
2013 debugBelch("DEBUG: priSpark; priority sparking.\n");
2014 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
2017 case 's': /* priSched; also -bD64 */
2018 debugBelch("DEBUG: priSched; priority scheduling.\n");
2019 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
2022 case 'F': /* findWork; also -bD128 */
2023 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
2024 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
2027 case 'g': /* globalBlock; also -bD256 */
2028 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
2029 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
2032 case 'G': /* pack; also -bD512 */
2033 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
2034 RtsFlags.GranFlags.Debug.pack = rtsTrue;
2037 case 'P': /* packBuffer; also -bD1024 */
2038 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
2039 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
2042 case 'o': /* sortedQ; also -bD2048 */
2043 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
2044 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
2047 case 'r': /* randomSteal; also -bD4096 */
2048 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2049 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2052 case 'q': /* checkSparkQ; also -bD8192 */
2053 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2054 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2057 case ':': /* checkLight; also -bD16384 */
2058 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2059 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2062 case 'b': /* bq; also -bD32768 */
2063 debugBelch("DEBUG: bq; check blocking queues\n");
2064 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2067 case 'd': /* all options turned on */
2068 debugBelch("DEBUG: all options turned on.\n");
2069 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2070 /* RtsFlags.GranFlags.Debug |= 0x40; */
2074 /* RtsFlags.GranFlags.Debug = 1; */
2080 # endif /* GRAN_CHECK */
2082 bad_option( rts_argv[arg] );
2088 Interpret n as a binary number masking GranSim debug options and set the
2089 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2092 set_GranSim_debug_options(nat n) {
2095 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2097 errorBelch(gran_debug_opts_strs[i]);
2099 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2100 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2101 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2102 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2103 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2104 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2105 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2106 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2107 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2108 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2109 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2110 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2111 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2112 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2113 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2114 default: barf("set_GranSim_debug_options: only %d debug options expected");
2120 Print one line explanation for each of the GranSim debug options specified
2124 help_GranSim_debug_options(nat n) {
2127 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2129 debugBelch(gran_debug_opts_strs[i]);
2135 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2138 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2139 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2143 /* Communication and task creation cost parameters */
2144 switch(rts_argv[arg][2]) {
2145 case 'e': /* -qe<n> ... allow <n> local sparks */
2146 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2147 RtsFlags.ParFlags.maxLocalSparks
2148 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2150 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2151 errorBelch("setupRtsFlags: bad value for -e\n");
2155 IF_PAR_DEBUG(verbose,
2156 errorBelch("-qe<n>: max %d local sparks",
2157 RtsFlags.ParFlags.maxLocalSparks));
2161 if (rts_argv[arg][3] != '\0') {
2162 RtsFlags.ParFlags.maxThreads
2163 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2165 errorBelch("missing size for -qt\n");
2168 IF_PAR_DEBUG(verbose,
2169 errorBelch("-qt<n>: max %d threads",
2170 RtsFlags.ParFlags.maxThreads));
2174 if (rts_argv[arg][3] != '\0')
2175 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2177 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2179 IF_PAR_DEBUG(verbose,
2180 errorBelch("-qf<n>: max %d fishes sent out at one time",
2181 RtsFlags.ParFlags.maxFishes));
2185 if (rts_argv[arg][3] != '\0') {
2186 RtsFlags.ParFlags.fishDelay
2187 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2189 errorBelch("missing fish delay time for -qF\n");
2192 IF_PAR_DEBUG(verbose,
2193 errorBelch("-qF<n>: fish delay time %d us",
2194 RtsFlags.ParFlags.fishDelay));
2198 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2199 IF_PAR_DEBUG(verbose,
2200 errorBelch("-qO: output disabled"));
2203 case 'g': /* -qg<n> ... globalisation scheme */
2204 if (rts_argv[arg][3] != '\0') {
2205 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2207 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2210 IF_PAR_DEBUG(verbose,
2211 debugBelch("-qg<n>: globalisation scheme set to %d",
2212 RtsFlags.ParFlags.globalising));
2215 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2216 if (rts_argv[arg][3] != '\0') {
2217 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2219 errorBelch("missing number of thunks per packet (for -qh)\n");
2222 IF_PAR_DEBUG(verbose,
2223 debugBelch("-qh<n>: thunks per packet set to %d",
2224 RtsFlags.ParFlags.thunksToPack));
2227 case 'P': /* -qP for writing a log file */
2228 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2229 /* same encoding as in GranSim after -bP */
2230 switch(rts_argv[arg][3]) {
2231 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2232 break; // nothing special, just an ordinary profile
2233 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2234 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2236 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2238 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2240 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2242 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2245 # if defined(PAR_TICKY)
2246 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2248 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2249 stg_exit(EXIT_FAILURE);
2252 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2254 IF_PAR_DEBUG(verbose,
2255 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2256 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2259 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2260 if (rts_argv[arg][3] != '\0') {
2261 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2263 errorBelch("missing size of PackBuffer (for -qQ)\n");
2266 IF_PAR_DEBUG(verbose,
2267 debugBelch("-qQ<n>: pack buffer size set to %d",
2268 RtsFlags.ParFlags.packBufferSize));
2272 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2273 IF_PAR_DEBUG(verbose,
2274 debugBelch("-qR: fair-ish scheduling"));
2279 if (rts_argv[arg][3] != '\0') {
2280 RtsFlags.ParFlags.wait
2281 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2283 RtsFlags.ParFlags.wait = 1000;
2285 IF_PAR_DEBUG(verbose,
2286 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2287 RtsFlags.ParFlags.wait));
2290 case 'D': /* -qD ... all the debugging options */
2291 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2292 /* hack warning: interpret the flags as a binary number */
2293 nat n = decode(rts_argv[arg]+3);
2294 set_par_debug_options(n);
2297 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2298 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2301 if (i==MAX_PAR_DEBUG_OPTION+1) {
2302 errorBelch("Valid GUM debug options are:\n");
2303 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2304 bad_option( rts_argv[arg] );
2305 } else { // flag found; now set it
2306 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2312 errorBelch("Unknown option -q%c (%d opts in total)",
2313 rts_argv[arg][2], *rts_argc);
2319 Interpret n as a binary number masking Par debug options and set the
2320 correxponding option. See par_debug_opts_strs for explanations of the flags.
2323 set_par_debug_options(nat n) {
2326 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2328 debugBelch(par_debug_opts_strs[i]);
2330 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2331 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2332 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2333 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2334 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2335 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2336 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2337 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2338 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2339 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2340 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2341 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2342 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2343 default: barf("set_par_debug_options: only %d debug options expected",
2344 MAX_PAR_DEBUG_OPTION);
2350 Print one line explanation for each of the GranSim debug options specified
2354 help_par_debug_options(nat n) {
2357 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2359 debugBelch(par_debug_opts_strs[i]);
2365 stats_fprintf(FILE *f, char *s, ...)
2377 static int /* return -1 on error */
2380 int argc, char *argv[],
2381 int rts_argc, char *rts_argv[],
2382 const char *FILENAME_FMT,
2387 if (strequal(rts_argv[arg]+2, "stderr")
2388 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
2389 f = NULL; /* NULL means use debugBelch */
2391 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2392 f = fopen(rts_argv[arg]+2,"w");
2394 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2395 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2396 f = fopen(stats_filename,"w");
2399 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2406 /* Write argv and rtsv into start of stats file */
2408 for(count = 0; count < argc; count++) {
2409 stats_fprintf(f, "%s ", argv[count]);
2411 stats_fprintf(f, "+RTS ");
2412 for(count = 0; count < rts_argc; count++)
2413 stats_fprintf(f, "%s ", rts_argv[count]);
2414 stats_fprintf(f, "\n");
2422 decode(const char *s)
2433 if (c == 'g' || c == 'G')
2434 m *= 1000*1000*1000; /* UNchecked! */
2435 else if (c == 'm' || c == 'M')
2436 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2437 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2438 m *= 1000; /* a direct-mapped cache. */
2439 else if (c == 'w' || c == 'W')
2446 bad_option(const char *s)
2448 errorBelch("bad RTS option: %s", s);
2449 stg_exit(EXIT_FAILURE);
2452 /* -----------------------------------------------------------------------------
2453 Getting/Setting the program's arguments.
2455 These are used by System.Environment, and parts of the RTS.
2456 -------------------------------------------------------------------------- */
2459 setProgName(char *argv[])
2461 /* Remove directory from argv[0] -- default files in current directory */
2462 #if !defined(mingw32_HOST_OS)
2464 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2465 prog_name = last_slash+1;
2467 prog_name = argv[0];
2470 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2471 while ( last_slash > argv[0] ) {
2472 if ( *last_slash == '/' || *last_slash == '\\' ) {
2473 prog_name = last_slash+1;
2478 prog_name = argv[0];
2483 getProgArgv(int *argc, char **argv[])
2485 if (argc) { *argc = prog_argc; }
2486 if (argv) { *argv = prog_argv; }
2490 setProgArgv(int argc, char *argv[])
2492 /* Usually this is done by startupHaskell, so we don't need to call this.
2493 However, sometimes Hugs wants to change the arguments which Haskell
2494 getArgs >>= ... will be fed. So you can do that by calling here
2495 _after_ calling startupHaskell.
2499 setProgName(prog_argv);
2502 /* These functions record and recall the full arguments, including the
2503 +RTS ... -RTS options. The reason for adding them was so that the
2504 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2506 getFullProgArgv(int *argc, char **argv[])
2508 if (argc) { *argc = full_prog_argc; }
2509 if (argv) { *argv = full_prog_argv; }
2513 setFullProgArgv(int argc, char *argv[])
2516 full_prog_argc = argc;
2517 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2518 "setFullProgArgv 1");
2519 for (i = 0; i < argc; i++) {
2520 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2521 "setFullProgArgv 2");
2522 strcpy(full_prog_argv[i], argv[i]);
2524 full_prog_argv[argc] = NULL;