1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.37 2001/03/14 11:18:18 sewardj 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 (-qDt, -qD2): trace; trace messages.\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"
152 /* one character codes for the available debug options */
153 char par_debug_opts_flags[] = {
154 'v', 't', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p'
157 /* prefix strings printed with the debug messages of the corresponding type */
158 char *par_debug_opts_prefix[] = {
175 //@node Static function decls, Command-line option parsing routines, Constants
176 //@subsection Static function decls
178 /* -----------------------------------------------------------------------------
179 Static function decls
180 -------------------------------------------------------------------------- */
182 static FILE * /* return NULL on error */
185 int argc, char *argv[],
186 int rts_argc, char *rts_argv[],
187 const char *FILENAME_FMT);
189 static I_ decode(const char *s);
190 static void bad_option(const char *s);
193 static void enable_GranSimLight(void);
194 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
195 static void set_GranSim_debug_options(nat n);
196 static void help_GranSim_debug_options(nat n);
198 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
199 static void set_par_debug_options(nat n);
200 static void help_par_debug_options(nat n);
203 static void set_debug_options(nat n);
204 static void help_debug_options(nat n);
207 //@node Command-line option parsing routines, GranSim specific options, Static function decls
208 //@subsection Command-line option parsing routines
210 /* -----------------------------------------------------------------------------
211 * Command-line option parsing routines.
212 * ---------------------------------------------------------------------------*/
214 void initRtsFlagsDefaults(void)
216 RtsFlags.GcFlags.statsFile = NULL;
217 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
219 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
220 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
222 RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE;
223 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
224 RtsFlags.GcFlags.maxHeapSize = (64 * 1024 * 1024) / BLOCK_SIZE;
225 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
226 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
227 RtsFlags.GcFlags.oldGenFactor = 2;
228 RtsFlags.GcFlags.generations = 2;
229 RtsFlags.GcFlags.steps = 2;
231 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
232 #ifdef RTS_GTK_FRONTPANEL
233 RtsFlags.GcFlags.frontpanel = rtsFalse;
236 #if defined(PROFILING) || defined(PAR)
237 RtsFlags.CcFlags.doCostCentres = 0;
238 #endif /* PROFILING or PAR */
241 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
242 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
243 RtsFlags.ProfFlags.modSelector = NULL;
244 RtsFlags.ProfFlags.descrSelector = NULL;
245 RtsFlags.ProfFlags.typeSelector = NULL;
246 RtsFlags.ProfFlags.ccSelector = NULL;
248 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
251 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
254 RtsFlags.ParFlags.nNodes = 1;
258 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
259 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
260 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
261 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
262 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
263 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
265 RtsFlags.ParFlags.outputDisabled = rtsFalse;
266 RtsFlags.ParFlags.packBufferSize = 1024;
268 RtsFlags.ParFlags.maxThreads = 1024;
269 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
270 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
273 #if defined(PAR) || defined(SMP)
274 RtsFlags.ParFlags.maxLocalSparks = 4096;
275 #endif /* PAR || SMP */
278 /* ToDo: check defaults for GranSim and GUM */
279 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
280 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
282 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
283 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
284 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
285 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
286 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
287 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
288 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
289 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
291 RtsFlags.GranFlags.packBufferSize = 1024;
292 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
294 RtsFlags.GranFlags.proc = MAX_PROC;
295 RtsFlags.GranFlags.Fishing = rtsFalse;
296 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
297 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
298 RtsFlags.GranFlags.Light = rtsFalse;
300 RtsFlags.GranFlags.Costs.latency = LATENCY;
301 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
302 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
303 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
304 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
305 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
306 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
307 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
309 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
310 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
311 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
312 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
313 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
315 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
316 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
317 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
318 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
319 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
321 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
323 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
324 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
326 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
327 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
328 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
329 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
330 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
331 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
332 RtsFlags.GranFlags.FetchStrategy = 2;
333 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
334 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
335 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
336 RtsFlags.GranFlags.SparkPriority = 0;
337 RtsFlags.GranFlags.SparkPriority2 = 0;
338 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
339 RtsFlags.GranFlags.InversePriorities = rtsFalse;
340 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
341 RtsFlags.GranFlags.ThunksToPack = 0;
342 RtsFlags.GranFlags.RandomSteal = rtsTrue;
346 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
347 RtsFlags.TickyFlags.tickyFile = NULL;
354 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
356 " +RTS Indicates run time system options follow",
357 " -RTS Indicates program arguments follow",
358 " --RTS Indicates that ALL subsequent arguments will be given to the",
359 " program (including any of these RTS flags)",
361 "The following run time system options are available:",
363 " -? Prints this message and exits; the program is not executed",
365 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
366 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
368 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
369 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
370 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
371 " -m<n>% Minimum % of heap which must be available (default 3%)",
372 " -G<n> Number of generations (default: 2)",
373 " -T<n> Number of steps in younger generations (default: 2)",
375 " -t<file> One-line GC statistics (default file: <program>.stat)",
376 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
377 " -S<file> Detailed GC statistics",
378 #ifdef RTS_GTK_FRONTPANEL
379 " -f Display front panel (requires X11 & GTK+)",
383 " -Z Don't squeeze out update frames on stack overflow",
384 " -B Sound the bell at the start of each garbage collection",
385 #if defined(PROFILING) || defined(PAR)
387 " -px Time/allocation profile (XML) (output file <program>.prof)",
388 " -p<sort> Time/allocation profile (output file <program>.prof)",
389 " sort: T = time (default), A = alloc, C = cost centre label",
390 " -P<sort> More detailed Time/Allocation profile",
392 # if defined(PROFILING)
394 " -hx Heap residency profile (XML) (output file <program>.prof)",
395 " -h<break-down> Heap residency profile (text) (output file <program>.prof)",
396 " break-down: C = cost centre stack (default), M = module",
397 " D = closure description, Y = type description",
398 " A subset of closures may be selected thusly:",
399 " -hc{cc, cc ...} specific cost centre(s) (NOT STACKS!)",
400 " -hm{mod,mod...} all cost centres from the specified modules(s)",
401 " -hd{des,des...} closures with specified closure descriptions",
402 " -hy{typ,typ...} closures with specified type descriptions",
404 " -xc Show current cost centre stack on raising an exception",
406 #endif /* PROFILING or PAR */
407 #if !defined(PROFILING) && defined(DEBUG)
409 " -h<break-down> Debugging Heap residency profile",
410 " (output file <program>.hp)",
411 " break-down: L = closure label (default)",
412 " T = closure type (constructor, thunk etc.)",
415 #if defined(TICKY_TICKY)
416 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
420 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
421 /* NB: the -N<n> is implemented by the driver!! */
423 " -C<secs> Context-switch interval in seconds",
424 " (0 or no argument means switch as often as possible)",
425 " the default is .02 sec; resolution is .02 sec",
427 " -N<n> Use <n> OS threads (default: 1)",
429 #if defined(SMP) || defined(PAR)
430 " -e<size> Size of spark pools (default 100)",
433 " -t<num> Set maximum number of advisory threads per PE (default 32)",
434 " -qP Enable activity profile (output files in ~/<program>*.gr)",
435 " -qQ<size> Set pack-buffer size (default: 1024)",
436 " -qd Turn on PVM-ish debugging",
437 " -qO Disable output for performance measurement",
439 #if defined(SMP) || defined(PAR)
440 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
443 " -d Turn on PVM-ish debugging",
444 " -O Disable output for performance measurement",
446 #if defined(GRAN) /* ToDo: fill in decent Docu here */
447 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
450 "Other RTS options may be available for programs compiled a different way.",
451 "The GHC User's Guide has full details.",
456 static __inline__ rtsBool
457 strequal(const char *a, const char * b)
459 return(strcmp(a, b) == 0);
463 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
465 rtsBool error = rtsFalse;
470 /* Remove directory from argv[0] -- default files in current directory */
472 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
473 strcpy(argv[0], last_slash+1);
475 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
476 /* argv[0] must be PGM argument -- leave in argv */
484 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
485 if (strequal("+RTS", argv[arg])) {
488 else if (strequal("-RTS", argv[arg])) {
491 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
492 rts_argv[(*rts_argc)++] = argv[arg];
494 else if (mode == PGM) {
495 argv[(*argc)++] = argv[arg];
498 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
501 if (arg < total_arg) {
502 /* arg must be --RTS; process remaining program arguments */
503 while (++arg < total_arg) {
504 argv[(*argc)++] = argv[arg];
507 argv[*argc] = (char *) 0;
508 rts_argv[*rts_argc] = (char *) 0;
510 /* Process RTS (rts_argv) part: mainly to determine statsfile */
512 for (arg = 0; arg < *rts_argc; arg++) {
513 if (rts_argv[arg][0] != '-') {
515 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
519 switch(rts_argv[arg][1]) {
521 /* process: general args, then PROFILING-only ones,
522 then CONCURRENT-only, PARallel-only, GRAN-only,
523 TICKY-only (same order as defined in RtsFlags.lh);
524 within those groups, mostly in case-insensitive
526 Final group is x*, which allows for more options.
530 # define TICKY_BUILD_ONLY(x) x
532 # define TICKY_BUILD_ONLY(x) \
533 prog_belch("GHC not built for: ticky-ticky stats"); \
537 #if defined(PROFILING)
538 # define COST_CENTRE_USING_BUILD_ONLY(x) x
540 # define COST_CENTRE_USING_BUILD_ONLY(x) \
541 prog_belch("GHC not built for: -prof or -parallel"); \
546 # define PROFILING_BUILD_ONLY(x) x
548 # define PROFILING_BUILD_ONLY(x) \
549 prog_belch("GHC not built for: -prof"); \
554 # define SMP_BUILD_ONLY(x) x
556 # define SMP_BUILD_ONLY(x) \
557 prog_belch("GHC not built for: -parallel"); \
562 # define PAR_BUILD_ONLY(x) x
564 # define PAR_BUILD_ONLY(x) \
565 prog_belch("GHC not built for: -parallel"); \
569 #if defined(SMP) || defined(PAR)
570 # define PAR_OR_SMP_BUILD_ONLY(x) x
572 # define PAR_OR_SMP_BUILD_ONLY(x) \
573 prog_belch("GHC not built for: -parallel or -smp"); \
578 # define GRAN_BUILD_ONLY(x) x
580 # define GRAN_BUILD_ONLY(x) \
581 prog_belch("GHC not built for: -gransim"); \
585 /* =========== GENERAL ========================== */
591 RtsFlags.GcFlags.minAllocAreaSize
592 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
593 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
594 bad_option(rts_argv[arg]);
599 RtsFlags.GcFlags.ringBell = rtsTrue;
603 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
605 if (RtsFlags.GcFlags.oldGenFactor < 0)
606 bad_option( rts_argv[arg] );
611 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
612 /* hack warning: interpret the flags as a binary number */
613 nat n = decode(rts_argv[arg]+2);
614 set_debug_options(n);
620 RtsFlags.GcFlags.maxStkSize =
621 decode(rts_argv[arg]+2) / sizeof(W_);
623 if (RtsFlags.GcFlags.maxStkSize == 0)
624 bad_option( rts_argv[arg] );
628 RtsFlags.GcFlags.initialStkSize =
629 decode(rts_argv[arg]+2) / sizeof(W_);
631 if (RtsFlags.GcFlags.initialStkSize == 0)
632 bad_option( rts_argv[arg] );
636 RtsFlags.GcFlags.maxHeapSize =
637 decode(rts_argv[arg]+2) / BLOCK_SIZE;
638 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
640 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
641 bad_option(rts_argv[arg]);
646 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
648 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
649 RtsFlags.GcFlags.pcFreeHeap > 100)
650 bad_option( rts_argv[arg] );
654 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
655 if (RtsFlags.GcFlags.generations < 1) {
656 bad_option(rts_argv[arg]);
661 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
662 if (RtsFlags.GcFlags.steps < 1) {
663 bad_option(rts_argv[arg]);
668 RtsFlags.GcFlags.heapSizeSuggestion =
669 decode(rts_argv[arg]+2) / BLOCK_SIZE;
671 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
672 bad_option(rts_argv[arg]);
676 #ifdef RTS_GTK_FRONTPANEL
678 RtsFlags.GcFlags.frontpanel = rtsTrue;
683 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
687 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
691 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
696 /* Opening all those files would almost certainly fail... */
697 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
698 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
700 RtsFlags.GcFlags.statsFile
701 = open_stats_file(arg, *argc, argv,
702 *rts_argc, rts_argv, STAT_FILENAME_FMT);
704 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
709 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
712 /* =========== PROFILING ========================== */
714 case 'P': /* detailed cost centre profiling (time/alloc) */
715 COST_CENTRE_USING_BUILD_ONLY(
716 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
718 case 'p': /* cost centre profiling (time/alloc) */
719 COST_CENTRE_USING_BUILD_ONLY(
720 switch (rts_argv[arg][2]) {
722 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
725 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
730 case 'h': /* serial heap profile */
731 #if !defined(PROFILING) && defined(DEBUG)
732 switch (rts_argv[arg][2]) {
735 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
738 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
741 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
745 PROFILING_BUILD_ONLY(
746 switch (rts_argv[arg][2]) {
749 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
752 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
755 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
758 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
760 case 'c': /* cost centre label select */
761 case 'm': /* cost centre module select */
762 case 'd': /* closure descr select */
763 case 'y': /* closure type select */
764 {char *left = strchr(rts_argv[arg], '{');
765 char *right = strrchr(rts_argv[arg], '}');
766 if (! left || ! right ||
767 strrchr(rts_argv[arg], '{') != left ||
768 strchr(rts_argv[arg], '}') != right) {
770 "Invalid heap profiling selection bracketing\n %s\n",
775 switch (rts_argv[arg][2]) {
776 case 'c': /* cost centre label select */
777 RtsFlags.ProfFlags.ccSelector = left + 1;
779 case 'm': /* cost centre module select */
780 RtsFlags.ProfFlags.modSelector = left + 1;
782 case 'd': /* closure descr select */
783 RtsFlags.ProfFlags.descrSelector = left + 1;
785 case 'y': /* closure type select */
786 RtsFlags.ProfFlags.typeSelector = left + 1;
793 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
801 /* =========== CONCURRENT ========================= */
802 case 'C': /* context switch interval */
803 if (rts_argv[arg][2] == '\0')
804 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
808 /* Convert to milliseconds */
809 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
810 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
811 if (cst != 0 && cst < CS_MIN_MILLISECS)
812 cst = CS_MIN_MILLISECS;
814 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
821 if (rts_argv[arg][2] != '\0') {
822 RtsFlags.ParFlags.nNodes
823 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
824 if (RtsFlags.ParFlags.nNodes <= 0) {
825 prog_belch("bad value for -N");
831 /* =========== PARALLEL =========================== */
833 PAR_OR_SMP_BUILD_ONLY(
834 if (rts_argv[arg][2] != '\0') {
835 RtsFlags.ParFlags.maxLocalSparks
836 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
837 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
838 prog_belch("bad value for -e");
846 process_par_option(arg, rts_argc, rts_argv, &error);
849 /* =========== GRAN =============================== */
853 process_gran_option(arg, rts_argc, rts_argv, &error);
856 /* =========== TICKY ============================== */
858 case 'r': /* Basic profiling stats */
861 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
862 RtsFlags.TickyFlags.tickyFile
863 = open_stats_file(arg, *argc, argv,
864 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
866 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
869 /* =========== EXTENDED OPTIONS =================== */
871 case 'x': /* Extend the argument space */
872 switch(rts_argv[arg][2]) {
874 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
878 case 'c': /* Debugging tool: show current cost centre on an exception */
879 PROFILING_BUILD_ONLY(
880 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
883 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
886 prog_belch("unknown RTS option: %s",rts_argv[arg]);
890 break; /* defensive programming */
892 /* =========== OH DEAR ============================ */
894 prog_belch("unknown RTS option: %s",rts_argv[arg]);
904 for (p = usage_text; *p; p++)
906 stg_exit(EXIT_FAILURE);
912 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
913 //@subsection GranSim specific options
916 enable_GranSimLight(void) {
918 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
919 RtsFlags.GranFlags.Light=rtsTrue;
920 RtsFlags.GranFlags.Costs.latency =
921 RtsFlags.GranFlags.Costs.fetchtime =
922 RtsFlags.GranFlags.Costs.additional_latency =
923 RtsFlags.GranFlags.Costs.gunblocktime =
924 RtsFlags.GranFlags.Costs.lunblocktime =
925 RtsFlags.GranFlags.Costs.threadcreatetime =
926 RtsFlags.GranFlags.Costs.threadqueuetime =
927 RtsFlags.GranFlags.Costs.threadscheduletime =
928 RtsFlags.GranFlags.Costs.threaddescheduletime =
929 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
931 RtsFlags.GranFlags.Costs.mpacktime =
932 RtsFlags.GranFlags.Costs.munpacktime = 0;
934 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
935 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
936 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
937 /* FetchStrategy is irrelevant in GrAnSim-Light */
939 /* GrAnSim Light often creates an abundance of parallel threads,
940 each with its own stack etc. Therefore, it's in general a good
941 idea to use small stack chunks (use the -o<size> option to
944 // RtsFlags.ConcFlags.stkChunkSize = 100;
946 RtsFlags.GranFlags.proc = 1;
950 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
952 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
955 /* or a ridiculously idealised simulator */
956 if(strcmp((rts_argv[arg]+2),"oring")==0) {
957 RtsFlags.GranFlags.Costs.latency =
958 RtsFlags.GranFlags.Costs.fetchtime =
959 RtsFlags.GranFlags.Costs.additional_latency =
960 RtsFlags.GranFlags.Costs.gunblocktime =
961 RtsFlags.GranFlags.Costs.lunblocktime =
962 RtsFlags.GranFlags.Costs.threadcreatetime =
963 RtsFlags.GranFlags.Costs.threadqueuetime =
964 RtsFlags.GranFlags.Costs.threadscheduletime =
965 RtsFlags.GranFlags.Costs.threaddescheduletime =
966 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
968 RtsFlags.GranFlags.Costs.mpacktime =
969 RtsFlags.GranFlags.Costs.munpacktime = 0;
971 RtsFlags.GranFlags.Costs.arith_cost =
972 RtsFlags.GranFlags.Costs.float_cost =
973 RtsFlags.GranFlags.Costs.load_cost =
974 RtsFlags.GranFlags.Costs.store_cost =
975 RtsFlags.GranFlags.Costs.branch_cost = 0;
977 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
979 /* ++RtsFlags.GranFlags.DoFairSchedule; */
980 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
981 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
982 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
986 /* or a somewhat idealised simulator */
987 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
988 RtsFlags.GranFlags.Costs.latency =
989 RtsFlags.GranFlags.Costs.fetchtime =
990 RtsFlags.GranFlags.Costs.additional_latency =
991 RtsFlags.GranFlags.Costs.gunblocktime =
992 RtsFlags.GranFlags.Costs.lunblocktime =
993 RtsFlags.GranFlags.Costs.threadcreatetime =
994 RtsFlags.GranFlags.Costs.threadqueuetime =
995 RtsFlags.GranFlags.Costs.threadscheduletime =
996 RtsFlags.GranFlags.Costs.threaddescheduletime =
997 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
999 RtsFlags.GranFlags.Costs.mpacktime =
1000 RtsFlags.GranFlags.Costs.munpacktime = 0;
1002 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1004 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1005 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1006 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1007 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1008 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1009 # if defined(GRAN_CHECK) && defined(GRAN)
1010 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1015 /* Communication and task creation cost parameters */
1016 switch(rts_argv[arg][2]) {
1018 IgnoreYields = rtsTrue; // HWL HACK
1022 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1026 if (rts_argv[arg][3] != '\0')
1028 RtsFlags.GranFlags.Costs.gunblocktime =
1029 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1030 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1033 RtsFlags.GranFlags.Costs.latency = LATENCY;
1037 if (rts_argv[arg][3] != '\0')
1038 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1040 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1044 if (rts_argv[arg][3] != '\0')
1045 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1047 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1051 if (rts_argv[arg][3] != '\0')
1052 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1054 RtsFlags.GranFlags.Costs.mtidytime = 0;
1058 if (rts_argv[arg][3] != '\0')
1059 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1061 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1065 if (rts_argv[arg][3] != '\0')
1066 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1068 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1072 if (rts_argv[arg][3] != '\0')
1073 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1075 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1079 if (rts_argv[arg][3] != '\0')
1080 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1082 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1085 /* Thread-related metrics */
1087 if (rts_argv[arg][3] != '\0')
1088 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1090 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1094 if (rts_argv[arg][3] != '\0')
1095 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1097 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1101 if (rts_argv[arg][3] != '\0')
1102 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1104 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1106 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1107 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1111 if (rts_argv[arg][3] != '\0')
1112 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1114 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1116 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1117 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1120 /* Instruction Cost Metrics */
1122 if (rts_argv[arg][3] != '\0')
1123 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1125 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1129 if (rts_argv[arg][3] != '\0')
1130 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1132 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1136 if (rts_argv[arg][3] != '\0')
1137 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1139 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1143 if (rts_argv[arg][3] != '\0')
1144 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1146 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1150 if (rts_argv[arg][3] != '\0')
1151 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1153 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1157 if (rts_argv[arg][3] != '\0')
1158 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1160 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1164 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1165 if (rts_argv[arg][3] != '\0')
1166 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1168 RtsFlags.GranFlags.FetchStrategy = 2;
1169 if (RtsFlags.GranFlags.FetchStrategy == 0)
1170 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1173 case 'K': /* sort overhead (per elem in spark list) */
1174 if (rts_argv[arg][3] != '\0')
1175 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1177 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1178 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1179 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1182 case 'O': /* sort overhead (per elem in spark list) */
1183 if (rts_argv[arg][3] != '\0')
1184 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1186 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1187 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1188 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1191 /* General Parameters */
1193 if (rts_argv[arg][3] != '\0')
1195 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1196 if (RtsFlags.GranFlags.proc==0) {
1197 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1198 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1199 RtsFlags.GranFlags.proc < 1)
1201 fprintf(stderr,"setupRtsFlags: no more than %u processors
1208 RtsFlags.GranFlags.proc = MAX_PROC;
1212 RtsFlags.GranFlags.Fishing = rtsTrue;
1213 if (rts_argv[arg][3] != '\0')
1214 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1216 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1220 if (rts_argv[arg][3] != '\0')
1221 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1223 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1227 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1228 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1232 fprintf(stderr,"Bulk fetching enabled.\n");
1233 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1237 fprintf(stderr,"Thread migration enabled.\n");
1238 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1242 fprintf(stderr,"Fair Scheduling enabled.\n");
1243 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1247 fprintf(stderr,"Priority Scheduling enabled.\n");
1248 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1252 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1253 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1257 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1261 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1265 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1269 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1273 /* format is -bP<c> where <c> is one char describing kind of profile */
1274 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1275 switch(rts_argv[arg][3]) {
1276 case '\0': break; // nothing special, just an ordinary profile
1277 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1279 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1281 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1283 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1285 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1287 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1289 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1294 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1298 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1301 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1302 if (rts_argv[arg][3] != '\0') {
1305 arg0 = rts_argv[arg]+3;
1306 if ((tmp = strstr(arg0,","))==NULL) {
1307 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1308 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1311 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1312 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1313 fprintf(stderr,"SparkPriority: %u.\n",
1314 RtsFlags.GranFlags.SparkPriority);
1315 fprintf(stderr,"SparkPriority2:%u.\n",
1316 RtsFlags.GranFlags.SparkPriority2);
1317 if (RtsFlags.GranFlags.SparkPriority2 <
1318 RtsFlags.GranFlags.SparkPriority) {
1319 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1320 RtsFlags.GranFlags.SparkPriority2,
1321 RtsFlags.GranFlags.SparkPriority);
1325 /* plain pri spark is now invoked with -bX
1326 RtsFlags.GranFlags.DoPrioritySparking = 1;
1327 fprintf(stderr,"PrioritySparking.\n");
1333 if (rts_argv[arg][3] != '\0') {
1334 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1336 RtsFlags.GranFlags.ThunksToPack = 1;
1338 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1339 RtsFlags.GranFlags.ThunksToPack);
1343 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1344 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1347 /* The following class of options contains eXperimental */
1348 /* features in connection with exploiting granularity */
1349 /* information. I.e. if -bY is chosen these options */
1350 /* tell the RTS what to do with the supplied info --HWL */
1353 if (rts_argv[arg][3] != '\0') {
1354 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1356 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1358 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1359 RtsFlags.GranFlags.packBufferSize_internal);
1363 switch(rts_argv[arg][3]) {
1366 RtsFlags.GranFlags.DoPrioritySparking = 1;
1367 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1368 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1369 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1370 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1374 RtsFlags.GranFlags.DoPrioritySparking = 1;
1375 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1376 RtsFlags.GranFlags.InversePriorities++;
1380 RtsFlags.GranFlags.DoPrioritySparking = 1;
1381 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1382 RtsFlags.GranFlags.RandomPriorities++;
1386 RtsFlags.GranFlags.DoPrioritySparking = 1;
1387 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1388 RtsFlags.GranFlags.IgnorePriorities++;
1392 bad_option( rts_argv[arg] );
1398 switch(rts_argv[arg][3]) {
1401 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1402 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1406 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1410 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1414 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1418 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1419 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1423 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1427 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1431 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1435 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1439 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1443 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1447 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1451 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1452 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1456 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1460 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1464 bad_option( rts_argv[arg] );
1469 # if defined(GRAN_CHECK) && defined(GRAN)
1471 switch(rts_argv[arg][3]) {
1472 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1473 if (rts_argv[arg][4] != '\0') {
1474 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1475 fprintf(stderr,"Pack buffer size: %d\n",
1476 RtsFlags.GranFlags.packBufferSize);
1478 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1484 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1485 /* hack warning: interpret the flags as a binary number */
1486 nat n = decode(rts_argv[arg]+3);
1487 set_GranSim_debug_options(n);
1490 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1491 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1494 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1495 fprintf(stderr, "Valid GranSim debug options are:\n");
1496 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1497 bad_option( rts_argv[arg] );
1498 } else { // flag found; now set it
1499 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1505 case 'e': /* event trace; also -bD1 */
1506 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1507 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1508 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1511 case 'E': /* event statistics; also -bD2 */
1512 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1513 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1514 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1517 case 'f': /* thunkStealing; also -bD4 */
1518 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1519 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1520 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1523 case 'z': /* blockOnFetch; also -bD8 */
1524 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1525 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1526 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1529 case 't': /* blockOnFetch_sanity; also -bD16 */
1530 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1531 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1532 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1535 case 'S': /* priSpark; also -bD32 */
1536 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1537 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1540 case 's': /* priSched; also -bD64 */
1541 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1542 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1545 case 'F': /* findWork; also -bD128 */
1546 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1547 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1550 case 'g': /* globalBlock; also -bD256 */
1551 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1552 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1555 case 'G': /* pack; also -bD512 */
1556 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1557 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1560 case 'P': /* packBuffer; also -bD1024 */
1561 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1562 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1565 case 'o': /* sortedQ; also -bD2048 */
1566 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1567 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1570 case 'r': /* randomSteal; also -bD4096 */
1571 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1572 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1575 case 'q': /* checkSparkQ; also -bD8192 */
1576 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1577 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1580 case ':': /* checkLight; also -bD16384 */
1581 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1582 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1585 case 'b': /* bq; also -bD32768 */
1586 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1587 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1590 case 'd': /* all options turned on */
1591 fprintf(stderr,"DEBUG: all options turned on.\n");
1592 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1593 /* RtsFlags.GranFlags.Debug |= 0x40; */
1597 /* RtsFlags.GranFlags.Debug = 1; */
1603 # endif /* GRAN_CHECK */
1605 bad_option( rts_argv[arg] );
1611 Interpret n as a binary number masking GranSim debug options and set the
1612 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1615 set_GranSim_debug_options(nat n) {
1618 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1620 fprintf(stderr, gran_debug_opts_strs[i]);
1622 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1623 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1624 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1625 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1626 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1627 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1628 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1629 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1630 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1631 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1632 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1633 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1634 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1635 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1636 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1637 default: barf("set_GranSim_debug_options: only %d debug options expected");
1643 Print one line explanation for each of the GranSim debug options specified
1647 help_GranSim_debug_options(nat n) {
1650 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1652 fprintf(stderr, gran_debug_opts_strs[i]);
1658 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1660 if (rts_argv[arg][1] != 'q') /* All GUM options start with -q */
1663 /* Communication and task creation cost parameters */
1664 switch(rts_argv[arg][2]) {
1665 case 'e': /* -qe<n> ... allow <n> local sparks */
1666 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1667 RtsFlags.ParFlags.maxLocalSparks
1668 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1670 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1671 belch("setupRtsFlags: bad value for -e\n");
1675 IF_PAR_DEBUG(verbose,
1676 belch("-qe<n>: max %d local sparks",
1677 RtsFlags.ParFlags.maxLocalSparks));
1681 if (rts_argv[arg][3] != '\0') {
1682 RtsFlags.ParFlags.maxThreads
1683 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1685 belch("setupRtsFlags: missing size for -qt\n");
1688 IF_PAR_DEBUG(verbose,
1689 belch("-qt<n>: max %d threads",
1690 RtsFlags.ParFlags.maxThreads));
1694 if (rts_argv[arg][3] != '\0')
1695 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1697 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1699 IF_PAR_DEBUG(verbose,
1700 belch("-qf<n>: max %d fishes sent out at one time",
1701 RtsFlags.ParFlags.maxFishes));
1706 if (rts_argv[arg][3] != '\0') {
1707 RtsFlags.ParFlags.fishDelay
1708 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1710 belch("setupRtsFlags: missing fish delay time for -qd\n");
1713 IF_PAR_DEBUG(verbose,
1714 belch("-qd<n>: fish delay time %d",
1715 RtsFlags.ParFlags.fishDelay));
1719 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1720 IF_PAR_DEBUG(verbose,
1721 belch("-qO: output disabled"));
1724 case 'P': /* -qP for writing a log file */
1725 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1726 /* same encoding as in GranSim after -bP */
1727 switch(rts_argv[arg][3]) {
1728 case '\0': break; // nothing special, just an ordinary profile
1729 //case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1731 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1733 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1735 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1737 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1739 case 'g': RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1741 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1743 IF_PAR_DEBUG(verbose,
1744 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1745 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1748 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1749 if (rts_argv[arg][3] != '\0') {
1750 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1752 belch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1755 IF_PAR_DEBUG(verbose,
1756 belch("-qQ<n>: pack buffer size set to %d",
1757 RtsFlags.ParFlags.packBufferSize));
1762 if (rts_argv[arg][3] != '\0') {
1763 RtsFlags.ParFlags.wait
1764 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1766 RtsFlags.ParFlags.wait = 1000;
1768 IF_PAR_DEBUG(verbose,
1769 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1770 RtsFlags.ParFlags.wait));
1773 case 'D': /* -qD ... all the debugging options */
1774 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1775 /* hack warning: interpret the flags as a binary number */
1776 nat n = decode(rts_argv[arg]+3);
1777 set_par_debug_options(n);
1780 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1781 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1784 if (i==MAX_PAR_DEBUG_OPTION+1) {
1785 fprintf(stderr, "Valid GUM debug options are:\n");
1786 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1787 bad_option( rts_argv[arg] );
1788 } else { // flag found; now set it
1789 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1795 belch("Unknown option -q%c", rts_argv[arg][2]);
1801 Interpret n as a binary number masking Par debug options and set the
1802 correxponding option. See par_debug_opts_strs for explanations of the flags.
1805 set_par_debug_options(nat n) {
1808 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1810 fprintf(stderr, par_debug_opts_strs[i]);
1812 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1813 case 1: RtsFlags.ParFlags.Debug.trace = rtsTrue; break;
1814 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1815 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1816 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1817 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1818 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1819 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1820 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1821 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
1822 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
1823 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1824 default: barf("set_par_debug_options: only %d debug options expected");
1830 Print one line explanation for each of the GranSim debug options specified
1834 help_par_debug_options(nat n) {
1837 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1839 fprintf(stderr, par_debug_opts_strs[i]);
1846 set_debug_options(nat n) {
1849 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1851 fprintf(stderr, debug_opts_strs[i]);
1853 case 0: RtsFlags.DebugFlags.scheduler = rtsTrue; break;
1854 case 1: RtsFlags.DebugFlags.evaluator = rtsTrue; break;
1855 case 2: RtsFlags.DebugFlags.codegen = rtsTrue; break;
1856 case 3: RtsFlags.DebugFlags.weak = rtsTrue; break;
1857 case 4: RtsFlags.DebugFlags.gccafs = rtsTrue; break;
1858 case 5: RtsFlags.DebugFlags.gc = rtsTrue; break;
1859 case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1860 case 7: RtsFlags.DebugFlags.sanity = rtsTrue; break;
1861 case 8: RtsFlags.DebugFlags.stable = rtsTrue; break;
1862 case 9: RtsFlags.DebugFlags.prof = rtsTrue; break;
1863 case 10: RtsFlags.DebugFlags.gran = rtsTrue; break;
1864 case 11: RtsFlags.DebugFlags.par = rtsTrue; break;
1865 case 12: RtsFlags.DebugFlags.linker = rtsTrue; break;
1871 help_debug_options(nat n) {
1874 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1876 fprintf(stderr, debug_opts_strs[i]);
1880 //@node Aux fcts, , GranSim specific options
1881 //@subsection Aux fcts
1883 static FILE * /* return NULL on error */
1886 int argc, char *argv[],
1887 int rts_argc, char *rts_argv[],
1888 const char *FILENAME_FMT)
1892 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
1894 else if (rts_argv[arg][2] != '\0') /* stats file specified */
1895 f = fopen(rts_argv[arg]+2,"w");
1897 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1898 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1899 f = fopen(stats_filename,"w");
1902 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
1904 /* Write argv and rtsv into start of stats file */
1906 for(count = 0; count < argc; count++)
1907 fprintf(f, "%s ", argv[count]);
1908 fprintf(f, "+RTS ");
1909 for(count = 0; count < rts_argc; count++)
1910 fprintf(f, "%s ", rts_argv[count]);
1918 decode(const char *s)
1929 if (c == 'g' || c == 'G')
1930 m *= 1000*1000*1000; /* UNchecked! */
1931 else if (c == 'm' || c == 'M')
1932 m *= 1000*1000; /* We do not use powers of 2 (1024) */
1933 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
1934 m *= 1000; /* a direct-mapped cache. */
1935 else if (c == 'w' || c == 'W')
1942 bad_option(const char *s)
1944 prog_belch("bad RTS option: %s", s);
1945 stg_exit(EXIT_FAILURE);