RtsFlags.c 71.1 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2
3
 *
 * (c) The AQUA Project, Glasgow University, 1994-1997
Simon Marlow's avatar
Simon Marlow committed
4
 * (c) The GHC Team, 1998-2006
5
6
7
8
9
 *
 * Functions for parsing the argument list.
 *
 * ---------------------------------------------------------------------------*/

10
#include "PosixSource.h"
11
12
13
#include "Rts.h"
#include "RtsFlags.h"
#include "RtsUtils.h"
14
#include "Profiling.h"
15

16
17
#ifdef HAVE_CTYPE_H
#include <ctype.h>
18
19
#endif

20
21
22
#include <stdlib.h>
#include <string.h>

23
24
// Flag Structure
RTS_FLAGS RtsFlags;
25
26
27
28

/*
 * Split argument lists
 */
sof's avatar
sof committed
29
int     prog_argc = 0;    /* an "int" so as to match normal "argc" */
30
char  **prog_argv = NULL;
sof's avatar
sof committed
31
char   *prog_name = NULL; /* 'basename' of prog_argv[0] */
32
int     rts_argc = 0;  /* ditto */
33
34
35
36
37
38
39
40
char   *rts_argv[MAX_RTS_ARGS];

/*
 * constants, used later 
 */
#define RTS 1
#define PGM 0

41
42
#if defined(GRAN)

sof's avatar
sof committed
43
static char *gran_debug_opts_strs[] = {
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
  "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
  "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
  "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
  "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
  "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
  "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
  "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
  "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
  "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
  "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
  "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
  "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
  "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
  "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
};

/* one character codes for the available debug options */
sof's avatar
sof committed
62
static char gran_debug_opts_flags[] = {
63
64
65
66
67
  'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
};

#elif defined(PAR)

sof's avatar
sof committed
68
static char *par_debug_opts_strs[] = {
69
  "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
70
  "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
71
72
73
  "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
  "DEBUG (-qDe, -qD8): free; free messages.\n",
  "DEBUG (-qDr, -qD16): resume; resume messages.\n",
74
  "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
75
  "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
76
77
78
79
80
  // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
  "DEBUG (-qDf, -qD128): fish; fish messages.\n",
  //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
  "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
  "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
81
82
  "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
  "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
83
84
85
};

/* one character codes for the available debug options */
sof's avatar
sof committed
86
static char par_debug_opts_flags[] = {
87
  'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
88
89
90
91
};

#endif /* PAR */

92
93
94
95
/* -----------------------------------------------------------------------------
   Static function decls
   -------------------------------------------------------------------------- */

96
static int		/* return NULL on error */
97
98
99
100
open_stats_file (
    I_ arg,
    int argc, char *argv[],
    int rts_argc, char *rts_argv[],
101
102
    const char *FILENAME_FMT,
    FILE **file_ret);
103
104
105
106

static I_ decode(const char *s);
static void bad_option(const char *s);

107
108
109
110
111
112
113
114
115
116
117
#if defined(GRAN)
static void enable_GranSimLight(void);
static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
static void set_GranSim_debug_options(nat n);
static void help_GranSim_debug_options(nat n);
#elif defined(PAR)
static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
static void set_par_debug_options(nat n);
static void help_par_debug_options(nat n);
#endif

118
119
120
121
122
123
124
125
126
/* -----------------------------------------------------------------------------
 * Command-line option parsing routines.
 * ---------------------------------------------------------------------------*/

