X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=rts%2FRtsFlags.c;h=14080702bf4560f2a3565de02841e49681ecbe73;hp=93482f50b43cd2dcc8e9d4aca91e4e85c01fd133;hb=2d4d636af091b8da27466b5cf90011395a9c2f66;hpb=ef4372dc0ad6232dd36a91c0f4f043de6231aa74 diff --git a/rts/RtsFlags.c b/rts/RtsFlags.c index 93482f5..1408070 100644 --- a/rts/RtsFlags.c +++ b/rts/RtsFlags.c @@ -13,6 +13,7 @@ #include "RtsOpts.h" #include "RtsUtils.h" #include "Profiling.h" +#include "RtsFlags.h" #ifdef HAVE_CTYPE_H #include @@ -33,6 +34,14 @@ char **full_prog_argv = NULL; char *prog_name = NULL; /* 'basename' of prog_argv[0] */ int rts_argc = 0; /* ditto */ char *rts_argv[MAX_RTS_ARGS]; +#if defined(mingw32_HOST_OS) +// On Windows, we want to use GetCommandLineW rather than argc/argv, +// but we need to mutate the command line arguments for withProgName and +// friends. The System.Environment module achieves that using this bit of +// shared state: +int win32_prog_argc = 0; +wchar_t **win32_prog_argv = NULL; +#endif /* * constants, used later @@ -44,20 +53,26 @@ char *rts_argv[MAX_RTS_ARGS]; Static function decls -------------------------------------------------------------------------- */ -static int /* return NULL on error */ -open_stats_file ( - I_ arg, - int argc, char *argv[], - int rts_argc, char *rts_argv[], - const char *FILENAME_FMT, - FILE **file_ret); +static void procRtsOpts (int rts_argc0, RtsOptsEnabledEnum enabled); + +static void normaliseRtsOpts (void); + +static void initStatsFile (FILE *f); + +static int openStatsFile (char *filename, const char *FILENAME_FMT, + FILE **file_ret); + +static StgWord64 decodeSize (const char *flag, nat offset, + StgWord64 min, StgWord64 max); + +static void bad_option (const char *s); -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 +static void errorUsage (void) GNU_ATTRIBUTE(__noreturn__); + /* ----------------------------------------------------------------------------- * Command-line option parsing routines. * ---------------------------------------------------------------------------*/ @@ -69,6 +84,8 @@ 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; @@ -154,7 +171,6 @@ void initRtsFlagsDefaults(void) #ifdef THREADED_RTS RtsFlags.ParFlags.nNodes = 1; RtsFlags.ParFlags.migrate = rtsTrue; - RtsFlags.ParFlags.wakeupMigrate = rtsFalse; RtsFlags.ParFlags.parGcEnabled = 1; RtsFlags.ParFlags.parGcGen = 0; RtsFlags.ParFlags.parGcLoadBalancingEnabled = rtsTrue; @@ -194,7 +210,9 @@ usage_text[] = { " --info Print information about the RTS used by this program", "", " -K Sets the maximum stack size (default 8M) Egs: -K32k -K512k", -" -k Sets the initial thread stack size (default 1k) Egs: -k4k -k2m", +" -ki Sets the initial thread stack size (default 1k) Egs: -ki4k -ki2m", +" -kc Sets the stack chunk size (default 32k)", +" -kb Sets the stack chunk buffer size (default 1k)", "", " -A Sets the minimum allocation area size (default 512k) Egs: -A1m -A10k", " -M Sets the maximum heap size (default unlimited) Egs: -M256k -M1G", @@ -302,7 +320,7 @@ usage_text[] = { " -Da DEBUG: apply", " -Dl DEBUG: linker", " -Dm DEBUG: stm", -" -Dz DEBUG: stack squezing", +" -Dz DEBUG: stack squeezing", " -Dc DEBUG: program coverage", " -Dr DEBUG: sparks", "", @@ -319,14 +337,10 @@ usage_text[] = { " (default: 1, -qb alone turns off load-balancing)", " -qa Use the OS to set thread affinity (experimental)", " -qm Don't automatically migrate threads between CPUs", -" -qw Migrate a thread to the current CPU when it is woken up", #endif " --install-signal-handlers=", " Install signal handlers (default: yes)", #if defined(THREADED_RTS) -" -e Size of spark pools (default 100)", -#endif -#if defined(THREADED_RTS) " -e Maximum number of outstanding local sparks (default: 4096)", #endif #if defined(x86_64_HOST_ARCH) @@ -343,6 +357,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.", @@ -359,8 +375,7 @@ strequal(const char *a, const char * b) return(strcmp(a, b) == 0); } -static void -splitRtsFlags(char *s, int *rts_argc, char *rts_argv[]) +static void splitRtsFlags(char *s) { char *c1, *c2; @@ -372,11 +387,11 @@ splitRtsFlags(char *s, int *rts_argc, char *rts_argv[]) if (c1 == c2) { break; } - if (*rts_argc < MAX_RTS_ARGS-1) { + if (rts_argc < MAX_RTS_ARGS-1) { s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()"); strncpy(s, c1, c2-c1); s[c2-c1] = '\0'; - rts_argv[(*rts_argc)++] = s; + rts_argv[rts_argc++] = s; } else { barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1); } @@ -385,27 +400,48 @@ splitRtsFlags(char *s, int *rts_argc, char *rts_argv[]) } while (*c1 != '\0'); } -void -setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) +/* ----------------------------------------------------------------------------- + Parse the command line arguments, collecting options for the RTS. + + On return: + - argv[] is *modified*, any RTS options have been stripped out + - *argc contains the new count of arguments in argv[] + + - rts_argv[] (global) contains the collected RTS args + - rts_argc (global) contains the count of args in rts_argv + + - prog_argv[] (global) contains the non-RTS args (== argv) + - prog_argc (global) contains the count of args in prog_argv + + - prog_name (global) contains the basename of argv[0] + + -------------------------------------------------------------------------- */ + +void setupRtsFlags (int *argc, char *argv[]) { - rtsBool error = rtsFalse; - I_ mode; - I_ arg, total_arg; + nat mode; + nat total_arg; + nat arg, rts_argc0; setProgName (argv); total_arg = *argc; arg = 1; *argc = 1; - *rts_argc = 0; + rts_argc = 0; + + rts_argc0 = rts_argc; // 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); - } + splitRtsFlags(ghc_rts_opts); + // opts from ghc_rts_opts are always enabled: + procRtsOpts(rts_argc0, RtsOptsAll); + rts_argc0 = rts_argc; + } } // process arguments from the GHCRTS environment variable next @@ -414,14 +450,15 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) char *ghc_rts = getenv("GHCRTS"); if (ghc_rts != NULL) { - if (rtsOptsEnabled) { - splitRtsFlags(ghc_rts, rts_argc, rts_argv); - } - else { + if (rtsOptsEnabled == RtsOptsNone) { errorBelch("Warning: Ignoring GHCRTS variable as RTS options are disabled.\n Link with -rtsopts to enable them."); // We don't actually exit, just warn + } else { + splitRtsFlags(ghc_rts); + procRtsOpts(rts_argc0, rtsOptsEnabled); + rts_argc0 = rts_argc; } - } + } } // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts @@ -439,21 +476,15 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) break; } else if (strequal("+RTS", argv[arg])) { - if (rtsOptsEnabled) { - mode = RTS; - } - else { - errorBelch("RTS options are disabled. Link with -rtsopts to enable them."); - stg_exit(EXIT_FAILURE); - } - } + 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) { + 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 { @@ -465,17 +496,62 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) argv[(*argc)++] = argv[arg]; } argv[*argc] = (char *) 0; - rts_argv[*rts_argc] = (char *) 0; + rts_argv[rts_argc] = (char *) 0; + + procRtsOpts(rts_argc0, rtsOptsEnabled); + + normaliseRtsOpts(); + + setProgArgv(*argc, argv); + + if (RtsFlags.GcFlags.statsFile != NULL) { + initStatsFile (RtsFlags.GcFlags.statsFile); + } + if (RtsFlags.TickyFlags.tickyFile != NULL) { + initStatsFile (RtsFlags.GcFlags.statsFile); + } +} + +/* ----------------------------------------------------------------------------- + * procRtsOpts: Process rts_argv between rts_argc0 and rts_argc. + * -------------------------------------------------------------------------- */ + +static void procRtsOpts (int rts_argc0, RtsOptsEnabledEnum enabled) +{ + rtsBool error = rtsFalse; + int arg; // Process RTS (rts_argv) part: mainly to determine statsfile - for (arg = 0; arg < *rts_argc; arg++) { - if (rts_argv[arg][0] != '-') { + for (arg = rts_argc0; arg < rts_argc; arg++) { + if (rts_argv[arg][0] != '-') { fflush(stdout); errorBelch("unexpected RTS argument: %s", rts_argv[arg]); error = rtsTrue; } else { - switch(rts_argv[arg][1]) { + + if (enabled == RtsOptsNone) { + errorBelch("RTS options are disabled. Link with -rtsopts to enable them."); + stg_exit(EXIT_FAILURE); + } + + switch(rts_argv[arg][1]) { + case '-': + if (strequal("info", &rts_argv[arg][2])) { + printRtsInfo(); + stg_exit(0); + } + break; + default: + break; + } + + if (enabled == RtsOptsSafeOnly) { + 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 @@ -548,7 +624,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]); @@ -580,12 +656,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] ); @@ -681,15 +763,31 @@ error = rtsTrue; 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* */ @@ -750,9 +848,8 @@ error = rtsTrue; stats: { int r; - r = open_stats_file(arg, *argc, argv, - *rts_argc, rts_argv, NULL, - &RtsFlags.GcFlags.statsFile); + r = openStatsFile(rts_argv[arg]+2, NULL, + &RtsFlags.GcFlags.statsFile); if (r == -1) { error = rtsTrue; } } break; @@ -1024,10 +1121,10 @@ error = rtsTrue; case 'm': RtsFlags.ParFlags.migrate = rtsFalse; break; - case 'w': - RtsFlags.ParFlags.wakeupMigrate = rtsTrue; - break; - default: + case 'w': + // -qw was removed; accepted for backwards compat + break; + default: errorBelch("unknown RTS option: %s",rts_argv[arg]); error = rtsTrue; break; @@ -1056,9 +1153,9 @@ error = rtsTrue; { int r; - r = open_stats_file(arg, *argc, argv, - *rts_argc, rts_argv, TICKY_FILENAME_FMT, - &RtsFlags.TickyFlags.tickyFile); + r = openStatsFile(rts_argv[arg]+2, + TICKY_FILENAME_FMT, + &RtsFlags.TickyFlags.tickyFile); if (r == -1) { error = rtsTrue; } } ) break; @@ -1143,6 +1240,16 @@ error = rtsTrue; } } + if (error) errorUsage(); +} + +/* ----------------------------------------------------------------------------- + * normaliseRtsOpts: Set some derived values, and make sure things are + * within sensible ranges. + * -------------------------------------------------------------------------- */ + +static void normaliseRtsOpts (void) +{ if (RtsFlags.MiscFlags.tickInterval < 0) { RtsFlags.MiscFlags.tickInterval = 50; } @@ -1191,16 +1298,22 @@ error = rtsTrue; RtsFlags.ProfFlags.profileIntervalTicks = 0; } - if (error) { - const char **p; - - fflush(stdout); - for (p = usage_text; *p; p++) - errorBelch("%s", *p); - stg_exit(EXIT_FAILURE); + 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)"); + errorUsage(); } } +static void errorUsage (void) +{ + const char **p; + + fflush(stdout); + for (p = usage_text; *p; p++) + errorBelch("%s", *p); + stg_exit(EXIT_FAILURE); +} static void stats_fprintf(FILE *f, char *s, ...) @@ -1215,49 +1328,62 @@ stats_fprintf(FILE *f, char *s, ...) va_end(ap); } -static int /* return -1 on error */ -open_stats_file ( - I_ arg, - int argc, char *argv[], - int rts_argc, char *rts_argv[], - const char *FILENAME_FMT, - FILE **file_ret) +/* ----------------------------------------------------------------------------- + * openStatsFile: open a file in which to put some runtime stats + * -------------------------------------------------------------------------- */ + +static int // return -1 on error +openStatsFile (char *filename, // filename, or NULL + const char *filename_fmt, // if filename == NULL, use + // this fmt with sprintf to + // generate the filename. %s + // expands to the program name. + FILE **file_ret) // return the FILE* { FILE *f = NULL; - if (strequal(rts_argv[arg]+2, "stderr") - || (FILENAME_FMT == NULL && rts_argv[arg][2] == '\0')) { + if (strequal(filename, "stderr") + || (filename_fmt == NULL && *filename == '\0')) { f = NULL; /* NULL means use debugBelch */ } else { - if (rts_argv[arg][2] != '\0') { /* stats file specified */ - f = fopen(rts_argv[arg]+2,"w"); + if (*filename != '\0') { /* stats file specified */ + f = fopen(filename,"w"); } else { char stats_filename[STATS_FILENAME_MAXLEN]; /* default . */ - sprintf(stats_filename, FILENAME_FMT, argv[0]); + sprintf(stats_filename, filename_fmt, prog_name); f = fopen(stats_filename,"w"); } if (f == NULL) { - errorBelch("Can't open stats file %s\n", rts_argv[arg]+2); + errorBelch("Can't open stats file %s\n", filename); return -1; } } *file_ret = f; - { - /* Write argv and rtsv into start of stats file */ - int count; - for(count = 0; count < argc; count++) { - stats_fprintf(f, "%s ", argv[count]); - } - stats_fprintf(f, "+RTS "); - for(count = 0; count < rts_argc; count++) - stats_fprintf(f, "%s ", rts_argv[count]); - stats_fprintf(f, "\n"); - } return 0; } +/* ----------------------------------------------------------------------------- + * initStatsFile: write a line to the file containing the program name + * and the arguments it was invoked with. +-------------------------------------------------------------------------- */ + +static void initStatsFile (FILE *f) +{ + /* Write prog_argv and rts_argv into start of stats file */ + int count; + for (count = 0; count < prog_argc; count++) { + stats_fprintf(f, "%s ", prog_argv[count]); + } + stats_fprintf(f, "+RTS "); + for (count = 0; count < rts_argc; count++) + stats_fprintf(f, "%s ", rts_argv[count]); + stats_fprintf(f, "\n"); +} +/* ----------------------------------------------------------------------------- + * decodeSize: parse a string containing a size, like 300K or 1.2M +-------------------------------------------------------------------------- */ static StgWord64 decodeSize(const char *flag, nat offset, StgWord64 min, StgWord64 max) @@ -1373,14 +1499,9 @@ getProgArgv(int *argc, char **argv[]) void setProgArgv(int argc, char *argv[]) { - /* Usually this is done by startupHaskell, so we don't need to call this. - However, sometimes Hugs wants to change the arguments which Haskell - getArgs >>= ... will be fed. So you can do that by calling here - _after_ calling startupHaskell. - */ - prog_argc = argc; - prog_argv = argv; - setProgName(prog_argv); + prog_argc = argc; + prog_argv = argv; + setProgName(prog_argv); } /* These functions record and recall the full arguments, including the @@ -1423,3 +1544,53 @@ freeFullProgArgv (void) full_prog_argc = 0; full_prog_argv = NULL; } + +#if defined(mingw32_HOST_OS) +void freeWin32ProgArgv (void); + +void +freeWin32ProgArgv (void) +{ + int i; + + if (win32_prog_argv != NULL) { + for (i = 0; i < win32_prog_argc; i++) { + stgFree(win32_prog_argv[i]); + } + stgFree(win32_prog_argv); + } + + win32_prog_argc = 0; + win32_prog_argv = NULL; +} + +void +getWin32ProgArgv(int *argc, wchar_t **argv[]) +{ + *argc = win32_prog_argc; + *argv = win32_prog_argv; +} + +void +setWin32ProgArgv(int argc, wchar_t *argv[]) +{ + int i; + + freeWin32ProgArgv(); + + win32_prog_argc = argc; + if (argv == NULL) { + win32_prog_argv = NULL; + return; + } + + win32_prog_argv = stgCallocBytes(argc + 1, sizeof (wchar_t *), + "setWin32ProgArgv 1"); + for (i = 0; i < argc; i++) { + win32_prog_argv[i] = stgMallocBytes((wcslen(argv[i]) + 1) * sizeof(wchar_t), + "setWin32ProgArgv 2"); + wcscpy(win32_prog_argv[i], argv[i]); + } + win32_prog_argv[argc] = NULL; +} +#endif