RtsFlags.c 74.3 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 151 152
#ifdef RTS_GTK_FRONTPANEL
    RtsFlags.GcFlags.frontpanel         = rtsFalse;
#endif
153
    RtsFlags.GcFlags.idleGCDelayTime    = 300; /* millisecs */
154

155 156 157 158 159 160 161 162 163 164 165 166
#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

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

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

189
    RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
190
    RtsFlags.ProfFlags.profileInterval    = 100;
191 192

#ifdef PROFILING
193
    RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
194
    RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
195
    RtsFlags.ProfFlags.maxRetainerSetSize = 8;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
196
    RtsFlags.ProfFlags.ccsLength          = 25;
197 198 199 200
    RtsFlags.ProfFlags.modSelector        = NULL;
    RtsFlags.ProfFlags.descrSelector      = NULL;
    RtsFlags.ProfFlags.typeSelector       = NULL;
    RtsFlags.ProfFlags.ccSelector         = NULL;
201
    RtsFlags.ProfFlags.ccsSelector        = NULL;
202 203
    RtsFlags.ProfFlags.retainerSelector   = NULL;
    RtsFlags.ProfFlags.bioSelector        = NULL;
204 205
#endif

206 207
    RtsFlags.MiscFlags.tickInterval	= 20;  /* In milliseconds */
    RtsFlags.ConcFlags.ctxtSwitchTime	= 20;  /* In milliseconds */
208

209 210
    RtsFlags.MiscFlags.install_signal_handlers = rtsTrue;

211
#ifdef THREADED_RTS
212
    RtsFlags.ParFlags.nNodes	        = 1;
213 214
    RtsFlags.ParFlags.migrate           = rtsTrue;
    RtsFlags.ParFlags.wakeupMigrate     = rtsFalse;
215
#endif
216

217
#ifdef PAR
218
    RtsFlags.ParFlags.ParStats.Full   	  = rtsFalse;
219
    RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
220 221 222 223 224 225
    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;

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

240
#if defined(PAR) || defined(THREADED_RTS)
241
    RtsFlags.ParFlags.maxLocalSparks	= 4096;
242
#endif /* PAR || THREADED_RTS */
243 244 245

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

249
    RtsFlags.GranFlags.maxThreads	= 65536; // refers to mandatory threads
250 251 252 253 254 255 256
    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;
257 258 259 260

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

261 262 263 264 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
    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;                     
300
    RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;   
301 302 303 304 305 306 307 308 309
    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;
310 311 312
#endif

#ifdef TICKY_TICKY
313 314
    RtsFlags.TickyFlags.showTickyStats	 = rtsFalse;
    RtsFlags.TickyFlags.tickyFile	 = NULL;
315
#endif
Simon Marlow's avatar
Simon Marlow committed
316 317 318

    RtsFlags.TraceFlags.timestamp	= rtsFalse;
    RtsFlags.TraceFlags.sched 		= rtsFalse;
319 320

#ifdef USE_PAPI
321 322
    /* By default no special measurements taken */
    RtsFlags.PapiFlags.eventType        = 0;
323
#endif
324 325 326 327 328 329 330 331 332 333 334 335 336 337
}

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:",
"",
338
"  -?       Prints this message and exits; the program is not executed",
339
"  --info   Print information about the RTS used by this program",
340
"",
341
"  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
sof's avatar
sof committed
342
"  -k<size> Sets the initial thread stack size (default 1k)  Egs: -k4k   -k2m",
343 344
"",
"  -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
345
"  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
346
"  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
347
"  -m<n>    Minimum % of heap which must be available (default 3%)",
348
"  -G<n>    Number of generations (default: 2)",
349
"  -T<n>    Number of steps in younger generations (default: 2)",
350 351
"  -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%)",
352
"  -c       Enable compaction for all major collections",
353
#if defined(THREADED_RTS)
354 355
"  -I<sec>  Perform full GC after <sec> idle time (default: 0.3, 0 == off)",
#endif
356 357 358 359
"",
"  -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",
360 361 362
#ifdef RTS_GTK_FRONTPANEL
"  -f       Display front panel (requires X11 & GTK+)",
#endif
363 364 365 366 367 368
"",
"",
"  -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)
"",
369
"  -px      Time/allocation profile (XML)  (output file <program>.prof)",
andy's avatar
andy committed
370 371 372
"  -p       Time/allocation profile        (output file <program>.prof)",
"  -P       More detailed Time/Allocation profile",
"  -Pa      Give information about *all* cost centres",
373

