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