void initRtsFlagsDefaults(void)
{
    RtsFlags.GcFlags.statsFile		= NULL;
    RtsFlags.GcFlags.giveStats		= NO_GC_STATS;

127
    RtsFlags.GcFlags.maxStkSize		= (8 * 1024 * 1024) / sizeof(W_);
128
129
    RtsFlags.GcFlags.initialStkSize	= 1024 / sizeof(W_);

130
    RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
131
    RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
132
    RtsFlags.GcFlags.maxHeapSize	= 0;    /* off by default */
133
    RtsFlags.GcFlags.heapSizeSuggestion	= 0;    /* none */
134
    RtsFlags.GcFlags.pcFreeHeap		= 3;	/* 3% */
135
    RtsFlags.GcFlags.oldGenFactor       = 2;
136
137
138
139
140
141
#if defined(PAR)
    /* A hack currently needed for GUM -- HWL */
    RtsFlags.GcFlags.generations        = 1;
    RtsFlags.GcFlags.steps              = 2;
    RtsFlags.GcFlags.squeezeUpdFrames	= rtsFalse;
#else
142
    RtsFlags.GcFlags.generations        = 2;
143
    RtsFlags.GcFlags.steps              = 2;
144
    RtsFlags.GcFlags.squeezeUpdFrames	= rtsTrue;
145
#endif
146
    RtsFlags.GcFlags.compact            = rtsFalse;
147
    RtsFlags.GcFlags.compactThreshold   = 30.0;
148
149
150
#ifdef RTS_GTK_FRONTPANEL
    RtsFlags.GcFlags.frontpanel         = rtsFalse;
#endif
151
    RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
152

153
154
#ifdef DEBUG
    RtsFlags.DebugFlags.scheduler	= rtsFalse;
155
    RtsFlags.DebugFlags.interpreter	= rtsFalse;
156
157
158
159
160
161
    RtsFlags.DebugFlags.weak		= rtsFalse;
    RtsFlags.DebugFlags.gccafs		= rtsFalse;
    RtsFlags.DebugFlags.gc		= rtsFalse;
    RtsFlags.DebugFlags.block_alloc	= rtsFalse;
    RtsFlags.DebugFlags.sanity		= rtsFalse;
    RtsFlags.DebugFlags.stable		= rtsFalse;
162
    RtsFlags.DebugFlags.stm             = rtsFalse;
163
164
165
166
    RtsFlags.DebugFlags.prof		= rtsFalse;
    RtsFlags.DebugFlags.gran		= rtsFalse;
    RtsFlags.DebugFlags.par		= rtsFalse;
    RtsFlags.DebugFlags.linker		= rtsFalse;
167
    RtsFlags.DebugFlags.squeeze		= rtsFalse;
168
169
#endif

170
171
172
173
174
#if defined(PROFILING) || defined(PAR)
    RtsFlags.CcFlags.doCostCentres	= 0;
#endif /* PROFILING or PAR */

#ifdef PROFILING
175
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
176
    RtsFlags.ProfFlags.profileInterval    = 100;
177
    RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
178
    RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
179
    RtsFlags.ProfFlags.maxRetainerSetSize = 8;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
180
    RtsFlags.ProfFlags.ccsLength          = 25;
181
182
183
184
    RtsFlags.ProfFlags.modSelector        = NULL;
    RtsFlags.ProfFlags.descrSelector      = NULL;
    RtsFlags.ProfFlags.typeSelector       = NULL;
    RtsFlags.ProfFlags.ccSelector         = NULL;
185
    RtsFlags.ProfFlags.ccsSelector        = NULL;
186
187
    RtsFlags.ProfFlags.retainerSelector   = NULL;
    RtsFlags.ProfFlags.bioSelector        = NULL;
188

189
#elif defined(DEBUG)
190
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
191
192
#endif

193
194
    RtsFlags.MiscFlags.tickInterval	= 50;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 50;  /* In milliseconds */
195

196
#ifdef THREADED_RTS
197
    RtsFlags.ParFlags.nNodes	        = 1;
198
199
    RtsFlags.ParFlags.migrate           = rtsTrue;
    RtsFlags.ParFlags.wakeupMigrate     = rtsFalse;
200
#endif
201

202
#ifdef PAR
203
    RtsFlags.ParFlags.ParStats.Full   	  = rtsFalse;
204
    RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
205
206
207
208
209
210
    RtsFlags.ParFlags.ParStats.Binary 	  = rtsFalse;
    RtsFlags.ParFlags.ParStats.Sparks 	  = rtsFalse;
    RtsFlags.ParFlags.ParStats.Heap   	  = rtsFalse;
    RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
    RtsFlags.ParFlags.ParStats.Global     = rtsFalse;

211
    RtsFlags.ParFlags.outputDisabled	= rtsFalse;
212
213
214
215
216
#ifdef DIST
    RtsFlags.ParFlags.doFairScheduling  = rtsTrue;  /* fair sched by def */
#else
    RtsFlags.ParFlags.doFairScheduling  = rtsFalse;  /* unfair sched by def */
#endif
217
    RtsFlags.ParFlags.packBufferSize	= 1024;
218
219
    RtsFlags.ParFlags.thunksToPack      = 1; /* 0 ... infinity; */
    RtsFlags.ParFlags.globalising       = 1; /* 0 ... everything */
220
221
222
    RtsFlags.ParFlags.maxThreads        = 1024;
    RtsFlags.ParFlags.maxFishes        = MAX_FISHES;
    RtsFlags.ParFlags.fishDelay         = FISH_DELAY;
223
224
#endif

225
#if defined(PAR) || defined(THREADED_RTS)
226
    RtsFlags.ParFlags.maxLocalSparks	= 4096;
227
#endif /* PAR || THREADED_RTS */
228
229
230

#if defined(GRAN)
    /* ToDo: check defaults for GranSim and GUM */
231
    RtsFlags.GcFlags.maxStkSize		= (8 * 1024 * 1024) / sizeof(W_);
232
233
    RtsFlags.GcFlags.initialStkSize	= 1024 / sizeof(W_);

234
    RtsFlags.GranFlags.maxThreads	= 65536; // refers to mandatory threads
235
236
237
238
239
240
241
    RtsFlags.GranFlags.GranSimStats.Full	= rtsFalse;
    RtsFlags.GranFlags.GranSimStats.Suppressed	= rtsFalse;
    RtsFlags.GranFlags.GranSimStats.Binary      = rtsFalse;
    RtsFlags.GranFlags.GranSimStats.Sparks      = rtsFalse;
    RtsFlags.GranFlags.GranSimStats.Heap        = rtsFalse;
    RtsFlags.GranFlags.GranSimStats.NewLogfile  = rtsFalse;
    RtsFlags.GranFlags.GranSimStats.Global      = rtsFalse;
242
243
244
245

    RtsFlags.GranFlags.packBufferSize	= 1024;
    RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
    RtsFlags.GranFlags.proc         = MAX_PROC;
    RtsFlags.GranFlags.Fishing      = rtsFalse;
    RtsFlags.GranFlags.maxFishes   = MAX_FISHES;
    RtsFlags.GranFlags.time_slice   = GRAN_TIME_SLICE;
    RtsFlags.GranFlags.Light        = rtsFalse;

    RtsFlags.GranFlags.Costs.latency =             LATENCY;          
    RtsFlags.GranFlags.Costs.additional_latency =  ADDITIONAL_LATENCY; 
    RtsFlags.GranFlags.Costs.fetchtime =           FETCHTIME; 
    RtsFlags.GranFlags.Costs.lunblocktime =        LOCALUNBLOCKTIME; 
    RtsFlags.GranFlags.Costs.gunblocktime =        GLOBALUNBLOCKTIME;
    RtsFlags.GranFlags.Costs.mpacktime =           MSGPACKTIME;      
    RtsFlags.GranFlags.Costs.munpacktime =         MSGUNPACKTIME;
    RtsFlags.GranFlags.Costs.mtidytime =           MSGTIDYTIME;

    RtsFlags.GranFlags.Costs.threadcreatetime =         THREADCREATETIME;
    RtsFlags.GranFlags.Costs.threadqueuetime =          THREADQUEUETIME;
    RtsFlags.GranFlags.Costs.threaddescheduletime =     THREADDESCHEDULETIME;
    RtsFlags.GranFlags.Costs.threadscheduletime =       THREADSCHEDULETIME;
    RtsFlags.GranFlags.Costs.threadcontextswitchtime =  THREADCONTEXTSWITCHTIME;

    RtsFlags.GranFlags.Costs.arith_cost =         ARITH_COST;       
    RtsFlags.GranFlags.Costs.branch_cost =        BRANCH_COST; 
    RtsFlags.GranFlags.Costs.load_cost =          LOAD_COST;        
    RtsFlags.GranFlags.Costs.store_cost =         STORE_COST; 
    RtsFlags.GranFlags.Costs.float_cost =         FLOAT_COST;       

    RtsFlags.GranFlags.Costs.heapalloc_cost =     HEAPALLOC_COST;

    RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;        
    RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;        

    RtsFlags.GranFlags.DoFairSchedule           = rtsFalse;             
    RtsFlags.GranFlags.DoAsyncFetch             = rtsFalse;        
    RtsFlags.GranFlags.DoStealThreadsFirst      = rtsFalse;        
    RtsFlags.GranFlags.DoAlwaysCreateThreads    = rtsFalse;      
    RtsFlags.GranFlags.DoBulkFetching           = rtsFalse;             
    RtsFlags.GranFlags.DoThreadMigration        = rtsFalse;          
    RtsFlags.GranFlags.FetchStrategy            = 2;                     
285
    RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;   
286
287
288
289
290
291
292
293
294
    RtsFlags.GranFlags.DoPrioritySparking       = rtsFalse;         
    RtsFlags.GranFlags.DoPriorityScheduling     = rtsFalse;       
    RtsFlags.GranFlags.SparkPriority            = 0;
    RtsFlags.GranFlags.SparkPriority2           = 0; 
    RtsFlags.GranFlags.RandomPriorities         = rtsFalse;           
    RtsFlags.GranFlags.InversePriorities        = rtsFalse;          
    RtsFlags.GranFlags.IgnorePriorities         = rtsFalse;           
    RtsFlags.GranFlags.ThunksToPack             = 0;                      
    RtsFlags.GranFlags.RandomSteal              = rtsTrue;
295
296
297
#endif

#ifdef TICKY_TICKY
298
299
    RtsFlags.TickyFlags.showTickyStats	 = rtsFalse;
    RtsFlags.TickyFlags.tickyFile	 = NULL;
300
#endif
Simon Marlow's avatar
Simon Marlow committed
301
302
303

    RtsFlags.TraceFlags.timestamp	= rtsFalse;
    RtsFlags.TraceFlags.sched 		= rtsFalse;
304
305
306
307

#ifdef USE_PAPI
    RtsFlags.PapiFlags.eventType        = PAPI_FLAG_BRANCH;
#endif
308
309
310
311
312
313
314
315
316
317
318
319
320
321
}

