Add +RTS -vg flag for requesting some GC trace messages, outside DEBUG
[ghc.git] / rts / RtsFlags.c
1 /* -----------------------------------------------------------------------------
2 *
3 * (c) The AQUA Project, Glasgow University, 1994-1997
4 * (c) The GHC Team, 1998-2006
5 *
6 * Functions for parsing the argument list.
7 *
8 * ---------------------------------------------------------------------------*/
9
10 #include "PosixSource.h"
11 #include "Rts.h"
12 #include "RtsFlags.h"
13 #include "RtsUtils.h"
14 #include "Profiling.h"
15
16 #ifdef HAVE_CTYPE_H
17 #include <ctype.h>
18 #endif
19
20 #include <stdlib.h>
21 #include <string.h>
22
23 // Flag Structure
24 RTS_FLAGS RtsFlags;
25
26 /*
27 * Split argument lists
28 */
29 int prog_argc = 0; /* an "int" so as to match normal "argc" */
30 char **prog_argv = NULL;
31 int full_prog_argc = 0; /* an "int" so as to match normal "argc" */
32 char **full_prog_argv = NULL;
33 char *prog_name = NULL; /* 'basename' of prog_argv[0] */
34 int rts_argc = 0; /* ditto */
35 char *rts_argv[MAX_RTS_ARGS];
36
37 /*
38 * constants, used later
39 */
40 #define RTS 1
41 #define PGM 0
42
43 #if defined(GRAN)
44
45 static char *gran_debug_opts_strs[] = {
46 "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
47 "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
48 "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
49 "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
50 "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
51 "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
52 "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
53 "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
54 "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
55 "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
56 "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
57 "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
58 "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
59 "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
60 "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
61 };
62
63 /* one character codes for the available debug options */
64 static char gran_debug_opts_flags[] = {
65 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
66 };
67
68 #elif defined(PAR)
69
70 static char *par_debug_opts_strs[] = {
71 "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
72 "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
73 "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
74 "DEBUG (-qDe, -qD8): free; free messages.\n",
75 "DEBUG (-qDr, -qD16): resume; resume messages.\n",
76 "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
77 "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
78 // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
79 "DEBUG (-qDf, -qD128): fish; fish messages.\n",
80 //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
81 "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
82 "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
83 "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
84 "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
85 };
86
87 /* one character codes for the available debug options */
88 static char par_debug_opts_flags[] = {
89 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
90 };
91
92 #endif /* PAR */
93
94 /* -----------------------------------------------------------------------------
95 Static function decls
96 -------------------------------------------------------------------------- */
97
98 static int /* return NULL on error */
99 open_stats_file (
100 I_ arg,
101 int argc, char *argv[],
102 int rts_argc, char *rts_argv[],
103 const char *FILENAME_FMT,
104 FILE **file_ret);
105
106 static I_ decode(const char *s);
107 static void bad_option(const char *s);
108
109 #if defined(GRAN)
110 static void enable_GranSimLight(void);
111 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
112 static void set_GranSim_debug_options(nat n);
113 static void help_GranSim_debug_options(nat n);
114 #elif defined(PAR)
115 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
116 static void set_par_debug_options(nat n);
117 static void help_par_debug_options(nat n);
118 #endif
119
120 /* -----------------------------------------------------------------------------
121 * Command-line option parsing routines.
122 * ---------------------------------------------------------------------------*/
123
124 void initRtsFlagsDefaults(void)
125 {
126 RtsFlags.GcFlags.statsFile = NULL;
127 RtsFlags.GcFlags.giveStats = NO_GC_STATS;
128
129 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
130 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
131
132 RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE;
133 RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE;
134 RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */
135 RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */
136 RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
137 RtsFlags.GcFlags.oldGenFactor = 2;
138 #if defined(PAR)
139 /* A hack currently needed for GUM -- HWL */
140 RtsFlags.GcFlags.generations = 1;
141 RtsFlags.GcFlags.steps = 2;
142 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
143 #else
144 RtsFlags.GcFlags.generations = 2;
145 RtsFlags.GcFlags.steps = 2;
146 RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
147 #endif
148 RtsFlags.GcFlags.compact = rtsFalse;
149 RtsFlags.GcFlags.compactThreshold = 30.0;
150 #ifdef RTS_GTK_FRONTPANEL
151 RtsFlags.GcFlags.frontpanel = rtsFalse;
152 #endif
153 RtsFlags.GcFlags.idleGCDelayTime = 300; /* millisecs */
154
155 #if osf3_HOST_OS
156 /* ToDo: Perhaps by adjusting this value we can make linking without
157 * -static work (i.e., not generate a core-dumping executable)? */
158 # if SIZEOF_VOID_P == 8
159 RtsFlags.GcFlags.heapBase = 0x180000000L;
160 # else
161 # error I have no idea where to begin the heap on a non-64-bit osf3 machine.
162 # endif
163 #else
164 RtsFlags.GcFlags.heapBase = 0; /* means don't care */
165 #endif
166
167 #ifdef DEBUG
168 RtsFlags.DebugFlags.scheduler = rtsFalse;
169 RtsFlags.DebugFlags.interpreter = rtsFalse;
170 RtsFlags.DebugFlags.weak = rtsFalse;
171 RtsFlags.DebugFlags.gccafs = rtsFalse;
172 RtsFlags.DebugFlags.gc = rtsFalse;
173 RtsFlags.DebugFlags.block_alloc = rtsFalse;
174 RtsFlags.DebugFlags.sanity = rtsFalse;
175 RtsFlags.DebugFlags.stable = rtsFalse;
176 RtsFlags.DebugFlags.stm = rtsFalse;
177 RtsFlags.DebugFlags.prof = rtsFalse;
178 RtsFlags.DebugFlags.gran = rtsFalse;
179 RtsFlags.DebugFlags.par = rtsFalse;
180 RtsFlags.DebugFlags.linker = rtsFalse;
181 RtsFlags.DebugFlags.squeeze = rtsFalse;
182 RtsFlags.DebugFlags.hpc = rtsFalse;
183 #endif
184
185 #if defined(PROFILING) || defined(PAR)
186 RtsFlags.CcFlags.doCostCentres = 0;
187 #endif /* PROFILING or PAR */
188
189 RtsFlags.ProfFlags.doHeapProfile = rtsFalse;
190 RtsFlags.ProfFlags.profileInterval = 100;
191
192 #ifdef PROFILING
193 RtsFlags.ProfFlags.includeTSOs = rtsFalse;
194 RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
195 RtsFlags.ProfFlags.maxRetainerSetSize = 8;
196 RtsFlags.ProfFlags.ccsLength = 25;
197 RtsFlags.ProfFlags.modSelector = NULL;
198 RtsFlags.ProfFlags.descrSelector = NULL;
199 RtsFlags.ProfFlags.typeSelector = NULL;
200 RtsFlags.ProfFlags.ccSelector = NULL;
201 RtsFlags.ProfFlags.ccsSelector = NULL;
202 RtsFlags.ProfFlags.retainerSelector = NULL;
203 RtsFlags.ProfFlags.bioSelector = NULL;
204 #endif
205
206 RtsFlags.MiscFlags.tickInterval = 20; /* In milliseconds */
207 RtsFlags.ConcFlags.ctxtSwitchTime = 20; /* In milliseconds */
208
209 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
210
211 #ifdef THREADED_RTS
212 RtsFlags.ParFlags.nNodes = 1;
213 RtsFlags.ParFlags.migrate = rtsTrue;
214 RtsFlags.ParFlags.wakeupMigrate = rtsFalse;
215 RtsFlags.ParFlags.gcThreads = 1;
216 #endif
217
218 #ifdef PAR
219 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
220 RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
221 RtsFlags.ParFlags.ParStats.Binary = rtsFalse;
222 RtsFlags.ParFlags.ParStats.Sparks = rtsFalse;
223 RtsFlags.ParFlags.ParStats.Heap = rtsFalse;
224 RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
225 RtsFlags.ParFlags.ParStats.Global = rtsFalse;
226
227 RtsFlags.ParFlags.outputDisabled = rtsFalse;
228 #ifdef DIST
229 RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */
230 #else
231 RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */
232 #endif
233 RtsFlags.ParFlags.packBufferSize = 1024;
234 RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */
235 RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */
236 RtsFlags.ParFlags.maxThreads = 1024;
237 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
238 RtsFlags.ParFlags.fishDelay = FISH_DELAY;
239 #endif
240
241 #if defined(PAR) || defined(THREADED_RTS)
242 RtsFlags.ParFlags.maxLocalSparks = 4096;
243 #endif /* PAR || THREADED_RTS */
244
245 #if defined(GRAN)
246 /* ToDo: check defaults for GranSim and GUM */
247 RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_);
248 RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_);
249
250 RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads
251 RtsFlags.GranFlags.GranSimStats.Full = rtsFalse;
252 RtsFlags.GranFlags.GranSimStats.Suppressed = rtsFalse;
253 RtsFlags.GranFlags.GranSimStats.Binary = rtsFalse;
254 RtsFlags.GranFlags.GranSimStats.Sparks = rtsFalse;
255 RtsFlags.GranFlags.GranSimStats.Heap = rtsFalse;
256 RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsFalse;
257 RtsFlags.GranFlags.GranSimStats.Global = rtsFalse;
258
259 RtsFlags.GranFlags.packBufferSize = 1024;
260 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
261
262 RtsFlags.GranFlags.proc = MAX_PROC;
263 RtsFlags.GranFlags.Fishing = rtsFalse;
264 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
265 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
266 RtsFlags.GranFlags.Light = rtsFalse;
267
268 RtsFlags.GranFlags.Costs.latency = LATENCY;
269 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
270 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
271 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
272 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
273 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
274 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
275 RtsFlags.GranFlags.Costs.mtidytime = MSGTIDYTIME;
276
277 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
278 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
279 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
280 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
281 RtsFlags.GranFlags.Costs.threadcontextswitchtime = THREADCONTEXTSWITCHTIME;
282
283 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
284 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
285 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
286 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
287 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
288
289 RtsFlags.GranFlags.Costs.heapalloc_cost = HEAPALLOC_COST;
290
291 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
292 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
293
294 RtsFlags.GranFlags.DoFairSchedule = rtsFalse;
295 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
296 RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse;
297 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse;
298 RtsFlags.GranFlags.DoBulkFetching = rtsFalse;
299 RtsFlags.GranFlags.DoThreadMigration = rtsFalse;
300 RtsFlags.GranFlags.FetchStrategy = 2;
301 RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
302 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
303 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
304 RtsFlags.GranFlags.SparkPriority = 0;
305 RtsFlags.GranFlags.SparkPriority2 = 0;
306 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
307 RtsFlags.GranFlags.InversePriorities = rtsFalse;
308 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
309 RtsFlags.GranFlags.ThunksToPack = 0;
310 RtsFlags.GranFlags.RandomSteal = rtsTrue;
311 #endif
312
313 #ifdef TICKY_TICKY
314 RtsFlags.TickyFlags.showTickyStats = rtsFalse;
315 RtsFlags.TickyFlags.tickyFile = NULL;
316 #endif
317
318 RtsFlags.TraceFlags.timestamp = rtsFalse;
319 RtsFlags.TraceFlags.sched = rtsFalse;
320 RtsFlags.TraceFlags.gc = rtsFalse;
321
322 #ifdef USE_PAPI
323 /* By default no special measurements taken */
324 RtsFlags.PapiFlags.eventType = 0;
325 RtsFlags.PapiFlags.numUserEvents = 0;
326 #endif
327 }
328
329 static const char *
330 usage_text[] = {
331 "",
332 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
333 "",
334 " +RTS Indicates run time system options follow",
335 " -RTS Indicates program arguments follow",
336 " --RTS Indicates that ALL subsequent arguments will be given to the",
337 " program (including any of these RTS flags)",
338 "",
339 "The following run time system options are available:",
340 "",
341 " -? Prints this message and exits; the program is not executed",
342 " --info Print information about the RTS used by this program",
343 "",
344 " -K<size> Sets the maximum stack size (default 8M) Egs: -K32k -K512k",
345 " -k<size> Sets the initial thread stack size (default 1k) Egs: -k4k -k2m",
346 "",
347 " -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
348 " -M<size> Sets the maximum heap size (default unlimited) Egs: -M256k -M1G",
349 " -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
350 " -m<n> Minimum % of heap which must be available (default 3%)",
351 " -G<n> Number of generations (default: 2)",
352 " -T<n> Number of steps in younger generations (default: 2)",
353 " -c<n> Auto-enable compaction of the oldest generation when live data is",
354 " at least <n>% of the maximum heap size set with -M (default: 30%)",
355 " -c Enable compaction for all major collections",
356 #if defined(THREADED_RTS)
357 " -I<sec> Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
358 #endif
359 "",
360 " -t<file> One-line GC statistics (default file: <program>.stat)",
361 " -s<file> Summary GC statistics (with -Sstderr going to stderr)",
362 " -S<file> Detailed GC statistics",
363 #ifdef RTS_GTK_FRONTPANEL
364 " -f Display front panel (requires X11 & GTK+)",
365 #endif
366 "",
367 "",
368 " -Z Don't squeeze out update frames on stack overflow",
369 " -B Sound the bell at the start of each garbage collection",
370 #if defined(PROFILING) || defined(PAR)
371 "",
372 " -px Time/allocation profile (XML) (output file <program>.prof)",
373 " -p Time/allocation profile (output file <program>.prof)",
374 " -P More detailed Time/Allocation profile",
375 " -Pa Give information about *all* cost centres",
376
377 # if defined(PROFILING)
378 "",
379 " -hx Heap residency profile (XML) (output file <program>.prof)",
380 " -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
381 " break-down: c = cost centre stack (default)",
382 " m = module",
383 " d = closure description",
384 " y = type description",
385 " r = retainer",
386 " b = biography (LAG,DRAG,VOID,USE)",
387 " A subset of closures may be selected thusly:",
388 " -hc<cc>,... specific cost centre(s) (top of stack only)",
389 " -hC<cc>,... specific cost centre(s) (anywhere in stack)",
390 " -hm<mod>... all cost centres from the specified modules(s)",
391 " -hd<des>,... closures with specified closure descriptions",
392 " -hy<typ>... closures with specified type descriptions",
393 " -hr<cc>... closures with specified retainers",
394 " -hb<bio>... closures with specified biographies (lag,drag,void,use)",
395 "",
396 " -R<size> Set the maximum retainer set size (default: 8)",
397 "",
398 " -L<chars> Maximum length of a cost-centre stack in a heap profile",
399 " (default: 25)",
400 "",
401 " -xt Include threads (TSOs) in a heap profile",
402 "",
403 " -xc Show current cost centre stack on raising an exception",
404 "",
405 # endif
406 #endif /* PROFILING or PAR */
407 #if !defined(PROFILING)
408 "",
409 " -hT Heap residency profile (output file <program>.hp)",
410 #endif
411 " -i<sec> Time between heap samples (seconds, default: 0.1)",
412 "",
413 #if defined(TICKY_TICKY)
414 " -r<file> Produce ticky-ticky statistics (with -rstderr for stderr)",
415 "",
416 #endif
417 #if defined(PAR)
418 " -N<n> Use <n> PVMish processors in parallel (default: 2)",
419 /* NB: the -N<n> is implemented by the driver!! */
420 #endif
421 " -C<secs> Context-switch interval in seconds.",
422 " 0 or no argument means switch as often as possible.",
423 " Default: 0.02 sec; resolution is set by -V below.",
424 " -V<secs> Master tick interval in seconds (0 == disable timer).",
425 " This sets the resolution for -C and the profile timer -i.",
426 " Default: 0.02 sec.",
427 "",
428 " -vs Trace scheduler events (see also -Ds with -debug)",
429 " -vt Time-stamp trace messages",
430 "",
431 #if defined(DEBUG)
432 " -Ds DEBUG: scheduler",
433 " -Di DEBUG: interpreter",
434 " -Dw DEBUG: weak",
435 " -DG DEBUG: gccafs",
436 " -Dg DEBUG: gc",
437 " -Db DEBUG: block",
438 " -DS DEBUG: sanity",
439 " -Dt DEBUG: stable",
440 " -Dp DEBUG: prof",
441 " -Dr DEBUG: gran",
442 " -DP DEBUG: par",
443 " -Dl DEBUG: linker",
444 " -Dm DEBUG: stm",
445 " -Dz DEBUG: stack squezing",
446 " -Dc DEBUG: program coverage",
447 "",
448 #endif /* DEBUG */
449 #if defined(THREADED_RTS) && !defined(NOSMP)
450 " -N<n> Use <n> OS threads (default: 1)",
451 " -g<n> Use <n> OS threads for GC (default: 1)",
452 " -qm Don't automatically migrate threads between CPUs",
453 " -qw Migrate a thread to the current CPU when it is woken up",
454 #endif
455 " --install-signal-handlers=<yes|no>",
456 " Install signal handlers (default: yes)",
457 #if defined(THREADED_RTS) || defined(PAR)
458 " -e<size> Size of spark pools (default 100)",
459 #endif
460 #if defined(PAR)
461 " -t<num> Set maximum number of advisory threads per PE (default 32)",
462 " -qP Enable activity profile (output files in ~/<program>*.gr)",
463 " -qQ<size> Set pack-buffer size (default: 1024)",
464 " -qd Turn on PVM-ish debugging",
465 " -qO Disable output for performance measurement",
466 #endif
467 #if defined(THREADED_RTS) || defined(PAR)
468 " -e<n> Maximum number of outstanding local sparks (default: 4096)",
469 #endif
470 #if defined(PAR)
471 " -d Turn on PVM-ish debugging",
472 " -O Disable output for performance measurement",
473 #endif /* PAR */
474 #if defined(GRAN) /* ToDo: fill in decent Docu here */
475 " -b... All GranSim options start with -b; see GranSim User's Guide for details",
476 #endif
477 #if defined(USE_PAPI)
478 " -aX CPU performance counter measurements using PAPI",
479 " (use with the -s<file> option). X is one of:",
480 "",
481 /* " y - cycles", */
482 " 1 - level 1 cache misses",
483 " 2 - level 2 cache misses",
484 " b - branch mispredictions",
485 " s - stalled cycles",
486 " e - cache miss and branch misprediction events",
487 #endif
488 "",
489 "RTS options may also be specified using the GHCRTS environment variable.",
490 "",
491 "Other RTS options may be available for programs compiled a different way.",
492 "The GHC User's Guide has full details.",
493 "",
494 0
495 };
496
497 STATIC_INLINE rtsBool
498 strequal(const char *a, const char * b)
499 {
500 return(strcmp(a, b) == 0);
501 }
502
503 static void
504 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
505 {
506 char *c1, *c2;
507
508 c1 = s;
509 do {
510 while (isspace(*c1)) { c1++; };
511 c2 = c1;
512 while (!isspace(*c2) && *c2 != '\0') { c2++; };
513
514 if (c1 == c2) { break; }
515
516 if (*rts_argc < MAX_RTS_ARGS-1) {
517 s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
518 strncpy(s, c1, c2-c1);
519 s[c2-c1] = '\0';
520 rts_argv[(*rts_argc)++] = s;
521 } else {
522 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
523 }
524
525 c1 = c2;
526 } while (*c1 != '\0');
527 }
528
529 void
530 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
531 {
532 rtsBool error = rtsFalse;
533 I_ mode;
534 I_ arg, total_arg;
535
536 setProgName (argv);
537 total_arg = *argc;
538 arg = 1;
539
540 *argc = 1;
541 *rts_argc = 0;
542
543 // process arguments from the ghc_rts_opts global variable first.
544 // (arguments from the GHCRTS environment variable and the command
545 // line override these).
546 {
547 if (ghc_rts_opts != NULL) {
548 splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
549 }
550 }
551
552 // process arguments from the GHCRTS environment variable next
553 // (arguments from the command line override these).
554 {
555 char *ghc_rts = getenv("GHCRTS");
556
557 if (ghc_rts != NULL) {
558 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
559 }
560 }
561
562 // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
563 // argv[0] must be PGM argument -- leave in argv
564
565 for (mode = PGM; arg < total_arg; arg++) {
566 // The '--RTS' argument disables all future +RTS ... -RTS processing.
567 if (strequal("--RTS", argv[arg])) {
568 arg++;
569 break;
570 }
571 // The '--' argument is passed through to the program, but
572 // disables all further +RTS ... -RTS processing.
573 else if (strequal("--", argv[arg])) {
574 break;
575 }
576 else if (strequal("+RTS", argv[arg])) {
577 mode = RTS;
578 }
579 else if (strequal("-RTS", argv[arg])) {
580 mode = PGM;
581 }
582 else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
583 rts_argv[(*rts_argc)++] = argv[arg];
584 }
585 else if (mode == PGM) {
586 argv[(*argc)++] = argv[arg];
587 }
588 else {
589 barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
590 }
591 }
592 // process remaining program arguments
593 for (; arg < total_arg; arg++) {
594 argv[(*argc)++] = argv[arg];
595 }
596 argv[*argc] = (char *) 0;
597 rts_argv[*rts_argc] = (char *) 0;
598
599 // Process RTS (rts_argv) part: mainly to determine statsfile
600 for (arg = 0; arg < *rts_argc; arg++) {
601 if (rts_argv[arg][0] != '-') {
602 fflush(stdout);
603 errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
604 error = rtsTrue;
605
606 } else {
607 switch(rts_argv[arg][1]) {
608
609 /* process: general args, then PROFILING-only ones,
610 then CONCURRENT-only, PARallel-only, GRAN-only,
611 TICKY-only (same order as defined in RtsFlags.lh);
612 within those groups, mostly in case-insensitive
613 alphabetical order.
614 Final group is x*, which allows for more options.
615 */
616
617 #ifdef TICKY_TICKY
618 # define TICKY_BUILD_ONLY(x) x
619 #else
620 # define TICKY_BUILD_ONLY(x) \
621 errorBelch("not built for: ticky-ticky stats"); \
622 error = rtsTrue;
623 #endif
624
625 #if defined(PROFILING)
626 # define COST_CENTRE_USING_BUILD_ONLY(x) x
627 #else
628 # define COST_CENTRE_USING_BUILD_ONLY(x) \
629 errorBelch("not built for: -prof or -parallel"); \
630 error = rtsTrue;
631 #endif
632
633 #ifdef PROFILING
634 # define PROFILING_BUILD_ONLY(x) x
635 #else
636 # define PROFILING_BUILD_ONLY(x) \
637 errorBelch("not built for: -prof"); \
638 error = rtsTrue;
639 #endif
640
641 #ifdef PAR
642 # define PAR_BUILD_ONLY(x) x
643 #else
644 # define PAR_BUILD_ONLY(x) \
645 errorBelch("not built for: -parallel"); \
646 error = rtsTrue;
647 #endif
648
649 #ifdef THREADED_RTS
650 # define THREADED_BUILD_ONLY(x) x
651 #else
652 # define THREADED_BUILD_ONLY(x) \
653 errorBelch("not built for: -smp"); \
654 error = rtsTrue;
655 #endif
656
657 #if defined(THREADED_RTS) || defined(PAR)
658 # define PAR_OR_THREADED_BUILD_ONLY(x) x
659 #else
660 # define PAR_OR_THREADED_BUILD_ONLY(x) \
661 errorBelch("not built for: -parallel or -smp"); \
662 error = rtsTrue;
663 #endif
664
665 #ifdef GRAN
666 # define GRAN_BUILD_ONLY(x) x
667 #else
668 # define GRAN_BUILD_ONLY(x) \
669 errorBelch("not built for: -gransim"); \
670 error = rtsTrue;
671 #endif
672
673 /* =========== GENERAL ========================== */
674 case '?':
675 error = rtsTrue;
676 break;
677
678 /* This isn't going to allow us to keep related options
679 together as we add more --* flags. We really need a
680 proper options parser. */
681 case '-':
682 if (strequal("install-signal-handlers=yes",
683 &rts_argv[arg][2])) {
684 RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
685 }
686 else if (strequal("install-signal-handlers=no",
687 &rts_argv[arg][2])) {
688 RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
689 }
690 else if (strequal("info",
691 &rts_argv[arg][2])) {
692 printRtsInfo();
693 exit(0);
694 }
695 else {
696 errorBelch("unknown RTS option: %s",rts_argv[arg]);
697 error = rtsTrue;
698 }
699 break;
700 case 'A':
701 RtsFlags.GcFlags.minAllocAreaSize
702 = decode(rts_argv[arg]+2) / BLOCK_SIZE;
703 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
704 bad_option(rts_argv[arg]);
705 }
706 break;
707
708 #ifdef USE_PAPI
709 case 'a':
710 switch(rts_argv[arg][2]) {
711 case '1':
712 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
713 break;
714 case '2':
715 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
716 break;
717 case 'b':
718 RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
719 break;
720 case 's':
721 RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
722 break;
723 case 'e':
724 RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
725 break;
726 case '+':
727 if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
728 errorBelch("maximum number of PAPI events reached");
729 stg_exit(EXIT_FAILURE);
730 }
731 RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
732 RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
733 break;
734 default:
735 bad_option( rts_argv[arg] );
736 }
737 break;
738 #endif
739
740 case 'B':
741 RtsFlags.GcFlags.ringBell = rtsTrue;
742 break;
743
744 case 'c':
745 if (rts_argv[arg][2] != '\0') {
746 RtsFlags.GcFlags.compactThreshold =
747 atof(rts_argv[arg]+2);
748 } else {
749 RtsFlags.GcFlags.compact = rtsTrue;
750 }
751 break;
752
753 case 'F':
754 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
755
756 if (RtsFlags.GcFlags.oldGenFactor < 0)
757 bad_option( rts_argv[arg] );
758 break;
759
760 #ifdef DEBUG
761 case 'D':
762 {
763 char *c;
764
765 for (c = rts_argv[arg] + 2; *c != '\0'; c++) {
766 switch (*c) {
767 case 's':
768 RtsFlags.DebugFlags.scheduler = rtsTrue;
769 break;
770 case 'i':
771 RtsFlags.DebugFlags.interpreter = rtsTrue;
772 break;
773 case 'w':
774 RtsFlags.DebugFlags.weak = rtsTrue;
775 break;
776 case 'G':
777 RtsFlags.DebugFlags.gccafs = rtsTrue;
778 break;
779 case 'g':
780 RtsFlags.DebugFlags.gc = rtsTrue;
781 break;
782 case 'b':
783 RtsFlags.DebugFlags.block_alloc = rtsTrue;
784 break;
785 case 'S':
786 RtsFlags.DebugFlags.sanity = rtsTrue;
787 break;
788 case 't':
789 RtsFlags.DebugFlags.stable = rtsTrue;
790 break;
791 case 'p':
792 RtsFlags.DebugFlags.prof = rtsTrue;
793 break;
794 case 'r':
795 RtsFlags.DebugFlags.gran = rtsTrue;
796 break;
797 case 'P':
798 RtsFlags.DebugFlags.par = rtsTrue;
799 break;
800 case 'l':
801 RtsFlags.DebugFlags.linker = rtsTrue;
802 break;
803 case 'a':
804 RtsFlags.DebugFlags.apply = rtsTrue;
805 break;
806 case 'm':
807 RtsFlags.DebugFlags.stm = rtsTrue;
808 break;
809 case 'z':
810 RtsFlags.DebugFlags.squeeze = rtsTrue;
811 break;
812 case 'c':
813 RtsFlags.DebugFlags.hpc = rtsTrue;
814 break;
815 default:
816 bad_option( rts_argv[arg] );
817 }
818 }
819 break;
820 }
821 #endif
822
823 case 'K':
824 RtsFlags.GcFlags.maxStkSize =
825 decode(rts_argv[arg]+2) / sizeof(W_);
826
827 if (RtsFlags.GcFlags.maxStkSize == 0)
828 bad_option( rts_argv[arg] );
829 break;
830
831 case 'k':
832 RtsFlags.GcFlags.initialStkSize =
833 decode(rts_argv[arg]+2) / sizeof(W_);
834
835 if (RtsFlags.GcFlags.initialStkSize == 0)
836 bad_option( rts_argv[arg] );
837 break;
838
839 case 'M':
840 RtsFlags.GcFlags.maxHeapSize =
841 decode(rts_argv[arg]+2) / BLOCK_SIZE;
842 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
843
844 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
845 bad_option(rts_argv[arg]);
846 }
847 break;
848
849 case 'm':
850 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
851
852 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
853 RtsFlags.GcFlags.pcFreeHeap > 100)
854 bad_option( rts_argv[arg] );
855 break;
856
857 case 'G':
858 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
859 if (RtsFlags.GcFlags.generations < 1) {
860 bad_option(rts_argv[arg]);
861 }
862 break;
863
864 case 'T':
865 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
866 if (RtsFlags.GcFlags.steps < 1) {
867 bad_option(rts_argv[arg]);
868 }
869 break;
870
871 case 'H':
872 RtsFlags.GcFlags.heapSizeSuggestion =
873 decode(rts_argv[arg]+2) / BLOCK_SIZE;
874 break;
875
876 #ifdef RTS_GTK_FRONTPANEL
877 case 'f':
878 RtsFlags.GcFlags.frontpanel = rtsTrue;
879 break;
880 #endif
881
882 case 'I': /* idle GC delay */
883 if (rts_argv[arg][2] == '\0') {
884 /* use default */
885 } else {
886 I_ cst; /* tmp */
887
888 /* Convert to millisecs */
889 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
890 RtsFlags.GcFlags.idleGCDelayTime = cst;
891 }
892 break;
893
894 case 'S':
895 RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
896 goto stats;
897
898 case 's':
899 RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
900 goto stats;
901
902 case 't':
903 RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
904 goto stats;
905
906 stats:
907 #ifdef PAR
908 /* Opening all those files would almost certainly fail... */
909 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
910 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
911 #else
912 {
913 int r;
914 r = open_stats_file(arg, *argc, argv,
915 *rts_argc, rts_argv, STAT_FILENAME_FMT,
916 &RtsFlags.GcFlags.statsFile);
917 if (r == -1) { error = rtsTrue; }
918 }
919 #endif
920 break;
921
922 case 'Z':
923 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
924 break;
925
926 /* =========== PROFILING ========================== */
927
928 case 'P': /* detailed cost centre profiling (time/alloc) */
929 case 'p': /* cost centre profiling (time/alloc) */
930 COST_CENTRE_USING_BUILD_ONLY(
931 switch (rts_argv[arg][2]) {
932 case 'x':
933 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
934 break;
935 case 'a':
936 RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
937 break;
938 default:
939 if (rts_argv[arg][1] == 'P') {
940 RtsFlags.CcFlags.doCostCentres =
941 COST_CENTRES_VERBOSE;
942 } else {
943 RtsFlags.CcFlags.doCostCentres =
944 COST_CENTRES_SUMMARY;
945 }
946 break;
947 }
948 ) break;
949
950 case 'R':
951 PROFILING_BUILD_ONLY(
952 RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
953 ) break;
954 case 'L':
955 PROFILING_BUILD_ONLY(
956 RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
957 if(RtsFlags.ProfFlags.ccsLength <= 0) {
958 bad_option(rts_argv[arg]);
959 }
960 ) break;
961 case 'h': /* serial heap profile */
962 #if !defined(PROFILING)
963 switch (rts_argv[arg][2]) {
964 case '\0':
965 case 'T':
966 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
967 break;
968 default:
969 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
970 error = rtsTrue;
971 }
972 #else
973 PROFILING_BUILD_ONLY(
974 switch (rts_argv[arg][2]) {
975 case '\0':
976 case 'C':
977 case 'c':
978 case 'M':
979 case 'm':
980 case 'D':
981 case 'd':
982 case 'Y':
983 case 'y':
984 case 'R':
985 case 'r':
986 case 'B':
987 case 'b':
988 if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
989 {
990 char *left = strchr(rts_argv[arg], '{');
991 char *right = strrchr(rts_argv[arg], '}');
992
993 // curly braces are optional, for
994 // backwards compat.
995 if (left)
996 left = left+1;
997 else
998 left = rts_argv[arg] + 3;
999
1000 if (!right)
1001 right = rts_argv[arg] + strlen(rts_argv[arg]);
1002
1003 *right = '\0';
1004
1005 switch (rts_argv[arg][2]) {
1006 case 'c': // cost centre label select
1007 RtsFlags.ProfFlags.ccSelector = left;
1008 break;
1009 case 'C':
1010 RtsFlags.ProfFlags.ccsSelector = left;
1011 break;
1012 case 'M':
1013 case 'm': // cost centre module select
1014 RtsFlags.ProfFlags.modSelector = left;
1015 break;
1016 case 'D':
1017 case 'd': // closure descr select
1018 RtsFlags.ProfFlags.descrSelector = left;
1019 break;
1020 case 'Y':
1021 case 'y': // closure type select
1022 RtsFlags.ProfFlags.typeSelector = left;
1023 break;
1024 case 'R':
1025 case 'r': // retainer select
1026 RtsFlags.ProfFlags.retainerSelector = left;
1027 break;
1028 case 'B':
1029 case 'b': // biography select
1030 RtsFlags.ProfFlags.bioSelector = left;
1031 break;
1032 }
1033 }
1034 break;
1035 }
1036
1037 if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1038 errorBelch("multiple heap profile options");
1039 error = rtsTrue;
1040 break;
1041 }
1042
1043 switch (rts_argv[arg][2]) {
1044 case '\0':
1045 case 'C':
1046 case 'c':
1047 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
1048 break;
1049 case 'M':
1050 case 'm':
1051 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
1052 break;
1053 case 'D':
1054 case 'd':
1055 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
1056 break;
1057 case 'Y':
1058 case 'y':
1059 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
1060 break;
1061 case 'R':
1062 case 'r':
1063 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
1064 break;
1065 case 'B':
1066 case 'b':
1067 RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
1068 break;
1069 }
1070 break;
1071
1072 default:
1073 errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1074 error = rtsTrue;
1075 }
1076 )
1077 #endif /* PROFILING */
1078 break;
1079
1080 case 'i': /* heap sample interval */
1081 if (rts_argv[arg][2] == '\0') {
1082 /* use default */
1083 } else {
1084 I_ cst; /* tmp */
1085
1086 /* Convert to milliseconds */
1087 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1088 RtsFlags.ProfFlags.profileInterval = cst;
1089 }
1090 break;
1091
1092 /* =========== CONCURRENT ========================= */
1093 case 'C': /* context switch interval */
1094 if (rts_argv[arg][2] == '\0')
1095 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1096 else {
1097 I_ cst; /* tmp */
1098
1099 /* Convert to milliseconds */
1100 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1101 RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1102 }
1103 break;
1104
1105 case 'V': /* master tick interval */
1106 if (rts_argv[arg][2] == '\0') {
1107 // turns off ticks completely
1108 RtsFlags.MiscFlags.tickInterval = 0;
1109 } else {
1110 I_ cst; /* tmp */
1111
1112 /* Convert to milliseconds */
1113 cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1114 RtsFlags.MiscFlags.tickInterval = cst;
1115 }
1116 break;
1117
1118 #if defined(THREADED_RTS) && !defined(NOSMP)
1119 case 'N':
1120 THREADED_BUILD_ONLY(
1121 if (rts_argv[arg][2] != '\0') {
1122 RtsFlags.ParFlags.nNodes
1123 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1124 if (RtsFlags.ParFlags.nNodes <= 0) {
1125 errorBelch("bad value for -N");
1126 error = rtsTrue;
1127 }
1128 }
1129 ) break;
1130
1131 case 'g':
1132 THREADED_BUILD_ONLY(
1133 if (rts_argv[arg][2] != '\0') {
1134 RtsFlags.ParFlags.gcThreads
1135 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1136 if (RtsFlags.ParFlags.nNodes <= 0) {
1137 errorBelch("bad value for -g");
1138 error = rtsTrue;
1139 }
1140 #if defined(PROFILING)
1141 if (RtsFlags.ParFlags.nNodes > 1) {
1142 errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1143 error = rtsTrue;
1144 }
1145 #endif
1146 }
1147 ) break;
1148
1149 case 'q':
1150 switch (rts_argv[arg][2]) {
1151 case '\0':
1152 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1153 error = rtsTrue;
1154 break;
1155 case 'm':
1156 RtsFlags.ParFlags.migrate = rtsFalse;
1157 break;
1158 case 'w':
1159 RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
1160 break;
1161 default:
1162 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1163 error = rtsTrue;
1164 break;
1165 }
1166 break;
1167 #endif
1168 /* =========== PARALLEL =========================== */
1169 case 'e':
1170 PAR_OR_THREADED_BUILD_ONLY(
1171 if (rts_argv[arg][2] != '\0') {
1172 RtsFlags.ParFlags.maxLocalSparks
1173 = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1174 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1175 errorBelch("bad value for -e");
1176 error = rtsTrue;
1177 }
1178 }
1179 ) break;
1180
1181 #ifdef PAR
1182 case 'q':
1183 PAR_BUILD_ONLY(
1184 process_par_option(arg, rts_argc, rts_argv, &error);
1185 ) break;
1186 #endif
1187
1188 /* =========== GRAN =============================== */
1189
1190 case 'b':
1191 GRAN_BUILD_ONLY(
1192 process_gran_option(arg, rts_argc, rts_argv, &error);
1193 ) break;
1194
1195 /* =========== TICKY ============================== */
1196
1197 case 'r': /* Basic profiling stats */
1198 TICKY_BUILD_ONLY(
1199
1200 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1201
1202 {
1203 int r;
1204 r = open_stats_file(arg, *argc, argv,
1205 *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1206 &RtsFlags.TickyFlags.tickyFile);
1207 if (r == -1) { error = rtsTrue; }
1208 }
1209 ) break;
1210
1211 /* =========== TRACING ---------=================== */
1212
1213 case 'v':
1214 switch(rts_argv[arg][2]) {
1215 case '\0':
1216 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1217 error = rtsTrue;
1218 break;
1219 case 't':
1220 RtsFlags.TraceFlags.timestamp = rtsTrue;
1221 break;
1222 case 's':
1223 RtsFlags.TraceFlags.sched = rtsTrue;
1224 break;
1225 case 'g':
1226 RtsFlags.TraceFlags.gc = rtsTrue;
1227 break;
1228 default:
1229 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1230 error = rtsTrue;
1231 break;
1232 }
1233 break;
1234
1235 /* =========== EXTENDED OPTIONS =================== */
1236
1237 case 'x': /* Extend the argument space */
1238 switch(rts_argv[arg][2]) {
1239 case '\0':
1240 errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1241 error = rtsTrue;
1242 break;
1243
1244 case 'b': /* heapBase in hex; undocumented */
1245 if (rts_argv[arg][3] != '\0') {
1246 RtsFlags.GcFlags.heapBase
1247 = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1248 } else {
1249 errorBelch("-xb: requires argument");
1250 error = rtsTrue;
1251 }
1252 break;
1253
1254 case 'c': /* Debugging tool: show current cost centre on an exception */
1255 PROFILING_BUILD_ONLY(
1256 RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1257 );
1258 break;
1259
1260 case 't': /* Include memory used by TSOs in a heap profile */
1261 PROFILING_BUILD_ONLY(
1262 RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1263 );
1264 break;
1265
1266 /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */
1267
1268 default:
1269 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1270 error = rtsTrue;
1271 break;
1272 }
1273 break; /* defensive programming */
1274
1275 /* =========== OH DEAR ============================ */
1276 default:
1277 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1278 error = rtsTrue;
1279 break;
1280 }
1281 }
1282 }
1283
1284 if (RtsFlags.MiscFlags.tickInterval < 0) {
1285 RtsFlags.MiscFlags.tickInterval = 50;
1286 }
1287
1288 // If the master timer is disabled, turn off the other timers.
1289 if (RtsFlags.MiscFlags.tickInterval == 0) {
1290 RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1291 RtsFlags.GcFlags.idleGCDelayTime = 0;
1292 RtsFlags.ProfFlags.profileInterval = 0;
1293 }
1294
1295 // Determine what tick interval we should use for the RTS timer
1296 // by taking the shortest of the various intervals that we need to
1297 // monitor.
1298 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1299 RtsFlags.MiscFlags.tickInterval =
1300 stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1301 RtsFlags.MiscFlags.tickInterval);
1302 }
1303
1304 if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1305 RtsFlags.MiscFlags.tickInterval =
1306 stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1307 RtsFlags.MiscFlags.tickInterval);
1308 }
1309
1310 if (RtsFlags.ProfFlags.profileInterval > 0) {
1311 RtsFlags.MiscFlags.tickInterval =
1312 stg_min(RtsFlags.ProfFlags.profileInterval,
1313 RtsFlags.MiscFlags.tickInterval);
1314 }
1315
1316 if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1317 RtsFlags.ConcFlags.ctxtSwitchTicks =
1318 RtsFlags.ConcFlags.ctxtSwitchTime /
1319 RtsFlags.MiscFlags.tickInterval;
1320 } else {
1321 RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1322 }
1323
1324 if (RtsFlags.ProfFlags.profileInterval > 0) {
1325 RtsFlags.ProfFlags.profileIntervalTicks =
1326 RtsFlags.ProfFlags.profileInterval /
1327 RtsFlags.MiscFlags.tickInterval;
1328 } else {
1329 RtsFlags.ProfFlags.profileIntervalTicks = 0;
1330 }
1331
1332 if (error) {
1333 const char **p;
1334
1335 fflush(stdout);
1336 for (p = usage_text; *p; p++)
1337 errorBelch("%s", *p);
1338 stg_exit(EXIT_FAILURE);
1339 }
1340 }
1341
1342 #if defined(GRAN)
1343
1344 static void
1345 enable_GranSimLight(void) {
1346
1347 debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n");
1348 RtsFlags.GranFlags.Light=rtsTrue;
1349 RtsFlags.GranFlags.Costs.latency =
1350 RtsFlags.GranFlags.Costs.fetchtime =
1351 RtsFlags.GranFlags.Costs.additional_latency =
1352 RtsFlags.GranFlags.Costs.gunblocktime =
1353 RtsFlags.GranFlags.Costs.lunblocktime =
1354 RtsFlags.GranFlags.Costs.threadcreatetime =
1355 RtsFlags.GranFlags.Costs.threadqueuetime =
1356 RtsFlags.GranFlags.Costs.threadscheduletime =
1357 RtsFlags.GranFlags.Costs.threaddescheduletime =
1358 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1359
1360 RtsFlags.GranFlags.Costs.mpacktime =
1361 RtsFlags.GranFlags.Costs.munpacktime = 0;
1362
1363 RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1364 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1365 RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1366 /* FetchStrategy is irrelevant in GrAnSim-Light */
1367
1368 /* GrAnSim Light often creates an abundance of parallel threads,
1369 each with its own stack etc. Therefore, it's in general a good
1370 idea to use small stack chunks (use the -o<size> option to
1371 increase it again).
1372 */
1373 // RtsFlags.ConcFlags.stkChunkSize = 100;
1374
1375 RtsFlags.GranFlags.proc = 1;
1376 }
1377
1378 static void
1379 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1380 {
1381 if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1382 return;
1383
1384 /* or a ridiculously idealised simulator */
1385 if(strcmp((rts_argv[arg]+2),"oring")==0) {
1386 RtsFlags.GranFlags.Costs.latency =
1387 RtsFlags.GranFlags.Costs.fetchtime =
1388 RtsFlags.GranFlags.Costs.additional_latency =
1389 RtsFlags.GranFlags.Costs.gunblocktime =
1390 RtsFlags.GranFlags.Costs.lunblocktime =
1391 RtsFlags.GranFlags.Costs.threadcreatetime =
1392 RtsFlags.GranFlags.Costs.threadqueuetime =
1393 RtsFlags.GranFlags.Costs.threadscheduletime =
1394 RtsFlags.GranFlags.Costs.threaddescheduletime =
1395 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1396
1397 RtsFlags.GranFlags.Costs.mpacktime =
1398 RtsFlags.GranFlags.Costs.munpacktime = 0;
1399
1400 RtsFlags.GranFlags.Costs.arith_cost =
1401 RtsFlags.GranFlags.Costs.float_cost =
1402 RtsFlags.GranFlags.Costs.load_cost =
1403 RtsFlags.GranFlags.Costs.store_cost =
1404 RtsFlags.GranFlags.Costs.branch_cost = 0;
1405
1406 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1407
1408 /* ++RtsFlags.GranFlags.DoFairSchedule; */
1409 RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */
1410 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1411 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1412 return;
1413 }
1414
1415 /* or a somewhat idealised simulator */
1416 if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1417 RtsFlags.GranFlags.Costs.latency =
1418 RtsFlags.GranFlags.Costs.fetchtime =
1419 RtsFlags.GranFlags.Costs.additional_latency =
1420 RtsFlags.GranFlags.Costs.gunblocktime =
1421 RtsFlags.GranFlags.Costs.lunblocktime =
1422 RtsFlags.GranFlags.Costs.threadcreatetime =
1423 RtsFlags.GranFlags.Costs.threadqueuetime =
1424 RtsFlags.GranFlags.Costs.threadscheduletime =
1425 RtsFlags.GranFlags.Costs.threaddescheduletime =
1426 RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1427
1428 RtsFlags.GranFlags.Costs.mpacktime =
1429 RtsFlags.GranFlags.Costs.munpacktime = 0;
1430
1431 RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1432
1433 /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */
1434 /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */
1435 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */
1436 RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */
1437 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */
1438 # if defined(GRAN_CHECK) && defined(GRAN)
1439 RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */
1440 # endif
1441 return;
1442 }
1443
1444 /* Communication and task creation cost parameters */
1445 switch(rts_argv[arg][2]) {
1446 case '.':
1447 IgnoreYields = rtsTrue; // HWL HACK
1448 break;
1449
1450 case ':':
1451 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1452 break;
1453
1454 case 'l':
1455 if (rts_argv[arg][3] != '\0')
1456 {
1457 RtsFlags.GranFlags.Costs.gunblocktime =
1458 RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1459 RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1460 }
1461 else
1462 RtsFlags.GranFlags.Costs.latency = LATENCY;
1463 break;
1464
1465 case 'a':
1466 if (rts_argv[arg][3] != '\0')
1467 RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1468 else
1469 RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1470 break;
1471
1472 case 'm':
1473 if (rts_argv[arg][3] != '\0')
1474 RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1475 else
1476 RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1477 break;
1478
1479 case 'x':
1480 if (rts_argv[arg][3] != '\0')
1481 RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1482 else
1483 RtsFlags.GranFlags.Costs.mtidytime = 0;
1484 break;
1485
1486 case 'r':
1487 if (rts_argv[arg][3] != '\0')
1488 RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1489 else
1490 RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1491 break;
1492
1493 case 'g':
1494 if (rts_argv[arg][3] != '\0')
1495 RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1496 else
1497 RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1498 break;
1499
1500 case 'n':
1501 if (rts_argv[arg][3] != '\0')
1502 RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1503 else
1504 RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1505 break;
1506
1507 case 'u':
1508 if (rts_argv[arg][3] != '\0')
1509 RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1510 else
1511 RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1512 break;
1513
1514 /* Thread-related metrics */
1515 case 't':
1516 if (rts_argv[arg][3] != '\0')
1517 RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1518 else
1519 RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1520 break;
1521
1522 case 'q':
1523 if (rts_argv[arg][3] != '\0')
1524 RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1525 else
1526 RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1527 break;
1528
1529 case 'c':
1530 if (rts_argv[arg][3] != '\0')
1531 RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1532 else
1533 RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1534
1535 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1536 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1537 break;
1538
1539 case 'd':
1540 if (rts_argv[arg][3] != '\0')
1541 RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1542 else
1543 RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1544
1545 RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1546 + RtsFlags.GranFlags.Costs.threaddescheduletime;
1547 break;
1548
1549 /* Instruction Cost Metrics */
1550 case 'A':
1551 if (rts_argv[arg][3] != '\0')
1552 RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1553 else
1554 RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1555 break;
1556
1557 case 'F':
1558 if (rts_argv[arg][3] != '\0')
1559 RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1560 else
1561 RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1562 break;
1563
1564 case 'B':
1565 if (rts_argv[arg][3] != '\0')
1566 RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1567 else
1568 RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1569 break;
1570
1571 case 'L':
1572 if (rts_argv[arg][3] != '\0')
1573 RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1574 else
1575 RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1576 break;
1577
1578 case 'S':
1579 if (rts_argv[arg][3] != '\0')
1580 RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1581 else
1582 RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1583 break;
1584
1585 case 'H':
1586 if (rts_argv[arg][3] != '\0')
1587 RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1588 else
1589 RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1590 break;
1591
1592 case 'y':
1593 RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1594 if (rts_argv[arg][3] != '\0')
1595 RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1596 else
1597 RtsFlags.GranFlags.FetchStrategy = 2;
1598 if (RtsFlags.GranFlags.FetchStrategy == 0)
1599 RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1600 break;
1601
1602 case 'K': /* sort overhead (per elem in spark list) */
1603 if (rts_argv[arg][3] != '\0')
1604 RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1605 else
1606 RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1607 debugBelch("Overhead for pri spark: %d (per elem).\n",
1608 RtsFlags.GranFlags.Costs.pri_spark_overhead);
1609 break;
1610
1611 case 'O': /* sort overhead (per elem in spark list) */
1612 if (rts_argv[arg][3] != '\0')
1613 RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1614 else
1615 RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1616 debugBelch("Overhead for pri sched: %d (per elem).\n",
1617 RtsFlags.GranFlags.Costs.pri_sched_overhead);
1618 break;
1619
1620 /* General Parameters */
1621 case 'p':
1622 if (rts_argv[arg][3] != '\0')
1623 {
1624 RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1625 if (RtsFlags.GranFlags.proc==0) {
1626 enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1627 } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1628 RtsFlags.GranFlags.proc < 1)
1629 {
1630 debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1631 MAX_PROC);
1632 *error = rtsTrue;
1633 }
1634 }
1635 else
1636 RtsFlags.GranFlags.proc = MAX_PROC;
1637 break;
1638
1639 case 'f':
1640 RtsFlags.GranFlags.Fishing = rtsTrue;
1641 if (rts_argv[arg][3] != '\0')
1642 RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1643 else
1644 RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1645 break;
1646
1647 case 'w':
1648 if (rts_argv[arg][3] != '\0')
1649 RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1650 else
1651 RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1652 break;
1653
1654 case 'C':
1655 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1656 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1657 break;
1658
1659 case 'G':
1660 debugBelch("Bulk fetching enabled.\n");
1661 RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1662 break;
1663
1664 case 'M':
1665 debugBelch("Thread migration enabled.\n");
1666 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1667 break;
1668
1669 case 'R':
1670 debugBelch("Fair Scheduling enabled.\n");
1671 RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1672 break;
1673
1674 case 'I':
1675 debugBelch("Priority Scheduling enabled.\n");
1676 RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1677 break;
1678
1679 case 'T':
1680 RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1681 RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1682 break;
1683
1684 case 'Z':
1685 RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1686 break;
1687
1688 /* case 'z': */
1689 /* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1690 /* break; */
1691
1692 case 'N':
1693 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1694 break;
1695
1696 case 'b':
1697 RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1698 break;
1699
1700 case 'P':
1701 /* format is -bP<c> where <c> is one char describing kind of profile */
1702 RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1703 switch(rts_argv[arg][3]) {
1704 case '\0': break; // nothing special, just an ordinary profile
1705 case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1706 break;
1707 case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1708 break;
1709 case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1710 break;
1711 case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1712 break;
1713 case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1714 break;
1715 case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1716 break;
1717 default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1718 }
1719 break;
1720
1721 case 's':
1722 RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1723 break;
1724
1725 case 'h':
1726 RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1727 break;
1728
1729 case 'Y': /* syntax: -bY<n>[,<n>] n ... pos int */
1730 if (rts_argv[arg][3] != '\0') {
1731 char *arg0, *tmp;
1732
1733 arg0 = rts_argv[arg]+3;
1734 if ((tmp = strstr(arg0,","))==NULL) {
1735 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1736 debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1737 } else {
1738 *(tmp++) = '\0';
1739 RtsFlags.GranFlags.SparkPriority = decode(arg0);
1740 RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1741 debugBelch("SparkPriority: %u.\n",
1742 RtsFlags.GranFlags.SparkPriority);
1743 debugBelch("SparkPriority2:%u.\n",
1744 RtsFlags.GranFlags.SparkPriority2);
1745 if (RtsFlags.GranFlags.SparkPriority2 <
1746 RtsFlags.GranFlags.SparkPriority) {
1747 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1748 RtsFlags.GranFlags.SparkPriority2,
1749 RtsFlags.GranFlags.SparkPriority);
1750 }
1751 }
1752 } else {
1753 /* plain pri spark is now invoked with -bX
1754 RtsFlags.GranFlags.DoPrioritySparking = 1;
1755 debugBelch("PrioritySparking.\n");
1756 */
1757 }
1758 break;
1759
1760 case 'Q':
1761 if (rts_argv[arg][3] != '\0') {
1762 RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1763 } else {
1764 RtsFlags.GranFlags.ThunksToPack = 1;
1765 }
1766 debugBelch("Thunks To Pack in one packet: %u.\n",
1767 RtsFlags.GranFlags.ThunksToPack);
1768 break;
1769
1770 case 'e':
1771 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1772 debugBelch("Deterministic mode (no random stealing)\n");
1773 break;
1774
1775 /* The following class of options contains eXperimental */
1776 /* features in connection with exploiting granularity */
1777 /* information. I.e. if -bY is chosen these options */
1778 /* tell the RTS what to do with the supplied info --HWL */
1779
1780 case 'W':
1781 if (rts_argv[arg][3] != '\0') {
1782 RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1783 } else {
1784 RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1785 }
1786 debugBelch("Size of GranSim internal pack buffer: %u.\n",
1787 RtsFlags.GranFlags.packBufferSize_internal);
1788 break;
1789
1790 case 'X':
1791 switch(rts_argv[arg][3]) {
1792
1793 case '\0':
1794 RtsFlags.GranFlags.DoPrioritySparking = 1;
1795 debugBelch("Priority Sparking with Normal Priorities.\n");
1796 RtsFlags.GranFlags.InversePriorities = rtsFalse;
1797 RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1798 RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1799 break;
1800
1801 case 'I':
1802 RtsFlags.GranFlags.DoPrioritySparking = 1;
1803 debugBelch("Priority Sparking with Inverse Priorities.\n");
1804 RtsFlags.GranFlags.InversePriorities++;
1805 break;
1806
1807 case 'R':
1808 RtsFlags.GranFlags.DoPrioritySparking = 1;
1809 debugBelch("Priority Sparking with Random Priorities.\n");
1810 RtsFlags.GranFlags.RandomPriorities++;
1811 break;
1812
1813 case 'N':
1814 RtsFlags.GranFlags.DoPrioritySparking = 1;
1815 debugBelch("Priority Sparking with No Priorities.\n");
1816 RtsFlags.GranFlags.IgnorePriorities++;
1817 break;
1818
1819 default:
1820 bad_option( rts_argv[arg] );
1821 break;
1822 }
1823 break;
1824
1825 case '-':
1826 switch(rts_argv[arg][3]) {
1827
1828 case 'C':
1829 RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1830 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1831 break;
1832
1833 case 'G':
1834 RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1835 break;
1836
1837 case 'M':
1838 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1839 break;
1840
1841 case 'R':
1842 RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1843 break;
1844
1845 case 'T':
1846 RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1847 RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1848 break;
1849
1850 case 'Z':
1851 RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1852 break;
1853
1854 case 'N':
1855 RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1856 break;
1857
1858 case 'P':
1859 RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1860 break;
1861
1862 case 's':
1863 RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1864 break;
1865
1866 case 'h':
1867 RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1868 break;
1869
1870 case 'b':
1871 RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1872 break;
1873
1874 case 'X':
1875 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1876 break;
1877
1878 case 'Y':
1879 RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1880 RtsFlags.GranFlags.SparkPriority = rtsFalse;
1881 break;
1882
1883 case 'I':
1884 RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1885 break;
1886
1887 case 'e':
1888 RtsFlags.GranFlags.RandomSteal = rtsFalse;
1889 break;
1890
1891 default:
1892 bad_option( rts_argv[arg] );
1893 break;
1894 }
1895 break;
1896
1897 # if defined(GRAN_CHECK) && defined(GRAN)
1898 case 'D':
1899 switch(rts_argv[arg][3]) {
1900 case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */
1901 if (rts_argv[arg][4] != '\0') {
1902 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1903 debugBelch("Pack buffer size: %d\n",
1904 RtsFlags.GranFlags.packBufferSize);
1905 } else {
1906 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1907 *error = rtsTrue;
1908 }
1909 break;
1910
1911 default:
1912 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1913 /* hack warning: interpret the flags as a binary number */
1914 nat n = decode(rts_argv[arg]+3);
1915 set_GranSim_debug_options(n);
1916 } else {
1917 nat i;
1918 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1919 if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1920 break;
1921
1922 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1923 debugBelch("Valid GranSim debug options are:\n");
1924 help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1925 bad_option( rts_argv[arg] );
1926 } else { // flag found; now set it
1927 set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i
1928 }
1929 }
1930 break;
1931
1932 #if 0
1933 case 'e': /* event trace; also -bD1 */
1934 debugBelch("DEBUG: event_trace; printing event trace.\n");
1935 RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1936 /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1937 break;
1938
1939 case 'E': /* event statistics; also -bD2 */
1940 debugBelch("DEBUG: event_stats; printing event statistics.\n");
1941 RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1942 /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */
1943 break;
1944
1945 case 'f': /* thunkStealing; also -bD4 */
1946 debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1947 RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1948 /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */
1949 break;
1950
1951 case 'z': /* blockOnFetch; also -bD8 */
1952 debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1953 RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1954 /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1955 break;
1956
1957 case 't': /* blockOnFetch_sanity; also -bD16 */
1958 debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1959 RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1960 /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */
1961 break;
1962
1963 case 'S': /* priSpark; also -bD32 */
1964 debugBelch("DEBUG: priSpark; priority sparking.\n");
1965 RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1966 break;
1967
1968 case 's': /* priSched; also -bD64 */
1969 debugBelch("DEBUG: priSched; priority scheduling.\n");
1970 RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1971 break;
1972
1973 case 'F': /* findWork; also -bD128 */
1974 debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1975 RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1976 break;
1977
1978 case 'g': /* globalBlock; also -bD256 */
1979 debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1980 RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1981 break;
1982
1983 case 'G': /* pack; also -bD512 */
1984 debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
1985 RtsFlags.GranFlags.Debug.pack = rtsTrue;
1986 break;
1987
1988 case 'P': /* packBuffer; also -bD1024 */
1989 debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1990 RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1991 break;
1992
1993 case 'o': /* sortedQ; also -bD2048 */
1994 debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1995 RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1996 break;
1997
1998 case 'r': /* randomSteal; also -bD4096 */
1999 debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
2000 RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
2001 break;
2002
2003 case 'q': /* checkSparkQ; also -bD8192 */
2004 debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
2005 RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
2006 break;
2007
2008 case ':': /* checkLight; also -bD16384 */
2009 debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
2010 RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
2011 break;
2012
2013 case 'b': /* bq; also -bD32768 */
2014 debugBelch("DEBUG: bq; check blocking queues\n");
2015 RtsFlags.GranFlags.Debug.bq = rtsTrue;
2016 break;
2017
2018 case 'd': /* all options turned on */
2019 debugBelch("DEBUG: all options turned on.\n");
2020 set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
2021 /* RtsFlags.GranFlags.Debug |= 0x40; */
2022 break;
2023
2024 /* case '\0': */
2025 /* RtsFlags.GranFlags.Debug = 1; */
2026 /* break; */
2027 #endif
2028
2029 }
2030 break;
2031 # endif /* GRAN_CHECK */
2032 default:
2033 bad_option( rts_argv[arg] );
2034 break;
2035 }
2036 }
2037
2038 /*
2039 Interpret n as a binary number masking GranSim debug options and set the
2040 correxponding option. See gran_debug_opts_strs for explanations of the flags.
2041 */
2042 static void
2043 set_GranSim_debug_options(nat n) {
2044 nat i;
2045
2046 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2047 if ((n>>i)&1) {
2048 errorBelch(gran_debug_opts_strs[i]);
2049 switch (i) {
2050 case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break;
2051 case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break;
2052 case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break;
2053 case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break;
2054 case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break;
2055 case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break;
2056 case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break;
2057 case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break;
2058 case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break;
2059 case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break;
2060 case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break;
2061 case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break;
2062 case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break;
2063 case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break;
2064 case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break;
2065 default: barf("set_GranSim_debug_options: only %d debug options expected");
2066 } /* switch */
2067 } /* if */
2068 }
2069
2070 /*
2071 Print one line explanation for each of the GranSim debug options specified
2072 in the bitmask n.
2073 */
2074 static void
2075 help_GranSim_debug_options(nat n) {
2076 nat i;
2077
2078 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
2079 if ((n>>i)&1)
2080 debugBelch(gran_debug_opts_strs[i]);
2081 }
2082
2083 # elif defined(PAR)
2084
2085 static void
2086 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
2087 {
2088
2089 if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
2090 errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
2091 return;
2092 }
2093
2094 /* Communication and task creation cost parameters */
2095 switch(rts_argv[arg][2]) {
2096 case 'e': /* -qe<n> ... allow <n> local sparks */
2097 if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
2098 RtsFlags.ParFlags.maxLocalSparks
2099 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2100
2101 if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
2102 errorBelch("setupRtsFlags: bad value for -e\n");
2103 *error = rtsTrue;
2104 }
2105 }
2106 IF_PAR_DEBUG(verbose,
2107 errorBelch("-qe<n>: max %d local sparks",
2108 RtsFlags.ParFlags.maxLocalSparks));
2109 break;
2110
2111 case 't':
2112 if (rts_argv[arg][3] != '\0') {
2113 RtsFlags.ParFlags.maxThreads
2114 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2115 } else {
2116 errorBelch("missing size for -qt\n");
2117 *error = rtsTrue;
2118 }
2119 IF_PAR_DEBUG(verbose,
2120 errorBelch("-qt<n>: max %d threads",
2121 RtsFlags.ParFlags.maxThreads));
2122 break;
2123
2124 case 'f':
2125 if (rts_argv[arg][3] != '\0')
2126 RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
2127 else
2128 RtsFlags.ParFlags.maxFishes = MAX_FISHES;
2129 break;
2130 IF_PAR_DEBUG(verbose,
2131 errorBelch("-qf<n>: max %d fishes sent out at one time",
2132 RtsFlags.ParFlags.maxFishes));
2133 break;
2134
2135 case 'F':
2136 if (rts_argv[arg][3] != '\0') {
2137 RtsFlags.ParFlags.fishDelay
2138 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2139 } else {
2140 errorBelch("missing fish delay time for -qF\n");
2141 *error = rtsTrue;
2142 }
2143 IF_PAR_DEBUG(verbose,
2144 errorBelch("-qF<n>: fish delay time %d us",
2145 RtsFlags.ParFlags.fishDelay));
2146 break;
2147
2148 case 'O':
2149 RtsFlags.ParFlags.outputDisabled = rtsTrue;
2150 IF_PAR_DEBUG(verbose,
2151 errorBelch("-qO: output disabled"));
2152 break;
2153
2154 case 'g': /* -qg<n> ... globalisation scheme */
2155 if (rts_argv[arg][3] != '\0') {
2156 RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
2157 } else {
2158 errorBelch("missing identifier for globalisation scheme (for -qg)\n");
2159 *error = rtsTrue;
2160 }
2161 IF_PAR_DEBUG(verbose,
2162 debugBelch("-qg<n>: globalisation scheme set to %d",
2163 RtsFlags.ParFlags.globalising));
2164 break;
2165
2166 case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
2167 if (rts_argv[arg][3] != '\0') {
2168 RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
2169 } else {
2170 errorBelch("missing number of thunks per packet (for -qh)\n");
2171 *error = rtsTrue;
2172 }
2173 IF_PAR_DEBUG(verbose,
2174 debugBelch("-qh<n>: thunks per packet set to %d",
2175 RtsFlags.ParFlags.thunksToPack));
2176 break;
2177
2178 case 'P': /* -qP for writing a log file */
2179 //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2180 /* same encoding as in GranSim after -bP */
2181 switch(rts_argv[arg][3]) {
2182 case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
2183 break; // nothing special, just an ordinary profile
2184 case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
2185 RtsFlags.ParFlags.ParStats.Full = rtsFalse;
2186 break;
2187 case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
2188 break;
2189 case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
2190 break;
2191 //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
2192 // break;
2193 case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
2194 break;
2195 case 'g':
2196 # if defined(PAR_TICKY)
2197 RtsFlags.ParFlags.ParStats.Global = rtsTrue;
2198 # else
2199 errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
2200 stg_exit(EXIT_FAILURE);
2201 # endif
2202 break;
2203 default: barf("Unknown option -qP%c", rts_argv[arg][2]);
2204 }
2205 IF_PAR_DEBUG(verbose,
2206 debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
2207 (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
2208 break;
2209
2210 case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
2211 if (rts_argv[arg][3] != '\0') {
2212 RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
2213 } else {
2214 errorBelch("missing size of PackBuffer (for -qQ)\n");
2215 *error = rtsTrue;
2216 }
2217 IF_PAR_DEBUG(verbose,
2218 debugBelch("-qQ<n>: pack buffer size set to %d",
2219 RtsFlags.ParFlags.packBufferSize));
2220 break;
2221
2222 case 'R':
2223 RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2224 IF_PAR_DEBUG(verbose,
2225 debugBelch("-qR: fair-ish scheduling"));
2226 break;
2227
2228 # if defined(DEBUG)
2229 case 'w':
2230 if (rts_argv[arg][3] != '\0') {
2231 RtsFlags.ParFlags.wait
2232 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2233 } else {
2234 RtsFlags.ParFlags.wait = 1000;
2235 }
2236 IF_PAR_DEBUG(verbose,
2237 debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2238 RtsFlags.ParFlags.wait));
2239 break;
2240
2241 case 'D': /* -qD ... all the debugging options */
2242 if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2243 /* hack warning: interpret the flags as a binary number */
2244 nat n = decode(rts_argv[arg]+3);
2245 set_par_debug_options(n);
2246 } else {
2247 nat i;
2248 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2249 if (rts_argv[arg][3] == par_debug_opts_flags[i])
2250 break;
2251
2252 if (i==MAX_PAR_DEBUG_OPTION+1) {
2253 errorBelch("Valid GUM debug options are:\n");
2254 help_par_debug_options(MAX_PAR_DEBUG_MASK);
2255 bad_option( rts_argv[arg] );
2256 } else { // flag found; now set it
2257 set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i
2258 }
2259 }
2260 break;
2261 # endif
2262 default:
2263 errorBelch("Unknown option -q%c (%d opts in total)",
2264 rts_argv[arg][2], *rts_argc);
2265 break;
2266 } /* switch */
2267 }
2268
2269 /*
2270 Interpret n as a binary number masking Par debug options and set the
2271 correxponding option. See par_debug_opts_strs for explanations of the flags.
2272 */
2273 static void
2274 set_par_debug_options(nat n) {
2275 nat i;
2276
2277 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2278 if ((n>>i)&1) {
2279 debugBelch(par_debug_opts_strs[i]);
2280 switch (i) {
2281 case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break;
2282 case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break;
2283 case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break;
2284 case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break;
2285 case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break;
2286 case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break;
2287 case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break;
2288 //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break;
2289 case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break;
2290 case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break;
2291 case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break;
2292 case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break;
2293 case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break;
2294 default: barf("set_par_debug_options: only %d debug options expected",
2295 MAX_PAR_DEBUG_OPTION);
2296 } /* switch */
2297 } /* if */
2298 }
2299
2300 /*
2301 Print one line explanation for each of the GranSim debug options specified
2302 in the bitmask n.
2303 */
2304 static void
2305 help_par_debug_options(nat n) {
2306 nat i;
2307
2308 for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2309 if ((n>>i)&1)
2310 debugBelch(par_debug_opts_strs[i]);
2311 }
2312
2313 #endif /* PAR */
2314
2315 static void
2316 stats_fprintf(FILE *f, char *s, ...)
2317 {
2318 va_list ap;
2319 va_start(ap,s);
2320 if (f == NULL) {
2321 vdebugBelch(s, ap);
2322 } else {
2323 vfprintf(f, s, ap);
2324 }
2325 va_end(ap);
2326 }
2327
2328 static int /* return -1 on error */
2329 open_stats_file (
2330 I_ arg,
2331 int argc, char *argv[],
2332 int rts_argc, char *rts_argv[],
2333 const char *FILENAME_FMT,
2334 FILE **file_ret)
2335 {
2336 FILE *f = NULL;
2337
2338 if (strequal(rts_argv[arg]+2, "stderr")) { /* use debugBelch */
2339 f = NULL; /* NULL means use debugBelch */
2340 } else {
2341 if (rts_argv[arg][2] != '\0') { /* stats file specified */
2342 f = fopen(rts_argv[arg]+2,"w");
2343 } else {
2344 char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2345 sprintf(stats_filename, FILENAME_FMT, argv[0]);
2346 f = fopen(stats_filename,"w");
2347 }
2348 if (f == NULL) {
2349 errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2350 return -1;
2351 }
2352 }
2353 *file_ret = f;
2354
2355 {
2356 /* Write argv and rtsv into start of stats file */
2357 int count;
2358 for(count = 0; count < argc; count++) {
2359 stats_fprintf(f, "%s ", argv[count]);
2360 }
2361 stats_fprintf(f, "+RTS ");
2362 for(count = 0; count < rts_argc; count++)
2363 stats_fprintf(f, "%s ", rts_argv[count]);
2364 stats_fprintf(f, "\n");
2365 }
2366 return 0;
2367 }
2368
2369
2370
2371 static I_
2372 decode(const char *s)
2373 {
2374 I_ c;
2375 StgDouble m;
2376
2377 if (!*s)
2378 return 0;
2379
2380 m = atof(s);
2381 c = s[strlen(s)-1];
2382
2383 if (c == 'g' || c == 'G')
2384 m *= 1000*1000*1000; /* UNchecked! */
2385 else if (c == 'm' || c == 'M')
2386 m *= 1000*1000; /* We do not use powers of 2 (1024) */
2387 else if (c == 'k' || c == 'K') /* to avoid possible bad effects on */
2388 m *= 1000; /* a direct-mapped cache. */
2389 else if (c == 'w' || c == 'W')
2390 m *= sizeof(W_);
2391
2392 return (I_)m;
2393 }
2394
2395 static void
2396 bad_option(const char *s)
2397 {
2398 errorBelch("bad RTS option: %s", s);
2399 stg_exit(EXIT_FAILURE);
2400 }
2401
2402 /* -----------------------------------------------------------------------------
2403 Getting/Setting the program's arguments.
2404
2405 These are used by System.Environment, and parts of the RTS.
2406 -------------------------------------------------------------------------- */
2407
2408 void
2409 setProgName(char *argv[])
2410 {
2411 /* Remove directory from argv[0] -- default files in current directory */
2412 #if !defined(mingw32_HOST_OS)
2413 char *last_slash;
2414 if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
2415 prog_name = last_slash+1;
2416 } else {
2417 prog_name = argv[0];
2418 }
2419 #else
2420 char* last_slash = argv[0] + (strlen(argv[0]) - 1);
2421 while ( last_slash > argv[0] ) {
2422 if ( *last_slash == '/' || *last_slash == '\\' ) {
2423 prog_name = last_slash+1;
2424 return;
2425 }
2426 last_slash--;
2427 }
2428 prog_name = argv[0];
2429 #endif
2430 }
2431
2432 void
2433 getProgArgv(int *argc, char **argv[])
2434 {
2435 if (argc) { *argc = prog_argc; }
2436 if (argv) { *argv = prog_argv; }
2437 }
2438
2439 void
2440 setProgArgv(int argc, char *argv[])
2441 {
2442 /* Usually this is done by startupHaskell, so we don't need to call this.
2443 However, sometimes Hugs wants to change the arguments which Haskell
2444 getArgs >>= ... will be fed. So you can do that by calling here
2445 _after_ calling startupHaskell.
2446 */
2447 prog_argc = argc;
2448 prog_argv = argv;
2449 setProgName(prog_argv);
2450 }
2451
2452 /* These functions record and recall the full arguments, including the
2453 +RTS ... -RTS options. The reason for adding them was so that the
2454 ghc-inplace program can pass /all/ the arguments on to the real ghc. */
2455 void
2456 getFullProgArgv(int *argc, char **argv[])
2457 {
2458 if (argc) { *argc = full_prog_argc; }
2459 if (argv) { *argv = full_prog_argv; }
2460 }
2461
2462 void
2463 setFullProgArgv(int argc, char *argv[])
2464 {
2465 int i;
2466 full_prog_argc = argc;
2467 full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
2468 "setFullProgArgv 1");
2469 for (i = 0; i < argc; i++) {
2470 full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
2471 "setFullProgArgv 2");
2472 strcpy(full_prog_argv[i], argv[i]);
2473 }
2474 full_prog_argv[argc] = NULL;
2475 }
2476