1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.39 2001/07/19 07:28:00 andy 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.profileFrequency = 20;
251 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
252 RtsFlags.ProfFlags.modSelector = NULL;
253 RtsFlags.ProfFlags.descrSelector = NULL;
254 RtsFlags.ProfFlags.typeSelector = NULL;
255 RtsFlags.ProfFlags.ccSelector = NULL;
257 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
260 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
263 RtsFlags.ParFlags.nNodes = 1;
267 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
268 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
269 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
270 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
271 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
272 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
273 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
275 RtsFlags.ParFlags.outputDisabled = rtsFalse;
277 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
279 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
281 RtsFlags.ParFlags.packBufferSize = 1024;
282 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
283 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
284 RtsFlags.ParFlags.maxThreads = 1024;
285 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
286 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
289 #if defined(PAR) || defined(SMP)
290 RtsFlags.ParFlags.maxLocalSparks = 4096;
291 #endif /* PAR || SMP */
294 /* ToDo: check defaults for GranSim and GUM */
295 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
296 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
298 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
299 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
300 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
301 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
302 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
303 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
304 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
305 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
307 RtsFlags.GranFlags.packBufferSize = 1024;
308 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
310 RtsFlags.GranFlags.proc = MAX_PROC;
311 RtsFlags.GranFlags.Fishing = rtsFalse;
312 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
313 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
314 RtsFlags.GranFlags.Light = rtsFalse;
316 RtsFlags.GranFlags.Costs.latency = LATENCY;
317 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
318 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
319 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
320 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
321 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
322 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
323 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
325 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
326 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
327 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
328 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
329 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
331 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
332 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
333 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
334 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
335 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
337 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
339 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
340 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
342 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
343 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
344 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
345 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
346 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
347 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
348 RtsFlags.GranFlags.FetchStrategy = 2;
349 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
350 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
351 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
352 RtsFlags.GranFlags.SparkPriority = 0;
353 RtsFlags.GranFlags.SparkPriority2 = 0;
354 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
355 RtsFlags.GranFlags.InversePriorities = rtsFalse;
356 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
357 RtsFlags.GranFlags.ThunksToPack = 0;
358 RtsFlags.GranFlags.RandomSteal = rtsTrue;
362 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
363 RtsFlags.TickyFlags.tickyFile = NULL;
370 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
372 " +RTS Indicates run time system options follow",
373 " -RTS Indicates program arguments follow",
374 " --RTS Indicates that ALL subsequent arguments will be given to the",
375 " program (including any of these RTS flags)",
377 "The following run time system options are available:",
379 " -? Prints this message and exits; the program is not executed",
381 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
382 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
384 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
385 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
386 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
387 " -m<n>% Minimum % of heap which must be available (default 3%)",
388 " -G<n> Number of generations (default: 2)",
389 " -T<n> Number of steps in younger generations (default: 2)",
391 " -t<file> One-line GC statistics (default file: <program>.stat)",
392 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
393 " -S<file> Detailed GC statistics",
394 #ifdef RTS_GTK_FRONTPANEL
395 " -f Display front panel (requires X11 & GTK+)",
399 " -Z Don't squeeze out update frames on stack overflow",
400 " -B Sound the bell at the start of each garbage collection",
401 #if defined(PROFILING) || defined(PAR)
403 " -px Time/allocation profile (XML) (output file <program>.prof)",
404 " -p<sort> Time/allocation profile (output file <program>.prof)",
405 " sort: T = time (default), A = alloc, C = cost centre label",
406 " -P<sort> More detailed Time/Allocation profile",
408 # if defined(PROFILING)
410 " -hx Heap residency profile (XML) (output file <program>.prof)",
411 " -h<break-down> Heap residency profile (text) (output file <program>.prof)",
412 " break-down: C = cost centre stack (default), M = module",
413 " D = closure description, Y = type description",
414 " A subset of closures may be selected thusly:",
415 " -hc{cc, cc ...} specific cost centre(s) (NOT STACKS!)",
416 " -hm{mod,mod...} all cost centres from the specified modules(s)",
417 " -hd{des,des...} closures with specified closure descriptions",
418 " -hy{typ,typ...} closures with specified type descriptions",
420 " -i<sec> how often to sample heap",
422 " -xc Show current cost centre stack on raising an exception",
424 #endif /* PROFILING or PAR */
425 #if !defined(PROFILING) && defined(DEBUG)
427 " -h<break-down> Debugging Heap residency profile",
428 " (output file <program>.hp)",
429 " break-down: L = closure label (default)",
430 " T = closure type (constructor, thunk etc.)",
433 #if defined(TICKY_TICKY)
434 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
438 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
439 /* NB: the -N<n> is implemented by the driver!! */
441 " -C<secs> Context-switch interval in seconds",
442 " (0 or no argument means switch as often as possible)",
443 " the default is .02 sec; resolution is .02 sec",
445 " -N<n> Use <n> OS threads (default: 1)",
447 #if defined(SMP) || defined(PAR)
448 " -e<size> Size of spark pools (default 100)",
451 " -t<num> Set maximum number of advisory threads per PE (default 32)",
452 " -qP Enable activity profile (output files in ~/<program>*.gr)",
453 " -qQ<size> Set pack-buffer size (default: 1024)",
454 " -qd Turn on PVM-ish debugging",
455 " -qO Disable output for performance measurement",
457 #if defined(SMP) || defined(PAR)
458 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
461 " -d Turn on PVM-ish debugging",
462 " -O Disable output for performance measurement",
464 #if defined(GRAN) /* ToDo: fill in decent Docu here */
465 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
468 "Other RTS options may be available for programs compiled a different way.",
469 "The GHC User's Guide has full details.",
474 static __inline__ rtsBool
475 strequal(const char *a, const char * b)
477 return(strcmp(a, b) == 0);
481 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
483 rtsBool error = rtsFalse;
488 /* Remove directory from argv[0] -- default files in current directory */
490 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
491 strcpy(argv[0], last_slash+1);
493 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
494 /* argv[0] must be PGM argument -- leave in argv */
502 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
503 if (strequal("+RTS", argv[arg])) {
506 else if (strequal("-RTS", argv[arg])) {
509 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
510 rts_argv[(*rts_argc)++] = argv[arg];
512 else if (mode == PGM) {
513 argv[(*argc)++] = argv[arg];
516 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
519 if (arg < total_arg) {
520 /* arg must be --RTS; process remaining program arguments */
521 while (++arg < total_arg) {
522 argv[(*argc)++] = argv[arg];
525 argv[*argc] = (char *) 0;
526 rts_argv[*rts_argc] = (char *) 0;
528 /* Process RTS (rts_argv) part: mainly to determine statsfile */
530 for (arg = 0; arg < *rts_argc; arg++) {
531 if (rts_argv[arg][0] != '-') {
533 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
537 switch(rts_argv[arg][1]) {
539 /* process: general args, then PROFILING-only ones,
540 then CONCURRENT-only, PARallel-only, GRAN-only,
541 TICKY-only (same order as defined in RtsFlags.lh);
542 within those groups, mostly in case-insensitive
544 Final group is x*, which allows for more options.
548 # define TICKY_BUILD_ONLY(x) x
550 # define TICKY_BUILD_ONLY(x) \
551 prog_belch("GHC not built for: ticky-ticky stats"); \
555 #if defined(PROFILING)
556 # define COST_CENTRE_USING_BUILD_ONLY(x) x
558 # define COST_CENTRE_USING_BUILD_ONLY(x) \
559 prog_belch("GHC not built for: -prof or -parallel"); \
564 # define PROFILING_BUILD_ONLY(x) x
566 # define PROFILING_BUILD_ONLY(x) \
567 prog_belch("GHC not built for: -prof"); \
572 # define SMP_BUILD_ONLY(x) x
574 # define SMP_BUILD_ONLY(x) \
575 prog_belch("GHC not built for: -smp"); \
580 # define PAR_BUILD_ONLY(x) x
582 # define PAR_BUILD_ONLY(x) \
583 prog_belch("GHC not built for: -parallel"); \
587 #if defined(SMP) || defined(PAR)
588 # define PAR_OR_SMP_BUILD_ONLY(x) x
590 # define PAR_OR_SMP_BUILD_ONLY(x) \
591 prog_belch("GHC not built for: -parallel or -smp"); \
596 # define GRAN_BUILD_ONLY(x) x
598 # define GRAN_BUILD_ONLY(x) \
599 prog_belch("GHC not built for: -gransim"); \
603 /* =========== GENERAL ========================== */
609 RtsFlags.GcFlags.minAllocAreaSize
610 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
611 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
612 bad_option(rts_argv[arg]);
617 RtsFlags.GcFlags.ringBell = rtsTrue;
621 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
623 if (RtsFlags.GcFlags.oldGenFactor < 0)
624 bad_option( rts_argv[arg] );
629 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
630 /* hack warning: interpret the flags as a binary number */
631 nat n = decode(rts_argv[arg]+2);
632 set_debug_options(n);
638 RtsFlags.GcFlags.maxStkSize =
639 decode(rts_argv[arg]+2) / sizeof(W_);
641 if (RtsFlags.GcFlags.maxStkSize == 0)
642 bad_option( rts_argv[arg] );
646 RtsFlags.GcFlags.initialStkSize =
647 decode(rts_argv[arg]+2) / sizeof(W_);
649 if (RtsFlags.GcFlags.initialStkSize == 0)
650 bad_option( rts_argv[arg] );
654 RtsFlags.GcFlags.maxHeapSize =
655 decode(rts_argv[arg]+2) / BLOCK_SIZE;
656 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
658 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
659 bad_option(rts_argv[arg]);
664 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
666 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
667 RtsFlags.GcFlags.pcFreeHeap > 100)
668 bad_option( rts_argv[arg] );
672 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
673 if (RtsFlags.GcFlags.generations < 1) {
674 bad_option(rts_argv[arg]);
679 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
680 if (RtsFlags.GcFlags.steps < 1) {
681 bad_option(rts_argv[arg]);
686 RtsFlags.GcFlags.heapSizeSuggestion =
687 decode(rts_argv[arg]+2) / BLOCK_SIZE;
689 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
690 bad_option(rts_argv[arg]);
694 #ifdef RTS_GTK_FRONTPANEL
696 RtsFlags.GcFlags.frontpanel = rtsTrue;
701 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
705 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
709 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
714 /* Opening all those files would almost certainly fail... */
715 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
716 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
718 RtsFlags.GcFlags.statsFile
719 = open_stats_file(arg, *argc, argv,
720 *rts_argc, rts_argv, STAT_FILENAME_FMT);
722 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
727 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
730 /* =========== PROFILING ========================== */
732 case 'P': /* detailed cost centre profiling (time/alloc) */
733 COST_CENTRE_USING_BUILD_ONLY(
734 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
736 case 'p': /* cost centre profiling (time/alloc) */
737 COST_CENTRE_USING_BUILD_ONLY(
738 switch (rts_argv[arg][2]) {
740 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
743 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
748 case 'h': /* serial heap profile */
749 #if !defined(PROFILING) && defined(DEBUG)
750 switch (rts_argv[arg][2]) {
753 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
756 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
759 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
763 PROFILING_BUILD_ONLY(
764 switch (rts_argv[arg][2]) {
767 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
770 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
773 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
776 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
778 case 'c': /* cost centre label select */
779 case 'm': /* cost centre module select */
780 case 'd': /* closure descr select */
781 case 'y': /* closure type select */
782 {char *left = strchr(rts_argv[arg], '{');
783 char *right = strrchr(rts_argv[arg], '}');
784 if (! left || ! right ||
785 strrchr(rts_argv[arg], '{') != left ||
786 strchr(rts_argv[arg], '}') != right) {
788 "Invalid heap profiling selection bracketing\n %s\n",
793 switch (rts_argv[arg][2]) {
794 case 'c': /* cost centre label select */
795 RtsFlags.ProfFlags.ccSelector = left + 1;
797 case 'm': /* cost centre module select */
798 RtsFlags.ProfFlags.modSelector = left + 1;
800 case 'd': /* closure descr select */
801 RtsFlags.ProfFlags.descrSelector = left + 1;
803 case 'y': /* closure type select */
804 RtsFlags.ProfFlags.typeSelector = left + 1;
811 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
819 #if defined(PROFILING)
820 case 'i': /* heap sample interval */
821 if (rts_argv[arg][2] == '\0') {
826 /* Convert to milliseconds */
827 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
828 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
829 if (cst != 0 && cst < CS_MIN_MILLISECS)
830 cst = CS_MIN_MILLISECS;
832 RtsFlags.ProfFlags.profileFrequency = cst;
839 /* =========== CONCURRENT ========================= */
840 case 'C': /* context switch interval */
841 if (rts_argv[arg][2] == '\0')
842 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
846 /* Convert to milliseconds */
847 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
848 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
849 if (cst != 0 && cst < CS_MIN_MILLISECS)
850 cst = CS_MIN_MILLISECS;
852 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
859 if (rts_argv[arg][2] != '\0') {
860 RtsFlags.ParFlags.nNodes
861 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
862 if (RtsFlags.ParFlags.nNodes <= 0) {
863 prog_belch("bad value for -N");
869 /* =========== PARALLEL =========================== */
871 PAR_OR_SMP_BUILD_ONLY(
872 if (rts_argv[arg][2] != '\0') {
873 RtsFlags.ParFlags.maxLocalSparks
874 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
875 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
876 prog_belch("bad value for -e");
884 process_par_option(arg, rts_argc, rts_argv, &error);
887 /* =========== GRAN =============================== */
891 process_gran_option(arg, rts_argc, rts_argv, &error);
894 /* =========== TICKY ============================== */
896 case 'r': /* Basic profiling stats */
899 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
900 RtsFlags.TickyFlags.tickyFile
901 = open_stats_file(arg, *argc, argv,
902 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
904 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
907 /* =========== EXTENDED OPTIONS =================== */
909 case 'x': /* Extend the argument space */
910 switch(rts_argv[arg][2]) {
912 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
916 case 'c': /* Debugging tool: show current cost centre on an exception */
917 PROFILING_BUILD_ONLY(
918 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
921 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
924 prog_belch("unknown RTS option: %s",rts_argv[arg]);
928 break; /* defensive programming */
930 /* =========== OH DEAR ============================ */
932 prog_belch("unknown RTS option: %s",rts_argv[arg]);
942 for (p = usage_text; *p; p++)
944 stg_exit(EXIT_FAILURE);
950 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
951 //@subsection GranSim specific options
954 enable_GranSimLight(void) {
956 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
957 RtsFlags.GranFlags.Light=rtsTrue;
958 RtsFlags.GranFlags.Costs.latency =
959 RtsFlags.GranFlags.Costs.fetchtime =
960 RtsFlags.GranFlags.Costs.additional_latency =
961 RtsFlags.GranFlags.Costs.gunblocktime =
962 RtsFlags.GranFlags.Costs.lunblocktime =
963 RtsFlags.GranFlags.Costs.threadcreatetime =
964 RtsFlags.GranFlags.Costs.threadqueuetime =
965 RtsFlags.GranFlags.Costs.threadscheduletime =
966 RtsFlags.GranFlags.Costs.threaddescheduletime =
967 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
969 RtsFlags.GranFlags.Costs.mpacktime =
970 RtsFlags.GranFlags.Costs.munpacktime = 0;
972 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
973 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
974 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
975 /* FetchStrategy is irrelevant in GrAnSim-Light */
977 /* GrAnSim Light often creates an abundance of parallel threads,
978 each with its own stack etc. Therefore, it's in general a good
979 idea to use small stack chunks (use the -o<size> option to
982 // RtsFlags.ConcFlags.stkChunkSize = 100;
984 RtsFlags.GranFlags.proc = 1;
988 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
990 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
993 /* or a ridiculously idealised simulator */
994 if(strcmp((rts_argv[arg]+2),"oring")==0) {
995 RtsFlags.GranFlags.Costs.latency =
996 RtsFlags.GranFlags.Costs.fetchtime =
997 RtsFlags.GranFlags.Costs.additional_latency =
998 RtsFlags.GranFlags.Costs.gunblocktime =
999 RtsFlags.GranFlags.Costs.lunblocktime =
1000 RtsFlags.GranFlags.Costs.threadcreatetime =
1001 RtsFlags.GranFlags.Costs.threadqueuetime =
1002 RtsFlags.GranFlags.Costs.threadscheduletime =
1003 RtsFlags.GranFlags.Costs.threaddescheduletime =
1004 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1006 RtsFlags.GranFlags.Costs.mpacktime =
1007 RtsFlags.GranFlags.Costs.munpacktime = 0;
1009 RtsFlags.GranFlags.Costs.arith_cost =
1010 RtsFlags.GranFlags.Costs.float_cost =
1011 RtsFlags.GranFlags.Costs.load_cost =
1012 RtsFlags.GranFlags.Costs.store_cost =
1013 RtsFlags.GranFlags.Costs.branch_cost = 0;
1015 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1017 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1018 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1019 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1020 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1024 /* or a somewhat idealised simulator */
1025 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1026 RtsFlags.GranFlags.Costs.latency =
1027 RtsFlags.GranFlags.Costs.fetchtime =
1028 RtsFlags.GranFlags.Costs.additional_latency =
1029 RtsFlags.GranFlags.Costs.gunblocktime =
1030 RtsFlags.GranFlags.Costs.lunblocktime =
1031 RtsFlags.GranFlags.Costs.threadcreatetime =
1032 RtsFlags.GranFlags.Costs.threadqueuetime =
1033 RtsFlags.GranFlags.Costs.threadscheduletime =
1034 RtsFlags.GranFlags.Costs.threaddescheduletime =
1035 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1037 RtsFlags.GranFlags.Costs.mpacktime =
1038 RtsFlags.GranFlags.Costs.munpacktime = 0;
1040 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1042 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1043 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1044 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1045 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1046 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1047 # if defined(GRAN_CHECK) && defined(GRAN)
1048 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1053 /* Communication and task creation cost parameters */
1054 switch(rts_argv[arg][2]) {
1056 IgnoreYields = rtsTrue; // HWL HACK
1060 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1064 if (rts_argv[arg][3] != '\0')
1066 RtsFlags.GranFlags.Costs.gunblocktime =
1067 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1068 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1071 RtsFlags.GranFlags.Costs.latency = LATENCY;
1075 if (rts_argv[arg][3] != '\0')
1076 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1078 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1082 if (rts_argv[arg][3] != '\0')
1083 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1085 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1089 if (rts_argv[arg][3] != '\0')
1090 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1092 RtsFlags.GranFlags.Costs.mtidytime = 0;
1096 if (rts_argv[arg][3] != '\0')
1097 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1099 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1103 if (rts_argv[arg][3] != '\0')
1104 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1106 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1110 if (rts_argv[arg][3] != '\0')
1111 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1113 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1117 if (rts_argv[arg][3] != '\0')
1118 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1120 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1123 /* Thread-related metrics */
1125 if (rts_argv[arg][3] != '\0')
1126 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1128 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1132 if (rts_argv[arg][3] != '\0')
1133 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1135 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1139 if (rts_argv[arg][3] != '\0')
1140 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1142 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1144 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1145 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1149 if (rts_argv[arg][3] != '\0')
1150 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1152 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1154 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1155 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1158 /* Instruction Cost Metrics */
1160 if (rts_argv[arg][3] != '\0')
1161 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1163 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1167 if (rts_argv[arg][3] != '\0')
1168 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1170 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1174 if (rts_argv[arg][3] != '\0')
1175 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1177 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1181 if (rts_argv[arg][3] != '\0')
1182 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1184 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1188 if (rts_argv[arg][3] != '\0')
1189 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1191 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1195 if (rts_argv[arg][3] != '\0')
1196 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1198 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1202 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1203 if (rts_argv[arg][3] != '\0')
1204 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1206 RtsFlags.GranFlags.FetchStrategy = 2;
1207 if (RtsFlags.GranFlags.FetchStrategy == 0)
1208 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1211 case 'K': /* sort overhead (per elem in spark list) */
1212 if (rts_argv[arg][3] != '\0')
1213 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1215 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1216 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1217 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1220 case 'O': /* sort overhead (per elem in spark list) */
1221 if (rts_argv[arg][3] != '\0')
1222 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1224 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1225 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1226 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1229 /* General Parameters */
1231 if (rts_argv[arg][3] != '\0')
1233 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1234 if (RtsFlags.GranFlags.proc==0) {
1235 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1236 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1237 RtsFlags.GranFlags.proc < 1)
1239 fprintf(stderr,"setupRtsFlags: no more than %u processors
1246 RtsFlags.GranFlags.proc = MAX_PROC;
1250 RtsFlags.GranFlags.Fishing = rtsTrue;
1251 if (rts_argv[arg][3] != '\0')
1252 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1254 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1258 if (rts_argv[arg][3] != '\0')
1259 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1261 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1265 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1266 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1270 fprintf(stderr,"Bulk fetching enabled.\n");
1271 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1275 fprintf(stderr,"Thread migration enabled.\n");
1276 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1280 fprintf(stderr,"Fair Scheduling enabled.\n");
1281 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1285 fprintf(stderr,"Priority Scheduling enabled.\n");
1286 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1290 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1291 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1295 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1299 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1303 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1307 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1311 /* format is -bP<c> where <c> is one char describing kind of profile */
1312 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1313 switch(rts_argv[arg][3]) {
1314 case '\0': break; // nothing special, just an ordinary profile
1315 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1317 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1319 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1321 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1323 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1325 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1327 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1332 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1336 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1339 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1340 if (rts_argv[arg][3] != '\0') {
1343 arg0 = rts_argv[arg]+3;
1344 if ((tmp = strstr(arg0,","))==NULL) {
1345 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1346 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1349 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1350 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1351 fprintf(stderr,"SparkPriority: %u.\n",
1352 RtsFlags.GranFlags.SparkPriority);
1353 fprintf(stderr,"SparkPriority2:%u.\n",
1354 RtsFlags.GranFlags.SparkPriority2);
1355 if (RtsFlags.GranFlags.SparkPriority2 <
1356 RtsFlags.GranFlags.SparkPriority) {
1357 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1358 RtsFlags.GranFlags.SparkPriority2,
1359 RtsFlags.GranFlags.SparkPriority);
1363 /* plain pri spark is now invoked with -bX
1364 RtsFlags.GranFlags.DoPrioritySparking = 1;
1365 fprintf(stderr,"PrioritySparking.\n");
1371 if (rts_argv[arg][3] != '\0') {
1372 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1374 RtsFlags.GranFlags.ThunksToPack = 1;
1376 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1377 RtsFlags.GranFlags.ThunksToPack);
1381 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1382 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1385 /* The following class of options contains eXperimental */
1386 /* features in connection with exploiting granularity */
1387 /* information. I.e. if -bY is chosen these options */
1388 /* tell the RTS what to do with the supplied info --HWL */
1391 if (rts_argv[arg][3] != '\0') {
1392 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1394 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1396 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1397 RtsFlags.GranFlags.packBufferSize_internal);
1401 switch(rts_argv[arg][3]) {
1404 RtsFlags.GranFlags.DoPrioritySparking = 1;
1405 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1406 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1407 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1408 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1412 RtsFlags.GranFlags.DoPrioritySparking = 1;
1413 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1414 RtsFlags.GranFlags.InversePriorities++;
1418 RtsFlags.GranFlags.DoPrioritySparking = 1;
1419 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1420 RtsFlags.GranFlags.RandomPriorities++;
1424 RtsFlags.GranFlags.DoPrioritySparking = 1;
1425 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1426 RtsFlags.GranFlags.IgnorePriorities++;
1430 bad_option( rts_argv[arg] );
1436 switch(rts_argv[arg][3]) {
1439 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1440 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1444 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1448 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1452 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1456 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1457 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1461 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1465 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1469 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1473 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1477 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1481 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1485 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1489 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1490 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1494 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1498 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1502 bad_option( rts_argv[arg] );
1507 # if defined(GRAN_CHECK) && defined(GRAN)
1509 switch(rts_argv[arg][3]) {
1510 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1511 if (rts_argv[arg][4] != '\0') {
1512 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1513 fprintf(stderr,"Pack buffer size: %d\n",
1514 RtsFlags.GranFlags.packBufferSize);
1516 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1522 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1523 /* hack warning: interpret the flags as a binary number */
1524 nat n = decode(rts_argv[arg]+3);
1525 set_GranSim_debug_options(n);
1528 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1529 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1532 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1533 fprintf(stderr, "Valid GranSim debug options are:\n");
1534 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1535 bad_option( rts_argv[arg] );
1536 } else { // flag found; now set it
1537 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1543 case 'e': /* event trace; also -bD1 */
1544 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1545 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1546 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1549 case 'E': /* event statistics; also -bD2 */
1550 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1551 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1552 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1555 case 'f': /* thunkStealing; also -bD4 */
1556 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1557 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1558 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1561 case 'z': /* blockOnFetch; also -bD8 */
1562 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1563 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1564 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1567 case 't': /* blockOnFetch_sanity; also -bD16 */
1568 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1569 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1570 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1573 case 'S': /* priSpark; also -bD32 */
1574 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1575 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1578 case 's': /* priSched; also -bD64 */
1579 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1580 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1583 case 'F': /* findWork; also -bD128 */
1584 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1585 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1588 case 'g': /* globalBlock; also -bD256 */
1589 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1590 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1593 case 'G': /* pack; also -bD512 */
1594 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1595 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1598 case 'P': /* packBuffer; also -bD1024 */
1599 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1600 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1603 case 'o': /* sortedQ; also -bD2048 */
1604 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1605 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1608 case 'r': /* randomSteal; also -bD4096 */
1609 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1610 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1613 case 'q': /* checkSparkQ; also -bD8192 */
1614 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1615 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1618 case ':': /* checkLight; also -bD16384 */
1619 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1620 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1623 case 'b': /* bq; also -bD32768 */
1624 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1625 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1628 case 'd': /* all options turned on */
1629 fprintf(stderr,"DEBUG: all options turned on.\n");
1630 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1631 /* RtsFlags.GranFlags.Debug |= 0x40; */
1635 /* RtsFlags.GranFlags.Debug = 1; */
1641 # endif /* GRAN_CHECK */
1643 bad_option( rts_argv[arg] );
1649 Interpret n as a binary number masking GranSim debug options and set the
1650 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1653 set_GranSim_debug_options(nat n) {
1656 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1658 fprintf(stderr, gran_debug_opts_strs[i]);
1660 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1661 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1662 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1663 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1664 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1665 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1666 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1667 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1668 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1669 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1670 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1671 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1672 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1673 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1674 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1675 default: barf("set_GranSim_debug_options: only %d debug options expected");
1681 Print one line explanation for each of the GranSim debug options specified
1685 help_GranSim_debug_options(nat n) {
1688 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1690 fprintf(stderr, gran_debug_opts_strs[i]);
1696 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1699 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
1700 belch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
1704 /* Communication and task creation cost parameters */
1705 switch(rts_argv[arg][2]) {
1706 case 'e': /* -qe<n> ... allow <n> local sparks */
1707 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1708 RtsFlags.ParFlags.maxLocalSparks
1709 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1711 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1712 belch("setupRtsFlags: bad value for -e\n");
1716 IF_PAR_DEBUG(verbose,
1717 belch("-qe<n>: max %d local sparks",
1718 RtsFlags.ParFlags.maxLocalSparks));
1722 if (rts_argv[arg][3] != '\0') {
1723 RtsFlags.ParFlags.maxThreads
1724 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1726 belch("setupRtsFlags: missing size for -qt\n");
1729 IF_PAR_DEBUG(verbose,
1730 belch("-qt<n>: max %d threads",
1731 RtsFlags.ParFlags.maxThreads));
1735 if (rts_argv[arg][3] != '\0')
1736 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1738 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1740 IF_PAR_DEBUG(verbose,
1741 belch("-qf<n>: max %d fishes sent out at one time",
1742 RtsFlags.ParFlags.maxFishes));
1746 if (rts_argv[arg][3] != '\0') {
1747 RtsFlags.ParFlags.fishDelay
1748 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1750 belch("setupRtsFlags: missing fish delay time for -qF\n");
1753 IF_PAR_DEBUG(verbose,
1754 belch("-qF<n>: fish delay time %d us",
1755 RtsFlags.ParFlags.fishDelay));
1759 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1760 IF_PAR_DEBUG(verbose,
1761 belch("-qO: output disabled"));
1764 case 'g': /* -qg<n> ... globalisation scheme */
1765 if (rts_argv[arg][3] != '\0') {
1766 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
1768 belch("setupRtsFlags: missing identifier for globalisation scheme (for -qg)\n");
1771 IF_PAR_DEBUG(verbose,
1772 belch("-qg<n>: globalisation scheme set to %d",
1773 RtsFlags.ParFlags.globalising));
1776 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
1777 if (rts_argv[arg][3] != '\0') {
1778 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
1780 belch("setupRtsFlags: missing number of thunks per packet (for -qh)\n");
1783 IF_PAR_DEBUG(verbose,
1784 belch("-qh<n>: thunks per packet set to %d",
1785 RtsFlags.ParFlags.thunksToPack));
1788 case 'P': /* -qP for writing a log file */
1789 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1790 /* same encoding as in GranSim after -bP */
1791 switch(rts_argv[arg][3]) {
1792 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1793 break; // nothing special, just an ordinary profile
1794 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1795 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1797 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1799 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1801 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1803 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1806 # if defined(PAR_TICKY)
1807 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1809 fprintf(stderr,"-qPg is only possible for a PAR_TICKY RTS, which this is not");
1810 stg_exit(EXIT_FAILURE);
1813 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1815 IF_PAR_DEBUG(verbose,
1816 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1817 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1820 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1821 if (rts_argv[arg][3] != '\0') {
1822 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1824 belch("setupRtsFlags: missing size of PackBuffer (for -qQ)\n");
1827 IF_PAR_DEBUG(verbose,
1828 belch("-qQ<n>: pack buffer size set to %d",
1829 RtsFlags.ParFlags.packBufferSize));
1833 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
1834 IF_PAR_DEBUG(verbose,
1835 belch("-qR: fair-ish scheduling"));
1840 if (rts_argv[arg][3] != '\0') {
1841 RtsFlags.ParFlags.wait
1842 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1844 RtsFlags.ParFlags.wait = 1000;
1846 IF_PAR_DEBUG(verbose,
1847 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1848 RtsFlags.ParFlags.wait));
1851 case 'D': /* -qD ... all the debugging options */
1852 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1853 /* hack warning: interpret the flags as a binary number */
1854 nat n = decode(rts_argv[arg]+3);
1855 set_par_debug_options(n);
1858 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1859 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1862 if (i==MAX_PAR_DEBUG_OPTION+1) {
1863 fprintf(stderr, "Valid GUM debug options are:\n");
1864 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1865 bad_option( rts_argv[arg] );
1866 } else { // flag found; now set it
1867 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1873 belch("Unknown option -q%c (%d opts in total)",
1874 rts_argv[arg][2], *rts_argc);
1880 Interpret n as a binary number masking Par debug options and set the
1881 correxponding option. See par_debug_opts_strs for explanations of the flags.
1884 set_par_debug_options(nat n) {
1887 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1889 fprintf(stderr, par_debug_opts_strs[i]);
1891 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1892 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
1893 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1894 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1895 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1896 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1897 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1898 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1899 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1900 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
1901 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
1902 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1903 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
1904 default: barf("set_par_debug_options: only %d debug options expected",
1905 MAX_PAR_DEBUG_OPTION);
1911 Print one line explanation for each of the GranSim debug options specified
1915 help_par_debug_options(nat n) {
1918 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1920 fprintf(stderr, par_debug_opts_strs[i]);
1927 set_debug_options(nat n) {
1930 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1932 fprintf(stderr, debug_opts_strs[i]);
1934 case 0: RtsFlags.DebugFlags.scheduler = rtsTrue; break;
1935 case 1: RtsFlags.DebugFlags.evaluator = rtsTrue; break;
1936 case 2: RtsFlags.DebugFlags.codegen = rtsTrue; break;
1937 case 3: RtsFlags.DebugFlags.weak = rtsTrue; break;
1938 case 4: RtsFlags.DebugFlags.gccafs = rtsTrue; break;
1939 case 5: RtsFlags.DebugFlags.gc = rtsTrue; break;
1940 case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1941 case 7: RtsFlags.DebugFlags.sanity = rtsTrue; break;
1942 case 8: RtsFlags.DebugFlags.stable = rtsTrue; break;
1943 case 9: RtsFlags.DebugFlags.prof = rtsTrue; break;
1944 case 10: RtsFlags.DebugFlags.gran = rtsTrue; break;
1945 case 11: RtsFlags.DebugFlags.par = rtsTrue; break;
1946 default: barf("set_debug_options: only %d debug options expected",
1953 help_debug_options(nat n) {
1956 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1958 fprintf(stderr, debug_opts_strs[i]);
1962 //@node Aux fcts, , GranSim specific options
1963 //@subsection Aux fcts
1965 static FILE * /* return NULL on error */
1968 int argc, char *argv[],
1969 int rts_argc, char *rts_argv[],
1970 const char *FILENAME_FMT)
1974 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
1976 else if (rts_argv[arg][2] != '\0') /* stats file specified */
1977 f = fopen(rts_argv[arg]+2,"w");
1979 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1980 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1981 f = fopen(stats_filename,"w");
1984 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
1986 /* Write argv and rtsv into start of stats file */
1988 for(count = 0; count < argc; count++)
1989 fprintf(f, "%s ", argv[count]);
1990 fprintf(f, "+RTS ");
1991 for(count = 0; count < rts_argc; count++)
1992 fprintf(f, "%s ", rts_argv[count]);
2000 decode(const char *s)
2011 if (c == 'g' || c == 'G')
2012 m *= 1000*1000*1000; /* UNchecked! */
2013 else if (c == 'm' || c == 'M')
2014 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2015 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2016 m *= 1000; /* a direct-mapped cache. */
2017 else if (c == 'w' || c == 'W')
2024 bad_option(const char *s)
2026 prog_belch("bad RTS option: %s", s);
2027 stg_exit(EXIT_FAILURE);