#include "PosixSource.h"
#include "Rts.h"
+#include "RtsOpts.h"
#include "RtsUtils.h"
#include "Profiling.h"
static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max);
static void bad_option(const char *s);
+#ifdef TRACING
+static void read_trace_flags(char *arg);
+#endif
/* -----------------------------------------------------------------------------
* Command-line option parsing routines.
RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */
RtsFlags.GcFlags.oldGenFactor = 2;
RtsFlags.GcFlags.generations = 2;
- RtsFlags.GcFlags.steps = 2;
RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue;
RtsFlags.GcFlags.compact = rtsFalse;
RtsFlags.GcFlags.compactThreshold = 30.0;
" -H<size> Sets the minimum heap size (default 0M) Egs: -H24m -H1G",
" -m<n> Minimum % of heap which must be available (default 3%)",
" -G<n> Number of generations (default: 2)",
-" -T<n> Number of steps in younger generations (default: 2)",
" -c<n> Use in-place compaction instead of copying in the oldest generation",
" when live data is at least <n>% of the maximum heap size set with",
" -M (default: 30%)",
" -xt Include threads (TSOs) in a heap profile",
"",
" -xc Show current cost centre stack on raising an exception",
-"",
# endif
#endif /* PROFILING or PAR */
#ifdef TRACING
"",
-" -v Log events to stderr",
-" -l Log events in binary format to the file <program>.eventlog",
-" -vt Include time stamps when tracing events to stderr with -v",
-"",
-" -ls Log scheduler events",
-"",
+" -l[flags] Log events in binary format to the file <program>.eventlog",
+# ifdef DEBUG
+" -v[flags] Log events to stderr",
+# endif
+" where [flags] can contain:",
+" s scheduler events",
+# ifdef DEBUG
+" t add time stamps (only useful with -v)",
+# endif
#endif
#if !defined(PROFILING)
" -Dc DEBUG: program coverage",
" -Dr DEBUG: sparks",
"",
-" NOTE: all -D options also enable -v automatically. Use -l to create a",
+" NOTE: DEBUG events are sent to stderr by default; add -l to create a",
" binary event log file instead.",
"",
#endif /* DEBUG */
" --install-signal-handlers=<yes|no>",
" Install signal handlers (default: yes)",
#if defined(THREADED_RTS)
-" -e<size> Size of spark pools (default 100)",
-#endif
-#if defined(THREADED_RTS)
" -e<n> Maximum number of outstanding local sparks (default: 4096)",
#endif
#if defined(x86_64_HOST_ARCH)
" b - branch mispredictions",
" s - stalled cycles",
" e - cache miss and branch misprediction events",
+" +PAPI_EVENT - collect papi preset event PAPI_EVENT",
+" #NATIVE_EVENT - collect native event NATIVE_EVENT (in hex)",
#endif
"",
"RTS options may also be specified using the GHCRTS environment variable.",
char *ghc_rts = getenv("GHCRTS");
if (ghc_rts != NULL) {
- splitRtsFlags(ghc_rts, rts_argc, rts_argv);
+ if (rtsOptsEnabled != rtsOptsNone) {
+ splitRtsFlags(ghc_rts, rts_argc, rts_argv);
+ }
+ else {
+ errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n Link with -rtsopts to enable them.");
+ // We don't actually exit, just warn
+ }
}
}
break;
}
else if (strequal("+RTS", argv[arg])) {
- mode = RTS;
+ if (rtsOptsEnabled != rtsOptsNone) {
+ mode = RTS;
+ }
+ else {
+ errorBelch("RTS options are disabled. Link with -rtsopts to enable them.");
+ stg_exit(EXIT_FAILURE);
+ }
}
else if (strequal("-RTS", argv[arg])) {
mode = PGM;
}
else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
- rts_argv[(*rts_argc)++] = argv[arg];
+ if ((rtsOptsEnabled == rtsOptsAll) ||
+ strequal(argv[arg], "--info")) {
+ rts_argv[(*rts_argc)++] = argv[arg];
+ }
+ else {
+ errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
+ stg_exit(EXIT_FAILURE);
+ }
}
else if (mode == PGM) {
argv[(*argc)++] = argv[arg];
# define TICKY_BUILD_ONLY(x) x
#else
# define TICKY_BUILD_ONLY(x) \
-errorBelch("not built for: ticky-ticky stats"); \
+errorBelch("the flag %s requires the program to be built with -ticky", rts_argv[arg]); \
error = rtsTrue;
#endif
# define PROFILING_BUILD_ONLY(x) x
#else
# define PROFILING_BUILD_ONLY(x) \
-errorBelch("not built for: -prof"); \
+errorBelch("the flag %s requires the program to be built with -prof", rts_argv[arg]); \
error = rtsTrue;
#endif
# define TRACING_BUILD_ONLY(x) x
#else
# define TRACING_BUILD_ONLY(x) \
-errorBelch("not built for: -par-prof"); \
+errorBelch("the flag %s requires the program to be built with -eventlog or -debug", rts_argv[arg]); \
error = rtsTrue;
#endif
# define THREADED_BUILD_ONLY(x) x
#else
# define THREADED_BUILD_ONLY(x) \
-errorBelch("not built for: -smp"); \
+errorBelch("the flag %s requires the program to be built with -threaded", rts_argv[arg]); \
+error = rtsTrue;
+#endif
+
+#ifdef DEBUG
+# define DEBUG_BUILD_ONLY(x) x
+#else
+# define DEBUG_BUILD_ONLY(x) \
+errorBelch("the flag %s requires the program to be built with -debug", rts_argv[arg]); \
error = rtsTrue;
#endif
else if (strequal("info",
&rts_argv[arg][2])) {
printRtsInfo();
- exit(0);
+ stg_exit(0);
}
else {
errorBelch("unknown RTS option: %s",rts_argv[arg]);
RtsFlags.PapiFlags.eventType = PAPI_FLAG_CB_EVENTS;
break;
case '+':
+ case '#':
if (RtsFlags.PapiFlags.numUserEvents >= MAX_PAPI_USER_EVENTS) {
errorBelch("maximum number of PAPI events reached");
stg_exit(EXIT_FAILURE);
}
+ nat eventNum = RtsFlags.PapiFlags.numUserEvents++;
+ char kind = rts_argv[arg][2];
+ nat eventKind = kind == '+' ? PAPI_PRESET_EVENT_KIND : PAPI_NATIVE_EVENT_KIND;
+
+ RtsFlags.PapiFlags.userEvents[eventNum] = rts_argv[arg] + 3;
RtsFlags.PapiFlags.eventType = PAPI_USER_EVENTS;
- RtsFlags.PapiFlags.userEvents[RtsFlags.PapiFlags.numUserEvents++] = rts_argv[arg] + 3;
+ RtsFlags.PapiFlags.userEventsKind[eventNum] = eventKind;
break;
default:
bad_option( rts_argv[arg] );
bad_option( rts_argv[arg] );
break;
-#ifdef DEBUG
case 'D':
+ DEBUG_BUILD_ONLY(
{
char *c;
// -Dx also turns on -v. Use -l to direct trace
// events to the .eventlog file instead.
RtsFlags.TraceFlags.tracing = TRACE_STDERR;
- break;
- }
-#endif
+ })
+ break;
case 'K':
RtsFlags.GcFlags.maxStkSize =
decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
break;
- case 'T':
- RtsFlags.GcFlags.steps =
- decodeSize(rts_argv[arg], 2, 1, HS_INT_MAX);
- break;
-
case 'H':
if (rts_argv[arg][2] == '\0') {
RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
/* =========== PROFILING ========================== */
- case 'l':
-#ifdef TRACING
- switch(rts_argv[arg][2]) {
- case '\0':
- RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
- break;
- case 's':
- RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
- RtsFlags.TraceFlags.scheduler = rtsTrue;
- break;
- default:
- errorBelch("unknown RTS option: %s",rts_argv[arg]);
- error = rtsTrue;
- break;
- }
-#else
- errorBelch("not built for: -eventlog");
-#endif
- break;
-
case 'P': /* detailed cost centre profiling (time/alloc) */
case 'p': /* cost centre profiling (time/alloc) */
PROFILING_BUILD_ONLY(
}
break;
-#if defined(THREADED_RTS) && !defined(NOSMP)
+#if !defined(NOSMP)
case 'N':
THREADED_BUILD_ONLY(
if (rts_argv[arg][2] == '\0') {
) break;
case 'q':
+ THREADED_BUILD_ONLY(
switch (rts_argv[arg][2]) {
case '\0':
errorBelch("incomplete RTS option: %s",rts_argv[arg]);
error = rtsTrue;
break;
}
- break;
+ ) break;
#endif
/* =========== PARALLEL =========================== */
case 'e':
/* =========== TRACING ---------=================== */
+ case 'l':
+ TRACING_BUILD_ONLY(
+ RtsFlags.TraceFlags.tracing = TRACE_EVENTLOG;
+ read_trace_flags(&rts_argv[arg][2]);
+ );
+ break;
+
case 'v':
- switch(rts_argv[arg][2]) {
-#ifdef TRACING
- case '\0':
- RtsFlags.TraceFlags.tracing = TRACE_STDERR;
- break;
- case 't':
- RtsFlags.TraceFlags.timestamp = rtsTrue;
- break;
-#endif
- case 's':
- case 'g':
- // ignored for backwards-compat
- break;
- default:
- errorBelch("unknown RTS option: %s",rts_argv[arg]);
- error = rtsTrue;
- break;
- }
- break;
+ DEBUG_BUILD_ONLY(
+ RtsFlags.TraceFlags.tracing = TRACE_STDERR;
+ read_trace_flags(&rts_argv[arg][2]);
+ );
+ break;
/* =========== EXTENDED OPTIONS =================== */
return val;
}
+#if defined(TRACING)
+static void read_trace_flags(char *arg)
+{
+ char *c;
+
+ for (c = arg; *c != '\0'; c++) {
+ switch(*c) {
+ case '\0':
+ break;
+ case 's':
+ RtsFlags.TraceFlags.scheduler = rtsTrue;
+ break;
+ case 't':
+ RtsFlags.TraceFlags.timestamp = rtsTrue;
+ break;
+ case 'g':
+ // ignored for backwards-compat
+ break;
+ default:
+ errorBelch("unknown trace option: %c",*c);
+ break;
+ }
+ }
+}
+#endif
+
static void GNU_ATTRIBUTE(__noreturn__)
bad_option(const char *s)
{