1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.47 2001/08/10 15:25:49 simonmar Exp $
4 * (c) The AQUA Project, Glasgow University, 1994-1997
5 * (c) The GHC Team, 1998-1999
7 * Functions for parsing the argument list.
9 * ---------------------------------------------------------------------------*/
14 //* Static function decls::
15 //* Command-line option parsing routines::
16 //* GranSim specific options::
21 //@node Includes, Constants
22 //@subsection Includes
27 #include "BlockAlloc.h"
28 #include "Itimer.h" /* CS_MIN_MILLISECS */
29 #include "Profiling.h"
31 #if defined(PROFILING)
39 extern struct RTS_FLAGS RtsFlags;
42 * Split argument lists
44 int prog_argc; /* an "int" so as to match normal "argc" */
45 char **prog_argv = NULL;
46 int rts_argc; /* ditto */
47 char *rts_argv[MAX_RTS_ARGS];
49 //@node Constants, Static function decls, Includes
50 //@subsection Constants
53 * constants, used later
58 char *debug_opts_strs[] = {
59 "DEBUG (-D1): scheduler\n",
60 "DEBUG (-D2): evaluator\n",
61 "DEBUG (-D4): codegen\n",
62 "DEBUG (-D8): weak\n",
63 "DEBUG (-D16): gccafs\n",
65 "DEBUG (-D64): block\n",
66 "DEBUG (-D128): sanity\n",
67 "DEBUG (-D256): stable\n",
68 "DEBUG (-D512): prof\n",
69 "DEBUG (-D1024): gran\n",
70 "DEBUG (-D2048): par\n",
71 "DEBUG (-D4096): linker\n"
74 char *debug_opts_prefix[] = {
92 char *gran_debug_opts_strs[] = {
93 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
94 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
95 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
96 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
97 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
98 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
99 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
100 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
101 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
102 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
103 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
104 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
105 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
106 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
107 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
110 /* one character codes for the available debug options */
111 char gran_debug_opts_flags[] = {
112 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
115 /* prefix strings printed with the debug messages of the corresponding type */
116 char *gran_debug_opts_prefix[] = {
117 "", /* event_trace */
118 "", /* event_stats */
121 "^^", /* checkSparkQ */
122 "==", /* thunkStealing */
123 "^^", /* randomSteal */
127 "::", /* checkLight */
129 "", /* blockOnFetch */
131 "" /* blockOnFetch_sanity */
136 char *par_debug_opts_strs[] = {
137 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
138 "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
139 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
140 "DEBUG (-qDe, -qD8): free; free messages.\n",
141 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
142 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
143 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
144 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
145 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
146 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
147 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
148 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
149 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
150 "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
153 /* one character codes for the available debug options */
154 char par_debug_opts_flags[] = {
155 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
158 /* prefix strings printed with the debug messages of the corresponding type */
159 char *par_debug_opts_prefix[] = {
177 //@node Static function decls, Command-line option parsing routines, Constants
178 //@subsection Static function decls
180 /* -----------------------------------------------------------------------------
181 Static function decls
182 -------------------------------------------------------------------------- */
184 static FILE * /* return NULL on error */
187 int argc, char *argv[],
188 int rts_argc, char *rts_argv[],
189 const char *FILENAME_FMT);
191 static I_ decode(const char *s);
192 static void bad_option(const char *s);
195 static void enable_GranSimLight(void);
196 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
197 static void set_GranSim_debug_options(nat n);
198 static void help_GranSim_debug_options(nat n);
200 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
201 static void set_par_debug_options(nat n);
202 static void help_par_debug_options(nat n);
205 static void set_debug_options(nat n);
206 static void help_debug_options(nat n);
209 //@node Command-line option parsing routines, GranSim specific options, Static function decls
210 //@subsection Command-line option parsing routines
212 /* -----------------------------------------------------------------------------
213 * Command-line option parsing routines.
214 * ---------------------------------------------------------------------------*/
216 void initRtsFlagsDefaults(void)
218 RtsFlags.GcFlags.statsFile = NULL;
219 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
221 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
222 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
224 RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE;
225 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
226 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
227 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
228 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
229 RtsFlags.GcFlags.oldGenFactor = 2;
231 /* A hack currently needed for GUM -- HWL */
232 RtsFlags.GcFlags.generations = 1;
233 RtsFlags.GcFlags.steps = 2;
234 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
236 RtsFlags.GcFlags.generations = 2;
237 RtsFlags.GcFlags.steps = 2;
238 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
240 RtsFlags.GcFlags.compact = rtsFalse;
241 RtsFlags.GcFlags.compactThreshold = 30.0;
242 #ifdef RTS_GTK_FRONTPANEL
243 RtsFlags.GcFlags.frontpanel = rtsFalse;
246 #if defined(PROFILING) || defined(PAR)
247 RtsFlags.CcFlags.doCostCentres = 0;
248 #endif /* PROFILING or PAR */
251 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
252 RtsFlags.ProfFlags.profileFrequency = 20;
253 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
254 RtsFlags.ProfFlags.modSelector = NULL;
255 RtsFlags.ProfFlags.descrSelector = NULL;
256 RtsFlags.ProfFlags.typeSelector = NULL;
257 RtsFlags.ProfFlags.ccSelector = NULL;
259 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
262 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
265 RtsFlags.ParFlags.nNodes = 1;
269 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
270 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
271 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
272 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
273 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
274 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
275 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
277 RtsFlags.ParFlags.outputDisabled = rtsFalse;
279 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
281 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
283 RtsFlags.ParFlags.packBufferSize = 1024;
284 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
285 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
286 RtsFlags.ParFlags.maxThreads = 1024;
287 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
288 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
291 #if defined(PAR) || defined(SMP)
292 RtsFlags.ParFlags.maxLocalSparks = 4096;
293 #endif /* PAR || SMP */
296 /* ToDo: check defaults for GranSim and GUM */
297 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
298 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
300 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
301 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
302 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
303 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
304 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
305 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
306 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
307 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
309 RtsFlags.GranFlags.packBufferSize = 1024;
310 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
312 RtsFlags.GranFlags.proc = MAX_PROC;
313 RtsFlags.GranFlags.Fishing = rtsFalse;
314 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
315 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
316 RtsFlags.GranFlags.Light = rtsFalse;
318 RtsFlags.GranFlags.Costs.latency = LATENCY;
319 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
320 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
321 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
322 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
323 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
324 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
325 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
327 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
328 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
329 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
330 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
331 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
333 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
334 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
335 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
336 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
337 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
339 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
341 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
342 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
344 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
345 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
346 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
347 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
348 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
349 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
350 RtsFlags.GranFlags.FetchStrategy = 2;
351 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
352 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
353 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
354 RtsFlags.GranFlags.SparkPriority = 0;
355 RtsFlags.GranFlags.SparkPriority2 = 0;
356 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
357 RtsFlags.GranFlags.InversePriorities = rtsFalse;
358 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
359 RtsFlags.GranFlags.ThunksToPack = 0;
360 RtsFlags.GranFlags.RandomSteal = rtsTrue;
364 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
365 RtsFlags.TickyFlags.tickyFile = NULL;
372 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
374 " +RTS Indicates run time system options follow",
375 " -RTS Indicates program arguments follow",
376 " --RTS Indicates that ALL subsequent arguments will be given to the",
377 " program (including any of these RTS flags)",
379 "The following run time system options are available:",
381 " -? Prints this message and exits; the program is not executed",
383 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
384 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
386 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
387 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
388 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
389 " -m<n> Minimum % of heap which must be available (default 3%)",
390 " -G<n> Number of generations (default: 2)",
391 " -T<n> Number of steps in younger generations (default: 2)",
392 " -c<n> Auto-enable compaction of the oldest generation when live data is",
393 " at least <n>% of the maximum heap size set with -M (default: 30%)",
394 " -c Enable compaction for all major collections",
396 " -t<file> One-line GC statistics (default file: <program>.stat)",
397 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
398 " -S<file> Detailed GC statistics",
399 #ifdef RTS_GTK_FRONTPANEL
400 " -f Display front panel (requires X11 & GTK+)",
404 " -Z Don't squeeze out update frames on stack overflow",
405 " -B Sound the bell at the start of each garbage collection",
406 #if defined(PROFILING) || defined(PAR)
408 " -px Time/allocation profile (XML) (output file <program>.prof)",
409 " -p Time/allocation profile (output file <program>.prof)",
410 " -P More detailed Time/Allocation profile",
411 " -Pa Give information about *all* cost centres",
413 # if defined(PROFILING)
415 " -hx Heap residency profile (XML) (output file <program>.prof)",
416 " -h<break-down> Heap residency profile (text) (output file <program>.prof)",
417 " break-down: C = cost centre stack (default), M = module",
418 " D = closure description, Y = type description",
419 " A subset of closures may be selected thusly:",
420 " -hc{cc, cc ...} specific cost centre(s) (NOT STACKS!)",
421 " -hm{mod,mod...} all cost centres from the specified modules(s)",
422 " -hd{des,des...} closures with specified closure descriptions",
423 " -hy{typ,typ...} closures with specified type descriptions",
425 " -i<msec> Time between heap samples (msec, default: 20)",
427 " -xc Show current cost centre stack on raising an exception",
429 #endif /* PROFILING or PAR */
430 #if !defined(PROFILING) && defined(DEBUG)
432 " -h<break-down> Debugging Heap residency profile",
433 " (output file <program>.hp)",
434 " break-down: L = closure label (default)",
435 " T = closure type (constructor, thunk etc.)",
438 #if defined(TICKY_TICKY)
439 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
443 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
444 /* NB: the -N<n> is implemented by the driver!! */
446 " -C<secs> Context-switch interval in seconds",
447 " (0 or no argument means switch as often as possible)",
448 " the default is .02 sec; resolution is .02 sec",
450 " -N<n> Use <n> OS threads (default: 1)",
452 #if defined(SMP) || defined(PAR)
453 " -e<size> Size of spark pools (default 100)",
456 " -t<num> Set maximum number of advisory threads per PE (default 32)",
457 " -qP Enable activity profile (output files in ~/<program>*.gr)",
458 " -qQ<size> Set pack-buffer size (default: 1024)",
459 " -qd Turn on PVM-ish debugging",
460 " -qO Disable output for performance measurement",
462 #if defined(SMP) || defined(PAR)
463 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
466 " -d Turn on PVM-ish debugging",
467 " -O Disable output for performance measurement",
469 #if defined(GRAN) /* ToDo: fill in decent Docu here */
470 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
473 "RTS options may also be specified using the GHCRTS environment variable.",
475 "Other RTS options may be available for programs compiled a different way.",
476 "The GHC User's Guide has full details.",
481 static __inline__ rtsBool
482 strequal(const char *a, const char * b)
484 return(strcmp(a, b) == 0);
488 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
490 rtsBool error = rtsFalse;
495 /* Remove directory from argv[0] -- default files in current directory */
497 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
498 strcpy(argv[0], last_slash+1);
506 // process arguments from the GHCRTS environment variable first
507 // (arguments from the command line override these).
509 char *ghc_rts = getenv("GHCRTS");
512 if (ghc_rts != NULL) {
515 while (isspace(*c1)) { c1++; };
517 while (!isspace(*c2) && *c2 != '\0') { c2++; };
519 if (c1 == c2) { break; }
521 if (*rts_argc < MAX_RTS_ARGS-1) {
523 strncpy(s, c1, c2-c1);
525 rts_argv[(*rts_argc)++] = s;
527 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
531 } while (*c1 != '\0');
535 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
536 // argv[0] must be PGM argument -- leave in argv
538 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
539 if (strequal("+RTS", argv[arg])) {
542 else if (strequal("-RTS", argv[arg])) {
545 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
546 rts_argv[(*rts_argc)++] = argv[arg];
548 else if (mode == PGM) {
549 argv[(*argc)++] = argv[arg];
552 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
555 if (arg < total_arg) {
556 /* arg must be --RTS; process remaining program arguments */
557 while (++arg < total_arg) {
558 argv[(*argc)++] = argv[arg];
561 argv[*argc] = (char *) 0;
562 rts_argv[*rts_argc] = (char *) 0;
564 // Process RTS (rts_argv) part: mainly to determine statsfile
565 for (arg = 0; arg < *rts_argc; arg++) {
566 if (rts_argv[arg][0] != '-') {
568 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
572 switch(rts_argv[arg][1]) {
574 /* process: general args, then PROFILING-only ones,
575 then CONCURRENT-only, PARallel-only, GRAN-only,
576 TICKY-only (same order as defined in RtsFlags.lh);
577 within those groups, mostly in case-insensitive
579 Final group is x*, which allows for more options.
583 # define TICKY_BUILD_ONLY(x) x
585 # define TICKY_BUILD_ONLY(x) \
586 prog_belch("GHC not built for: ticky-ticky stats"); \
590 #if defined(PROFILING)
591 # define COST_CENTRE_USING_BUILD_ONLY(x) x
593 # define COST_CENTRE_USING_BUILD_ONLY(x) \
594 prog_belch("GHC not built for: -prof or -parallel"); \
599 # define PROFILING_BUILD_ONLY(x) x
601 # define PROFILING_BUILD_ONLY(x) \
602 prog_belch("GHC not built for: -prof"); \
607 # define SMP_BUILD_ONLY(x) x
609 # define SMP_BUILD_ONLY(x) \
610 prog_belch("GHC not built for: -smp"); \
615 # define PAR_BUILD_ONLY(x) x
617 # define PAR_BUILD_ONLY(x) \
618 prog_belch("GHC not built for: -parallel"); \
622 #if defined(SMP) || defined(PAR)
623 # define PAR_OR_SMP_BUILD_ONLY(x) x
625 # define PAR_OR_SMP_BUILD_ONLY(x) \
626 prog_belch("GHC not built for: -parallel or -smp"); \
631 # define GRAN_BUILD_ONLY(x) x
633 # define GRAN_BUILD_ONLY(x) \
634 prog_belch("GHC not built for: -gransim"); \
638 /* =========== GENERAL ========================== */
644 RtsFlags.GcFlags.minAllocAreaSize
645 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
646 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
647 bad_option(rts_argv[arg]);
652 RtsFlags.GcFlags.ringBell = rtsTrue;
656 if (rts_argv[arg][2] != '\0') {
657 RtsFlags.GcFlags.compactThreshold =
658 atof(rts_argv[arg]+2);
660 RtsFlags.GcFlags.compact = rtsTrue;
665 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
667 if (RtsFlags.GcFlags.oldGenFactor < 0)
668 bad_option( rts_argv[arg] );
673 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
674 /* hack warning: interpret the flags as a binary number */
675 nat n = decode(rts_argv[arg]+2);
676 set_debug_options(n);
682 RtsFlags.GcFlags.maxStkSize =
683 decode(rts_argv[arg]+2) / sizeof(W_);
685 if (RtsFlags.GcFlags.maxStkSize == 0)
686 bad_option( rts_argv[arg] );
690 RtsFlags.GcFlags.initialStkSize =
691 decode(rts_argv[arg]+2) / sizeof(W_);
693 if (RtsFlags.GcFlags.initialStkSize == 0)
694 bad_option( rts_argv[arg] );
698 RtsFlags.GcFlags.maxHeapSize =
699 decode(rts_argv[arg]+2) / BLOCK_SIZE;
700 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
702 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
703 bad_option(rts_argv[arg]);
708 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
710 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
711 RtsFlags.GcFlags.pcFreeHeap > 100)
712 bad_option( rts_argv[arg] );
716 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
717 if (RtsFlags.GcFlags.generations < 1) {
718 bad_option(rts_argv[arg]);
723 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
724 if (RtsFlags.GcFlags.steps < 1) {
725 bad_option(rts_argv[arg]);
730 RtsFlags.GcFlags.heapSizeSuggestion =
731 decode(rts_argv[arg]+2) / BLOCK_SIZE;
733 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
734 bad_option(rts_argv[arg]);
738 #ifdef RTS_GTK_FRONTPANEL
740 RtsFlags.GcFlags.frontpanel = rtsTrue;
745 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
749 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
753 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
758 /* Opening all those files would almost certainly fail... */
759 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
760 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
762 RtsFlags.GcFlags.statsFile
763 = open_stats_file(arg, *argc, argv,
764 *rts_argc, rts_argv, STAT_FILENAME_FMT);
766 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
771 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
774 /* =========== PROFILING ========================== */
776 case 'P': /* detailed cost centre profiling (time/alloc) */
777 case 'p': /* cost centre profiling (time/alloc) */
778 COST_CENTRE_USING_BUILD_ONLY(
779 switch (rts_argv[arg][2]) {
781 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
784 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
787 if (rts_argv[arg][1] == 'P') {
788 RtsFlags.CcFlags.doCostCentres =
789 COST_CENTRES_VERBOSE;
791 RtsFlags.CcFlags.doCostCentres =
792 COST_CENTRES_SUMMARY;
798 case 'h': /* serial heap profile */
799 #if !defined(PROFILING) && defined(DEBUG)
800 switch (rts_argv[arg][2]) {
803 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
806 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
809 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
813 PROFILING_BUILD_ONLY(
814 switch (rts_argv[arg][2]) {
817 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
820 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
823 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
826 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
828 case 'c': /* cost centre label select */
829 case 'm': /* cost centre module select */
830 case 'd': /* closure descr select */
831 case 'y': /* closure type select */
832 {char *left = strchr(rts_argv[arg], '{');
833 char *right = strrchr(rts_argv[arg], '}');
834 if (! left || ! right ||
835 strrchr(rts_argv[arg], '{') != left ||
836 strchr(rts_argv[arg], '}') != right) {
838 "Invalid heap profiling selection bracketing\n %s\n",
843 switch (rts_argv[arg][2]) {
844 case 'c': /* cost centre label select */
845 RtsFlags.ProfFlags.ccSelector = left + 1;
847 case 'm': /* cost centre module select */
848 RtsFlags.ProfFlags.modSelector = left + 1;
850 case 'd': /* closure descr select */
851 RtsFlags.ProfFlags.descrSelector = left + 1;
853 case 'y': /* closure type select */
854 RtsFlags.ProfFlags.typeSelector = left + 1;
861 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
869 #if defined(PROFILING)
870 case 'i': /* heap sample interval */
871 if (rts_argv[arg][2] == '\0') {
876 /* Convert to milliseconds */
877 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
878 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
879 if (cst != 0 && cst < CS_MIN_MILLISECS)
880 cst = CS_MIN_MILLISECS;
882 RtsFlags.ProfFlags.profileFrequency = cst;
889 /* =========== CONCURRENT ========================= */
890 case 'C': /* context switch interval */
891 if (rts_argv[arg][2] == '\0')
892 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
896 /* Convert to milliseconds */
897 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
898 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
899 if (cst != 0 && cst < CS_MIN_MILLISECS)
900 cst = CS_MIN_MILLISECS;
902 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
909 if (rts_argv[arg][2] != '\0') {
910 RtsFlags.ParFlags.nNodes
911 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
912 if (RtsFlags.ParFlags.nNodes <= 0) {
913 prog_belch("bad value for -N");
919 /* =========== PARALLEL =========================== */
921 PAR_OR_SMP_BUILD_ONLY(
922 if (rts_argv[arg][2] != '\0') {
923 RtsFlags.ParFlags.maxLocalSparks
924 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
925 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
926 prog_belch("bad value for -e");
934 process_par_option(arg, rts_argc, rts_argv, &error);
937 /* =========== GRAN =============================== */
941 process_gran_option(arg, rts_argc, rts_argv, &error);
944 /* =========== TICKY ============================== */
946 case 'r': /* Basic profiling stats */
949 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
950 RtsFlags.TickyFlags.tickyFile
951 = open_stats_file(arg, *argc, argv,
952 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
954 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
957 /* =========== EXTENDED OPTIONS =================== */
959 case 'x': /* Extend the argument space */
960 switch(rts_argv[arg][2]) {
962 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
966 case 'c': /* Debugging tool: show current cost centre on an exception */
967 PROFILING_BUILD_ONLY(
968 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
971 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
974 prog_belch("unknown RTS option: %s",rts_argv[arg]);
978 break; /* defensive programming */
980 /* =========== OH DEAR ============================ */
982 prog_belch("unknown RTS option: %s",rts_argv[arg]);
992 for (p = usage_text; *p; p++)
994 stg_exit(EXIT_FAILURE);
1000 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
1001 //@subsection GranSim specific options
1004 enable_GranSimLight(void) {
1006 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1007 RtsFlags.GranFlags.Light=rtsTrue;
1008 RtsFlags.GranFlags.Costs.latency =
1009 RtsFlags.GranFlags.Costs.fetchtime =
1010 RtsFlags.GranFlags.Costs.additional_latency =
1011 RtsFlags.GranFlags.Costs.gunblocktime =
1012 RtsFlags.GranFlags.Costs.lunblocktime =
1013 RtsFlags.GranFlags.Costs.threadcreatetime =
1014 RtsFlags.GranFlags.Costs.threadqueuetime =
1015 RtsFlags.GranFlags.Costs.threadscheduletime =
1016 RtsFlags.GranFlags.Costs.threaddescheduletime =
1017 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1019 RtsFlags.GranFlags.Costs.mpacktime =
1020 RtsFlags.GranFlags.Costs.munpacktime = 0;
1022 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1023 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1024 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1025 /* FetchStrategy is irrelevant in GrAnSim-Light */
1027 /* GrAnSim Light often creates an abundance of parallel threads,
1028 each with its own stack etc. Therefore, it's in general a good
1029 idea to use small stack chunks (use the -o<size> option to
1032 // RtsFlags.ConcFlags.stkChunkSize = 100;
1034 RtsFlags.GranFlags.proc = 1;
1038 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1040 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1043 /* or a ridiculously idealised simulator */
1044 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1045 RtsFlags.GranFlags.Costs.latency =
1046 RtsFlags.GranFlags.Costs.fetchtime =
1047 RtsFlags.GranFlags.Costs.additional_latency =
1048 RtsFlags.GranFlags.Costs.gunblocktime =
1049 RtsFlags.GranFlags.Costs.lunblocktime =
1050 RtsFlags.GranFlags.Costs.threadcreatetime =
1051 RtsFlags.GranFlags.Costs.threadqueuetime =
1052 RtsFlags.GranFlags.Costs.threadscheduletime =
1053 RtsFlags.GranFlags.Costs.threaddescheduletime =
1054 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1056 RtsFlags.GranFlags.Costs.mpacktime =
1057 RtsFlags.GranFlags.Costs.munpacktime = 0;
1059 RtsFlags.GranFlags.Costs.arith_cost =
1060 RtsFlags.GranFlags.Costs.float_cost =
1061 RtsFlags.GranFlags.Costs.load_cost =
1062 RtsFlags.GranFlags.Costs.store_cost =
1063 RtsFlags.GranFlags.Costs.branch_cost = 0;
1065 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1067 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1068 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1069 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1070 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1074 /* or a somewhat idealised simulator */
1075 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1076 RtsFlags.GranFlags.Costs.latency =
1077 RtsFlags.GranFlags.Costs.fetchtime =
1078 RtsFlags.GranFlags.Costs.additional_latency =
1079 RtsFlags.GranFlags.Costs.gunblocktime =
1080 RtsFlags.GranFlags.Costs.lunblocktime =
1081 RtsFlags.GranFlags.Costs.threadcreatetime =
1082 RtsFlags.GranFlags.Costs.threadqueuetime =
1083 RtsFlags.GranFlags.Costs.threadscheduletime =
1084 RtsFlags.GranFlags.Costs.threaddescheduletime =
1085 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1087 RtsFlags.GranFlags.Costs.mpacktime =
1088 RtsFlags.GranFlags.Costs.munpacktime = 0;
1090 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1092 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1093 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1094 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1095 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1096 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1097 # if defined(GRAN_CHECK) && defined(GRAN)
1098 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1103 /* Communication and task creation cost parameters */
1104 switch(rts_argv[arg][2]) {
1106 IgnoreYields = rtsTrue; // HWL HACK
1110 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1114 if (rts_argv[arg][3] != '\0')
1116 RtsFlags.GranFlags.Costs.gunblocktime =
1117 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1118 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1121 RtsFlags.GranFlags.Costs.latency = LATENCY;
1125 if (rts_argv[arg][3] != '\0')
1126 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1128 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1132 if (rts_argv[arg][3] != '\0')
1133 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1135 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1139 if (rts_argv[arg][3] != '\0')
1140 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1142 RtsFlags.GranFlags.Costs.mtidytime = 0;
1146 if (rts_argv[arg][3] != '\0')
1147 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1149 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1153 if (rts_argv[arg][3] != '\0')
1154 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1156 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1160 if (rts_argv[arg][3] != '\0')
1161 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1163 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1167 if (rts_argv[arg][3] != '\0')
1168 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1170 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1173 /* Thread-related metrics */
1175 if (rts_argv[arg][3] != '\0')
1176 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1178 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1182 if (rts_argv[arg][3] != '\0')
1183 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1185 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1189 if (rts_argv[arg][3] != '\0')
1190 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1192 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1194 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1195 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1199 if (rts_argv[arg][3] != '\0')
1200 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1202 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1204 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1205 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1208 /* Instruction Cost Metrics */
1210 if (rts_argv[arg][3] != '\0')
1211 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1213 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1217 if (rts_argv[arg][3] != '\0')
1218 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1220 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1224 if (rts_argv[arg][3] != '\0')
1225 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1227 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1231 if (rts_argv[arg][3] != '\0')
1232 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1234 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1238 if (rts_argv[arg][3] != '\0')
1239 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1241 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1245 if (rts_argv[arg][3] != '\0')
1246 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1248 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1252 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1253 if (rts_argv[arg][3] != '\0')
1254 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1256 RtsFlags.GranFlags.FetchStrategy = 2;
1257 if (RtsFlags.GranFlags.FetchStrategy == 0)
1258 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1261 case 'K': /* sort overhead (per elem in spark list) */
1262 if (rts_argv[arg][3] != '\0')
1263 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1265 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1266 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1267 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1270 case 'O': /* sort overhead (per elem in spark list) */
1271 if (rts_argv[arg][3] != '\0')
1272 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1274 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1275 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1276 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1279 /* General Parameters */
1281 if (rts_argv[arg][3] != '\0')
1283 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1284 if (RtsFlags.GranFlags.proc==0) {
1285 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1286 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1287 RtsFlags.GranFlags.proc < 1)
1289 fprintf(stderr,"setupRtsFlags: no more than %u processors
1296 RtsFlags.GranFlags.proc = MAX_PROC;
1300 RtsFlags.GranFlags.Fishing = rtsTrue;
1301 if (rts_argv[arg][3] != '\0')
1302 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1304 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1308 if (rts_argv[arg][3] != '\0')
1309 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1311 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1315 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1316 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1320 fprintf(stderr,"Bulk fetching enabled.\n");
1321 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1325 fprintf(stderr,"Thread migration enabled.\n");
1326 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1330 fprintf(stderr,"Fair Scheduling enabled.\n");
1331 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1335 fprintf(stderr,"Priority Scheduling enabled.\n");
1336 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1340 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1341 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1345 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1349 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1353 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1357 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1361 /* format is -bP<c> where <c> is one char describing kind of profile */
1362 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1363 switch(rts_argv[arg][3]) {
1364 case '\0': break; // nothing special, just an ordinary profile
1365 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1367 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1369 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1371 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1373 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1375 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1377 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1382 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1386 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1389 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1390 if (rts_argv[arg][3] != '\0') {
1393 arg0 = rts_argv[arg]+3;
1394 if ((tmp = strstr(arg0,","))==NULL) {
1395 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1396 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1399 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1400 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1401 fprintf(stderr,"SparkPriority: %u.\n",
1402 RtsFlags.GranFlags.SparkPriority);
1403 fprintf(stderr,"SparkPriority2:%u.\n",
1404 RtsFlags.GranFlags.SparkPriority2);
1405 if (RtsFlags.GranFlags.SparkPriority2 <
1406 RtsFlags.GranFlags.SparkPriority) {
1407 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1408 RtsFlags.GranFlags.SparkPriority2,
1409 RtsFlags.GranFlags.SparkPriority);
1413 /* plain pri spark is now invoked with -bX
1414 RtsFlags.GranFlags.DoPrioritySparking = 1;
1415 fprintf(stderr,"PrioritySparking.\n");
1421 if (rts_argv[arg][3] != '\0') {
1422 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1424 RtsFlags.GranFlags.ThunksToPack = 1;
1426 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1427 RtsFlags.GranFlags.ThunksToPack);
1431 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1432 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1435 /* The following class of options contains eXperimental */
1436 /* features in connection with exploiting granularity */
1437 /* information. I.e. if -bY is chosen these options */
1438 /* tell the RTS what to do with the supplied info --HWL */
1441 if (rts_argv[arg][3] != '\0') {
1442 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1444 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1446 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1447 RtsFlags.GranFlags.packBufferSize_internal);
1451 switch(rts_argv[arg][3]) {
1454 RtsFlags.GranFlags.DoPrioritySparking = 1;
1455 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1456 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1457 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1458 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1462 RtsFlags.GranFlags.DoPrioritySparking = 1;
1463 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1464 RtsFlags.GranFlags.InversePriorities++;
1468 RtsFlags.GranFlags.DoPrioritySparking = 1;
1469 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1470 RtsFlags.GranFlags.RandomPriorities++;
1474 RtsFlags.GranFlags.DoPrioritySparking = 1;
1475 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1476 RtsFlags.GranFlags.IgnorePriorities++;
1480 bad_option( rts_argv[arg] );
1486 switch(rts_argv[arg][3]) {
1489 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1490 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1494 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1498 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1502 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1506 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1507 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1511 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1515 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1519 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1523 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1527 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1531 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1535 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1539 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1540 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1544 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1548 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1552 bad_option( rts_argv[arg] );
1557 # if defined(GRAN_CHECK) && defined(GRAN)
1559 switch(rts_argv[arg][3]) {
1560 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1561 if (rts_argv[arg][4] != '\0') {
1562 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1563 fprintf(stderr,"Pack buffer size: %d\n",
1564 RtsFlags.GranFlags.packBufferSize);
1566 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1572 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1573 /* hack warning: interpret the flags as a binary number */
1574 nat n = decode(rts_argv[arg]+3);
1575 set_GranSim_debug_options(n);
1578 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1579 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1582 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1583 fprintf(stderr, "Valid GranSim debug options are:\n");
1584 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1585 bad_option( rts_argv[arg] );
1586 } else { // flag found; now set it
1587 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1593 case 'e': /* event trace; also -bD1 */
1594 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1595 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1596 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1599 case 'E': /* event statistics; also -bD2 */
1600 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1601 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1602 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1605 case 'f': /* thunkStealing; also -bD4 */
1606 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1607 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1608 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1611 case 'z': /* blockOnFetch; also -bD8 */
1612 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1613 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1614 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1617 case 't': /* blockOnFetch_sanity; also -bD16 */
1618 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1619 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1620 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1623 case 'S': /* priSpark; also -bD32 */
1624 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1625 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1628 case 's': /* priSched; also -bD64 */
1629 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1630 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1633 case 'F': /* findWork; also -bD128 */
1634 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1635 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1638 case 'g': /* globalBlock; also -bD256 */
1639 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1640 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1643 case 'G': /* pack; also -bD512 */
1644 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1645 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1648 case 'P': /* packBuffer; also -bD1024 */
1649 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1650 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1653 case 'o': /* sortedQ; also -bD2048 */
1654 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1655 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1658 case 'r': /* randomSteal; also -bD4096 */
1659 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1660 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1663 case 'q': /* checkSparkQ; also -bD8192 */
1664 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1665 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1668 case ':': /* checkLight; also -bD16384 */
1669 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1670 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1673 case 'b': /* bq; also -bD32768 */
1674 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1675 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1678 case 'd': /* all options turned on */
1679 fprintf(stderr,"DEBUG: all options turned on.\n");
1680 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1681 /* RtsFlags.GranFlags.Debug |= 0x40; */
1685 /* RtsFlags.GranFlags.Debug = 1; */
1691 # endif /* GRAN_CHECK */
1693 bad_option( rts_argv[arg] );
1699 Interpret n as a binary number masking GranSim debug options and set the
1700 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1703 set_GranSim_debug_options(nat n) {
1706 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1708 fprintf(stderr, gran_debug_opts_strs[i]);
1710 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1711 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1712 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1713 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1714 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1715 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1716 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1717 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1718 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1719 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1720 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1721 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1722 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1723 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1724 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1725 default: barf("set_GranSim_debug_options: only %d debug options expected");
1731 Print one line explanation for each of the GranSim debug options specified
1735 help_GranSim_debug_options(nat n) {
1738 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1740 fprintf(stderr, gran_debug_opts_strs[i]);
1746 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1749 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
1750 belch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
1754 /* Communication and task creation cost parameters */
1755 switch(rts_argv[arg][2]) {
1756 case 'e': /* -qe<n> ... allow <n> local sparks */
1757 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1758 RtsFlags.ParFlags.maxLocalSparks
1759 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1761 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1762 belch("setupRtsFlags: bad value for -e\n");
1766 IF_PAR_DEBUG(verbose,
1767 belch("-qe<n>: max %d local sparks",
1768 RtsFlags.ParFlags.maxLocalSparks));
1772 if (rts_argv[arg][3] != '\0') {
1773 RtsFlags.ParFlags.maxThreads
1774 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1776 belch("setupRtsFlags: missing size for -qt\n");
1779 IF_PAR_DEBUG(verbose,
1780 belch("-qt<n>: max %d threads",
1781 RtsFlags.ParFlags.maxThreads));
1785 if (rts_argv[arg][3] != '\0')
1786 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1788 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1790 IF_PAR_DEBUG(verbose,
1791 belch("-qf<n>: max %d fishes sent out at one time",
1792 RtsFlags.ParFlags.maxFishes));
1796 if (rts_argv[arg][3] != '\0') {
1797 RtsFlags.ParFlags.fishDelay
1798 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1800 belch("setupRtsFlags: missing fish delay time for -qF\n");
1803 IF_PAR_DEBUG(verbose,
1804 belch("-qF<n>: fish delay time %d us",
1805 RtsFlags.ParFlags.fishDelay));
1809 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1810 IF_PAR_DEBUG(verbose,
1811 belch("-qO: output disabled"));
1814 case 'g': /* -qg<n> ... globalisation scheme */
1815 if (rts_argv[arg][3] != '\0') {
1816 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
1818 belch("setupRtsFlags: missing identifier for globalisation scheme (for -qg)\n");
1821 IF_PAR_DEBUG(verbose,
1822 belch("-qg<n>: globalisation scheme set to %d",
1823 RtsFlags.ParFlags.globalising));
1826 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
1827 if (rts_argv[arg][3] != '\0') {
1828 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
1830 belch("setupRtsFlags: missing number of thunks per packet (for -qh)\n");
1833 IF_PAR_DEBUG(verbose,
1834 belch("-qh<n>: thunks per packet set to %d",
1835 RtsFlags.ParFlags.thunksToPack));
1838 case 'P': /* -qP for writing a log file */
1839 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1840 /* same encoding as in GranSim after -bP */
1841 switch(rts_argv[arg][3]) {
1842 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1843 break; // nothing special, just an ordinary profile
1844 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1845 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1847 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1849 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1851 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1853 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1856 # if defined(PAR_TICKY)
1857 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1859 fprintf(stderr,"-qPg is only possible for a PAR_TICKY RTS, which this is not");
1860 stg_exit(EXIT_FAILURE);
1863 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1865 IF_PAR_DEBUG(verbose,
1866 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1867 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1870 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1871 if (rts_argv[arg][3] != '\0') {
1872 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1874 belch("setupRtsFlags: missing size of PackBuffer (for -qQ)\n");
1877 IF_PAR_DEBUG(verbose,
1878 belch("-qQ<n>: pack buffer size set to %d",
1879 RtsFlags.ParFlags.packBufferSize));
1883 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
1884 IF_PAR_DEBUG(verbose,
1885 belch("-qR: fair-ish scheduling"));
1890 if (rts_argv[arg][3] != '\0') {
1891 RtsFlags.ParFlags.wait
1892 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1894 RtsFlags.ParFlags.wait = 1000;
1896 IF_PAR_DEBUG(verbose,
1897 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1898 RtsFlags.ParFlags.wait));
1901 case 'D': /* -qD ... all the debugging options */
1902 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1903 /* hack warning: interpret the flags as a binary number */
1904 nat n = decode(rts_argv[arg]+3);
1905 set_par_debug_options(n);
1908 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1909 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1912 if (i==MAX_PAR_DEBUG_OPTION+1) {
1913 fprintf(stderr, "Valid GUM debug options are:\n");
1914 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1915 bad_option( rts_argv[arg] );
1916 } else { // flag found; now set it
1917 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1923 belch("Unknown option -q%c (%d opts in total)",
1924 rts_argv[arg][2], *rts_argc);
1930 Interpret n as a binary number masking Par debug options and set the
1931 correxponding option. See par_debug_opts_strs for explanations of the flags.
1934 set_par_debug_options(nat n) {
1937 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1939 fprintf(stderr, par_debug_opts_strs[i]);
1941 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1942 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
1943 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1944 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1945 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1946 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1947 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1948 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1949 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1950 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
1951 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
1952 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1953 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
1954 default: barf("set_par_debug_options: only %d debug options expected",
1955 MAX_PAR_DEBUG_OPTION);
1961 Print one line explanation for each of the GranSim debug options specified
1965 help_par_debug_options(nat n) {
1968 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1970 fprintf(stderr, par_debug_opts_strs[i]);
1977 set_debug_options(nat n) {
1980 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1982 fprintf(stderr, debug_opts_strs[i]);
1984 case 0: RtsFlags.DebugFlags.scheduler = rtsTrue; break;
1985 case 1: RtsFlags.DebugFlags.evaluator = rtsTrue; break;
1986 case 2: RtsFlags.DebugFlags.codegen = rtsTrue; break;
1987 case 3: RtsFlags.DebugFlags.weak = rtsTrue; break;
1988 case 4: RtsFlags.DebugFlags.gccafs = rtsTrue; break;
1989 case 5: RtsFlags.DebugFlags.gc = rtsTrue; break;
1990 case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1991 case 7: RtsFlags.DebugFlags.sanity = rtsTrue; break;
1992 case 8: RtsFlags.DebugFlags.stable = rtsTrue; break;
1993 case 9: RtsFlags.DebugFlags.prof = rtsTrue; break;
1994 case 10: RtsFlags.DebugFlags.gran = rtsTrue; break;
1995 case 11: RtsFlags.DebugFlags.par = rtsTrue; break;
1996 default: barf("set_debug_options: only %d debug options expected",
2003 help_debug_options(nat n) {
2006 for (i=0; i<=MAX_DEBUG_OPTION; i++)
2008 fprintf(stderr, debug_opts_strs[i]);
2012 //@node Aux fcts, , GranSim specific options
2013 //@subsection Aux fcts
2015 static FILE * /* return NULL on error */
2018 int argc, char *argv[],
2019 int rts_argc, char *rts_argv[],
2020 const char *FILENAME_FMT)
2024 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
2026 else if (rts_argv[arg][2] != '\0') /* stats file specified */
2027 f = fopen(rts_argv[arg]+2,"w");
2029 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2030 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2031 f = fopen(stats_filename,"w");
2034 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
2036 /* Write argv and rtsv into start of stats file */
2038 for(count = 0; count < argc; count++)
2039 fprintf(f, "%s ", argv[count]);
2040 fprintf(f, "+RTS ");
2041 for(count = 0; count < rts_argc; count++)
2042 fprintf(f, "%s ", rts_argv[count]);
2050 decode(const char *s)
2061 if (c == 'g' || c == 'G')
2062 m *= 1000*1000*1000; /* UNchecked! */
2063 else if (c == 'm' || c == 'M')
2064 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2065 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2066 m *= 1000; /* a direct-mapped cache. */
2067 else if (c == 'w' || c == 'W')
2074 bad_option(const char *s)
2076 prog_belch("bad RTS option: %s", s);
2077 stg_exit(EXIT_FAILURE);