374 375
# if defined(PROFILING)
"",
376 377 378 379 380 381 382 383
"  -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)",
384
"  A subset of closures may be selected thusly:",
385 386
"    -hc<cc>,...  specific cost centre(s) (top of stack only)",
"    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
387 388 389 390 391
"    -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)",
392 393
"",
"  -R<size>       Set the maximum retainer set size (default: 8)",
ravi@bluespec.com's avatar
ravi@bluespec.com committed
394 395 396
"", 
"  -L<chars>      Maximum length of a cost-centre stack in a heap profile",
"                 (default: 25)",
397
"",
398 399
"  -xt            Include threads (TSOs) in a heap profile",
"",
400
"  -xc      Show current cost centre stack on raising an exception",
401
"",
402 403
# endif
#endif /* PROFILING or PAR */
404
#if !defined(PROFILING)
405
"",
406
"  -hT      Heap residency profile (output file <program>.hp)",
407
#endif
408
"  -i<sec>  Time between heap samples (seconds, default: 0.1)",
409 410
"",
#if defined(TICKY_TICKY)
411
"  -r<file>  Produce ticky-ticky statistics (with -rstderr for stderr)",
412 413
"",
#endif
414
#if defined(PAR)
415 416
"  -N<n>     Use <n> PVMish processors in parallel (default: 2)",
/* NB: the -N<n> is implemented by the driver!! */
417
#endif
418 419 420
"  -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.",
421
"  -V<secs>  Master tick interval in seconds (0 == disable timer).",
422 423
"            This sets the resolution for -C and the profile timer -i.",
"            Default: 0.02 sec.",
424
"",
Simon Marlow's avatar
Simon Marlow committed
425 426 427
"  -vs       Trace scheduler events (see also -Ds with -debug)",
"  -vt       Time-stamp trace messages",
"",
428 429
#if defined(DEBUG)
"  -Ds  DEBUG: scheduler",
430
"  -Di  DEBUG: interpreter",
431 432 433 434 435 436 437 438 439 440
"  -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",
441
"  -Dm  DEBUG: stm",
442
"  -Dz  DEBUG: stack squezing",
443
"  -Dc  DEBUG: program coverage",
444
"",
445
#endif /* DEBUG */
446
#if defined(THREADED_RTS) && !defined(NOSMP)
447
"  -N<n>     Use <n> OS threads (default: 1)",
448 449
"  -qm       Don't automatically migrate threads between CPUs",
"  -qw       Migrate a thread to the current CPU when it is woken up",
450
#endif
451 452
"  --install-signal-handlers=<yes|no>",
"            Install signal handlers (default: yes)",
453
#if defined(THREADED_RTS) || defined(PAR)
454 455 456
"  -e<size>  Size of spark pools (default 100)",
#endif
#if defined(PAR)
457 458 459 460 461
"  -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",
462
#endif
463
#if defined(THREADED_RTS) || defined(PAR)
464 465
"  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
#endif
466
#if defined(PAR)
467 468
"  -d        Turn on PVM-ish debugging",
"  -O        Disable output for performance measurement",
469 470
#endif /* PAR */
#if defined(GRAN)  /* ToDo: fill in decent Docu here */
471
"  -b...     All GranSim options start with -b; see GranSim User's Guide for details",
472
#endif
473
#if defined(USE_PAPI)
474 475
"  -aX       CPU performance counter measurements using PAPI",
"            (use with the -s<file> option).  X is one of:",
476 477 478 479 480 481
"",
/* "            y - cycles", */
"            1 - level 1 cache misses",
"            2 - level 2 cache misses",
"            b - branch mispredictions",
"            s - stalled cycles",
482
"            e - cache miss and branch misprediction events",
483
#endif
484
"",
485 486
"RTS options may also be specified using the GHCRTS environment variable.",
"",
487 488 489 490 491 492
"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
493
STATIC_INLINE rtsBool
494 495 496 497 498
strequal(const char *a, const char * b)
{
    return(strcmp(a, b) == 0);
}

499 500 501 502 503 504 505 506 507 508 509 510 511 512
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
513
	    s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
514 515 516 517 518 519 520 521 522 523 524
	    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');
}
    
525 526 527 528 529 530 531
void
setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
{
    rtsBool error = rtsFalse;
    I_ mode;
    I_ arg, total_arg;

532
    setProgName (argv);
533 534 535 536 537 538
    total_arg = *argc;
    arg = 1;

    *argc = 1;
    *rts_argc = 0;

539 540 541 542 543 544 545 546 547
    // 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);
	}
    }

548
    // process arguments from the GHCRTS environment variable next
549
    // (arguments from the command line override these).
550 551 552 553
    {
	char *ghc_rts = getenv("GHCRTS");

	if (ghc_rts != NULL) {
554
	    splitRtsFlags(ghc_rts, rts_argc, rts_argv);
555 556
	}
    }
