RtsFlags.c 77.2 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;
31 32
int     full_prog_argc = 0;    /* an "int" so as to match normal "argc" */
char  **full_prog_argv = NULL;
sof's avatar
sof committed
33
char   *prog_name = NULL; /* 'basename' of prog_argv[0] */
34
int     rts_argc = 0;  /* ditto */
35 36 37 38 39 40 41 42
char   *rts_argv[MAX_RTS_ARGS];

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

43 44
#if defined(GRAN)

sof's avatar
sof committed
45
static char *gran_debug_opts_strs[] = {
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
  "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
64
static char gran_debug_opts_flags[] = {
65 66 67 68 69
  'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
};

#elif defined(PAR)

sof's avatar
sof committed
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 74 75
  "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
  "DEBUG (-qDe, -qD8): free; free messages.\n",
  "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 79 80 81 82
  // "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",
83 84
  "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
  "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
85 86 87
};

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

#endif /* PAR */

94 95 96 97
/* -----------------------------------------------------------------------------
   Static function decls
   -------------------------------------------------------------------------- */

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

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

109 110 111 112 113 114 115 116 117 118 119
#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

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

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

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

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 139 140 141 142 143
#if defined(PAR)
    /* A hack currently needed for GUM -- HWL */
    RtsFlags.GcFlags.generations        = 1;
    RtsFlags.GcFlags.steps              = 2;
    RtsFlags.GcFlags.squeezeUpdFrames	= rtsFalse;
#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 152 153
#ifdef RTS_GTK_FRONTPANEL
    RtsFlags.GcFlags.frontpanel         = rtsFalse;
#endif
154
    RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
155

156 157 158 159 160 161 162 163 164 165 166 167
#if osf3_HOST_OS
/* ToDo: Perhaps by adjusting this value we can make linking without
 * -static work (i.e., not generate a core-dumping executable)? */
# if SIZEOF_VOID_P == 8
    RtsFlags.GcFlags.heapBase           = 0x180000000L;
# else
#  error I have no idea where to begin the heap on a non-64-bit osf3 machine.
# endif
#else
    RtsFlags.GcFlags.heapBase           = 0;   /* means don't care */
#endif

168 169
#ifdef DEBUG
    RtsFlags.DebugFlags.scheduler	= rtsFalse;
170
    RtsFlags.DebugFlags.interpreter	= rtsFalse;
171 172 173 174 175 176
    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;
177
    RtsFlags.DebugFlags.stm             = rtsFalse;
178 179 180 181
    RtsFlags.DebugFlags.prof		= rtsFalse;
    RtsFlags.DebugFlags.gran		= rtsFalse;
    RtsFlags.DebugFlags.par		= rtsFalse;
    RtsFlags.DebugFlags.linker		= rtsFalse;
182
    RtsFlags.DebugFlags.squeeze		= rtsFalse;
183
    RtsFlags.DebugFlags.hpc		= rtsFalse;
184 185
#endif

186 187 188 189
#if defined(PROFILING) || defined(PAR)
    RtsFlags.CcFlags.doCostCentres	= 0;
#endif /* PROFILING or PAR */

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;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
197
    RtsFlags.ProfFlags.ccsLength          = 25;
198 199 200 201
    RtsFlags.ProfFlags.modSelector        = NULL;
    RtsFlags.ProfFlags.descrSelector      = NULL;
    RtsFlags.ProfFlags.typeSelector       = NULL;
    RtsFlags.ProfFlags.ccSelector         = NULL;
202
    RtsFlags.ProfFlags.ccsSelector        = NULL;
203 204
    RtsFlags.ProfFlags.retainerSelector   = NULL;
    RtsFlags.ProfFlags.bioSelector        = NULL;
205 206
#endif

207 208
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    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 216
    RtsFlags.ParFlags.migrate           = rtsTrue;
    RtsFlags.ParFlags.wakeupMigrate     = rtsFalse;
217 218
    RtsFlags.ParFlags.parGcEnabled      = 1;
    RtsFlags.ParFlags.parGcGen          = 1;
219
#endif
220

221
#ifdef PAR
222
    RtsFlags.ParFlags.ParStats.Full   	  = rtsFalse;
223
    RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
224 225 226 227 228 229
    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;

230
    RtsFlags.ParFlags.outputDisabled	= rtsFalse;
231 232 233 234 235
#ifdef DIST
    RtsFlags.ParFlags.doFairScheduling  = rtsTrue;  /* fair sched by def */
