fix #3910
[ghc-hetmet.git] / rts / RtsFlags.c
index a6dbaf0..067986f 100644 (file)
@@ -10,6 +10,7 @@
 #include "PosixSource.h"
 #include "Rts.h"
 
+#include "RtsOpts.h"
 #include "RtsUtils.h"
 #include "Profiling.h"
 
@@ -53,6 +54,9 @@ open_stats_file (
 
 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.
@@ -65,15 +69,17 @@ void initRtsFlagsDefaults(void)
 
     RtsFlags.GcFlags.maxStkSize                = (8 * 1024 * 1024) / sizeof(W_);
     RtsFlags.GcFlags.initialStkSize    = 1024 / sizeof(W_);
+    RtsFlags.GcFlags.stkChunkSize       = (32 * 1024) / sizeof(W_);
+    RtsFlags.GcFlags.stkChunkBufferSize = (1 * 1024) / sizeof(W_);
 
     RtsFlags.GcFlags.minAllocAreaSize   = (512 * 1024)        / BLOCK_SIZE;
     RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
     RtsFlags.GcFlags.maxHeapSize       = 0;    /* off by default */
     RtsFlags.GcFlags.heapSizeSuggestion        = 0;    /* none */
+    RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsFalse;
     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;
@@ -190,14 +196,15 @@ usage_text[] = {
 "  --info   Print information about the RTS used by this program",
 "",
 "  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
-"  -k<size> Sets the initial thread stack size (default 1k)  Egs: -k4k   -k2m",
+"  -ki<size> Sets the initial thread stack size (default 1k)  Egs: -ki4k -ki2m",
+"  -kc<size> Sets the stack chunk size (default 32k)",
+"  -kb<size> Sets the stack chunk buffer size (default 1k)",
 "",
 "  -A<size> Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k",
 "  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
 "  -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%)",
@@ -252,18 +259,20 @@ usage_text[] = {
 "  -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)
@@ -301,7 +310,7 @@ usage_text[] = {
 "  -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 */
@@ -319,9 +328,6 @@ usage_text[] = {
 "  --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)
@@ -338,6 +344,8 @@ usage_text[] = {
 "            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.",
@@ -409,7 +417,13 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
        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
+            }
        }
     }
 
@@ -428,15 +442,21 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
            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];
-       }
-       else if (mode == PGM) {
+            rts_argv[(*rts_argc)++] = argv[arg];
+        }
+        else if (mode == PGM) {
            argv[(*argc)++] = argv[arg];
        }
        else {
@@ -458,7 +478,25 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
            error = rtsTrue;
 
         } else {
-           switch(rts_argv[arg][1]) {
+
+            switch(rts_argv[arg][1]) {
+            case '-':
+                if (strequal("info", &rts_argv[arg][2])) {
+                    printRtsInfo();
+                    stg_exit(0);
+                }
+                break;
+            default:
+                break;
+            }
+
+            if (rtsOptsEnabled != rtsOptsAll)
+            {
+                errorBelch("Most RTS options are disabled. Link with -rtsopts to enable them.");
+                stg_exit(EXIT_FAILURE);
+            }
+
+            switch(rts_argv[arg][1]) {
 
              /* process: general args, then PROFILING-only ones, then
                 CONCURRENT-only, TICKY-only (same order as defined in
@@ -471,7 +509,7 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
 # 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
 
@@ -479,7 +517,7 @@ error = rtsTrue;
 # 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
 
@@ -487,7 +525,7 @@ error = rtsTrue;
 # 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
 
@@ -495,7 +533,15 @@ error = rtsTrue;
 # 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
 
@@ -523,7 +569,7 @@ error = rtsTrue;
                   else if (strequal("info",
                                &rts_argv[arg][2])) {
                       printRtsInfo();
-                      exit(0);
+                      stg_exit(0);
                   }
                   else {
                      errorBelch("unknown RTS option: %s",rts_argv[arg]);
@@ -555,12 +601,18 @@ error = rtsTrue;
                  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] );
@@ -592,8 +644,8 @@ error = rtsTrue;
                  bad_option( rts_argv[arg] );
                break;
              
-#ifdef DEBUG
              case 'D':
+              DEBUG_BUILD_ONLY(
              { 
                  char *c;
 
@@ -651,21 +703,36 @@ error = rtsTrue;
                   // -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_WORD_MAX) / sizeof(W_);
+                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
                   break;
 
              case 'k':
+               switch(rts_argv[arg][2]) {
+                case 'c':
+                  RtsFlags.GcFlags.stkChunkSize =
+                      decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
+                  break;
+                case 'b':
+                  RtsFlags.GcFlags.stkChunkBufferSize =
+                      decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
+                  break;
+                case 'i':
+                  RtsFlags.GcFlags.initialStkSize =
+                      decodeSize(rts_argv[arg], 3, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
+                  break;
+                default:
                   RtsFlags.GcFlags.initialStkSize =
-                      decodeSize(rts_argv[arg], 2, 1, HS_WORD_MAX) / sizeof(W_);
+                      decodeSize(rts_argv[arg], 2, sizeof(W_), HS_WORD_MAX) / sizeof(W_);
                   break;
+                }
+                break;
 
-             case 'M':
+              case 'M':
                   RtsFlags.GcFlags.maxHeapSize =
                       decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE;
                   /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
@@ -684,15 +751,14 @@ error = rtsTrue;
                       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':
-               RtsFlags.GcFlags.heapSizeSuggestion =
-                    (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
-               break;
+                  if (rts_argv[arg][2] == '\0') {
+                      RtsFlags.GcFlags.heapSizeSuggestionAuto = rtsTrue;
+                  } else {
+                      RtsFlags.GcFlags.heapSizeSuggestion =
+                          (nat)(decodeSize(rts_argv[arg], 2, BLOCK_SIZE, HS_WORD_MAX) / BLOCK_SIZE);
+                  }
+                  break;
 
 #ifdef RTS_GTK_FRONTPANEL
              case 'f':
@@ -740,26 +806,6 @@ error = 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(
@@ -950,7 +996,7 @@ error = rtsTrue;
                 }
                 break;
 
-#if defined(THREADED_RTS) && !defined(NOSMP)
+#if !defined(NOSMP)
              case 'N':
                THREADED_BUILD_ONLY(
                if (rts_argv[arg][2] == '\0') {
@@ -990,6 +1036,7 @@ error = rtsTrue;
                     ) break;
 
              case 'q':
+               THREADED_BUILD_ONLY(
                    switch (rts_argv[arg][2]) {
                    case '\0':
                        errorBelch("incomplete RTS option: %s",rts_argv[arg]);
@@ -1028,7 +1075,7 @@ error = rtsTrue;
                        error = rtsTrue;
                        break;
                    }
-                   break;
+                    ) break;
 #endif
              /* =========== PARALLEL =========================== */
              case 'e':
@@ -1061,26 +1108,19 @@ error = rtsTrue;
 
              /* =========== 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 =================== */
 
@@ -1194,6 +1234,12 @@ error = rtsTrue;
         RtsFlags.ProfFlags.profileIntervalTicks = 0;
     }
 
+    if (RtsFlags.GcFlags.stkChunkBufferSize >
+        RtsFlags.GcFlags.stkChunkSize / 2) {
+        errorBelch("stack chunk buffer size (-kb) must be less than 50%% of the stack chunk size (-kc)");
+        error = rtsTrue;
+    }
+
     if (error) {
        const char **p;
 
@@ -1294,14 +1340,41 @@ decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max)
     val = (StgWord64)m;
 
     if (m < 0 || val < min || val > max) {
-        errorBelch("error in RTS option %s: size outside allowed range (%" FMT_Word64 " - %" FMT_Word64 ")", 
-                   flag, min, max);
+        // printf doesn't like 64-bit format specs on Windows
+        // apparently, so fall back to unsigned long.
+        errorBelch("error in RTS option %s: size outside allowed range (%lu - %lu)", flag, (lnat)min, (lnat)max);
         stg_exit(EXIT_FAILURE);
     }
 
     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)
 {
@@ -1384,3 +1457,18 @@ setFullProgArgv(int argc, char *argv[])
     full_prog_argv[argc] = NULL;
 }
 
+void
+freeFullProgArgv (void)
+{
+    int i;
+
+    if (full_prog_argv != NULL) {
+        for (i = 0; i < full_prog_argc; i++) {
+            stgFree(full_prog_argv[i]);
+        }
+        stgFree(full_prog_argv);
+    }
+
+    full_prog_argc = 0;
+    full_prog_argv = NULL;
+}