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