#else
    RtsFlags.ParFlags.doFairScheduling  = rtsFalse;  /* unfair sched by def */
#endif
236
    RtsFlags.ParFlags.packBufferSize	= 1024;
237 238
    RtsFlags.ParFlags.thunksToPack      = 1; /* 0 ... infinity; */
    RtsFlags.ParFlags.globalising       = 1; /* 0 ... everything */
239 240 241
    RtsFlags.ParFlags.maxThreads        = 1024;
    RtsFlags.ParFlags.maxFishes        = MAX_FISHES;
    RtsFlags.ParFlags.fishDelay         = FISH_DELAY;
242 243
#endif

244
#if defined(PAR) || defined(THREADED_RTS)
245
    RtsFlags.ParFlags.maxLocalSparks	= 4096;
246
#endif /* PAR || THREADED_RTS */
247 248 249

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

253
    RtsFlags.GranFlags.maxThreads	= 65536; // refers to mandatory threads
254 255 256 257 258 259 260
    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;
261 262 263 264

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

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
    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;                     
304
    RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;   
305 306 307 308 309 310 311 312 313
    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;
314 315 316
#endif

#ifdef TICKY_TICKY
317 318
    RtsFlags.TickyFlags.showTickyStats	 = rtsFalse;
    RtsFlags.TickyFlags.tickyFile	 = NULL;
319
#endif
Simon Marlow's avatar
Simon Marlow committed
320 321 322

    RtsFlags.TraceFlags.timestamp	= rtsFalse;
    RtsFlags.TraceFlags.sched 		= rtsFalse;
323
    RtsFlags.TraceFlags.gc 		= rtsFalse;
324 325

#ifdef USE_PAPI
326 327
    /* By default no special measurements taken */
    RtsFlags.PapiFlags.eventType        = 0;
328
    RtsFlags.PapiFlags.numUserEvents    = 0;
329
#endif
330 331 332 333 334 335 336 337 338 339 340 341 342 343
}

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:",
"",
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",
sof's avatar
sof committed
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 357
"  -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%)",
358
"  -c       Enable compaction for all major collections",
359
"  -w       Use mark-region for the oldest generation (experimental)",
360
#if defined(THREADED_RTS)
361 362
"  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
#endif
363
"",
364 365 366
"  -t[<file>] One-line GC statistics (if <file> omitted, uses stderr)",
"  -s[<file>] Summary  GC statistics (if <file> omitted, uses stderr)",
"  -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)",
367 368 369
#ifdef RTS_GTK_FRONTPANEL
"  -f       Display front panel (requires X11 & GTK+)",
#endif
370 371 372 373 374 375
"",
"",
"  -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)
"",
376
"  -px      Time/allocation profile (XML)  (output file <program>.prof)",
andy's avatar
andy committed
377 378 379
"  -p       Time/allocation profile        (output file <program>.prof)",
"  -P       More detailed Time/Allocation profile",
"  -Pa      Give information about *all* cost centres",
380

