1 /* -----------------------------------------------------------------------------
3 * (c) The AQUA Project, Glasgow University, 1994-1997
4 * (c) The GHC Team, 1998-2006
6 * Functions for parsing the argument list.
8 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
14 #include "Profiling.h"
27 * Split argument lists
29 int prog_argc = 0; /* an "int" so as to match normal "argc" */
30 char **prog_argv = NULL;
31 int full_prog_argc = 0; /* an "int" so as to match normal "argc" */
32 char **full_prog_argv = NULL;
33 char *prog_name = NULL; /* 'basename' of prog_argv[0] */
34 int rts_argc = 0; /* ditto */
35 char *rts_argv[MAX_RTS_ARGS];
38 * constants, used later
45 static char *gran_debug_opts_strs[] = {
46 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
47 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
48 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
49 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
50 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
51 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
52 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
53 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
54 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
55 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
56 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
57 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
58 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
59 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
60 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
63 /* one character codes for the available debug options */
64 static char gran_debug_opts_flags[] = {
65 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
70 static char *par_debug_opts_strs[] = {
71 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
72 "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
73 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
74 "DEBUG (-qDe, -qD8): free; free messages.\n",
75 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
76 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
77 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
78 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
79 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
80 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
81 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
82 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
83 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
84 "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
87 /* one character codes for the available debug options */
88 static char par_debug_opts_flags[] = {
89 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
94 /* -----------------------------------------------------------------------------
96 -------------------------------------------------------------------------- */
98 static int /* return NULL on error */
101 int argc, char *argv[],
102 int rts_argc, char *rts_argv[],
103 const char *FILENAME_FMT,
106 static I_ decode(const char *s);
107 static void bad_option(const char *s);
110 static void enable_GranSimLight(void);
111 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
112 static void set_GranSim_debug_options(nat n);
113 static void help_GranSim_debug_options(nat n);
115 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
116 static void set_par_debug_options(nat n);
117 static void help_par_debug_options(nat n);
120 /* -----------------------------------------------------------------------------
121 * Command-line option parsing routines.
122 * ---------------------------------------------------------------------------*/
124 void initRtsFlagsDefaults(void)
126 RtsFlags.GcFlags.statsFile = NULL;
127 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
129 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
130 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
132 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
133 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
134 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
135 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
136 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
137 RtsFlags.GcFlags.oldGenFactor = 2;
139 /* A hack currently needed for GUM -- HWL */
140 RtsFlags.GcFlags.generations = 1;
141 RtsFlags.GcFlags.steps = 2;
142 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
144 RtsFlags.GcFlags.generations = 2;
145 RtsFlags.GcFlags.steps = 2;
146 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
148 RtsFlags.GcFlags.compact = rtsFalse;
149 RtsFlags.GcFlags.compactThreshold = 30.0;
150 RtsFlags.GcFlags.sweep = rtsFalse;
151 #ifdef RTS_GTK_FRONTPANEL
152 RtsFlags.GcFlags.frontpanel = rtsFalse;
154 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
157 /* ToDo: Perhaps by adjusting this value we can make linking without
158 * -static work (i.e., not generate a core-dumping executable)? */
159 # if SIZEOF_VOID_P == 8
160 RtsFlags.GcFlags.heapBase = 0x180000000L;
162 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
165 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
169 RtsFlags.DebugFlags.scheduler = rtsFalse;
170 RtsFlags.DebugFlags.interpreter = rtsFalse;
171 RtsFlags.DebugFlags.weak = rtsFalse;
172 RtsFlags.DebugFlags.gccafs = rtsFalse;
173 RtsFlags.DebugFlags.gc = rtsFalse;
174 RtsFlags.DebugFlags.block_alloc = rtsFalse;
175 RtsFlags.DebugFlags.sanity = rtsFalse;
176 RtsFlags.DebugFlags.stable = rtsFalse;
177 RtsFlags.DebugFlags.stm = rtsFalse;
178 RtsFlags.DebugFlags.prof = rtsFalse;
179 RtsFlags.DebugFlags.gran = rtsFalse;
180 RtsFlags.DebugFlags.par = rtsFalse;
181 RtsFlags.DebugFlags.linker = rtsFalse;
182 RtsFlags.DebugFlags.squeeze = rtsFalse;
183 RtsFlags.DebugFlags.hpc = rtsFalse;
186 #if defined(PROFILING) || defined(PAR)
187 RtsFlags.CcFlags.doCostCentres = 0;
188 #endif /* PROFILING or PAR */
190 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
191 RtsFlags.ProfFlags.profileInterval = 100;
194 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
195 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
196 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
197 RtsFlags.ProfFlags.ccsLength = 25;
198 RtsFlags.ProfFlags.modSelector = NULL;
199 RtsFlags.ProfFlags.descrSelector = NULL;
200 RtsFlags.ProfFlags.typeSelector = NULL;
201 RtsFlags.ProfFlags.ccSelector = NULL;
202 RtsFlags.ProfFlags.ccsSelector = NULL;
203 RtsFlags.ProfFlags.retainerSelector = NULL;
204 RtsFlags.ProfFlags.bioSelector = NULL;
207 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
208 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
210 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
211 RtsFlags.MiscFlags.linkerMemBase = 0;
214 RtsFlags.ParFlags.nNodes = 1;
215 RtsFlags.ParFlags.migrate = rtsTrue;
216 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
217 RtsFlags.ParFlags.parGcEnabled = 1;
218 RtsFlags.ParFlags.parGcGen = 1;
222 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
223 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
224 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
225 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
226 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
227 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
228 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
230 RtsFlags.ParFlags.outputDisabled = rtsFalse;
232 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
234 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
236 RtsFlags.ParFlags.packBufferSize = 1024;
237 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
238 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
239 RtsFlags.ParFlags.maxThreads = 1024;
240 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
241 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
244 #if defined(PAR) || defined(THREADED_RTS)
245 RtsFlags.ParFlags.maxLocalSparks = 4096;
246 #endif /* PAR || THREADED_RTS */
249 /* ToDo: check defaults for GranSim and GUM */
250 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
251 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
253 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
254 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
255 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
256 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
257 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
258 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
259 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
260 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
262 RtsFlags.GranFlags.packBufferSize = 1024;
263 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
265 RtsFlags.GranFlags.proc = MAX_PROC;
266 RtsFlags.GranFlags.Fishing = rtsFalse;
267 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
268 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
269 RtsFlags.GranFlags.Light = rtsFalse;
271 RtsFlags.GranFlags.Costs.latency = LATENCY;
272 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
273 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
274 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
275 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
276 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
277 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
278 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
280 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
281 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
282 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
283 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
284 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
286 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
287 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
288 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
289 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
290 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
292 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
294 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
295 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
297 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
298 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
299 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
300 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
301 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
302 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
303 RtsFlags.GranFlags.FetchStrategy = 2;
304 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
305 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
306 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
307 RtsFlags.GranFlags.SparkPriority = 0;
308 RtsFlags.GranFlags.SparkPriority2 = 0;
309 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
310 RtsFlags.GranFlags.InversePriorities = rtsFalse;
311 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
312 RtsFlags.GranFlags.ThunksToPack = 0;
313 RtsFlags.GranFlags.RandomSteal = rtsTrue;
317 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
318 RtsFlags.TickyFlags.tickyFile = NULL;
321 RtsFlags.TraceFlags.timestamp = rtsFalse;
322 RtsFlags.TraceFlags.sched = rtsFalse;
323 RtsFlags.TraceFlags.gc = rtsFalse;
326 /* By default no special measurements taken */
327 RtsFlags.PapiFlags.eventType = 0;
328 RtsFlags.PapiFlags.numUserEvents = 0;
335 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
337 " +RTS Indicates run time system options follow",
338 " -RTS Indicates program arguments follow",
339 " --RTS Indicates that ALL subsequent arguments will be given to the",
340 " program (including any of these RTS flags)",
342 "The following run time system options are available:",
344 " -? Prints this message and exits; the program is not executed",
345 " --info Print information about the RTS used by this program",
347 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
348 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
350 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
351 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
352 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
353 " -m<n> Minimum % of heap which must be available (default 3%)",
354 " -G<n> Number of generations (default: 2)",
355 " -T<n> Number of steps in younger generations (default: 2)",
356 " -c<n> Auto-enable compaction of the oldest generation when live data is",
357 " at least <n>% of the maximum heap size set with -M (default: 30%)",
358 " -c Enable compaction for all major collections",
359 " -w Use mark-region for the oldest generation (experimental)",
360 #if defined(THREADED_RTS)
361 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
364 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
365 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
366 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
367 #ifdef RTS_GTK_FRONTPANEL
368 " -f Display front panel (requires X11 & GTK+)",
372 " -Z Don't squeeze out update frames on stack overflow",
373 " -B Sound the bell at the start of each garbage collection",
374 #if defined(PROFILING) || defined(PAR)
376 " -px Time/allocation profile (XML) (output file <program>.prof)",
377 " -p Time/allocation profile (output file <program>.prof)",
378 " -P More detailed Time/Allocation profile",
379 " -Pa Give information about *all* cost centres",
381 # if defined(PROFILING)
383 " -hx Heap residency profile (XML) (output file <program>.prof)",
384 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
385 " break-down: c = cost centre stack (default)",
387 " d = closure description",
388 " y = type description",
390 " b = biography (LAG,DRAG,VOID,USE)",
391 " A subset of closures may be selected thusly:",
392 " -hc<cc>,... specific cost centre(s) (top of stack only)",
393 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
394 " -hm<mod>... all cost centres from the specified modules(s)",
395 " -hd<des>,... closures with specified closure descriptions",
396 " -hy<typ>... closures with specified type descriptions",
397 " -hr<cc>... closures with specified retainers",
398 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
400 " -R<size> Set the maximum retainer set size (default: 8)",
402 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
405 " -xt Include threads (TSOs) in a heap profile",
407 " -xc Show current cost centre stack on raising an exception",
410 #endif /* PROFILING or PAR */
411 #if !defined(PROFILING)
413 " -hT Heap residency profile (output file <program>.hp)",
415 " -i<sec> Time between heap samples (seconds, default: 0.1)",
417 #if defined(TICKY_TICKY)
418 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
422 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
423 /* NB: the -N<n> is implemented by the driver!! */
425 " -C<secs> Context-switch interval in seconds.",
426 " 0 or no argument means switch as often as possible.",
427 " Default: 0.02 sec; resolution is set by -V below.",
428 " -V<secs> Master tick interval in seconds (0 == disable timer).",
429 " This sets the resolution for -C and the profile timer -i.",
430 " Default: 0.02 sec.",
432 " -vs Trace scheduler events (see also -Ds with -debug)",
433 " -vt Time-stamp trace messages",
436 " -Ds DEBUG: scheduler",
437 " -Di DEBUG: interpreter",
439 " -DG DEBUG: gccafs",
442 " -DS DEBUG: sanity",
443 " -Dt DEBUG: stable",
447 " -Dl DEBUG: linker",
449 " -Dz DEBUG: stack squezing",
450 " -Dc DEBUG: program coverage",
453 #if defined(THREADED_RTS) && !defined(NOSMP)
454 " -N<n> Use <n> OS threads (default: 1)",
455 " -q1 Use one OS thread for GC (turns off parallel GC)",
456 " -qg<n> Use parallel GC only for generations >= <n> (default: 1)",
457 " -qm Don't automatically migrate threads between CPUs",
458 " -qw Migrate a thread to the current CPU when it is woken up",
460 " --install-signal-handlers=<yes|no>",
461 " Install signal handlers (default: yes)",
462 #if defined(THREADED_RTS) || defined(PAR)
463 " -e<size> Size of spark pools (default 100)",
466 " -t<num> Set maximum number of advisory threads per PE (default 32)",
467 " -qP Enable activity profile (output files in ~/<program>*.gr)",
468 " -qQ<size> Set pack-buffer size (default: 1024)",
469 " -qd Turn on PVM-ish debugging",
470 " -qO Disable output for performance measurement",
472 #if defined(THREADED_RTS) || defined(PAR)
473 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
476 " -d Turn on PVM-ish debugging",
477 " -O Disable output for performance measurement",
479 #if defined(GRAN) /* ToDo: fill in decent Docu here */
480 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
482 #if defined(x86_64_HOST_ARCH)
483 " -xm Base address to mmap memory in the GHCi linker",
484 " (hex; must be <80000000)",
486 #if defined(USE_PAPI)
487 " -aX CPU performance counter measurements using PAPI",
488 " (use with the -s<file> option). X is one of:",
491 " 1 - level 1 cache misses",
492 " 2 - level 2 cache misses",
493 " b - branch mispredictions",
494 " s - stalled cycles",
495 " e - cache miss and branch misprediction events",
498 "RTS options may also be specified using the GHCRTS environment variable.",
500 "Other RTS options may be available for programs compiled a different way.",
501 "The GHC User's Guide has full details.",
506 STATIC_INLINE rtsBool
507 strequal(const char *a, const char * b)
509 return(strcmp(a, b) == 0);
513 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
519 while (isspace(*c1)) { c1++; };
521 while (!isspace(*c2) && *c2 != '\0') { c2++; };
523 if (c1 == c2) { break; }
525 if (*rts_argc < MAX_RTS_ARGS-1) {
526 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
527 strncpy(s, c1, c2-c1);
529 rts_argv[(*rts_argc)++] = s;
531 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
535 } while (*c1 != '\0');
539 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
541 rtsBool error = rtsFalse;
552 // process arguments from the ghc_rts_opts global variable first.
553 // (arguments from the GHCRTS environment variable and the command
554 // line override these).
556 if (ghc_rts_opts != NULL) {
557 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
561 // process arguments from the GHCRTS environment variable next
562 // (arguments from the command line override these).
564 char *ghc_rts = getenv("GHCRTS");
566 if (ghc_rts != NULL) {
567 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
571 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
572 // argv[0] must be PGM argument -- leave in argv
574 for (mode = PGM; arg < total_arg; arg++) {
575 // The '--RTS' argument disables all future +RTS ... -RTS processing.
576 if (strequal("--RTS", argv[arg])) {
580 // The '--' argument is passed through to the program, but
581 // disables all further +RTS ... -RTS processing.
582 else if (strequal("--", argv[arg])) {
585 else if (strequal("+RTS", argv[arg])) {
588 else if (strequal("-RTS", argv[arg])) {
591 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
592 rts_argv[(*rts_argc)++] = argv[arg];
594 else if (mode == PGM) {
595 argv[(*argc)++] = argv[arg];
598 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
601 // process remaining program arguments
602 for (; arg < total_arg; arg++) {
603 argv[(*argc)++] = argv[arg];
605 argv[*argc] = (char *) 0;
606 rts_argv[*rts_argc] = (char *) 0;
608 // Process RTS (rts_argv) part: mainly to determine statsfile
609 for (arg = 0; arg < *rts_argc; arg++) {
610 if (rts_argv[arg][0] != '-') {
612 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
616 switch(rts_argv[arg][1]) {
618 /* process: general args, then PROFILING-only ones,
619 then CONCURRENT-only, PARallel-only, GRAN-only,
620 TICKY-only (same order as defined in RtsFlags.lh);
621 within those groups, mostly in case-insensitive
623 Final group is x*, which allows for more options.
627 # define TICKY_BUILD_ONLY(x) x
629 # define TICKY_BUILD_ONLY(x) \
630 errorBelch("not built for: ticky-ticky stats"); \
634 #if defined(PROFILING)
635 # define COST_CENTRE_USING_BUILD_ONLY(x) x
637 # define COST_CENTRE_USING_BUILD_ONLY(x) \
638 errorBelch("not built for: -prof or -parallel"); \
643 # define PROFILING_BUILD_ONLY(x) x
645 # define PROFILING_BUILD_ONLY(x) \
646 errorBelch("not built for: -prof"); \
651 # define PAR_BUILD_ONLY(x) x
653 # define PAR_BUILD_ONLY(x) \
654 errorBelch("not built for: -parallel"); \
659 # define THREADED_BUILD_ONLY(x) x
661 # define THREADED_BUILD_ONLY(x) \
662 errorBelch("not built for: -smp"); \
666 #if defined(THREADED_RTS) || defined(PAR)
667 # define PAR_OR_THREADED_BUILD_ONLY(x) x
669 # define PAR_OR_THREADED_BUILD_ONLY(x) \
670 errorBelch("not built for: -parallel or -smp"); \
675 # define GRAN_BUILD_ONLY(x) x
677 # define GRAN_BUILD_ONLY(x) \
678 errorBelch("not built for: -gransim"); \
682 /* =========== GENERAL ========================== */
687 /* This isn't going to allow us to keep related options
688 together as we add more --* flags. We really need a
689 proper options parser. */
691 if (strequal("install-signal-handlers=yes",
692 &rts_argv[arg][2])) {
693 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
695 else if (strequal("install-signal-handlers=no",
696 &rts_argv[arg][2])) {
697 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
699 else if (strequal("info",
700 &rts_argv[arg][2])) {
705 errorBelch("unknown RTS option: %s",rts_argv[arg]);
710 RtsFlags.GcFlags.minAllocAreaSize
711 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
712 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
713 bad_option(rts_argv[arg]);
719 switch(rts_argv[arg][2]) {
721 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
724 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
727 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
730 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
733 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
736 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
737 errorBelch("maximum number of PAPI events reached");
738 stg_exit(EXIT_FAILURE);
740 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
741 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
744 bad_option( rts_argv[arg] );
750 RtsFlags.GcFlags.ringBell = rtsTrue;
754 if (rts_argv[arg][2] != '\0') {
755 RtsFlags.GcFlags.compactThreshold =
756 atof(rts_argv[arg]+2);
758 RtsFlags.GcFlags.compact = rtsTrue;
763 RtsFlags.GcFlags.sweep = rtsTrue;
767 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
769 if (RtsFlags.GcFlags.oldGenFactor < 0)
770 bad_option( rts_argv[arg] );
778 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
781 RtsFlags.DebugFlags.scheduler = rtsTrue;
784 RtsFlags.DebugFlags.interpreter = rtsTrue;
787 RtsFlags.DebugFlags.weak = rtsTrue;
790 RtsFlags.DebugFlags.gccafs = rtsTrue;
793 RtsFlags.DebugFlags.gc = rtsTrue;
796 RtsFlags.DebugFlags.block_alloc = rtsTrue;
799 RtsFlags.DebugFlags.sanity = rtsTrue;
802 RtsFlags.DebugFlags.stable = rtsTrue;
805 RtsFlags.DebugFlags.prof = rtsTrue;
808 RtsFlags.DebugFlags.gran = rtsTrue;
811 RtsFlags.DebugFlags.par = rtsTrue;
814 RtsFlags.DebugFlags.linker = rtsTrue;
817 RtsFlags.DebugFlags.apply = rtsTrue;
820 RtsFlags.DebugFlags.stm = rtsTrue;
823 RtsFlags.DebugFlags.squeeze = rtsTrue;
826 RtsFlags.DebugFlags.hpc = rtsTrue;
829 bad_option( rts_argv[arg] );
837 RtsFlags.GcFlags.maxStkSize =
838 decode(rts_argv[arg]+2) / sizeof(W_);
840 if (RtsFlags.GcFlags.maxStkSize == 0)
841 bad_option( rts_argv[arg] );
845 RtsFlags.GcFlags.initialStkSize =
846 decode(rts_argv[arg]+2) / sizeof(W_);
848 if (RtsFlags.GcFlags.initialStkSize == 0)
849 bad_option( rts_argv[arg] );
853 RtsFlags.GcFlags.maxHeapSize =
854 decode(rts_argv[arg]+2) / BLOCK_SIZE;
855 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
857 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
858 bad_option(rts_argv[arg]);
863 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
865 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
866 RtsFlags.GcFlags.pcFreeHeap > 100)
867 bad_option( rts_argv[arg] );
871 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
872 if (RtsFlags.GcFlags.generations < 1) {
873 bad_option(rts_argv[arg]);
878 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
879 if (RtsFlags.GcFlags.steps < 1) {
880 bad_option(rts_argv[arg]);
885 RtsFlags.GcFlags.heapSizeSuggestion =
886 decode(rts_argv[arg]+2) / BLOCK_SIZE;
889 #ifdef RTS_GTK_FRONTPANEL
891 RtsFlags.GcFlags.frontpanel = rtsTrue;
895 case 'I': /* idle GC delay */
896 if (rts_argv[arg][2] == '\0') {
901 /* Convert to millisecs */
902 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
903 RtsFlags.GcFlags.idleGCDelayTime = cst;
908 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
912 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
916 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
921 /* Opening all those files would almost certainly fail... */
922 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
923 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
927 r = open_stats_file(arg, *argc, argv,
928 *rts_argc, rts_argv, NULL,
929 &RtsFlags.GcFlags.statsFile);
930 if (r == -1) { error = rtsTrue; }
936 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
939 /* =========== PROFILING ========================== */
941 case 'P': /* detailed cost centre profiling (time/alloc) */
942 case 'p': /* cost centre profiling (time/alloc) */
943 COST_CENTRE_USING_BUILD_ONLY(
944 switch (rts_argv[arg][2]) {
946 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
949 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
952 if (rts_argv[arg][1] == 'P') {
953 RtsFlags.CcFlags.doCostCentres =
954 COST_CENTRES_VERBOSE;
956 RtsFlags.CcFlags.doCostCentres =
957 COST_CENTRES_SUMMARY;
964 PROFILING_BUILD_ONLY(
965 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
968 PROFILING_BUILD_ONLY(
969 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
970 if(RtsFlags.ProfFlags.ccsLength <= 0) {
971 bad_option(rts_argv[arg]);
974 case 'h': /* serial heap profile */
975 #if !defined(PROFILING)
976 switch (rts_argv[arg][2]) {
979 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
982 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
986 PROFILING_BUILD_ONLY(
987 switch (rts_argv[arg][2]) {
1001 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
1003 char *left = strchr(rts_argv[arg], '{');
1004 char *right = strrchr(rts_argv[arg], '}');
1006 // curly braces are optional, for
1007 // backwards compat.
1011 left = rts_argv[arg] + 3;
1014 right = rts_argv[arg] + strlen(rts_argv[arg]);
1018 switch (rts_argv[arg][2]) {
1019 case 'c': // cost centre label select
1020 RtsFlags.ProfFlags.ccSelector = left;
1023 RtsFlags.ProfFlags.ccsSelector = left;
1026 case 'm': // cost centre module select
1027 RtsFlags.ProfFlags.modSelector = left;
1030 case 'd': // closure descr select
1031 RtsFlags.ProfFlags.descrSelector = left;
1034 case 'y': // closure type select
1035 RtsFlags.ProfFlags.typeSelector = left;
1038 case 'r': // retainer select
1039 RtsFlags.ProfFlags.retainerSelector = left;
1042 case 'b': // biography select
1043 RtsFlags.ProfFlags.bioSelector = left;
1050 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1051 errorBelch("multiple heap profile options");
1056 switch (rts_argv[arg][2]) {
1060 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1064 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1068 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1072 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1076 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1080 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1086 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1090 #endif /* PROFILING */
1093 case 'i': /* heap sample interval */
1094 if (rts_argv[arg][2] == '\0') {
1099 /* Convert to milliseconds */
1100 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1101 RtsFlags.ProfFlags.profileInterval = cst;
1105 /* =========== CONCURRENT ========================= */
1106 case 'C': /* context switch interval */
1107 if (rts_argv[arg][2] == '\0')
1108 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1112 /* Convert to milliseconds */
1113 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1114 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1118 case 'V': /* master tick interval */
1119 if (rts_argv[arg][2] == '\0') {
1120 // turns off ticks completely
1121 RtsFlags.MiscFlags.tickInterval = 0;
1125 /* Convert to milliseconds */
1126 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1127 RtsFlags.MiscFlags.tickInterval = cst;
1131 #if defined(THREADED_RTS) && !defined(NOSMP)
1133 THREADED_BUILD_ONLY(
1134 if (rts_argv[arg][2] != '\0') {
1135 RtsFlags.ParFlags.nNodes
1136 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1137 if (RtsFlags.ParFlags.nNodes <= 0) {
1138 errorBelch("bad value for -N");
1141 #if defined(PROFILING)
1142 if (RtsFlags.ParFlags.nNodes > 1) {
1143 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1151 THREADED_BUILD_ONLY(
1152 switch (rts_argv[arg][2]) {
1154 // backwards compat only
1155 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1158 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1165 switch (rts_argv[arg][2]) {
1167 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1171 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1174 if (rts_argv[arg][3] != '\0') {
1175 RtsFlags.ParFlags.parGcGen
1176 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1178 errorBelch("bad value for -qg");
1183 RtsFlags.ParFlags.migrate = rtsFalse;
1186 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1189 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1195 /* =========== PARALLEL =========================== */
1197 PAR_OR_THREADED_BUILD_ONLY(
1198 if (rts_argv[arg][2] != '\0') {
1199 RtsFlags.ParFlags.maxLocalSparks
1200 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1201 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1202 errorBelch("bad value for -e");
1211 process_par_option(arg, rts_argc, rts_argv, &error);
1215 /* =========== GRAN =============================== */
1219 process_gran_option(arg, rts_argc, rts_argv, &error);
1222 /* =========== TICKY ============================== */
1224 case 'r': /* Basic profiling stats */
1227 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1231 r = open_stats_file(arg, *argc, argv,
1232 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1233 &RtsFlags.TickyFlags.tickyFile);
1234 if (r == -1) { error = rtsTrue; }
1238 /* =========== TRACING ---------=================== */
1241 switch(rts_argv[arg][2]) {
1243 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1247 RtsFlags.TraceFlags.timestamp = rtsTrue;
1250 RtsFlags.TraceFlags.sched = rtsTrue;
1253 RtsFlags.TraceFlags.gc = rtsTrue;
1256 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1262 /* =========== EXTENDED OPTIONS =================== */
1264 case 'x': /* Extend the argument space */
1265 switch(rts_argv[arg][2]) {
1267 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1271 case 'b': /* heapBase in hex; undocumented */
1272 if (rts_argv[arg][3] != '\0') {
1273 RtsFlags.GcFlags.heapBase
1274 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1276 errorBelch("-xb: requires argument");
1281 #if defined(x86_64_HOST_ARCH)
1282 case 'm': /* linkerMemBase */
1283 if (rts_argv[arg][3] != '\0') {
1284 RtsFlags.MiscFlags.linkerMemBase
1285 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1286 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1287 errorBelch("-xm: value must be <80000000");
1291 RtsFlags.MiscFlags.linkerMemBase = 0;
1296 case 'c': /* Debugging tool: show current cost centre on an exception */
1297 PROFILING_BUILD_ONLY(
1298 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1302 case 't': /* Include memory used by TSOs in a heap profile */
1303 PROFILING_BUILD_ONLY(
1304 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1308 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1311 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1315 break; /* defensive programming */
1317 /* =========== OH DEAR ============================ */
1319 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1326 if (RtsFlags.MiscFlags.tickInterval < 0) {
1327 RtsFlags.MiscFlags.tickInterval = 50;
1330 // If the master timer is disabled, turn off the other timers.
1331 if (RtsFlags.MiscFlags.tickInterval == 0) {
1332 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1333 RtsFlags.GcFlags.idleGCDelayTime = 0;
1334 RtsFlags.ProfFlags.profileInterval = 0;
1337 // Determine what tick interval we should use for the RTS timer
1338 // by taking the shortest of the various intervals that we need to
1340 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1341 RtsFlags.MiscFlags.tickInterval =
1342 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1343 RtsFlags.MiscFlags.tickInterval);
1346 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1347 RtsFlags.MiscFlags.tickInterval =
1348 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1349 RtsFlags.MiscFlags.tickInterval);
1352 if (RtsFlags.ProfFlags.profileInterval > 0) {
1353 RtsFlags.MiscFlags.tickInterval =
1354 stg_min(RtsFlags.ProfFlags.profileInterval,
1355 RtsFlags.MiscFlags.tickInterval);
1358 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1359 RtsFlags.ConcFlags.ctxtSwitchTicks =
1360 RtsFlags.ConcFlags.ctxtSwitchTime /
1361 RtsFlags.MiscFlags.tickInterval;
1363 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1366 if (RtsFlags.ProfFlags.profileInterval > 0) {
1367 RtsFlags.ProfFlags.profileIntervalTicks =
1368 RtsFlags.ProfFlags.profileInterval /
1369 RtsFlags.MiscFlags.tickInterval;
1371 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1378 for (p = usage_text; *p; p++)
1379 errorBelch("%s", *p);
1380 stg_exit(EXIT_FAILURE);
1387 enable_GranSimLight(void) {
1389 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1390 RtsFlags.GranFlags.Light=rtsTrue;
1391 RtsFlags.GranFlags.Costs.latency =
1392 RtsFlags.GranFlags.Costs.fetchtime =
1393 RtsFlags.GranFlags.Costs.additional_latency =
1394 RtsFlags.GranFlags.Costs.gunblocktime =
1395 RtsFlags.GranFlags.Costs.lunblocktime =
1396 RtsFlags.GranFlags.Costs.threadcreatetime =
1397 RtsFlags.GranFlags.Costs.threadqueuetime =
1398 RtsFlags.GranFlags.Costs.threadscheduletime =
1399 RtsFlags.GranFlags.Costs.threaddescheduletime =
1400 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1402 RtsFlags.GranFlags.Costs.mpacktime =
1403 RtsFlags.GranFlags.Costs.munpacktime = 0;
1405 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1406 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1407 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1408 /* FetchStrategy is irrelevant in GrAnSim-Light */
1410 /* GrAnSim Light often creates an abundance of parallel threads,
1411 each with its own stack etc. Therefore, it's in general a good
1412 idea to use small stack chunks (use the -o<size> option to
1415 // RtsFlags.ConcFlags.stkChunkSize = 100;
1417 RtsFlags.GranFlags.proc = 1;
1421 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1423 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1426 /* or a ridiculously idealised simulator */
1427 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1428 RtsFlags.GranFlags.Costs.latency =
1429 RtsFlags.GranFlags.Costs.fetchtime =
1430 RtsFlags.GranFlags.Costs.additional_latency =
1431 RtsFlags.GranFlags.Costs.gunblocktime =
1432 RtsFlags.GranFlags.Costs.lunblocktime =
1433 RtsFlags.GranFlags.Costs.threadcreatetime =
1434 RtsFlags.GranFlags.Costs.threadqueuetime =
1435 RtsFlags.GranFlags.Costs.threadscheduletime =
1436 RtsFlags.GranFlags.Costs.threaddescheduletime =
1437 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1439 RtsFlags.GranFlags.Costs.mpacktime =
1440 RtsFlags.GranFlags.Costs.munpacktime = 0;
1442 RtsFlags.GranFlags.Costs.arith_cost =
1443 RtsFlags.GranFlags.Costs.float_cost =
1444 RtsFlags.GranFlags.Costs.load_cost =
1445 RtsFlags.GranFlags.Costs.store_cost =
1446 RtsFlags.GranFlags.Costs.branch_cost = 0;
1448 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1450 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1451 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1452 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1453 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1457 /* or a somewhat idealised simulator */
1458 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1459 RtsFlags.GranFlags.Costs.latency =
1460 RtsFlags.GranFlags.Costs.fetchtime =
1461 RtsFlags.GranFlags.Costs.additional_latency =
1462 RtsFlags.GranFlags.Costs.gunblocktime =
1463 RtsFlags.GranFlags.Costs.lunblocktime =
1464 RtsFlags.GranFlags.Costs.threadcreatetime =
1465 RtsFlags.GranFlags.Costs.threadqueuetime =
1466 RtsFlags.GranFlags.Costs.threadscheduletime =
1467 RtsFlags.GranFlags.Costs.threaddescheduletime =
1468 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1470 RtsFlags.GranFlags.Costs.mpacktime =
1471 RtsFlags.GranFlags.Costs.munpacktime = 0;
1473 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1475 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1476 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1477 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1478 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1479 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1480 # if defined(GRAN_CHECK) && defined(GRAN)
1481 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1486 /* Communication and task creation cost parameters */
1487 switch(rts_argv[arg][2]) {
1489 IgnoreYields = rtsTrue; // HWL HACK
1493 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1497 if (rts_argv[arg][3] != '\0')
1499 RtsFlags.GranFlags.Costs.gunblocktime =
1500 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1501 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1504 RtsFlags.GranFlags.Costs.latency = LATENCY;
1508 if (rts_argv[arg][3] != '\0')
1509 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1511 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1515 if (rts_argv[arg][3] != '\0')
1516 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1518 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1522 if (rts_argv[arg][3] != '\0')
1523 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1525 RtsFlags.GranFlags.Costs.mtidytime = 0;
1529 if (rts_argv[arg][3] != '\0')
1530 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1532 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1536 if (rts_argv[arg][3] != '\0')
1537 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1539 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1543 if (rts_argv[arg][3] != '\0')
1544 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1546 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1550 if (rts_argv[arg][3] != '\0')
1551 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1553 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1556 /* Thread-related metrics */
1558 if (rts_argv[arg][3] != '\0')
1559 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1561 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1565 if (rts_argv[arg][3] != '\0')
1566 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1568 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1572 if (rts_argv[arg][3] != '\0')
1573 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1575 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1577 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1578 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1582 if (rts_argv[arg][3] != '\0')
1583 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1585 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1587 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1588 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1591 /* Instruction Cost Metrics */
1593 if (rts_argv[arg][3] != '\0')
1594 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1596 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1600 if (rts_argv[arg][3] != '\0')
1601 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1603 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1607 if (rts_argv[arg][3] != '\0')
1608 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1610 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1614 if (rts_argv[arg][3] != '\0')
1615 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1617 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1621 if (rts_argv[arg][3] != '\0')
1622 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1624 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1628 if (rts_argv[arg][3] != '\0')
1629 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1631 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1635 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1636 if (rts_argv[arg][3] != '\0')
1637 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1639 RtsFlags.GranFlags.FetchStrategy = 2;
1640 if (RtsFlags.GranFlags.FetchStrategy == 0)
1641 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1644 case 'K': /* sort overhead (per elem in spark list) */
1645 if (rts_argv[arg][3] != '\0')
1646 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1648 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1649 debugBelch("Overhead for pri spark: %d (per elem).\n",
1650 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1653 case 'O': /* sort overhead (per elem in spark list) */
1654 if (rts_argv[arg][3] != '\0')
1655 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1657 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1658 debugBelch("Overhead for pri sched: %d (per elem).\n",
1659 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1662 /* General Parameters */
1664 if (rts_argv[arg][3] != '\0')
1666 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1667 if (RtsFlags.GranFlags.proc==0) {
1668 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1669 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1670 RtsFlags.GranFlags.proc < 1)
1672 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1678 RtsFlags.GranFlags.proc = MAX_PROC;
1682 RtsFlags.GranFlags.Fishing = rtsTrue;
1683 if (rts_argv[arg][3] != '\0')
1684 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1686 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1690 if (rts_argv[arg][3] != '\0')
1691 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1693 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1697 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1698 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1702 debugBelch("Bulk fetching enabled.\n");
1703 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1707 debugBelch("Thread migration enabled.\n");
1708 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1712 debugBelch("Fair Scheduling enabled.\n");
1713 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1717 debugBelch("Priority Scheduling enabled.\n");
1718 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1722 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1723 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1727 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1731 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1735 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1739 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1743 /* format is -bP<c> where <c> is one char describing kind of profile */
1744 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1745 switch(rts_argv[arg][3]) {
1746 case '\0': break; // nothing special, just an ordinary profile
1747 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1749 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1751 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1753 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1755 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1757 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1759 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1764 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1768 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1771 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1772 if (rts_argv[arg][3] != '\0') {
1775 arg0 = rts_argv[arg]+3;
1776 if ((tmp = strstr(arg0,","))==NULL) {
1777 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1778 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1781 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1782 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1783 debugBelch("SparkPriority: %u.\n",
1784 RtsFlags.GranFlags.SparkPriority);
1785 debugBelch("SparkPriority2:%u.\n",
1786 RtsFlags.GranFlags.SparkPriority2);
1787 if (RtsFlags.GranFlags.SparkPriority2 <
1788 RtsFlags.GranFlags.SparkPriority) {
1789 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1790 RtsFlags.GranFlags.SparkPriority2,
1791 RtsFlags.GranFlags.SparkPriority);
1795 /* plain pri spark is now invoked with -bX
1796 RtsFlags.GranFlags.DoPrioritySparking = 1;
1797 debugBelch("PrioritySparking.\n");
1803 if (rts_argv[arg][3] != '\0') {
1804 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1806 RtsFlags.GranFlags.ThunksToPack = 1;
1808 debugBelch("Thunks To Pack in one packet: %u.\n",
1809 RtsFlags.GranFlags.ThunksToPack);
1813 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1814 debugBelch("Deterministic mode (no random stealing)\n");
1817 /* The following class of options contains eXperimental */
1818 /* features in connection with exploiting granularity */
1819 /* information. I.e. if -bY is chosen these options */
1820 /* tell the RTS what to do with the supplied info --HWL */
1823 if (rts_argv[arg][3] != '\0') {
1824 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1826 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1828 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1829 RtsFlags.GranFlags.packBufferSize_internal);
1833 switch(rts_argv[arg][3]) {
1836 RtsFlags.GranFlags.DoPrioritySparking = 1;
1837 debugBelch("Priority Sparking with Normal Priorities.\n");
1838 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1839 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1840 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1844 RtsFlags.GranFlags.DoPrioritySparking = 1;
1845 debugBelch("Priority Sparking with Inverse Priorities.\n");
1846 RtsFlags.GranFlags.InversePriorities++;
1850 RtsFlags.GranFlags.DoPrioritySparking = 1;
1851 debugBelch("Priority Sparking with Random Priorities.\n");
1852 RtsFlags.GranFlags.RandomPriorities++;
1856 RtsFlags.GranFlags.DoPrioritySparking = 1;
1857 debugBelch("Priority Sparking with No Priorities.\n");
1858 RtsFlags.GranFlags.IgnorePriorities++;
1862 bad_option( rts_argv[arg] );
1868 switch(rts_argv[arg][3]) {
1871 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1872 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1876 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1880 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1884 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1888 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1889 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1893 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1897 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1901 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1905 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1909 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1913 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1917 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1921 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1922 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1926 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1930 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1934 bad_option( rts_argv[arg] );
1939 # if defined(GRAN_CHECK) && defined(GRAN)
1941 switch(rts_argv[arg][3]) {
1942 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1943 if (rts_argv[arg][4] != '\0') {
1944 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1945 debugBelch("Pack buffer size: %d\n",
1946 RtsFlags.GranFlags.packBufferSize);
1948 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1954 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1955 /* hack warning: interpret the flags as a binary number */
1956 nat n = decode(rts_argv[arg]+3);
1957 set_GranSim_debug_options(n);
1960 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1961 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1964 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1965 debugBelch("Valid GranSim debug options are:\n");
1966 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1967 bad_option( rts_argv[arg] );
1968 } else { // flag found; now set it
1969 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1975 case 'e': /* event trace; also -bD1 */
1976 debugBelch("DEBUG: event_trace; printing event trace.\n");
1977 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1978 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1981 case 'E': /* event statistics; also -bD2 */
1982 debugBelch("DEBUG: event_stats; printing event statistics.\n");
1983 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1984 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1987 case 'f': /* thunkStealing; also -bD4 */
1988 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1989 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1990 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1993 case 'z': /* blockOnFetch; also -bD8 */
1994 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1995 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1996 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1999 case 't': /* blockOnFetch_sanity; also -bD16 */
2000 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
2001 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
2002 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
2005 case 'S': /* priSpark; also -bD32 */
2006 debugBelch("DEBUG: priSpark; priority sparking.\n");
2007 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
2010 case 's': /* priSched; also -bD64 */
2011 debugBelch("DEBUG: priSched; priority scheduling.\n");
2012 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
2015 case 'F': /* findWork; also -bD128 */
2016 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
2017 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
2020 case 'g': /* globalBlock; also -bD256 */
2021 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
2022 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
2025 case 'G': /* pack; also -bD512 */
2026 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
2027 RtsFlags.GranFlags.Debug.pack = rtsTrue;
2030 case 'P': /* packBuffer; also -bD1024 */
2031 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
2032 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
2035 case 'o': /* sortedQ; also -bD2048 */
2036 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
2037 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
2040 case 'r': /* randomSteal; also -bD4096 */
2041 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2042 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2045 case 'q': /* checkSparkQ; also -bD8192 */
2046 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2047 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2050 case ':': /* checkLight; also -bD16384 */
2051 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2052 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2055 case 'b': /* bq; also -bD32768 */
2056 debugBelch("DEBUG: bq; check blocking queues\n");
2057 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2060 case 'd': /* all options turned on */
2061 debugBelch("DEBUG: all options turned on.\n");
2062 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2063 /* RtsFlags.GranFlags.Debug |= 0x40; */
2067 /* RtsFlags.GranFlags.Debug = 1; */
2073 # endif /* GRAN_CHECK */
2075 bad_option( rts_argv[arg] );
2081 Interpret n as a binary number masking GranSim debug options and set the
2082 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2085 set_GranSim_debug_options(nat n) {
2088 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2090 errorBelch(gran_debug_opts_strs[i]);
2092 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2093 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2094 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2095 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2096 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2097 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2098 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2099 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2100 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2101 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2102 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2103 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2104 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2105 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2106 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2107 default: barf("set_GranSim_debug_options: only %d debug options expected");
2113 Print one line explanation for each of the GranSim debug options specified
2117 help_GranSim_debug_options(nat n) {
2120 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2122 debugBelch(gran_debug_opts_strs[i]);
2128 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2131 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2132 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2136 /* Communication and task creation cost parameters */
2137 switch(rts_argv[arg][2]) {
2138 case 'e': /* -qe<n> ... allow <n> local sparks */
2139 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2140 RtsFlags.ParFlags.maxLocalSparks
2141 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2143 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2144 errorBelch("setupRtsFlags: bad value for -e\n");
2148 IF_PAR_DEBUG(verbose,
2149 errorBelch("-qe<n>: max %d local sparks",
2150 RtsFlags.ParFlags.maxLocalSparks));
2154 if (rts_argv[arg][3] != '\0') {
2155 RtsFlags.ParFlags.maxThreads
2156 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2158 errorBelch("missing size for -qt\n");
2161 IF_PAR_DEBUG(verbose,
2162 errorBelch("-qt<n>: max %d threads",
2163 RtsFlags.ParFlags.maxThreads));
2167 if (rts_argv[arg][3] != '\0')
2168 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2170 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2172 IF_PAR_DEBUG(verbose,
2173 errorBelch("-qf<n>: max %d fishes sent out at one time",
2174 RtsFlags.ParFlags.maxFishes));
2178 if (rts_argv[arg][3] != '\0') {
2179 RtsFlags.ParFlags.fishDelay
2180 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2182 errorBelch("missing fish delay time for -qF\n");
2185 IF_PAR_DEBUG(verbose,
2186 errorBelch("-qF<n>: fish delay time %d us",
2187 RtsFlags.ParFlags.fishDelay));
2191 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2192 IF_PAR_DEBUG(verbose,
2193 errorBelch("-qO: output disabled"));
2196 case 'g': /* -qg<n> ... globalisation scheme */
2197 if (rts_argv[arg][3] != '\0') {
2198 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2200 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2203 IF_PAR_DEBUG(verbose,
2204 debugBelch("-qg<n>: globalisation scheme set to %d",
2205 RtsFlags.ParFlags.globalising));
2208 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2209 if (rts_argv[arg][3] != '\0') {
2210 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2212 errorBelch("missing number of thunks per packet (for -qh)\n");
2215 IF_PAR_DEBUG(verbose,
2216 debugBelch("-qh<n>: thunks per packet set to %d",
2217 RtsFlags.ParFlags.thunksToPack));
2220 case 'P': /* -qP for writing a log file */
2221 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2222 /* same encoding as in GranSim after -bP */
2223 switch(rts_argv[arg][3]) {
2224 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2225 break; // nothing special, just an ordinary profile
2226 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2227 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2229 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2231 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2233 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2235 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2238 # if defined(PAR_TICKY)
2239 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2241 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2242 stg_exit(EXIT_FAILURE);
2245 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2247 IF_PAR_DEBUG(verbose,
2248 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2249 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2252 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2253 if (rts_argv[arg][3] != '\0') {
2254 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2256 errorBelch("missing size of PackBuffer (for -qQ)\n");
2259 IF_PAR_DEBUG(verbose,
2260 debugBelch("-qQ<n>: pack buffer size set to %d",
2261 RtsFlags.ParFlags.packBufferSize));
2265 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2266 IF_PAR_DEBUG(verbose,
2267 debugBelch("-qR: fair-ish scheduling"));
2272 if (rts_argv[arg][3] != '\0') {
2273 RtsFlags.ParFlags.wait
2274 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2276 RtsFlags.ParFlags.wait = 1000;
2278 IF_PAR_DEBUG(verbose,
2279 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2280 RtsFlags.ParFlags.wait));
2283 case 'D': /* -qD ... all the debugging options */
2284 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2285 /* hack warning: interpret the flags as a binary number */
2286 nat n = decode(rts_argv[arg]+3);
2287 set_par_debug_options(n);
2290 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2291 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2294 if (i==MAX_PAR_DEBUG_OPTION+1) {
2295 errorBelch("Valid GUM debug options are:\n");
2296 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2297 bad_option( rts_argv[arg] );
2298 } else { // flag found; now set it
2299 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2305 errorBelch("Unknown option -q%c (%d opts in total)",
2306 rts_argv[arg][2], *rts_argc);
2312 Interpret n as a binary number masking Par debug options and set the
2313 correxponding option. See par_debug_opts_strs for explanations of the flags.
2316 set_par_debug_options(nat n) {
2319 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2321 debugBelch(par_debug_opts_strs[i]);
2323 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2324 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2325 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2326 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2327 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2328 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2329 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2330 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2331 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2332 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2333 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2334 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2335 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2336 default: barf("set_par_debug_options: only %d debug options expected",
2337 MAX_PAR_DEBUG_OPTION);
2343 Print one line explanation for each of the GranSim debug options specified
2347 help_par_debug_options(nat n) {
2350 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2352 debugBelch(par_debug_opts_strs[i]);
2358 stats_fprintf(FILE *f, char *s, ...)
2370 static int /* return -1 on error */
2373 int argc, char *argv[],
2374 int rts_argc, char *rts_argv[],
2375 const char *FILENAME_FMT,
2380 if (strequal(rts_argv[arg]+2, "stderr")
2381 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
2382 f = NULL; /* NULL means use debugBelch */
2384 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2385 f = fopen(rts_argv[arg]+2,"w");
2387 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2388 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2389 f = fopen(stats_filename,"w");
2392 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2399 /* Write argv and rtsv into start of stats file */
2401 for(count = 0; count < argc; count++) {
2402 stats_fprintf(f, "%s ", argv[count]);
2404 stats_fprintf(f, "+RTS ");
2405 for(count = 0; count < rts_argc; count++)
2406 stats_fprintf(f, "%s ", rts_argv[count]);
2407 stats_fprintf(f, "\n");
2415 decode(const char *s)
2426 if (c == 'g' || c == 'G')
2427 m *= 1000*1000*1000; /* UNchecked! */
2428 else if (c == 'm' || c == 'M')
2429 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2430 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2431 m *= 1000; /* a direct-mapped cache. */
2432 else if (c == 'w' || c == 'W')
2439 bad_option(const char *s)
2441 errorBelch("bad RTS option: %s", s);
2442 stg_exit(EXIT_FAILURE);
2445 /* -----------------------------------------------------------------------------
2446 Getting/Setting the program's arguments.
2448 These are used by System.Environment, and parts of the RTS.
2449 -------------------------------------------------------------------------- */
2452 setProgName(char *argv[])
2454 /* Remove directory from argv[0] -- default files in current directory */
2455 #if !defined(mingw32_HOST_OS)
2457 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2458 prog_name = last_slash+1;
2460 prog_name = argv[0];
2463 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2464 while ( last_slash > argv[0] ) {
2465 if ( *last_slash == '/' || *last_slash == '\\' ) {
2466 prog_name = last_slash+1;
2471 prog_name = argv[0];
2476 getProgArgv(int *argc, char **argv[])
2478 if (argc) { *argc = prog_argc; }
2479 if (argv) { *argv = prog_argv; }
2483 setProgArgv(int argc, char *argv[])
2485 /* Usually this is done by startupHaskell, so we don't need to call this.
2486 However, sometimes Hugs wants to change the arguments which Haskell
2487 getArgs >>= ... will be fed. So you can do that by calling here
2488 _after_ calling startupHaskell.
2492 setProgName(prog_argv);
2495 /* These functions record and recall the full arguments, including the
2496 +RTS ... -RTS options. The reason for adding them was so that the
2497 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2499 getFullProgArgv(int *argc, char **argv[])
2501 if (argc) { *argc = full_prog_argc; }
2502 if (argv) { *argv = full_prog_argv; }
2506 setFullProgArgv(int argc, char *argv[])
2509 full_prog_argc = argc;
2510 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2511 "setFullProgArgv 1");
2512 for (i = 0; i < argc; i++) {
2513 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2514 "setFullProgArgv 2");
2515 strcpy(full_prog_argv[i], argv[i]);
2517 full_prog_argv[argc] = NULL;