1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.38 2001/03/22 03:51:10 hwloidl 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 = (64 * 1024 * 1024) / BLOCK_SIZE;
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 #ifdef RTS_GTK_FRONTPANEL
241 RtsFlags.GcFlags.frontpanel = rtsFalse;
244 #if defined(PROFILING) || defined(PAR)
245 RtsFlags.CcFlags.doCostCentres = 0;
246 #endif /* PROFILING or PAR */
249 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
250 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
251 RtsFlags.ProfFlags.modSelector = NULL;
252 RtsFlags.ProfFlags.descrSelector = NULL;
253 RtsFlags.ProfFlags.typeSelector = NULL;
254 RtsFlags.ProfFlags.ccSelector = NULL;
256 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
259 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
262 RtsFlags.ParFlags.nNodes = 1;
266 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
267 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
268 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
269 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
270 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
271 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
272 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
274 RtsFlags.ParFlags.outputDisabled = rtsFalse;
276 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
278 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
280 RtsFlags.ParFlags.packBufferSize = 1024;
281 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
282 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
283 RtsFlags.ParFlags.maxThreads = 1024;
284 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
285 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
288 #if defined(PAR) || defined(SMP)
289 RtsFlags.ParFlags.maxLocalSparks = 4096;
290 #endif /* PAR || SMP */
293 /* ToDo: check defaults for GranSim and GUM */
294 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
295 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
297 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
298 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
299 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
300 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
301 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
302 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
303 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
304 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
306 RtsFlags.GranFlags.packBufferSize = 1024;
307 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
309 RtsFlags.GranFlags.proc = MAX_PROC;
310 RtsFlags.GranFlags.Fishing = rtsFalse;
311 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
312 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
313 RtsFlags.GranFlags.Light = rtsFalse;
315 RtsFlags.GranFlags.Costs.latency = LATENCY;
316 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
317 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
318 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
319 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
320 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
321 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
322 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
324 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
325 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
326 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
327 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
328 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
330 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
331 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
332 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
333 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
334 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
336 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
338 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
339 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
341 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
342 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
343 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
344 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
345 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
346 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
347 RtsFlags.GranFlags.FetchStrategy = 2;
348 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
349 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
350 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
351 RtsFlags.GranFlags.SparkPriority = 0;
352 RtsFlags.GranFlags.SparkPriority2 = 0;
353 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
354 RtsFlags.GranFlags.InversePriorities = rtsFalse;
355 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
356 RtsFlags.GranFlags.ThunksToPack = 0;
357 RtsFlags.GranFlags.RandomSteal = rtsTrue;
361 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
362 RtsFlags.TickyFlags.tickyFile = NULL;
369 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
371 " +RTS Indicates run time system options follow",
372 " -RTS Indicates program arguments follow",
373 " --RTS Indicates that ALL subsequent arguments will be given to the",
374 " program (including any of these RTS flags)",
376 "The following run time system options are available:",
378 " -? Prints this message and exits; the program is not executed",
380 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
381 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
383 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
384 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
385 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
386 " -m<n>% Minimum % of heap which must be available (default 3%)",
387 " -G<n> Number of generations (default: 2)",
388 " -T<n> Number of steps in younger generations (default: 2)",
390 " -t<file> One-line GC statistics (default file: <program>.stat)",
391 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
392 " -S<file> Detailed GC statistics",
393 #ifdef RTS_GTK_FRONTPANEL
394 " -f Display front panel (requires X11 & GTK+)",
398 " -Z Don't squeeze out update frames on stack overflow",
399 " -B Sound the bell at the start of each garbage collection",
400 #if defined(PROFILING) || defined(PAR)
402 " -px Time/allocation profile (XML) (output file <program>.prof)",
403 " -p<sort> Time/allocation profile (output file <program>.prof)",
404 " sort: T = time (default), A = alloc, C = cost centre label",
405 " -P<sort> More detailed Time/Allocation profile",
407 # if defined(PROFILING)
409 " -hx Heap residency profile (XML) (output file <program>.prof)",
410 " -h<break-down> Heap residency profile (text) (output file <program>.prof)",
411 " break-down: C = cost centre stack (default), M = module",
412 " D = closure description, Y = type description",
413 " A subset of closures may be selected thusly:",
414 " -hc{cc, cc ...} specific cost centre(s) (NOT STACKS!)",
415 " -hm{mod,mod...} all cost centres from the specified modules(s)",
416 " -hd{des,des...} closures with specified closure descriptions",
417 " -hy{typ,typ...} closures with specified type descriptions",
419 " -xc Show current cost centre stack on raising an exception",
421 #endif /* PROFILING or PAR */
422 #if !defined(PROFILING) && defined(DEBUG)
424 " -h<break-down> Debugging Heap residency profile",
425 " (output file <program>.hp)",
426 " break-down: L = closure label (default)",
427 " T = closure type (constructor, thunk etc.)",
430 #if defined(TICKY_TICKY)
431 " -r<file> Produce reduction profiling 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 " the default is .02 sec; resolution is .02 sec",
442 " -N<n> Use <n> OS threads (default: 1)",
444 #if defined(SMP) || defined(PAR)
445 " -e<size> Size of spark pools (default 100)",
448 " -t<num> Set maximum number of advisory threads per PE (default 32)",
449 " -qP Enable activity profile (output files in ~/<program>*.gr)",
450 " -qQ<size> Set pack-buffer size (default: 1024)",
451 " -qd Turn on PVM-ish debugging",
452 " -qO Disable output for performance measurement",
454 #if defined(SMP) || defined(PAR)
455 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
458 " -d Turn on PVM-ish debugging",
459 " -O Disable output for performance measurement",
461 #if defined(GRAN) /* ToDo: fill in decent Docu here */
462 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
465 "Other RTS options may be available for programs compiled a different way.",
466 "The GHC User's Guide has full details.",
471 static __inline__ rtsBool
472 strequal(const char *a, const char * b)
474 return(strcmp(a, b) == 0);
478 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
480 rtsBool error = rtsFalse;
485 /* Remove directory from argv[0] -- default files in current directory */
487 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
488 strcpy(argv[0], last_slash+1);
490 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
491 /* argv[0] must be PGM argument -- leave in argv */
499 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
500 if (strequal("+RTS", argv[arg])) {
503 else if (strequal("-RTS", argv[arg])) {
506 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
507 rts_argv[(*rts_argc)++] = argv[arg];
509 else if (mode == PGM) {
510 argv[(*argc)++] = argv[arg];
513 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
516 if (arg < total_arg) {
517 /* arg must be --RTS; process remaining program arguments */
518 while (++arg < total_arg) {
519 argv[(*argc)++] = argv[arg];
522 argv[*argc] = (char *) 0;
523 rts_argv[*rts_argc] = (char *) 0;
525 /* Process RTS (rts_argv) part: mainly to determine statsfile */
527 for (arg = 0; arg < *rts_argc; arg++) {
528 if (rts_argv[arg][0] != '-') {
530 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
534 switch(rts_argv[arg][1]) {
536 /* process: general args, then PROFILING-only ones,
537 then CONCURRENT-only, PARallel-only, GRAN-only,
538 TICKY-only (same order as defined in RtsFlags.lh);
539 within those groups, mostly in case-insensitive
541 Final group is x*, which allows for more options.
545 # define TICKY_BUILD_ONLY(x) x
547 # define TICKY_BUILD_ONLY(x) \
548 prog_belch("GHC not built for: ticky-ticky stats"); \
552 #if defined(PROFILING)
553 # define COST_CENTRE_USING_BUILD_ONLY(x) x
555 # define COST_CENTRE_USING_BUILD_ONLY(x) \
556 prog_belch("GHC not built for: -prof or -parallel"); \
561 # define PROFILING_BUILD_ONLY(x) x
563 # define PROFILING_BUILD_ONLY(x) \
564 prog_belch("GHC not built for: -prof"); \
569 # define SMP_BUILD_ONLY(x) x
571 # define SMP_BUILD_ONLY(x) \
572 prog_belch("GHC not built for: -smp"); \
577 # define PAR_BUILD_ONLY(x) x
579 # define PAR_BUILD_ONLY(x) \
580 prog_belch("GHC not built for: -parallel"); \
584 #if defined(SMP) || defined(PAR)
585 # define PAR_OR_SMP_BUILD_ONLY(x) x
587 # define PAR_OR_SMP_BUILD_ONLY(x) \
588 prog_belch("GHC not built for: -parallel or -smp"); \
593 # define GRAN_BUILD_ONLY(x) x
595 # define GRAN_BUILD_ONLY(x) \
596 prog_belch("GHC not built for: -gransim"); \
600 /* =========== GENERAL ========================== */
606 RtsFlags.GcFlags.minAllocAreaSize
607 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
608 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
609 bad_option(rts_argv[arg]);
614 RtsFlags.GcFlags.ringBell = rtsTrue;
618 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
620 if (RtsFlags.GcFlags.oldGenFactor < 0)
621 bad_option( rts_argv[arg] );
626 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
627 /* hack warning: interpret the flags as a binary number */
628 nat n = decode(rts_argv[arg]+2);
629 set_debug_options(n);
635 RtsFlags.GcFlags.maxStkSize =
636 decode(rts_argv[arg]+2) / sizeof(W_);
638 if (RtsFlags.GcFlags.maxStkSize == 0)
639 bad_option( rts_argv[arg] );
643 RtsFlags.GcFlags.initialStkSize =
644 decode(rts_argv[arg]+2) / sizeof(W_);
646 if (RtsFlags.GcFlags.initialStkSize == 0)
647 bad_option( rts_argv[arg] );
651 RtsFlags.GcFlags.maxHeapSize =
652 decode(rts_argv[arg]+2) / BLOCK_SIZE;
653 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
655 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
656 bad_option(rts_argv[arg]);
661 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
663 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
664 RtsFlags.GcFlags.pcFreeHeap > 100)
665 bad_option( rts_argv[arg] );
669 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
670 if (RtsFlags.GcFlags.generations < 1) {
671 bad_option(rts_argv[arg]);
676 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
677 if (RtsFlags.GcFlags.steps < 1) {
678 bad_option(rts_argv[arg]);
683 RtsFlags.GcFlags.heapSizeSuggestion =
684 decode(rts_argv[arg]+2) / BLOCK_SIZE;
686 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
687 bad_option(rts_argv[arg]);
691 #ifdef RTS_GTK_FRONTPANEL
693 RtsFlags.GcFlags.frontpanel = rtsTrue;
698 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
702 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
706 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
711 /* Opening all those files would almost certainly fail... */
712 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
713 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
715 RtsFlags.GcFlags.statsFile
716 = open_stats_file(arg, *argc, argv,
717 *rts_argc, rts_argv, STAT_FILENAME_FMT);
719 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
724 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
727 /* =========== PROFILING ========================== */
729 case 'P': /* detailed cost centre profiling (time/alloc) */
730 COST_CENTRE_USING_BUILD_ONLY(
731 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
733 case 'p': /* cost centre profiling (time/alloc) */
734 COST_CENTRE_USING_BUILD_ONLY(
735 switch (rts_argv[arg][2]) {
737 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
740 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
745 case 'h': /* serial heap profile */
746 #if !defined(PROFILING) && defined(DEBUG)
747 switch (rts_argv[arg][2]) {
750 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
753 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
756 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
760 PROFILING_BUILD_ONLY(
761 switch (rts_argv[arg][2]) {
764 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
767 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
770 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
773 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
775 case 'c': /* cost centre label select */
776 case 'm': /* cost centre module select */
777 case 'd': /* closure descr select */
778 case 'y': /* closure type select */
779 {char *left = strchr(rts_argv[arg], '{');
780 char *right = strrchr(rts_argv[arg], '}');
781 if (! left || ! right ||
782 strrchr(rts_argv[arg], '{') != left ||
783 strchr(rts_argv[arg], '}') != right) {
785 "Invalid heap profiling selection bracketing\n %s\n",
790 switch (rts_argv[arg][2]) {
791 case 'c': /* cost centre label select */
792 RtsFlags.ProfFlags.ccSelector = left + 1;
794 case 'm': /* cost centre module select */
795 RtsFlags.ProfFlags.modSelector = left + 1;
797 case 'd': /* closure descr select */
798 RtsFlags.ProfFlags.descrSelector = left + 1;
800 case 'y': /* closure type select */
801 RtsFlags.ProfFlags.typeSelector = left + 1;
808 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
816 /* =========== CONCURRENT ========================= */
817 case 'C': /* context switch interval */
818 if (rts_argv[arg][2] == '\0')
819 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
823 /* Convert to milliseconds */
824 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
825 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
826 if (cst != 0 && cst < CS_MIN_MILLISECS)
827 cst = CS_MIN_MILLISECS;
829 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
836 if (rts_argv[arg][2] != '\0') {
837 RtsFlags.ParFlags.nNodes
838 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
839 if (RtsFlags.ParFlags.nNodes <= 0) {
840 prog_belch("bad value for -N");
846 /* =========== PARALLEL =========================== */
848 PAR_OR_SMP_BUILD_ONLY(
849 if (rts_argv[arg][2] != '\0') {
850 RtsFlags.ParFlags.maxLocalSparks
851 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
852 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
853 prog_belch("bad value for -e");
861 process_par_option(arg, rts_argc, rts_argv, &error);
864 /* =========== GRAN =============================== */
868 process_gran_option(arg, rts_argc, rts_argv, &error);
871 /* =========== TICKY ============================== */
873 case 'r': /* Basic profiling stats */
876 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
877 RtsFlags.TickyFlags.tickyFile
878 = open_stats_file(arg, *argc, argv,
879 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
881 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
884 /* =========== EXTENDED OPTIONS =================== */
886 case 'x': /* Extend the argument space */
887 switch(rts_argv[arg][2]) {
889 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
893 case 'c': /* Debugging tool: show current cost centre on an exception */
894 PROFILING_BUILD_ONLY(
895 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
898 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
901 prog_belch("unknown RTS option: %s",rts_argv[arg]);
905 break; /* defensive programming */
907 /* =========== OH DEAR ============================ */
909 prog_belch("unknown RTS option: %s",rts_argv[arg]);
919 for (p = usage_text; *p; p++)
921 stg_exit(EXIT_FAILURE);
927 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
928 //@subsection GranSim specific options
931 enable_GranSimLight(void) {
933 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
934 RtsFlags.GranFlags.Light=rtsTrue;
935 RtsFlags.GranFlags.Costs.latency =
936 RtsFlags.GranFlags.Costs.fetchtime =
937 RtsFlags.GranFlags.Costs.additional_latency =
938 RtsFlags.GranFlags.Costs.gunblocktime =
939 RtsFlags.GranFlags.Costs.lunblocktime =
940 RtsFlags.GranFlags.Costs.threadcreatetime =
941 RtsFlags.GranFlags.Costs.threadqueuetime =
942 RtsFlags.GranFlags.Costs.threadscheduletime =
943 RtsFlags.GranFlags.Costs.threaddescheduletime =
944 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
946 RtsFlags.GranFlags.Costs.mpacktime =
947 RtsFlags.GranFlags.Costs.munpacktime = 0;
949 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
950 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
951 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
952 /* FetchStrategy is irrelevant in GrAnSim-Light */
954 /* GrAnSim Light often creates an abundance of parallel threads,
955 each with its own stack etc. Therefore, it's in general a good
956 idea to use small stack chunks (use the -o<size> option to
959 // RtsFlags.ConcFlags.stkChunkSize = 100;
961 RtsFlags.GranFlags.proc = 1;
965 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
967 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
970 /* or a ridiculously idealised simulator */
971 if(strcmp((rts_argv[arg]+2),"oring")==0) {
972 RtsFlags.GranFlags.Costs.latency =
973 RtsFlags.GranFlags.Costs.fetchtime =
974 RtsFlags.GranFlags.Costs.additional_latency =
975 RtsFlags.GranFlags.Costs.gunblocktime =
976 RtsFlags.GranFlags.Costs.lunblocktime =
977 RtsFlags.GranFlags.Costs.threadcreatetime =
978 RtsFlags.GranFlags.Costs.threadqueuetime =
979 RtsFlags.GranFlags.Costs.threadscheduletime =
980 RtsFlags.GranFlags.Costs.threaddescheduletime =
981 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
983 RtsFlags.GranFlags.Costs.mpacktime =
984 RtsFlags.GranFlags.Costs.munpacktime = 0;
986 RtsFlags.GranFlags.Costs.arith_cost =
987 RtsFlags.GranFlags.Costs.float_cost =
988 RtsFlags.GranFlags.Costs.load_cost =
989 RtsFlags.GranFlags.Costs.store_cost =
990 RtsFlags.GranFlags.Costs.branch_cost = 0;
992 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
994 /* ++RtsFlags.GranFlags.DoFairSchedule; */
995 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
996 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
997 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1001 /* or a somewhat idealised simulator */
1002 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1003 RtsFlags.GranFlags.Costs.latency =
1004 RtsFlags.GranFlags.Costs.fetchtime =
1005 RtsFlags.GranFlags.Costs.additional_latency =
1006 RtsFlags.GranFlags.Costs.gunblocktime =
1007 RtsFlags.GranFlags.Costs.lunblocktime =
1008 RtsFlags.GranFlags.Costs.threadcreatetime =
1009 RtsFlags.GranFlags.Costs.threadqueuetime =
1010 RtsFlags.GranFlags.Costs.threadscheduletime =
1011 RtsFlags.GranFlags.Costs.threaddescheduletime =
1012 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1014 RtsFlags.GranFlags.Costs.mpacktime =
1015 RtsFlags.GranFlags.Costs.munpacktime = 0;
1017 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1019 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1020 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1021 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1022 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1023 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1024 # if defined(GRAN_CHECK) && defined(GRAN)
1025 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1030 /* Communication and task creation cost parameters */
1031 switch(rts_argv[arg][2]) {
1033 IgnoreYields = rtsTrue; // HWL HACK
1037 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1041 if (rts_argv[arg][3] != '\0')
1043 RtsFlags.GranFlags.Costs.gunblocktime =
1044 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1045 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1048 RtsFlags.GranFlags.Costs.latency = LATENCY;
1052 if (rts_argv[arg][3] != '\0')
1053 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1055 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1059 if (rts_argv[arg][3] != '\0')
1060 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1062 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1066 if (rts_argv[arg][3] != '\0')
1067 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1069 RtsFlags.GranFlags.Costs.mtidytime = 0;
1073 if (rts_argv[arg][3] != '\0')
1074 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1076 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1080 if (rts_argv[arg][3] != '\0')
1081 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1083 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1087 if (rts_argv[arg][3] != '\0')
1088 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1090 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1094 if (rts_argv[arg][3] != '\0')
1095 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1097 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1100 /* Thread-related metrics */
1102 if (rts_argv[arg][3] != '\0')
1103 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1105 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1109 if (rts_argv[arg][3] != '\0')
1110 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1112 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1116 if (rts_argv[arg][3] != '\0')
1117 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1119 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1121 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1122 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1126 if (rts_argv[arg][3] != '\0')
1127 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1129 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1131 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1132 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1135 /* Instruction Cost Metrics */
1137 if (rts_argv[arg][3] != '\0')
1138 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1140 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1144 if (rts_argv[arg][3] != '\0')
1145 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1147 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1151 if (rts_argv[arg][3] != '\0')
1152 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1154 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1158 if (rts_argv[arg][3] != '\0')
1159 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1161 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1165 if (rts_argv[arg][3] != '\0')
1166 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1168 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1172 if (rts_argv[arg][3] != '\0')
1173 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1175 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1179 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1180 if (rts_argv[arg][3] != '\0')
1181 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1183 RtsFlags.GranFlags.FetchStrategy = 2;
1184 if (RtsFlags.GranFlags.FetchStrategy == 0)
1185 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1188 case 'K': /* sort overhead (per elem in spark list) */
1189 if (rts_argv[arg][3] != '\0')
1190 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1192 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1193 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1194 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1197 case 'O': /* sort overhead (per elem in spark list) */
1198 if (rts_argv[arg][3] != '\0')
1199 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1201 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1202 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1203 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1206 /* General Parameters */
1208 if (rts_argv[arg][3] != '\0')
1210 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1211 if (RtsFlags.GranFlags.proc==0) {
1212 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1213 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1214 RtsFlags.GranFlags.proc < 1)
1216 fprintf(stderr,"setupRtsFlags: no more than %u processors
1223 RtsFlags.GranFlags.proc = MAX_PROC;
1227 RtsFlags.GranFlags.Fishing = rtsTrue;
1228 if (rts_argv[arg][3] != '\0')
1229 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1231 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1235 if (rts_argv[arg][3] != '\0')
1236 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1238 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1242 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1243 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1247 fprintf(stderr,"Bulk fetching enabled.\n");
1248 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1252 fprintf(stderr,"Thread migration enabled.\n");
1253 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1257 fprintf(stderr,"Fair Scheduling enabled.\n");
1258 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1262 fprintf(stderr,"Priority Scheduling enabled.\n");
1263 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1267 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1268 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1272 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1276 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1280 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1284 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1288 /* format is -bP<c> where <c> is one char describing kind of profile */
1289 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1290 switch(rts_argv[arg][3]) {
1291 case '\0': break; // nothing special, just an ordinary profile
1292 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1294 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1296 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1298 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1300 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1302 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1304 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1309 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1313 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1316 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1317 if (rts_argv[arg][3] != '\0') {
1320 arg0 = rts_argv[arg]+3;
1321 if ((tmp = strstr(arg0,","))==NULL) {
1322 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1323 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1326 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1327 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1328 fprintf(stderr,"SparkPriority: %u.\n",
1329 RtsFlags.GranFlags.SparkPriority);
1330 fprintf(stderr,"SparkPriority2:%u.\n",
1331 RtsFlags.GranFlags.SparkPriority2);
1332 if (RtsFlags.GranFlags.SparkPriority2 <
1333 RtsFlags.GranFlags.SparkPriority) {
1334 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1335 RtsFlags.GranFlags.SparkPriority2,
1336 RtsFlags.GranFlags.SparkPriority);
1340 /* plain pri spark is now invoked with -bX
1341 RtsFlags.GranFlags.DoPrioritySparking = 1;
1342 fprintf(stderr,"PrioritySparking.\n");
1348 if (rts_argv[arg][3] != '\0') {
1349 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1351 RtsFlags.GranFlags.ThunksToPack = 1;
1353 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1354 RtsFlags.GranFlags.ThunksToPack);
1358 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1359 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1362 /* The following class of options contains eXperimental */
1363 /* features in connection with exploiting granularity */
1364 /* information. I.e. if -bY is chosen these options */
1365 /* tell the RTS what to do with the supplied info --HWL */
1368 if (rts_argv[arg][3] != '\0') {
1369 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1371 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1373 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1374 RtsFlags.GranFlags.packBufferSize_internal);
1378 switch(rts_argv[arg][3]) {
1381 RtsFlags.GranFlags.DoPrioritySparking = 1;
1382 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1383 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1384 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1385 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1389 RtsFlags.GranFlags.DoPrioritySparking = 1;
1390 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1391 RtsFlags.GranFlags.InversePriorities++;
1395 RtsFlags.GranFlags.DoPrioritySparking = 1;
1396 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1397 RtsFlags.GranFlags.RandomPriorities++;
1401 RtsFlags.GranFlags.DoPrioritySparking = 1;
1402 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1403 RtsFlags.GranFlags.IgnorePriorities++;
1407 bad_option( rts_argv[arg] );
1413 switch(rts_argv[arg][3]) {
1416 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1417 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1421 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1425 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1429 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1433 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1434 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1438 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1442 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1446 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1450 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1454 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1458 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1462 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1466 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1467 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1471 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1475 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1479 bad_option( rts_argv[arg] );
1484 # if defined(GRAN_CHECK) && defined(GRAN)
1486 switch(rts_argv[arg][3]) {
1487 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1488 if (rts_argv[arg][4] != '\0') {
1489 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1490 fprintf(stderr,"Pack buffer size: %d\n",
1491 RtsFlags.GranFlags.packBufferSize);
1493 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1499 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1500 /* hack warning: interpret the flags as a binary number */
1501 nat n = decode(rts_argv[arg]+3);
1502 set_GranSim_debug_options(n);
1505 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1506 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1509 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1510 fprintf(stderr, "Valid GranSim debug options are:\n");
1511 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1512 bad_option( rts_argv[arg] );
1513 } else { // flag found; now set it
1514 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1520 case 'e': /* event trace; also -bD1 */
1521 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1522 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1523 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1526 case 'E': /* event statistics; also -bD2 */
1527 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1528 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1529 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1532 case 'f': /* thunkStealing; also -bD4 */
1533 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1534 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1535 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1538 case 'z': /* blockOnFetch; also -bD8 */
1539 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1540 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1541 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1544 case 't': /* blockOnFetch_sanity; also -bD16 */
1545 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1546 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1547 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1550 case 'S': /* priSpark; also -bD32 */
1551 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1552 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1555 case 's': /* priSched; also -bD64 */
1556 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1557 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1560 case 'F': /* findWork; also -bD128 */
1561 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1562 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1565 case 'g': /* globalBlock; also -bD256 */
1566 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1567 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1570 case 'G': /* pack; also -bD512 */
1571 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1572 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1575 case 'P': /* packBuffer; also -bD1024 */
1576 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1577 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1580 case 'o': /* sortedQ; also -bD2048 */
1581 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1582 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1585 case 'r': /* randomSteal; also -bD4096 */
1586 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1587 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1590 case 'q': /* checkSparkQ; also -bD8192 */
1591 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1592 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1595 case ':': /* checkLight; also -bD16384 */
1596 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1597 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1600 case 'b': /* bq; also -bD32768 */
1601 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1602 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1605 case 'd': /* all options turned on */
1606 fprintf(stderr,"DEBUG: all options turned on.\n");
1607 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1608 /* RtsFlags.GranFlags.Debug |= 0x40; */
1612 /* RtsFlags.GranFlags.Debug = 1; */
1618 # endif /* GRAN_CHECK */
1620 bad_option( rts_argv[arg] );
1626 Interpret n as a binary number masking GranSim debug options and set the
1627 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1630 set_GranSim_debug_options(nat n) {
1633 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1635 fprintf(stderr, gran_debug_opts_strs[i]);
1637 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1638 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1639 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1640 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1641 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1642 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1643 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1644 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1645 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1646 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1647 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1648 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1649 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1650 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1651 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1652 default: barf("set_GranSim_debug_options: only %d debug options expected");
1658 Print one line explanation for each of the GranSim debug options specified
1662 help_GranSim_debug_options(nat n) {
1665 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1667 fprintf(stderr, gran_debug_opts_strs[i]);
1673 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1676 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
1677 belch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
1681 /* Communication and task creation cost parameters */
1682 switch(rts_argv[arg][2]) {
1683 case 'e': /* -qe<n> ... allow <n> local sparks */
1684 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1685 RtsFlags.ParFlags.maxLocalSparks
1686 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1688 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1689 belch("setupRtsFlags: bad value for -e\n");
1693 IF_PAR_DEBUG(verbose,
1694 belch("-qe<n>: max %d local sparks",
1695 RtsFlags.ParFlags.maxLocalSparks));
1699 if (rts_argv[arg][3] != '\0') {
1700 RtsFlags.ParFlags.maxThreads
1701 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1703 belch("setupRtsFlags: missing size for -qt\n");
1706 IF_PAR_DEBUG(verbose,
1707 belch("-qt<n>: max %d threads",
1708 RtsFlags.ParFlags.maxThreads));
1712 if (rts_argv[arg][3] != '\0')
1713 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1715 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1717 IF_PAR_DEBUG(verbose,
1718 belch("-qf<n>: max %d fishes sent out at one time",
1719 RtsFlags.ParFlags.maxFishes));
1723 if (rts_argv[arg][3] != '\0') {
1724 RtsFlags.ParFlags.fishDelay
1725 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1727 belch("setupRtsFlags: missing fish delay time for -qF\n");
1730 IF_PAR_DEBUG(verbose,
1731 belch("-qF<n>: fish delay time %d us",
1732 RtsFlags.ParFlags.fishDelay));
1736 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1737 IF_PAR_DEBUG(verbose,
1738 belch("-qO: output disabled"));
1741 case 'g': /* -qg<n> ... globalisation scheme */
1742 if (rts_argv[arg][3] != '\0') {
1743 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
1745 belch("setupRtsFlags: missing identifier for globalisation scheme (for -qg)\n");
1748 IF_PAR_DEBUG(verbose,
1749 belch("-qg<n>: globalisation scheme set to %d",
1750 RtsFlags.ParFlags.globalising));
1753 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
1754 if (rts_argv[arg][3] != '\0') {
1755 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
1757 belch("setupRtsFlags: missing number of thunks per packet (for -qh)\n");
1760 IF_PAR_DEBUG(verbose,
1761 belch("-qh<n>: thunks per packet set to %d",
1762 RtsFlags.ParFlags.thunksToPack));
1765 case 'P': /* -qP for writing a log file */
1766 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1767 /* same encoding as in GranSim after -bP */
1768 switch(rts_argv[arg][3]) {
1769 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1770 break; // nothing special, just an ordinary profile
1771 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1772 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1774 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1776 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1778 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1780 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1783 # if defined(PAR_TICKY)
1784 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1786 fprintf(stderr,"-qPg is only possible for a PAR_TICKY RTS, which this is not");
1787 stg_exit(EXIT_FAILURE);
1790 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1792 IF_PAR_DEBUG(verbose,
1793 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1794 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1797 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1798 if (rts_argv[arg][3] != '\0') {
1799 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1801 belch("setupRtsFlags: missing size of PackBuffer (for -qQ)\n");
1804 IF_PAR_DEBUG(verbose,
1805 belch("-qQ<n>: pack buffer size set to %d",
1806 RtsFlags.ParFlags.packBufferSize));
1810 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
1811 IF_PAR_DEBUG(verbose,
1812 belch("-qR: fair-ish scheduling"));
1817 if (rts_argv[arg][3] != '\0') {
1818 RtsFlags.ParFlags.wait
1819 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1821 RtsFlags.ParFlags.wait = 1000;
1823 IF_PAR_DEBUG(verbose,
1824 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1825 RtsFlags.ParFlags.wait));
1828 case 'D': /* -qD ... all the debugging options */
1829 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1830 /* hack warning: interpret the flags as a binary number */
1831 nat n = decode(rts_argv[arg]+3);
1832 set_par_debug_options(n);
1835 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1836 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1839 if (i==MAX_PAR_DEBUG_OPTION+1) {
1840 fprintf(stderr, "Valid GUM debug options are:\n");
1841 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1842 bad_option( rts_argv[arg] );
1843 } else { // flag found; now set it
1844 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1850 belch("Unknown option -q%c (%d opts in total)",
1851 rts_argv[arg][2], *rts_argc);
1857 Interpret n as a binary number masking Par debug options and set the
1858 correxponding option. See par_debug_opts_strs for explanations of the flags.
1861 set_par_debug_options(nat n) {
1864 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1866 fprintf(stderr, par_debug_opts_strs[i]);
1868 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1869 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
1870 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1871 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1872 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1873 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1874 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1875 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1876 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1877 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
1878 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
1879 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1880 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
1881 default: barf("set_par_debug_options: only %d debug options expected",
1882 MAX_PAR_DEBUG_OPTION);
1888 Print one line explanation for each of the GranSim debug options specified
1892 help_par_debug_options(nat n) {
1895 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1897 fprintf(stderr, par_debug_opts_strs[i]);
1904 set_debug_options(nat n) {
1907 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1909 fprintf(stderr, debug_opts_strs[i]);
1911 case 0: RtsFlags.DebugFlags.scheduler = rtsTrue; break;
1912 case 1: RtsFlags.DebugFlags.evaluator = rtsTrue; break;
1913 case 2: RtsFlags.DebugFlags.codegen = rtsTrue; break;
1914 case 3: RtsFlags.DebugFlags.weak = rtsTrue; break;
1915 case 4: RtsFlags.DebugFlags.gccafs = rtsTrue; break;
1916 case 5: RtsFlags.DebugFlags.gc = rtsTrue; break;
1917 case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1918 case 7: RtsFlags.DebugFlags.sanity = rtsTrue; break;
1919 case 8: RtsFlags.DebugFlags.stable = rtsTrue; break;
1920 case 9: RtsFlags.DebugFlags.prof = rtsTrue; break;
1921 case 10: RtsFlags.DebugFlags.gran = rtsTrue; break;
1922 case 11: RtsFlags.DebugFlags.par = rtsTrue; break;
1923 default: barf("set_debug_options: only %d debug options expected",
1930 help_debug_options(nat n) {
1933 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1935 fprintf(stderr, debug_opts_strs[i]);
1939 //@node Aux fcts, , GranSim specific options
1940 //@subsection Aux fcts
1942 static FILE * /* return NULL on error */
1945 int argc, char *argv[],
1946 int rts_argc, char *rts_argv[],
1947 const char *FILENAME_FMT)
1951 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
1953 else if (rts_argv[arg][2] != '\0') /* stats file specified */
1954 f = fopen(rts_argv[arg]+2,"w");
1956 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1957 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1958 f = fopen(stats_filename,"w");
1961 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
1963 /* Write argv and rtsv into start of stats file */
1965 for(count = 0; count < argc; count++)
1966 fprintf(f, "%s ", argv[count]);
1967 fprintf(f, "+RTS ");
1968 for(count = 0; count < rts_argc; count++)
1969 fprintf(f, "%s ", rts_argv[count]);
1977 decode(const char *s)
1988 if (c == 'g' || c == 'G')
1989 m *= 1000*1000*1000; /* UNchecked! */
1990 else if (c == 'm' || c == 'M')
1991 m *= 1000*1000; /* We do not use powers of 2 (1024) */
1992 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
1993 m *= 1000; /* a direct-mapped cache. */
1994 else if (c == 'w' || c == 'W')
2001 bad_option(const char *s)
2003 prog_belch("bad RTS option: %s", s);
2004 stg_exit(EXIT_FAILURE);