381 382
# if defined(PROFILING)
"",
383 384 385 386 387 388 389 390
"  -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)",
391
"  A subset of closures may be selected thusly:",
392 393
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
394 395 396 397 398
"    -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)",
399 400
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
401 402 403
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
404
"",
405 406
"  -xt            Include threads (TSOs) in a heap profile",
"",
407
"  -xc      Show current cost centre stack on raising an exception",
408
"",
409 410
# endif
#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 423
"  -N<n>     Use <n> PVMish processors in parallel (default: 2)",
/* NB: the -N<n> is implemented by the driver!! */
424
#endif
425 426 427
"  -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.",
428
"  -V<secs>  Master tick interval in seconds (0 == disable timer).",
429 430
"            This sets the resolution for -C and the profile timer -i.",
"            Default: 0.02 sec.",
431
"",
Simon Marlow's avatar
Simon Marlow committed
432 433 434
"  -vs       Trace scheduler events (see also -Ds with -debug)",
"  -vt       Time-stamp trace messages",
"",
435 436
#if defined(DEBUG)
"  -Ds  DEBUG: scheduler",
437
"  -Di  DEBUG: interpreter",
438 439 440 441 442 443 444 445 446 447
"  -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",
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 455 456
"  -N<n>     Use <n> OS threads (default: 1)",
"  -q1       Use one OS thread for GC (turns off parallel GC)",
"  -qg<n>    Use parallel GC only for generations >= <n> (default: 1)",
457 458
"  -qm       Don't automatically migrate threads between CPUs",
"  -qw       Migrate a thread to the current CPU when it is woken up",
459
#endif
460 461
"  --install-signal-handlers=<yes|no>",
"            Install signal handlers (default: yes)",
462
#if defined(THREADED_RTS) || defined(PAR)
463 464 465
"  -e<size>  Size of spark pools (default 100)",
#endif
#if defined(PAR)
466 467 468 469 470
"  -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",
471
#endif
472
#if defined(THREADED_RTS) || defined(PAR)
473 474
"  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
#endif
475
#if defined(PAR)
476 477
"  -d        Turn on PVM-ish debugging",
"  -O        Disable output for performance measurement",
478 479
#endif /* PAR */
#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 483 484 485
#if defined(x86_64_HOST_ARCH)
"  -xm       Base address to mmap memory in the GHCi linker",
"            (hex; must be <80000000)",
#endif
486
#if defined(USE_PAPI)
487 488
"  -aX       CPU performance counter measurements using PAPI",
"            (use with the -s<file> option).  X is one of:",
489 490 491 492 493 494
"",
/* "            y - cycles", */
"            1 - level 1 cache misses",
"            2 - level 2 cache misses",
"            b - branch mispredictions",
"            s - stalled cycles",
495
"            e - cache miss and branch misprediction events",
496
#endif
497
"",
498 499
"RTS options may also be specified using the GHCRTS environment variable.",
"",
500 501 502 503 504 505
"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
506
STATIC_INLINE rtsBool
507 508 509 510 511
strequal(const char *a, const char * b)
{
    return(strcmp(a, b) == 0);
}

512 513 514 515 516 517 518 519 520 521 522 523 524 525
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
526
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
527 528 529 530 531 532 533 534 535 536 537
	    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');
}
    
538 539 540 541 542 543 544
void
setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
{
    rtsBool error = rtsFalse;
    I_ mode;
    I_ arg, total_arg;

545
    setProgName (argv);
546 547 548 549 550 551
    total_arg = *argc;
    arg = 1;

    *argc = 1;
    *rts_argc = 0;

552 553 554 555 556 557 558 559 560
    // 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);
	}
    }

561
    // process arguments from the GHCRTS environment variable next
562
    // (arguments from the command line override these).
563 564 565 566
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
567
	    splitRtsFlags(ghc_rts, rts_argc, rts_argv);
568 569
	}
    }
570

571 572 573
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

574 575 576 577 578 579 580 581 582 583 584 585
    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])) {
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
	    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);
	}
    }
601 602 603
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
604 605 606 607 608
    }
    argv[*argc] = (char *) 0;
    rts_argv[*rts_argc] = (char *) 0;

    // Process RTS (rts_argv) part: mainly to determine statsfile
609 610 611
    for (arg = 0; arg < *rts_argc; arg++) {
	if (rts_argv[arg][0] != '-') {
	    fflush(stdout);
612
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
613 614 615 616 617 618 619 620 621 622
	    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.
623
                 Final group is x*, which allows for more options.
624 625 626 627 628 629
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
630
errorBelch("not built for: ticky-ticky stats"); \
631 632 633 634 635 636 637
error = rtsTrue;
#endif

#if defined(PROFILING) 
# define COST_CENTRE_USING_BUILD_ONLY(x) x
#else
# define COST_CENTRE_USING_BUILD_ONLY(x) \
638
errorBelch("not built for: -prof or -parallel"); \
639 640 641 642 643 644 645
error = rtsTrue;
#endif

#ifdef PROFILING
# define PROFILING_BUILD_ONLY(x)   x
#else
# define PROFILING_BUILD_ONLY(x) \
646
errorBelch("not built for: -prof"); \
647 648 649
error = rtsTrue;
#endif

650 651 652 653
#ifdef PAR
# define PAR_BUILD_ONLY(x)      x
#else
# define PAR_BUILD_ONLY(x) \
654
errorBelch("not built for: -parallel"); \
655 656 657
error = rtsTrue;
#endif

658 659 660 661 662 663 664 665 666 667
#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
668
#else
669
# define PAR_OR_THREADED_BUILD_ONLY(x) \
670
errorBelch("not built for: -parallel or -smp"); \
671 672 673 674 675 676 677
error = rtsTrue;
#endif

#ifdef GRAN
# define GRAN_BUILD_ONLY(x)     x
#else
# define GRAN_BUILD_ONLY(x) \
678
errorBelch("not built for: -gransim"); \
679 680 681 682 683 684 685 686
error = rtsTrue;
#endif

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

687 688 689 690 691 692 693 694 695 696 697 698
              /* This isn't going to allow us to keep related options
                 together as we add more --* flags. We really need a
                 proper options parser. */
	      case '-':
                  if (strequal("install-signal-handlers=yes",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;
                  }
                  else if (strequal("install-signal-handlers=no",
                               &rts_argv[arg][2])) {
                      RtsFlags.MiscFlags.install_signal_handlers = rtsFalse;
                  }
699 700
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
701
                      printRtsInfo();
702 703
                      exit(0);
                  }
704 705 706 707 708
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
709 710 711 712 713 714 715 716
	      case 'A':
		RtsFlags.GcFlags.minAllocAreaSize
		  = decode(rts_argv[arg]+2) / BLOCK_SIZE;
		if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
		  bad_option(rts_argv[arg]);
		}
		break;

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
#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;
732 733 734
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
735 736 737 738 739 740 741 742
                case '+':
                  if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
                      errorBelch("maximum number of PAPI events reached");
                      stg_exit(EXIT_FAILURE);
                  }
                  RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
                  RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
                  break;