557

558 559 560
    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
    //   argv[0] must be PGM argument -- leave in argv

561 562 563 564 565 566 567 568 569 570 571 572
    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])) {
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
	    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);
	}
    }
588 589 590
    // process remaining program arguments
    for (; arg < total_arg; arg++) {
	argv[(*argc)++] = argv[arg];
591 592 593 594 595
    }
    argv[*argc] = (char *) 0;
    rts_argv[*rts_argc] = (char *) 0;

    // Process RTS (rts_argv) part: mainly to determine statsfile
596 597 598
    for (arg = 0; arg < *rts_argc; arg++) {
	if (rts_argv[arg][0] != '-') {
	    fflush(stdout);
599
	    errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
600 601 602 603 604 605 606 607 608 609
	    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.
610
                 Final group is x*, which allows for more options.
611 612 613 614 615 616
	      */

#ifdef TICKY_TICKY
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
617
errorBelch("not built for: ticky-ticky stats"); \
618 619 620 621 622 623 624
error = rtsTrue;
#endif

#if defined(PROFILING) 
# define COST_CENTRE_USING_BUILD_ONLY(x) x
#else
# define COST_CENTRE_USING_BUILD_ONLY(x) \
625
errorBelch("not built for: -prof or -parallel"); \
626 627 628 629 630 631 632
error = rtsTrue;
#endif

#ifdef PROFILING
# define PROFILING_BUILD_ONLY(x)   x
#else
# define PROFILING_BUILD_ONLY(x) \
633
errorBelch("not built for: -prof"); \
634 635 636
error = rtsTrue;
#endif

637 638 639 640
#ifdef PAR
# define PAR_BUILD_ONLY(x)      x
#else
# define PAR_BUILD_ONLY(x) \
641
errorBelch("not built for: -parallel"); \
642 643 644
error = rtsTrue;
#endif

645 646 647 648 649 650 651 652 653 654
#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
655
#else
656
# define PAR_OR_THREADED_BUILD_ONLY(x) \
657
errorBelch("not built for: -parallel or -smp"); \
658 659 660 661 662 663 664
error = rtsTrue;
#endif

#ifdef GRAN
# define GRAN_BUILD_ONLY(x)     x
#else
# define GRAN_BUILD_ONLY(x) \
665
errorBelch("not built for: -gransim"); \
666 667 668 669 670 671 672 673
error = rtsTrue;
#endif

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

674 675 676 677 678 679 680 681 682 683 684 685
              /* 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;
                  }
686 687
                  else if (strequal("info",
                               &rts_argv[arg][2])) {
688
                      printRtsInfo();
689 690
                      exit(0);
                  }
691 692 693 694 695
                  else {
		      errorBelch("unknown RTS option: %s",rts_argv[arg]);
		      error = rtsTrue;
                  }
		  break;
696 697 698 699 700 701 702 703
	      case 'A':
		RtsFlags.GcFlags.minAllocAreaSize
		  = decode(rts_argv[arg]+2) / BLOCK_SIZE;
		if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
		  bad_option(rts_argv[arg]);
		}
		break;

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
#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;
719 720 721
		case 'e':
		  RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
		  break;
722 723 724 725 726 727
		default:
		  bad_option( rts_argv[arg] );
		}
		break;
#endif

728 729 730 731
	      case 'B':
		RtsFlags.GcFlags.ringBell = rtsTrue;
		break;

732
	      case 'c':
733 734 735 736
		  if (rts_argv[arg][2] != '\0') {
		      RtsFlags.GcFlags.compactThreshold =
			  atof(rts_argv[arg]+2);
		  } else {
737
		      RtsFlags.GcFlags.compact = rtsTrue;
738 739
		  }
		  break;
740

741 742 743 744 745 746 747
	      case 'F':
	        RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
	      
		if (RtsFlags.GcFlags.oldGenFactor < 0)
		  bad_option( rts_argv[arg] );
		break;
	      
748 749
#ifdef DEBUG
	      case 'D':
750 751 752 753 754 755 756 757
	      { 
		  char *c;

		  for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
		      switch (*c) {
		      case 's':
			  RtsFlags.DebugFlags.scheduler = rtsTrue;
			  break;
758 759
		      case 'i':
			  RtsFlags.DebugFlags.interpreter = rtsTrue;
760 761 762 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
			  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;
791 792 793
		      case 'a':
			  RtsFlags.DebugFlags.apply = rtsTrue;
			  break;
794 795 796
		      case 'm':
			  RtsFlags.DebugFlags.stm = rtsTrue;
			  break;
797 798 799
		      case 'z':
			  RtsFlags.DebugFlags.squeeze = rtsTrue;
			  break;
800 801 802
		      case 'c':
			  RtsFlags.DebugFlags.hpc = rtsTrue;
			  break;
803 804 805 806 807 808
		      default:
			  bad_option( rts_argv[arg] );
		      }
		  }
		  break;
	      }
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
#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;

845 846
	      case 'G':
		RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
847
		if (RtsFlags.GcFlags.generations < 1) {
848 849 850 851
		  bad_option(rts_argv[arg]);
		}
		break;

852 853 854 855 856 857 858
	      case 'T':
		RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
		if (RtsFlags.GcFlags.steps < 1) {
		  bad_option(rts_argv[arg]);
		}
		break;

859
	      case 'H':
860 861 862 863 864 865
		RtsFlags.GcFlags.heapSizeSuggestion = 
		  decode(rts_argv[arg]+2) / BLOCK_SIZE;

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

868 869 870 871 872 873
#ifdef RTS_GTK_FRONTPANEL
	      case 'f':
		  RtsFlags.GcFlags.frontpanel = rtsTrue;
		  break;
#endif

874 875 876 877 878 879
    	      case 'I':	/* idle GC delay */
		if (rts_argv[arg][2] == '\0') {
		  /* use default */
		} else {
		    I_ cst; /* tmp */

880
		    /* Convert to millisecs */
881
		    cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
882
		    RtsFlags.GcFlags.idleGCDelayTime = cst;
883 884 885
		}
		break;

886
	      case 'S':
887 888
		  RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
		  goto stats;
889

890
	      case 's':
891 892
		  RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
		  goto stats;
893 894

	      case 't':
895 896
		  RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
		  goto stats;
897

898
	    stats:
899
#ifdef PAR
900 901
		/* Opening all those files would almost certainly fail... */
		// RtsFlags.ParFlags.ParStats.Full = rtsTrue;
902
		RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
903
#else
904 905 906 907 908 909 910
		{ 
		    int r;
		    r = open_stats_file(arg, *argc, argv,
					*rts_argc, rts_argv, STAT_FILENAME_FMT,
					&RtsFlags.GcFlags.statsFile);
		    if (r == -1) { error = rtsTrue; }
		}
911
#endif
912
		  break;
913 914 915 916 917 918 919 920 921 922 923

	      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]) {
924 925
		  case 'x':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
926
		    break;
andy's avatar
andy committed
927 928 929
		  case 'a':
		    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
		    break;
930
		  default:
931 932 933 934 935 936 937 938
		      if (rts_argv[arg][1] == 'P') {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_VERBOSE;
		      } else {
			  RtsFlags.CcFlags.doCostCentres =
			      COST_CENTRES_SUMMARY;
		      }
		      break;
939 940 941
		}
		) break;

