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.eventlog = rtsFalse;
188 RtsFlags.DebugFlags.gran = rtsFalse;
189 RtsFlags.DebugFlags.par = rtsFalse;
190 RtsFlags.DebugFlags.apply = rtsFalse;
191 RtsFlags.DebugFlags.linker = rtsFalse;
192 RtsFlags.DebugFlags.squeeze = rtsFalse;
193 RtsFlags.DebugFlags.hpc = rtsFalse;
194 RtsFlags.DebugFlags.timestamp = rtsFalse;
197 #if defined(PROFILING) || defined(PAR)
198 RtsFlags.CcFlags.doCostCentres = 0;
199 #endif /* PROFILING or PAR */
201 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
202 RtsFlags.ProfFlags.profileInterval = 100;
205 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
206 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
207 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
208 RtsFlags.ProfFlags.ccsLength = 25;
209 RtsFlags.ProfFlags.modSelector = NULL;
210 RtsFlags.ProfFlags.descrSelector = NULL;
211 RtsFlags.ProfFlags.typeSelector = NULL;
212 RtsFlags.ProfFlags.ccSelector = NULL;
213 RtsFlags.ProfFlags.ccsSelector = NULL;
214 RtsFlags.ProfFlags.retainerSelector = NULL;
215 RtsFlags.ProfFlags.bioSelector = NULL;
219 RtsFlags.EventLogFlags.doEventLogging = rtsFalse;
222 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
223 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
225 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
226 RtsFlags.MiscFlags.machineReadable = rtsFalse;
227 RtsFlags.MiscFlags.linkerMemBase = 0;
230 RtsFlags.ParFlags.nNodes = 1;
231 RtsFlags.ParFlags.migrate = rtsTrue;
232 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
233 RtsFlags.ParFlags.parGcEnabled = 1;
234 RtsFlags.ParFlags.parGcGen = 1;
235 RtsFlags.ParFlags.parGcLoadBalancing = 1;
239 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
240 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
241 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
242 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
243 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
244 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
245 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
247 RtsFlags.ParFlags.outputDisabled = rtsFalse;
249 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
251 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
253 RtsFlags.ParFlags.packBufferSize = 1024;
254 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
255 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
256 RtsFlags.ParFlags.maxThreads = 1024;
257 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
258 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
261 #if defined(PAR) || defined(THREADED_RTS)
262 RtsFlags.ParFlags.maxLocalSparks = 4096;
263 #endif /* PAR || THREADED_RTS */
266 /* ToDo: check defaults for GranSim and GUM */
267 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
268 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
270 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
271 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
272 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
273 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
274 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
275 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
276 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
277 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
279 RtsFlags.GranFlags.packBufferSize = 1024;
280 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
282 RtsFlags.GranFlags.proc = MAX_PROC;
283 RtsFlags.GranFlags.Fishing = rtsFalse;
284 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
285 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
286 RtsFlags.GranFlags.Light = rtsFalse;
288 RtsFlags.GranFlags.Costs.latency = LATENCY;
289 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
290 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
291 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
292 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
293 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
294 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
295 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
297 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
298 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
299 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
300 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
301 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
303 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
304 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
305 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
306 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
307 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
309 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
311 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
312 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
314 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
315 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
316 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
317 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
318 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
319 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
320 RtsFlags.GranFlags.FetchStrategy = 2;
321 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
322 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
323 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
324 RtsFlags.GranFlags.SparkPriority = 0;
325 RtsFlags.GranFlags.SparkPriority2 = 0;
326 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
327 RtsFlags.GranFlags.InversePriorities = rtsFalse;
328 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
329 RtsFlags.GranFlags.ThunksToPack = 0;
330 RtsFlags.GranFlags.RandomSteal = rtsTrue;
334 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
335 RtsFlags.TickyFlags.tickyFile = NULL;
339 /* By default no special measurements taken */
340 RtsFlags.PapiFlags.eventType = 0;
341 RtsFlags.PapiFlags.numUserEvents = 0;
348 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
350 " +RTS Indicates run time system options follow",
351 " -RTS Indicates program arguments follow",
352 " --RTS Indicates that ALL subsequent arguments will be given to the",
353 " program (including any of these RTS flags)",
355 "The following run time system options are available:",
357 " -? Prints this message and exits; the program is not executed",
358 " --info Print information about the RTS used by this program",
360 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
361 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
363 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
364 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
365 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
366 " -m<n> Minimum % of heap which must be available (default 3%)",
367 " -G<n> Number of generations (default: 2)",
368 " -T<n> Number of steps in younger generations (default: 2)",
369 " -c<n> Auto-enable compaction of the oldest generation when live data is",
370 " at least <n>% of the maximum heap size set with -M (default: 30%)",
371 " -c Enable compaction for all major collections",
372 " -w Use mark-region for the oldest generation (experimental)",
373 #if defined(THREADED_RTS)
374 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
377 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
378 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
379 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
380 #ifdef RTS_GTK_FRONTPANEL
381 " -f Display front panel (requires X11 & GTK+)",
385 " -Z Don't squeeze out update frames on stack overflow",
386 " -B Sound the bell at the start of each garbage collection",
387 #if defined(PROFILING) || defined(PAR)
389 " -px Time/allocation profile (XML) (output file <program>.prof)",
390 " -p Time/allocation profile (output file <program>.prof)",
391 " -P More detailed Time/Allocation profile",
392 " -Pa Give information about *all* cost centres",
394 # if defined(PROFILING)
396 " -hx Heap residency profile (XML) (output file <program>.prof)",
397 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
398 " break-down: c = cost centre stack (default)",
400 " d = closure description",
401 " y = type description",
403 " b = biography (LAG,DRAG,VOID,USE)",
404 " A subset of closures may be selected thusly:",
405 " -hc<cc>,... specific cost centre(s) (top of stack only)",
406 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
407 " -hm<mod>... all cost centres from the specified modules(s)",
408 " -hd<des>,... closures with specified closure descriptions",
409 " -hy<typ>... closures with specified type descriptions",
410 " -hr<cc>... closures with specified retainers",
411 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
413 " -R<size> Set the maximum retainer set size (default: 8)",
415 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
418 " -xt Include threads (TSOs) in a heap profile",
420 " -xc Show current cost centre stack on raising an exception",
423 #endif /* PROFILING or PAR */
427 " -l Log runtime events (generates binary trace file <program>.eventlog)",
431 #if !defined(PROFILING)
433 " -hT Heap residency profile (output file <program>.hp)",
435 " -i<sec> Time between heap samples (seconds, default: 0.1)",
437 #if defined(TICKY_TICKY)
438 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
442 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
443 /* NB: the -N<n> is implemented by the driver!! */
445 " -C<secs> Context-switch interval in seconds.",
446 " 0 or no argument means switch as often as possible.",
447 " Default: 0.02 sec; resolution is set by -V below.",
448 " -V<secs> Master tick interval in seconds (0 == disable timer).",
449 " This sets the resolution for -C and the profile timer -i.",
450 " Default: 0.02 sec.",
452 " -vt Time-stamp debug messages",
455 " -Ds DEBUG: scheduler",
456 " -Di DEBUG: interpreter",
458 " -DG DEBUG: gccafs",
461 " -DS DEBUG: sanity",
462 " -Dt DEBUG: stable",
464 " -De DEBUG: event logging",
468 " -Dl DEBUG: linker",
470 " -Dz DEBUG: stack squezing",
471 " -Dc DEBUG: program coverage",
474 #if defined(THREADED_RTS) && !defined(NOSMP)
475 " -N<n> Use <n> processors (default: 1)",
476 " -N Determine the number of processors to use automatically",
477 " -q1 Use one OS thread for GC (turns off parallel GC)",
478 " -qg<n> Use parallel GC only for generations >= <n> (default: 1)",
479 " -qm Don't automatically migrate threads between CPUs",
480 " -qw Migrate a thread to the current CPU when it is woken up",
482 " --install-signal-handlers=<yes|no>",
483 " Install signal handlers (default: yes)",
484 #if defined(THREADED_RTS) || defined(PAR)
485 " -e<size> Size of spark pools (default 100)",
488 " -t<num> Set maximum number of advisory threads per PE (default 32)",
489 " -qP Enable activity profile (output files in ~/<program>*.gr)",
490 " -qQ<size> Set pack-buffer size (default: 1024)",
491 " -qd Turn on PVM-ish debugging",
492 " -qO Disable output for performance measurement",
494 #if defined(THREADED_RTS) || defined(PAR)
495 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
498 " -d Turn on PVM-ish debugging",
499 " -O Disable output for performance measurement",
501 #if defined(GRAN) /* ToDo: fill in decent Docu here */
502 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
504 #if defined(x86_64_HOST_ARCH)
505 " -xm Base address to mmap memory in the GHCi linker",
506 " (hex; must be <80000000)",
508 #if defined(USE_PAPI)
509 " -aX CPU performance counter measurements using PAPI",
510 " (use with the -s<file> option). X is one of:",
513 " 1 - level 1 cache misses",
514 " 2 - level 2 cache misses",
515 " b - branch mispredictions",
516 " s - stalled cycles",
517 " e - cache miss and branch misprediction events",
520 "RTS options may also be specified using the GHCRTS environment variable.",
522 "Other RTS options may be available for programs compiled a different way.",
523 "The GHC User's Guide has full details.",
528 STATIC_INLINE rtsBool
529 strequal(const char *a, const char * b)
531 return(strcmp(a, b) == 0);
535 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
541 while (isspace(*c1)) { c1++; };
543 while (!isspace(*c2) && *c2 != '\0') { c2++; };
545 if (c1 == c2) { break; }
547 if (*rts_argc < MAX_RTS_ARGS-1) {
548 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
549 strncpy(s, c1, c2-c1);
551 rts_argv[(*rts_argc)++] = s;
553 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
557 } while (*c1 != '\0');
561 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
563 rtsBool error = rtsFalse;
574 // process arguments from the ghc_rts_opts global variable first.
575 // (arguments from the GHCRTS environment variable and the command
576 // line override these).
578 if (ghc_rts_opts != NULL) {
579 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
583 // process arguments from the GHCRTS environment variable next
584 // (arguments from the command line override these).
586 char *ghc_rts = getenv("GHCRTS");
588 if (ghc_rts != NULL) {
589 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
593 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
594 // argv[0] must be PGM argument -- leave in argv
596 for (mode = PGM; arg < total_arg; arg++) {
597 // The '--RTS' argument disables all future +RTS ... -RTS processing.
598 if (strequal("--RTS", argv[arg])) {
602 // The '--' argument is passed through to the program, but
603 // disables all further +RTS ... -RTS processing.
604 else if (strequal("--", argv[arg])) {
607 else if (strequal("+RTS", argv[arg])) {
610 else if (strequal("-RTS", argv[arg])) {
613 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
614 rts_argv[(*rts_argc)++] = argv[arg];
616 else if (mode == PGM) {
617 argv[(*argc)++] = argv[arg];
620 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
623 // process remaining program arguments
624 for (; arg < total_arg; arg++) {
625 argv[(*argc)++] = argv[arg];
627 argv[*argc] = (char *) 0;
628 rts_argv[*rts_argc] = (char *) 0;
630 // Process RTS (rts_argv) part: mainly to determine statsfile
631 for (arg = 0; arg < *rts_argc; arg++) {
632 if (rts_argv[arg][0] != '-') {
634 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
638 switch(rts_argv[arg][1]) {
640 /* process: general args, then PROFILING-only ones,
641 then CONCURRENT-only, PARallel-only, GRAN-only,
642 TICKY-only (same order as defined in RtsFlags.lh);
643 within those groups, mostly in case-insensitive
645 Final group is x*, which allows for more options.
649 # define TICKY_BUILD_ONLY(x) x
651 # define TICKY_BUILD_ONLY(x) \
652 errorBelch("not built for: ticky-ticky stats"); \
656 #if defined(PROFILING)
657 # define COST_CENTRE_USING_BUILD_ONLY(x) x
659 # define COST_CENTRE_USING_BUILD_ONLY(x) \
660 errorBelch("not built for: -prof or -parallel"); \
665 # define PROFILING_BUILD_ONLY(x) x
667 # define PROFILING_BUILD_ONLY(x) \
668 errorBelch("not built for: -prof"); \
673 # define EVENTLOG_BUILD_ONLY(x) x
675 # define EVENTLOG_BUILD_ONLY(x) \
676 errorBelch("not built for: -par-prof"); \
681 # define PAR_BUILD_ONLY(x) x
683 # define PAR_BUILD_ONLY(x) \
684 errorBelch("not built for: -parallel"); \
689 # define THREADED_BUILD_ONLY(x) x
691 # define THREADED_BUILD_ONLY(x) \
692 errorBelch("not built for: -smp"); \
696 #if defined(THREADED_RTS) || defined(PAR)
697 # define PAR_OR_THREADED_BUILD_ONLY(x) x
699 # define PAR_OR_THREADED_BUILD_ONLY(x) \
700 errorBelch("not built for: -parallel or -smp"); \
705 # define GRAN_BUILD_ONLY(x) x
707 # define GRAN_BUILD_ONLY(x) \
708 errorBelch("not built for: -gransim"); \
712 /* =========== GENERAL ========================== */
717 /* This isn't going to allow us to keep related options
718 together as we add more --* flags. We really need a
719 proper options parser. */
721 if (strequal("install-signal-handlers=yes",
722 &rts_argv[arg][2])) {
723 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
725 else if (strequal("install-signal-handlers=no",
726 &rts_argv[arg][2])) {
727 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
729 else if (strequal("machine-readable",
730 &rts_argv[arg][2])) {
731 RtsFlags.MiscFlags.machineReadable = rtsTrue;
733 else if (strequal("info",
734 &rts_argv[arg][2])) {
739 errorBelch("unknown RTS option: %s",rts_argv[arg]);
744 RtsFlags.GcFlags.minAllocAreaSize
745 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
746 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
747 bad_option(rts_argv[arg]);
753 switch(rts_argv[arg][2]) {
755 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
758 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
761 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
764 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
767 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
770 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
771 errorBelch("maximum number of PAPI events reached");
772 stg_exit(EXIT_FAILURE);
774 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
775 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
778 bad_option( rts_argv[arg] );
784 RtsFlags.GcFlags.ringBell = rtsTrue;
788 if (rts_argv[arg][2] != '\0') {
789 RtsFlags.GcFlags.compactThreshold =
790 atof(rts_argv[arg]+2);
792 RtsFlags.GcFlags.compact = rtsTrue;
797 RtsFlags.GcFlags.sweep = rtsTrue;
801 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
803 if (RtsFlags.GcFlags.oldGenFactor < 0)
804 bad_option( rts_argv[arg] );
812 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
815 RtsFlags.DebugFlags.scheduler = rtsTrue;
818 RtsFlags.DebugFlags.interpreter = rtsTrue;
821 RtsFlags.DebugFlags.weak = rtsTrue;
824 RtsFlags.DebugFlags.gccafs = rtsTrue;
827 RtsFlags.DebugFlags.gc = rtsTrue;
830 RtsFlags.DebugFlags.block_alloc = rtsTrue;
833 RtsFlags.DebugFlags.sanity = rtsTrue;
836 RtsFlags.DebugFlags.stable = rtsTrue;
839 RtsFlags.DebugFlags.prof = rtsTrue;
842 RtsFlags.DebugFlags.eventlog = rtsTrue;
845 RtsFlags.DebugFlags.gran = rtsTrue;
848 RtsFlags.DebugFlags.par = rtsTrue;
851 RtsFlags.DebugFlags.linker = rtsTrue;
854 RtsFlags.DebugFlags.apply = rtsTrue;
857 RtsFlags.DebugFlags.stm = rtsTrue;
860 RtsFlags.DebugFlags.squeeze = rtsTrue;
863 RtsFlags.DebugFlags.hpc = rtsTrue;
866 bad_option( rts_argv[arg] );
874 RtsFlags.GcFlags.maxStkSize =
875 decode(rts_argv[arg]+2) / sizeof(W_);
877 if (RtsFlags.GcFlags.maxStkSize == 0)
878 bad_option( rts_argv[arg] );
882 RtsFlags.GcFlags.initialStkSize =
883 decode(rts_argv[arg]+2) / sizeof(W_);
885 if (RtsFlags.GcFlags.initialStkSize == 0)
886 bad_option( rts_argv[arg] );
890 RtsFlags.GcFlags.maxHeapSize =
891 decode(rts_argv[arg]+2) / BLOCK_SIZE;
892 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
894 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
895 bad_option(rts_argv[arg]);
900 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
902 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
903 RtsFlags.GcFlags.pcFreeHeap > 100)
904 bad_option( rts_argv[arg] );
908 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
909 if (RtsFlags.GcFlags.generations < 1) {
910 bad_option(rts_argv[arg]);
915 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
916 if (RtsFlags.GcFlags.steps < 1) {
917 bad_option(rts_argv[arg]);
922 RtsFlags.GcFlags.heapSizeSuggestion =
923 decode(rts_argv[arg]+2) / BLOCK_SIZE;
926 #ifdef RTS_GTK_FRONTPANEL
928 RtsFlags.GcFlags.frontpanel = rtsTrue;
932 case 'I': /* idle GC delay */
933 if (rts_argv[arg][2] == '\0') {
938 /* Convert to millisecs */
939 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
940 RtsFlags.GcFlags.idleGCDelayTime = cst;
945 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
949 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
953 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
958 /* Opening all those files would almost certainly fail... */
959 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
960 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
964 r = open_stats_file(arg, *argc, argv,
965 *rts_argc, rts_argv, NULL,
966 &RtsFlags.GcFlags.statsFile);
967 if (r == -1) { error = rtsTrue; }
973 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
976 /* =========== PROFILING ========================== */
980 RtsFlags.EventLogFlags.doEventLogging = rtsTrue;
982 errorBelch("not built for: -eventlog");
986 case 'P': /* detailed cost centre profiling (time/alloc) */
987 case 'p': /* cost centre profiling (time/alloc) */
988 COST_CENTRE_USING_BUILD_ONLY(
989 switch (rts_argv[arg][2]) {
991 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
994 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
997 if (rts_argv[arg][1] == 'P') {
998 RtsFlags.CcFlags.doCostCentres =
999 COST_CENTRES_VERBOSE;
1001 RtsFlags.CcFlags.doCostCentres =
1002 COST_CENTRES_SUMMARY;
1009 PROFILING_BUILD_ONLY(
1010 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
1013 PROFILING_BUILD_ONLY(
1014 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
1015 if(RtsFlags.ProfFlags.ccsLength <= 0) {
1016 bad_option(rts_argv[arg]);
1019 case 'h': /* serial heap profile */
1020 #if !defined(PROFILING)
1021 switch (rts_argv[arg][2]) {
1024 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
1027 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1031 PROFILING_BUILD_ONLY(
1032 switch (rts_argv[arg][2]) {
1046 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
1048 char *left = strchr(rts_argv[arg], '{');
1049 char *right = strrchr(rts_argv[arg], '}');
1051 // curly braces are optional, for
1052 // backwards compat.
1056 left = rts_argv[arg] + 3;
1059 right = rts_argv[arg] + strlen(rts_argv[arg]);
1063 switch (rts_argv[arg][2]) {
1064 case 'c': // cost centre label select
1065 RtsFlags.ProfFlags.ccSelector = left;
1068 RtsFlags.ProfFlags.ccsSelector = left;
1071 case 'm': // cost centre module select
1072 RtsFlags.ProfFlags.modSelector = left;
1075 case 'd': // closure descr select
1076 RtsFlags.ProfFlags.descrSelector = left;
1079 case 'y': // closure type select
1080 RtsFlags.ProfFlags.typeSelector = left;
1083 case 'r': // retainer select
1084 RtsFlags.ProfFlags.retainerSelector = left;
1087 case 'b': // biography select
1088 RtsFlags.ProfFlags.bioSelector = left;
1095 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1096 errorBelch("multiple heap profile options");
1101 switch (rts_argv[arg][2]) {
1105 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1109 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1113 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1117 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1121 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1125 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1131 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1135 #endif /* PROFILING */
1138 case 'i': /* heap sample interval */
1139 if (rts_argv[arg][2] == '\0') {
1144 /* Convert to milliseconds */
1145 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1146 RtsFlags.ProfFlags.profileInterval = cst;
1150 /* =========== CONCURRENT ========================= */
1151 case 'C': /* context switch interval */
1152 if (rts_argv[arg][2] == '\0')
1153 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1157 /* Convert to milliseconds */
1158 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1159 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1163 case 'V': /* master tick interval */
1164 if (rts_argv[arg][2] == '\0') {
1165 // turns off ticks completely
1166 RtsFlags.MiscFlags.tickInterval = 0;
1170 /* Convert to milliseconds */
1171 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1172 RtsFlags.MiscFlags.tickInterval = cst;
1176 #if defined(THREADED_RTS) && !defined(NOSMP)
1178 THREADED_BUILD_ONLY(
1179 if (rts_argv[arg][2] == '\0') {
1180 #if defined(PROFILING)
1181 RtsFlags.ParFlags.nNodes = 1;
1183 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1186 RtsFlags.ParFlags.nNodes
1187 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1188 if (RtsFlags.ParFlags.nNodes <= 0) {
1189 errorBelch("bad value for -N");
1192 #if defined(PROFILING)
1193 if (RtsFlags.ParFlags.nNodes > 1) {
1194 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1202 THREADED_BUILD_ONLY(
1203 switch (rts_argv[arg][2]) {
1205 // backwards compat only
1206 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1209 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1216 switch (rts_argv[arg][2]) {
1218 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1222 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1225 if (rts_argv[arg][3] != '\0') {
1226 RtsFlags.ParFlags.parGcGen
1227 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1229 errorBelch("bad value for -qg");
1234 RtsFlags.ParFlags.parGcLoadBalancing = rtsFalse;
1237 RtsFlags.ParFlags.migrate = rtsFalse;
1240 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1243 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1249 /* =========== PARALLEL =========================== */
1251 PAR_OR_THREADED_BUILD_ONLY(
1252 if (rts_argv[arg][2] != '\0') {
1253 RtsFlags.ParFlags.maxLocalSparks
1254 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1255 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1256 errorBelch("bad value for -e");
1265 process_par_option(arg, rts_argc, rts_argv, &error);
1269 /* =========== GRAN =============================== */
1273 process_gran_option(arg, rts_argc, rts_argv, &error);
1276 /* =========== TICKY ============================== */
1278 case 'r': /* Basic profiling stats */
1281 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1285 r = open_stats_file(arg, *argc, argv,
1286 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1287 &RtsFlags.TickyFlags.tickyFile);
1288 if (r == -1) { error = rtsTrue; }
1292 /* =========== TRACING ---------=================== */
1295 switch(rts_argv[arg][2]) {
1297 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1301 RtsFlags.DebugFlags.timestamp = rtsTrue;
1305 // ignored for backwards-compat
1308 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1314 /* =========== EXTENDED OPTIONS =================== */
1316 case 'x': /* Extend the argument space */
1317 switch(rts_argv[arg][2]) {
1319 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1323 case 'b': /* heapBase in hex; undocumented */
1324 if (rts_argv[arg][3] != '\0') {
1325 RtsFlags.GcFlags.heapBase
1326 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1328 errorBelch("-xb: requires argument");
1333 #if defined(x86_64_HOST_ARCH)
1334 case 'm': /* linkerMemBase */
1335 if (rts_argv[arg][3] != '\0') {
1336 RtsFlags.MiscFlags.linkerMemBase
1337 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1338 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1339 errorBelch("-xm: value must be <80000000");
1343 RtsFlags.MiscFlags.linkerMemBase = 0;
1348 case 'c': /* Debugging tool: show current cost centre on an exception */
1349 PROFILING_BUILD_ONLY(
1350 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1354 case 't': /* Include memory used by TSOs in a heap profile */
1355 PROFILING_BUILD_ONLY(
1356 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1360 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1363 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1367 break; /* defensive programming */
1369 /* =========== OH DEAR ============================ */
1371 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1378 if (RtsFlags.MiscFlags.tickInterval < 0) {
1379 RtsFlags.MiscFlags.tickInterval = 50;
1382 // If the master timer is disabled, turn off the other timers.
1383 if (RtsFlags.MiscFlags.tickInterval == 0) {
1384 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1385 RtsFlags.GcFlags.idleGCDelayTime = 0;
1386 RtsFlags.ProfFlags.profileInterval = 0;
1389 // Determine what tick interval we should use for the RTS timer
1390 // by taking the shortest of the various intervals that we need to
1392 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1393 RtsFlags.MiscFlags.tickInterval =
1394 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1395 RtsFlags.MiscFlags.tickInterval);
1398 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1399 RtsFlags.MiscFlags.tickInterval =
1400 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1401 RtsFlags.MiscFlags.tickInterval);
1404 if (RtsFlags.ProfFlags.profileInterval > 0) {
1405 RtsFlags.MiscFlags.tickInterval =
1406 stg_min(RtsFlags.ProfFlags.profileInterval,
1407 RtsFlags.MiscFlags.tickInterval);
1410 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1411 RtsFlags.ConcFlags.ctxtSwitchTicks =
1412 RtsFlags.ConcFlags.ctxtSwitchTime /
1413 RtsFlags.MiscFlags.tickInterval;
1415 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1418 if (RtsFlags.ProfFlags.profileInterval > 0) {
1419 RtsFlags.ProfFlags.profileIntervalTicks =
1420 RtsFlags.ProfFlags.profileInterval /
1421 RtsFlags.MiscFlags.tickInterval;
1423 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1430 for (p = usage_text; *p; p++)
1431 errorBelch("%s", *p);
1432 stg_exit(EXIT_FAILURE);
1439 enable_GranSimLight(void) {
1441 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1442 RtsFlags.GranFlags.Light=rtsTrue;
1443 RtsFlags.GranFlags.Costs.latency =
1444 RtsFlags.GranFlags.Costs.fetchtime =
1445 RtsFlags.GranFlags.Costs.additional_latency =
1446 RtsFlags.GranFlags.Costs.gunblocktime =
1447 RtsFlags.GranFlags.Costs.lunblocktime =
1448 RtsFlags.GranFlags.Costs.threadcreatetime =
1449 RtsFlags.GranFlags.Costs.threadqueuetime =
1450 RtsFlags.GranFlags.Costs.threadscheduletime =
1451 RtsFlags.GranFlags.Costs.threaddescheduletime =
1452 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1454 RtsFlags.GranFlags.Costs.mpacktime =
1455 RtsFlags.GranFlags.Costs.munpacktime = 0;
1457 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1458 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1459 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1460 /* FetchStrategy is irrelevant in GrAnSim-Light */
1462 /* GrAnSim Light often creates an abundance of parallel threads,
1463 each with its own stack etc. Therefore, it's in general a good
1464 idea to use small stack chunks (use the -o<size> option to
1467 // RtsFlags.ConcFlags.stkChunkSize = 100;
1469 RtsFlags.GranFlags.proc = 1;
1473 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1475 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1478 /* or a ridiculously idealised simulator */
1479 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1480 RtsFlags.GranFlags.Costs.latency =
1481 RtsFlags.GranFlags.Costs.fetchtime =
1482 RtsFlags.GranFlags.Costs.additional_latency =
1483 RtsFlags.GranFlags.Costs.gunblocktime =
1484 RtsFlags.GranFlags.Costs.lunblocktime =
1485 RtsFlags.GranFlags.Costs.threadcreatetime =
1486 RtsFlags.GranFlags.Costs.threadqueuetime =
1487 RtsFlags.GranFlags.Costs.threadscheduletime =
1488 RtsFlags.GranFlags.Costs.threaddescheduletime =
1489 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1491 RtsFlags.GranFlags.Costs.mpacktime =
1492 RtsFlags.GranFlags.Costs.munpacktime = 0;
1494 RtsFlags.GranFlags.Costs.arith_cost =
1495 RtsFlags.GranFlags.Costs.float_cost =
1496 RtsFlags.GranFlags.Costs.load_cost =
1497 RtsFlags.GranFlags.Costs.store_cost =
1498 RtsFlags.GranFlags.Costs.branch_cost = 0;
1500 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1502 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1503 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1504 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1505 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1509 /* or a somewhat idealised simulator */
1510 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1511 RtsFlags.GranFlags.Costs.latency =
1512 RtsFlags.GranFlags.Costs.fetchtime =
1513 RtsFlags.GranFlags.Costs.additional_latency =
1514 RtsFlags.GranFlags.Costs.gunblocktime =
1515 RtsFlags.GranFlags.Costs.lunblocktime =
1516 RtsFlags.GranFlags.Costs.threadcreatetime =
1517 RtsFlags.GranFlags.Costs.threadqueuetime =
1518 RtsFlags.GranFlags.Costs.threadscheduletime =
1519 RtsFlags.GranFlags.Costs.threaddescheduletime =
1520 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1522 RtsFlags.GranFlags.Costs.mpacktime =
1523 RtsFlags.GranFlags.Costs.munpacktime = 0;
1525 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1527 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1528 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1529 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1530 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1531 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1532 # if defined(GRAN_CHECK) && defined(GRAN)
1533 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1538 /* Communication and task creation cost parameters */
1539 switch(rts_argv[arg][2]) {
1541 IgnoreYields = rtsTrue; // HWL HACK
1545 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1549 if (rts_argv[arg][3] != '\0')
1551 RtsFlags.GranFlags.Costs.gunblocktime =
1552 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1553 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1556 RtsFlags.GranFlags.Costs.latency = LATENCY;
1560 if (rts_argv[arg][3] != '\0')
1561 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1563 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1567 if (rts_argv[arg][3] != '\0')
1568 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1570 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1574 if (rts_argv[arg][3] != '\0')
1575 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1577 RtsFlags.GranFlags.Costs.mtidytime = 0;
1581 if (rts_argv[arg][3] != '\0')
1582 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1584 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1588 if (rts_argv[arg][3] != '\0')
1589 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1591 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1595 if (rts_argv[arg][3] != '\0')
1596 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1598 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1602 if (rts_argv[arg][3] != '\0')
1603 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1605 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1608 /* Thread-related metrics */
1610 if (rts_argv[arg][3] != '\0')
1611 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1613 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1617 if (rts_argv[arg][3] != '\0')
1618 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1620 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1624 if (rts_argv[arg][3] != '\0')
1625 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1627 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1629 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1630 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1634 if (rts_argv[arg][3] != '\0')
1635 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1637 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1639 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1640 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1643 /* Instruction Cost Metrics */
1645 if (rts_argv[arg][3] != '\0')
1646 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1648 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1652 if (rts_argv[arg][3] != '\0')
1653 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1655 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1659 if (rts_argv[arg][3] != '\0')
1660 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1662 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1666 if (rts_argv[arg][3] != '\0')
1667 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1669 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1673 if (rts_argv[arg][3] != '\0')
1674 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1676 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1680 if (rts_argv[arg][3] != '\0')
1681 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1683 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1687 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1688 if (rts_argv[arg][3] != '\0')
1689 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1691 RtsFlags.GranFlags.FetchStrategy = 2;
1692 if (RtsFlags.GranFlags.FetchStrategy == 0)
1693 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1696 case 'K': /* sort overhead (per elem in spark list) */
1697 if (rts_argv[arg][3] != '\0')
1698 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1700 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1701 debugBelch("Overhead for pri spark: %d (per elem).\n",
1702 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1705 case 'O': /* sort overhead (per elem in spark list) */
1706 if (rts_argv[arg][3] != '\0')
1707 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1709 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1710 debugBelch("Overhead for pri sched: %d (per elem).\n",
1711 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1714 /* General Parameters */
1716 if (rts_argv[arg][3] != '\0')
1718 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1719 if (RtsFlags.GranFlags.proc==0) {
1720 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1721 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1722 RtsFlags.GranFlags.proc < 1)
1724 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1730 RtsFlags.GranFlags.proc = MAX_PROC;
1734 RtsFlags.GranFlags.Fishing = rtsTrue;
1735 if (rts_argv[arg][3] != '\0')
1736 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1738 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1742 if (rts_argv[arg][3] != '\0')
1743 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1745 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1749 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1750 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1754 debugBelch("Bulk fetching enabled.\n");
1755 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1759 debugBelch("Thread migration enabled.\n");
1760 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1764 debugBelch("Fair Scheduling enabled.\n");
1765 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1769 debugBelch("Priority Scheduling enabled.\n");
1770 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1774 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1775 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1779 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1783 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1787 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1791 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1795 /* format is -bP<c> where <c> is one char describing kind of profile */
1796 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1797 switch(rts_argv[arg][3]) {
1798 case '\0': break; // nothing special, just an ordinary profile
1799 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1801 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1803 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1805 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1807 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1809 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1811 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1816 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1820 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1823 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1824 if (rts_argv[arg][3] != '\0') {
1827 arg0 = rts_argv[arg]+3;
1828 if ((tmp = strstr(arg0,","))==NULL) {
1829 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1830 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1833 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1834 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1835 debugBelch("SparkPriority: %u.\n",
1836 RtsFlags.GranFlags.SparkPriority);
1837 debugBelch("SparkPriority2:%u.\n",
1838 RtsFlags.GranFlags.SparkPriority2);
1839 if (RtsFlags.GranFlags.SparkPriority2 <
1840 RtsFlags.GranFlags.SparkPriority) {
1841 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1842 RtsFlags.GranFlags.SparkPriority2,
1843 RtsFlags.GranFlags.SparkPriority);
1847 /* plain pri spark is now invoked with -bX
1848 RtsFlags.GranFlags.DoPrioritySparking = 1;
1849 debugBelch("PrioritySparking.\n");
1855 if (rts_argv[arg][3] != '\0') {
1856 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1858 RtsFlags.GranFlags.ThunksToPack = 1;
1860 debugBelch("Thunks To Pack in one packet: %u.\n",
1861 RtsFlags.GranFlags.ThunksToPack);
1865 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1866 debugBelch("Deterministic mode (no random stealing)\n");
1869 /* The following class of options contains eXperimental */
1870 /* features in connection with exploiting granularity */
1871 /* information. I.e. if -bY is chosen these options */
1872 /* tell the RTS what to do with the supplied info --HWL */
1875 if (rts_argv[arg][3] != '\0') {
1876 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1878 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1880 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1881 RtsFlags.GranFlags.packBufferSize_internal);
1885 switch(rts_argv[arg][3]) {
1888 RtsFlags.GranFlags.DoPrioritySparking = 1;
1889 debugBelch("Priority Sparking with Normal Priorities.\n");
1890 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1891 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1892 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1896 RtsFlags.GranFlags.DoPrioritySparking = 1;
1897 debugBelch("Priority Sparking with Inverse Priorities.\n");
1898 RtsFlags.GranFlags.InversePriorities++;
1902 RtsFlags.GranFlags.DoPrioritySparking = 1;
1903 debugBelch("Priority Sparking with Random Priorities.\n");
1904 RtsFlags.GranFlags.RandomPriorities++;
1908 RtsFlags.GranFlags.DoPrioritySparking = 1;
1909 debugBelch("Priority Sparking with No Priorities.\n");
1910 RtsFlags.GranFlags.IgnorePriorities++;
1914 bad_option( rts_argv[arg] );
1920 switch(rts_argv[arg][3]) {
1923 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1924 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1928 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1932 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1936 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1940 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1941 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1945 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1949 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1953 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1957 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1961 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1965 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1969 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1973 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1974 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1978 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1982 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1986 bad_option( rts_argv[arg] );
1991 # if defined(GRAN_CHECK) && defined(GRAN)
1993 switch(rts_argv[arg][3]) {
1994 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1995 if (rts_argv[arg][4] != '\0') {
1996 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1997 debugBelch("Pack buffer size: %d\n",
1998 RtsFlags.GranFlags.packBufferSize);
2000 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
2006 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2007 /* hack warning: interpret the flags as a binary number */
2008 nat n = decode(rts_argv[arg]+3);
2009 set_GranSim_debug_options(n);
2012 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2013 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
2016 if (i==MAX_GRAN_DEBUG_OPTION+1) {
2017 debugBelch("Valid GranSim debug options are:\n");
2018 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2019 bad_option( rts_argv[arg] );
2020 } else { // flag found; now set it
2021 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
2027 case 'e': /* event trace; also -bD1 */
2028 debugBelch("DEBUG: event_trace; printing event trace.\n");
2029 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
2030 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
2033 case 'E': /* event statistics; also -bD2 */
2034 debugBelch("DEBUG: event_stats; printing event statistics.\n");
2035 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
2036 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
2039 case 'f': /* thunkStealing; also -bD4 */
2040 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
2041 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
2042 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
2045 case 'z': /* blockOnFetch; also -bD8 */
2046 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
2047 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
2048 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
2051 case 't': /* blockOnFetch_sanity; also -bD16 */
2052 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
2053 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
2054 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
2057 case 'S': /* priSpark; also -bD32 */
2058 debugBelch("DEBUG: priSpark; priority sparking.\n");
2059 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
2062 case 's': /* priSched; also -bD64 */
2063 debugBelch("DEBUG: priSched; priority scheduling.\n");
2064 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
2067 case 'F': /* findWork; also -bD128 */
2068 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
2069 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
2072 case 'g': /* globalBlock; also -bD256 */
2073 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
2074 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
2077 case 'G': /* pack; also -bD512 */
2078 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
2079 RtsFlags.GranFlags.Debug.pack = rtsTrue;
2082 case 'P': /* packBuffer; also -bD1024 */
2083 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
2084 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
2087 case 'o': /* sortedQ; also -bD2048 */
2088 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
2089 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
2092 case 'r': /* randomSteal; also -bD4096 */
2093 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2094 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2097 case 'q': /* checkSparkQ; also -bD8192 */
2098 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2099 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2102 case ':': /* checkLight; also -bD16384 */
2103 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2104 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2107 case 'b': /* bq; also -bD32768 */
2108 debugBelch("DEBUG: bq; check blocking queues\n");
2109 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2112 case 'd': /* all options turned on */
2113 debugBelch("DEBUG: all options turned on.\n");
2114 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2115 /* RtsFlags.GranFlags.Debug |= 0x40; */
2119 /* RtsFlags.GranFlags.Debug = 1; */
2125 # endif /* GRAN_CHECK */
2127 bad_option( rts_argv[arg] );
2133 Interpret n as a binary number masking GranSim debug options and set the
2134 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2137 set_GranSim_debug_options(nat n) {
2140 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2142 errorBelch(gran_debug_opts_strs[i]);
2144 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2145 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2146 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2147 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2148 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2149 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2150 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2151 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2152 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2153 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2154 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2155 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2156 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2157 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2158 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2159 default: barf("set_GranSim_debug_options: only %d debug options expected");
2165 Print one line explanation for each of the GranSim debug options specified
2169 help_GranSim_debug_options(nat n) {
2172 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2174 debugBelch(gran_debug_opts_strs[i]);
2180 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2183 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2184 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2188 /* Communication and task creation cost parameters */
2189 switch(rts_argv[arg][2]) {
2190 case 'e': /* -qe<n> ... allow <n> local sparks */
2191 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2192 RtsFlags.ParFlags.maxLocalSparks
2193 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2195 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2196 errorBelch("setupRtsFlags: bad value for -e\n");
2200 IF_PAR_DEBUG(verbose,
2201 errorBelch("-qe<n>: max %d local sparks",
2202 RtsFlags.ParFlags.maxLocalSparks));
2206 if (rts_argv[arg][3] != '\0') {
2207 RtsFlags.ParFlags.maxThreads
2208 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2210 errorBelch("missing size for -qt\n");
2213 IF_PAR_DEBUG(verbose,
2214 errorBelch("-qt<n>: max %d threads",
2215 RtsFlags.ParFlags.maxThreads));
2219 if (rts_argv[arg][3] != '\0')
2220 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2222 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2224 IF_PAR_DEBUG(verbose,
2225 errorBelch("-qf<n>: max %d fishes sent out at one time",
2226 RtsFlags.ParFlags.maxFishes));
2230 if (rts_argv[arg][3] != '\0') {
2231 RtsFlags.ParFlags.fishDelay
2232 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2234 errorBelch("missing fish delay time for -qF\n");
2237 IF_PAR_DEBUG(verbose,
2238 errorBelch("-qF<n>: fish delay time %d us",
2239 RtsFlags.ParFlags.fishDelay));
2243 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2244 IF_PAR_DEBUG(verbose,
2245 errorBelch("-qO: output disabled"));
2248 case 'g': /* -qg<n> ... globalisation scheme */
2249 if (rts_argv[arg][3] != '\0') {
2250 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2252 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2255 IF_PAR_DEBUG(verbose,
2256 debugBelch("-qg<n>: globalisation scheme set to %d",
2257 RtsFlags.ParFlags.globalising));
2260 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2261 if (rts_argv[arg][3] != '\0') {
2262 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2264 errorBelch("missing number of thunks per packet (for -qh)\n");
2267 IF_PAR_DEBUG(verbose,
2268 debugBelch("-qh<n>: thunks per packet set to %d",
2269 RtsFlags.ParFlags.thunksToPack));
2272 case 'P': /* -qP for writing a log file */
2273 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2274 /* same encoding as in GranSim after -bP */
2275 switch(rts_argv[arg][3]) {
2276 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2277 break; // nothing special, just an ordinary profile
2278 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2279 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2281 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2283 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2285 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2287 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2290 # if defined(PAR_TICKY)
2291 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2293 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2294 stg_exit(EXIT_FAILURE);
2297 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2299 IF_PAR_DEBUG(verbose,
2300 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2301 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2304 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2305 if (rts_argv[arg][3] != '\0') {
2306 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2308 errorBelch("missing size of PackBuffer (for -qQ)\n");
2311 IF_PAR_DEBUG(verbose,
2312 debugBelch("-qQ<n>: pack buffer size set to %d",
2313 RtsFlags.ParFlags.packBufferSize));
2317 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2318 IF_PAR_DEBUG(verbose,
2319 debugBelch("-qR: fair-ish scheduling"));
2324 if (rts_argv[arg][3] != '\0') {
2325 RtsFlags.ParFlags.wait
2326 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2328 RtsFlags.ParFlags.wait = 1000;
2330 IF_PAR_DEBUG(verbose,
2331 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2332 RtsFlags.ParFlags.wait));
2335 case 'D': /* -qD ... all the debugging options */
2336 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2337 /* hack warning: interpret the flags as a binary number */
2338 nat n = decode(rts_argv[arg]+3);
2339 set_par_debug_options(n);
2342 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2343 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2346 if (i==MAX_PAR_DEBUG_OPTION+1) {
2347 errorBelch("Valid GUM debug options are:\n");
2348 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2349 bad_option( rts_argv[arg] );
2350 } else { // flag found; now set it
2351 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2357 errorBelch("Unknown option -q%c (%d opts in total)",
2358 rts_argv[arg][2], *rts_argc);
2364 Interpret n as a binary number masking Par debug options and set the
2365 correxponding option. See par_debug_opts_strs for explanations of the flags.
2368 set_par_debug_options(nat n) {
2371 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2373 debugBelch(par_debug_opts_strs[i]);
2375 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2376 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2377 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2378 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2379 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2380 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2381 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2382 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2383 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2384 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2385 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2386 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2387 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2388 default: barf("set_par_debug_options: only %d debug options expected",
2389 MAX_PAR_DEBUG_OPTION);
2395 Print one line explanation for each of the GranSim debug options specified
2399 help_par_debug_options(nat n) {
2402 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2404 debugBelch(par_debug_opts_strs[i]);
2410 stats_fprintf(FILE *f, char *s, ...)
2422 static int /* return -1 on error */
2425 int argc, char *argv[],
2426 int rts_argc, char *rts_argv[],
2427 const char *FILENAME_FMT,
2432 if (strequal(rts_argv[arg]+2, "stderr")
2433 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
2434 f = NULL; /* NULL means use debugBelch */
2436 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2437 f = fopen(rts_argv[arg]+2,"w");
2439 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2440 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2441 f = fopen(stats_filename,"w");
2444 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2451 /* Write argv and rtsv into start of stats file */
2453 for(count = 0; count < argc; count++) {
2454 stats_fprintf(f, "%s ", argv[count]);
2456 stats_fprintf(f, "+RTS ");
2457 for(count = 0; count < rts_argc; count++)
2458 stats_fprintf(f, "%s ", rts_argv[count]);
2459 stats_fprintf(f, "\n");
2467 decode(const char *s)
2478 if (c == 'g' || c == 'G')
2479 m *= 1000*1000*1000; /* UNchecked! */
2480 else if (c == 'm' || c == 'M')
2481 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2482 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2483 m *= 1000; /* a direct-mapped cache. */
2484 else if (c == 'w' || c == 'W')
2491 bad_option(const char *s)
2493 errorBelch("bad RTS option: %s", s);
2494 stg_exit(EXIT_FAILURE);
2497 /* -----------------------------------------------------------------------------
2498 Getting/Setting the program's arguments.
2500 These are used by System.Environment, and parts of the RTS.
2501 -------------------------------------------------------------------------- */
2504 setProgName(char *argv[])
2506 /* Remove directory from argv[0] -- default files in current directory */
2507 #if !defined(mingw32_HOST_OS)
2509 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2510 prog_name = last_slash+1;
2512 prog_name = argv[0];
2515 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2516 while ( last_slash > argv[0] ) {
2517 if ( *last_slash == '/' || *last_slash == '\\' ) {
2518 prog_name = last_slash+1;
2523 prog_name = argv[0];
2528 getProgArgv(int *argc, char **argv[])
2530 if (argc) { *argc = prog_argc; }
2531 if (argv) { *argv = prog_argv; }
2535 setProgArgv(int argc, char *argv[])
2537 /* Usually this is done by startupHaskell, so we don't need to call this.
2538 However, sometimes Hugs wants to change the arguments which Haskell
2539 getArgs >>= ... will be fed. So you can do that by calling here
2540 _after_ calling startupHaskell.
2544 setProgName(prog_argv);
2547 /* These functions record and recall the full arguments, including the
2548 +RTS ... -RTS options. The reason for adding them was so that the
2549 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2551 getFullProgArgv(int *argc, char **argv[])
2553 if (argc) { *argc = full_prog_argc; }
2554 if (argv) { *argv = full_prog_argv; }
2558 setFullProgArgv(int argc, char *argv[])
2561 full_prog_argc = argc;
2562 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2563 "setFullProgArgv 1");
2564 for (i = 0; i < argc; i++) {
2565 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2566 "setFullProgArgv 2");
2567 strcpy(full_prog_argv[i], argv[i]);
2569 full_prog_argv[argc] = NULL;