static const char *
usage_text[] = {
"",
"Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
"",
"   +RTS    Indicates run time system options follow",
"   -RTS    Indicates program arguments follow",
"  --RTS    Indicates that ALL subsequent arguments will be given to the",
"           program (including any of these RTS flags)",
"",
"The following run time system options are available:",
"",
322
"  -?       Prints this message and exits; the program is not executed",
323
"",
324
"  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
sof's avatar
sof committed
325
"  -k<size> Sets the initial thread stack size (default 1k)  Egs: -k4k   -k2m",
326
327
"",
"  -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
328
"  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
329
"  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
330
"  -m<n>    Minimum % of heap which must be available (default 3%)",
331
"  -G<n>    Number of generations (default: 2)",
332
"  -T<n>    Number of steps in younger generations (default: 2)",
333
334
"  -c<n>    Auto-enable compaction of the oldest generation when live data is",
"           at least <n>% of the maximum heap size set with -M (default: 30%)",
335
"  -c       Enable compaction for all major collections",
336
#if defined(THREADED_RTS)
337
338
"  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
#endif
339
340
341
342
"",
"  -t<file> One-line GC statistics  (default file: <program>.stat)",
"  -s<file> Summary  GC statistics  (with -Sstderr going to stderr)",
"  -S<file> Detailed GC statistics",
343
344
345
#ifdef RTS_GTK_FRONTPANEL
"  -f       Display front panel (requires X11 & GTK+)",
#endif
346
347
348
349
350
351
"",
"",
"  -Z       Don't squeeze out update frames on stack overflow",
"  -B       Sound the bell at the start of each garbage collection",
#if defined(PROFILING) || defined(PAR)
"",
352
"  -px      Time/allocation profile (XML)  (output file <program>.prof)",
andy's avatar
andy committed
353
354
355
"  -p       Time/allocation profile        (output file <program>.prof)",
"  -P       More detailed Time/Allocation profile",
"  -Pa      Give information about *all* cost centres",
356

357
358
# if defined(PROFILING)
"",
359
360
361
362
363
364
365
366
"  -hx            Heap residency profile (XML)   (output file <program>.prof)",
"  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
"     break-down: c = cost centre stack (default)",
"                 m = module",
"                 d = closure description",
"                 y = type description",
"                 r = retainer",
"                 b = biography (LAG,DRAG,VOID,USE)",
367
"  A subset of closures may be selected thusly:",
368
369
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
370
371
372
373
374
"    -hm<mod>...  all cost centres from the specified modules(s)",
"    -hd<des>,... closures with specified closure descriptions",
"    -hy<typ>...  closures with specified type descriptions",
"    -hr<cc>...   closures with specified retainers",
"    -hb<bio>...  closures with specified biographies (lag,drag,void,use)",
375
376
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
377
378
379
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
380
"",
381
"  -i<sec>        Time between heap samples (seconds, default: 0.1)",
andy's avatar
andy committed
382
"",
383
384
"  -xt            Include threads (TSOs) in a heap profile",
"",
385
"  -xc      Show current cost centre stack on raising an exception",
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# endif
#endif /* PROFILING or PAR */
#if !defined(PROFILING) && defined(DEBUG)
"",
"  -h<break-down> Debugging Heap residency profile",
"                 (output file <program>.hp)",
"     break-down: L = closure label (default)",
"                 T = closure type (constructor, thunk etc.)",
#endif
"",
#if defined(TICKY_TICKY)
"  -r<file>  Produce reduction profiling statistics (with -rstderr for stderr)",
"",
#endif
400
#if defined(PAR)
401
402
"  -N<n>     Use <n> PVMish processors in parallel (default: 2)",
/* NB: the -N<n> is implemented by the driver!! */
403
#endif
404
405
406
407
408
409
"  -C<secs>  Context-switch interval in seconds.",
"            0 or no argument means switch as often as possible.",
"            Default: 0.02 sec; resolution is set by -V below.",
"  -V<secs>  Master tick interval in seconds.",
"            This sets the resolution for -C and the profile timer -i.",
"            Default: 0.02 sec.",
410
"",
Simon Marlow's avatar
Simon Marlow committed
411
412
413
"  -vs       Trace scheduler events (see also -Ds with -debug)",
"  -vt       Time-stamp trace messages",
"",
414
415
#if defined(DEBUG)
"  -Ds  DEBUG: scheduler",
416
"  -Di  DEBUG: interpreter",
417
418
419
420
421
422
423
424
425
426
"  -Dw  DEBUG: weak",
"  -DG  DEBUG: gccafs",
"  -Dg  DEBUG: gc",
"  -Db  DEBUG: block",
"  -DS  DEBUG: sanity",
"  -Dt  DEBUG: stable",
"  -Dp  DEBUG: prof",
"  -Dr  DEBUG: gran",
"  -DP  DEBUG: par",
"  -Dl  DEBUG: linker",
427
"  -Dm  DEBUG: stm",
428
"  -Dz  DEBUG: stack squezing",
429
"",
430
#endif /* DEBUG */
431
#if defined(THREADED_RTS) && !defined(NOSMP)
432
"  -N<n>     Use <n> OS threads (default: 1)",
433
434
"  -qm       Don't automatically migrate threads between CPUs",
"  -qw       Migrate a thread to the current CPU when it is woken up",
435
#endif
436
#if defined(THREADED_RTS) || defined(PAR)
437
438
439
"  -e<size>  Size of spark pools (default 100)",
#endif
#if defined(PAR)
440
441
442
443
444
"  -t<num>   Set maximum number of advisory threads per PE (default 32)",
"  -qP       Enable activity profile (output files in ~/<program>*.gr)",
"  -qQ<size> Set pack-buffer size (default: 1024)",
"  -qd       Turn on PVM-ish debugging",
"  -qO       Disable output for performance measurement",
445
#endif
446
#if defined(THREADED_RTS) || defined(PAR)
447
448
"  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
#endif
449
#if defined(PAR)
450
451
"  -d        Turn on PVM-ish debugging",
"  -O        Disable output for performance measurement",
452
453
#endif /* PAR */
#if defined(GRAN)  /* ToDo: fill in decent Docu here */
454
"  -b...     All GranSim options start with -b; see GranSim User's Guide for details",
455
#endif
456
457
458
459
460
461
462
463
464
465
#if defined(USE_PAPI)
"  -aX       Perform measurements using PAPI, it should be used with the -s<file> option.",
"            Where X is one of:",
"",
/* "            y - cycles", */
"            1 - level 1 cache misses",
"            2 - level 2 cache misses",
"            b - branch mispredictions",
"            s - stalled cycles",
#endif
466
"",
467
468
"RTS options may also be specified using the GHCRTS environment variable.",
"",
469
470
471
472
473
474
"Other RTS options may be available for programs compiled a different way.",
"The GHC User's Guide has full details.",
"",
0
};

