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"
35 * Split argument lists
37 int prog_argc = 0; /* an "int" so as to match normal "argc" */
38 char **prog_argv = NULL;
39 int full_prog_argc = 0; /* an "int" so as to match normal "argc" */
40 char **full_prog_argv = NULL;
41 char *prog_name = NULL; /* 'basename' of prog_argv[0] */
42 int rts_argc = 0; /* ditto */
43 char *rts_argv[MAX_RTS_ARGS];
46 * constants, used later
53 static char *gran_debug_opts_strs[] = {
54 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
55 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
56 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
57 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
58 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
59 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
60 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
61 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
62 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
63 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
64 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
65 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
66 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
67 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
68 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
71 /* one character codes for the available debug options */
72 static char gran_debug_opts_flags[] = {
73 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
78 static char *par_debug_opts_strs[] = {
79 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
80 "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
81 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
82 "DEBUG (-qDe, -qD8): free; free messages.\n",
83 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
84 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
85 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
86 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
87 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
88 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
89 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
90 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
91 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
92 "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
95 /* one character codes for the available debug options */
96 static char par_debug_opts_flags[] = {
97 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
102 /* -----------------------------------------------------------------------------
103 Static function decls
104 -------------------------------------------------------------------------- */
106 static int /* return NULL on error */
109 int argc, char *argv[],
110 int rts_argc, char *rts_argv[],
111 const char *FILENAME_FMT,
114 static I_ decode(const char *s);
115 static void bad_option(const char *s);
118 static void enable_GranSimLight(void);
119 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
120 static void set_GranSim_debug_options(nat n);
121 static void help_GranSim_debug_options(nat n);
123 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
124 static void set_par_debug_options(nat n);
125 static void help_par_debug_options(nat n);
128 /* -----------------------------------------------------------------------------
129 * Command-line option parsing routines.
130 * ---------------------------------------------------------------------------*/
132 void initRtsFlagsDefaults(void)
134 RtsFlags.GcFlags.statsFile = NULL;
135 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
137 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
138 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
140 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
141 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
142 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
143 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
144 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
145 RtsFlags.GcFlags.oldGenFactor = 2;
147 /* A hack currently needed for GUM -- HWL */
148 RtsFlags.GcFlags.generations = 1;
149 RtsFlags.GcFlags.steps = 2;
150 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
152 RtsFlags.GcFlags.generations = 2;
153 RtsFlags.GcFlags.steps = 2;
154 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
156 RtsFlags.GcFlags.compact = rtsFalse;
157 RtsFlags.GcFlags.compactThreshold = 30.0;
158 RtsFlags.GcFlags.sweep = rtsFalse;
159 #ifdef RTS_GTK_FRONTPANEL
160 RtsFlags.GcFlags.frontpanel = rtsFalse;
162 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
165 /* ToDo: Perhaps by adjusting this value we can make linking without
166 * -static work (i.e., not generate a core-dumping executable)? */
167 # if SIZEOF_VOID_P == 8
168 RtsFlags.GcFlags.heapBase = 0x180000000L;
170 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
173 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
177 RtsFlags.DebugFlags.scheduler = rtsFalse;
178 RtsFlags.DebugFlags.interpreter = rtsFalse;
179 RtsFlags.DebugFlags.weak = rtsFalse;
180 RtsFlags.DebugFlags.gccafs = rtsFalse;
181 RtsFlags.DebugFlags.gc = rtsFalse;
182 RtsFlags.DebugFlags.block_alloc = rtsFalse;
183 RtsFlags.DebugFlags.sanity = rtsFalse;
184 RtsFlags.DebugFlags.stable = rtsFalse;
185 RtsFlags.DebugFlags.stm = rtsFalse;
186 RtsFlags.DebugFlags.prof = rtsFalse;
187 RtsFlags.DebugFlags.gran = rtsFalse;
188 RtsFlags.DebugFlags.par = rtsFalse;
189 RtsFlags.DebugFlags.apply = rtsFalse;
190 RtsFlags.DebugFlags.linker = rtsFalse;
191 RtsFlags.DebugFlags.squeeze = rtsFalse;
192 RtsFlags.DebugFlags.hpc = rtsFalse;
195 #if defined(PROFILING) || defined(PAR)
196 RtsFlags.CcFlags.doCostCentres = 0;
197 #endif /* PROFILING or PAR */
199 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
200 RtsFlags.ProfFlags.profileInterval = 100;
203 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
204 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
205 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
206 RtsFlags.ProfFlags.ccsLength = 25;
207 RtsFlags.ProfFlags.modSelector = NULL;
208 RtsFlags.ProfFlags.descrSelector = NULL;
209 RtsFlags.ProfFlags.typeSelector = NULL;
210 RtsFlags.ProfFlags.ccSelector = NULL;
211 RtsFlags.ProfFlags.ccsSelector = NULL;
212 RtsFlags.ProfFlags.retainerSelector = NULL;
213 RtsFlags.ProfFlags.bioSelector = NULL;
216 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
217 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
219 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
220 RtsFlags.MiscFlags.machineReadable = rtsFalse;
221 RtsFlags.MiscFlags.linkerMemBase = 0;
224 RtsFlags.ParFlags.nNodes = 1;
225 RtsFlags.ParFlags.migrate = rtsTrue;
226 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
227 RtsFlags.ParFlags.parGcEnabled = 1;
228 RtsFlags.ParFlags.parGcGen = 1;
229 RtsFlags.ParFlags.parGcLoadBalancing = 1;
233 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
234 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
235 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
236 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
237 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
238 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
239 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
241 RtsFlags.ParFlags.outputDisabled = rtsFalse;
243 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
245 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
247 RtsFlags.ParFlags.packBufferSize = 1024;
248 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
249 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
250 RtsFlags.ParFlags.maxThreads = 1024;
251 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
252 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
255 #if defined(PAR) || defined(THREADED_RTS)
256 RtsFlags.ParFlags.maxLocalSparks = 4096;
257 #endif /* PAR || THREADED_RTS */
260 /* ToDo: check defaults for GranSim and GUM */
261 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
262 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
264 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
265 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
266 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
267 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
268 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
269 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
270 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
271 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
273 RtsFlags.GranFlags.packBufferSize = 1024;
274 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
276 RtsFlags.GranFlags.proc = MAX_PROC;
277 RtsFlags.GranFlags.Fishing = rtsFalse;
278 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
279 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
280 RtsFlags.GranFlags.Light = rtsFalse;
282 RtsFlags.GranFlags.Costs.latency = LATENCY;
283 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
284 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
285 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
286 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
287 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
288 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
289 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
291 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
292 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
293 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
294 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
295 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
297 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
298 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
299 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
300 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
301 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
303 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
305 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
306 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
308 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
309 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
310 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
311 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
312 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
313 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
314 RtsFlags.GranFlags.FetchStrategy = 2;
315 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
316 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
317 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
318 RtsFlags.GranFlags.SparkPriority = 0;
319 RtsFlags.GranFlags.SparkPriority2 = 0;
320 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
321 RtsFlags.GranFlags.InversePriorities = rtsFalse;
322 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
323 RtsFlags.GranFlags.ThunksToPack = 0;
324 RtsFlags.GranFlags.RandomSteal = rtsTrue;
328 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
329 RtsFlags.TickyFlags.tickyFile = NULL;
332 RtsFlags.TraceFlags.timestamp = rtsFalse;
333 RtsFlags.TraceFlags.sched = rtsFalse;
334 RtsFlags.TraceFlags.gc = rtsFalse;
337 /* By default no special measurements taken */
338 RtsFlags.PapiFlags.eventType = 0;
339 RtsFlags.PapiFlags.numUserEvents = 0;
346 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
348 " +RTS Indicates run time system options follow",
349 " -RTS Indicates program arguments follow",
350 " --RTS Indicates that ALL subsequent arguments will be given to the",
351 " program (including any of these RTS flags)",
353 "The following run time system options are available:",
355 " -? Prints this message and exits; the program is not executed",
356 " --info Print information about the RTS used by this program",
358 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
359 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
361 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
362 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
363 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
364 " -m<n> Minimum % of heap which must be available (default 3%)",
365 " -G<n> Number of generations (default: 2)",
366 " -T<n> Number of steps in younger generations (default: 2)",
367 " -c<n> Auto-enable compaction of the oldest generation when live data is",
368 " at least <n>% of the maximum heap size set with -M (default: 30%)",
369 " -c Enable compaction for all major collections",
370 " -w Use mark-region for the oldest generation (experimental)",
371 #if defined(THREADED_RTS)
372 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
375 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
376 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
377 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
378 #ifdef RTS_GTK_FRONTPANEL
379 " -f Display front panel (requires X11 & GTK+)",
383 " -Z Don't squeeze out update frames on stack overflow",
384 " -B Sound the bell at the start of each garbage collection",
385 #if defined(PROFILING) || defined(PAR)
387 " -px Time/allocation profile (XML) (output file <program>.prof)",
388 " -p Time/allocation profile (output file <program>.prof)",
389 " -P More detailed Time/Allocation profile",
390 " -Pa Give information about *all* cost centres",
392 # if defined(PROFILING)
394 " -hx Heap residency profile (XML) (output file <program>.prof)",
395 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
396 " break-down: c = cost centre stack (default)",
398 " d = closure description",
399 " y = type description",
401 " b = biography (LAG,DRAG,VOID,USE)",
402 " A subset of closures may be selected thusly:",
403 " -hc<cc>,... specific cost centre(s) (top of stack only)",
404 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
405 " -hm<mod>... all cost centres from the specified modules(s)",
406 " -hd<des>,... closures with specified closure descriptions",
407 " -hy<typ>... closures with specified type descriptions",
408 " -hr<cc>... closures with specified retainers",
409 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
411 " -R<size> Set the maximum retainer set size (default: 8)",
413 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
416 " -xt Include threads (TSOs) in a heap profile",
418 " -xc Show current cost centre stack on raising an exception",
421 #endif /* PROFILING or PAR */
422 #if !defined(PROFILING)
424 " -hT Heap residency profile (output file <program>.hp)",
426 " -i<sec> Time between heap samples (seconds, default: 0.1)",
428 #if defined(TICKY_TICKY)
429 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
433 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
434 /* NB: the -N<n> is implemented by the driver!! */
436 " -C<secs> Context-switch interval in seconds.",
437 " 0 or no argument means switch as often as possible.",
438 " Default: 0.02 sec; resolution is set by -V below.",
439 " -V<secs> Master tick interval in seconds (0 == disable timer).",
440 " This sets the resolution for -C and the profile timer -i.",
441 " Default: 0.02 sec.",
443 " -vs Trace scheduler events (see also -Ds with -debug)",
444 " -vt Time-stamp trace messages",
447 " -Ds DEBUG: scheduler",
448 " -Di DEBUG: interpreter",
450 " -DG DEBUG: gccafs",
453 " -DS DEBUG: sanity",
454 " -Dt DEBUG: stable",
459 " -Dl DEBUG: linker",
461 " -Dz DEBUG: stack squezing",
462 " -Dc DEBUG: program coverage",
465 #if defined(THREADED_RTS) && !defined(NOSMP)
466 " -N<n> Use <n> processors (default: 1)",
467 " -N Determine the number of processors to use automatically",
468 " -q1 Use one OS thread for GC (turns off parallel GC)",
469 " -qg<n> Use parallel GC only for generations >= <n> (default: 1)",
470 " -qm Don't automatically migrate threads between CPUs",
471 " -qw Migrate a thread to the current CPU when it is woken up",
473 " --install-signal-handlers=<yes|no>",
474 " Install signal handlers (default: yes)",
475 #if defined(THREADED_RTS) || defined(PAR)
476 " -e<size> Size of spark pools (default 100)",
479 " -t<num> Set maximum number of advisory threads per PE (default 32)",
480 " -qP Enable activity profile (output files in ~/<program>*.gr)",
481 " -qQ<size> Set pack-buffer size (default: 1024)",
482 " -qd Turn on PVM-ish debugging",
483 " -qO Disable output for performance measurement",
485 #if defined(THREADED_RTS) || defined(PAR)
486 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
489 " -d Turn on PVM-ish debugging",
490 " -O Disable output for performance measurement",
492 #if defined(GRAN) /* ToDo: fill in decent Docu here */
493 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
495 #if defined(x86_64_HOST_ARCH)
496 " -xm Base address to mmap memory in the GHCi linker",
497 " (hex; must be <80000000)",
499 #if defined(USE_PAPI)
500 " -aX CPU performance counter measurements using PAPI",
501 " (use with the -s<file> option). X is one of:",
504 " 1 - level 1 cache misses",
505 " 2 - level 2 cache misses",
506 " b - branch mispredictions",
507 " s - stalled cycles",
508 " e - cache miss and branch misprediction events",
511 "RTS options may also be specified using the GHCRTS environment variable.",
513 "Other RTS options may be available for programs compiled a different way.",
514 "The GHC User's Guide has full details.",
519 STATIC_INLINE rtsBool
520 strequal(const char *a, const char * b)
522 return(strcmp(a, b) == 0);
526 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
532 while (isspace(*c1)) { c1++; };
534 while (!isspace(*c2) && *c2 != '\0') { c2++; };
536 if (c1 == c2) { break; }
538 if (*rts_argc < MAX_RTS_ARGS-1) {
539 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
540 strncpy(s, c1, c2-c1);
542 rts_argv[(*rts_argc)++] = s;
544 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
548 } while (*c1 != '\0');
552 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
554 rtsBool error = rtsFalse;
565 // process arguments from the ghc_rts_opts global variable first.
566 // (arguments from the GHCRTS environment variable and the command
567 // line override these).
569 if (ghc_rts_opts != NULL) {
570 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
574 // process arguments from the GHCRTS environment variable next
575 // (arguments from the command line override these).
577 char *ghc_rts = getenv("GHCRTS");
579 if (ghc_rts != NULL) {
580 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
584 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
585 // argv[0] must be PGM argument -- leave in argv
587 for (mode = PGM; arg < total_arg; arg++) {
588 // The '--RTS' argument disables all future +RTS ... -RTS processing.
589 if (strequal("--RTS", argv[arg])) {
593 // The '--' argument is passed through to the program, but
594 // disables all further +RTS ... -RTS processing.
595 else if (strequal("--", argv[arg])) {
598 else if (strequal("+RTS", argv[arg])) {
601 else if (strequal("-RTS", argv[arg])) {
604 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
605 rts_argv[(*rts_argc)++] = argv[arg];
607 else if (mode == PGM) {
608 argv[(*argc)++] = argv[arg];
611 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
614 // process remaining program arguments
615 for (; arg < total_arg; arg++) {
616 argv[(*argc)++] = argv[arg];
618 argv[*argc] = (char *) 0;
619 rts_argv[*rts_argc] = (char *) 0;
621 // Process RTS (rts_argv) part: mainly to determine statsfile
622 for (arg = 0; arg < *rts_argc; arg++) {
623 if (rts_argv[arg][0] != '-') {
625 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
629 switch(rts_argv[arg][1]) {
631 /* process: general args, then PROFILING-only ones,
632 then CONCURRENT-only, PARallel-only, GRAN-only,
633 TICKY-only (same order as defined in RtsFlags.lh);
634 within those groups, mostly in case-insensitive
636 Final group is x*, which allows for more options.
640 # define TICKY_BUILD_ONLY(x) x
642 # define TICKY_BUILD_ONLY(x) \
643 errorBelch("not built for: ticky-ticky stats"); \
647 #if defined(PROFILING)
648 # define COST_CENTRE_USING_BUILD_ONLY(x) x
650 # define COST_CENTRE_USING_BUILD_ONLY(x) \
651 errorBelch("not built for: -prof or -parallel"); \
656 # define PROFILING_BUILD_ONLY(x) x
658 # define PROFILING_BUILD_ONLY(x) \
659 errorBelch("not built for: -prof"); \
664 # define PAR_BUILD_ONLY(x) x
666 # define PAR_BUILD_ONLY(x) \
667 errorBelch("not built for: -parallel"); \
672 # define THREADED_BUILD_ONLY(x) x
674 # define THREADED_BUILD_ONLY(x) \
675 errorBelch("not built for: -smp"); \
679 #if defined(THREADED_RTS) || defined(PAR)
680 # define PAR_OR_THREADED_BUILD_ONLY(x) x
682 # define PAR_OR_THREADED_BUILD_ONLY(x) \
683 errorBelch("not built for: -parallel or -smp"); \
688 # define GRAN_BUILD_ONLY(x) x
690 # define GRAN_BUILD_ONLY(x) \
691 errorBelch("not built for: -gransim"); \
695 /* =========== GENERAL ========================== */
700 /* This isn't going to allow us to keep related options
701 together as we add more --* flags. We really need a
702 proper options parser. */
704 if (strequal("install-signal-handlers=yes",
705 &rts_argv[arg][2])) {
706 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
708 else if (strequal("install-signal-handlers=no",
709 &rts_argv[arg][2])) {
710 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
712 else if (strequal("machine-readable",
713 &rts_argv[arg][2])) {
714 RtsFlags.MiscFlags.machineReadable = rtsTrue;
716 else if (strequal("info",
717 &rts_argv[arg][2])) {
722 errorBelch("unknown RTS option: %s",rts_argv[arg]);
727 RtsFlags.GcFlags.minAllocAreaSize
728 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
729 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
730 bad_option(rts_argv[arg]);
736 switch(rts_argv[arg][2]) {
738 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
741 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
744 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
747 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
750 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
753 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
754 errorBelch("maximum number of PAPI events reached");
755 stg_exit(EXIT_FAILURE);
757 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
758 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
761 bad_option( rts_argv[arg] );
767 RtsFlags.GcFlags.ringBell = rtsTrue;
771 if (rts_argv[arg][2] != '\0') {
772 RtsFlags.GcFlags.compactThreshold =
773 atof(rts_argv[arg]+2);
775 RtsFlags.GcFlags.compact = rtsTrue;
780 RtsFlags.GcFlags.sweep = rtsTrue;
784 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
786 if (RtsFlags.GcFlags.oldGenFactor < 0)
787 bad_option( rts_argv[arg] );
795 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
798 RtsFlags.DebugFlags.scheduler = rtsTrue;
801 RtsFlags.DebugFlags.interpreter = rtsTrue;
804 RtsFlags.DebugFlags.weak = rtsTrue;
807 RtsFlags.DebugFlags.gccafs = rtsTrue;
810 RtsFlags.DebugFlags.gc = rtsTrue;
813 RtsFlags.DebugFlags.block_alloc = rtsTrue;
816 RtsFlags.DebugFlags.sanity = rtsTrue;
819 RtsFlags.DebugFlags.stable = rtsTrue;
822 RtsFlags.DebugFlags.prof = rtsTrue;
825 RtsFlags.DebugFlags.gran = rtsTrue;
828 RtsFlags.DebugFlags.par = rtsTrue;
831 RtsFlags.DebugFlags.linker = rtsTrue;
834 RtsFlags.DebugFlags.apply = rtsTrue;
837 RtsFlags.DebugFlags.stm = rtsTrue;
840 RtsFlags.DebugFlags.squeeze = rtsTrue;
843 RtsFlags.DebugFlags.hpc = rtsTrue;
846 bad_option( rts_argv[arg] );
854 RtsFlags.GcFlags.maxStkSize =
855 decode(rts_argv[arg]+2) / sizeof(W_);
857 if (RtsFlags.GcFlags.maxStkSize == 0)
858 bad_option( rts_argv[arg] );
862 RtsFlags.GcFlags.initialStkSize =
863 decode(rts_argv[arg]+2) / sizeof(W_);
865 if (RtsFlags.GcFlags.initialStkSize == 0)
866 bad_option( rts_argv[arg] );
870 RtsFlags.GcFlags.maxHeapSize =
871 decode(rts_argv[arg]+2) / BLOCK_SIZE;
872 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
874 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
875 bad_option(rts_argv[arg]);
880 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
882 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
883 RtsFlags.GcFlags.pcFreeHeap > 100)
884 bad_option( rts_argv[arg] );
888 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
889 if (RtsFlags.GcFlags.generations < 1) {
890 bad_option(rts_argv[arg]);
895 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
896 if (RtsFlags.GcFlags.steps < 1) {
897 bad_option(rts_argv[arg]);
902 RtsFlags.GcFlags.heapSizeSuggestion =
903 decode(rts_argv[arg]+2) / BLOCK_SIZE;
906 #ifdef RTS_GTK_FRONTPANEL
908 RtsFlags.GcFlags.frontpanel = rtsTrue;
912 case 'I': /* idle GC delay */
913 if (rts_argv[arg][2] == '\0') {
918 /* Convert to millisecs */
919 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
920 RtsFlags.GcFlags.idleGCDelayTime = cst;
925 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
929 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
933 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
938 /* Opening all those files would almost certainly fail... */
939 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
940 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
944 r = open_stats_file(arg, *argc, argv,
945 *rts_argc, rts_argv, NULL,
946 &RtsFlags.GcFlags.statsFile);
947 if (r == -1) { error = rtsTrue; }
953 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
956 /* =========== PROFILING ========================== */
958 case 'P': /* detailed cost centre profiling (time/alloc) */
959 case 'p': /* cost centre profiling (time/alloc) */
960 COST_CENTRE_USING_BUILD_ONLY(
961 switch (rts_argv[arg][2]) {
963 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
966 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
969 if (rts_argv[arg][1] == 'P') {
970 RtsFlags.CcFlags.doCostCentres =
971 COST_CENTRES_VERBOSE;
973 RtsFlags.CcFlags.doCostCentres =
974 COST_CENTRES_SUMMARY;
981 PROFILING_BUILD_ONLY(
982 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
985 PROFILING_BUILD_ONLY(
986 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
987 if(RtsFlags.ProfFlags.ccsLength <= 0) {
988 bad_option(rts_argv[arg]);
991 case 'h': /* serial heap profile */
992 #if !defined(PROFILING)
993 switch (rts_argv[arg][2]) {
996 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
999 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1003 PROFILING_BUILD_ONLY(
1004 switch (rts_argv[arg][2]) {
1018 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
1020 char *left = strchr(rts_argv[arg], '{');
1021 char *right = strrchr(rts_argv[arg], '}');
1023 // curly braces are optional, for
1024 // backwards compat.
1028 left = rts_argv[arg] + 3;
1031 right = rts_argv[arg] + strlen(rts_argv[arg]);
1035 switch (rts_argv[arg][2]) {
1036 case 'c': // cost centre label select
1037 RtsFlags.ProfFlags.ccSelector = left;
1040 RtsFlags.ProfFlags.ccsSelector = left;
1043 case 'm': // cost centre module select
1044 RtsFlags.ProfFlags.modSelector = left;
1047 case 'd': // closure descr select
1048 RtsFlags.ProfFlags.descrSelector = left;
1051 case 'y': // closure type select
1052 RtsFlags.ProfFlags.typeSelector = left;
1055 case 'r': // retainer select
1056 RtsFlags.ProfFlags.retainerSelector = left;
1059 case 'b': // biography select
1060 RtsFlags.ProfFlags.bioSelector = left;
1067 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1068 errorBelch("multiple heap profile options");
1073 switch (rts_argv[arg][2]) {
1077 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1081 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1085 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1089 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1093 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1097 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1103 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1107 #endif /* PROFILING */
1110 case 'i': /* heap sample interval */
1111 if (rts_argv[arg][2] == '\0') {
1116 /* Convert to milliseconds */
1117 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1118 RtsFlags.ProfFlags.profileInterval = cst;
1122 /* =========== CONCURRENT ========================= */
1123 case 'C': /* context switch interval */
1124 if (rts_argv[arg][2] == '\0')
1125 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1129 /* Convert to milliseconds */
1130 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1131 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1135 case 'V': /* master tick interval */
1136 if (rts_argv[arg][2] == '\0') {
1137 // turns off ticks completely
1138 RtsFlags.MiscFlags.tickInterval = 0;
1142 /* Convert to milliseconds */
1143 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1144 RtsFlags.MiscFlags.tickInterval = cst;
1148 #if defined(THREADED_RTS) && !defined(NOSMP)
1150 THREADED_BUILD_ONLY(
1151 if (rts_argv[arg][2] == '\0') {
1152 #if defined(PROFILING)
1153 RtsFlags.ParFlags.nNodes = 1;
1155 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1158 RtsFlags.ParFlags.nNodes
1159 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1160 if (RtsFlags.ParFlags.nNodes <= 0) {
1161 errorBelch("bad value for -N");
1164 #if defined(PROFILING)
1165 if (RtsFlags.ParFlags.nNodes > 1) {
1166 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1174 THREADED_BUILD_ONLY(
1175 switch (rts_argv[arg][2]) {
1177 // backwards compat only
1178 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1181 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1188 switch (rts_argv[arg][2]) {
1190 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1194 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1197 if (rts_argv[arg][3] != '\0') {
1198 RtsFlags.ParFlags.parGcGen
1199 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1201 errorBelch("bad value for -qg");
1206 RtsFlags.ParFlags.parGcLoadBalancing = rtsFalse;
1209 RtsFlags.ParFlags.migrate = rtsFalse;
1212 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1215 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1221 /* =========== PARALLEL =========================== */
1223 PAR_OR_THREADED_BUILD_ONLY(
1224 if (rts_argv[arg][2] != '\0') {
1225 RtsFlags.ParFlags.maxLocalSparks
1226 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1227 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1228 errorBelch("bad value for -e");
1237 process_par_option(arg, rts_argc, rts_argv, &error);
1241 /* =========== GRAN =============================== */
1245 process_gran_option(arg, rts_argc, rts_argv, &error);
1248 /* =========== TICKY ============================== */
1250 case 'r': /* Basic profiling stats */
1253 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1257 r = open_stats_file(arg, *argc, argv,
1258 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1259 &RtsFlags.TickyFlags.tickyFile);
1260 if (r == -1) { error = rtsTrue; }
1264 /* =========== TRACING ---------=================== */
1267 switch(rts_argv[arg][2]) {
1269 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1273 RtsFlags.TraceFlags.timestamp = rtsTrue;
1276 RtsFlags.TraceFlags.sched = rtsTrue;
1279 RtsFlags.TraceFlags.gc = rtsTrue;
1282 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1288 /* =========== EXTENDED OPTIONS =================== */
1290 case 'x': /* Extend the argument space */
1291 switch(rts_argv[arg][2]) {
1293 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1297 case 'b': /* heapBase in hex; undocumented */
1298 if (rts_argv[arg][3] != '\0') {
1299 RtsFlags.GcFlags.heapBase
1300 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1302 errorBelch("-xb: requires argument");
1307 #if defined(x86_64_HOST_ARCH)
1308 case 'm': /* linkerMemBase */
1309 if (rts_argv[arg][3] != '\0') {
1310 RtsFlags.MiscFlags.linkerMemBase
1311 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1312 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1313 errorBelch("-xm: value must be <80000000");
1317 RtsFlags.MiscFlags.linkerMemBase = 0;
1322 case 'c': /* Debugging tool: show current cost centre on an exception */
1323 PROFILING_BUILD_ONLY(
1324 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1328 case 't': /* Include memory used by TSOs in a heap profile */
1329 PROFILING_BUILD_ONLY(
1330 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1334 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1337 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1341 break; /* defensive programming */
1343 /* =========== OH DEAR ============================ */
1345 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1352 if (RtsFlags.MiscFlags.tickInterval < 0) {
1353 RtsFlags.MiscFlags.tickInterval = 50;
1356 // If the master timer is disabled, turn off the other timers.
1357 if (RtsFlags.MiscFlags.tickInterval == 0) {
1358 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1359 RtsFlags.GcFlags.idleGCDelayTime = 0;
1360 RtsFlags.ProfFlags.profileInterval = 0;
1363 // Determine what tick interval we should use for the RTS timer
1364 // by taking the shortest of the various intervals that we need to
1366 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1367 RtsFlags.MiscFlags.tickInterval =
1368 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1369 RtsFlags.MiscFlags.tickInterval);
1372 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1373 RtsFlags.MiscFlags.tickInterval =
1374 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1375 RtsFlags.MiscFlags.tickInterval);
1378 if (RtsFlags.ProfFlags.profileInterval > 0) {
1379 RtsFlags.MiscFlags.tickInterval =
1380 stg_min(RtsFlags.ProfFlags.profileInterval,
1381 RtsFlags.MiscFlags.tickInterval);
1384 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1385 RtsFlags.ConcFlags.ctxtSwitchTicks =
1386 RtsFlags.ConcFlags.ctxtSwitchTime /
1387 RtsFlags.MiscFlags.tickInterval;
1389 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1392 if (RtsFlags.ProfFlags.profileInterval > 0) {
1393 RtsFlags.ProfFlags.profileIntervalTicks =
1394 RtsFlags.ProfFlags.profileInterval /
1395 RtsFlags.MiscFlags.tickInterval;
1397 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1404 for (p = usage_text; *p; p++)
1405 errorBelch("%s", *p);
1406 stg_exit(EXIT_FAILURE);
1413 enable_GranSimLight(void) {
1415 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1416 RtsFlags.GranFlags.Light=rtsTrue;
1417 RtsFlags.GranFlags.Costs.latency =
1418 RtsFlags.GranFlags.Costs.fetchtime =
1419 RtsFlags.GranFlags.Costs.additional_latency =
1420 RtsFlags.GranFlags.Costs.gunblocktime =
1421 RtsFlags.GranFlags.Costs.lunblocktime =
1422 RtsFlags.GranFlags.Costs.threadcreatetime =
1423 RtsFlags.GranFlags.Costs.threadqueuetime =
1424 RtsFlags.GranFlags.Costs.threadscheduletime =
1425 RtsFlags.GranFlags.Costs.threaddescheduletime =
1426 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1428 RtsFlags.GranFlags.Costs.mpacktime =
1429 RtsFlags.GranFlags.Costs.munpacktime = 0;
1431 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1432 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1433 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1434 /* FetchStrategy is irrelevant in GrAnSim-Light */
1436 /* GrAnSim Light often creates an abundance of parallel threads,
1437 each with its own stack etc. Therefore, it's in general a good
1438 idea to use small stack chunks (use the -o<size> option to
1441 // RtsFlags.ConcFlags.stkChunkSize = 100;
1443 RtsFlags.GranFlags.proc = 1;
1447 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1449 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1452 /* or a ridiculously idealised simulator */
1453 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1454 RtsFlags.GranFlags.Costs.latency =
1455 RtsFlags.GranFlags.Costs.fetchtime =
1456 RtsFlags.GranFlags.Costs.additional_latency =
1457 RtsFlags.GranFlags.Costs.gunblocktime =
1458 RtsFlags.GranFlags.Costs.lunblocktime =
1459 RtsFlags.GranFlags.Costs.threadcreatetime =
1460 RtsFlags.GranFlags.Costs.threadqueuetime =
1461 RtsFlags.GranFlags.Costs.threadscheduletime =
1462 RtsFlags.GranFlags.Costs.threaddescheduletime =
1463 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1465 RtsFlags.GranFlags.Costs.mpacktime =
1466 RtsFlags.GranFlags.Costs.munpacktime = 0;
1468 RtsFlags.GranFlags.Costs.arith_cost =
1469 RtsFlags.GranFlags.Costs.float_cost =
1470 RtsFlags.GranFlags.Costs.load_cost =
1471 RtsFlags.GranFlags.Costs.store_cost =
1472 RtsFlags.GranFlags.Costs.branch_cost = 0;
1474 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1476 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1477 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1478 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1479 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1483 /* or a somewhat idealised simulator */
1484 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1485 RtsFlags.GranFlags.Costs.latency =
1486 RtsFlags.GranFlags.Costs.fetchtime =
1487 RtsFlags.GranFlags.Costs.additional_latency =
1488 RtsFlags.GranFlags.Costs.gunblocktime =
1489 RtsFlags.GranFlags.Costs.lunblocktime =
1490 RtsFlags.GranFlags.Costs.threadcreatetime =
1491 RtsFlags.GranFlags.Costs.threadqueuetime =
1492 RtsFlags.GranFlags.Costs.threadscheduletime =
1493 RtsFlags.GranFlags.Costs.threaddescheduletime =
1494 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1496 RtsFlags.GranFlags.Costs.mpacktime =
1497 RtsFlags.GranFlags.Costs.munpacktime = 0;
1499 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1501 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1502 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1503 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1504 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1505 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1506 # if defined(GRAN_CHECK) && defined(GRAN)
1507 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1512 /* Communication and task creation cost parameters */
1513 switch(rts_argv[arg][2]) {
1515 IgnoreYields = rtsTrue; // HWL HACK
1519 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1523 if (rts_argv[arg][3] != '\0')
1525 RtsFlags.GranFlags.Costs.gunblocktime =
1526 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1527 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1530 RtsFlags.GranFlags.Costs.latency = LATENCY;
1534 if (rts_argv[arg][3] != '\0')
1535 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1537 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1541 if (rts_argv[arg][3] != '\0')
1542 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1544 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1548 if (rts_argv[arg][3] != '\0')
1549 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1551 RtsFlags.GranFlags.Costs.mtidytime = 0;
1555 if (rts_argv[arg][3] != '\0')
1556 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1558 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1562 if (rts_argv[arg][3] != '\0')
1563 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1565 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1569 if (rts_argv[arg][3] != '\0')
1570 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1572 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1576 if (rts_argv[arg][3] != '\0')
1577 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1579 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1582 /* Thread-related metrics */
1584 if (rts_argv[arg][3] != '\0')
1585 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1587 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1591 if (rts_argv[arg][3] != '\0')
1592 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1594 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1598 if (rts_argv[arg][3] != '\0')
1599 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1601 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1603 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1604 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1608 if (rts_argv[arg][3] != '\0')
1609 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1611 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1613 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1614 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1617 /* Instruction Cost Metrics */
1619 if (rts_argv[arg][3] != '\0')
1620 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1622 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1626 if (rts_argv[arg][3] != '\0')
1627 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1629 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1633 if (rts_argv[arg][3] != '\0')
1634 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1636 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1640 if (rts_argv[arg][3] != '\0')
1641 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1643 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1647 if (rts_argv[arg][3] != '\0')
1648 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1650 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1654 if (rts_argv[arg][3] != '\0')
1655 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1657 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1661 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1662 if (rts_argv[arg][3] != '\0')
1663 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1665 RtsFlags.GranFlags.FetchStrategy = 2;
1666 if (RtsFlags.GranFlags.FetchStrategy == 0)
1667 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1670 case 'K': /* sort overhead (per elem in spark list) */
1671 if (rts_argv[arg][3] != '\0')
1672 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1674 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1675 debugBelch("Overhead for pri spark: %d (per elem).\n",
1676 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1679 case 'O': /* sort overhead (per elem in spark list) */
1680 if (rts_argv[arg][3] != '\0')
1681 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1683 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1684 debugBelch("Overhead for pri sched: %d (per elem).\n",
1685 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1688 /* General Parameters */
1690 if (rts_argv[arg][3] != '\0')
1692 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1693 if (RtsFlags.GranFlags.proc==0) {
1694 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1695 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1696 RtsFlags.GranFlags.proc < 1)
1698 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1704 RtsFlags.GranFlags.proc = MAX_PROC;
1708 RtsFlags.GranFlags.Fishing = rtsTrue;
1709 if (rts_argv[arg][3] != '\0')
1710 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1712 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1716 if (rts_argv[arg][3] != '\0')
1717 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1719 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1723 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1724 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1728 debugBelch("Bulk fetching enabled.\n");
1729 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1733 debugBelch("Thread migration enabled.\n");
1734 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1738 debugBelch("Fair Scheduling enabled.\n");
1739 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1743 debugBelch("Priority Scheduling enabled.\n");
1744 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1748 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1749 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1753 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1757 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1761 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1765 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1769 /* format is -bP<c> where <c> is one char describing kind of profile */
1770 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1771 switch(rts_argv[arg][3]) {
1772 case '\0': break; // nothing special, just an ordinary profile
1773 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1775 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1777 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1779 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1781 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1783 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1785 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1790 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1794 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1797 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1798 if (rts_argv[arg][3] != '\0') {
1801 arg0 = rts_argv[arg]+3;
1802 if ((tmp = strstr(arg0,","))==NULL) {
1803 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1804 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1807 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1808 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1809 debugBelch("SparkPriority: %u.\n",
1810 RtsFlags.GranFlags.SparkPriority);
1811 debugBelch("SparkPriority2:%u.\n",
1812 RtsFlags.GranFlags.SparkPriority2);
1813 if (RtsFlags.GranFlags.SparkPriority2 <
1814 RtsFlags.GranFlags.SparkPriority) {
1815 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1816 RtsFlags.GranFlags.SparkPriority2,
1817 RtsFlags.GranFlags.SparkPriority);
1821 /* plain pri spark is now invoked with -bX
1822 RtsFlags.GranFlags.DoPrioritySparking = 1;
1823 debugBelch("PrioritySparking.\n");
1829 if (rts_argv[arg][3] != '\0') {
1830 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1832 RtsFlags.GranFlags.ThunksToPack = 1;
1834 debugBelch("Thunks To Pack in one packet: %u.\n",
1835 RtsFlags.GranFlags.ThunksToPack);
1839 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1840 debugBelch("Deterministic mode (no random stealing)\n");
1843 /* The following class of options contains eXperimental */
1844 /* features in connection with exploiting granularity */
1845 /* information. I.e. if -bY is chosen these options */
1846 /* tell the RTS what to do with the supplied info --HWL */
1849 if (rts_argv[arg][3] != '\0') {
1850 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1852 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1854 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1855 RtsFlags.GranFlags.packBufferSize_internal);
1859 switch(rts_argv[arg][3]) {
1862 RtsFlags.GranFlags.DoPrioritySparking = 1;
1863 debugBelch("Priority Sparking with Normal Priorities.\n");
1864 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1865 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1866 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1870 RtsFlags.GranFlags.DoPrioritySparking = 1;
1871 debugBelch("Priority Sparking with Inverse Priorities.\n");
1872 RtsFlags.GranFlags.InversePriorities++;
1876 RtsFlags.GranFlags.DoPrioritySparking = 1;
1877 debugBelch("Priority Sparking with Random Priorities.\n");
1878 RtsFlags.GranFlags.RandomPriorities++;
1882 RtsFlags.GranFlags.DoPrioritySparking = 1;
1883 debugBelch("Priority Sparking with No Priorities.\n");
1884 RtsFlags.GranFlags.IgnorePriorities++;
1888 bad_option( rts_argv[arg] );
1894 switch(rts_argv[arg][3]) {
1897 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1898 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1902 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1906 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1910 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1914 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1915 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1919 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1923 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1927 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1931 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1935 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1939 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1943 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1947 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1948 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1952 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1956 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1960 bad_option( rts_argv[arg] );
1965 # if defined(GRAN_CHECK) && defined(GRAN)
1967 switch(rts_argv[arg][3]) {
1968 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1969 if (rts_argv[arg][4] != '\0') {
1970 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1971 debugBelch("Pack buffer size: %d\n",
1972 RtsFlags.GranFlags.packBufferSize);
1974 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1980 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1981 /* hack warning: interpret the flags as a binary number */
1982 nat n = decode(rts_argv[arg]+3);
1983 set_GranSim_debug_options(n);
1986 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1987 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1990 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1991 debugBelch("Valid GranSim debug options are:\n");
1992 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1993 bad_option( rts_argv[arg] );
1994 } else { // flag found; now set it
1995 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
2001 case 'e': /* event trace; also -bD1 */
2002 debugBelch("DEBUG: event_trace; printing event trace.\n");
2003 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
2004 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
2007 case 'E': /* event statistics; also -bD2 */
2008 debugBelch("DEBUG: event_stats; printing event statistics.\n");
2009 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
2010 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
2013 case 'f': /* thunkStealing; also -bD4 */
2014 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
2015 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
2016 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
2019 case 'z': /* blockOnFetch; also -bD8 */
2020 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
2021 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
2022 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
2025 case 't': /* blockOnFetch_sanity; also -bD16 */
2026 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
2027 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
2028 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
2031 case 'S': /* priSpark; also -bD32 */
2032 debugBelch("DEBUG: priSpark; priority sparking.\n");
2033 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
2036 case 's': /* priSched; also -bD64 */
2037 debugBelch("DEBUG: priSched; priority scheduling.\n");
2038 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
2041 case 'F': /* findWork; also -bD128 */
2042 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
2043 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
2046 case 'g': /* globalBlock; also -bD256 */
2047 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
2048 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
2051 case 'G': /* pack; also -bD512 */
2052 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
2053 RtsFlags.GranFlags.Debug.pack = rtsTrue;
2056 case 'P': /* packBuffer; also -bD1024 */
2057 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
2058 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
2061 case 'o': /* sortedQ; also -bD2048 */
2062 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
2063 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
2066 case 'r': /* randomSteal; also -bD4096 */
2067 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2068 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2071 case 'q': /* checkSparkQ; also -bD8192 */
2072 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2073 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2076 case ':': /* checkLight; also -bD16384 */
2077 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2078 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2081 case 'b': /* bq; also -bD32768 */
2082 debugBelch("DEBUG: bq; check blocking queues\n");
2083 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2086 case 'd': /* all options turned on */
2087 debugBelch("DEBUG: all options turned on.\n");
2088 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2089 /* RtsFlags.GranFlags.Debug |= 0x40; */
2093 /* RtsFlags.GranFlags.Debug = 1; */
2099 # endif /* GRAN_CHECK */
2101 bad_option( rts_argv[arg] );
2107 Interpret n as a binary number masking GranSim debug options and set the
2108 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2111 set_GranSim_debug_options(nat n) {
2114 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2116 errorBelch(gran_debug_opts_strs[i]);
2118 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2119 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2120 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2121 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2122 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2123 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2124 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2125 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2126 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2127 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2128 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2129 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2130 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2131 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2132 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2133 default: barf("set_GranSim_debug_options: only %d debug options expected");
2139 Print one line explanation for each of the GranSim debug options specified
2143 help_GranSim_debug_options(nat n) {
2146 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2148 debugBelch(gran_debug_opts_strs[i]);
2154 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2157 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2158 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2162 /* Communication and task creation cost parameters */
2163 switch(rts_argv[arg][2]) {
2164 case 'e': /* -qe<n> ... allow <n> local sparks */
2165 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2166 RtsFlags.ParFlags.maxLocalSparks
2167 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2169 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2170 errorBelch("setupRtsFlags: bad value for -e\n");
2174 IF_PAR_DEBUG(verbose,
2175 errorBelch("-qe<n>: max %d local sparks",
2176 RtsFlags.ParFlags.maxLocalSparks));
2180 if (rts_argv[arg][3] != '\0') {
2181 RtsFlags.ParFlags.maxThreads
2182 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2184 errorBelch("missing size for -qt\n");
2187 IF_PAR_DEBUG(verbose,
2188 errorBelch("-qt<n>: max %d threads",
2189 RtsFlags.ParFlags.maxThreads));
2193 if (rts_argv[arg][3] != '\0')
2194 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2196 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2198 IF_PAR_DEBUG(verbose,
2199 errorBelch("-qf<n>: max %d fishes sent out at one time",
2200 RtsFlags.ParFlags.maxFishes));
2204 if (rts_argv[arg][3] != '\0') {
2205 RtsFlags.ParFlags.fishDelay
2206 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2208 errorBelch("missing fish delay time for -qF\n");
2211 IF_PAR_DEBUG(verbose,
2212 errorBelch("-qF<n>: fish delay time %d us",
2213 RtsFlags.ParFlags.fishDelay));
2217 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2218 IF_PAR_DEBUG(verbose,
2219 errorBelch("-qO: output disabled"));
2222 case 'g': /* -qg<n> ... globalisation scheme */
2223 if (rts_argv[arg][3] != '\0') {
2224 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2226 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2229 IF_PAR_DEBUG(verbose,
2230 debugBelch("-qg<n>: globalisation scheme set to %d",
2231 RtsFlags.ParFlags.globalising));
2234 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2235 if (rts_argv[arg][3] != '\0') {
2236 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2238 errorBelch("missing number of thunks per packet (for -qh)\n");
2241 IF_PAR_DEBUG(verbose,
2242 debugBelch("-qh<n>: thunks per packet set to %d",
2243 RtsFlags.ParFlags.thunksToPack));
2246 case 'P': /* -qP for writing a log file */
2247 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2248 /* same encoding as in GranSim after -bP */
2249 switch(rts_argv[arg][3]) {
2250 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2251 break; // nothing special, just an ordinary profile
2252 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2253 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2255 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2257 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2259 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2261 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2264 # if defined(PAR_TICKY)
2265 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2267 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2268 stg_exit(EXIT_FAILURE);
2271 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2273 IF_PAR_DEBUG(verbose,
2274 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2275 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2278 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2279 if (rts_argv[arg][3] != '\0') {
2280 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2282 errorBelch("missing size of PackBuffer (for -qQ)\n");
2285 IF_PAR_DEBUG(verbose,
2286 debugBelch("-qQ<n>: pack buffer size set to %d",
2287 RtsFlags.ParFlags.packBufferSize));
2291 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2292 IF_PAR_DEBUG(verbose,
2293 debugBelch("-qR: fair-ish scheduling"));
2298 if (rts_argv[arg][3] != '\0') {
2299 RtsFlags.ParFlags.wait
2300 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2302 RtsFlags.ParFlags.wait = 1000;
2304 IF_PAR_DEBUG(verbose,
2305 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2306 RtsFlags.ParFlags.wait));
2309 case 'D': /* -qD ... all the debugging options */
2310 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2311 /* hack warning: interpret the flags as a binary number */
2312 nat n = decode(rts_argv[arg]+3);
2313 set_par_debug_options(n);
2316 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2317 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2320 if (i==MAX_PAR_DEBUG_OPTION+1) {
2321 errorBelch("Valid GUM debug options are:\n");
2322 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2323 bad_option( rts_argv[arg] );
2324 } else { // flag found; now set it
2325 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2331 errorBelch("Unknown option -q%c (%d opts in total)",
2332 rts_argv[arg][2], *rts_argc);
2338 Interpret n as a binary number masking Par debug options and set the
2339 correxponding option. See par_debug_opts_strs for explanations of the flags.
2342 set_par_debug_options(nat n) {
2345 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2347 debugBelch(par_debug_opts_strs[i]);
2349 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2350 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2351 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2352 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2353 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2354 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2355 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2356 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2357 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2358 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2359 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2360 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2361 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2362 default: barf("set_par_debug_options: only %d debug options expected",
2363 MAX_PAR_DEBUG_OPTION);
2369 Print one line explanation for each of the GranSim debug options specified
2373 help_par_debug_options(nat n) {
2376 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2378 debugBelch(par_debug_opts_strs[i]);
2384 stats_fprintf(FILE *f, char *s, ...)
2396 static int /* return -1 on error */
2399 int argc, char *argv[],
2400 int rts_argc, char *rts_argv[],
2401 const char *FILENAME_FMT,
2406 if (strequal(rts_argv[arg]+2, "stderr")
2407 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
2408 f = NULL; /* NULL means use debugBelch */
2410 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2411 f = fopen(rts_argv[arg]+2,"w");
2413 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2414 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2415 f = fopen(stats_filename,"w");
2418 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2425 /* Write argv and rtsv into start of stats file */
2427 for(count = 0; count < argc; count++) {
2428 stats_fprintf(f, "%s ", argv[count]);
2430 stats_fprintf(f, "+RTS ");
2431 for(count = 0; count < rts_argc; count++)
2432 stats_fprintf(f, "%s ", rts_argv[count]);
2433 stats_fprintf(f, "\n");
2441 decode(const char *s)
2452 if (c == 'g' || c == 'G')
2453 m *= 1000*1000*1000; /* UNchecked! */
2454 else if (c == 'm' || c == 'M')
2455 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2456 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2457 m *= 1000; /* a direct-mapped cache. */
2458 else if (c == 'w' || c == 'W')
2465 bad_option(const char *s)
2467 errorBelch("bad RTS option: %s", s);
2468 stg_exit(EXIT_FAILURE);
2471 /* -----------------------------------------------------------------------------
2472 Getting/Setting the program's arguments.
2474 These are used by System.Environment, and parts of the RTS.
2475 -------------------------------------------------------------------------- */
2478 setProgName(char *argv[])
2480 /* Remove directory from argv[0] -- default files in current directory */
2481 #if !defined(mingw32_HOST_OS)
2483 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2484 prog_name = last_slash+1;
2486 prog_name = argv[0];
2489 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2490 while ( last_slash > argv[0] ) {
2491 if ( *last_slash == '/' || *last_slash == '\\' ) {
2492 prog_name = last_slash+1;
2497 prog_name = argv[0];
2502 getProgArgv(int *argc, char **argv[])
2504 if (argc) { *argc = prog_argc; }
2505 if (argv) { *argv = prog_argv; }
2509 setProgArgv(int argc, char *argv[])
2511 /* Usually this is done by startupHaskell, so we don't need to call this.
2512 However, sometimes Hugs wants to change the arguments which Haskell
2513 getArgs >>= ... will be fed. So you can do that by calling here
2514 _after_ calling startupHaskell.
2518 setProgName(prog_argv);
2521 /* These functions record and recall the full arguments, including the
2522 +RTS ... -RTS options. The reason for adding them was so that the
2523 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2525 getFullProgArgv(int *argc, char **argv[])
2527 if (argc) { *argc = full_prog_argc; }
2528 if (argv) { *argv = full_prog_argv; }
2532 setFullProgArgv(int argc, char *argv[])
2535 full_prog_argc = argc;
2536 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2537 "setFullProgArgv 1");
2538 for (i = 0; i < argc; i++) {
2539 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2540 "setFullProgArgv 2");
2541 strcpy(full_prog_argv[i], argv[i]);
2543 full_prog_argv[argc] = NULL;