942 943 944 945
	      case 'R':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
  	          ) break;
ravi@bluespec.com's avatar
ravi@bluespec.com committed
946 947 948 949 950 951 952
	      case 'L':
		  PROFILING_BUILD_ONLY(
		      RtsFlags.ProfFlags.ccsLength = atof(rts_argv[arg]+2);
                      if(RtsFlags.ProfFlags.ccsLength <= 0) {
			bad_option(rts_argv[arg]);
                      }
		  ) break;
953
	      case 'h': /* serial heap profile */
954
#if !defined(PROFILING)
955 956 957 958 959 960
		switch (rts_argv[arg][2]) {
		  case '\0':
		  case 'T':
		    RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
		    break;
		  default:
961
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
962 963 964 965 966
		    error = rtsTrue;
		}
#else
		PROFILING_BUILD_ONLY(
		switch (rts_argv[arg][2]) {
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
		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], '}');
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000

			    // 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;
1001 1002 1003
			    case 'C':
				RtsFlags.ProfFlags.ccsSelector = left;
				break;
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
			    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;
1024 1025 1026 1027
			    }
			}
			break;
		    }
1028

1029
		    if (RtsFlags.ProfFlags.doHeapProfile != 0) {
1030
			errorBelch("multiple heap profile options");
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
			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':
1043 1044
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
			  break;
1045 1046
		    case 'D':
		    case 'd':
1047 1048
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
			  break;
1049 1050
		    case 'Y':
		    case 'y':
1051 1052
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
			  break;
1053 1054
		    case 'R':
		    case 'r':
1055 1056
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
			  break;
1057 1058
		    case 'B':
		    case 'b':
1059 1060
			  RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
			  break;
1061 1062
		    }
		    break;
1063
		      
1064
		default:
1065
		    errorBelch("invalid heap profile option: %s",rts_argv[arg]);
1066 1067 1068
		    error = rtsTrue;
		}
		) 
1069
#endif /* PROFILING */
andy's avatar
andy committed
1070