sof's avatar
sof committed
475
STATIC_INLINE rtsBool
476
477
478
479
480
strequal(const char *a, const char * b)
{
    return(strcmp(a, b) == 0);
}

481
482
483
484
485
486
487
488
489
490
491
492
493
494
static void
splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
{
    char *c1, *c2;

    c1 = s;
    do {
	while (isspace(*c1)) { c1++; };
	c2 = c1;
	while (!isspace(*c2) && *c2 != '\0') { c2++; };
	
	if (c1 == c2) { break; }
	
	if (*rts_argc < MAX_RTS_ARGS-1) {
sof's avatar
sof committed
495
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
496
497
498
499
500
501
502
503
504
505
506
	    strncpy(s, c1, c2-c1);
	    s[c2-c1] = '\0';
	    rts_argv[(*rts_argc)++] = s;
	} else {
	    barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
	}
	
	c1 = c2;
    } while (*c1 != '\0');
}
    
507
508
509
510
511
512
513
void
setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
{
    rtsBool error = rtsFalse;
    I_ mode;
    I_ arg, total_arg;

514
    setProgName (argv);
515
516
517
518
519
520
    total_arg = *argc;
    arg = 1;

    *argc = 1;
    *rts_argc = 0;

521
522
523
524
525
526
527
528
529
    // process arguments from the ghc_rts_opts global variable first.
    // (arguments from the GHCRTS environment variable and the command
    // line override these).
    {
	if (ghc_rts_opts != NULL) {
	    splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
	}
    }

530
    // process arguments from the GHCRTS environment variable next
531
    // (arguments from the command line override these).
532
533
534
535
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
536
	    splitRtsFlags(ghc_rts, rts_argc, rts_argv);
537
538
	}
    }
539

540
541
542
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