743 744 745 746 747 748
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

749 750 751 752
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

753
	      case 'c':
754 755 756 757
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
758
		      RtsFlags.GcFlags.compact = rtsTrue;
759 760
		  }
		  break;
761

762 763 764 765
              case 'w':
		RtsFlags.GcFlags.sweep = rtsTrue;
		break;

766 767 768 769 770 771 772
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
773 774
#ifdef DEBUG
	      case 'D':
775 776 777 778 779 780 781 782
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
783 784
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
			  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;
816 817 818
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
819 820 821
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
822 823 824
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
825 826 827
		      case 'c':
			  RtsFlags.DebugFlags.hpc = rtsTrue;
			  break;
828 829 830 831 832 833
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
		  break;
	      }
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
#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;

870 871
	      case 'G':
		RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
872
		if (RtsFlags.GcFlags.generations < 1) {
873 874 875 876
		  bad_option(rts_argv[arg]);
		}
		break;

877 878 879 880 881 882 883
	      case 'T':
		RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
		if (RtsFlags.GcFlags.steps < 1) {
		  bad_option(rts_argv[arg]);
		}
		break;

884
	      case 'H':
885 886
		RtsFlags.GcFlags.heapSizeSuggestion = 
		  decode(rts_argv[arg]+2) / BLOCK_SIZE;
887 888
		break;

889 890 891 892 893 894
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

895 896 897 898 899 900
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

901
		    /* Convert to millisecs */
902
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
903
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
904 905 906
		}
		break;

907
	      case 'S':
908 909
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
910

911
	      case 's':
912 913
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
914 915

	      case 't':
916 917
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
918

919
	    stats:
920
#ifdef PAR
921 922
		/* Opening all those files would almost certainly fail... */
		// RtsFlags.ParFlags.ParStats.Full = rtsTrue;
923
		RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
924
#else
925 926 927
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
928
					*rts_argc, rts_argv, NULL,
929 930 931
					&RtsFlags.GcFlags.statsFile);
		    if (r == -1) { error = rtsTrue; }
		}
932
#endif
933
		  break;
934 935 936 937 938 939 940 941 942 943 944

	      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]) {
945 946
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
947
		    break;
andy's avatar
andy committed
948 949 950
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
951
		  default:
952 953 954 955 956 957 958 959
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
960 961 962
		}
		) break;

963 964 965 966
	      case 'R':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
  	          ) break;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
967 968 969 970 971 972 973
	      case 'L':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
                      if(RtsFlags.ProfFlags.ccsLength <= 0) {
			bad_option(rts_argv[arg]);
                      }
		  ) break;
974
	      case 'h': /* serial heap profile */
975
#if !defined(PROFILING)
976 977 978 979 980 981
		switch (rts_argv[arg][2]) {
		  case '\0':
		  case 'T':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
		    break;
		  default:
982
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
983 984 985 986 987
		    error = rtsTrue;
		}
#else
		PROFILING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
		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], '}');
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

			    // 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;
1022 1023 1024
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
			    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;
1045 1046 1047 1048
			    }
			}
			break;
		    }
1049

1050
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1051
			errorBelch("multiple heap profile options");
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
			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':
1064 1065
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
1066 1067
		    case 'D':
		    case 'd':