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.eventlog = rtsFalse;
180 RtsFlags.DebugFlags.gran = rtsFalse;
181 RtsFlags.DebugFlags.par = rtsFalse;
182 RtsFlags.DebugFlags.apply = rtsFalse;
183 RtsFlags.DebugFlags.linker = rtsFalse;
184 RtsFlags.DebugFlags.squeeze = rtsFalse;
185 RtsFlags.DebugFlags.hpc = rtsFalse;
186 RtsFlags.DebugFlags.timestamp = rtsFalse;
189 #if defined(PROFILING) || defined(PAR)
190 RtsFlags.CcFlags.doCostCentres = 0;
191 #endif /* PROFILING or PAR */
193 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
194 RtsFlags.ProfFlags.profileInterval = 100;
197 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
198 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
199 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
200 RtsFlags.ProfFlags.ccsLength = 25;
201 RtsFlags.ProfFlags.modSelector = NULL;
202 RtsFlags.ProfFlags.descrSelector = NULL;
203 RtsFlags.ProfFlags.typeSelector = NULL;
204 RtsFlags.ProfFlags.ccSelector = NULL;
205 RtsFlags.ProfFlags.ccsSelector = NULL;
206 RtsFlags.ProfFlags.retainerSelector = NULL;
207 RtsFlags.ProfFlags.bioSelector = NULL;
211 RtsFlags.EventLogFlags.doEventLogging = rtsFalse;
214 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
215 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
217 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
218 RtsFlags.MiscFlags.machineReadable = rtsFalse;
219 RtsFlags.MiscFlags.linkerMemBase = 0;
222 RtsFlags.ParFlags.nNodes = 1;
223 RtsFlags.ParFlags.migrate = rtsTrue;
224 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
225 RtsFlags.ParFlags.parGcEnabled = 1;
226 RtsFlags.ParFlags.parGcGen = 1;
227 RtsFlags.ParFlags.parGcLoadBalancing = 1;
228 RtsFlags.ParFlags.setAffinity = 0;
232 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
233 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
234 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
235 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
236 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
237 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
238 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
240 RtsFlags.ParFlags.outputDisabled = rtsFalse;
242 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
244 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
246 RtsFlags.ParFlags.packBufferSize = 1024;
247 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
248 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
249 RtsFlags.ParFlags.maxThreads = 1024;
250 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
251 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
254 #if defined(PAR) || defined(THREADED_RTS)
255 RtsFlags.ParFlags.maxLocalSparks = 4096;
256 #endif /* PAR || THREADED_RTS */
259 /* ToDo: check defaults for GranSim and GUM */
260 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
261 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
263 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
264 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
265 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
266 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
267 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
268 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
269 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
270 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
272 RtsFlags.GranFlags.packBufferSize = 1024;
273 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
275 RtsFlags.GranFlags.proc = MAX_PROC;
276 RtsFlags.GranFlags.Fishing = rtsFalse;
277 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
278 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
279 RtsFlags.GranFlags.Light = rtsFalse;
281 RtsFlags.GranFlags.Costs.latency = LATENCY;
282 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
283 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
284 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
285 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
286 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
287 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
288 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
290 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
291 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
292 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
293 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
294 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
296 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
297 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
298 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
299 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
300 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
302 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
304 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
305 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
307 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
308 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
309 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
310 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
311 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
312 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
313 RtsFlags.GranFlags.FetchStrategy = 2;
314 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
315 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
316 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
317 RtsFlags.GranFlags.SparkPriority = 0;
318 RtsFlags.GranFlags.SparkPriority2 = 0;
319 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
320 RtsFlags.GranFlags.InversePriorities = rtsFalse;
321 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
322 RtsFlags.GranFlags.ThunksToPack = 0;
323 RtsFlags.GranFlags.RandomSteal = rtsTrue;
327 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
328 RtsFlags.TickyFlags.tickyFile = NULL;
332 /* By default no special measurements taken */
333 RtsFlags.PapiFlags.eventType = 0;
334 RtsFlags.PapiFlags.numUserEvents = 0;
341 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
343 " +RTS Indicates run time system options follow",
344 " -RTS Indicates program arguments follow",
345 " --RTS Indicates that ALL subsequent arguments will be given to the",
346 " program (including any of these RTS flags)",
348 "The following run time system options are available:",
350 " -? Prints this message and exits; the program is not executed",
351 " --info Print information about the RTS used by this program",
353 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
354 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
356 " -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
357 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
358 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
359 " -m<n> Minimum % of heap which must be available (default 3%)",
360 " -G<n> Number of generations (default: 2)",
361 " -T<n> Number of steps in younger generations (default: 2)",
362 " -c<n> Auto-enable compaction of the oldest generation when live data is",
363 " at least <n>% of the maximum heap size set with -M (default: 30%)",
364 " -c Enable compaction for all major collections",
365 " -w Use mark-region for the oldest generation (experimental)",
366 #if defined(THREADED_RTS)
367 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
370 " -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
371 " -s[<file>] Summary GC statistics (if <file> omitted, uses stderr)",
372 " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
373 #ifdef RTS_GTK_FRONTPANEL
374 " -f Display front panel (requires X11 & GTK+)",
378 " -Z Don't squeeze out update frames on stack overflow",
379 " -B Sound the bell at the start of each garbage collection",
380 #if defined(PROFILING) || defined(PAR)
382 " -px Time/allocation profile (XML) (output file <program>.prof)",
383 " -p Time/allocation profile (output file <program>.prof)",
384 " -P More detailed Time/Allocation profile",
385 " -Pa Give information about *all* cost centres",
387 # if defined(PROFILING)
389 " -hx Heap residency profile (XML) (output file <program>.prof)",
390 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
391 " break-down: c = cost centre stack (default)",
393 " d = closure description",
394 " y = type description",
396 " b = biography (LAG,DRAG,VOID,USE)",
397 " A subset of closures may be selected thusly:",
398 " -hc<cc>,... specific cost centre(s) (top of stack only)",
399 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
400 " -hm<mod>... all cost centres from the specified modules(s)",
401 " -hd<des>,... closures with specified closure descriptions",
402 " -hy<typ>... closures with specified type descriptions",
403 " -hr<cc>... closures with specified retainers",
404 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
406 " -R<size> Set the maximum retainer set size (default: 8)",
408 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
411 " -xt Include threads (TSOs) in a heap profile",
413 " -xc Show current cost centre stack on raising an exception",
416 #endif /* PROFILING or PAR */
420 " -l Log runtime events (generates binary trace file <program>.eventlog)",
424 #if !defined(PROFILING)
426 " -hT Heap residency profile (output file <program>.hp)",
428 " -i<sec> Time between heap samples (seconds, default: 0.1)",
430 #if defined(TICKY_TICKY)
431 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
435 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
436 /* NB: the -N<n> is implemented by the driver!! */
438 " -C<secs> Context-switch interval in seconds.",
439 " 0 or no argument means switch as often as possible.",
440 " Default: 0.02 sec; resolution is set by -V below.",
441 " -V<secs> Master tick interval in seconds (0 == disable timer).",
442 " This sets the resolution for -C and the profile timer -i.",
443 " Default: 0.02 sec.",
445 " -vt Time-stamp debug messages",
448 " -Ds DEBUG: scheduler",
449 " -Di DEBUG: interpreter",
451 " -DG DEBUG: gccafs",
454 " -DS DEBUG: sanity",
455 " -Dt DEBUG: stable",
457 " -De DEBUG: event logging",
461 " -Dl DEBUG: linker",
463 " -Dz DEBUG: stack squezing",
464 " -Dc DEBUG: program coverage",
467 #if defined(THREADED_RTS) && !defined(NOSMP)
468 " -N<n> Use <n> processors (default: 1)",
469 " -N Determine the number of processors to use automatically",
470 " -q1 Use one OS thread for GC (turns off parallel GC)",
471 " -qg<n> Use parallel GC only for generations >= <n> (default: 1)",
472 " -qb Disable load-balancing in the parallel GC",
473 " -qa Use the OS to set thread affinity",
474 " -qm Don't automatically migrate threads between CPUs",
475 " -qw Migrate a thread to the current CPU when it is woken up",
477 " --install-signal-handlers=<yes|no>",
478 " Install signal handlers (default: yes)",
479 #if defined(THREADED_RTS) || defined(PAR)
480 " -e<size> Size of spark pools (default 100)",
483 " -t<num> Set maximum number of advisory threads per PE (default 32)",
484 " -qP Enable activity profile (output files in ~/<program>*.gr)",
485 " -qQ<size> Set pack-buffer size (default: 1024)",
486 " -qd Turn on PVM-ish debugging",
487 " -qO Disable output for performance measurement",
489 #if defined(THREADED_RTS) || defined(PAR)
490 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
493 " -d Turn on PVM-ish debugging",
494 " -O Disable output for performance measurement",
496 #if defined(GRAN) /* ToDo: fill in decent Docu here */
497 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
499 #if defined(x86_64_HOST_ARCH)
500 " -xm Base address to mmap memory in the GHCi linker",
501 " (hex; must be <80000000)",
503 #if defined(USE_PAPI)
504 " -aX CPU performance counter measurements using PAPI",
505 " (use with the -s<file> option). X is one of:",
508 " 1 - level 1 cache misses",
509 " 2 - level 2 cache misses",
510 " b - branch mispredictions",
511 " s - stalled cycles",
512 " e - cache miss and branch misprediction events",
515 "RTS options may also be specified using the GHCRTS environment variable.",
517 "Other RTS options may be available for programs compiled a different way.",
518 "The GHC User's Guide has full details.",
523 STATIC_INLINE rtsBool
524 strequal(const char *a, const char * b)
526 return(strcmp(a, b) == 0);
530 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
536 while (isspace(*c1)) { c1++; };
538 while (!isspace(*c2) && *c2 != '\0') { c2++; };
540 if (c1 == c2) { break; }
542 if (*rts_argc < MAX_RTS_ARGS-1) {
543 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
544 strncpy(s, c1, c2-c1);
546 rts_argv[(*rts_argc)++] = s;
548 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
552 } while (*c1 != '\0');
556 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
558 rtsBool error = rtsFalse;
569 // process arguments from the ghc_rts_opts global variable first.
570 // (arguments from the GHCRTS environment variable and the command
571 // line override these).
573 if (ghc_rts_opts != NULL) {
574 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
578 // process arguments from the GHCRTS environment variable next
579 // (arguments from the command line override these).
581 char *ghc_rts = getenv("GHCRTS");
583 if (ghc_rts != NULL) {
584 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
588 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
589 // argv[0] must be PGM argument -- leave in argv
591 for (mode = PGM; arg < total_arg; arg++) {
592 // The '--RTS' argument disables all future +RTS ... -RTS processing.
593 if (strequal("--RTS", argv[arg])) {
597 // The '--' argument is passed through to the program, but
598 // disables all further +RTS ... -RTS processing.
599 else if (strequal("--", argv[arg])) {
602 else if (strequal("+RTS", argv[arg])) {
605 else if (strequal("-RTS", argv[arg])) {
608 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
609 rts_argv[(*rts_argc)++] = argv[arg];
611 else if (mode == PGM) {
612 argv[(*argc)++] = argv[arg];
615 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
618 // process remaining program arguments
619 for (; arg < total_arg; arg++) {
620 argv[(*argc)++] = argv[arg];
622 argv[*argc] = (char *) 0;
623 rts_argv[*rts_argc] = (char *) 0;
625 // Process RTS (rts_argv) part: mainly to determine statsfile
626 for (arg = 0; arg < *rts_argc; arg++) {
627 if (rts_argv[arg][0] != '-') {
629 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
633 switch(rts_argv[arg][1]) {
635 /* process: general args, then PROFILING-only ones,
636 then CONCURRENT-only, PARallel-only, GRAN-only,
637 TICKY-only (same order as defined in RtsFlags.lh);
638 within those groups, mostly in case-insensitive
640 Final group is x*, which allows for more options.
644 # define TICKY_BUILD_ONLY(x) x
646 # define TICKY_BUILD_ONLY(x) \
647 errorBelch("not built for: ticky-ticky stats"); \
651 #if defined(PROFILING)
652 # define COST_CENTRE_USING_BUILD_ONLY(x) x
654 # define COST_CENTRE_USING_BUILD_ONLY(x) \
655 errorBelch("not built for: -prof or -parallel"); \
660 # define PROFILING_BUILD_ONLY(x) x
662 # define PROFILING_BUILD_ONLY(x) \
663 errorBelch("not built for: -prof"); \
668 # define EVENTLOG_BUILD_ONLY(x) x
670 # define EVENTLOG_BUILD_ONLY(x) \
671 errorBelch("not built for: -par-prof"); \
676 # define PAR_BUILD_ONLY(x) x
678 # define PAR_BUILD_ONLY(x) \
679 errorBelch("not built for: -parallel"); \
684 # define THREADED_BUILD_ONLY(x) x
686 # define THREADED_BUILD_ONLY(x) \
687 errorBelch("not built for: -smp"); \
691 #if defined(THREADED_RTS) || defined(PAR)
692 # define PAR_OR_THREADED_BUILD_ONLY(x) x
694 # define PAR_OR_THREADED_BUILD_ONLY(x) \
695 errorBelch("not built for: -parallel or -smp"); \
700 # define GRAN_BUILD_ONLY(x) x
702 # define GRAN_BUILD_ONLY(x) \
703 errorBelch("not built for: -gransim"); \
707 /* =========== GENERAL ========================== */
712 /* This isn't going to allow us to keep related options
713 together as we add more --* flags. We really need a
714 proper options parser. */
716 if (strequal("install-signal-handlers=yes",
717 &rts_argv[arg][2])) {
718 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
720 else if (strequal("install-signal-handlers=no",
721 &rts_argv[arg][2])) {
722 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
724 else if (strequal("machine-readable",
725 &rts_argv[arg][2])) {
726 RtsFlags.MiscFlags.machineReadable = rtsTrue;
728 else if (strequal("info",
729 &rts_argv[arg][2])) {
734 errorBelch("unknown RTS option: %s",rts_argv[arg]);
739 RtsFlags.GcFlags.minAllocAreaSize
740 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
741 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
742 bad_option(rts_argv[arg]);
748 switch(rts_argv[arg][2]) {
750 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
753 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
756 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
759 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
762 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
765 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
766 errorBelch("maximum number of PAPI events reached");
767 stg_exit(EXIT_FAILURE);
769 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
770 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
773 bad_option( rts_argv[arg] );
779 RtsFlags.GcFlags.ringBell = rtsTrue;
783 if (rts_argv[arg][2] != '\0') {
784 RtsFlags.GcFlags.compactThreshold =
785 atof(rts_argv[arg]+2);
787 RtsFlags.GcFlags.compact = rtsTrue;
792 RtsFlags.GcFlags.sweep = rtsTrue;
796 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
798 if (RtsFlags.GcFlags.oldGenFactor < 0)
799 bad_option( rts_argv[arg] );
807 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
810 RtsFlags.DebugFlags.scheduler = rtsTrue;
813 RtsFlags.DebugFlags.interpreter = rtsTrue;
816 RtsFlags.DebugFlags.weak = rtsTrue;
819 RtsFlags.DebugFlags.gccafs = rtsTrue;
822 RtsFlags.DebugFlags.gc = rtsTrue;
825 RtsFlags.DebugFlags.block_alloc = rtsTrue;
828 RtsFlags.DebugFlags.sanity = rtsTrue;
831 RtsFlags.DebugFlags.stable = rtsTrue;
834 RtsFlags.DebugFlags.prof = rtsTrue;
837 RtsFlags.DebugFlags.eventlog = rtsTrue;
840 RtsFlags.DebugFlags.gran = rtsTrue;
843 RtsFlags.DebugFlags.par = rtsTrue;
846 RtsFlags.DebugFlags.linker = rtsTrue;
849 RtsFlags.DebugFlags.apply = rtsTrue;
852 RtsFlags.DebugFlags.stm = rtsTrue;
855 RtsFlags.DebugFlags.squeeze = rtsTrue;
858 RtsFlags.DebugFlags.hpc = rtsTrue;
861 bad_option( rts_argv[arg] );
869 RtsFlags.GcFlags.maxStkSize =
870 decode(rts_argv[arg]+2) / sizeof(W_);
872 if (RtsFlags.GcFlags.maxStkSize == 0)
873 bad_option( rts_argv[arg] );
877 RtsFlags.GcFlags.initialStkSize =
878 decode(rts_argv[arg]+2) / sizeof(W_);
880 if (RtsFlags.GcFlags.initialStkSize == 0)
881 bad_option( rts_argv[arg] );
885 RtsFlags.GcFlags.maxHeapSize =
886 decode(rts_argv[arg]+2) / BLOCK_SIZE;
887 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
889 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
890 bad_option(rts_argv[arg]);
895 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
897 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
898 RtsFlags.GcFlags.pcFreeHeap > 100)
899 bad_option( rts_argv[arg] );
903 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
904 if (RtsFlags.GcFlags.generations < 1) {
905 bad_option(rts_argv[arg]);
910 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
911 if (RtsFlags.GcFlags.steps < 1) {
912 bad_option(rts_argv[arg]);
917 RtsFlags.GcFlags.heapSizeSuggestion =
918 decode(rts_argv[arg]+2) / BLOCK_SIZE;
921 #ifdef RTS_GTK_FRONTPANEL
923 RtsFlags.GcFlags.frontpanel = rtsTrue;
927 case 'I': /* idle GC delay */
928 if (rts_argv[arg][2] == '\0') {
933 /* Convert to millisecs */
934 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
935 RtsFlags.GcFlags.idleGCDelayTime = cst;
940 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
944 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
948 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
953 /* Opening all those files would almost certainly fail... */
954 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
955 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
959 r = open_stats_file(arg, *argc, argv,
960 *rts_argc, rts_argv, NULL,
961 &RtsFlags.GcFlags.statsFile);
962 if (r == -1) { error = rtsTrue; }
968 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
971 /* =========== PROFILING ========================== */
975 RtsFlags.EventLogFlags.doEventLogging = rtsTrue;
977 errorBelch("not built for: -eventlog");
981 case 'P': /* detailed cost centre profiling (time/alloc) */
982 case 'p': /* cost centre profiling (time/alloc) */
983 COST_CENTRE_USING_BUILD_ONLY(
984 switch (rts_argv[arg][2]) {
986 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
989 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
992 if (rts_argv[arg][1] == 'P') {
993 RtsFlags.CcFlags.doCostCentres =
994 COST_CENTRES_VERBOSE;
996 RtsFlags.CcFlags.doCostCentres =
997 COST_CENTRES_SUMMARY;
1004 PROFILING_BUILD_ONLY(
1005 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
1008 PROFILING_BUILD_ONLY(
1009 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
1010 if(RtsFlags.ProfFlags.ccsLength <= 0) {
1011 bad_option(rts_argv[arg]);
1014 case 'h': /* serial heap profile */
1015 #if !defined(PROFILING)
1016 switch (rts_argv[arg][2]) {
1019 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
1022 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1026 PROFILING_BUILD_ONLY(
1027 switch (rts_argv[arg][2]) {
1041 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
1043 char *left = strchr(rts_argv[arg], '{');
1044 char *right = strrchr(rts_argv[arg], '}');
1046 // curly braces are optional, for
1047 // backwards compat.
1051 left = rts_argv[arg] + 3;
1054 right = rts_argv[arg] + strlen(rts_argv[arg]);
1058 switch (rts_argv[arg][2]) {
1059 case 'c': // cost centre label select
1060 RtsFlags.ProfFlags.ccSelector = left;
1063 RtsFlags.ProfFlags.ccsSelector = left;
1066 case 'm': // cost centre module select
1067 RtsFlags.ProfFlags.modSelector = left;
1070 case 'd': // closure descr select
1071 RtsFlags.ProfFlags.descrSelector = left;
1074 case 'y': // closure type select
1075 RtsFlags.ProfFlags.typeSelector = left;
1078 case 'r': // retainer select
1079 RtsFlags.ProfFlags.retainerSelector = left;
1082 case 'b': // biography select
1083 RtsFlags.ProfFlags.bioSelector = left;
1090 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1091 errorBelch("multiple heap profile options");
1096 switch (rts_argv[arg][2]) {
1100 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1104 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1108 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1112 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1116 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1120 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1126 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1130 #endif /* PROFILING */
1133 case 'i': /* heap sample interval */
1134 if (rts_argv[arg][2] == '\0') {
1139 /* Convert to milliseconds */
1140 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1141 RtsFlags.ProfFlags.profileInterval = cst;
1145 /* =========== CONCURRENT ========================= */
1146 case 'C': /* context switch interval */
1147 if (rts_argv[arg][2] == '\0')
1148 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1152 /* Convert to milliseconds */
1153 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1154 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1158 case 'V': /* master tick interval */
1159 if (rts_argv[arg][2] == '\0') {
1160 // turns off ticks completely
1161 RtsFlags.MiscFlags.tickInterval = 0;
1165 /* Convert to milliseconds */
1166 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1167 RtsFlags.MiscFlags.tickInterval = cst;
1171 #if defined(THREADED_RTS) && !defined(NOSMP)
1173 THREADED_BUILD_ONLY(
1174 if (rts_argv[arg][2] == '\0') {
1175 #if defined(PROFILING)
1176 RtsFlags.ParFlags.nNodes = 1;
1178 RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1181 RtsFlags.ParFlags.nNodes
1182 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1183 if (RtsFlags.ParFlags.nNodes <= 0) {
1184 errorBelch("bad value for -N");
1187 #if defined(PROFILING)
1188 if (RtsFlags.ParFlags.nNodes > 1) {
1189 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1197 THREADED_BUILD_ONLY(
1198 switch (rts_argv[arg][2]) {
1200 // backwards compat only
1201 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1204 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1211 switch (rts_argv[arg][2]) {
1213 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1217 RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1220 if (rts_argv[arg][3] != '\0') {
1221 RtsFlags.ParFlags.parGcGen
1222 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1224 errorBelch("bad value for -qg");
1229 RtsFlags.ParFlags.parGcLoadBalancing = rtsFalse;
1232 RtsFlags.ParFlags.setAffinity = rtsTrue;
1235 RtsFlags.ParFlags.migrate = rtsFalse;
1238 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1241 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1247 /* =========== PARALLEL =========================== */
1249 PAR_OR_THREADED_BUILD_ONLY(
1250 if (rts_argv[arg][2] != '\0') {
1251 RtsFlags.ParFlags.maxLocalSparks
1252 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1253 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1254 errorBelch("bad value for -e");
1263 process_par_option(arg, rts_argc, rts_argv, &error);
1267 /* =========== GRAN =============================== */
1271 process_gran_option(arg, rts_argc, rts_argv, &error);
1274 /* =========== TICKY ============================== */
1276 case 'r': /* Basic profiling stats */
1279 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1283 r = open_stats_file(arg, *argc, argv,
1284 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1285 &RtsFlags.TickyFlags.tickyFile);
1286 if (r == -1) { error = rtsTrue; }
1290 /* =========== TRACING ---------=================== */
1293 switch(rts_argv[arg][2]) {
1295 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1299 RtsFlags.DebugFlags.timestamp = rtsTrue;
1303 // ignored for backwards-compat
1306 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1312 /* =========== EXTENDED OPTIONS =================== */
1314 case 'x': /* Extend the argument space */
1315 switch(rts_argv[arg][2]) {
1317 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1321 case 'b': /* heapBase in hex; undocumented */
1322 if (rts_argv[arg][3] != '\0') {
1323 RtsFlags.GcFlags.heapBase
1324 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1326 errorBelch("-xb: requires argument");
1331 #if defined(x86_64_HOST_ARCH)
1332 case 'm': /* linkerMemBase */
1333 if (rts_argv[arg][3] != '\0') {
1334 RtsFlags.MiscFlags.linkerMemBase
1335 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1336 if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1337 errorBelch("-xm: value must be <80000000");
1341 RtsFlags.MiscFlags.linkerMemBase = 0;
1346 case 'c': /* Debugging tool: show current cost centre on an exception */
1347 PROFILING_BUILD_ONLY(
1348 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1352 case 't': /* Include memory used by TSOs in a heap profile */
1353 PROFILING_BUILD_ONLY(
1354 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1358 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1361 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1365 break; /* defensive programming */
1367 /* =========== OH DEAR ============================ */
1369 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1376 if (RtsFlags.MiscFlags.tickInterval < 0) {
1377 RtsFlags.MiscFlags.tickInterval = 50;
1380 // If the master timer is disabled, turn off the other timers.
1381 if (RtsFlags.MiscFlags.tickInterval == 0) {
1382 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1383 RtsFlags.GcFlags.idleGCDelayTime = 0;
1384 RtsFlags.ProfFlags.profileInterval = 0;
1387 // Determine what tick interval we should use for the RTS timer
1388 // by taking the shortest of the various intervals that we need to
1390 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1391 RtsFlags.MiscFlags.tickInterval =
1392 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1393 RtsFlags.MiscFlags.tickInterval);
1396 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1397 RtsFlags.MiscFlags.tickInterval =
1398 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1399 RtsFlags.MiscFlags.tickInterval);
1402 if (RtsFlags.ProfFlags.profileInterval > 0) {
1403 RtsFlags.MiscFlags.tickInterval =
1404 stg_min(RtsFlags.ProfFlags.profileInterval,
1405 RtsFlags.MiscFlags.tickInterval);
1408 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1409 RtsFlags.ConcFlags.ctxtSwitchTicks =
1410 RtsFlags.ConcFlags.ctxtSwitchTime /
1411 RtsFlags.MiscFlags.tickInterval;
1413 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1416 if (RtsFlags.ProfFlags.profileInterval > 0) {
1417 RtsFlags.ProfFlags.profileIntervalTicks =
1418 RtsFlags.ProfFlags.profileInterval /
1419 RtsFlags.MiscFlags.tickInterval;
1421 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1428 for (p = usage_text; *p; p++)
1429 errorBelch("%s", *p);
1430 stg_exit(EXIT_FAILURE);
1437 enable_GranSimLight(void) {
1439 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1440 RtsFlags.GranFlags.Light=rtsTrue;
1441 RtsFlags.GranFlags.Costs.latency =
1442 RtsFlags.GranFlags.Costs.fetchtime =
1443 RtsFlags.GranFlags.Costs.additional_latency =
1444 RtsFlags.GranFlags.Costs.gunblocktime =
1445 RtsFlags.GranFlags.Costs.lunblocktime =
1446 RtsFlags.GranFlags.Costs.threadcreatetime =
1447 RtsFlags.GranFlags.Costs.threadqueuetime =
1448 RtsFlags.GranFlags.Costs.threadscheduletime =
1449 RtsFlags.GranFlags.Costs.threaddescheduletime =
1450 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1452 RtsFlags.GranFlags.Costs.mpacktime =
1453 RtsFlags.GranFlags.Costs.munpacktime = 0;
1455 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1456 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1457 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1458 /* FetchStrategy is irrelevant in GrAnSim-Light */
1460 /* GrAnSim Light often creates an abundance of parallel threads,
1461 each with its own stack etc. Therefore, it's in general a good
1462 idea to use small stack chunks (use the -o<size> option to
1465 // RtsFlags.ConcFlags.stkChunkSize = 100;
1467 RtsFlags.GranFlags.proc = 1;
1471 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1473 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1476 /* or a ridiculously idealised simulator */
1477 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1478 RtsFlags.GranFlags.Costs.latency =
1479 RtsFlags.GranFlags.Costs.fetchtime =
1480 RtsFlags.GranFlags.Costs.additional_latency =
1481 RtsFlags.GranFlags.Costs.gunblocktime =
1482 RtsFlags.GranFlags.Costs.lunblocktime =
1483 RtsFlags.GranFlags.Costs.threadcreatetime =
1484 RtsFlags.GranFlags.Costs.threadqueuetime =
1485 RtsFlags.GranFlags.Costs.threadscheduletime =
1486 RtsFlags.GranFlags.Costs.threaddescheduletime =
1487 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1489 RtsFlags.GranFlags.Costs.mpacktime =
1490 RtsFlags.GranFlags.Costs.munpacktime = 0;
1492 RtsFlags.GranFlags.Costs.arith_cost =
1493 RtsFlags.GranFlags.Costs.float_cost =
1494 RtsFlags.GranFlags.Costs.load_cost =
1495 RtsFlags.GranFlags.Costs.store_cost =
1496 RtsFlags.GranFlags.Costs.branch_cost = 0;
1498 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1500 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1501 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1502 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1503 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1507 /* or a somewhat idealised simulator */
1508 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1509 RtsFlags.GranFlags.Costs.latency =
1510 RtsFlags.GranFlags.Costs.fetchtime =
1511 RtsFlags.GranFlags.Costs.additional_latency =
1512 RtsFlags.GranFlags.Costs.gunblocktime =
1513 RtsFlags.GranFlags.Costs.lunblocktime =
1514 RtsFlags.GranFlags.Costs.threadcreatetime =
1515 RtsFlags.GranFlags.Costs.threadqueuetime =
1516 RtsFlags.GranFlags.Costs.threadscheduletime =
1517 RtsFlags.GranFlags.Costs.threaddescheduletime =
1518 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1520 RtsFlags.GranFlags.Costs.mpacktime =
1521 RtsFlags.GranFlags.Costs.munpacktime = 0;
1523 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1525 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1526 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1527 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1528 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1529 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1530 # if defined(GRAN_CHECK) && defined(GRAN)
1531 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1536 /* Communication and task creation cost parameters */
1537 switch(rts_argv[arg][2]) {
1539 IgnoreYields = rtsTrue; // HWL HACK
1543 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1547 if (rts_argv[arg][3] != '\0')
1549 RtsFlags.GranFlags.Costs.gunblocktime =
1550 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1551 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1554 RtsFlags.GranFlags.Costs.latency = LATENCY;
1558 if (rts_argv[arg][3] != '\0')
1559 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1561 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1565 if (rts_argv[arg][3] != '\0')
1566 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1568 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1572 if (rts_argv[arg][3] != '\0')
1573 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1575 RtsFlags.GranFlags.Costs.mtidytime = 0;
1579 if (rts_argv[arg][3] != '\0')
1580 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1582 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1586 if (rts_argv[arg][3] != '\0')
1587 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1589 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1593 if (rts_argv[arg][3] != '\0')
1594 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1596 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1600 if (rts_argv[arg][3] != '\0')
1601 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1603 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1606 /* Thread-related metrics */
1608 if (rts_argv[arg][3] != '\0')
1609 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1611 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1615 if (rts_argv[arg][3] != '\0')
1616 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1618 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1622 if (rts_argv[arg][3] != '\0')
1623 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1625 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1627 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1628 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1632 if (rts_argv[arg][3] != '\0')
1633 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1635 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1637 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1638 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1641 /* Instruction Cost Metrics */
1643 if (rts_argv[arg][3] != '\0')
1644 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1646 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1650 if (rts_argv[arg][3] != '\0')
1651 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1653 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1657 if (rts_argv[arg][3] != '\0')
1658 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1660 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1664 if (rts_argv[arg][3] != '\0')
1665 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1667 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1671 if (rts_argv[arg][3] != '\0')
1672 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1674 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1678 if (rts_argv[arg][3] != '\0')
1679 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1681 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1685 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1686 if (rts_argv[arg][3] != '\0')
1687 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1689 RtsFlags.GranFlags.FetchStrategy = 2;
1690 if (RtsFlags.GranFlags.FetchStrategy == 0)
1691 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1694 case 'K': /* sort overhead (per elem in spark list) */
1695 if (rts_argv[arg][3] != '\0')
1696 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1698 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1699 debugBelch("Overhead for pri spark: %d (per elem).\n",
1700 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1703 case 'O': /* sort overhead (per elem in spark list) */
1704 if (rts_argv[arg][3] != '\0')
1705 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1707 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1708 debugBelch("Overhead for pri sched: %d (per elem).\n",
1709 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1712 /* General Parameters */
1714 if (rts_argv[arg][3] != '\0')
1716 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1717 if (RtsFlags.GranFlags.proc==0) {
1718 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1719 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1720 RtsFlags.GranFlags.proc < 1)
1722 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1728 RtsFlags.GranFlags.proc = MAX_PROC;
1732 RtsFlags.GranFlags.Fishing = rtsTrue;
1733 if (rts_argv[arg][3] != '\0')
1734 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1736 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1740 if (rts_argv[arg][3] != '\0')
1741 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1743 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1747 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1748 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1752 debugBelch("Bulk fetching enabled.\n");
1753 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1757 debugBelch("Thread migration enabled.\n");
1758 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1762 debugBelch("Fair Scheduling enabled.\n");
1763 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1767 debugBelch("Priority Scheduling enabled.\n");
1768 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1772 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1773 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1777 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1781 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1785 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1789 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1793 /* format is -bP<c> where <c> is one char describing kind of profile */
1794 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1795 switch(rts_argv[arg][3]) {
1796 case '\0': break; // nothing special, just an ordinary profile
1797 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1799 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1801 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1803 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1805 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1807 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1809 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1814 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1818 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1821 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1822 if (rts_argv[arg][3] != '\0') {
1825 arg0 = rts_argv[arg]+3;
1826 if ((tmp = strstr(arg0,","))==NULL) {
1827 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1828 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1831 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1832 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1833 debugBelch("SparkPriority: %u.\n",
1834 RtsFlags.GranFlags.SparkPriority);
1835 debugBelch("SparkPriority2:%u.\n",
1836 RtsFlags.GranFlags.SparkPriority2);
1837 if (RtsFlags.GranFlags.SparkPriority2 <
1838 RtsFlags.GranFlags.SparkPriority) {
1839 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1840 RtsFlags.GranFlags.SparkPriority2,
1841 RtsFlags.GranFlags.SparkPriority);
1845 /* plain pri spark is now invoked with -bX
1846 RtsFlags.GranFlags.DoPrioritySparking = 1;
1847 debugBelch("PrioritySparking.\n");
1853 if (rts_argv[arg][3] != '\0') {
1854 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1856 RtsFlags.GranFlags.ThunksToPack = 1;
1858 debugBelch("Thunks To Pack in one packet: %u.\n",
1859 RtsFlags.GranFlags.ThunksToPack);
1863 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1864 debugBelch("Deterministic mode (no random stealing)\n");
1867 /* The following class of options contains eXperimental */
1868 /* features in connection with exploiting granularity */
1869 /* information. I.e. if -bY is chosen these options */
1870 /* tell the RTS what to do with the supplied info --HWL */
1873 if (rts_argv[arg][3] != '\0') {
1874 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1876 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1878 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1879 RtsFlags.GranFlags.packBufferSize_internal);
1883 switch(rts_argv[arg][3]) {
1886 RtsFlags.GranFlags.DoPrioritySparking = 1;
1887 debugBelch("Priority Sparking with Normal Priorities.\n");
1888 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1889 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1890 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1894 RtsFlags.GranFlags.DoPrioritySparking = 1;
1895 debugBelch("Priority Sparking with Inverse Priorities.\n");
1896 RtsFlags.GranFlags.InversePriorities++;
1900 RtsFlags.GranFlags.DoPrioritySparking = 1;
1901 debugBelch("Priority Sparking with Random Priorities.\n");
1902 RtsFlags.GranFlags.RandomPriorities++;
1906 RtsFlags.GranFlags.DoPrioritySparking = 1;
1907 debugBelch("Priority Sparking with No Priorities.\n");
1908 RtsFlags.GranFlags.IgnorePriorities++;
1912 bad_option( rts_argv[arg] );
1918 switch(rts_argv[arg][3]) {
1921 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1922 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1926 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1930 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1934 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1938 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1939 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1943 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1947 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1951 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1955 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1959 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1963 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1967 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1971 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1972 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1976 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1980 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1984 bad_option( rts_argv[arg] );
1989 # if defined(GRAN_CHECK) && defined(GRAN)
1991 switch(rts_argv[arg][3]) {
1992 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1993 if (rts_argv[arg][4] != '\0') {
1994 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1995 debugBelch("Pack buffer size: %d\n",
1996 RtsFlags.GranFlags.packBufferSize);
1998 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
2004 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2005 /* hack warning: interpret the flags as a binary number */
2006 nat n = decode(rts_argv[arg]+3);
2007 set_GranSim_debug_options(n);
2010 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2011 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
2014 if (i==MAX_GRAN_DEBUG_OPTION+1) {
2015 debugBelch("Valid GranSim debug options are:\n");
2016 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2017 bad_option( rts_argv[arg] );
2018 } else { // flag found; now set it
2019 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
2025 case 'e': /* event trace; also -bD1 */
2026 debugBelch("DEBUG: event_trace; printing event trace.\n");
2027 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
2028 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
2031 case 'E': /* event statistics; also -bD2 */
2032 debugBelch("DEBUG: event_stats; printing event statistics.\n");
2033 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
2034 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
2037 case 'f': /* thunkStealing; also -bD4 */
2038 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
2039 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
2040 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
2043 case 'z': /* blockOnFetch; also -bD8 */
2044 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
2045 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
2046 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
2049 case 't': /* blockOnFetch_sanity; also -bD16 */
2050 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
2051 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
2052 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
2055 case 'S': /* priSpark; also -bD32 */
2056 debugBelch("DEBUG: priSpark; priority sparking.\n");
2057 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
2060 case 's': /* priSched; also -bD64 */
2061 debugBelch("DEBUG: priSched; priority scheduling.\n");
2062 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
2065 case 'F': /* findWork; also -bD128 */
2066 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
2067 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
2070 case 'g': /* globalBlock; also -bD256 */
2071 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
2072 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
2075 case 'G': /* pack; also -bD512 */
2076 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
2077 RtsFlags.GranFlags.Debug.pack = rtsTrue;
2080 case 'P': /* packBuffer; also -bD1024 */
2081 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
2082 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
2085 case 'o': /* sortedQ; also -bD2048 */
2086 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
2087 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
2090 case 'r': /* randomSteal; also -bD4096 */
2091 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2092 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2095 case 'q': /* checkSparkQ; also -bD8192 */
2096 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2097 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2100 case ':': /* checkLight; also -bD16384 */
2101 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2102 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2105 case 'b': /* bq; also -bD32768 */
2106 debugBelch("DEBUG: bq; check blocking queues\n");
2107 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2110 case 'd': /* all options turned on */
2111 debugBelch("DEBUG: all options turned on.\n");
2112 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2113 /* RtsFlags.GranFlags.Debug |= 0x40; */
2117 /* RtsFlags.GranFlags.Debug = 1; */
2123 # endif /* GRAN_CHECK */
2125 bad_option( rts_argv[arg] );
2131 Interpret n as a binary number masking GranSim debug options and set the
2132 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2135 set_GranSim_debug_options(nat n) {
2138 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2140 errorBelch(gran_debug_opts_strs[i]);
2142 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2143 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2144 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2145 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2146 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2147 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2148 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2149 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2150 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2151 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2152 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2153 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2154 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2155 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2156 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2157 default: barf("set_GranSim_debug_options: only %d debug options expected");
2163 Print one line explanation for each of the GranSim debug options specified
2167 help_GranSim_debug_options(nat n) {
2170 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2172 debugBelch(gran_debug_opts_strs[i]);
2178 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2181 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2182 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2186 /* Communication and task creation cost parameters */
2187 switch(rts_argv[arg][2]) {
2188 case 'e': /* -qe<n> ... allow <n> local sparks */
2189 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2190 RtsFlags.ParFlags.maxLocalSparks
2191 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2193 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2194 errorBelch("setupRtsFlags: bad value for -e\n");
2198 IF_PAR_DEBUG(verbose,
2199 errorBelch("-qe<n>: max %d local sparks",
2200 RtsFlags.ParFlags.maxLocalSparks));
2204 if (rts_argv[arg][3] != '\0') {
2205 RtsFlags.ParFlags.maxThreads
2206 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2208 errorBelch("missing size for -qt\n");
2211 IF_PAR_DEBUG(verbose,
2212 errorBelch("-qt<n>: max %d threads",
2213 RtsFlags.ParFlags.maxThreads));
2217 if (rts_argv[arg][3] != '\0')
2218 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2220 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2222 IF_PAR_DEBUG(verbose,
2223 errorBelch("-qf<n>: max %d fishes sent out at one time",
2224 RtsFlags.ParFlags.maxFishes));
2228 if (rts_argv[arg][3] != '\0') {
2229 RtsFlags.ParFlags.fishDelay
2230 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2232 errorBelch("missing fish delay time for -qF\n");
2235 IF_PAR_DEBUG(verbose,
2236 errorBelch("-qF<n>: fish delay time %d us",
2237 RtsFlags.ParFlags.fishDelay));
2241 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2242 IF_PAR_DEBUG(verbose,
2243 errorBelch("-qO: output disabled"));
2246 case 'g': /* -qg<n> ... globalisation scheme */
2247 if (rts_argv[arg][3] != '\0') {
2248 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2250 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2253 IF_PAR_DEBUG(verbose,
2254 debugBelch("-qg<n>: globalisation scheme set to %d",
2255 RtsFlags.ParFlags.globalising));
2258 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2259 if (rts_argv[arg][3] != '\0') {
2260 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2262 errorBelch("missing number of thunks per packet (for -qh)\n");
2265 IF_PAR_DEBUG(verbose,
2266 debugBelch("-qh<n>: thunks per packet set to %d",
2267 RtsFlags.ParFlags.thunksToPack));
2270 case 'P': /* -qP for writing a log file */
2271 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2272 /* same encoding as in GranSim after -bP */
2273 switch(rts_argv[arg][3]) {
2274 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2275 break; // nothing special, just an ordinary profile
2276 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2277 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2279 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2281 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2283 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2285 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2288 # if defined(PAR_TICKY)
2289 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2291 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2292 stg_exit(EXIT_FAILURE);
2295 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2297 IF_PAR_DEBUG(verbose,
2298 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2299 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2302 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2303 if (rts_argv[arg][3] != '\0') {
2304 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2306 errorBelch("missing size of PackBuffer (for -qQ)\n");
2309 IF_PAR_DEBUG(verbose,
2310 debugBelch("-qQ<n>: pack buffer size set to %d",
2311 RtsFlags.ParFlags.packBufferSize));
2315 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2316 IF_PAR_DEBUG(verbose,
2317 debugBelch("-qR: fair-ish scheduling"));
2322 if (rts_argv[arg][3] != '\0') {
2323 RtsFlags.ParFlags.wait
2324 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2326 RtsFlags.ParFlags.wait = 1000;
2328 IF_PAR_DEBUG(verbose,
2329 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2330 RtsFlags.ParFlags.wait));
2333 case 'D': /* -qD ... all the debugging options */
2334 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2335 /* hack warning: interpret the flags as a binary number */
2336 nat n = decode(rts_argv[arg]+3);
2337 set_par_debug_options(n);
2340 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2341 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2344 if (i==MAX_PAR_DEBUG_OPTION+1) {
2345 errorBelch("Valid GUM debug options are:\n");
2346 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2347 bad_option( rts_argv[arg] );
2348 } else { // flag found; now set it
2349 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2355 errorBelch("Unknown option -q%c (%d opts in total)",
2356 rts_argv[arg][2], *rts_argc);
2362 Interpret n as a binary number masking Par debug options and set the
2363 correxponding option. See par_debug_opts_strs for explanations of the flags.
2366 set_par_debug_options(nat n) {
2369 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2371 debugBelch(par_debug_opts_strs[i]);
2373 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2374 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2375 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2376 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2377 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2378 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2379 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2380 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2381 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2382 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2383 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2384 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2385 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2386 default: barf("set_par_debug_options: only %d debug options expected",
2387 MAX_PAR_DEBUG_OPTION);
2393 Print one line explanation for each of the GranSim debug options specified
2397 help_par_debug_options(nat n) {
2400 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2402 debugBelch(par_debug_opts_strs[i]);
2408 stats_fprintf(FILE *f, char *s, ...)
2420 static int /* return -1 on error */
2423 int argc, char *argv[],
2424 int rts_argc, char *rts_argv[],
2425 const char *FILENAME_FMT,
2430 if (strequal(rts_argv[arg]+2, "stderr")
2431 || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
2432 f = NULL; /* NULL means use debugBelch */
2434 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2435 f = fopen(rts_argv[arg]+2,"w");
2437 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2438 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2439 f = fopen(stats_filename,"w");
2442 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2449 /* Write argv and rtsv into start of stats file */
2451 for(count = 0; count < argc; count++) {
2452 stats_fprintf(f, "%s ", argv[count]);
2454 stats_fprintf(f, "+RTS ");
2455 for(count = 0; count < rts_argc; count++)
2456 stats_fprintf(f, "%s ", rts_argv[count]);
2457 stats_fprintf(f, "\n");
2465 decode(const char *s)
2476 if (c == 'g' || c == 'G')
2477 m *= 1000*1000*1000; /* UNchecked! */
2478 else if (c == 'm' || c == 'M')
2479 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2480 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2481 m *= 1000; /* a direct-mapped cache. */
2482 else if (c == 'w' || c == 'W')
2489 bad_option(const char *s)
2491 errorBelch("bad RTS option: %s", s);
2492 stg_exit(EXIT_FAILURE);
2495 /* -----------------------------------------------------------------------------
2496 Getting/Setting the program's arguments.
2498 These are used by System.Environment, and parts of the RTS.
2499 -------------------------------------------------------------------------- */
2502 setProgName(char *argv[])
2504 /* Remove directory from argv[0] -- default files in current directory */
2505 #if !defined(mingw32_HOST_OS)
2507 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2508 prog_name = last_slash+1;
2510 prog_name = argv[0];
2513 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2514 while ( last_slash > argv[0] ) {
2515 if ( *last_slash == '/' || *last_slash == '\\' ) {
2516 prog_name = last_slash+1;
2521 prog_name = argv[0];
2526 getProgArgv(int *argc, char **argv[])
2528 if (argc) { *argc = prog_argc; }
2529 if (argv) { *argv = prog_argv; }
2533 setProgArgv(int argc, char *argv[])
2535 /* Usually this is done by startupHaskell, so we don't need to call this.
2536 However, sometimes Hugs wants to change the arguments which Haskell
2537 getArgs >>= ... will be fed. So you can do that by calling here
2538 _after_ calling startupHaskell.
2542 setProgName(prog_argv);
2545 /* These functions record and recall the full arguments, including the
2546 +RTS ... -RTS options. The reason for adding them was so that the
2547 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2549 getFullProgArgv(int *argc, char **argv[])
2551 if (argc) { *argc = full_prog_argc; }
2552 if (argv) { *argv = full_prog_argv; }
2556 setFullProgArgv(int argc, char *argv[])
2559 full_prog_argc = argc;
2560 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2561 "setFullProgArgv 1");
2562 for (i = 0; i < argc; i++) {
2563 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2564 "setFullProgArgv 2");
2565 strcpy(full_prog_argv[i], argv[i]);
2567 full_prog_argv[argc] = NULL;