543
544
545
546
547
548
549
550
551
552
553
554
    for (mode = PGM; arg < total_arg; arg++) {
	// The '--RTS' argument disables all future +RTS ... -RTS processing.
	if (strequal("--RTS", argv[arg])) {
	    arg++;
	    break;
	}
	// The '--' argument is passed through to the program, but
	// disables all further +RTS ... -RTS processing.
	else if (strequal("--", argv[arg])) {
	    break;
	}
	else if (strequal("+RTS", argv[arg])) {
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
	    mode = RTS;
	}
	else if (strequal("-RTS", argv[arg])) {
	    mode = PGM;
	}
	else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
	    rts_argv[(*rts_argc)++] = argv[arg];
	}
	else if (mode == PGM) {
	    argv[(*argc)++] = argv[arg];
	}
	else {
	  barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
	}
    }
570
571
572
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
573
574
575
576
577
    }
    argv[*argc] = (char *) 0;
    rts_argv[*rts_argc] = (char *) 0;

    // Process RTS (rts_argv) part: mainly to determine statsfile
578
579
580
    for (arg = 0; arg < *rts_argc; arg++) {
	if (rts_argv[arg][0] != '-') {
	    fflush(stdout);
581
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
582
583
584
585
586
587
588
589
590
591
	    error = rtsTrue;

        } else {
	    switch(rts_argv[arg][1]) {

	      /* process: general args, then PROFILING-only ones,
		 then CONCURRENT-only, PARallel-only, GRAN-only,
		 TICKY-only (same order as defined in RtsFlags.lh);
		 within those groups, mostly in case-insensitive
		 alphabetical order.
592
                 Final group is x*, which allows for more options.
593
594
595
596
597
598
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
599
errorBelch("not built for: ticky-ticky stats"); \
600
601
602
603
604
605
606
error = rtsTrue;
#endif

#if defined(PROFILING) 
# define COST_CENTRE_USING_BUILD_ONLY(x) x
#else
# define COST_CENTRE_USING_BUILD_ONLY(x) \
607
errorBelch("not built for: -prof or -parallel"); \
608
609
610
611
612
613
614
error = rtsTrue;
#endif

#ifdef PROFILING
# define PROFILING_BUILD_ONLY(x)   x
#else
# define PROFILING_BUILD_ONLY(x) \
615
errorBelch("not built for: -prof"); \
616
617
618
error = rtsTrue;
#endif

619
620
621
622
#ifdef PAR
# define PAR_BUILD_ONLY(x)      x
#else
# define PAR_BUILD_ONLY(x) \
623
errorBelch("not built for: -parallel"); \
624
625
626
error = rtsTrue;
#endif

627
628
629
630
631
632
633
634
635
636
#ifdef THREADED_RTS
# define THREADED_BUILD_ONLY(x)      x
#else
# define THREADED_BUILD_ONLY(x) \
errorBelch("not built for: -smp"); \
error = rtsTrue;
#endif

#if defined(THREADED_RTS) || defined(PAR)
# define PAR_OR_THREADED_BUILD_ONLY(x)      x
637
#else
638
# define PAR_OR_THREADED_BUILD_ONLY(x) \
639
errorBelch("not built for: -parallel or -smp"); \
640
641
642
643
644
645
646
error = rtsTrue;
#endif

#ifdef GRAN
# define GRAN_BUILD_ONLY(x)     x
#else
# define GRAN_BUILD_ONLY(x) \
647
errorBelch("not built for: -gransim"); \
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
error = rtsTrue;
#endif

	      /* =========== GENERAL ========================== */
	      case '?':
		error = rtsTrue;
		break;

	      case 'A':
		RtsFlags.GcFlags.minAllocAreaSize
		  = decode(rts_argv[arg]+2) / BLOCK_SIZE;
		if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
		  bad_option(rts_argv[arg]);
		}
		break;

664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
#ifdef USE_PAPI
	      case 'a':
		switch(rts_argv[arg][2]) {
		case '1':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L1;
		  break;
		case '2':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CACHE_L2;
		  break;
		case 'b':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_BRANCH;
		  break;
		case 's':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_STALLS;
		  break;
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

685
686
687
688
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

689
	      case 'c':
690
691
692
693
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
694
		      RtsFlags.GcFlags.compact = rtsTrue;
695
696
		  }
		  break;
697

698
699
700
701
702
703
704
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
705
706
#ifdef DEBUG
	      case 'D':
707
708
709
710
711
712
713
714
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
715
716
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
			  break;
		      case 'w':
			  RtsFlags.DebugFlags.weak = rtsTrue;
			  break;
		      case 'G':
			  RtsFlags.DebugFlags.gccafs = rtsTrue;
			  break;
		      case 'g':
			  RtsFlags.DebugFlags.gc = rtsTrue;
			  break;
		      case 'b':
			  RtsFlags.DebugFlags.block_alloc = rtsTrue;
			  break;
		      case 'S':
			  RtsFlags.DebugFlags.sanity = rtsTrue;
			  break;
		      case 't':
			  RtsFlags.DebugFlags.stable = rtsTrue;
			  break;
		      case 'p':
			  RtsFlags.DebugFlags.prof = rtsTrue;
			  break;
		      case 'r':
			  RtsFlags.DebugFlags.gran = rtsTrue;
			  break;
		      case 'P':
			  RtsFlags.DebugFlags.par = rtsTrue;
			  break;
		      case 'l':
			  RtsFlags.DebugFlags.linker = rtsTrue;
			  break;
748
749
750
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
751
752
753
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
754
755
756
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
757
758
759
760
761
762
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
		  break;
	      }
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
#endif

	      case 'K':
		RtsFlags.GcFlags.maxStkSize = 
		  decode(rts_argv[arg]+2) / sizeof(W_);

		if (RtsFlags.GcFlags.maxStkSize == 0) 
		  bad_option( rts_argv[arg] );
		break;

	      case 'k':
		RtsFlags.GcFlags.initialStkSize = 
		  decode(rts_argv[arg]+2) / sizeof(W_);

		if (RtsFlags.GcFlags.initialStkSize == 0) 
		  bad_option( rts_argv[arg] );
		break;

	      case 'M':
		RtsFlags.GcFlags.maxHeapSize = 
		  decode(rts_argv[arg]+2) / BLOCK_SIZE;
		/* user give size in *bytes* but "maxHeapSize" is in *blocks* */

		if (RtsFlags.GcFlags.maxHeapSize <= 0) {
		  bad_option(rts_argv[arg]);
		}
		break;

	      case 'm':
		RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);

		if (RtsFlags.GcFlags.pcFreeHeap < 0 || 
		    RtsFlags.GcFlags.pcFreeHeap > 100)
		  bad_option( rts_argv[arg] );
		break;

