1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.28 2000/03/31 03:09:36 hwloidl Exp $
4 * (c) The AQUA Project, Glasgow University, 1994-1997
5 * (c) The GHC Team, 1998-1999
7 * Functions for parsing the argument list.
9 * ---------------------------------------------------------------------------*/
14 //* Static function decls::
15 //* Command-line option parsing routines::
16 //* GranSim specific options::
21 //@node Includes, Constants
22 //@subsection Includes
27 #include "BlockAlloc.h"
30 #if defined(PROFILING)
42 extern struct RTS_FLAGS RtsFlags;
45 * Split argument lists
47 int prog_argc; /* an "int" so as to match normal "argc" */
48 char **prog_argv = NULL;
49 int rts_argc; /* ditto */
50 char *rts_argv[MAX_RTS_ARGS];
52 //@node Constants, Static function decls, Includes
53 //@subsection Constants
56 * constants, used later
61 char *debug_opts_strs[] = {
62 "DEBUG (-D1): scheduler\n",
63 "DEBUG (-D2): evaluator\n",
64 "DEBUG (-D4): codegen\n",
65 "DEBUG (-D8): weak\n",
66 "DEBUG (-D16): gccafs\n",
68 "DEBUG (-D64): block\n",
69 "DEBUG (-D128): sanity\n",
70 "DEBUG (-D256): stable\n",
71 "DEBUG (-D512): prof\n",
72 "DEBUG (-D1024): gran\n",
73 "DEBUG (-D2048): par\n"
76 char *debug_opts_prefix[] = {
93 char *gran_debug_opts_strs[] = {
94 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
95 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
96 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
97 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
98 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
99 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
100 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
101 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
102 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
103 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
104 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
105 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
106 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
107 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
108 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
111 /* one character codes for the available debug options */
112 char gran_debug_opts_flags[] = {
113 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
116 /* prefix strings printed with the debug messages of the corresponding type */
117 char *gran_debug_opts_prefix[] = {
118 "", /* event_trace */
119 "", /* event_stats */
122 "^^", /* checkSparkQ */
123 "==", /* thunkStealing */
124 "^^", /* randomSteal */
128 "::", /* checkLight */
130 "", /* blockOnFetch */
132 "" /* blockOnFetch_sanity */
137 char *par_debug_opts_strs[] = {
138 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
139 "DEBUG (-qDt, -qD2): trace; trace messages.\n",
140 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
141 "DEBUG (-qDe, -qD8): free; free messages.\n",
142 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
143 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
144 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
145 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
146 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
147 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
148 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
149 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
150 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n"
153 /* one character codes for the available debug options */
154 char par_debug_opts_flags[] = {
155 'v', 't', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p'
158 /* prefix strings printed with the debug messages of the corresponding type */
159 char *par_debug_opts_prefix[] = {
176 //@node Static function decls, Command-line option parsing routines, Constants
177 //@subsection Static function decls
179 /* -----------------------------------------------------------------------------
180 Static function decls
181 -------------------------------------------------------------------------- */
183 static FILE * /* return NULL on error */
186 int argc, char *argv[],
187 int rts_argc, char *rts_argv[],
188 const char *FILENAME_FMT);
190 static I_ decode(const char *s);
191 static void bad_option(const char *s);
194 static void enable_GranSimLight(void);
195 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
196 static void set_GranSim_debug_options(nat n);
197 static void help_GranSim_debug_options(nat n);
199 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
200 static void set_par_debug_options(nat n);
201 static void help_par_debug_options(nat n);
203 static void set_debug_options(nat n);
204 static void help_debug_options(nat n);
206 //@node Command-line option parsing routines, GranSim specific options, Static function decls
207 //@subsection Command-line option parsing routines
209 /* -----------------------------------------------------------------------------
210 * Command-line option parsing routines.
211 * ---------------------------------------------------------------------------*/
213 void initRtsFlagsDefaults(void)
215 RtsFlags.GcFlags.statsFile = NULL;
216 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
218 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
219 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
221 RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE;
222 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
223 RtsFlags.GcFlags.maxHeapSize = (64 * 1024 * 1024) / BLOCK_SIZE;
224 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
225 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
226 RtsFlags.GcFlags.oldGenFactor = 2;
227 RtsFlags.GcFlags.generations = 2;
228 RtsFlags.GcFlags.steps = 2;
230 RtsFlags.GcFlags.forceGC = rtsFalse;
231 RtsFlags.GcFlags.forcingInterval = 5000000; /* 5MB (or words?) */
232 RtsFlags.GcFlags.ringBell = rtsFalse;
234 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
236 #if defined(PROFILING) || defined(PAR)
237 RtsFlags.CcFlags.doCostCentres = 0;
238 #endif /* PROFILING or PAR */
241 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
242 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
244 RtsFlags.ProfFlags.ccSelector = NULL;
245 RtsFlags.ProfFlags.modSelector = NULL;
246 RtsFlags.ProfFlags.descrSelector = NULL;
247 RtsFlags.ProfFlags.typeSelector = NULL;
248 RtsFlags.ProfFlags.kindSelector = NULL;
250 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
253 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
256 RtsFlags.ParFlags.nNodes = 1;
260 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
261 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
262 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
263 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
264 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
265 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
267 RtsFlags.ParFlags.outputDisabled = rtsFalse;
268 RtsFlags.ParFlags.packBufferSize = 1024;
270 RtsFlags.ParFlags.maxThreads = 1024;
271 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
272 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
275 #if defined(PAR) || defined(SMP)
276 RtsFlags.ParFlags.maxLocalSparks = 4096;
277 #endif /* PAR || SMP */
280 /* ToDo: check defaults for GranSim and GUM */
281 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
282 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
283 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
285 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
286 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
287 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
288 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
289 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
290 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
291 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
292 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
294 RtsFlags.GranFlags.packBufferSize = 1024;
295 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
297 RtsFlags.GranFlags.proc = MAX_PROC;
298 RtsFlags.GranFlags.Fishing = rtsFalse;
299 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
300 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
301 RtsFlags.GranFlags.Light = rtsFalse;
303 RtsFlags.GranFlags.Costs.latency = LATENCY;
304 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
305 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
306 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
307 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
308 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
309 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
310 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
312 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
313 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
314 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
315 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
316 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
318 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
319 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
320 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
321 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
322 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
324 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
326 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
327 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
329 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
330 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
331 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
332 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
333 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
334 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
335 RtsFlags.GranFlags.FetchStrategy = 2;
336 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
337 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
338 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
339 RtsFlags.GranFlags.SparkPriority = 0;
340 RtsFlags.GranFlags.SparkPriority2 = 0;
341 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
342 RtsFlags.GranFlags.InversePriorities = rtsFalse;
343 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
344 RtsFlags.GranFlags.ThunksToPack = 0;
345 RtsFlags.GranFlags.RandomSteal = rtsTrue;
349 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
350 RtsFlags.TickyFlags.tickyFile = NULL;
357 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
359 " +RTS Indicates run time system options follow",
360 " -RTS Indicates program arguments follow",
361 " --RTS Indicates that ALL subsequent arguments will be given to the",
362 " program (including any of these RTS flags)",
364 "The following run time system options are available:",
366 " -? -f Prints this message and exits; the program is not executed",
368 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
369 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
371 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
372 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
373 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
374 " -m<n>% Minimum % of heap which must be available (default 3%)",
375 " -G<n> Number of generations (default: 2)",
376 " -T<n> Number of steps in younger generations (default: 2)",
377 " -s<file> Summary GC statistics (default file: <program>.stat)",
378 " -S<file> Detailed GC statistics (with -Sstderr going to stderr)",
381 " -Z Don't squeeze out update frames on stack overflow",
382 " -B Sound the bell at the start of each garbage collection",
383 #if defined(PROFILING) || defined(PAR)
385 " -p<sort> Produce cost centre time profile (output file <program>.prof)",
386 " sort: T = time (default), A = alloc, C = cost centre label",
387 " -P<sort> Produce serial time profile (output file <program>.time)",
388 " and a -p profile with detailed tick/alloc info",
389 # if defined(PROFILING)
391 " -h<break-down> Heap residency profile (output file <program>.hp)",
392 " break-down: C = cost centre stack (default), M = module",
393 " D = closure description, Y = type description",
394 " T<ints>,<start> = time closure created",
395 " ints: no. of interval bands plotted (default 18)",
396 " start: seconds after which intervals start (default 0.0)",
397 " A subset of closures may be selected by the attached cost centre using:",
398 " -c{mod:lab,mod:lab...}, specific module:label cost centre(s)",
399 " -m{mod,mod...} all cost centres from the specified modules(s)",
400 " Selections can also be made by description, type, kind and age:",
401 " -d{des,des...} closures with specified closure descriptions",
402 " -y{typ,typ...} closures with specified type descriptions",
403 " -k{knd,knd...} closures of the specified kinds",
404 " -a<age> closures which survived <age> complete intervals",
405 " The selection logic used is summarised as follows:",
406 " ([-c] or [-m] or [-g]) and ([-d] or [-y] or [-k]) and [-a]",
407 " where an option is true if not specified",
409 " -xc Show current cost centre stack on raising an exception",
412 " -z<tbl><size> set hash table <size> for <tbl> (C, M, G, D or Y)",
414 " -i<secs> Number of seconds in a profiling interval (default 1.0):",
415 " heap profile (-h) and/or serial time profile (-P) frequency",
416 #endif /* PROFILING or PAR */
417 #if !defined(PROFILING) && defined(DEBUG)
419 " -h<break-down> Debugging Heap residency profile",
420 " (output file <program>.hp)",
421 " break-down: L = closure label (default)",
422 " T = closure type (constructor, thunk etc.)",
425 #if defined(TICKY_TICKY)
426 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
430 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
431 /* NB: the -N<n> is implemented by the driver!! */
433 " -C<secs> Context-switch interval in seconds",
434 " (0 or no argument means switch as often as possible)",
435 " the default is .01 sec; resolution is .01 sec",
437 " -N<n> Use <n> OS threads (default: 1)",
439 #if defined(SMP) || defined(PAR)
440 " -e<size> Size of spark pools (default 100)",
443 " -t<num> Set maximum number of advisory threads per PE (default 32)",
444 " -qP Enable activity profile (output files in ~/<program>*.gr)",
445 " -qQ<size> Set pack-buffer size (default: 1024)",
446 " -qd Turn on PVM-ish debugging",
447 " -qO Disable output for performance measurement",
449 #if defined(SMP) || defined(PAR)
450 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
453 " -d Turn on PVM-ish debugging",
454 " -O Disable output for performance measurement",
456 #if defined(GRAN) /* ToDo: fill in decent Docu here */
457 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
460 "Other RTS options may be available for programs compiled a different way.",
461 "The GHC User's Guide has full details.",
466 static __inline__ rtsBool
467 strequal(const char *a, const char * b)
469 return(strcmp(a, b) == 0);
473 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
475 rtsBool error = rtsFalse;
480 /* Remove directory from argv[0] -- default files in current directory */
482 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
483 strcpy(argv[0], last_slash+1);
485 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
486 /* argv[0] must be PGM argument -- leave in argv */
494 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
495 if (strequal("+RTS", argv[arg])) {
498 else if (strequal("-RTS", argv[arg])) {
501 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
502 rts_argv[(*rts_argc)++] = argv[arg];
504 else if (mode == PGM) {
505 argv[(*argc)++] = argv[arg];
508 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
511 if (arg < total_arg) {
512 /* arg must be --RTS; process remaining program arguments */
513 while (++arg < total_arg) {
514 argv[(*argc)++] = argv[arg];
517 argv[*argc] = (char *) 0;
518 rts_argv[*rts_argc] = (char *) 0;
520 /* Process RTS (rts_argv) part: mainly to determine statsfile */
522 for (arg = 0; arg < *rts_argc; arg++) {
523 if (rts_argv[arg][0] != '-') {
525 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
529 switch(rts_argv[arg][1]) {
531 /* process: general args, then PROFILING-only ones,
532 then CONCURRENT-only, PARallel-only, GRAN-only,
533 TICKY-only (same order as defined in RtsFlags.lh);
534 within those groups, mostly in case-insensitive
536 Final group is x*, which allows for more options.
540 # define TICKY_BUILD_ONLY(x) x
542 # define TICKY_BUILD_ONLY(x) \
543 prog_belch("GHC not built for: ticky-ticky stats"); \
547 #if defined(PROFILING)
548 # define COST_CENTRE_USING_BUILD_ONLY(x) x
550 # define COST_CENTRE_USING_BUILD_ONLY(x) \
551 prog_belch("GHC not built for: -prof or -parallel"); \
556 # define PROFILING_BUILD_ONLY(x) x
558 # define PROFILING_BUILD_ONLY(x) \
559 prog_belch("GHC not built for: -prof"); \
564 # define SMP_BUILD_ONLY(x) x
566 # define SMP_BUILD_ONLY(x) \
567 prog_belch("GHC not built for: -parallel"); \
572 # define PAR_BUILD_ONLY(x) x
574 # define PAR_BUILD_ONLY(x) \
575 prog_belch("GHC not built for: -parallel"); \
579 #if defined(SMP) || defined(PAR)
580 # define PAR_OR_SMP_BUILD_ONLY(x) x
582 # define PAR_OR_SMP_BUILD_ONLY(x) \
583 prog_belch("GHC not built for: -parallel or -smp"); \
588 # define GRAN_BUILD_ONLY(x) x
590 # define GRAN_BUILD_ONLY(x) \
591 prog_belch("GHC not built for: -gransim"); \
595 /* =========== GENERAL ========================== */
602 RtsFlags.GcFlags.minAllocAreaSize
603 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
604 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
605 bad_option(rts_argv[arg]);
610 RtsFlags.GcFlags.ringBell = rtsTrue;
614 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
616 if (RtsFlags.GcFlags.oldGenFactor < 0)
617 bad_option( rts_argv[arg] );
622 if (isdigit(rts_argv[arg][2])) {/* Set all debugging options in one */
623 /* hack warning: interpret the flags as a binary number */
624 nat n = decode(rts_argv[arg]+2);
625 set_debug_options(n);
631 RtsFlags.GcFlags.maxStkSize =
632 decode(rts_argv[arg]+2) / sizeof(W_);
634 if (RtsFlags.GcFlags.maxStkSize == 0)
635 bad_option( rts_argv[arg] );
639 RtsFlags.GcFlags.initialStkSize =
640 decode(rts_argv[arg]+2) / sizeof(W_);
642 if (RtsFlags.GcFlags.initialStkSize == 0)
643 bad_option( rts_argv[arg] );
647 RtsFlags.GcFlags.maxHeapSize =
648 decode(rts_argv[arg]+2) / BLOCK_SIZE;
649 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
651 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
652 bad_option(rts_argv[arg]);
657 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
659 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
660 RtsFlags.GcFlags.pcFreeHeap > 100)
661 bad_option( rts_argv[arg] );
665 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
666 if (RtsFlags.GcFlags.generations < 1) {
667 bad_option(rts_argv[arg]);
672 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
673 if (RtsFlags.GcFlags.steps < 1) {
674 bad_option(rts_argv[arg]);
679 RtsFlags.GcFlags.heapSizeSuggestion =
680 decode(rts_argv[arg]+2) / BLOCK_SIZE;
682 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
683 bad_option(rts_argv[arg]);
687 case 'j': /* force GC option */
688 RtsFlags.GcFlags.forceGC = rtsTrue;
689 if (rts_argv[arg][2]) {
690 RtsFlags.GcFlags.forcingInterval
691 = decode(rts_argv[arg]+2) / sizeof(W_);
696 RtsFlags.GcFlags.giveStats ++;
699 RtsFlags.GcFlags.giveStats ++;
701 /* Opening all those files would almost certainly fail... */
702 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
703 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
705 RtsFlags.GcFlags.statsFile
706 = open_stats_file(arg, *argc, argv,
707 *rts_argc, rts_argv, STAT_FILENAME_FMT);
709 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
714 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
717 /* =========== PROFILING ========================== */
719 case 'P': /* detailed cost centre profiling (time/alloc) */
720 COST_CENTRE_USING_BUILD_ONLY(
721 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
723 case 'p': /* cost centre profiling (time/alloc) */
724 COST_CENTRE_USING_BUILD_ONLY(
725 switch (rts_argv[arg][2]) {
727 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
730 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
735 case 'i': /* serial profiling -- initial timer interval */
736 COST_CENTRE_USING_BUILD_ONLY(
737 interval_ticks = (I_) ((atof(rts_argv[arg]+2) * TICK_FREQUENCY));
738 if (interval_ticks <= 0)
742 case 'h': /* serial heap profile */
743 #if !defined(PROFILING) && defined(DEBUG)
744 switch (rts_argv[arg][2]) {
747 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
750 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
753 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
757 PROFILING_BUILD_ONLY(
758 switch (rts_argv[arg][2]) {
761 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
764 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
767 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
770 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
773 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TIME;
774 if (rts_argv[arg][3]) {
775 char *start_str = strchr(rts_argv[arg]+3, ',');
777 if (start_str) *start_str = '\0';
779 if ((intervals = decode(rts_argv[arg]+3)) != 0) {
780 time_intervals = (hash_t) intervals;
781 /* ToDo: and what if it *is* zero intervals??? */
784 earlier_ticks = (I_)((atof(start_str + 1) * TICK_FREQUENCY));
789 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
796 case 'z': /* size of index tables */
797 PROFILING_BUILD_ONLY(
798 switch (rts_argv[arg][2]) {
800 max_cc_no = (hash_t) decode(rts_argv[arg]+3);
801 if (max_cc_no == 0) {
802 prog_belch("bad number of cost centres %s", rts_argv[arg]);
807 max_mod_no = (hash_t) decode(rts_argv[arg]+3);
808 if (max_mod_no == 0) {
809 prog_belch("bad number of modules %s", rts_argv[arg]);
814 max_descr_no = (hash_t) decode(rts_argv[arg]+3);
815 if (max_descr_no == 0) {
816 prog_belch("bad number of closure descriptions %s",
822 max_type_no = (hash_t) decode(rts_argv[arg]+3);
823 if (max_type_no == 0) {
824 prog_belch("bad number of type descriptions %s",
830 prog_belch("invalid index table size option: %s",
836 case 'c': /* cost centre label select */
837 case 'd': /* closure descr select */
838 case 'y': /* closure type select */
839 PROFILING_BUILD_ONLY(
840 {char *left = strchr(rts_argv[arg], '{');
841 char *right = strrchr(rts_argv[arg], '}');
843 if (! left || ! right ||
844 strrchr(rts_argv[arg], '{') != left ||
845 strchr(rts_argv[arg], '}') != right) {
846 prog_belch("invalid heap profiling selection bracketing: %s",
851 switch (rts_argv[arg][1]) {
852 case 'c': /* cost centre label select */
853 RtsFlags.ProfFlags.ccSelector = left + 1;
855 case 'm': /* cost centre module select */
856 RtsFlags.ProfFlags.modSelector = left + 1;
858 case 'd': /* closure descr select */
859 RtsFlags.ProfFlags.descrSelector = left + 1;
861 case 'y': /* closure type select */
862 RtsFlags.ProfFlags.typeSelector = left + 1;
864 case 'k': /* closure kind select */
865 RtsFlags.ProfFlags.kindSelector = left + 1;
871 /* =========== CONCURRENT ========================= */
872 case 'C': /* context switch interval */
873 if (rts_argv[arg][2] == '\0')
874 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
878 /* Convert to milliseconds */
879 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
880 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
881 if (cst < CS_MIN_MILLISECS)
882 cst = CS_MIN_MILLISECS;
884 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
891 if (rts_argv[arg][2] != '\0') {
892 RtsFlags.ParFlags.nNodes
893 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
894 if (RtsFlags.ParFlags.nNodes <= 0) {
895 prog_belch("bad value for -N");
901 /* =========== PARALLEL =========================== */
903 PAR_OR_SMP_BUILD_ONLY(
904 if (rts_argv[arg][2] != '\0') {
905 RtsFlags.ParFlags.maxLocalSparks
906 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
907 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
908 prog_belch("bad value for -e");
916 process_par_option(arg, rts_argc, rts_argv, &error);
919 /* =========== GRAN =============================== */
923 process_gran_option(arg, rts_argc, rts_argv, &error);
926 /* =========== TICKY ============================== */
928 case 'r': /* Basic profiling stats */
931 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
932 RtsFlags.TickyFlags.tickyFile
933 = open_stats_file(arg, *argc, argv,
934 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
936 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
939 /* =========== EXTENDED OPTIONS =================== */
941 case 'x': /* Extend the argument space */
942 switch(rts_argv[arg][2]) {
944 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
948 case 'c': /* Debugging tool: show current cost centre on an exception */
949 PROFILING_BUILD_ONLY(
950 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
953 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
956 prog_belch("unknown RTS option: %s",rts_argv[arg]);
960 break; /* defensive programming */
962 /* =========== OH DEAR ============================ */
964 prog_belch("unknown RTS option: %s",rts_argv[arg]);
974 for (p = usage_text; *p; p++)
976 stg_exit(EXIT_FAILURE);
982 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
983 //@subsection GranSim specific options
986 enable_GranSimLight(void) {
988 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
989 RtsFlags.GranFlags.Light=rtsTrue;
990 RtsFlags.GranFlags.Costs.latency =
991 RtsFlags.GranFlags.Costs.fetchtime =
992 RtsFlags.GranFlags.Costs.additional_latency =
993 RtsFlags.GranFlags.Costs.gunblocktime =
994 RtsFlags.GranFlags.Costs.lunblocktime =
995 RtsFlags.GranFlags.Costs.threadcreatetime =
996 RtsFlags.GranFlags.Costs.threadqueuetime =
997 RtsFlags.GranFlags.Costs.threadscheduletime =
998 RtsFlags.GranFlags.Costs.threaddescheduletime =
999 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1001 RtsFlags.GranFlags.Costs.mpacktime =
1002 RtsFlags.GranFlags.Costs.munpacktime = 0;
1004 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1005 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1006 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1007 /* FetchStrategy is irrelevant in GrAnSim-Light */
1009 /* GrAnSim Light often creates an abundance of parallel threads,
1010 each with its own stack etc. Therefore, it's in general a good
1011 idea to use small stack chunks (use the -o<size> option to
1014 // RtsFlags.ConcFlags.stkChunkSize = 100;
1016 RtsFlags.GranFlags.proc = 1;
1020 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1022 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1025 /* or a ridiculously idealised simulator */
1026 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1027 RtsFlags.GranFlags.Costs.latency =
1028 RtsFlags.GranFlags.Costs.fetchtime =
1029 RtsFlags.GranFlags.Costs.additional_latency =
1030 RtsFlags.GranFlags.Costs.gunblocktime =
1031 RtsFlags.GranFlags.Costs.lunblocktime =
1032 RtsFlags.GranFlags.Costs.threadcreatetime =
1033 RtsFlags.GranFlags.Costs.threadqueuetime =
1034 RtsFlags.GranFlags.Costs.threadscheduletime =
1035 RtsFlags.GranFlags.Costs.threaddescheduletime =
1036 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1038 RtsFlags.GranFlags.Costs.mpacktime =
1039 RtsFlags.GranFlags.Costs.munpacktime = 0;
1041 RtsFlags.GranFlags.Costs.arith_cost =
1042 RtsFlags.GranFlags.Costs.float_cost =
1043 RtsFlags.GranFlags.Costs.load_cost =
1044 RtsFlags.GranFlags.Costs.store_cost =
1045 RtsFlags.GranFlags.Costs.branch_cost = 0;
1047 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1049 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1050 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1051 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1052 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1056 /* or a somewhat idealised simulator */
1057 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1058 RtsFlags.GranFlags.Costs.latency =
1059 RtsFlags.GranFlags.Costs.fetchtime =
1060 RtsFlags.GranFlags.Costs.additional_latency =
1061 RtsFlags.GranFlags.Costs.gunblocktime =
1062 RtsFlags.GranFlags.Costs.lunblocktime =
1063 RtsFlags.GranFlags.Costs.threadcreatetime =
1064 RtsFlags.GranFlags.Costs.threadqueuetime =
1065 RtsFlags.GranFlags.Costs.threadscheduletime =
1066 RtsFlags.GranFlags.Costs.threaddescheduletime =
1067 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1069 RtsFlags.GranFlags.Costs.mpacktime =
1070 RtsFlags.GranFlags.Costs.munpacktime = 0;
1072 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1074 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1075 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1076 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1077 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1078 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1079 # if defined(GRAN_CHECK) && defined(GRAN)
1080 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1085 /* Communication and task creation cost parameters */
1086 switch(rts_argv[arg][2]) {
1088 IgnoreYields = rtsTrue; // HWL HACK
1092 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1096 if (rts_argv[arg][3] != '\0')
1098 RtsFlags.GranFlags.Costs.gunblocktime =
1099 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1100 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1103 RtsFlags.GranFlags.Costs.latency = LATENCY;
1107 if (rts_argv[arg][3] != '\0')
1108 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1110 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1114 if (rts_argv[arg][3] != '\0')
1115 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1117 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1121 if (rts_argv[arg][3] != '\0')
1122 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1124 RtsFlags.GranFlags.Costs.mtidytime = 0;
1128 if (rts_argv[arg][3] != '\0')
1129 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1131 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1135 if (rts_argv[arg][3] != '\0')
1136 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1138 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1142 if (rts_argv[arg][3] != '\0')
1143 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1145 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1149 if (rts_argv[arg][3] != '\0')
1150 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1152 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1155 /* Thread-related metrics */
1157 if (rts_argv[arg][3] != '\0')
1158 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1160 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1164 if (rts_argv[arg][3] != '\0')
1165 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1167 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1171 if (rts_argv[arg][3] != '\0')
1172 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1174 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1176 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1177 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1181 if (rts_argv[arg][3] != '\0')
1182 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1184 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1186 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1187 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1190 /* Instruction Cost Metrics */
1192 if (rts_argv[arg][3] != '\0')
1193 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1195 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1199 if (rts_argv[arg][3] != '\0')
1200 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1202 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1206 if (rts_argv[arg][3] != '\0')
1207 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1209 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1213 if (rts_argv[arg][3] != '\0')
1214 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1216 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1220 if (rts_argv[arg][3] != '\0')
1221 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1223 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1227 if (rts_argv[arg][3] != '\0')
1228 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1230 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1234 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1235 if (rts_argv[arg][3] != '\0')
1236 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1238 RtsFlags.GranFlags.FetchStrategy = 2;
1239 if (RtsFlags.GranFlags.FetchStrategy == 0)
1240 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1243 case 'K': /* sort overhead (per elem in spark list) */
1244 if (rts_argv[arg][3] != '\0')
1245 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1247 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1248 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1249 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1252 case 'O': /* sort overhead (per elem in spark list) */
1253 if (rts_argv[arg][3] != '\0')
1254 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1256 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1257 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1258 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1261 /* General Parameters */
1263 if (rts_argv[arg][3] != '\0')
1265 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1266 if (RtsFlags.GranFlags.proc==0) {
1267 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1268 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1269 RtsFlags.GranFlags.proc < 1)
1271 fprintf(stderr,"setupRtsFlags: no more than %u processors
1278 RtsFlags.GranFlags.proc = MAX_PROC;
1282 RtsFlags.GranFlags.Fishing = rtsTrue;
1283 if (rts_argv[arg][3] != '\0')
1284 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1286 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1290 if (rts_argv[arg][3] != '\0')
1291 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1293 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1297 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1298 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1302 fprintf(stderr,"Bulk fetching enabled.\n");
1303 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1307 fprintf(stderr,"Thread migration enabled.\n");
1308 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1312 fprintf(stderr,"Fair Scheduling enabled.\n");
1313 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1317 fprintf(stderr,"Priority Scheduling enabled.\n");
1318 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1322 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1323 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1327 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1331 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1335 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1339 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1343 /* format is -bP<c> where <c> is one char describing kind of profile */
1344 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1345 switch(rts_argv[arg][3]) {
1346 case '\0': break; // nothing special, just an ordinary profile
1347 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1349 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1351 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1353 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1355 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1357 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1359 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1364 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1368 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1371 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1372 if (rts_argv[arg][3] != '\0') {
1375 arg0 = rts_argv[arg]+3;
1376 if ((tmp = strstr(arg0,","))==NULL) {
1377 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1378 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1381 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1382 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1383 fprintf(stderr,"SparkPriority: %u.\n",
1384 RtsFlags.GranFlags.SparkPriority);
1385 fprintf(stderr,"SparkPriority2:%u.\n",
1386 RtsFlags.GranFlags.SparkPriority2);
1387 if (RtsFlags.GranFlags.SparkPriority2 <
1388 RtsFlags.GranFlags.SparkPriority) {
1389 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1390 RtsFlags.GranFlags.SparkPriority2,
1391 RtsFlags.GranFlags.SparkPriority);
1395 /* plain pri spark is now invoked with -bX
1396 RtsFlags.GranFlags.DoPrioritySparking = 1;
1397 fprintf(stderr,"PrioritySparking.\n");
1403 if (rts_argv[arg][3] != '\0') {
1404 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1406 RtsFlags.GranFlags.ThunksToPack = 1;
1408 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1409 RtsFlags.GranFlags.ThunksToPack);
1413 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1414 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1417 /* The following class of options contains eXperimental */
1418 /* features in connection with exploiting granularity */
1419 /* information. I.e. if -bY is chosen these options */
1420 /* tell the RTS what to do with the supplied info --HWL */
1423 if (rts_argv[arg][3] != '\0') {
1424 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1426 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1428 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1429 RtsFlags.GranFlags.packBufferSize_internal);
1433 switch(rts_argv[arg][3]) {
1436 RtsFlags.GranFlags.DoPrioritySparking = 1;
1437 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1438 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1439 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1440 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1444 RtsFlags.GranFlags.DoPrioritySparking = 1;
1445 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1446 RtsFlags.GranFlags.InversePriorities++;
1450 RtsFlags.GranFlags.DoPrioritySparking = 1;
1451 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1452 RtsFlags.GranFlags.RandomPriorities++;
1456 RtsFlags.GranFlags.DoPrioritySparking = 1;
1457 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1458 RtsFlags.GranFlags.IgnorePriorities++;
1462 bad_option( rts_argv[arg] );
1468 switch(rts_argv[arg][3]) {
1471 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1472 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1476 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1480 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1484 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1488 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1489 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1493 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1497 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1501 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1505 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1509 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1513 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1517 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1521 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1522 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1526 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1530 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1534 bad_option( rts_argv[arg] );
1539 # if defined(GRAN_CHECK) && defined(GRAN)
1541 switch(rts_argv[arg][3]) {
1542 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1543 if (rts_argv[arg][4] != '\0') {
1544 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1545 fprintf(stderr,"Pack buffer size: %d\n",
1546 RtsFlags.GranFlags.packBufferSize);
1548 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1554 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1555 /* hack warning: interpret the flags as a binary number */
1556 nat n = decode(rts_argv[arg]+3);
1557 set_GranSim_debug_options(n);
1560 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1561 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1564 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1565 fprintf(stderr, "Valid GranSim debug options are:\n");
1566 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1567 bad_option( rts_argv[arg] );
1568 } else { // flag found; now set it
1569 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1575 case 'e': /* event trace; also -bD1 */
1576 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1577 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1578 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1581 case 'E': /* event statistics; also -bD2 */
1582 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1583 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1584 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1587 case 'f': /* thunkStealing; also -bD4 */
1588 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1589 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1590 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1593 case 'z': /* blockOnFetch; also -bD8 */
1594 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1595 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1596 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1599 case 't': /* blockOnFetch_sanity; also -bD16 */
1600 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1601 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1602 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1605 case 'S': /* priSpark; also -bD32 */
1606 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1607 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1610 case 's': /* priSched; also -bD64 */
1611 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1612 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1615 case 'F': /* findWork; also -bD128 */
1616 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1617 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1620 case 'g': /* globalBlock; also -bD256 */
1621 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1622 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1625 case 'G': /* pack; also -bD512 */
1626 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1627 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1630 case 'P': /* packBuffer; also -bD1024 */
1631 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1632 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1635 case 'o': /* sortedQ; also -bD2048 */
1636 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1637 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1640 case 'r': /* randomSteal; also -bD4096 */
1641 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1642 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1645 case 'q': /* checkSparkQ; also -bD8192 */
1646 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1647 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1650 case ':': /* checkLight; also -bD16384 */
1651 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1652 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1655 case 'b': /* bq; also -bD32768 */
1656 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1657 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1660 case 'd': /* all options turned on */
1661 fprintf(stderr,"DEBUG: all options turned on.\n");
1662 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1663 /* RtsFlags.GranFlags.Debug |= 0x40; */
1667 /* RtsFlags.GranFlags.Debug = 1; */
1673 # endif /* GRAN_CHECK */
1675 bad_option( rts_argv[arg] );
1681 Interpret n as a binary number masking GranSim debug options and set the
1682 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1685 set_GranSim_debug_options(nat n) {
1688 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1690 fprintf(stderr, gran_debug_opts_strs[i]);
1692 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1693 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1694 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1695 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1696 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1697 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1698 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1699 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1700 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1701 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1702 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1703 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1704 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1705 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1706 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1707 default: barf("set_GranSim_debug_options: only %d debug options expected");
1713 Print one line explanation for each of the GranSim debug options specified
1717 help_GranSim_debug_options(nat n) {
1720 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1722 fprintf(stderr, gran_debug_opts_strs[i]);
1728 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1730 if (rts_argv[arg][1] != 'q') /* All GUM options start with -q */
1733 /* Communication and task creation cost parameters */
1734 switch(rts_argv[arg][2]) {
1735 case 'e': /* -qe<n> ... allow <n> local sparks */
1736 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1737 RtsFlags.ParFlags.maxLocalSparks
1738 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1740 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1741 belch("setupRtsFlags: bad value for -e\n");
1745 IF_PAR_DEBUG(verbose,
1746 belch("-qe<n>: max %d local sparks",
1747 RtsFlags.ParFlags.maxLocalSparks));
1751 if (rts_argv[arg][3] != '\0') {
1752 RtsFlags.ParFlags.maxThreads
1753 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1755 belch("setupRtsFlags: missing size for -qt\n");
1758 IF_PAR_DEBUG(verbose,
1759 belch("-qt<n>: max %d threads",
1760 RtsFlags.ParFlags.maxThreads));
1764 if (rts_argv[arg][3] != '\0')
1765 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1767 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1769 IF_PAR_DEBUG(verbose,
1770 belch("-qf<n>: max %d fishes sent out at one time",
1771 RtsFlags.ParFlags.maxFishes));
1776 if (rts_argv[arg][3] != '\0') {
1777 RtsFlags.ParFlags.fishDelay
1778 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1780 belch("setupRtsFlags: missing fish delay time for -qd\n");
1783 IF_PAR_DEBUG(verbose,
1784 belch("-qd<n>: fish delay time %d",
1785 RtsFlags.ParFlags.fishDelay));
1789 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1790 IF_PAR_DEBUG(verbose,
1791 belch("-qO: output disabled"));
1794 case 'P': /* -qP for writing a log file */
1795 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1796 /* same encoding as in GranSim after -bP */
1797 switch(rts_argv[arg][3]) {
1798 case '\0': break; // nothing special, just an ordinary profile
1799 //case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1801 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1803 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1805 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1807 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1809 case 'g': RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1811 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1813 IF_PAR_DEBUG(verbose,
1814 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1815 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1818 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1819 if (rts_argv[arg][3] != '\0') {
1820 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1822 belch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1825 IF_PAR_DEBUG(verbose,
1826 belch("-qQ<n>: pack buffer size set to %d",
1827 RtsFlags.ParFlags.packBufferSize));
1832 if (rts_argv[arg][3] != '\0') {
1833 RtsFlags.ParFlags.wait
1834 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1836 RtsFlags.ParFlags.wait = 1000;
1838 IF_PAR_DEBUG(verbose,
1839 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1840 RtsFlags.ParFlags.wait));
1843 case 'D': /* -qD ... all the debugging options */
1844 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1845 /* hack warning: interpret the flags as a binary number */
1846 nat n = decode(rts_argv[arg]+3);
1847 set_par_debug_options(n);
1850 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1851 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1854 if (i==MAX_PAR_DEBUG_OPTION+1) {
1855 fprintf(stderr, "Valid GUM debug options are:\n");
1856 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1857 bad_option( rts_argv[arg] );
1858 } else { // flag found; now set it
1859 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1865 belch("Unknown option -q%c", rts_argv[arg][2]);
1871 Interpret n as a binary number masking Par debug options and set the
1872 correxponding option. See par_debug_opts_strs for explanations of the flags.
1875 set_par_debug_options(nat n) {
1878 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1880 fprintf(stderr, par_debug_opts_strs[i]);
1882 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1883 case 1: RtsFlags.ParFlags.Debug.trace = rtsTrue; break;
1884 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1885 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1886 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1887 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1888 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1889 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1890 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1891 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
1892 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
1893 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1894 default: barf("set_par_debug_options: only %d debug options expected");
1900 Print one line explanation for each of the GranSim debug options specified
1904 help_par_debug_options(nat n) {
1907 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1909 fprintf(stderr, par_debug_opts_strs[i]);
1915 set_debug_options(nat n) {
1918 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1920 fprintf(stderr, debug_opts_strs[i]);
1922 case 0: RtsFlags.DebugFlags.scheduler = rtsTrue; break;
1923 case 1: RtsFlags.DebugFlags.evaluator = rtsTrue; break;
1924 case 2: RtsFlags.DebugFlags.codegen = rtsTrue; break;
1925 case 3: RtsFlags.DebugFlags.weak = rtsTrue; break;
1926 case 4: RtsFlags.DebugFlags.gccafs = rtsTrue; break;
1927 case 5: RtsFlags.DebugFlags.gc = rtsTrue; break;
1928 case 6: RtsFlags.DebugFlags.block_alloc = rtsTrue; break;
1929 case 7: RtsFlags.DebugFlags.sanity = rtsTrue; break;
1930 case 8: RtsFlags.DebugFlags.stable = rtsTrue; break;
1931 case 9: RtsFlags.DebugFlags.prof = rtsTrue; break;
1932 case 10: RtsFlags.DebugFlags.gran = rtsTrue; break;
1933 case 11: RtsFlags.DebugFlags.par = rtsTrue; break;
1939 help_debug_options(nat n) {
1942 for (i=0; i<=MAX_DEBUG_OPTION; i++)
1944 fprintf(stderr, debug_opts_strs[i]);
1947 //@node Aux fcts, , GranSim specific options
1948 //@subsection Aux fcts
1950 static FILE * /* return NULL on error */
1953 int argc, char *argv[],
1954 int rts_argc, char *rts_argv[],
1955 const char *FILENAME_FMT)
1959 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
1961 else if (rts_argv[arg][2] != '\0') /* stats file specified */
1962 f = fopen(rts_argv[arg]+2,"w");
1964 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1965 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1966 f = fopen(stats_filename,"w");
1969 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
1971 /* Write argv and rtsv into start of stats file */
1973 for(count = 0; count < argc; count++)
1974 fprintf(f, "%s ", argv[count]);
1975 fprintf(f, "+RTS ");
1976 for(count = 0; count < rts_argc; count++)
1977 fprintf(f, "%s ", rts_argv[count]);
1985 decode(const char *s)
1996 if (c == 'g' || c == 'G')
1997 m *= 1000*1000*1000; /* UNchecked! */
1998 else if (c == 'm' || c == 'M')
1999 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2000 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2001 m *= 1000; /* a direct-mapped cache. */
2002 else if (c == 'w' || c == 'W')
2009 bad_option(const char *s)
2011 prog_belch("bad RTS option: %s", s);
2012 stg_exit(EXIT_FAILURE);