+RTS -qw hasn't done anything since 7.0.1; remove the implementation & docs
[ghc-hetmet.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
13 #include "RtsOpts.h"
14 #include "RtsUtils.h"
15 #include "Profiling.h"
16
17 #ifdef HAVE_CTYPE_H
18 #include <ctype.h>
19 #endif
20
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 /* -----------------------------------------------------------------------------
44    Static function decls
45    -------------------------------------------------------------------------- */
46
47 static int              /* return NULL on error */
48 open_stats_file (
49     I_ arg,
50     int argc, char *argv[],
51     int rts_argc, char *rts_argv[],
52     const char *FILENAME_FMT,
53     FILE **file_ret);
54
55 static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max);
56 static void bad_option(const char *s);
57 #ifdef TRACING
58 static void read_trace_flags(char *arg);
59 #endif
60
61 /* -----------------------------------------------------------------------------
62  * Command-line option parsing routines.
63  * ---------------------------------------------------------------------------*/
64
65 void initRtsFlagsDefaults(void)
66 {
67     RtsFlags.GcFlags.statsFile          = NULL;
68     RtsFlags.GcFlags.giveStats          = NO_GC_STATS;
69
70     RtsFlags.GcFlags.maxStkSize         = (8 * 1024 * 1024) / sizeof(W_);
71     RtsFlags.GcFlags.initialStkSize     = 1024 / sizeof(W_);
72     RtsFlags.GcFlags.stkChunkSize       = (32 * 1024) / sizeof(W_);
73     RtsFlags.GcFlags.stkChunkBufferSize = (1 * 1024) / sizeof(W_);
74
75     RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
76     RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
77     RtsFlags.GcFlags.maxHeapSize        = 0;    /* off by default */
78     RtsFlags.GcFlags.heapSizeSuggestion = 0;    /* none */
79     RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
80     RtsFlags.GcFlags.pcFreeHeap         = 3;    /* 3% */
81     RtsFlags.GcFlags.oldGenFactor       = 2;
82     RtsFlags.GcFlags.generations        = 2;
83     RtsFlags.GcFlags.squeezeUpdFrames   = rtsTrue;
84     RtsFlags.GcFlags.compact            = rtsFalse;
85     RtsFlags.GcFlags.compactThreshold   = 30.0;
86     RtsFlags.GcFlags.sweep              = rtsFalse;
87 #ifdef RTS_GTK_FRONTPANEL
88     RtsFlags.GcFlags.frontpanel         = rtsFalse;
89 #endif
90     RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
91
92 #if osf3_HOST_OS
93 /* ToDo: Perhaps by adjusting this value we can make linking without
94  * -static work (i.e., not generate a core-dumping executable)? */
95 # if SIZEOF_VOID_P == 8
96     RtsFlags.GcFlags.heapBase           = 0x180000000L;
97 # else
98 #  error I have no idea where to begin the heap on a non-64-bit osf3 machine.
99 # endif
100 #else
101     RtsFlags.GcFlags.heapBase           = 0;   /* means don't care */
102 #endif
103
104 #ifdef DEBUG
105     RtsFlags.DebugFlags.scheduler       = rtsFalse;
106     RtsFlags.DebugFlags.interpreter     = rtsFalse;
107     RtsFlags.DebugFlags.weak            = rtsFalse;
108     RtsFlags.DebugFlags.gccafs          = rtsFalse;
109     RtsFlags.DebugFlags.gc              = rtsFalse;
110     RtsFlags.DebugFlags.block_alloc     = rtsFalse;
111     RtsFlags.DebugFlags.sanity          = rtsFalse;
112     RtsFlags.DebugFlags.stable          = rtsFalse;
113     RtsFlags.DebugFlags.stm             = rtsFalse;
114     RtsFlags.DebugFlags.prof            = rtsFalse;
115     RtsFlags.DebugFlags.apply           = rtsFalse;
116     RtsFlags.DebugFlags.linker          = rtsFalse;
117     RtsFlags.DebugFlags.squeeze         = rtsFalse;
118     RtsFlags.DebugFlags.hpc             = rtsFalse;
119     RtsFlags.DebugFlags.sparks          = rtsFalse;
120 #endif
121
122 #if defined(PROFILING)
123     RtsFlags.CcFlags.doCostCentres      = 0;
124 #endif /* PROFILING */
125
126     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
127     RtsFlags.ProfFlags.profileInterval    = 100;
128
129 #ifdef PROFILING
130     RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
131     RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
132     RtsFlags.ProfFlags.maxRetainerSetSize = 8;
133     RtsFlags.ProfFlags.ccsLength          = 25;
134     RtsFlags.ProfFlags.modSelector        = NULL;
135     RtsFlags.ProfFlags.descrSelector      = NULL;
136     RtsFlags.ProfFlags.typeSelector       = NULL;
137     RtsFlags.ProfFlags.ccSelector         = NULL;
138     RtsFlags.ProfFlags.ccsSelector        = NULL;
139     RtsFlags.ProfFlags.retainerSelector   = NULL;
140     RtsFlags.ProfFlags.bioSelector        = NULL;
141 #endif
142
143 #ifdef TRACING
144     RtsFlags.TraceFlags.tracing       = TRACE_NONE;
145     RtsFlags.TraceFlags.timestamp     = rtsFalse;
146     RtsFlags.TraceFlags.scheduler     = rtsFalse;
147 #endif
148
149     RtsFlags.MiscFlags.tickInterval     = 20;  /* In milliseconds */
150     RtsFlags.ConcFlags.ctxtSwitchTime   = 20;  /* In milliseconds */
151
152     RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
153     RtsFlags.MiscFlags.machineReadable = rtsFalse;
154     RtsFlags.MiscFlags.linkerMemBase    = 0;
155
156 #ifdef THREADED_RTS
157     RtsFlags.ParFlags.nNodes            = 1;
158     RtsFlags.ParFlags.migrate           = rtsTrue;
159     RtsFlags.ParFlags.parGcEnabled      = 1;
160     RtsFlags.ParFlags.parGcGen          = 0;
161     RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
162     RtsFlags.ParFlags.parGcLoadBalancingGen = 1;
163     RtsFlags.ParFlags.setAffinity       = 0;
164 #endif
165
166 #if defined(THREADED_RTS)
167     RtsFlags.ParFlags.maxLocalSparks    = 4096;
168 #endif /* THREADED_RTS */
169
170 #ifdef TICKY_TICKY
171     RtsFlags.TickyFlags.showTickyStats   = rtsFalse;
172     RtsFlags.TickyFlags.tickyFile        = NULL;
173 #endif
174
175 #ifdef USE_PAPI
176     /* By default no special measurements taken */
177     RtsFlags.PapiFlags.eventType        = 0;
178     RtsFlags.PapiFlags.numUserEvents    = 0;
179 #endif
180 }
181
182 static const char *
183 usage_text[] = {
184 "",
185 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
186 "",
187 "   +RTS    Indicates run time system options follow",
188 "   -RTS    Indicates program arguments follow",
189 "  --RTS    Indicates that ALL subsequent arguments will be given to the",
190 "           program (including any of these RTS flags)",
191 "",
192 "The following run time system options are available:",
193 "",
194 "  -?       Prints this message and exits; the program is not executed",
195 "  --info   Print information about the RTS used by this program",
196 "",
197 "  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
198 "  -ki<size> Sets the initial thread stack size (default 1k)  Egs: -ki4k -ki2m",
199 "  -kc<size> Sets the stack chunk size (default 32k)",
200 "  -kb<size> Sets the stack chunk buffer size (default 1k)",
201 "",
202 "  -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
203 "  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
204 "  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
205 "  -m<n>    Minimum % of heap which must be available (default 3%)",
206 "  -G<n>    Number of generations (default: 2)",
207 "  -c<n>    Use in-place compaction instead of copying in the oldest generation",
208 "           when live data is at least <n>% of the maximum heap size set with",
209 "           -M (default: 30%)",
210 "  -c       Use in-place compaction for all oldest generation collections",
211 "           (the default is to use copying)",
212 "  -w       Use mark-region for the oldest generation (experimental)",
213 #if defined(THREADED_RTS)
214 "  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
215 #endif
216 "",
217 "  -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
218 "  -s[<file>] Summary  GC statistics (if <file> omitted, uses stderr)",
219 "  -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
220 #ifdef RTS_GTK_FRONTPANEL
221 "  -f       Display front panel (requires X11 & GTK+)",
222 #endif
223 "",
224 "",
225 "  -Z       Don't squeeze out update frames on stack overflow",
226 "  -B       Sound the bell at the start of each garbage collection",
227 #if defined(PROFILING)
228 "",
229 "  -px      Time/allocation profile (XML)  (output file <program>.prof)",
230 "  -p       Time/allocation profile        (output file <program>.prof)",
231 "  -P       More detailed Time/Allocation profile",
232 "  -Pa      Give information about *all* cost centres",
233
234 # if defined(PROFILING)
235 "",
236 "  -hx            Heap residency profile (XML)   (output file <program>.prof)",
237 "  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
238 "     break-down: c = cost centre stack (default)",
239 "                 m = module",
240 "                 d = closure description",
241 "                 y = type description",
242 "                 r = retainer",
243 "                 b = biography (LAG,DRAG,VOID,USE)",
244 "  A subset of closures may be selected thusly:",
245 "    -hc<cc>,...  specific cost centre(s) (top of stack only)",
246 "    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
247 "    -hm<mod>...  all cost centres from the specified modules(s)",
248 "    -hd<des>,... closures with specified closure descriptions",
249 "    -hy<typ>...  closures with specified type descriptions",
250 "    -hr<cc>...   closures with specified retainers",
251 "    -hb<bio>...  closures with specified biographies (lag,drag,void,use)",
252 "",
253 "  -R<size>       Set the maximum retainer set size (default: 8)",
254 "", 
255 "  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
256 "                 (default: 25)",
257 "",
258 "  -xt            Include threads (TSOs) in a heap profile",
259 "",
260 "  -xc      Show current cost centre stack on raising an exception",
261 # endif
262 #endif /* PROFILING or PAR */
263
264 #ifdef TRACING
265 "",
266 "  -l[flags]  Log events in binary format to the file <program>.eventlog",
267 #  ifdef DEBUG
268 "  -v[flags]  Log events to stderr",
269 #  endif
270 "             where [flags] can contain:",
271 "                s    scheduler events",
272 #  ifdef DEBUG
273 "                t    add time stamps (only useful with -v)",
274 #  endif
275 #endif
276
277 #if !defined(PROFILING)
278 "",
279 "  -hT      Heap residency profile (output file <program>.hp)",
280 #endif
281 "  -i<sec>  Time between heap samples (seconds, default: 0.1)",
282 "",
283 #if defined(TICKY_TICKY)
284 "  -r<file>  Produce ticky-ticky statistics (with -rstderr for stderr)",
285 "",
286 #endif
287 "  -C<secs>  Context-switch interval in seconds.",
288 "            0 or no argument means switch as often as possible.",
289 "            Default: 0.02 sec; resolution is set by -V below.",
290 "  -V<secs>  Master tick interval in seconds (0 == disable timer).",
291 "            This sets the resolution for -C and the profile timer -i.",
292 "            Default: 0.02 sec.",
293 "",
294 #if defined(DEBUG)
295 "  -Ds  DEBUG: scheduler",
296 "  -Di  DEBUG: interpreter",
297 "  -Dw  DEBUG: weak",
298 "  -DG  DEBUG: gccafs",
299 "  -Dg  DEBUG: gc",
300 "  -Db  DEBUG: block",
301 "  -DS  DEBUG: sanity",
302 "  -Dt  DEBUG: stable",
303 "  -Dp  DEBUG: prof",
304 "  -De  DEBUG: event logging",
305 "  -Da  DEBUG: apply",
306 "  -Dl  DEBUG: linker",
307 "  -Dm  DEBUG: stm",
308 "  -Dz  DEBUG: stack squezing",
309 "  -Dc  DEBUG: program coverage",
310 "  -Dr  DEBUG: sparks",
311 "",
312 "     NOTE: DEBUG events are sent to stderr by default; add -l to create a",
313 "     binary event log file instead.",
314 "",
315 #endif /* DEBUG */
316 #if defined(THREADED_RTS) && !defined(NOSMP)
317 "  -N<n>     Use <n> processors (default: 1)",
318 "  -N        Determine the number of processors to use automatically",
319 "  -qg[<n>]  Use parallel GC only for generations >= <n>",
320 "            (default: 0, -qg alone turns off parallel GC)",
321 "  -qb[<n>]  Use load-balancing in the parallel GC only for generations >= <n>",
322 "            (default: 1, -qb alone turns off load-balancing)",
323 "  -qa       Use the OS to set thread affinity (experimental)",
324 "  -qm       Don't automatically migrate threads between CPUs",
325 #endif
326 "  --install-signal-handlers=<yes|no>",
327 "            Install signal handlers (default: yes)",
328 #if defined(THREADED_RTS)
329 "  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
330 #endif
331 #if defined(x86_64_HOST_ARCH)
332 "  -xm       Base address to mmap memory in the GHCi linker",
333 "            (hex; must be <80000000)",
334 #endif
335 #if defined(USE_PAPI)
336 "  -aX       CPU performance counter measurements using PAPI",
337 "            (use with the -s<file> option).  X is one of:",
338 "",
339 /* "            y - cycles", */
340 "            1 - level 1 cache misses",
341 "            2 - level 2 cache misses",
342 "            b - branch mispredictions",
343 "            s - stalled cycles",
344 "            e - cache miss and branch misprediction events",
345 "            +PAPI_EVENT   - collect papi preset event PAPI_EVENT",
346 "            #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
347 #endif
348 "",
349 "RTS options may also be specified using the GHCRTS environment variable.",
350 "",
351 "Other RTS options may be available for programs compiled a different way.",
352 "The GHC User's Guide has full details.",
353 "",
354 0
355 };
356
357 STATIC_INLINE rtsBool
358 strequal(const char *a, const char * b)
359 {
360     return(strcmp(a, b) == 0);
361 }
362
363 static void
364 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
365 {
366     char *c1, *c2;
367
368     c1 = s;
369     do {
370         while (isspace(*c1)) { c1++; };
371         c2 = c1;
372         while (!isspace(*c2) && *c2 != '\0') { c2++; };
373         
374         if (c1 == c2) { break; }
375         
376         if (*rts_argc < MAX_RTS_ARGS-1) {
377             s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
378             strncpy(s, c1, c2-c1);
379             s[c2-c1] = '\0';
380             rts_argv[(*rts_argc)++] = s;
381         } else {
382             barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
383         }
384         
385         c1 = c2;
386     } while (*c1 != '\0');
387 }
388     
389 void
390 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
391 {
392     rtsBool error = rtsFalse;
393     I_ mode;
394     I_ arg, total_arg;
395
396     setProgName (argv);
397     total_arg = *argc;
398     arg = 1;
399
400     *argc = 1;
401     *rts_argc = 0;
402
403     // process arguments from the ghc_rts_opts global variable first.
404     // (arguments from the GHCRTS environment variable and the command
405     // line override these).
406     {
407         if (ghc_rts_opts != NULL) {
408             splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
409         }
410     }
411
412     // process arguments from the GHCRTS environment variable next
413     // (arguments from the command line override these).
414     {
415         char *ghc_rts = getenv("GHCRTS");
416
417         if (ghc_rts != NULL) {
418             if (rtsOptsEnabled != rtsOptsNone) {
419                 splitRtsFlags(ghc_rts, rts_argc, rts_argv);
420             }
421             else {
422                 errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n         Link with -rtsopts to enable them.");
423                 // We don't actually exit, just warn
424             }
425         }
426     }
427
428     // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
429     //   argv[0] must be PGM argument -- leave in argv
430
431     for (mode = PGM; arg < total_arg; arg++) {
432         // The '--RTS' argument disables all future +RTS ... -RTS processing.
433         if (strequal("--RTS", argv[arg])) {
434             arg++;
435             break;
436         }
437         // The '--' argument is passed through to the program, but
438         // disables all further +RTS ... -RTS processing.
439         else if (strequal("--", argv[arg])) {
440             break;
441         }
442         else if (strequal("+RTS", argv[arg])) {
443             if (rtsOptsEnabled != rtsOptsNone) {
444                 mode = RTS;
445             }
446             else {
447                 errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
448                 stg_exit(EXIT_FAILURE);
449             }
450         }
451         else if (strequal("-RTS", argv[arg])) {
452             mode = PGM;
453         }
454         else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
455             rts_argv[(*rts_argc)++] = argv[arg];
456         }
457         else if (mode == PGM) {
458             argv[(*argc)++] = argv[arg];
459         }
460         else {
461           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
462         }
463     }
464     // process remaining program arguments
465     for (; arg < total_arg; arg++) {
466         argv[(*argc)++] = argv[arg];
467     }
468     argv[*argc] = (char *) 0;
469     rts_argv[*rts_argc] = (char *) 0;
470
471     // Process RTS (rts_argv) part: mainly to determine statsfile
472     for (arg = 0; arg < *rts_argc; arg++) {
473         if (rts_argv[arg][0] != '-') {
474             fflush(stdout);
475             errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
476             error = rtsTrue;
477
478         } else {
479
480             switch(rts_argv[arg][1]) {
481             case '-':
482                 if (strequal("info", &rts_argv[arg][2])) {
483                     printRtsInfo();
484                     stg_exit(0);
485                 }
486                 break;
487             default:
488                 break;
489             }
490
491             if (rtsOptsEnabled != rtsOptsAll)
492             {
493                 errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
494                 stg_exit(EXIT_FAILURE);
495             }
496
497             switch(rts_argv[arg][1]) {
498
499               /* process: general args, then PROFILING-only ones, then
500                  CONCURRENT-only, TICKY-only (same order as defined in
501                  RtsFlags.lh); within those groups, mostly in
502                  case-insensitive alphabetical order.  Final group is
503                  x*, which allows for more options.
504               */
505
506 #ifdef TICKY_TICKY
507 # define TICKY_BUILD_ONLY(x) x
508 #else
509 # define TICKY_BUILD_ONLY(x) \
510 errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
511 error = rtsTrue;
512 #endif
513
514 #ifdef PROFILING
515 # define PROFILING_BUILD_ONLY(x)   x
516 #else
517 # define PROFILING_BUILD_ONLY(x) \
518 errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
519 error = rtsTrue;
520 #endif
521
522 #ifdef TRACING
523 # define TRACING_BUILD_ONLY(x)   x
524 #else
525 # define TRACING_BUILD_ONLY(x) \
526 errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
527 error = rtsTrue;
528 #endif
529
530 #ifdef THREADED_RTS
531 # define THREADED_BUILD_ONLY(x)      x
532 #else
533 # define THREADED_BUILD_ONLY(x) \
534 errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
535 error = rtsTrue;
536 #endif
537
538 #ifdef DEBUG
539 # define DEBUG_BUILD_ONLY(x) x
540 #else
541 # define DEBUG_BUILD_ONLY(x) \
542 errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
543 error = rtsTrue;
544 #endif
545
546               /* =========== GENERAL ========================== */
547               case '?':
548                 error = rtsTrue;
549                 break;
550
551               /* This isn't going to allow us to keep related options
552                  together as we add more --* flags. We really need a
553                  proper options parser. */
554               case '-':
555                   if (strequal("install-signal-handlers=yes",
556                                &rts_argv[arg][2])) {
557                       RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
558                   }
559                   else if (strequal("install-signal-handlers=no",
560                                &rts_argv[arg][2])) {
561                       RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
562                   }
563                   else if (strequal("machine-readable",
564                                &rts_argv[arg][2])) {
565                       RtsFlags.MiscFlags.machineReadable = rtsTrue;
566                   }
567                   else if (strequal("info",
568                                &rts_argv[arg][2])) {
569                       printRtsInfo();
570                       stg_exit(0);
571                   }
572                   else {
573                       errorBelch("unknown RTS option: %s",rts_argv[arg]);
574                       error = rtsTrue;
575                   }
576                   break;
577               case 'A':
578                   RtsFlags.GcFlags.minAllocAreaSize
579                       = decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_INT_MAX)
580                            / BLOCK_SIZE;
581                   break;
582
583 #ifdef USE_PAPI
584               case 'a':
585                 switch(rts_argv[arg][2]) {
586                 case '1':
587                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
588                   break;
589                 case '2':
590                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
591                   break;
592                 case 'b':
593                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
594                   break;
595                 case 's':
596                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
597                   break;
598                 case 'e':
599                   RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
600                   break;
601                 case '+':
602                 case '#':
603                   if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
604                       errorBelch("maximum number of PAPI events reached");
605                       stg_exit(EXIT_FAILURE);
606                   }
607                   nat eventNum  = RtsFlags.PapiFlags.numUserEvents++;
608                   char kind     = rts_argv[arg][2];
609                   nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;
610
611                   RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
612                   RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
613                   RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
614                   break;
615                 default:
616                   bad_option( rts_argv[arg] );
617                 }
618                 break;
619 #endif
620
621               case 'B':
622                 RtsFlags.GcFlags.ringBell = rtsTrue;
623                 break;
624
625               case 'c':
626                   if (rts_argv[arg][2] != '\0') {
627                       RtsFlags.GcFlags.compactThreshold =
628                           atof(rts_argv[arg]+2);
629                   } else {
630                       RtsFlags.GcFlags.compact = rtsTrue;
631                   }
632                   break;
633
634               case 'w':
635                 RtsFlags.GcFlags.sweep = rtsTrue;
636                 break;
637
638               case 'F':
639                 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
640               
641                 if (RtsFlags.GcFlags.oldGenFactor < 0)
642                   bad_option( rts_argv[arg] );
643                 break;
644               
645               case 'D':
646               DEBUG_BUILD_ONLY(
647               { 
648                   char *c;
649
650                   for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
651                       switch (*c) {
652                       case 's':
653                           RtsFlags.DebugFlags.scheduler = rtsTrue;
654                           break;
655                       case 'i':
656                           RtsFlags.DebugFlags.interpreter = rtsTrue;
657                           break;
658                       case 'w':
659                           RtsFlags.DebugFlags.weak = rtsTrue;
660                           break;
661                       case 'G':
662                           RtsFlags.DebugFlags.gccafs = rtsTrue;
663                           break;
664                       case 'g':
665                           RtsFlags.DebugFlags.gc = rtsTrue;
666                           break;
667                       case 'b':
668                           RtsFlags.DebugFlags.block_alloc = rtsTrue;
669                           break;
670                       case 'S':
671                           RtsFlags.DebugFlags.sanity = rtsTrue;
672                           break;
673                       case 't':
674                           RtsFlags.DebugFlags.stable = rtsTrue;
675                           break;
676                       case 'p':
677                           RtsFlags.DebugFlags.prof = rtsTrue;
678                           break;
679                       case 'l':
680                           RtsFlags.DebugFlags.linker = rtsTrue;
681                           break;
682                       case 'a':
683                           RtsFlags.DebugFlags.apply = rtsTrue;
684                           break;
685                       case 'm':
686                           RtsFlags.DebugFlags.stm = rtsTrue;
687                           break;
688                       case 'z':
689                           RtsFlags.DebugFlags.squeeze = rtsTrue;
690                           break;
691                       case 'c':
692                           RtsFlags.DebugFlags.hpc = rtsTrue;
693                           break;
694                       case 'r':
695                           RtsFlags.DebugFlags.sparks = rtsTrue;
696                           break;
697                       default:
698                           bad_option( rts_argv[arg] );
699                       }
700                   }
701                   // -Dx also turns on -v.  Use -l to direct trace
702                   // events to the .eventlog file instead.
703                   RtsFlags.TraceFlags.tracing = TRACE_STDERR;
704               })
705               break;
706
707               case 'K':
708                   RtsFlags.GcFlags.maxStkSize =
709                       decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
710                   break;
711
712               case 'k':
713                 switch(rts_argv[arg][2]) {
714                 case 'c':
715                   RtsFlags.GcFlags.stkChunkSize =
716                       decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
717                   break;
718                 case 'b':
719                   RtsFlags.GcFlags.stkChunkBufferSize =
720                       decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
721                   break;
722                 case 'i':
723                   RtsFlags.GcFlags.initialStkSize =
724                       decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
725                   break;
726                 default:
727                   RtsFlags.GcFlags.initialStkSize =
728                       decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
729                   break;
730                 }
731                 break;
732
733               case 'M':
734                   RtsFlags.GcFlags.maxHeapSize =
735                       decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
736                   /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
737                   break;
738
739               case 'm':
740                   RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
741
742                   if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
743                       RtsFlags.GcFlags.pcFreeHeap > 100)
744                       bad_option( rts_argv[arg] );
745                   break;
746
747               case 'G':
748                   RtsFlags.GcFlags.generations =
749                       decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
750                   break;
751
752               case 'H':
753                   if (rts_argv[arg][2] == '\0') {
754                       RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
755                   } else {
756                       RtsFlags.GcFlags.heapSizeSuggestion =
757                           (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
758                   }
759                   break;
760
761 #ifdef RTS_GTK_FRONTPANEL
762               case 'f':
763                   RtsFlags.GcFlags.frontpanel = rtsTrue;
764                   break;
765 #endif
766
767               case 'I': /* idle GC delay */
768                 if (rts_argv[arg][2] == '\0') {
769                   /* use default */
770                 } else {
771                     I_ cst; /* tmp */
772
773                     /* Convert to millisecs */
774                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
775                     RtsFlags.GcFlags.idleGCDelayTime = cst;
776                 }
777                 break;
778
779               case 'S':
780                   RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
781                   goto stats;
782
783               case 's':
784                   RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
785                   goto stats;
786
787               case 't':
788                   RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
789                   goto stats;
790
791             stats:
792                 { 
793                     int r;
794                     r = open_stats_file(arg, *argc, argv,
795                                         *rts_argc, rts_argv, NULL,
796                                         &RtsFlags.GcFlags.statsFile);
797                     if (r == -1) { error = rtsTrue; }
798                 }
799                 break;
800
801               case 'Z':
802                 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
803                 break;
804
805               /* =========== PROFILING ========================== */
806
807               case 'P': /* detailed cost centre profiling (time/alloc) */
808               case 'p': /* cost centre profiling (time/alloc) */
809                 PROFILING_BUILD_ONLY(
810                 switch (rts_argv[arg][2]) {
811                   case 'x':
812                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
813                     break;
814                   case 'a':
815                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
816                     break;
817                   default:
818                       if (rts_argv[arg][1] == 'P') {
819                           RtsFlags.CcFlags.doCostCentres =
820                               COST_CENTRES_VERBOSE;
821                       } else {
822                           RtsFlags.CcFlags.doCostCentres =
823                               COST_CENTRES_SUMMARY;
824                       }
825                       break;
826                 }
827                 ) break;
828
829               case 'R':
830                   PROFILING_BUILD_ONLY(
831                       RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
832                   ) break;
833               case 'L':
834                   PROFILING_BUILD_ONLY(
835                       RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
836                       if(RtsFlags.ProfFlags.ccsLength <= 0) {
837                         bad_option(rts_argv[arg]);
838                       }
839                   ) break;
840               case 'h': /* serial heap profile */
841 #if !defined(PROFILING)
842                 switch (rts_argv[arg][2]) {
843                   case '\0':
844                   case 'T':
845                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
846                     break;
847                   default:
848                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
849                     error = rtsTrue;
850                 }
851 #else
852                 PROFILING_BUILD_ONLY(
853                 switch (rts_argv[arg][2]) {
854                 case '\0':
855                 case 'C':
856                 case 'c':
857                 case 'M':
858                 case 'm':
859                 case 'D':
860                 case 'd':
861                 case 'Y':
862                 case 'y':
863                 case 'R':
864                 case 'r':
865                 case 'B':
866                 case 'b':
867                     if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
868                         {
869                             char *left  = strchr(rts_argv[arg], '{');
870                             char *right = strrchr(rts_argv[arg], '}');
871
872                             // curly braces are optional, for
873                             // backwards compat.
874                             if (left)
875                                 left = left+1;
876                             else
877                                 left = rts_argv[arg] + 3;
878
879                             if (!right)
880                                 right = rts_argv[arg] + strlen(rts_argv[arg]);
881
882                             *right = '\0';
883
884                             switch (rts_argv[arg][2]) {
885                             case 'c': // cost centre label select
886                                 RtsFlags.ProfFlags.ccSelector = left;
887                                 break;
888                             case 'C':
889                                 RtsFlags.ProfFlags.ccsSelector = left;
890                                 break;
891                             case 'M':
892                             case 'm': // cost centre module select
893                                 RtsFlags.ProfFlags.modSelector = left;
894                                 break;
895                             case 'D':
896                             case 'd': // closure descr select 
897                                 RtsFlags.ProfFlags.descrSelector = left;
898                                 break;
899                             case 'Y':
900                             case 'y': // closure type select
901                                 RtsFlags.ProfFlags.typeSelector = left;
902                                 break;
903                             case 'R':
904                             case 'r': // retainer select
905                                 RtsFlags.ProfFlags.retainerSelector = left;
906                                 break;
907                             case 'B':
908                             case 'b': // biography select
909                                 RtsFlags.ProfFlags.bioSelector = left;
910                                 break;
911                             }
912                         }
913                         break;
914                     }
915
916                     if (RtsFlags.ProfFlags.doHeapProfile != 0) {
917                         errorBelch("multiple heap profile options");
918                         error = rtsTrue;
919                         break;
920                     }
921
922                     switch (rts_argv[arg][2]) {
923                     case '\0':
924                     case 'C':
925                     case 'c':
926                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
927                         break;
928                     case 'M':
929                     case 'm':
930                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
931                           break;
932                     case 'D':
933                     case 'd':
934                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
935                           break;
936                     case 'Y':
937                     case 'y':
938                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
939                           break;
940                     case 'R':
941                     case 'r':
942                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
943                           break;
944                     case 'B':
945                     case 'b':
946                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
947                           break;
948                     }
949                     break;
950                       
951                 default:
952                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
953                     error = rtsTrue;
954                 }
955                 ) 
956 #endif /* PROFILING */
957                 break;
958
959               case 'i': /* heap sample interval */
960                 if (rts_argv[arg][2] == '\0') {
961                   /* use default */
962                 } else {
963                     I_ cst; /* tmp */
964
965                     /* Convert to milliseconds */
966                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
967                     RtsFlags.ProfFlags.profileInterval = cst;
968                 }
969                 break;
970
971               /* =========== CONCURRENT ========================= */
972               case 'C': /* context switch interval */
973                 if (rts_argv[arg][2] == '\0')
974                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
975                 else {
976                     I_ cst; /* tmp */
977
978                     /* Convert to milliseconds */
979                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
980                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
981                 }
982                 break;
983
984               case 'V': /* master tick interval */
985                 if (rts_argv[arg][2] == '\0') {
986                     // turns off ticks completely
987                     RtsFlags.MiscFlags.tickInterval = 0;
988                 } else {
989                     I_ cst; /* tmp */
990
991                     /* Convert to milliseconds */
992                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
993                     RtsFlags.MiscFlags.tickInterval = cst;
994                 }
995                 break;
996
997 #if !defined(NOSMP)
998               case 'N':
999                 THREADED_BUILD_ONLY(
1000                 if (rts_argv[arg][2] == '\0') {
1001 #if defined(PROFILING)
1002                     RtsFlags.ParFlags.nNodes = 1;
1003 #else
1004                     RtsFlags.ParFlags.nNodes = getNumberOfProcessors();
1005 #endif
1006                 } else {
1007                     RtsFlags.ParFlags.nNodes
1008                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1009                     if (RtsFlags.ParFlags.nNodes <= 0) {
1010                       errorBelch("bad value for -N");
1011                       error = rtsTrue;
1012                     }
1013 #if defined(PROFILING)
1014                     if (RtsFlags.ParFlags.nNodes > 1) {
1015                         errorBelch("bad option %s: only -N1 is supported with profiling", rts_argv[arg]);
1016                       error = rtsTrue;
1017                     }
1018 #endif
1019                 }
1020                 ) break;
1021
1022               case 'g':
1023                 THREADED_BUILD_ONLY(
1024                     switch (rts_argv[arg][2]) {
1025                     case '1':
1026                         // backwards compat only
1027                         RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1028                         break;
1029                     default:
1030                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
1031                         error = rtsTrue;
1032                         break;
1033                     }
1034                     ) break;
1035
1036               case 'q':
1037                 THREADED_BUILD_ONLY(
1038                     switch (rts_argv[arg][2]) {
1039                     case '\0':
1040                         errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1041                         error = rtsTrue;
1042                         break;
1043                     case 'g':
1044                         if (rts_argv[arg][3] == '\0') {
1045                             RtsFlags.ParFlags.parGcEnabled = rtsFalse;
1046                         } else {
1047                             RtsFlags.ParFlags.parGcEnabled = rtsTrue;
1048                             RtsFlags.ParFlags.parGcGen
1049                                 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1050                         }
1051                         break;
1052                     case 'b':
1053                         if (rts_argv[arg][3] == '\0') {
1054                             RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsFalse;
1055                         }
1056                         else {
1057                             RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue;
1058                             RtsFlags.ParFlags.parGcLoadBalancingGen
1059                                 = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1060                         }
1061                         break;
1062                     case 'a':
1063                         RtsFlags.ParFlags.setAffinity = rtsTrue;
1064                         break;
1065                     case 'm':
1066                         RtsFlags.ParFlags.migrate = rtsFalse;
1067                         break;
1068                     case 'w':
1069                         // -qw was removed; accepted for backwards compat
1070                         break;
1071                     default:
1072                         errorBelch("unknown RTS option: %s",rts_argv[arg]);
1073                         error = rtsTrue;
1074                         break;
1075                     }
1076                     ) break;
1077 #endif
1078               /* =========== PARALLEL =========================== */
1079               case 'e':
1080                 THREADED_BUILD_ONLY(
1081                 if (rts_argv[arg][2] != '\0') {
1082                     RtsFlags.ParFlags.maxLocalSparks
1083                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1084                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1085                       errorBelch("bad value for -e");
1086                       error = rtsTrue;
1087                     }
1088                 }
1089                 ) break;
1090
1091               /* =========== TICKY ============================== */
1092
1093               case 'r': /* Basic profiling stats */
1094                 TICKY_BUILD_ONLY(
1095
1096                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1097
1098                 { 
1099                     int r;
1100                     r = open_stats_file(arg, *argc, argv,
1101                                         *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1102                                         &RtsFlags.TickyFlags.tickyFile);
1103                     if (r == -1) { error = rtsTrue; }
1104                 }
1105                 ) break;
1106
1107               /* =========== TRACING ---------=================== */
1108
1109               case 'l':
1110                   TRACING_BUILD_ONLY(
1111                       RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
1112                       read_trace_flags(&rts_argv[arg][2]);
1113                       );
1114                   break;
1115
1116               case 'v':
1117                   DEBUG_BUILD_ONLY(
1118                       RtsFlags.TraceFlags.tracing = TRACE_STDERR;
1119                       read_trace_flags(&rts_argv[arg][2]);
1120                       );
1121                   break;
1122
1123               /* =========== EXTENDED OPTIONS =================== */
1124
1125               case 'x': /* Extend the argument space */
1126                 switch(rts_argv[arg][2]) {
1127                   case '\0':
1128                     errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1129                     error = rtsTrue;
1130                     break;
1131
1132                 case 'b': /* heapBase in hex; undocumented */
1133                     if (rts_argv[arg][3] != '\0') {
1134                         RtsFlags.GcFlags.heapBase
1135                             = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1136                     } else {
1137                         errorBelch("-xb: requires argument");
1138                         error = rtsTrue;
1139                     }
1140                     break;
1141
1142 #if defined(x86_64_HOST_ARCH)
1143                 case 'm': /* linkerMemBase */
1144                     if (rts_argv[arg][3] != '\0') {
1145                         RtsFlags.MiscFlags.linkerMemBase
1146                             = strtol(rts_argv[arg]+3, (char **) NULL, 16);
1147                         if (RtsFlags.MiscFlags.linkerMemBase > 0x80000000) {
1148                             errorBelch("-xm: value must be <80000000");
1149                             error = rtsTrue;
1150                         }
1151                     } else {
1152                         RtsFlags.MiscFlags.linkerMemBase = 0;
1153                     }
1154                     break;
1155 #endif
1156
1157                 case 'c': /* Debugging tool: show current cost centre on an exception */
1158                     PROFILING_BUILD_ONLY(
1159                         RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1160                         );
1161                     break;
1162
1163                 case 't':  /* Include memory used by TSOs in a heap profile */
1164                     PROFILING_BUILD_ONLY(
1165                         RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1166                         );
1167                     break;
1168
1169                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
1170
1171                   default:
1172                     errorBelch("unknown RTS option: %s",rts_argv[arg]);
1173                     error = rtsTrue;
1174                     break;
1175                 }
1176                 break;  /* defensive programming */
1177
1178               /* =========== OH DEAR ============================ */
1179               default:
1180                 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1181                 error = rtsTrue;
1182                 break;
1183             }
1184         }
1185     }
1186
1187     if (RtsFlags.MiscFlags.tickInterval < 0) {
1188         RtsFlags.MiscFlags.tickInterval = 50;
1189     }
1190
1191     // If the master timer is disabled, turn off the other timers.
1192     if (RtsFlags.MiscFlags.tickInterval == 0) {
1193         RtsFlags.ConcFlags.ctxtSwitchTime  = 0;
1194         RtsFlags.GcFlags.idleGCDelayTime   = 0;
1195         RtsFlags.ProfFlags.profileInterval = 0;
1196     }
1197
1198     // Determine what tick interval we should use for the RTS timer
1199     // by taking the shortest of the various intervals that we need to
1200     // monitor.
1201     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1202         RtsFlags.MiscFlags.tickInterval =
1203             stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
1204                     RtsFlags.MiscFlags.tickInterval);
1205     }
1206
1207     if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
1208         RtsFlags.MiscFlags.tickInterval =
1209             stg_min(RtsFlags.GcFlags.idleGCDelayTime,
1210                     RtsFlags.MiscFlags.tickInterval);
1211     }
1212
1213     if (RtsFlags.ProfFlags.profileInterval > 0) {
1214         RtsFlags.MiscFlags.tickInterval =
1215             stg_min(RtsFlags.ProfFlags.profileInterval,
1216                     RtsFlags.MiscFlags.tickInterval);
1217     }
1218
1219     if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
1220         RtsFlags.ConcFlags.ctxtSwitchTicks =
1221             RtsFlags.ConcFlags.ctxtSwitchTime /
1222             RtsFlags.MiscFlags.tickInterval;
1223     } else {
1224         RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
1225     }
1226
1227     if (RtsFlags.ProfFlags.profileInterval > 0) {
1228         RtsFlags.ProfFlags.profileIntervalTicks =
1229             RtsFlags.ProfFlags.profileInterval / 
1230             RtsFlags.MiscFlags.tickInterval;
1231     } else {
1232         RtsFlags.ProfFlags.profileIntervalTicks = 0;
1233     }
1234
1235     if (RtsFlags.GcFlags.stkChunkBufferSize >
1236         RtsFlags.GcFlags.stkChunkSize / 2) {
1237         errorBelch("stack chunk buffer size (-kb) must be less than 50%% of the stack chunk size (-kc)");
1238         error = rtsTrue;
1239     }
1240
1241     if (error) {
1242         const char **p;
1243
1244         fflush(stdout);
1245         for (p = usage_text; *p; p++)
1246             errorBelch("%s", *p);
1247         stg_exit(EXIT_FAILURE);
1248     }
1249 }
1250
1251
1252 static void
1253 stats_fprintf(FILE *f, char *s, ...)
1254 {
1255     va_list ap;
1256     va_start(ap,s);
1257     if (f == NULL) {
1258         vdebugBelch(s, ap);
1259     } else {
1260         vfprintf(f, s, ap);
1261     }
1262     va_end(ap);
1263 }
1264
1265 static int              /* return -1 on error */
1266 open_stats_file (
1267     I_ arg,
1268     int argc, char *argv[],
1269     int rts_argc, char *rts_argv[],
1270     const char *FILENAME_FMT,
1271     FILE **file_ret)
1272 {
1273     FILE *f = NULL;
1274
1275     if (strequal(rts_argv[arg]+2, "stderr")
1276         || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) {
1277         f = NULL; /* NULL means use debugBelch */
1278     } else {
1279         if (rts_argv[arg][2] != '\0') {  /* stats file specified */
1280             f = fopen(rts_argv[arg]+2,"w");
1281         } else {
1282             char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
1283             sprintf(stats_filename, FILENAME_FMT, argv[0]);
1284             f = fopen(stats_filename,"w");
1285         }
1286         if (f == NULL) {
1287             errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
1288             return -1;
1289         }
1290     }
1291     *file_ret = f;
1292
1293     {
1294         /* Write argv and rtsv into start of stats file */
1295         int count;
1296         for(count = 0; count < argc; count++) {
1297             stats_fprintf(f, "%s ", argv[count]);
1298         }
1299         stats_fprintf(f, "+RTS ");
1300         for(count = 0; count < rts_argc; count++)
1301             stats_fprintf(f, "%s ", rts_argv[count]);
1302         stats_fprintf(f, "\n");
1303     }
1304     return 0;
1305 }
1306
1307
1308
1309 static StgWord64
1310 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
1311 {
1312     char c;
1313     const char *s;
1314     StgDouble m;
1315     StgWord64 val;
1316
1317     s = flag + offset;
1318
1319     if (!*s)
1320     {
1321         m = 0;
1322     }
1323     else
1324     {
1325         m = atof(s);
1326         c = s[strlen(s)-1];
1327
1328         if (c == 'g' || c == 'G') 
1329             m *= 1024*1024*1024;
1330         else if (c == 'm' || c == 'M')
1331             m *= 1024*1024;
1332         else if (c == 'k' || c == 'K')
1333             m *= 1024;
1334         else if (c == 'w' || c == 'W')
1335             m *= sizeof(W_);
1336     }
1337
1338     val = (StgWord64)m;
1339
1340     if (m < 0 || val < min || val > max) {
1341         // printf doesn't like 64-bit format specs on Windows
1342         // apparently, so fall back to unsigned long.
1343         errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
1344         stg_exit(EXIT_FAILURE);
1345     }
1346
1347     return val;
1348 }
1349
1350 #if defined(TRACING)
1351 static void read_trace_flags(char *arg)
1352 {
1353     char *c;
1354
1355     for (c  = arg; *c != '\0'; c++) {
1356         switch(*c) {
1357         case '\0':
1358             break;
1359         case 's':
1360             RtsFlags.TraceFlags.scheduler = rtsTrue;
1361             break;
1362         case 't':
1363             RtsFlags.TraceFlags.timestamp = rtsTrue;
1364             break;
1365         case 'g':
1366             // ignored for backwards-compat
1367             break;
1368         default:
1369             errorBelch("unknown trace option: %c",*c);
1370             break;
1371         }
1372     }
1373 }
1374 #endif
1375
1376 static void GNU_ATTRIBUTE(__noreturn__)
1377 bad_option(const char *s)
1378 {
1379   errorBelch("bad RTS option: %s", s);
1380   stg_exit(EXIT_FAILURE);
1381 }
1382
1383 /* -----------------------------------------------------------------------------
1384    Getting/Setting the program's arguments.
1385
1386    These are used by System.Environment, and parts of the RTS.
1387    -------------------------------------------------------------------------- */
1388
1389 void
1390 setProgName(char *argv[])
1391 {
1392     /* Remove directory from argv[0] -- default files in current directory */
1393 #if !defined(mingw32_HOST_OS)
1394     char *last_slash;
1395     if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) {
1396         prog_name = last_slash+1;
1397    } else {
1398         prog_name = argv[0];
1399    }
1400 #else
1401     char* last_slash = argv[0] + (strlen(argv[0]) - 1);
1402     while ( last_slash > argv[0] ) {
1403         if ( *last_slash == '/' || *last_slash == '\\' ) {
1404             prog_name = last_slash+1;
1405             return;
1406         }
1407         last_slash--;
1408     }
1409     prog_name = argv[0];
1410 #endif
1411 }
1412
1413 void
1414 getProgArgv(int *argc, char **argv[])
1415 {
1416     if (argc) { *argc = prog_argc; }
1417     if (argv) { *argv = prog_argv; }
1418 }
1419
1420 void
1421 setProgArgv(int argc, char *argv[])
1422 {
1423    /* Usually this is done by startupHaskell, so we don't need to call this. 
1424       However, sometimes Hugs wants to change the arguments which Haskell
1425       getArgs >>= ... will be fed.  So you can do that by calling here
1426       _after_ calling startupHaskell.
1427    */
1428    prog_argc = argc;
1429    prog_argv = argv;
1430    setProgName(prog_argv);
1431 }
1432
1433 /* These functions record and recall the full arguments, including the
1434    +RTS ... -RTS options. The reason for adding them was so that the
1435    ghc-inplace program can pass /all/ the arguments on to the real ghc. */
1436 void
1437 getFullProgArgv(int *argc, char **argv[])
1438 {
1439     if (argc) { *argc = full_prog_argc; }
1440     if (argv) { *argv = full_prog_argv; }
1441 }
1442
1443 void
1444 setFullProgArgv(int argc, char *argv[])
1445 {
1446     int i;
1447     full_prog_argc = argc;
1448     full_prog_argv = stgCallocBytes(argc + 1, sizeof (char *),
1449                                     "setFullProgArgv 1");
1450     for (i = 0; i < argc; i++) {
1451         full_prog_argv[i] = stgMallocBytes(strlen(argv[i]) + 1,
1452                                            "setFullProgArgv 2");
1453         strcpy(full_prog_argv[i], argv[i]);
1454     }
1455     full_prog_argv[argc] = NULL;
1456 }
1457
1458 void
1459 freeFullProgArgv (void)
1460 {
1461     int i;
1462
1463     if (full_prog_argv != NULL) {
1464         for (i = 0; i < full_prog_argc; i++) {
1465             stgFree(full_prog_argv[i]);
1466         }
1467         stgFree(full_prog_argv);
1468     }
1469
1470     full_prog_argc = 0;
1471     full_prog_argv = NULL;
1472 }