799
800
	      case 'G':
		RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
801
		if (RtsFlags.GcFlags.generations < 1) {
802
803
804
805
		  bad_option(rts_argv[arg]);
		}
		break;

806
807
808
809
810
811
812
	      case 'T':
		RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
		if (RtsFlags.GcFlags.steps < 1) {
		  bad_option(rts_argv[arg]);
		}
		break;

813
	      case 'H':
814
815
816
817
818
819
		RtsFlags.GcFlags.heapSizeSuggestion = 
		  decode(rts_argv[arg]+2) / BLOCK_SIZE;

		if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
		  bad_option(rts_argv[arg]);
		}
820
821
		break;

822
823
824
825
826
827
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

828
829
830
831
832
833
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

834
		    /* Convert to millisecs */
835
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
836
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
837
838
839
		}
		break;

840
	      case 'S':
841
842
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
843

844
	      case 's':
845
846
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
847
848

	      case 't':
849
850
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
851

852
	    stats:
853
#ifdef PAR
854
855
		/* Opening all those files would almost certainly fail... */
		// RtsFlags.ParFlags.ParStats.Full = rtsTrue;
856
		RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
857
#else
858
859
860
861
862
863
864
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
					*rts_argc, rts_argv, STAT_FILENAME_FMT,
					&RtsFlags.GcFlags.statsFile);
		    if (r == -1) { error = rtsTrue; }
		}
865
#endif
866
		  break;
867
868
869
870
871
872
873
874
875
876
877

	      case 'Z':
		RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
		break;

	      /* =========== PROFILING ========================== */

	      case 'P': /* detailed cost centre profiling (time/alloc) */
	      case 'p': /* cost centre profiling (time/alloc) */
		COST_CENTRE_USING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
878
879
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
880
		    break;
andy's avatar
andy committed
881
882
883
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
884
		  default:
885
886
887
888
889
890
891
892
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
893
894
895
		}
		) break;

896
897
898
899
	      case 'R':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
  	          ) break;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
900
901
902
903
904
905
906
	      case 'L':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
                      if(RtsFlags.ProfFlags.ccsLength <= 0) {
			bad_option(rts_argv[arg]);
                      }
		  ) break;
907
908
909
910
911
912
913
914
915
916
917
	      case 'h': /* serial heap profile */
#if !defined(PROFILING) && defined(DEBUG)
		switch (rts_argv[arg][2]) {
		  case '\0':
		  case 'L':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
		    break;
		  case 'T':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
		    break;
		  default:
918
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
919
920
921
922
923
		    error = rtsTrue;
		}
#else
		PROFILING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
		case '\0':
		case 'C':
		case 'c':
		case 'M':
		case 'm':
		case 'D':
		case 'd':
		case 'Y':
		case 'y':
		case 'R':
		case 'r':
		case 'B':
		case 'b':
		    if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
			{
			    char *left  = strchr(rts_argv[arg], '{');
			    char *right = strrchr(rts_argv[arg], '}');
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957

			    // curly braces are optional, for
			    // backwards compat.
			    if (left)
				left = left+1;
			    else
				left = rts_argv[arg] + 3;

			    if (!right)
				right = rts_argv[arg] + strlen(rts_argv[arg]);

			    *right = '\0';

			    switch (rts_argv[arg][2]) {
			    case 'c': // cost centre label select
				RtsFlags.ProfFlags.ccSelector = left;
				break;
958
959
960
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
			    case 'M':
			    case 'm': // cost centre module select
				RtsFlags.ProfFlags.modSelector = left;
				break;
			    case 'D':
			    case 'd': // closure descr select 
				RtsFlags.ProfFlags.descrSelector = left;
				break;
			    case 'Y':
			    case 'y': // closure type select
				RtsFlags.ProfFlags.typeSelector = left;
				break;
			    case 'R':
			    case 'r': // retainer select
				RtsFlags.ProfFlags.retainerSelector = left;
				break;
			    case 'B':
			    case 'b': // biography select
				RtsFlags.ProfFlags.bioSelector = left;
				break;
981
982
983
984
			    }
			}
			break;
		    }
985

986
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
987
			errorBelch("multiple heap profile options");
988
989
990
991
992
993
994
995
996
997
998
999
			error = rtsTrue;
			break;
		    }

		    switch (rts_argv[arg][2]) {
		    case '\0':
		    case 'C':
		    case 'c':
			RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
			break;
		    case 'M':
		    case 'm':
1000
1001
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
1002
1003
		    case 'D':
		    case 'd':
1004
1005
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
			  break;
1006
1007
		    case 'Y':
		    case 'y':
1008
1009
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
			  break;
1010
1011
		    case 'R':
		    case 'r':
1012
1013
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
			  break;
1014
1015
		    case 'B':
		    case 'b':
1016
1017
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
			  break;
1018
1019
		    }
		    break;
1020
		      
1021
		default:
1022
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1023
1024
1025
		    error = rtsTrue;
		}
		) 
1026
#endif /* PROFILING */
andy's avatar
andy committed
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
    	    	break;

#if defined(PROFILING) 
    	      case 'i':	/* heap sample interval */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

		    /* Convert to milliseconds */
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1038
		    RtsFlags.ProfFlags.profileInterval = cst;
andy's avatar
andy committed
1039
1040
1041
		}
		break;
