1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.c,v 1.26 2000/02/17 17:19:42 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"
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
63 char *gran_debug_opts_strs[] = {
64 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
65 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
66 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
67 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
68 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
69 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
70 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
71 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
72 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
73 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
74 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
75 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
76 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
77 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
78 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
81 /* one character codes for the available debug options */
82 char gran_debug_opts_flags[] = {
83 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
86 /* prefix strings printed with the debug messages of the corresponding type */
87 char *gran_debug_opts_prefix[] = {
92 "^^", /* checkSparkQ */
93 "==", /* thunkStealing */
94 "^^", /* randomSteal */
98 "::", /* checkLight */
100 "", /* blockOnFetch */
102 "" /* blockOnFetch_sanity */
107 char *par_debug_opts_strs[] = {
108 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
109 "DEBUG (-qDt, -qD2): trace; trace messages.\n",
110 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
111 "DEBUG (-qDe, -qD8): free; free messages.\n",
112 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
113 "DEBUG (-qDw, -qD32): weight; print weights for GC.\n",
114 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
115 "DEBUG (-qDa, -qD128): ack; ack messages.\n",
116 "DEBUG (-qDf, -qD256): fish; fish messages.\n",
117 "DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
118 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n"
121 /* one character codes for the available debug options */
122 char par_debug_opts_flags[] = {
123 'v', 't', 's', 'e', 'r', 'w', 'F', 'a', 'f', 'o', 'p'
126 /* prefix strings printed with the debug messages of the corresponding type */
127 char *par_debug_opts_prefix[] = {
143 //@node Static function decls, Command-line option parsing routines, Constants
144 //@subsection Static function decls
146 /* -----------------------------------------------------------------------------
147 Static function decls
148 -------------------------------------------------------------------------- */
150 static FILE * /* return NULL on error */
153 int argc, char *argv[],
154 int rts_argc, char *rts_argv[],
155 const char *FILENAME_FMT);
157 static I_ decode(const char *s);
158 static void bad_option(const char *s);
161 static void enable_GranSimLight(void);
162 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
163 static void set_GranSim_debug_options(nat n);
164 static void help_GranSim_debug_options(nat n);
166 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
167 static void set_par_debug_options(nat n);
168 static void help_par_debug_options(nat n);
171 //@node Command-line option parsing routines, GranSim specific options, Static function decls
172 //@subsection Command-line option parsing routines
174 /* -----------------------------------------------------------------------------
175 * Command-line option parsing routines.
176 * ---------------------------------------------------------------------------*/
178 void initRtsFlagsDefaults(void)
180 RtsFlags.GcFlags.statsFile = NULL;
181 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
183 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
184 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
186 RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE;
187 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
188 RtsFlags.GcFlags.maxHeapSize = (64 * 1024 * 1024) / BLOCK_SIZE;
189 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
190 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
191 RtsFlags.GcFlags.oldGenFactor = 2;
192 RtsFlags.GcFlags.generations = 2;
193 RtsFlags.GcFlags.steps = 2;
195 RtsFlags.GcFlags.forceGC = rtsFalse;
196 RtsFlags.GcFlags.forcingInterval = 5000000; /* 5MB (or words?) */
197 RtsFlags.GcFlags.ringBell = rtsFalse;
199 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
201 #if defined(PROFILING) || defined(PAR)
202 RtsFlags.CcFlags.doCostCentres = 0;
203 #endif /* PROFILING or PAR */
206 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
207 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
209 RtsFlags.ProfFlags.ccSelector = NULL;
210 RtsFlags.ProfFlags.modSelector = NULL;
211 RtsFlags.ProfFlags.grpSelector = NULL;
212 RtsFlags.ProfFlags.descrSelector = NULL;
213 RtsFlags.ProfFlags.typeSelector = NULL;
214 RtsFlags.ProfFlags.kindSelector = NULL;
216 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
219 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
222 RtsFlags.ParFlags.nNodes = 1;
226 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
227 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
228 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
229 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
230 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
231 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
233 RtsFlags.ParFlags.outputDisabled = rtsFalse;
234 RtsFlags.ParFlags.packBufferSize = 1024;
236 RtsFlags.ParFlags.maxThreads = 1024;
237 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
238 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
241 #if defined(PAR) || defined(SMP)
242 RtsFlags.ParFlags.maxLocalSparks = 4096;
243 #endif /* PAR || SMP */
246 /* ToDo: check defaults for GranSim and GUM */
247 RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */
248 RtsFlags.ConcFlags.maxThreads = 65536; // refers to mandatory threads
249 RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_);
250 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
252 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
253 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
254 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
255 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
256 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
257 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
258 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
260 RtsFlags.GranFlags.packBufferSize = 1024;
261 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
263 RtsFlags.GranFlags.proc = MAX_PROC;
264 RtsFlags.GranFlags.Fishing = rtsFalse;
265 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
266 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
267 RtsFlags.GranFlags.Light = rtsFalse;
269 RtsFlags.GranFlags.Costs.latency = LATENCY;
270 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
271 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
272 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
273 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
274 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
275 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
276 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
278 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
279 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
280 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
281 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
282 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
284 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
285 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
286 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
287 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
288 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
290 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
292 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
293 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
295 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
296 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
297 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
298 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
299 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
300 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
301 RtsFlags.GranFlags.FetchStrategy = 2;
302 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
303 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
304 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
305 RtsFlags.GranFlags.SparkPriority = 0;
306 RtsFlags.GranFlags.SparkPriority2 = 0;
307 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
308 RtsFlags.GranFlags.InversePriorities = rtsFalse;
309 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
310 RtsFlags.GranFlags.ThunksToPack = 0;
311 RtsFlags.GranFlags.RandomSteal = rtsTrue;
315 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
316 RtsFlags.TickyFlags.tickyFile = NULL;
323 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
325 " +RTS Indicates run time system options follow",
326 " -RTS Indicates program arguments follow",
327 " --RTS Indicates that ALL subsequent arguments will be given to the",
328 " program (including any of these RTS flags)",
330 "The following run time system options are available:",
332 " -? -f Prints this message and exits; the program is not executed",
334 " -K<size> Sets the maximum stack size (default 1M) Egs: -K32k -K512k",
335 " -k<size> Sets the initial thread stack size (default 1k) Egs: -K4k -K2m",
337 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
338 " -M<size> Sets the maximum heap size (default 64M) Egs: -M256k -M1G",
339 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
340 " -m<n>% Minimum % of heap which must be available (default 3%)",
341 " -G<n> Number of generations (default: 2)",
342 " -T<n> Number of steps in younger generations (default: 2)",
343 " -s<file> Summary GC statistics (default file: <program>.stat)",
344 " -S<file> Detailed GC statistics (with -Sstderr going to stderr)",
347 " -Z Don't squeeze out update frames on stack overflow",
348 " -B Sound the bell at the start of each garbage collection",
349 #if defined(PROFILING) || defined(PAR)
351 " -p<sort> Produce cost centre time profile (output file <program>.prof)",
352 " sort: T = time (default), A = alloc, C = cost centre label",
353 " -P<sort> Produce serial time profile (output file <program>.time)",
354 " and a -p profile with detailed tick/alloc info",
355 # if defined(PROFILING)
357 " -h<break-down> Heap residency profile (output file <program>.hp)",
358 " break-down: C = cost centre stack (default), M = module, G = group",
359 " D = closure description, Y = type description",
360 " T<ints>,<start> = time closure created",
361 " ints: no. of interval bands plotted (default 18)",
362 " start: seconds after which intervals start (default 0.0)",
363 " A subset of closures may be selected by the attached cost centre using:",
364 " -c{mod:lab,mod:lab...}, specific module:label cost centre(s)",
365 " -m{mod,mod...} all cost centres from the specified modules(s)",
366 " -g{grp,grp...} all cost centres from the specified group(s)",
367 " Selections can also be made by description, type, kind and age:",
368 " -d{des,des...} closures with specified closure descriptions",
369 " -y{typ,typ...} closures with specified type descriptions",
370 " -k{knd,knd...} closures of the specified kinds",
371 " -a<age> closures which survived <age> complete intervals",
372 " The selection logic used is summarised as follows:",
373 " ([-c] or [-m] or [-g]) and ([-d] or [-y] or [-k]) and [-a]",
374 " where an option is true if not specified",
376 " -xc Show current cost centre stack on raising an exception",
379 " -z<tbl><size> set hash table <size> for <tbl> (C, M, G, D or Y)",
381 " -i<secs> Number of seconds in a profiling interval (default 1.0):",
382 " heap profile (-h) and/or serial time profile (-P) frequency",
383 #endif /* PROFILING or PAR */
384 #if !defined(PROFILING) && defined(DEBUG)
386 " -h<break-down> Debugging Heap residency profile",
387 " (output file <program>.hp)",
388 " break-down: L = closure label (default)",
389 " T = closure type (constructor, thunk etc.)",
392 #if defined(TICKY_TICKY)
393 " -r<file> Produce reduction profiling statistics (with -rstderr for stderr)",
397 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
398 /* NB: the -N<n> is implemented by the driver!! */
400 " -C<secs> Context-switch interval in seconds",
401 " (0 or no argument means switch as often as possible)",
402 " the default is .01 sec; resolution is .01 sec",
404 " -N<n> Use <n> OS threads (default: 1)",
406 #if defined(SMP) || defined(PAR)
407 " -e<size> Size of spark pools (default 100)",
410 " -t<num> Set maximum number of advisory threads per PE (default 32)",
411 " -qP Enable activity profile (output files in ~/<program>*.gr)",
412 " -qQ<size> Set pack-buffer size (default: 1024)",
413 " -qd Turn on PVM-ish debugging",
414 " -qO Disable output for performance measurement",
416 #if defined(SMP) || defined(PAR)
417 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
420 " -d Turn on PVM-ish debugging",
421 " -O Disable output for performance measurement",
423 #if defined(GRAN) /* ToDo: fill in decent Docu here */
424 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
427 "Other RTS options may be available for programs compiled a different way.",
428 "The GHC User's Guide has full details.",
433 static __inline__ rtsBool
434 strequal(const char *a, const char * b)
436 return(strcmp(a, b) == 0);
440 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
442 rtsBool error = rtsFalse;
447 /* Remove directory from argv[0] -- default files in current directory */
449 if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
450 strcpy(argv[0], last_slash+1);
452 /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
453 /* argv[0] must be PGM argument -- leave in argv */
461 for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
462 if (strequal("+RTS", argv[arg])) {
465 else if (strequal("-RTS", argv[arg])) {
468 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
469 rts_argv[(*rts_argc)++] = argv[arg];
471 else if (mode == PGM) {
472 argv[(*argc)++] = argv[arg];
475 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
478 if (arg < total_arg) {
479 /* arg must be --RTS; process remaining program arguments */
480 while (++arg < total_arg) {
481 argv[(*argc)++] = argv[arg];
484 argv[*argc] = (char *) 0;
485 rts_argv[*rts_argc] = (char *) 0;
487 /* Process RTS (rts_argv) part: mainly to determine statsfile */
489 for (arg = 0; arg < *rts_argc; arg++) {
490 if (rts_argv[arg][0] != '-') {
492 prog_belch("unexpected RTS argument: %s", rts_argv[arg]);
496 switch(rts_argv[arg][1]) {
498 /* process: general args, then PROFILING-only ones,
499 then CONCURRENT-only, PARallel-only, GRAN-only,
500 TICKY-only (same order as defined in RtsFlags.lh);
501 within those groups, mostly in case-insensitive
503 Final group is x*, which allows for more options.
507 # define TICKY_BUILD_ONLY(x) x
509 # define TICKY_BUILD_ONLY(x) \
510 prog_belch("GHC not built for: ticky-ticky stats"); \
514 #if defined(PROFILING)
515 # define COST_CENTRE_USING_BUILD_ONLY(x) x
517 # define COST_CENTRE_USING_BUILD_ONLY(x) \
518 prog_belch("GHC not built for: -prof or -parallel"); \
523 # define PROFILING_BUILD_ONLY(x) x
525 # define PROFILING_BUILD_ONLY(x) \
526 prog_belch("GHC not built for: -prof"); \
531 # define SMP_BUILD_ONLY(x) x
533 # define SMP_BUILD_ONLY(x) \
534 prog_belch("GHC not built for: -parallel"); \
539 # define PAR_BUILD_ONLY(x) x
541 # define PAR_BUILD_ONLY(x) \
542 prog_belch("GHC not built for: -parallel"); \
546 #if defined(SMP) || defined(PAR)
547 # define PAR_OR_SMP_BUILD_ONLY(x) x
549 # define PAR_OR_SMP_BUILD_ONLY(x) \
550 prog_belch("GHC not built for: -parallel or -smp"); \
555 # define GRAN_BUILD_ONLY(x) x
557 # define GRAN_BUILD_ONLY(x) \
558 prog_belch("GHC not built for: -gransim"); \
562 /* =========== GENERAL ========================== */
569 RtsFlags.GcFlags.minAllocAreaSize
570 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
571 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
572 bad_option(rts_argv[arg]);
577 RtsFlags.GcFlags.ringBell = rtsTrue;
581 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
583 if (RtsFlags.GcFlags.oldGenFactor < 0)
584 bad_option( rts_argv[arg] );
589 /* hack warning: interpret the flags as a binary number */
591 I_ n = decode(rts_argv[arg]+2);
592 if (n &1) RtsFlags.DebugFlags.scheduler = rtsTrue;
593 if ((n>>1)&1) RtsFlags.DebugFlags.evaluator = rtsTrue;
594 if ((n>>2)&1) RtsFlags.DebugFlags.codegen = rtsTrue;
595 if ((n>>3)&1) RtsFlags.DebugFlags.weak = rtsTrue;
596 if ((n>>4)&1) RtsFlags.DebugFlags.gccafs = rtsTrue;
597 if ((n>>5)&1) RtsFlags.DebugFlags.gc = rtsTrue;
598 if ((n>>6)&1) RtsFlags.DebugFlags.block_alloc = rtsTrue;
599 if ((n>>7)&1) RtsFlags.DebugFlags.sanity = rtsTrue;
600 if ((n>>8)&1) RtsFlags.DebugFlags.stable = rtsTrue;
601 if ((n>>9)&1) RtsFlags.DebugFlags.prof = rtsTrue;
602 if ((n>>10)&1) RtsFlags.DebugFlags.gran = rtsTrue;
603 if ((n>>11)&1) RtsFlags.DebugFlags.par = rtsTrue;
609 RtsFlags.GcFlags.maxStkSize =
610 decode(rts_argv[arg]+2) / sizeof(W_);
612 if (RtsFlags.GcFlags.maxStkSize == 0)
613 bad_option( rts_argv[arg] );
617 RtsFlags.GcFlags.initialStkSize =
618 decode(rts_argv[arg]+2) / sizeof(W_);
620 if (RtsFlags.GcFlags.initialStkSize == 0)
621 bad_option( rts_argv[arg] );
625 RtsFlags.GcFlags.maxHeapSize =
626 decode(rts_argv[arg]+2) / BLOCK_SIZE;
627 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
629 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
630 bad_option(rts_argv[arg]);
635 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
637 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
638 RtsFlags.GcFlags.pcFreeHeap > 100)
639 bad_option( rts_argv[arg] );
643 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
644 if (RtsFlags.GcFlags.generations < 1) {
645 bad_option(rts_argv[arg]);
650 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
651 if (RtsFlags.GcFlags.steps < 1) {
652 bad_option(rts_argv[arg]);
657 RtsFlags.GcFlags.heapSizeSuggestion =
658 decode(rts_argv[arg]+2) / BLOCK_SIZE;
660 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
661 bad_option(rts_argv[arg]);
665 case 'j': /* force GC option */
666 RtsFlags.GcFlags.forceGC = rtsTrue;
667 if (rts_argv[arg][2]) {
668 RtsFlags.GcFlags.forcingInterval
669 = decode(rts_argv[arg]+2) / sizeof(W_);
674 RtsFlags.GcFlags.giveStats ++;
677 RtsFlags.GcFlags.giveStats ++;
679 /* Opening all those files would almost certainly fail... */
680 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
681 RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */
683 RtsFlags.GcFlags.statsFile
684 = open_stats_file(arg, *argc, argv,
685 *rts_argc, rts_argv, STAT_FILENAME_FMT);
687 if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue;
692 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
695 /* =========== PROFILING ========================== */
697 case 'P': /* detailed cost centre profiling (time/alloc) */
698 COST_CENTRE_USING_BUILD_ONLY(
699 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
701 case 'p': /* cost centre profiling (time/alloc) */
702 COST_CENTRE_USING_BUILD_ONLY(
703 switch (rts_argv[arg][2]) {
705 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
708 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
713 case 'i': /* serial profiling -- initial timer interval */
714 COST_CENTRE_USING_BUILD_ONLY(
715 interval_ticks = (I_) ((atof(rts_argv[arg]+2) * TICK_FREQUENCY));
716 if (interval_ticks <= 0)
720 case 'h': /* serial heap profile */
721 #if !defined(PROFILING) && defined(DEBUG)
722 switch (rts_argv[arg][2]) {
725 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
728 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
731 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
735 PROFILING_BUILD_ONLY(
736 switch (rts_argv[arg][2]) {
739 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
742 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
745 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_GRP;
748 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
751 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
754 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TIME;
755 if (rts_argv[arg][3]) {
756 char *start_str = strchr(rts_argv[arg]+3, ',');
758 if (start_str) *start_str = '\0';
760 if ((intervals = decode(rts_argv[arg]+3)) != 0) {
761 time_intervals = (hash_t) intervals;
762 /* ToDo: and what if it *is* zero intervals??? */
765 earlier_ticks = (I_)((atof(start_str + 1) * TICK_FREQUENCY));
770 prog_belch("invalid heap profile option: %s",rts_argv[arg]);
777 case 'z': /* size of index tables */
778 PROFILING_BUILD_ONLY(
779 switch (rts_argv[arg][2]) {
781 max_cc_no = (hash_t) decode(rts_argv[arg]+3);
782 if (max_cc_no == 0) {
783 prog_belch("bad number of cost centres %s", rts_argv[arg]);
788 max_mod_no = (hash_t) decode(rts_argv[arg]+3);
789 if (max_mod_no == 0) {
790 prog_belch("bad number of modules %s", rts_argv[arg]);
795 max_grp_no = (hash_t) decode(rts_argv[arg]+3);
796 if (max_grp_no == 0) {
797 prog_belch("bad number of groups %s", rts_argv[arg]);
802 max_descr_no = (hash_t) decode(rts_argv[arg]+3);
803 if (max_descr_no == 0) {
804 prog_belch("bad number of closure descriptions %s",
810 max_type_no = (hash_t) decode(rts_argv[arg]+3);
811 if (max_type_no == 0) {
812 prog_belch("bad number of type descriptions %s",
818 prog_belch("invalid index table size option: %s",
824 case 'c': /* cost centre label select */
825 case 'g': /* cost centre group select */
826 case 'd': /* closure descr select */
827 case 'y': /* closure type select */
828 PROFILING_BUILD_ONLY(
829 {char *left = strchr(rts_argv[arg], '{');
830 char *right = strrchr(rts_argv[arg], '}');
832 if (! left || ! right ||
833 strrchr(rts_argv[arg], '{') != left ||
834 strchr(rts_argv[arg], '}') != right) {
835 prog_belch("invalid heap profiling selection bracketing: %s",
840 switch (rts_argv[arg][1]) {
841 case 'c': /* cost centre label select */
842 RtsFlags.ProfFlags.ccSelector = left + 1;
844 case 'm': /* cost centre module select */
845 RtsFlags.ProfFlags.modSelector = left + 1;
847 case 'g': /* cost centre group select */
848 RtsFlags.ProfFlags.grpSelector = left + 1;
850 case 'd': /* closure descr select */
851 RtsFlags.ProfFlags.descrSelector = left + 1;
853 case 'y': /* closure type select */
854 RtsFlags.ProfFlags.typeSelector = left + 1;
856 case 'k': /* closure kind select */
857 RtsFlags.ProfFlags.kindSelector = left + 1;
863 /* =========== CONCURRENT ========================= */
864 case 'C': /* context switch interval */
865 if (rts_argv[arg][2] == '\0')
866 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
870 /* Convert to milliseconds */
871 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
872 cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
873 if (cst < CS_MIN_MILLISECS)
874 cst = CS_MIN_MILLISECS;
876 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
883 if (rts_argv[arg][2] != '\0') {
884 RtsFlags.ParFlags.nNodes
885 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
886 if (RtsFlags.ParFlags.nNodes <= 0) {
887 prog_belch("bad value for -N");
893 /* =========== PARALLEL =========================== */
895 PAR_OR_SMP_BUILD_ONLY(
896 if (rts_argv[arg][2] != '\0') {
897 RtsFlags.ParFlags.maxLocalSparks
898 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
899 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
900 prog_belch("bad value for -e");
908 process_par_option(arg, rts_argc, rts_argv, &error);
911 /* =========== GRAN =============================== */
915 process_gran_option(arg, rts_argc, rts_argv, &error);
918 /* =========== TICKY ============================== */
920 case 'r': /* Basic profiling stats */
923 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
924 RtsFlags.TickyFlags.tickyFile
925 = open_stats_file(arg, *argc, argv,
926 *rts_argc, rts_argv, TICKY_FILENAME_FMT);
928 if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue;
931 /* =========== EXTENDED OPTIONS =================== */
933 case 'x': /* Extend the argument space */
934 switch(rts_argv[arg][2]) {
936 prog_belch("incomplete RTS option: %s",rts_argv[arg]);
940 case 'c': /* Debugging tool: show current cost centre on an exception */
941 PROFILING_BUILD_ONLY(
942 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
945 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
948 prog_belch("unknown RTS option: %s",rts_argv[arg]);
952 break; /* defensive programming */
954 /* =========== OH DEAR ============================ */
956 prog_belch("unknown RTS option: %s",rts_argv[arg]);
966 for (p = usage_text; *p; p++)
968 stg_exit(EXIT_FAILURE);
974 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
975 //@subsection GranSim specific options
978 enable_GranSimLight(void) {
980 fprintf(stderr,"GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
981 RtsFlags.GranFlags.Light=rtsTrue;
982 RtsFlags.GranFlags.Costs.latency =
983 RtsFlags.GranFlags.Costs.fetchtime =
984 RtsFlags.GranFlags.Costs.additional_latency =
985 RtsFlags.GranFlags.Costs.gunblocktime =
986 RtsFlags.GranFlags.Costs.lunblocktime =
987 RtsFlags.GranFlags.Costs.threadcreatetime =
988 RtsFlags.GranFlags.Costs.threadqueuetime =
989 RtsFlags.GranFlags.Costs.threadscheduletime =
990 RtsFlags.GranFlags.Costs.threaddescheduletime =
991 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
993 RtsFlags.GranFlags.Costs.mpacktime =
994 RtsFlags.GranFlags.Costs.munpacktime = 0;
996 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
997 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
998 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
999 /* FetchStrategy is irrelevant in GrAnSim-Light */
1001 /* GrAnSim Light often creates an abundance of parallel threads,
1002 each with its own stack etc. Therefore, it's in general a good
1003 idea to use small stack chunks (use the -o<size> option to
1006 // RtsFlags.ConcFlags.stkChunkSize = 100;
1008 RtsFlags.GranFlags.proc = 1;
1012 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1014 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1017 /* or a ridiculously idealised simulator */
1018 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1019 RtsFlags.GranFlags.Costs.latency =
1020 RtsFlags.GranFlags.Costs.fetchtime =
1021 RtsFlags.GranFlags.Costs.additional_latency =
1022 RtsFlags.GranFlags.Costs.gunblocktime =
1023 RtsFlags.GranFlags.Costs.lunblocktime =
1024 RtsFlags.GranFlags.Costs.threadcreatetime =
1025 RtsFlags.GranFlags.Costs.threadqueuetime =
1026 RtsFlags.GranFlags.Costs.threadscheduletime =
1027 RtsFlags.GranFlags.Costs.threaddescheduletime =
1028 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1030 RtsFlags.GranFlags.Costs.mpacktime =
1031 RtsFlags.GranFlags.Costs.munpacktime = 0;
1033 RtsFlags.GranFlags.Costs.arith_cost =
1034 RtsFlags.GranFlags.Costs.float_cost =
1035 RtsFlags.GranFlags.Costs.load_cost =
1036 RtsFlags.GranFlags.Costs.store_cost =
1037 RtsFlags.GranFlags.Costs.branch_cost = 0;
1039 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1041 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1042 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1043 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1044 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1048 /* or a somewhat idealised simulator */
1049 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1050 RtsFlags.GranFlags.Costs.latency =
1051 RtsFlags.GranFlags.Costs.fetchtime =
1052 RtsFlags.GranFlags.Costs.additional_latency =
1053 RtsFlags.GranFlags.Costs.gunblocktime =
1054 RtsFlags.GranFlags.Costs.lunblocktime =
1055 RtsFlags.GranFlags.Costs.threadcreatetime =
1056 RtsFlags.GranFlags.Costs.threadqueuetime =
1057 RtsFlags.GranFlags.Costs.threadscheduletime =
1058 RtsFlags.GranFlags.Costs.threaddescheduletime =
1059 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1061 RtsFlags.GranFlags.Costs.mpacktime =
1062 RtsFlags.GranFlags.Costs.munpacktime = 0;
1064 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1066 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1067 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1068 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1069 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1070 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1071 # if defined(GRAN_CHECK) && defined(GRAN)
1072 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1077 /* Communication and task creation cost parameters */
1078 switch(rts_argv[arg][2]) {
1080 IgnoreYields = rtsTrue; // HWL HACK
1084 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1088 if (rts_argv[arg][3] != '\0')
1090 RtsFlags.GranFlags.Costs.gunblocktime =
1091 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1092 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1095 RtsFlags.GranFlags.Costs.latency = LATENCY;
1099 if (rts_argv[arg][3] != '\0')
1100 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1102 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1106 if (rts_argv[arg][3] != '\0')
1107 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1109 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1113 if (rts_argv[arg][3] != '\0')
1114 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1116 RtsFlags.GranFlags.Costs.mtidytime = 0;
1120 if (rts_argv[arg][3] != '\0')
1121 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1123 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1127 if (rts_argv[arg][3] != '\0')
1128 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1130 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1134 if (rts_argv[arg][3] != '\0')
1135 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1137 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1141 if (rts_argv[arg][3] != '\0')
1142 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1144 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1147 /* Thread-related metrics */
1149 if (rts_argv[arg][3] != '\0')
1150 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1152 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1156 if (rts_argv[arg][3] != '\0')
1157 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1159 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1163 if (rts_argv[arg][3] != '\0')
1164 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1166 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1168 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1169 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1173 if (rts_argv[arg][3] != '\0')
1174 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1176 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1178 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1179 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1182 /* Instruction Cost Metrics */
1184 if (rts_argv[arg][3] != '\0')
1185 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1187 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1191 if (rts_argv[arg][3] != '\0')
1192 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1194 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1198 if (rts_argv[arg][3] != '\0')
1199 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1201 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1205 if (rts_argv[arg][3] != '\0')
1206 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1208 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1212 if (rts_argv[arg][3] != '\0')
1213 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1215 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1219 if (rts_argv[arg][3] != '\0')
1220 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1222 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1226 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1227 if (rts_argv[arg][3] != '\0')
1228 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1230 RtsFlags.GranFlags.FetchStrategy = 2;
1231 if (RtsFlags.GranFlags.FetchStrategy == 0)
1232 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1235 case 'K': /* sort overhead (per elem in spark list) */
1236 if (rts_argv[arg][3] != '\0')
1237 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1239 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1240 fprintf(stderr,"Overhead for pri spark: %d (per elem).\n",
1241 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1244 case 'O': /* sort overhead (per elem in spark list) */
1245 if (rts_argv[arg][3] != '\0')
1246 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1248 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1249 fprintf(stderr,"Overhead for pri sched: %d (per elem).\n",
1250 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1253 /* General Parameters */
1255 if (rts_argv[arg][3] != '\0')
1257 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1258 if (RtsFlags.GranFlags.proc==0) {
1259 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1260 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1261 RtsFlags.GranFlags.proc < 1)
1263 fprintf(stderr,"setupRtsFlags: no more than %u processors
1270 RtsFlags.GranFlags.proc = MAX_PROC;
1274 RtsFlags.GranFlags.Fishing = rtsTrue;
1275 if (rts_argv[arg][3] != '\0')
1276 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1278 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1282 if (rts_argv[arg][3] != '\0')
1283 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1285 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1289 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1290 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1294 fprintf(stderr,"Bulk fetching enabled.\n");
1295 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1299 fprintf(stderr,"Thread migration enabled.\n");
1300 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1304 fprintf(stderr,"Fair Scheduling enabled.\n");
1305 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1309 fprintf(stderr,"Priority Scheduling enabled.\n");
1310 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1314 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1315 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1319 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1323 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1327 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1331 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1335 /* format is -bP<c> where <c> is one char describing kind of profile */
1336 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1337 switch(rts_argv[arg][3]) {
1338 case '\0': break; // nothing special, just an ordinary profile
1339 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1341 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1343 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1345 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1347 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1349 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1351 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1356 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1360 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1363 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1364 if (rts_argv[arg][3] != '\0') {
1367 arg0 = rts_argv[arg]+3;
1368 if ((tmp = strstr(arg0,","))==NULL) {
1369 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1370 fprintf(stderr,"SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1373 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1374 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1375 fprintf(stderr,"SparkPriority: %u.\n",
1376 RtsFlags.GranFlags.SparkPriority);
1377 fprintf(stderr,"SparkPriority2:%u.\n",
1378 RtsFlags.GranFlags.SparkPriority2);
1379 if (RtsFlags.GranFlags.SparkPriority2 <
1380 RtsFlags.GranFlags.SparkPriority) {
1381 fprintf(stderr,"WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1382 RtsFlags.GranFlags.SparkPriority2,
1383 RtsFlags.GranFlags.SparkPriority);
1387 /* plain pri spark is now invoked with -bX
1388 RtsFlags.GranFlags.DoPrioritySparking = 1;
1389 fprintf(stderr,"PrioritySparking.\n");
1395 if (rts_argv[arg][3] != '\0') {
1396 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1398 RtsFlags.GranFlags.ThunksToPack = 1;
1400 fprintf(stderr,"Thunks To Pack in one packet: %u.\n",
1401 RtsFlags.GranFlags.ThunksToPack);
1405 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1406 fprintf(stderr,"Deterministic mode (no random stealing)\n");
1409 /* The following class of options contains eXperimental */
1410 /* features in connection with exploiting granularity */
1411 /* information. I.e. if -bY is chosen these options */
1412 /* tell the RTS what to do with the supplied info --HWL */
1415 if (rts_argv[arg][3] != '\0') {
1416 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1418 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1420 fprintf(stderr,"Size of GranSim internal pack buffer: %u.\n",
1421 RtsFlags.GranFlags.packBufferSize_internal);
1425 switch(rts_argv[arg][3]) {
1428 RtsFlags.GranFlags.DoPrioritySparking = 1;
1429 fprintf(stderr,"Priority Sparking with Normal Priorities.\n");
1430 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1431 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1432 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1436 RtsFlags.GranFlags.DoPrioritySparking = 1;
1437 fprintf(stderr,"Priority Sparking with Inverse Priorities.\n");
1438 RtsFlags.GranFlags.InversePriorities++;
1442 RtsFlags.GranFlags.DoPrioritySparking = 1;
1443 fprintf(stderr,"Priority Sparking with Random Priorities.\n");
1444 RtsFlags.GranFlags.RandomPriorities++;
1448 RtsFlags.GranFlags.DoPrioritySparking = 1;
1449 fprintf(stderr,"Priority Sparking with No Priorities.\n");
1450 RtsFlags.GranFlags.IgnorePriorities++;
1454 bad_option( rts_argv[arg] );
1460 switch(rts_argv[arg][3]) {
1463 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1464 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1468 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1472 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1476 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1480 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1481 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1485 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1489 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1493 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1497 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1501 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1505 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1509 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1513 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1514 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1518 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1522 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1526 bad_option( rts_argv[arg] );
1531 # if defined(GRAN_CHECK) && defined(GRAN)
1533 switch(rts_argv[arg][3]) {
1534 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1535 if (rts_argv[arg][4] != '\0') {
1536 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1537 fprintf(stderr,"Pack buffer size: %d\n",
1538 RtsFlags.GranFlags.packBufferSize);
1540 fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1546 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1547 /* hack warning: interpret the flags as a binary number */
1548 nat n = decode(rts_argv[arg]+3);
1549 set_GranSim_debug_options(n);
1552 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1553 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1556 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1557 fprintf(stderr, "Valid GranSim debug options are:\n");
1558 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1559 bad_option( rts_argv[arg] );
1560 } else { // flag found; now set it
1561 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1567 case 'e': /* event trace; also -bD1 */
1568 fprintf(stderr,"DEBUG: event_trace; printing event trace.\n");
1569 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1570 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1573 case 'E': /* event statistics; also -bD2 */
1574 fprintf(stderr,"DEBUG: event_stats; printing event statistics.\n");
1575 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1576 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1579 case 'f': /* thunkStealing; also -bD4 */
1580 fprintf(stderr,"DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1581 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1582 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1585 case 'z': /* blockOnFetch; also -bD8 */
1586 fprintf(stderr,"DEBUG: blockOnFetch; check for blocked on fetch.\n");
1587 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1588 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1591 case 't': /* blockOnFetch_sanity; also -bD16 */
1592 fprintf(stderr,"DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1593 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1594 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1597 case 'S': /* priSpark; also -bD32 */
1598 fprintf(stderr,"DEBUG: priSpark; priority sparking.\n");
1599 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1602 case 's': /* priSched; also -bD64 */
1603 fprintf(stderr,"DEBUG: priSched; priority scheduling.\n");
1604 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1607 case 'F': /* findWork; also -bD128 */
1608 fprintf(stderr,"DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1609 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1612 case 'g': /* globalBlock; also -bD256 */
1613 fprintf(stderr,"DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1614 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1617 case 'G': /* pack; also -bD512 */
1618 fprintf(stderr,"DEBUG: pack; routines for (un-)packing graph structures.\n");
1619 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1622 case 'P': /* packBuffer; also -bD1024 */
1623 fprintf(stderr,"DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1624 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1627 case 'o': /* sortedQ; also -bD2048 */
1628 fprintf(stderr,"DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1629 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1632 case 'r': /* randomSteal; also -bD4096 */
1633 fprintf(stderr,"DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1634 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1637 case 'q': /* checkSparkQ; also -bD8192 */
1638 fprintf(stderr,"DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1639 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1642 case ':': /* checkLight; also -bD16384 */
1643 fprintf(stderr,"DEBUG: checkLight; check GranSim-Light setup.\n");
1644 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1647 case 'b': /* bq; also -bD32768 */
1648 fprintf(stderr,"DEBUG: bq; check blocking queues\n");
1649 RtsFlags.GranFlags.Debug.bq = rtsTrue;
1652 case 'd': /* all options turned on */
1653 fprintf(stderr,"DEBUG: all options turned on.\n");
1654 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1655 /* RtsFlags.GranFlags.Debug |= 0x40; */
1659 /* RtsFlags.GranFlags.Debug = 1; */
1665 # endif /* GRAN_CHECK */
1667 bad_option( rts_argv[arg] );
1673 Interpret n as a binary number masking GranSim debug options and set the
1674 correxponding option. See gran_debug_opts_strs for explanations of the flags.
1677 set_GranSim_debug_options(nat n) {
1680 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1682 fprintf(stderr, gran_debug_opts_strs[i]);
1684 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
1685 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
1686 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
1687 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
1688 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
1689 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
1690 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
1691 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
1692 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
1693 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
1694 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
1695 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
1696 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
1697 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
1698 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
1699 default: barf("set_GranSim_debug_options: only %d debug options expected");
1705 Print one line explanation for each of the GranSim debug options specified
1709 help_GranSim_debug_options(nat n) {
1712 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1714 fprintf(stderr, gran_debug_opts_strs[i]);
1720 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1722 if (rts_argv[arg][1] != 'q') /* All GUM options start with -q */
1725 /* Communication and task creation cost parameters */
1726 switch(rts_argv[arg][2]) {
1727 case 'e': /* -qe<n> ... allow <n> local sparks */
1728 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1729 RtsFlags.ParFlags.maxLocalSparks
1730 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1732 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1733 belch("setupRtsFlags: bad value for -e\n");
1737 IF_PAR_DEBUG(verbose,
1738 belch("-qe<n>: max %d local sparks",
1739 RtsFlags.ParFlags.maxLocalSparks));
1743 if (rts_argv[arg][3] != '\0') {
1744 RtsFlags.ParFlags.maxThreads
1745 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1747 belch("setupRtsFlags: missing size for -qt\n");
1750 IF_PAR_DEBUG(verbose,
1751 belch("-qt<n>: max %d threads",
1752 RtsFlags.ParFlags.maxThreads));
1756 if (rts_argv[arg][3] != '\0')
1757 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1759 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1761 IF_PAR_DEBUG(verbose,
1762 belch("-qf<n>: max %d fishes sent out at one time",
1763 RtsFlags.ParFlags.maxFishes));
1768 if (rts_argv[arg][3] != '\0') {
1769 RtsFlags.ParFlags.fishDelay
1770 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1772 belch("setupRtsFlags: missing fish delay time for -qd\n");
1775 IF_PAR_DEBUG(verbose,
1776 belch("-qd<n>: fish delay time %d",
1777 RtsFlags.ParFlags.fishDelay));
1781 RtsFlags.ParFlags.outputDisabled = rtsTrue;
1782 IF_PAR_DEBUG(verbose,
1783 belch("-qO: output disabled"));
1786 case 'P': /* -qP for writing a log file */
1787 RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1788 /* same encoding as in GranSim after -bP */
1789 switch(rts_argv[arg][3]) {
1790 case '\0': break; // nothing special, just an ordinary profile
1791 //case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1793 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1795 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1797 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1799 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1801 case 'g': RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1803 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1805 IF_PAR_DEBUG(verbose,
1806 belch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1807 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1810 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1811 if (rts_argv[arg][3] != '\0') {
1812 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1814 belch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1817 IF_PAR_DEBUG(verbose,
1818 belch("-qQ<n>: pack buffer size set to %d",
1819 RtsFlags.ParFlags.packBufferSize));
1824 if (rts_argv[arg][3] != '\0') {
1825 RtsFlags.ParFlags.wait
1826 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1828 RtsFlags.ParFlags.wait = 1000;
1830 IF_PAR_DEBUG(verbose,
1831 belch("-qw<n>: length of wait loop after synchr before reduction: %d",
1832 RtsFlags.ParFlags.wait));
1835 case 'D': /* -qD ... all the debugging options */
1836 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1837 /* hack warning: interpret the flags as a binary number */
1838 nat n = decode(rts_argv[arg]+3);
1839 set_par_debug_options(n);
1842 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1843 if (rts_argv[arg][3] == par_debug_opts_flags[i])
1846 if (i==MAX_PAR_DEBUG_OPTION+1) {
1847 fprintf(stderr, "Valid GUM debug options are:\n");
1848 help_par_debug_options(MAX_PAR_DEBUG_MASK);
1849 bad_option( rts_argv[arg] );
1850 } else { // flag found; now set it
1851 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
1857 belch("Unknown option -q%c", rts_argv[arg][2]);
1863 Interpret n as a binary number masking Par debug options and set the
1864 correxponding option. See par_debug_opts_strs for explanations of the flags.
1867 set_par_debug_options(nat n) {
1870 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1872 fprintf(stderr, par_debug_opts_strs[i]);
1874 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
1875 case 1: RtsFlags.ParFlags.Debug.trace = rtsTrue; break;
1876 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
1877 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
1878 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
1879 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
1880 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
1881 case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
1882 case 8: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
1883 case 9: RtsFlags.ParFlags.Debug.forward = rtsTrue; break;
1884 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
1885 default: barf("set_par_debug_options: only %d debug options expected");
1891 Print one line explanation for each of the GranSim debug options specified
1895 help_par_debug_options(nat n) {
1898 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
1900 fprintf(stderr, par_debug_opts_strs[i]);
1905 //@node Aux fcts, , GranSim specific options
1906 //@subsection Aux fcts
1908 static FILE * /* return NULL on error */
1911 int argc, char *argv[],
1912 int rts_argc, char *rts_argv[],
1913 const char *FILENAME_FMT)
1917 if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */
1919 else if (rts_argv[arg][2] != '\0') /* stats file specified */
1920 f = fopen(rts_argv[arg]+2,"w");
1922 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1923 sprintf(stats_filename, FILENAME_FMT, argv[0]);
1924 f = fopen(stats_filename,"w");
1927 fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2);
1929 /* Write argv and rtsv into start of stats file */
1931 for(count = 0; count < argc; count++)
1932 fprintf(f, "%s ", argv[count]);
1933 fprintf(f, "+RTS ");
1934 for(count = 0; count < rts_argc; count++)
1935 fprintf(f, "%s ", rts_argv[count]);
1943 decode(const char *s)
1954 if (c == 'g' || c == 'G')
1955 m *= 1000*1000*1000; /* UNchecked! */
1956 else if (c == 'm' || c == 'M')
1957 m *= 1000*1000; /* We do not use powers of 2 (1024) */
1958 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
1959 m *= 1000; /* a direct-mapped cache. */
1960 else if (c == 'w' || c == 'W')
1967 bad_option(const char *s)
1969 prog_belch("bad RTS option: %s", s);
1970 stg_exit(EXIT_FAILURE);