1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.30 2000/04/19 12:42:48 simonmar Exp $
4 * (c) The AQUA Project, Glasgow University, 1994-1997
5 * (c) The GHC Team, 1998-1999
7 * Functions for parsing the argument list.
9 * ---------------------------------------------------------------------------*/
14 //* Static function decls::
15 //* Command-line option parsing routines::
16 //* GranSim specific options::
21 //@node Includes, Constants
22 //@subsection Includes
27 #include "BlockAlloc.h"
28 #include "Profiling.h"
30 #if defined(PROFILING)
38 extern struct RTS_FLAGS RtsFlags;
41 * Split argument lists
43 int prog_argc; /* an "int" so as to match normal "argc" */
44 char **prog_argv = NULL;
45 int rts_argc; /* ditto */
46 char *rts_argv[MAX_RTS_ARGS];
48 //@node Constants, Static function decls, Includes
49 //@subsection Constants
52 * constants, used later
57 char *debug_opts_strs[] = {
58 "DEBUG (-D1): scheduler\n",
59 "DEBUG (-D2): evaluator\n",
60 "DEBUG (-D4): codegen\n",
61 "DEBUG (-D8): weak\n",
62 "DEBUG (-D16): gccafs\n",
64 "DEBUG (-D64): block\n",
65 "DEBUG (-D128): sanity\n",
66 "DEBUG (-D256): stable\n",
67 "DEBUG (-D512): prof\n",
68 "DEBUG (-D1024): gran\n",
69 "DEBUG (-D2048): par\n"
72 char *debug_opts_prefix[] = {
89 char *gran_debug_opts_strs[] = {
90 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
91 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
92 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
93 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
94 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
95 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
96 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
97 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
98 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
99 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
100 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
101 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
102 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
103 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
104 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
107 /* one character codes for the available debug options */
108 char gran_debug_opts_flags[] = {
109 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
112 /* prefix strings printed with the debug messages of the corresponding type */
113 char *gran_debug_opts_prefix[] = {
114 "", /* event_trace */
115 "", /* event_stats */
118 "^^", /* checkSparkQ */
119 "==", /* thunkStealing */
120 "^^", /* randomSteal */
124 "::", /* checkLight */
126 "", /* blockOnFetch */
128 "" /* blockOnFetch_sanity */
133 char *par_debug_opts_strs[] = {
134 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
135 "DEBUG (-qDt, -qD2): trace; trace messages.\n",
136 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
137 "DEBUG (-qDe, -qD8): free; free messages.\n",
138 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
139 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
140 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
141 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
142 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
143 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
144 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
145 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
146 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n"
149 /* one character codes for the available debug options */
150 char par_debug_opts_flags[] = {
151 'v', 't', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p'
154 /* prefix strings printed with the debug messages of the corresponding type */
155 char *par_debug_opts_prefix[] = {
172 //@node Static function decls, Command-line option parsing routines, Constants
173 //@subsection Static function decls
175 /* -----------------------------------------------------------------------------
176 Static function decls
177 -------------------------------------------------------------------------- */
179 static FILE * /* return NULL on error */
182 int argc, char *argv[],
183 int rts_argc, char *rts_argv[],
184 const char *FILENAME_FMT);
186 static I_ decode(const char *s);
187 static void bad_option(const char *s);
190 static void enable_GranSimLight(void);
191 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
192 static void set_GranSim_debug_options(nat n);
193 static void help_GranSim_debug_options(nat n);
195 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
196 static void set_par_debug_options(nat n);
197 static void help_par_debug_options(nat n);
200 static void set_debug_options(nat n);
201 static void help_debug_options(nat n);
204 //@node Command-line option parsing routines, GranSim specific options, Static function decls
205 //@subsection Command-line option parsing routines
207 /* -----------------------------------------------------------------------------
208 * Command-line option parsing routines.
209 * ---------------------------------------------------------------------------*/
211 void initRtsFlagsDefaults(void)
213 RtsFlags.GcFlags.statsFile = NULL;
214 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
216 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
217 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
219 RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE;
220 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
221 RtsFlags.GcFlags.maxHeapSize = (64 * 1024 * 1024) / BLOCK_SIZE;
222 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
223 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
224 RtsFlags.GcFlags.oldGenFactor = 2;
225 RtsFlags.GcFlags.generations = 2;
226 RtsFlags.GcFlags.steps = 2;
228 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
230 #if defined(PROFILING) || defined(PAR)
231 RtsFlags.CcFlags.doCostCentres = 0;
232 #endif /* PROFILING or PAR */
235 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
236 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
238 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
241 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
244 RtsFlags.ParFlags.nNodes = 1;
248 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
249 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
250 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
251 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
252 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
253 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
255 RtsFlags.ParFlags.outputDisabled = rtsFalse;
256 RtsFlags.ParFlags.packBufferSize = 1024;
258 RtsFlags.ParFlags.maxThreads = 1024;
259 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
260 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
263 #if defined(PAR) || defined(SMP)
264 RtsFlags.ParFlags.maxLocalSparks = 4096;
265 #endif /* PAR || SMP */
268 /* ToDo: check defaults for GranSim and GUM */
269 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
270 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
271 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
273 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
274 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
275 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
276 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
277 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
278 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
279 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
280 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
282 RtsFlags.GranFlags.packBufferSize = 1024;
283 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
285 RtsFlags.GranFlags.proc = MAX_PROC;
286 RtsFlags.GranFlags.Fishing = rtsFalse;
287 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
288 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
289 RtsFlags.GranFlags.Light = rtsFalse;
291 RtsFlags.GranFlags.Costs.latency = LATENCY;
292 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
293 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
294 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
295 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
296 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
297 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
298 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
300 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
301 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
302 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
303 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
304 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
306 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
307 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
308 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
309 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
310 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
312 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
314 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
315 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
317 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
318 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
319 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
320 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
321 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
322 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
323 RtsFlags.GranFlags.FetchStrategy = 2;
324 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
325 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
326 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
327 RtsFlags.GranFlags.SparkPriority = 0;
328 RtsFlags.GranFlags.SparkPriority2 = 0;
329 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
330 RtsFlags.GranFlags.InversePriorities = rtsFalse;
331 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
332 RtsFlags.GranFlags.ThunksToPack = 0;
333 RtsFlags.GranFlags.RandomSteal = rtsTrue;
337 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
338 RtsFlags.TickyFlags.tickyFile = NULL;
345 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
347 " +RTS Indicates run time system options follow",
348 " -RTS Indicates program arguments follow",
349 " --RTS Indicates that ALL subsequent arguments will be given to the",
350 " program (including any of these RTS flags)",
352 "The following run time system options are available:",
354 " -? -f Prints this message and exits; the program is not executed",
356 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
357 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
359 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
360 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
361 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
362 " -m<n>% Minimum % of heap which must be available (default 3%)",
363 " -G<n> Number of generations (default: 2)",
364 " -T<n> Number of steps in younger generations (default: 2)",
365 " -s<file> Summary GC statistics (default file: <program>.stat)",
366 " -S<file> Detailed GC statistics (with -Sstderr going to stderr)",
369 " -Z Don't squeeze out update frames on stack overflow",
370 " -B Sound the bell at the start of each garbage collection",
371 #if defined(PROFILING) || defined(PAR)
373 " -px Time/allocation profile (XML) (output file <program>.prof)",
374 " -p<sort> Time/allocation profile (output file <program>.prof)",
375 " sort: T = time (default), A = alloc, C = cost centre label",
376 " -P<sort> More detailed Time/Allocation profile"
377 # if defined(PROFILING)
379 " -hx Heap residency profile (XML) (output file <program>.prof)",
380 " -h<break-down> Heap residency profile (text) (output file <program>.prof)",
381 " break-down: C = cost centre stack (default), M = module",
382 " D = closure description, Y = type description",
384 " -xc Show current cost centre stack on raising an exception",
386 #endif /* PROFILING or PAR */
387 #if !defined(PROFILING) && defined(DEBUG)
389 " -h<break-down> Debugging Heap residency profile",
390 " (output file <program>.hp)",
391 " break-down: L = closure label (default)",
392 " T = closure type (constructor, thunk etc.)",
395 #if defined(TICKY_TICKY)
396 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
400 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
401 /* NB: the -N<n> is implemented by the driver!! */
403 " -C<secs> Context-switch interval in seconds",
404 " (0 or no argument means switch as often as possible)",
405 " the default is .01 sec; resolution is .01 sec",
407 " -N<n> Use <n> OS threads (default: 1)",
409 #if defined(SMP) || defined(PAR)
410 " -e<size> Size of spark pools (default 100)",
413 " -t<num> Set maximum number of advisory threads per PE (default 32)",
414 " -qP Enable activity profile (output files in ~/<program>*.gr)",
415 " -qQ<size> Set pack-buffer size (default: 1024)",
416 " -qd Turn on PVM-ish debugging",
417 " -qO Disable output for performance measurement",
419 #if defined(SMP) || defined(PAR)
420 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
423 " -d Turn on PVM-ish debugging",
424 " -O Disable output for performance measurement",
426 #if defined(GRAN) /* ToDo: fill in decent Docu here */
427 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
430 "Other RTS options may be available for programs compiled a different way.",
431 "The GHC User's Guide has full details.",
436 static __inline__ rtsBool
437 strequal(const char *a, const char * b)
439 return(strcmp(a, b) == 0);
443 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
445 rtsBool error = rtsFalse;
450 /* Remove directory from argv[0] -- default files in current directory */
452 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
453 strcpy(argv[0], last_slash+1);
455 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
456 /* argv[0] must be PGM argument -- leave in argv */
464 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
465 if (strequal("+RTS", argv[arg])) {
468 else if (strequal("-RTS", argv[arg])) {
471 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
472 rts_argv[(*rts_argc)++] = argv[arg];
474 else if (mode == PGM) {
475 argv[(*argc)++] = argv[arg];
478 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
481 if (arg < total_arg) {
482 /* arg must be --RTS; process remaining program arguments */
483 while (++arg < total_arg) {
484 argv[(*argc)++] = argv[arg];
487 argv[*argc] = (char *) 0;
488 rts_argv[*rts_argc] = (char *) 0;
490 /* Process RTS (rts_argv) part: mainly to determine statsfile */
492 for (arg = 0; arg < *rts_argc; arg++) {
493 if (rts_argv[arg][0] != '-') {
495 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
499 switch(rts_argv[arg][1]) {
501 /* process: general args, then PROFILING-only ones,
502 then CONCURRENT-only, PARallel-only, GRAN-only,
503 TICKY-only (same order as defined in RtsFlags.lh);
504 within those groups, mostly in case-insensitive
506 Final group is x*, which allows for more options.
510 # define TICKY_BUILD_ONLY(x) x
512 # define TICKY_BUILD_ONLY(x) \
513 prog_belch("GHC not built for: ticky-ticky stats"); \
517 #if defined(PROFILING)
518 # define COST_CENTRE_USING_BUILD_ONLY(x) x
520 # define COST_CENTRE_USING_BUILD_ONLY(x) \
521 prog_belch("GHC not built for: -prof or -parallel"); \
526 # define PROFILING_BUILD_ONLY(x) x
528 # define PROFILING_BUILD_ONLY(x) \
529 prog_belch("GHC not built for: -prof"); \
534 # define SMP_BUILD_ONLY(x) x
536 # define SMP_BUILD_ONLY(x) \
537 prog_belch("GHC not built for: -parallel"); \
542 # define PAR_BUILD_ONLY(x) x
544 # define PAR_BUILD_ONLY(x) \
545 prog_belch("GHC not built for: -parallel"); \
549 #if defined(SMP) || defined(PAR)
550 # define PAR_OR_SMP_BUILD_ONLY(x) x
552 # define PAR_OR_SMP_BUILD_ONLY(x) \
553 prog_belch("GHC not built for: -parallel or -smp"); \
558 # define GRAN_BUILD_ONLY(x) x
560 # define GRAN_BUILD_ONLY(x) \
561 prog_belch("GHC not built for: -gransim"); \
565 /* =========== GENERAL ========================== */
572 RtsFlags.GcFlags.minAllocAreaSize
573 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
574 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
575 bad_option(rts_argv[arg]);
580 RtsFlags.GcFlags.ringBell = rtsTrue;
584 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
586 if (RtsFlags.GcFlags.oldGenFactor < 0)
587 bad_option( rts_argv[arg] );
592 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
593 /* hack warning: interpret the flags as a binary number */
594 nat n = decode(rts_argv[arg]+2);
595 set_debug_options(n);
601 RtsFlags.GcFlags.maxStkSize =
602 decode(rts_argv[arg]+2) / sizeof(W_);
604 if (RtsFlags.GcFlags.maxStkSize == 0)
605 bad_option( rts_argv[arg] );
609 RtsFlags.GcFlags.initialStkSize =
610 decode(rts_argv[arg]+2) / sizeof(W_);
612 if (RtsFlags.GcFlags.initialStkSize == 0)
613 bad_option( rts_argv[arg] );
617 RtsFlags.GcFlags.maxHeapSize =
618 decode(rts_argv[arg]+2) / BLOCK_SIZE;
619 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
621 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
622 bad_option(rts_argv[arg]);
627 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
629 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
630 RtsFlags.GcFlags.pcFreeHeap > 100)
631 bad_option( rts_argv[arg] );
635 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
636 if (RtsFlags.GcFlags.generations < 1) {
637 bad_option(rts_argv[arg]);
642 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
643 if (RtsFlags.GcFlags.steps < 1) {
644 bad_option(rts_argv[arg]);
649 RtsFlags.GcFlags.heapSizeSuggestion =
650 decode(rts_argv[arg]+2) / BLOCK_SIZE;
652 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
653 bad_option(rts_argv[arg]);
658 RtsFlags.GcFlags.giveStats ++;
661 RtsFlags.GcFlags.giveStats ++;
663 /* Opening all those files would almost certainly fail... */
664 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
665 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
667 RtsFlags.GcFlags.statsFile
668 = open_stats_file(arg, *argc, argv,
669 *rts_argc, rts_argv, STAT_FILENAME_FMT);
671 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
676 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
679 /* =========== PROFILING ========================== */
681 case 'P': /* detailed cost centre profiling (time/alloc) */
682 COST_CENTRE_USING_BUILD_ONLY(
683 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
685 case 'p': /* cost centre profiling (time/alloc) */
686 COST_CENTRE_USING_BUILD_ONLY(
687 switch (rts_argv[arg][2]) {
689 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
692 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
697 case 'h': /* serial heap profile */
698 #if !defined(PROFILING) && defined(DEBUG)
699 switch (rts_argv[arg][2]) {
702 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
705 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
708 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
712 PROFILING_BUILD_ONLY(
713 switch (rts_argv[arg][2]) {
716 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
719 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
722 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
725 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
728 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
735 /* =========== CONCURRENT ========================= */
736 case 'C': /* context switch interval */
737 if (rts_argv[arg][2] == '\0')
738 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
742 /* Convert to milliseconds */
743 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
744 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
745 if (cst < CS_MIN_MILLISECS)
746 cst = CS_MIN_MILLISECS;
748 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
755 if (rts_argv[arg][2] != '\0') {
756 RtsFlags.ParFlags.nNodes
757 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
758 if (RtsFlags.ParFlags.nNodes <= 0) {
759 prog_belch("bad value for -N");
765 /* =========== PARALLEL =========================== */
767 PAR_OR_SMP_BUILD_ONLY(
768 if (rts_argv[arg][2] != '\0') {
769 RtsFlags.ParFlags.maxLocalSparks
770 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
771 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
772 prog_belch("bad value for -e");
780 process_par_option(arg, rts_argc, rts_argv, &error);
783 /* =========== GRAN =============================== */
787 process_gran_option(arg, rts_argc, rts_argv, &error);
790 /* =========== TICKY ============================== */
792 case 'r': /* Basic profiling stats */
795 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
796 RtsFlags.TickyFlags.tickyFile
797 = open_stats_file(arg, *argc, argv,
798 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
800 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
803 /* =========== EXTENDED OPTIONS =================== */
805 case 'x': /* Extend the argument space */
806 switch(rts_argv[arg][2]) {
808 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
812 case 'c': /* Debugging tool: show current cost centre on an exception */
813 PROFILING_BUILD_ONLY(
814 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
817 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
820 prog_belch("unknown RTS option: %s",rts_argv[arg]);
824 break; /* defensive programming */
826 /* =========== OH DEAR ============================ */
828 prog_belch("unknown RTS option: %s",rts_argv[arg]);
838 for (p = usage_text; *p; p++)
840 stg_exit(EXIT_FAILURE);
846 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
847 //@subsection GranSim specific options
850 enable_GranSimLight(void) {
852 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
853 RtsFlags.GranFlags.Light=rtsTrue;
854 RtsFlags.GranFlags.Costs.latency =
855 RtsFlags.GranFlags.Costs.fetchtime =
856 RtsFlags.GranFlags.Costs.additional_latency =
857 RtsFlags.GranFlags.Costs.gunblocktime =
858 RtsFlags.GranFlags.Costs.lunblocktime =
859 RtsFlags.GranFlags.Costs.threadcreatetime =
860 RtsFlags.GranFlags.Costs.threadqueuetime =
861 RtsFlags.GranFlags.Costs.threadscheduletime =
862 RtsFlags.GranFlags.Costs.threaddescheduletime =
863 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
865 RtsFlags.GranFlags.Costs.mpacktime =
866 RtsFlags.GranFlags.Costs.munpacktime = 0;
868 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
869 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
870 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
871 /* FetchStrategy is irrelevant in GrAnSim-Light */
873 /* GrAnSim Light often creates an abundance of parallel threads,
874 each with its own stack etc. Therefore, it's in general a good
875 idea to use small stack chunks (use the -o<size> option to
878 // RtsFlags.ConcFlags.stkChunkSize = 100;
880 RtsFlags.GranFlags.proc = 1;
884 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
886 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
889 /* or a ridiculously idealised simulator */
890 if(strcmp((rts_argv[arg]+2),"oring")==0) {
891 RtsFlags.GranFlags.Costs.latency =
892 RtsFlags.GranFlags.Costs.fetchtime =
893 RtsFlags.GranFlags.Costs.additional_latency =
894 RtsFlags.GranFlags.Costs.gunblocktime =
895 RtsFlags.GranFlags.Costs.lunblocktime =
896 RtsFlags.GranFlags.Costs.threadcreatetime =
897 RtsFlags.GranFlags.Costs.threadqueuetime =
898 RtsFlags.GranFlags.Costs.threadscheduletime =
899 RtsFlags.GranFlags.Costs.threaddescheduletime =
900 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
902 RtsFlags.GranFlags.Costs.mpacktime =
903 RtsFlags.GranFlags.Costs.munpacktime = 0;
905 RtsFlags.GranFlags.Costs.arith_cost =
906 RtsFlags.GranFlags.Costs.float_cost =
907 RtsFlags.GranFlags.Costs.load_cost =
908 RtsFlags.GranFlags.Costs.store_cost =
909 RtsFlags.GranFlags.Costs.branch_cost = 0;
911 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
913 /* ++RtsFlags.GranFlags.DoFairSchedule; */
914 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
915 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
916 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
920 /* or a somewhat idealised simulator */
921 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
922 RtsFlags.GranFlags.Costs.latency =
923 RtsFlags.GranFlags.Costs.fetchtime =
924 RtsFlags.GranFlags.Costs.additional_latency =
925 RtsFlags.GranFlags.Costs.gunblocktime =
926 RtsFlags.GranFlags.Costs.lunblocktime =
927 RtsFlags.GranFlags.Costs.threadcreatetime =
928 RtsFlags.GranFlags.Costs.threadqueuetime =
929 RtsFlags.GranFlags.Costs.threadscheduletime =
930 RtsFlags.GranFlags.Costs.threaddescheduletime =
931 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
933 RtsFlags.GranFlags.Costs.mpacktime =
934 RtsFlags.GranFlags.Costs.munpacktime = 0;
936 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
938 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
939 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
940 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
941 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
942 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
943 # if defined(GRAN_CHECK) && defined(GRAN)
944 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
949 /* Communication and task creation cost parameters */
950 switch(rts_argv[arg][2]) {
952 IgnoreYields = rtsTrue; // HWL HACK
956 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
960 if (rts_argv[arg][3] != '\0')
962 RtsFlags.GranFlags.Costs.gunblocktime =
963 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
964 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
967 RtsFlags.GranFlags.Costs.latency = LATENCY;
971 if (rts_argv[arg][3] != '\0')
972 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
974 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
978 if (rts_argv[arg][3] != '\0')
979 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
981 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
985 if (rts_argv[arg][3] != '\0')
986 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
988 RtsFlags.GranFlags.Costs.mtidytime = 0;
992 if (rts_argv[arg][3] != '\0')
993 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
995 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
999 if (rts_argv[arg][3] != '\0')
1000 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1002 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1006 if (rts_argv[arg][3] != '\0')
1007 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1009 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1013 if (rts_argv[arg][3] != '\0')
1014 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1016 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1019 /* Thread-related metrics */
1021 if (rts_argv[arg][3] != '\0')
1022 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1024 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1028 if (rts_argv[arg][3] != '\0')
1029 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1031 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1035 if (rts_argv[arg][3] != '\0')
1036 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1038 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1040 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1041 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1045 if (rts_argv[arg][3] != '\0')
1046 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1048 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1050 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1051 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1054 /* Instruction Cost Metrics */
1056 if (rts_argv[arg][3] != '\0')
1057 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1059 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1063 if (rts_argv[arg][3] != '\0')
1064 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1066 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1070 if (rts_argv[arg][3] != '\0')
1071 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1073 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1077 if (rts_argv[arg][3] != '\0')
1078 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1080 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1084 if (rts_argv[arg][3] != '\0')
1085 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1087 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1091 if (rts_argv[arg][3] != '\0')
1092 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1094 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1098 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1099 if (rts_argv[arg][3] != '\0')
1100 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1102 RtsFlags.GranFlags.FetchStrategy = 2;
1103 if (RtsFlags.GranFlags.FetchStrategy == 0)
1104 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1107 case 'K': /* sort overhead (per elem in spark list) */
1108 if (rts_argv[arg][3] != '\0')
1109 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1111 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1112 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1113 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1116 case 'O': /* sort overhead (per elem in spark list) */
1117 if (rts_argv[arg][3] != '\0')
1118 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1120 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1121 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1122 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1125 /* General Parameters */
1127 if (rts_argv[arg][3] != '\0')
1129 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1130 if (RtsFlags.GranFlags.proc==0) {
1131 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1132 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1133 RtsFlags.GranFlags.proc < 1)
1135 fprintf(stderr,"setupRtsFlags: no more than %u processors
1142 RtsFlags.GranFlags.proc = MAX_PROC;
1146 RtsFlags.GranFlags.Fishing = rtsTrue;
1147 if (rts_argv[arg][3] != '\0')
1148 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1150 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1154 if (rts_argv[arg][3] != '\0')
1155 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1157 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1161 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1162 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1166 fprintf(stderr,"Bulk fetching enabled.\n");
1167 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1171 fprintf(stderr,"Thread migration enabled.\n");
1172 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1176 fprintf(stderr,"Fair Scheduling enabled.\n");
1177 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1181 fprintf(stderr,"Priority Scheduling enabled.\n");
1182 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1186 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1187 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1191 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1195 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1199 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1203 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1207 /* format is -bP<c> where <c> is one char describing kind of profile */
1208 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1209 switch(rts_argv[arg][3]) {
1210 case '\0': break; // nothing special, just an ordinary profile
1211 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1213 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1215 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1217 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1219 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1221 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1223 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1228 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1232 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1235 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1236 if (rts_argv[arg][3] != '\0') {
1239 arg0 = rts_argv[arg]+3;
1240 if ((tmp = strstr(arg0,","))==NULL) {
1241 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1242 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1245 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1246 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1247 fprintf(stderr,"SparkPriority: %u.\n",
1248 RtsFlags.GranFlags.SparkPriority);
1249 fprintf(stderr,"SparkPriority2:%u.\n",
1250 RtsFlags.GranFlags.SparkPriority2);
1251 if (RtsFlags.GranFlags.SparkPriority2 <
1252 RtsFlags.GranFlags.SparkPriority) {
1253 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1254 RtsFlags.GranFlags.SparkPriority2,
1255 RtsFlags.GranFlags.SparkPriority);
1259 /* plain pri spark is now invoked with -bX
1260 RtsFlags.GranFlags.DoPrioritySparking = 1;
1261 fprintf(stderr,"PrioritySparking.\n");
1267 if (rts_argv[arg][3] != '\0') {
1268 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1270 RtsFlags.GranFlags.ThunksToPack = 1;
1272 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1273 RtsFlags.GranFlags.ThunksToPack);
1277 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1278 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1281 /* The following class of options contains eXperimental */
1282 /* features in connection with exploiting granularity */
1283 /* information. I.e. if -bY is chosen these options */
1284 /* tell the RTS what to do with the supplied info --HWL */
1287 if (rts_argv[arg][3] != '\0') {
1288 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1290 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1292 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1293 RtsFlags.GranFlags.packBufferSize_internal);
1297 switch(rts_argv[arg][3]) {
1300 RtsFlags.GranFlags.DoPrioritySparking = 1;
1301 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1302 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1303 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1304 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1308 RtsFlags.GranFlags.DoPrioritySparking = 1;
1309 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1310 RtsFlags.GranFlags.InversePriorities++;
1314 RtsFlags.GranFlags.DoPrioritySparking = 1;
1315 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1316 RtsFlags.GranFlags.RandomPriorities++;
1320 RtsFlags.GranFlags.DoPrioritySparking = 1;
1321 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1322 RtsFlags.GranFlags.IgnorePriorities++;
1326 bad_option( rts_argv[arg] );
1332 switch(rts_argv[arg][3]) {
1335 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1336 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1340 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1344 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1348 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1352 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1353 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1357 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1361 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1365 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1369 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1373 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1377 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1381 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1385 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1386 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1390 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1394 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1398 bad_option( rts_argv[arg] );
1403 # if defined(GRAN_CHECK) && defined(GRAN)
1405 switch(rts_argv[arg][3]) {
1406 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1407 if (rts_argv[arg][4] != '\0') {
1408 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1409 fprintf(stderr,"Pack buffer size: %d\n",
1410 RtsFlags.GranFlags.packBufferSize);
1412 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1418 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1419 /* hack warning: interpret the flags as a binary number */
1420 nat n = decode(rts_argv[arg]+3);
1421 set_GranSim_debug_options(n);
1424 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1425 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1428 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1429 fprintf(stderr, "Valid GranSim debug options are:\n");
1430 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1431 bad_option( rts_argv[arg] );
1432 } else { // flag found; now set it
1433 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1439 case 'e': /* event trace; also -bD1 */
1440 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1441 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1442 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1445 case 'E': /* event statistics; also -bD2 */
1446 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1447 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1448 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1451 case 'f': /* thunkStealing; also -bD4 */
1452 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1453 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1454 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1457 case 'z': /* blockOnFetch; also -bD8 */
1458 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1459 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1460 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1463 case 't': /* blockOnFetch_sanity; also -bD16 */
1464 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1465 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1466 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1469 case 'S': /* priSpark; also -bD32 */
1470 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1471 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1474 case 's': /* priSched; also -bD64 */
1475 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1476 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1479 case 'F': /* findWork; also -bD128 */
1480 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1481 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1484 case 'g': /* globalBlock; also -bD256 */
1485 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1486 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1489 case 'G': /* pack; also -bD512 */
1490 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1491 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1494 case 'P': /* packBuffer; also -bD1024 */
1495 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1496 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1499 case 'o': /* sortedQ; also -bD2048 */
1500 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1501 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1504 case 'r': /* randomSteal; also -bD4096 */
1505 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1506 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1509 case 'q': /* checkSparkQ; also -bD8192 */
1510 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1511 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1514 case ':': /* checkLight; also -bD16384 */
1515 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1516 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1519 case 'b': /* bq; also -bD32768 */
1520 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1521 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1524 case 'd': /* all options turned on */
1525 fprintf(stderr,"DEBUG: all options turned on.\n");
1526 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1527 /* RtsFlags.GranFlags.Debug |= 0x40; */
1531 /* RtsFlags.GranFlags.Debug = 1; */
1537 # endif /* GRAN_CHECK */
1539 bad_option( rts_argv[arg] );
1545 Interpret n as a binary number masking GranSim debug options and set the
1546 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1549 set_GranSim_debug_options(nat n) {
1552 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1554 fprintf(stderr, gran_debug_opts_strs[i]);
1556 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1557 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1558 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1559 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1560 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1561 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1562 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1563 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1564 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1565 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1566 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1567 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1568 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1569 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1570 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1571 default: barf("set_GranSim_debug_options: only %d debug options expected");
1577 Print one line explanation for each of the GranSim debug options specified
1581 help_GranSim_debug_options(nat n) {
1584 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1586 fprintf(stderr, gran_debug_opts_strs[i]);
1592 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1594 if (rts_argv[arg][1] != 'q') /* All GUM options start with -q */
1597 /* Communication and task creation cost parameters */
1598 switch(rts_argv[arg][2]) {
1599 case 'e': /* -qe<n> ... allow <n> local sparks */
1600 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1601 RtsFlags.ParFlags.maxLocalSparks
1602 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1604 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1605 belch("setupRtsFlags: bad value for -e\n");
1609 IF_PAR_DEBUG(verbose,
1610 belch("-qe<n>: max %d local sparks",
1611 RtsFlags.ParFlags.maxLocalSparks));
1615 if (rts_argv[arg][3] != '\0') {
1616 RtsFlags.ParFlags.maxThreads
1617 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1619 belch("setupRtsFlags: missing size for -qt\n");
1622 IF_PAR_DEBUG(verbose,
1623 belch("-qt<n>: max %d threads",
1624 RtsFlags.ParFlags.maxThreads));
1628 if (rts_argv[arg][3] != '\0')
1629 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1631 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1633 IF_PAR_DEBUG(verbose,
1634 belch("-qf<n>: max %d fishes sent out at one time",
1635 RtsFlags.ParFlags.maxFishes));
1640 if (rts_argv[arg][3] != '\0') {
1641 RtsFlags.ParFlags.fishDelay
1642 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1644 belch("setupRtsFlags: missing fish delay time for -qd\n");
1647 IF_PAR_DEBUG(verbose,
1648 belch("-qd<n>: fish delay time %d",
1649 RtsFlags.ParFlags.fishDelay));
1653 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1654 IF_PAR_DEBUG(verbose,
1655 belch("-qO: output disabled"));
1658 case 'P': /* -qP for writing a log file */
1659 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1660 /* same encoding as in GranSim after -bP */
1661 switch(rts_argv[arg][3]) {
1662 case '\0': break; // nothing special, just an ordinary profile
1663 //case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1665 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1667 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1669 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1671 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1673 case 'g': RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1675 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1677 IF_PAR_DEBUG(verbose,
1678 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1679 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1682 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1683 if (rts_argv[arg][3] != '\0') {
1684 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1686 belch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1689 IF_PAR_DEBUG(verbose,
1690 belch("-qQ<n>: pack buffer size set to %d",
1691 RtsFlags.ParFlags.packBufferSize));
1696 if (rts_argv[arg][3] != '\0') {
1697 RtsFlags.ParFlags.wait
1698 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1700 RtsFlags.ParFlags.wait = 1000;
1702 IF_PAR_DEBUG(verbose,
1703 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1704 RtsFlags.ParFlags.wait));
1707 case 'D': /* -qD ... all the debugging options */
1708 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1709 /* hack warning: interpret the flags as a binary number */
1710 nat n = decode(rts_argv[arg]+3);
1711 set_par_debug_options(n);
1714 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1715 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1718 if (i==MAX_PAR_DEBUG_OPTION+1) {
1719 fprintf(stderr, "Valid GUM debug options are:\n");
1720 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1721 bad_option( rts_argv[arg] );
1722 } else { // flag found; now set it
1723 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1729 belch("Unknown option -q%c", rts_argv[arg][2]);
1735 Interpret n as a binary number masking Par debug options and set the
1736 correxponding option. See par_debug_opts_strs for explanations of the flags.
1739 set_par_debug_options(nat n) {
1742 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1744 fprintf(stderr, par_debug_opts_strs[i]);
1746 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1747 case 1: RtsFlags.ParFlags.Debug.trace = rtsTrue; break;
1748 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1749 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1750 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1751 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1752 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1753 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1754 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1755 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
1756 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
1757 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1758 default: barf("set_par_debug_options: only %d debug options expected");
1764 Print one line explanation for each of the GranSim debug options specified
1768 help_par_debug_options(nat n) {
1771 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1773 fprintf(stderr, par_debug_opts_strs[i]);
1780 set_debug_options(nat n) {
1783 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1785 fprintf(stderr, debug_opts_strs[i]);
1787 case 0: RtsFlags.DebugFlags.scheduler = rtsTrue; break;
1788 case 1: RtsFlags.DebugFlags.evaluator = rtsTrue; break;
1789 case 2: RtsFlags.DebugFlags.codegen = rtsTrue; break;
1790 case 3: RtsFlags.DebugFlags.weak = rtsTrue; break;
1791 case 4: RtsFlags.DebugFlags.gccafs = rtsTrue; break;
1792 case 5: RtsFlags.DebugFlags.gc = rtsTrue; break;
1793 case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1794 case 7: RtsFlags.DebugFlags.sanity = rtsTrue; break;
1795 case 8: RtsFlags.DebugFlags.stable = rtsTrue; break;
1796 case 9: RtsFlags.DebugFlags.prof = rtsTrue; break;
1797 case 10: RtsFlags.DebugFlags.gran = rtsTrue; break;
1798 case 11: RtsFlags.DebugFlags.par = rtsTrue; break;
1804 help_debug_options(nat n) {
1807 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1809 fprintf(stderr, debug_opts_strs[i]);
1813 //@node Aux fcts, , GranSim specific options
1814 //@subsection Aux fcts
1816 static FILE * /* return NULL on error */
1819 int argc, char *argv[],
1820 int rts_argc, char *rts_argv[],
1821 const char *FILENAME_FMT)
1825 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
1827 else if (rts_argv[arg][2] != '\0') /* stats file specified */
1828 f = fopen(rts_argv[arg]+2,"w");
1830 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1831 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1832 f = fopen(stats_filename,"w");
1835 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
1837 /* Write argv and rtsv into start of stats file */
1839 for(count = 0; count < argc; count++)
1840 fprintf(f, "%s ", argv[count]);
1841 fprintf(f, "+RTS ");
1842 for(count = 0; count < rts_argc; count++)
1843 fprintf(f, "%s ", rts_argv[count]);
1851 decode(const char *s)
1862 if (c == 'g' || c == 'G')
1863 m *= 1000*1000*1000; /* UNchecked! */
1864 else if (c == 'm' || c == 'M')
1865 m *= 1000*1000; /* We do not use powers of 2 (1024) */
1866 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
1867 m *= 1000; /* a direct-mapped cache. */
1868 else if (c == 'w' || c == 'W')
1875 bad_option(const char *s)
1877 prog_belch("bad RTS option: %s", s);
1878 stg_exit(EXIT_FAILURE);