#endif
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055

	      /* =========== CONCURRENT ========================= */
    	      case 'C':	/* context switch interval */
		if (rts_argv[arg][2] == '\0')
    	    	    RtsFlags.ConcFlags.ctxtSwitchTime = 0;
		else {
		    I_ cst; /* tmp */

		    /* Convert to milliseconds */
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
		    RtsFlags.ConcFlags.ctxtSwitchTime = cst;
		}
    	    	break;

1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
              case 'V': /* master tick interval */
                if (rts_argv[arg][2] == '\0') {
                    // turns off ticks completely
                    RtsFlags.MiscFlags.tickInterval = 0;
                } else {
                    I_ cst; /* tmp */

                    /* Convert to milliseconds */
                    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
                    RtsFlags.MiscFlags.tickInterval = cst;
                }
                break;

1069
#if defined(THREADED_RTS) && !defined(NOSMP)
1070
	      case 'N':
1071
		THREADED_BUILD_ONLY(
1072
		if (rts_argv[arg][2] != '\0') {
1073
		    RtsFlags.ParFlags.nNodes
1074
		      = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1075
		    if (RtsFlags.ParFlags.nNodes <= 0) {
1076
		      errorBelch("bad value for -N");
1077
		      error = rtsTrue;
1078
1079
		    }
		}
1080
		) break;
1081

Simon Marlow's avatar
Simon Marlow committed
1082
	      case 'q':
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
		    switch (rts_argv[arg][2]) {
		    case '\0':
			errorBelch("incomplete RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
		    case 'm':
			RtsFlags.ParFlags.migrate = rtsFalse;
			break;
		    case 'w':
			RtsFlags.ParFlags.wakeupMigrate = rtsTrue;
			break;
		    default:
			errorBelch("unknown RTS option: %s",rts_argv[arg]);
			error = rtsTrue;
			break;
		    }
		    break;
1100
#endif
1101
1102
	      /* =========== PARALLEL =========================== */
	      case 'e':
1103
		PAR_OR_THREADED_BUILD_ONLY(
1104
		if (rts_argv[arg][2] != '\0') {
1105
1106
1107
		    RtsFlags.ParFlags.maxLocalSparks
		      = strtol(rts_argv[arg]+2, (char **) NULL, 10);
		    if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1108
		      errorBelch("bad value for -e");
1109
		      error = rtsTrue;
1110
1111
1112
1113
		    }
		}
		) break;

1114
#ifdef PAR
1115
    	      case 'q':
1116
		PAR_BUILD_ONLY(
1117
		  process_par_option(arg, rts_argc, rts_argv, &error);
1118
		) break;
1119
#endif
1120
1121
1122
1123
1124

	      /* =========== GRAN =============================== */

    	      case 'b':
		GRAN_BUILD_ONLY(
1125
		  process_gran_option(arg, rts_argc, rts_argv, &error);
1126
1127
1128
1129
1130
1131
1132
1133
1134
		) break;

	      /* =========== TICKY ============================== */

	      case 'r': /* Basic profiling stats */
		TICKY_BUILD_ONLY(

		RtsFlags.TickyFlags.showTickyStats = rtsTrue;

1135
1136
1137
1138
1139
1140
1141
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
					*rts_argc, rts_argv, TICKY_FILENAME_FMT,
					&RtsFlags.TickyFlags.tickyFile);
		    if (r == -1) { error = rtsTrue; }
		}
1142
1143
	        ) break;

Simon Marlow's avatar
Simon Marlow committed
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
	      /* =========== TRACING ---------=================== */

	      case 'v':
                switch(rts_argv[arg][2]) {
		case '\0':
		    errorBelch("incomplete RTS option: %s",rts_argv[arg]);
		    error = rtsTrue;
		    break;
		case 't':
		    RtsFlags.TraceFlags.timestamp = rtsTrue;
		    break;
		case 's':
		    RtsFlags.TraceFlags.sched = rtsTrue;
		    break;
		default:
		    errorBelch("unknown RTS option: %s",rts_argv[arg]);
		    error = rtsTrue;
		    break;
		}
                break;

1165
1166
1167
1168
1169
	      /* =========== EXTENDED OPTIONS =================== */

              case 'x': /* Extend the argument space */
                switch(rts_argv[arg][2]) {
                  case '\0':
1170
		    errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1171
1172
1173
1174
1175
		    error = rtsTrue;
		    break;

                  case 'c': /* Debugging tool: show current cost centre on an exception */
                    PROFILING_BUILD_ONLY(
1176
1177
1178
1179
1180
1181
1182
1183
1184
			RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
			);
		    break;

		case 't':  /* Include memory used by TSOs in a heap profile */
		    PROFILING_BUILD_ONLY(
			RtsFlags.ProfFlags.includeTSOs = rtsTrue;
			);
		    break;
1185
1186
1187
1188

                  /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */

	          default:
1189
		    errorBelch("unknown RTS option: %s",rts_argv[arg]);
1190
1191
1192
1193
1194
		    error = rtsTrue;
		    break;
                }
                break;  /* defensive programming */

1195
1196
	      /* =========== OH DEAR ============================ */
	      default:
1197
		errorBelch("unknown RTS option: %s",rts_argv[arg]);
1198
1199
1200
1201
1202
		error = rtsTrue;
		break;
	    }
	}
    }
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243

    // Determine what tick interval we should use for the RTS timer
    // by taking the shortest of the various intervals that we need to
    // monitor.
    if (RtsFlags.MiscFlags.tickInterval <= 0) {
        RtsFlags.MiscFlags.tickInterval = 50;
    }

    if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
        RtsFlags.MiscFlags.tickInterval =
            stg_min(RtsFlags.ConcFlags.ctxtSwitchTime,
                    RtsFlags.MiscFlags.tickInterval);
    }

    if (RtsFlags.GcFlags.idleGCDelayTime > 0) {
        RtsFlags.MiscFlags.tickInterval =
            stg_min(RtsFlags.GcFlags.idleGCDelayTime,
                    RtsFlags.MiscFlags.tickInterval);
    }

#ifdef PROFILING
    if (RtsFlags.ProfFlags.profileInterval > 0) {
        RtsFlags.MiscFlags.tickInterval =
            stg_min(RtsFlags.ProfFlags.profileInterval,
                    RtsFlags.MiscFlags.tickInterval);
    }
#endif

    if (RtsFlags.ConcFlags.ctxtSwitchTime > 0) {
        RtsFlags.ConcFlags.ctxtSwitchTicks =
            RtsFlags.ConcFlags.ctxtSwitchTime /
            RtsFlags.MiscFlags.tickInterval;
    } else {
        RtsFlags.ConcFlags.ctxtSwitchTicks = 0;
    }

#ifdef PROFILING
    RtsFlags.ProfFlags.profileIntervalTicks =
        RtsFlags.ProfFlags.profileInterval / RtsFlags.MiscFlags.tickInterval;
#endif

1244
1245
1246
1247
1248
    if (error) {
	const char **p;

        fflush(stdout);
	for (p = usage_text; *p; p++)
1249
	    errorBelch("%s", *p);
1250
1251
1252
1253
	stg_exit(EXIT_FAILURE);
    }
}

1254
1255
1256
1257
1258
#if defined(GRAN)

static void
enable_GranSimLight(void) {

1259
    debugBelch("GrAnSim Light enabled (infinite number of processors;  0 communication costs)\n");
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
    RtsFlags.GranFlags.Light=rtsTrue;
    RtsFlags.GranFlags.Costs.latency = 
	RtsFlags.GranFlags.Costs.fetchtime = 
	RtsFlags.GranFlags.Costs.additional_latency =
	RtsFlags.GranFlags.Costs.gunblocktime = 
	RtsFlags.GranFlags.Costs.lunblocktime =
	RtsFlags.GranFlags.Costs.threadcreatetime = 
	RtsFlags.GranFlags.Costs.threadqueuetime =
	RtsFlags.GranFlags.Costs.threadscheduletime = 
	RtsFlags.GranFlags.Costs.threaddescheduletime =
	RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
  
    RtsFlags.GranFlags.Costs.mpacktime = 
	RtsFlags.GranFlags.Costs.munpacktime = 0;

    RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
    RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
    RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
    /* FetchStrategy is irrelevant in GrAnSim-Light */

    /* GrAnSim Light often creates an abundance of parallel threads,
       each with its own stack etc. Therefore, it's in general a good
       idea to use small stack chunks (use the -o<size> option to 
       increase it again). 
    */
    // RtsFlags.ConcFlags.stkChunkSize = 100;

    RtsFlags.GranFlags.proc = 1; 
}

static void
process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
{
    if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
      return;

    /* or a ridiculously idealised simulator */
    if(strcmp((rts_argv[arg]+2),"oring")==0) {
      RtsFlags.GranFlags.Costs.latency = 
	RtsFlags.GranFlags.Costs.fetchtime = 
	RtsFlags.GranFlags.Costs.additional_latency =
	RtsFlags.GranFlags.Costs.gunblocktime = 
	RtsFlags.GranFlags.Costs.lunblocktime =
	RtsFlags.GranFlags.Costs.threadcreatetime = 
	RtsFlags.GranFlags.Costs.threadqueuetime =
	RtsFlags.GranFlags.Costs.threadscheduletime = 
	RtsFlags.GranFlags.Costs.threaddescheduletime =
	RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;

      RtsFlags.GranFlags.Costs.mpacktime = 
	RtsFlags.GranFlags.Costs.munpacktime = 0;

      RtsFlags.GranFlags.Costs.arith_cost = 
	RtsFlags.GranFlags.Costs.float_cost = 
	RtsFlags.GranFlags.Costs.load_cost =
	RtsFlags.GranFlags.Costs.store_cost = 
	RtsFlags.GranFlags.Costs.branch_cost = 0;

      RtsFlags.GranFlags.Costs.heapalloc_cost = 1;

      /* ++RtsFlags.GranFlags.DoFairSchedule; */
      RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue;        /* -bZ */
      RtsFlags.GranFlags.DoThreadMigration   = rtsTrue;        /* -bM */
      RtsFlags.GranFlags.GranSimStats.Full   = rtsTrue;        /* -bP */
      return;
    }

      /* or a somewhat idealised simulator */
      if(strcmp((rts_argv[arg]+2),"onzo")==0) {
	RtsFlags.GranFlags.Costs.latency = 
	RtsFlags.GranFlags.Costs.fetchtime = 
	RtsFlags.GranFlags.Costs.additional_latency =
	RtsFlags.GranFlags.Costs.gunblocktime = 
	RtsFlags.GranFlags.Costs.lunblocktime =
	RtsFlags.GranFlags.Costs.threadcreatetime = 
	RtsFlags.GranFlags.Costs.threadqueuetime =
	RtsFlags.GranFlags.Costs.threadscheduletime = 
	RtsFlags.GranFlags.Costs.threaddescheduletime =
	RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;

	RtsFlags.GranFlags.Costs.mpacktime = 
	RtsFlags.GranFlags.Costs.munpacktime = 0;
	
	RtsFlags.GranFlags.Costs.heapalloc_cost = 1;

	/* RtsFlags.GranFlags.DoFairSchedule  = rtsTrue; */       /* -b-R */
	/* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */   /* -b-T */
	RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;         /* -bZ */
	RtsFlags.GranFlags.DoThreadMigration  = rtsTrue;          /* -bM */
	RtsFlags.GranFlags.GranSimStats.Full  = rtsTrue;          /* -bP */
#  if defined(GRAN_CHECK) && defined(GRAN)
	RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics   */
#  endif
	return;
      }

      /* Communication and task creation cost parameters */