X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Frts%2FRtsFlags.c;h=f24912fe46777204542aa97fffd178161f443680;hb=eba7b660a36878cd8d926845807913d7ec5734c9;hp=65cf5019b014a3dfec0b80890a586583442ac7d4;hpb=17315bf6c11c17ad38ca5a65d7e938ac32d07d8a;p=ghc-hetmet.git diff --git a/ghc/rts/RtsFlags.c b/ghc/rts/RtsFlags.c index 65cf501..f24912f 100644 --- a/ghc/rts/RtsFlags.c +++ b/ghc/rts/RtsFlags.c @@ -1,5 +1,5 @@ + /* ----------------------------------------------------------------------------- - * $Id: RtsFlags.c,v 1.19 1999/09/15 13:45:19 simonmar Exp $ * * (c) The AQUA Project, Glasgow University, 1994-1997 * (c) The GHC Team, 1998-1999 @@ -8,54 +8,138 @@ * * ---------------------------------------------------------------------------*/ +//@menu +//* Includes:: +//* Constants:: +//* Static function decls:: +//* Command-line option parsing routines:: +//* GranSim specific options:: +//* Aux fcts:: +//@end menu +//*/ + +//@node Includes, Constants +//@subsection Includes + +#include "PosixSource.h" #include "Rts.h" #include "RtsFlags.h" #include "RtsUtils.h" #include "BlockAlloc.h" -#include "ProfRts.h" +#include "Timer.h" /* CS_MIN_MILLISECS */ +#include "Profiling.h" -#if defined(PROFILING) -#include "Itimer.h" +#ifdef HAVE_CTYPE_H +#include #endif -#if HAVE_STDLIB_H #include -#endif - -#ifdef HAVE_STRING_H #include -#endif -extern struct RTS_FLAGS RtsFlags; +// Flag Structure +RTS_FLAGS RtsFlags; /* * Split argument lists */ -int prog_argc; /* an "int" so as to match normal "argc" */ +int prog_argc = 0; /* an "int" so as to match normal "argc" */ char **prog_argv = NULL; -int rts_argc; /* ditto */ +char *prog_name = NULL; /* 'basename' of prog_argv[0] */ +int rts_argc = 0; /* ditto */ char *rts_argv[MAX_RTS_ARGS]; +//@node Constants, Static function decls, Includes +//@subsection Constants + /* * constants, used later */ #define RTS 1 #define PGM 0 +#if defined(GRAN) + +static char *gran_debug_opts_strs[] = { + "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 */ +static char gran_debug_opts_flags[] = { + 'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't' +}; + +#elif defined(PAR) + +static char *par_debug_opts_strs[] = { + "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n", + "DEBUG (-qDq, -qD2): bq; print blocking queues.\n", + "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n", + "DEBUG (-qDe, -qD8): free; free messages.\n", + "DEBUG (-qDr, -qD16): resume; resume messages.\n", + "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n", + "DEBUG (-qDF, -qD64): fetch; fetch messages.\n", + // "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", + "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n", + "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n" +}; + +/* one character codes for the available debug options */ +static char par_debug_opts_flags[] = { + 'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z' +}; + +#endif /* PAR */ + +//@node Static function decls, Command-line option parsing routines, Constants +//@subsection Static function decls + /* ----------------------------------------------------------------------------- Static function decls -------------------------------------------------------------------------- */ -static FILE * /* return NULL on error */ +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); + const char *FILENAME_FMT, + FILE **file_ret); static I_ decode(const char *s); static void bad_option(const char *s); +#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 + +//@node Command-line option parsing routines, GranSim specific options, Static function decls +//@subsection Command-line option parsing routines + /* ----------------------------------------------------------------------------- * Command-line option parsing routines. * ---------------------------------------------------------------------------*/ @@ -65,119 +149,171 @@ void initRtsFlagsDefaults(void) RtsFlags.GcFlags.statsFile = NULL; RtsFlags.GcFlags.giveStats = NO_GC_STATS; - RtsFlags.GcFlags.maxStkSize = (1024 * 1024) / sizeof(W_); + RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_); RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_); - RtsFlags.GcFlags.minAllocAreaSize = (256 * 1024) / BLOCK_SIZE; + RtsFlags.GcFlags.minAllocAreaSize = (512 * 1024) / BLOCK_SIZE; RtsFlags.GcFlags.minOldGenSize = (1024 * 1024) / BLOCK_SIZE; - RtsFlags.GcFlags.maxHeapSize = (64 * 1024 * 1024) / BLOCK_SIZE; + RtsFlags.GcFlags.maxHeapSize = 0; /* off by default */ RtsFlags.GcFlags.heapSizeSuggestion = 0; /* none */ RtsFlags.GcFlags.pcFreeHeap = 3; /* 3% */ RtsFlags.GcFlags.oldGenFactor = 2; +#if defined(PAR) + /* A hack currently needed for GUM -- HWL */ + RtsFlags.GcFlags.generations = 1; + RtsFlags.GcFlags.steps = 2; + RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse; +#else RtsFlags.GcFlags.generations = 2; RtsFlags.GcFlags.steps = 2; - - RtsFlags.GcFlags.forceGC = rtsFalse; - RtsFlags.GcFlags.forcingInterval = 5000000; /* 5MB (or words?) */ - RtsFlags.GcFlags.ringBell = rtsFalse; - RtsFlags.GcFlags.squeezeUpdFrames = rtsTrue; +#endif + RtsFlags.GcFlags.compact = rtsFalse; + RtsFlags.GcFlags.compactThreshold = 30.0; +#ifdef RTS_GTK_FRONTPANEL + RtsFlags.GcFlags.frontpanel = rtsFalse; +#endif + RtsFlags.GcFlags.idleGCDelayTicks = 300 / TICK_MILLISECS; /* ticks */ + +#ifdef DEBUG + RtsFlags.DebugFlags.scheduler = rtsFalse; + RtsFlags.DebugFlags.interpreter = rtsFalse; + RtsFlags.DebugFlags.codegen = rtsFalse; + 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; + RtsFlags.DebugFlags.stm = rtsFalse; + RtsFlags.DebugFlags.prof = rtsFalse; + RtsFlags.DebugFlags.gran = rtsFalse; + RtsFlags.DebugFlags.par = rtsFalse; + RtsFlags.DebugFlags.linker = rtsFalse; + RtsFlags.DebugFlags.squeeze = rtsFalse; +#endif #if defined(PROFILING) || defined(PAR) RtsFlags.CcFlags.doCostCentres = 0; - RtsFlags.CcFlags.sortBy = SORTCC_TIME; #endif /* PROFILING or PAR */ #ifdef PROFILING - RtsFlags.ProfFlags.doHeapProfile = rtsFalse; - - RtsFlags.ProfFlags.ccSelector = NULL; - RtsFlags.ProfFlags.modSelector = NULL; - RtsFlags.ProfFlags.grpSelector = NULL; - RtsFlags.ProfFlags.descrSelector = NULL; - RtsFlags.ProfFlags.typeSelector = NULL; - RtsFlags.ProfFlags.kindSelector = NULL; + RtsFlags.ProfFlags.doHeapProfile = rtsFalse; + RtsFlags.ProfFlags.profileInterval = 100; + RtsFlags.ProfFlags.includeTSOs = rtsFalse; + RtsFlags.ProfFlags.showCCSOnException = rtsFalse; + RtsFlags.ProfFlags.maxRetainerSetSize = 8; + RtsFlags.ProfFlags.modSelector = NULL; + RtsFlags.ProfFlags.descrSelector = NULL; + RtsFlags.ProfFlags.typeSelector = NULL; + RtsFlags.ProfFlags.ccSelector = NULL; + RtsFlags.ProfFlags.ccsSelector = NULL; + RtsFlags.ProfFlags.retainerSelector = NULL; + RtsFlags.ProfFlags.bioSelector = NULL; + #elif defined(DEBUG) - RtsFlags.ProfFlags.doHeapProfile = rtsFalse; + RtsFlags.ProfFlags.doHeapProfile = rtsFalse; #endif RtsFlags.ConcFlags.ctxtSwitchTime = CS_MIN_MILLISECS; /* In milliseconds */ + +#ifdef THREADED_RTS + RtsFlags.ParFlags.nNodes = 1; +#endif + #ifdef PAR - RtsFlags.ParFlags.parallelStats = rtsFalse; - RtsFlags.ParFlags.granSimStats = rtsFalse; - RtsFlags.ParFlags.granSimStats_Binary = rtsFalse; + RtsFlags.ParFlags.ParStats.Full = rtsFalse; + RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse; + 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; RtsFlags.ParFlags.outputDisabled = rtsFalse; - +#ifdef DIST + RtsFlags.ParFlags.doFairScheduling = rtsTrue; /* fair sched by def */ +#else + RtsFlags.ParFlags.doFairScheduling = rtsFalse; /* unfair sched by def */ +#endif RtsFlags.ParFlags.packBufferSize = 1024; + RtsFlags.ParFlags.thunksToPack = 1; /* 0 ... infinity; */ + RtsFlags.ParFlags.globalising = 1; /* 0 ... everything */ + RtsFlags.ParFlags.maxThreads = 1024; + RtsFlags.ParFlags.maxFishes = MAX_FISHES; + RtsFlags.ParFlags.fishDelay = FISH_DELAY; +#endif + +#if defined(PAR) || defined(THREADED_RTS) RtsFlags.ParFlags.maxLocalSparks = 4096; -#endif /* PAR */ +#endif /* PAR || THREADED_RTS */ + +#if defined(GRAN) + /* ToDo: check defaults for GranSim and GUM */ + RtsFlags.GcFlags.maxStkSize = (8 * 1024 * 1024) / sizeof(W_); + RtsFlags.GcFlags.initialStkSize = 1024 / sizeof(W_); + + RtsFlags.GranFlags.maxThreads = 65536; // refers to mandatory threads + 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; -#ifdef GRAN - RtsFlags.GranFlags.granSimStats = rtsFalse; - RtsFlags.GranFlags.granSimStats_suppressed = rtsFalse; - RtsFlags.GranFlags.granSimStats_Binary = rtsFalse; - RtsFlags.GranFlags.granSimStats_Sparks = rtsFalse; - RtsFlags.GranFlags.granSimStats_Heap = rtsFalse; - RtsFlags.GranFlags.labelling = rtsFalse; RtsFlags.GranFlags.packBufferSize = 1024; RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE; - RtsFlags.GranFlags.proc = MAX_PROC; - RtsFlags.GranFlags.max_fishes = MAX_FISHES; - RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE; - RtsFlags.GranFlags.Light = rtsFalse; - - RtsFlags.GranFlags.gran_latency = LATENCY; - RtsFlags.GranFlags.gran_additional_latency = ADDITIONAL_LATENCY; - RtsFlags.GranFlags.gran_fetchtime = FETCHTIME; - RtsFlags.GranFlags.gran_lunblocktime = LOCALUNBLOCKTIME; - RtsFlags.GranFlags.gran_gunblocktime = GLOBALUNBLOCKTIME; - RtsFlags.GranFlags.gran_mpacktime = MSGPACKTIME; - RtsFlags.GranFlags.gran_munpacktime = MSGUNPACKTIME; - RtsFlags.GranFlags.gran_mtidytime = MSGTIDYTIME; - - RtsFlags.GranFlags.gran_threadcreatetime = THREADCREATETIME; - RtsFlags.GranFlags.gran_threadqueuetime = THREADQUEUETIME; - RtsFlags.GranFlags.gran_threaddescheduletime = THREADDESCHEDULETIME; - RtsFlags.GranFlags.gran_threadscheduletime = THREADSCHEDULETIME; - RtsFlags.GranFlags.gran_threadcontextswitchtime = THREADCONTEXTSWITCHTIME; - - RtsFlags.GranFlags.gran_arith_cost = ARITH_COST; - RtsFlags.GranFlags.gran_branch_cost = BRANCH_COST; - RtsFlags.GranFlags.gran_load_cost = LOAD_COST; - RtsFlags.GranFlags.gran_store_cost = STORE_COST; - RtsFlags.GranFlags.gran_float_cost = FLOAT_COST; - - RtsFlags.GranFlags.gran_heapalloc_cost = HEAPALLOC_COST; - - RtsFlags.GranFlags.gran_pri_spark_overhead = PRI_SPARK_OVERHEAD; - RtsFlags.GranFlags.gran_pri_sched_overhead = PRI_SCHED_OVERHEAD; - - RtsFlags.GranFlags.DoFairSchedule = rtsFalse; - RtsFlags.GranFlags.DoReScheduleOnFetch = rtsFalse; - RtsFlags.GranFlags.DoStealThreadsFirst = rtsFalse; - RtsFlags.GranFlags.SimplifiedFetch = rtsFalse; - RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsFalse; - RtsFlags.GranFlags.DoGUMMFetching = rtsFalse; - RtsFlags.GranFlags.DoThreadMigration = rtsFalse; - RtsFlags.GranFlags.FetchStrategy = 2; + 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; RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse; - 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; - RtsFlags.GranFlags.NoForward = rtsFalse; - RtsFlags.GranFlags.PrintFetchMisses = rtsFalse; - - RtsFlags.GranFlags.debug = 0x0; - RtsFlags.GranFlags.event_trace = rtsFalse; - RtsFlags.GranFlags.event_trace_all = rtsFalse; + 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; #endif #ifdef TICKY_TICKY @@ -198,55 +334,68 @@ usage_text[] = { "", "The following run time system options are available:", "", -" -? -f Prints this message and exits; the program is not executed", +" -? Prints this message and exits; the program is not executed", "", -" -K Sets the maximum stack size (default 1M) Egs: -K32k -K512k", -" -k Sets the initial thread stack size (default 1k) Egs: -K4k -K2m", +" -K Sets the maximum stack size (default 8M) Egs: -K32k -K512k", +" -k Sets the initial thread stack size (default 1k) Egs: -k4k -k2m", "", " -A Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k", -" -M Sets the maximum heap size (default 64M) Egs: -M256k -M1G", +" -M Sets the maximum heap size (default unlimited) Egs: -M256k -M1G", " -H Sets the minimum heap size (default 0M) Egs: -H24m -H1G", -" -m% Minimum % of heap which must be available (default 3%)", +" -m Minimum % of heap which must be available (default 3%)", " -G Number of generations (default: 2)", " -T Number of steps in younger generations (default: 2)", -" -s Summary GC statistics (default file: .stat)", -" -S Detailed GC statistics (with -Sstderr going to stderr)", +" -c Auto-enable compaction of the oldest generation when live data is", +" at least % of the maximum heap size set with -M (default: 30%)", +" -c Enable compaction for all major collections", +#if defined(THREADED_RTS) +" -I Perform full GC after idle time (default: 0.3, 0 == off)", +#endif +"", +" -t One-line GC statistics (default file: .stat)", +" -s Summary GC statistics (with -Sstderr going to stderr)", +" -S Detailed GC statistics", +#ifdef RTS_GTK_FRONTPANEL +" -f Display front panel (requires X11 & GTK+)", +#endif "", "", " -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) "", -" -p Produce cost centre time profile (output file .prof)", -" sort: T = time (default), A = alloc, C = cost centre label", -" -P Produce serial time profile (output file .time)", -" and a -p profile with detailed tick/alloc info", +" -px Time/allocation profile (XML) (output file .prof)", +" -p Time/allocation profile (output file .prof)", +" -P More detailed Time/Allocation profile", +" -Pa Give information about *all* cost centres", + # if defined(PROFILING) "", -" -h Heap residency profile (output file .hp)", -" break-down: C = cost centre stack (default), M = module, G = group", -" D = closure description, Y = type description", -" T, = time closure created", -" ints: no. of interval bands plotted (default 18)", -" start: seconds after which intervals start (default 0.0)", -" A subset of closures may be selected by the attached cost centre using:", -" -c{mod:lab,mod:lab...}, specific module:label cost centre(s)", -" -m{mod,mod...} all cost centres from the specified modules(s)", -" -g{grp,grp...} all cost centres from the specified group(s)", -" Selections can also be made by description, type, kind and age:", -" -d{des,des...} closures with specified closure descriptions", -" -y{typ,typ...} closures with specified type descriptions", -" -k{knd,knd...} closures of the specified kinds", -" -a closures which survived complete intervals", -" The selection logic used is summarised as follows:", -" ([-c] or [-m] or [-g]) and ([-d] or [-y] or [-k]) and [-a]", -" where an option is true if not specified", -# endif +" -hx Heap residency profile (XML) (output file .prof)", +" -h Heap residency profile (hp2ps) (output file .hp)", +" break-down: c = cost centre stack (default)", +" m = module", +" d = closure description", +" y = type description", +" r = retainer", +" b = biography (LAG,DRAG,VOID,USE)", +" A subset of closures may be selected thusly:", +" -hc,... specific cost centre(s) (top of stack only)", +" -hC,... specific cost centre(s) (anywhere in stack)", +" -hm... all cost centres from the specified modules(s)", +" -hd,... closures with specified closure descriptions", +" -hy... closures with specified type descriptions", +" -hr... closures with specified retainers", +" -hb... closures with specified biographies (lag,drag,void,use)", +"", +" -R Set the maximum retainer set size (default: 8)", "", -" -z set hash table for (C, M, G, D or Y)", +" -i Time between heap samples (seconds, default: 0.1)", "", -" -i Number of seconds in a profiling interval (default 1.0):", -" heap profile (-h) and/or serial time profile (-P) frequency", +" -xt Include threads (TSOs) in a heap profile", +"", +" -xc Show current cost centre stack on raising an exception", +# endif #endif /* PROFILING or PAR */ #if !defined(PROFILING) && defined(DEBUG) "", @@ -260,25 +409,57 @@ usage_text[] = { " -r Produce reduction profiling statistics (with -rstderr for stderr)", "", #endif -# ifdef PAR +#if defined(PAR) " -N Use PVMish processors in parallel (default: 2)", /* NB: the -N is implemented by the driver!! */ -# endif +#endif " -C Context-switch interval in seconds", " (0 or no argument means switch as often as possible)", -" the default is .01 sec; resolution is .01 sec", -# ifdef PAR -" -q Enable activity profile (output files in ~/*.gr)", -" -qb Enable binary activity profile (output file /tmp/.gb)", -" -Q Set pack-buffer size (default: 1024)", -# endif -# ifdef PAR +" the default is .02 sec; resolution is .02 sec", +"", +#if defined(DEBUG) +" -Ds DEBUG: scheduler", +" -Di DEBUG: interpreter", +" -Dc DEBUG: codegen", +" -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", +" -Dm DEBUG: stm", +" -Dz DEBUG: stack squezing", +"", +#endif /* DEBUG */ +#if defined(THREADED_RTS) +" -N Use OS threads (default: 1)", +#endif +#if defined(THREADED_RTS) || defined(PAR) +" -e Size of spark pools (default 100)", +#endif +#if defined(PAR) +" -t Set maximum number of advisory threads per PE (default 32)", +" -qP Enable activity profile (output files in ~/*.gr)", +" -qQ Set pack-buffer size (default: 1024)", +" -qd Turn on PVM-ish debugging", +" -qO Disable output for performance measurement", +#endif +#if defined(THREADED_RTS) || defined(PAR) +" -e Maximum number of outstanding local sparks (default: 4096)", +#endif +#if defined(PAR) " -d Turn on PVM-ish debugging", " -O Disable output for performance measurement", -# endif /* PAR */ -# ifdef GRAN /* ToDo: fill in decent Docu here */ +#endif /* PAR */ +#if defined(GRAN) /* ToDo: fill in decent Docu here */ " -b... All GranSim options start with -b; see GranSim User's Guide for details", -# endif +#endif +"", +"RTS options may also be specified using the GHCRTS environment variable.", "", "Other RTS options may be available for programs compiled a different way.", "The GHC User's Guide has full details.", @@ -286,36 +467,86 @@ usage_text[] = { 0 }; -static __inline__ rtsBool +STATIC_INLINE rtsBool strequal(const char *a, const char * b) { return(strcmp(a, b) == 0); } +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) { + s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()"); + 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'); +} + void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) { rtsBool error = rtsFalse; I_ mode; I_ arg, total_arg; - char *last_slash; - - /* Remove directory from argv[0] -- default files in current directory */ - - if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL) - strcpy(argv[0], last_slash+1); - - /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */ - /* argv[0] must be PGM argument -- leave in argv */ + setProgName (argv); total_arg = *argc; arg = 1; *argc = 1; *rts_argc = 0; - for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) { - if (strequal("+RTS", argv[arg])) { + // 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); + } + } + + // process arguments from the GHCRTS environment variable next + // (arguments from the command line override these). + { + char *ghc_rts = getenv("GHCRTS"); + + if (ghc_rts != NULL) { + splitRtsFlags(ghc_rts, rts_argc, rts_argv); + } + } + + // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts + // argv[0] must be PGM argument -- leave in argv + + 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])) { mode = RTS; } else if (strequal("-RTS", argv[arg])) { @@ -331,22 +562,18 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1); } } - if (arg < total_arg) { - /* arg must be --RTS; process remaining program arguments */ - while (++arg < total_arg) { - argv[(*argc)++] = argv[arg]; - } + // process remaining program arguments + for (; arg < total_arg; arg++) { + argv[(*argc)++] = argv[arg]; } argv[*argc] = (char *) 0; rts_argv[*rts_argc] = (char *) 0; - /* Process RTS (rts_argv) part: mainly to determine statsfile */ - + // Process RTS (rts_argv) part: mainly to determine statsfile for (arg = 0; arg < *rts_argc; arg++) { if (rts_argv[arg][0] != '-') { fflush(stdout); - fprintf(stderr, "setupRtsFlags: Unexpected RTS argument: %s\n", - rts_argv[arg]); + errorBelch("unexpected RTS argument: %s", rts_argv[arg]); error = rtsTrue; } else { @@ -357,13 +584,14 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]) TICKY-only (same order as defined in RtsFlags.lh); within those groups, mostly in case-insensitive alphabetical order. + Final group is x*, which allows for more options. */ #ifdef TICKY_TICKY # define TICKY_BUILD_ONLY(x) x #else # define TICKY_BUILD_ONLY(x) \ -fprintf(stderr, "setupRtsFlags: GHC not built for: ticky-ticky stats\n"); \ +errorBelch("not built for: ticky-ticky stats"); \ error = rtsTrue; #endif @@ -371,7 +599,7 @@ error = rtsTrue; # define COST_CENTRE_USING_BUILD_ONLY(x) x #else # define COST_CENTRE_USING_BUILD_ONLY(x) \ -fprintf(stderr, "setupRtsFlags: GHC not built for: -prof or -parallel\n"); \ +errorBelch("not built for: -prof or -parallel"); \ error = rtsTrue; #endif @@ -379,7 +607,7 @@ error = rtsTrue; # define PROFILING_BUILD_ONLY(x) x #else # define PROFILING_BUILD_ONLY(x) \ -fprintf(stderr, "setupRtsFlags: GHC not built for: -prof\n"); \ +errorBelch("not built for: -prof"); \ error = rtsTrue; #endif @@ -387,7 +615,23 @@ error = rtsTrue; # define PAR_BUILD_ONLY(x) x #else # define PAR_BUILD_ONLY(x) \ -fprintf(stderr, "setupRtsFlags: GHC not built for: -parallel\n"); \ +errorBelch("not built for: -parallel"); \ +error = rtsTrue; +#endif + +#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 +#else +# define PAR_OR_THREADED_BUILD_ONLY(x) \ +errorBelch("not built for: -parallel or -smp"); \ error = rtsTrue; #endif @@ -395,13 +639,12 @@ error = rtsTrue; # define GRAN_BUILD_ONLY(x) x #else # define GRAN_BUILD_ONLY(x) \ -fprintf(stderr, "setupRtsFlags: GHC not built for: -gransim\n"); \ +errorBelch("not built for: -gransim"); \ error = rtsTrue; #endif /* =========== GENERAL ========================== */ case '?': - case 'f': error = rtsTrue; break; @@ -417,6 +660,15 @@ error = rtsTrue; RtsFlags.GcFlags.ringBell = rtsTrue; break; + case 'c': + if (rts_argv[arg][2] != '\0') { + RtsFlags.GcFlags.compactThreshold = + atof(rts_argv[arg]+2); + } else { + RtsFlags.GcFlags.compact = rtsTrue; + } + break; + case 'F': RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2); @@ -426,21 +678,65 @@ error = rtsTrue; #ifdef DEBUG case 'D': - /* hack warning: interpret the flags as a binary number */ - { - I_ n = decode(rts_argv[arg]+2); - if (n &1) RtsFlags.DebugFlags.scheduler = rtsTrue; - if ((n>>1)&1) RtsFlags.DebugFlags.evaluator = rtsTrue; - if ((n>>2)&1) RtsFlags.DebugFlags.codegen = rtsTrue; - if ((n>>3)&1) RtsFlags.DebugFlags.weak = rtsTrue; - if ((n>>4)&1) RtsFlags.DebugFlags.gccafs = rtsTrue; - if ((n>>5)&1) RtsFlags.DebugFlags.gc = rtsTrue; - if ((n>>6)&1) RtsFlags.DebugFlags.block_alloc = rtsTrue; - if ((n>>7)&1) RtsFlags.DebugFlags.sanity = rtsTrue; - if ((n>>8)&1) RtsFlags.DebugFlags.stable = rtsTrue; - if ((n>>9)&1) RtsFlags.DebugFlags.prof = rtsTrue; - } - break; + { + char *c; + + for (c = rts_argv[arg] + 2; *c != '\0'; c++) { + switch (*c) { + case 's': + RtsFlags.DebugFlags.scheduler = rtsTrue; + break; + case 'i': + RtsFlags.DebugFlags.interpreter = rtsTrue; + break; + case 'c': + RtsFlags.DebugFlags.codegen = rtsTrue; + 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; + case 'a': + RtsFlags.DebugFlags.apply = rtsTrue; + break; + case 'm': + RtsFlags.DebugFlags.stm = rtsTrue; + break; + case 'z': + RtsFlags.DebugFlags.squeeze = rtsTrue; + break; + default: + bad_option( rts_argv[arg] ); + } + } + break; + } #endif case 'K': @@ -500,31 +796,56 @@ error = rtsTrue; } break; - case 'j': /* force GC option */ - RtsFlags.GcFlags.forceGC = rtsTrue; - if (rts_argv[arg][2]) { - RtsFlags.GcFlags.forcingInterval - = decode(rts_argv[arg]+2) / sizeof(W_); +#ifdef RTS_GTK_FRONTPANEL + case 'f': + RtsFlags.GcFlags.frontpanel = rtsTrue; + break; +#endif + + case 'I': /* idle GC delay */ + if (rts_argv[arg][2] == '\0') { + /* use default */ + } else { + I_ cst; /* tmp */ + + /* Convert to ticks */ + cst = (I_) ((atof(rts_argv[arg]+2) * 1000)); + if (cst > 0 && cst < TICK_MILLISECS) { + cst = TICK_MILLISECS; + } else { + cst = cst / TICK_MILLISECS; + } + RtsFlags.GcFlags.idleGCDelayTicks = cst; } break; case 'S': - RtsFlags.GcFlags.giveStats ++; + RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS; + goto stats; case 's': - RtsFlags.GcFlags.giveStats ++; + RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS; + goto stats; + + case 't': + RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS; + goto stats; + + stats: #ifdef PAR /* Opening all those files would almost certainly fail... */ - RtsFlags.ParFlags.parallelStats = rtsTrue; - RtsFlags.GcFlags.statsFile = stderr; /* temporary; ToDo: rm */ + // RtsFlags.ParFlags.ParStats.Full = rtsTrue; + RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */ #else - RtsFlags.GcFlags.statsFile - = open_stats_file(arg, *argc, argv, - *rts_argc, rts_argv, STAT_FILENAME_FMT); - - if (RtsFlags.GcFlags.statsFile == NULL) error = rtsTrue; + { + int r; + r = open_stats_file(arg, *argc, argv, + *rts_argc, rts_argv, STAT_FILENAME_FMT, + &RtsFlags.GcFlags.statsFile); + if (r == -1) { error = rtsTrue; } + } #endif - break; + break; case 'Z': RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse; @@ -533,31 +854,31 @@ error = rtsTrue; /* =========== PROFILING ========================== */ case 'P': /* detailed cost centre profiling (time/alloc) */ - COST_CENTRE_USING_BUILD_ONLY( - RtsFlags.CcFlags.doCostCentres++; - ) case 'p': /* cost centre profiling (time/alloc) */ COST_CENTRE_USING_BUILD_ONLY( - RtsFlags.CcFlags.doCostCentres++; - switch (rts_argv[arg][2]) { - case SORTCC_LABEL: - case SORTCC_TIME: - case SORTCC_ALLOC: - RtsFlags.CcFlags.sortBy = rts_argv[arg][2]; + case 'x': + RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML; break; - default: - RtsFlags.CcFlags.sortBy = SORTCC_TIME; + case 'a': + RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL; break; + default: + if (rts_argv[arg][1] == 'P') { + RtsFlags.CcFlags.doCostCentres = + COST_CENTRES_VERBOSE; + } else { + RtsFlags.CcFlags.doCostCentres = + COST_CENTRES_SUMMARY; + } + break; } ) break; - case 'i': /* serial profiling -- initial timer interval */ - COST_CENTRE_USING_BUILD_ONLY( - interval_ticks = (I_) ((atof(rts_argv[arg]+2) * TICK_FREQUENCY)); - if (interval_ticks <= 0) - interval_ticks = 1; - ) break; + case 'R': + PROFILING_BUILD_ONLY( + RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2); + ) break; case 'h': /* serial heap profile */ #if !defined(PROFILING) && defined(DEBUG) @@ -570,136 +891,134 @@ error = rtsTrue; RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE; break; default: - fprintf(stderr, "Invalid heap profile option: %s\n", - rts_argv[arg]); + errorBelch("invalid heap profile option: %s",rts_argv[arg]); error = rtsTrue; } #else PROFILING_BUILD_ONLY( switch (rts_argv[arg][2]) { - case '\0': - case CCchar: - RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS; - break; - case MODchar: - RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD; - break; - case GRPchar: - RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_GRP; - break; - case DESCRchar: - RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR; - break; - case TYPEchar: - RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE; - break; - case TIMEchar: - RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TIME; - if (rts_argv[arg][3]) { - char *start_str = strchr(rts_argv[arg]+3, ','); - I_ intervals; - if (start_str) *start_str = '\0'; - - if ((intervals = decode(rts_argv[arg]+3)) != 0) { - time_intervals = (hash_t) intervals; - /* ToDo: and what if it *is* zero intervals??? */ - } - if (start_str) { - earlier_ticks = (I_)((atof(start_str + 1) * TICK_FREQUENCY)); + 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], '}'); + + // 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; + case 'C': + RtsFlags.ProfFlags.ccsSelector = left; + break; + 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; + } } + break; } - break; - default: - fprintf(stderr, "Invalid heap profile option: %s\n", - rts_argv[arg]); - error = rtsTrue; - } - ) -#endif - break; - case 'z': /* size of index tables */ - PROFILING_BUILD_ONLY( - switch (rts_argv[arg][2]) { - case CCchar: - max_cc_no = (hash_t) decode(rts_argv[arg]+3); - if (max_cc_no == 0) { - fprintf(stderr, "Bad number of cost centres %s\n", rts_argv[arg]); - error = rtsTrue; - } - break; - case MODchar: - max_mod_no = (hash_t) decode(rts_argv[arg]+3); - if (max_mod_no == 0) { - fprintf(stderr, "Bad number of modules %s\n", rts_argv[arg]); - error = rtsTrue; - } - break; - case GRPchar: - max_grp_no = (hash_t) decode(rts_argv[arg]+3); - if (max_grp_no == 0) { - fprintf(stderr, "Bad number of groups %s\n", rts_argv[arg]); - error = rtsTrue; - } - break; - case DESCRchar: - max_descr_no = (hash_t) decode(rts_argv[arg]+3); - if (max_descr_no == 0) { - fprintf(stderr, "Bad number of closure descriptions %s\n", rts_argv[arg]); + if (RtsFlags.ProfFlags.doHeapProfile != 0) { + errorBelch("multiple heap profile options"); error = rtsTrue; + break; } - break; - case TYPEchar: - max_type_no = (hash_t) decode(rts_argv[arg]+3); - if (max_type_no == 0) { - fprintf(stderr, "Bad number of type descriptions %s\n", rts_argv[arg]); - error = rtsTrue; + + switch (rts_argv[arg][2]) { + case '\0': + case 'C': + case 'c': + RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS; + break; + case 'M': + case 'm': + RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD; + break; + case 'D': + case 'd': + RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR; + break; + case 'Y': + case 'y': + RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE; + break; + case 'R': + case 'r': + RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER; + break; + case 'B': + case 'b': + RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV; + break; } break; - default: - fprintf(stderr, "Invalid index table size option: %s\n", - rts_argv[arg]); + + default: + errorBelch("invalid heap profile option: %s",rts_argv[arg]); error = rtsTrue; } - ) break; - - case 'c': /* cost centre label select */ - case 'g': /* cost centre group select */ - case 'd': /* closure descr select */ - case 'y': /* closure type select */ - PROFILING_BUILD_ONLY( - {char *left = strchr(rts_argv[arg], '{'); - char *right = strrchr(rts_argv[arg], '}'); + ) +#endif /* PROFILING */ + break; - if (! left || ! right || - strrchr(rts_argv[arg], '{') != left || - strchr(rts_argv[arg], '}') != right) { - fprintf(stderr, "Invalid heap profiling selection bracketing\n %s\n", rts_argv[arg]); - error = rtsTrue; +#if defined(PROFILING) + case 'i': /* heap sample interval */ + if (rts_argv[arg][2] == '\0') { + /* use default */ } else { - *right = '\0'; - switch (rts_argv[arg][1]) { - case 'c': /* cost centre label select */ - RtsFlags.ProfFlags.ccSelector = left + 1; - break; - case 'm': /* cost centre module select */ - RtsFlags.ProfFlags.modSelector = left + 1; - break; - case 'g': /* cost centre group select */ - RtsFlags.ProfFlags.grpSelector = left + 1; - break; - case 'd': /* closure descr select */ - RtsFlags.ProfFlags.descrSelector = left + 1; - break; - case 'y': /* closure type select */ - RtsFlags.ProfFlags.typeSelector = left + 1; - break; - case 'k': /* closure kind select */ - RtsFlags.ProfFlags.kindSelector = left + 1; - break; - } - }} - ) break; + I_ cst; /* tmp */ + + /* Convert to milliseconds */ + cst = (I_) ((atof(rts_argv[arg]+2) * 1000)); + cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS; + if (cst != 0 && cst < CS_MIN_MILLISECS) + cst = CS_MIN_MILLISECS; + + RtsFlags.ProfFlags.profileInterval = cst; + } + break; +#endif /* =========== CONCURRENT ========================= */ case 'C': /* context switch interval */ @@ -711,66 +1030,49 @@ error = rtsTrue; /* Convert to milliseconds */ cst = (I_) ((atof(rts_argv[arg]+2) * 1000)); cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS; - if (cst < CS_MIN_MILLISECS) + if (cst != 0 && cst < CS_MIN_MILLISECS) cst = CS_MIN_MILLISECS; RtsFlags.ConcFlags.ctxtSwitchTime = cst; } break; +#ifdef THREADED_RTS + case 'N': + THREADED_BUILD_ONLY( + if (rts_argv[arg][2] != '\0') { + RtsFlags.ParFlags.nNodes + = strtol(rts_argv[arg]+2, (char **) NULL, 10); + if (RtsFlags.ParFlags.nNodes <= 0) { + errorBelch("bad value for -N"); + error = rtsTrue; + } + } + ) break; +#endif /* =========== PARALLEL =========================== */ case 'e': - PAR_BUILD_ONLY( - if (rts_argv[arg][2] != '\0') { /* otherwise, stick w/ the default */ - + PAR_OR_THREADED_BUILD_ONLY( + if (rts_argv[arg][2] != '\0') { RtsFlags.ParFlags.maxLocalSparks = strtol(rts_argv[arg]+2, (char **) NULL, 10); - if (RtsFlags.ParFlags.maxLocalSparks <= 0) { - fprintf(stderr, "setupRtsFlags: bad value for -e\n"); - error = rtsTrue; + errorBelch("bad value for -e"); + error = rtsTrue; } } ) break; - case 'O': + case 'q': PAR_BUILD_ONLY( - RtsFlags.ParFlags.outputDisabled = rtsTrue; - ) break; - - case 'q': /* activity profile option */ - PAR_BUILD_ONLY( - if (rts_argv[arg][2] == 'b') - RtsFlags.ParFlags.granSimStats_Binary = rtsTrue; - else - RtsFlags.ParFlags.granSimStats = rtsTrue; - ) break; - -#if 0 /* or??? */ - case 'q': /* quasi-parallel profile option */ - GRAN_BUILD_ONLY ( - if (rts_argv[arg][2] == 'v') - do_qp_prof = 2; - else - do_qp_prof++; - ) break; -#endif /* 0??? */ - - case 'Q': /* Set pack buffer size */ - PAR_BUILD_ONLY( - if (rts_argv[arg][2] != '\0') { - RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+2); - } else { - fprintf(stderr, "setupRtsFlags: missing size of PackBuffer (for -Q)\n"); - error = rtsTrue; - } + process_par_option(arg, rts_argc, rts_argv, &error); ) break; /* =========== GRAN =============================== */ case 'b': GRAN_BUILD_ONLY( - process_gran_option(arg, rts_argc, rts_argv, &error); + process_gran_option(arg, rts_argc, rts_argv, &error); ) break; /* =========== TICKY ============================== */ @@ -779,16 +1081,49 @@ error = rtsTrue; TICKY_BUILD_ONLY( RtsFlags.TickyFlags.showTickyStats = rtsTrue; - RtsFlags.TickyFlags.tickyFile - = open_stats_file(arg, *argc, argv, - *rts_argc, rts_argv, TICKY_FILENAME_FMT); - if (RtsFlags.TickyFlags.tickyFile == NULL) error = rtsTrue; + { + int r; + r = open_stats_file(arg, *argc, argv, + *rts_argc, rts_argv, TICKY_FILENAME_FMT, + &RtsFlags.TickyFlags.tickyFile); + if (r == -1) { error = rtsTrue; } + } ) break; + /* =========== EXTENDED OPTIONS =================== */ + + case 'x': /* Extend the argument space */ + switch(rts_argv[arg][2]) { + case '\0': + errorBelch("incomplete RTS option: %s",rts_argv[arg]); + error = rtsTrue; + break; + + case 'c': /* Debugging tool: show current cost centre on an exception */ + PROFILING_BUILD_ONLY( + RtsFlags.ProfFlags.showCCSOnException = rtsTrue; + ); + break; + + case 't': /* Include memory used by TSOs in a heap profile */ + PROFILING_BUILD_ONLY( + RtsFlags.ProfFlags.includeTSOs = rtsTrue; + ); + break; + + /* The option prefix '-xx' is reserved for future extension. KSW 1999-11. */ + + default: + errorBelch("unknown RTS option: %s",rts_argv[arg]); + error = rtsTrue; + break; + } + break; /* defensive programming */ + /* =========== OH DEAR ============================ */ default: - fprintf(stderr, "setupRtsFlags: Unknown RTS option: %s\n",rts_argv[arg]); + errorBelch("unknown RTS option: %s",rts_argv[arg]); error = rtsTrue; break; } @@ -799,46 +1134,1046 @@ error = rtsTrue; fflush(stdout); for (p = usage_text; *p; p++) - fprintf(stderr, "%s\n", *p); + errorBelch("%s", *p); stg_exit(EXIT_FAILURE); } +} + +#if defined(GRAN) + +//@node GranSim specific options, Aux fcts, Command-line option parsing routines +//@subsection GranSim specific options + +static void +enable_GranSimLight(void) { + + debugBelch("GrAnSim Light enabled (infinite number of processors; 0 communication costs)\n"); + RtsFlags.GranFlags.Light=rtsTrue; + RtsFlags.GranFlags.Costs.latency = + RtsFlags.GranFlags.Costs.fetchtime = + RtsFlags.GranFlags.Costs.additional_latency = + RtsFlags.GranFlags.Costs.gunblocktime = + RtsFlags.GranFlags.Costs.lunblocktime = + RtsFlags.GranFlags.Costs.threadcreatetime = + RtsFlags.GranFlags.Costs.threadqueuetime = + RtsFlags.GranFlags.Costs.threadscheduletime = + RtsFlags.GranFlags.Costs.threaddescheduletime = + RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0; + + RtsFlags.GranFlags.Costs.mpacktime = + RtsFlags.GranFlags.Costs.munpacktime = 0; + + RtsFlags.GranFlags.DoFairSchedule = rtsTrue; + RtsFlags.GranFlags.DoAsyncFetch = rtsFalse; + RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue; + /* FetchStrategy is irrelevant in GrAnSim-Light */ + + /* GrAnSim Light often creates an abundance of parallel threads, + each with its own stack etc. Therefore, it's in general a good + idea to use small stack chunks (use the -o option to + increase it again). + */ + // RtsFlags.ConcFlags.stkChunkSize = 100; + + RtsFlags.GranFlags.proc = 1; +} + +static void +process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error) +{ + if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */ + return; + + /* or a ridiculously idealised simulator */ + if(strcmp((rts_argv[arg]+2),"oring")==0) { + RtsFlags.GranFlags.Costs.latency = + RtsFlags.GranFlags.Costs.fetchtime = + RtsFlags.GranFlags.Costs.additional_latency = + RtsFlags.GranFlags.Costs.gunblocktime = + RtsFlags.GranFlags.Costs.lunblocktime = + RtsFlags.GranFlags.Costs.threadcreatetime = + RtsFlags.GranFlags.Costs.threadqueuetime = + RtsFlags.GranFlags.Costs.threadscheduletime = + RtsFlags.GranFlags.Costs.threaddescheduletime = + RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0; + + RtsFlags.GranFlags.Costs.mpacktime = + RtsFlags.GranFlags.Costs.munpacktime = 0; + + RtsFlags.GranFlags.Costs.arith_cost = + RtsFlags.GranFlags.Costs.float_cost = + RtsFlags.GranFlags.Costs.load_cost = + RtsFlags.GranFlags.Costs.store_cost = + RtsFlags.GranFlags.Costs.branch_cost = 0; + + RtsFlags.GranFlags.Costs.heapalloc_cost = 1; + + /* ++RtsFlags.GranFlags.DoFairSchedule; */ + RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; /* -bZ */ + RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */ + RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */ + return; + } + + /* or a somewhat idealised simulator */ + if(strcmp((rts_argv[arg]+2),"onzo")==0) { + RtsFlags.GranFlags.Costs.latency = + RtsFlags.GranFlags.Costs.fetchtime = + RtsFlags.GranFlags.Costs.additional_latency = + RtsFlags.GranFlags.Costs.gunblocktime = + RtsFlags.GranFlags.Costs.lunblocktime = + RtsFlags.GranFlags.Costs.threadcreatetime = + RtsFlags.GranFlags.Costs.threadqueuetime = + RtsFlags.GranFlags.Costs.threadscheduletime = + RtsFlags.GranFlags.Costs.threaddescheduletime = + RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0; + + RtsFlags.GranFlags.Costs.mpacktime = + RtsFlags.GranFlags.Costs.munpacktime = 0; + + RtsFlags.GranFlags.Costs.heapalloc_cost = 1; + + /* RtsFlags.GranFlags.DoFairSchedule = rtsTrue; */ /* -b-R */ + /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */ /* -b-T */ + RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; /* -bZ */ + RtsFlags.GranFlags.DoThreadMigration = rtsTrue; /* -bM */ + RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; /* -bP */ +# if defined(GRAN_CHECK) && defined(GRAN) + RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics */ +# endif + return; + } + + /* Communication and task creation cost parameters */ + switch(rts_argv[arg][2]) { + case '.': + IgnoreYields = rtsTrue; // HWL HACK + break; + + case ':': + enable_GranSimLight(); /* set flags for GrAnSim-Light mode */ + break; + + case 'l': + if (rts_argv[arg][3] != '\0') + { + RtsFlags.GranFlags.Costs.gunblocktime = + RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3); + RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency; + } + else + RtsFlags.GranFlags.Costs.latency = LATENCY; + break; + + case 'a': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY; + break; + + case 'm': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME; + break; + + case 'x': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.mtidytime = 0; + break; + + case 'r': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME; + break; + + case 'g': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME; + break; + + case 'n': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME; + break; + + case 'u': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME; + break; + + /* Thread-related metrics */ + case 't': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME; + break; + + case 'q': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME; + break; + + case 'c': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME; + + RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime + + RtsFlags.GranFlags.Costs.threaddescheduletime; + break; + + case 'd': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME; + + RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime + + RtsFlags.GranFlags.Costs.threaddescheduletime; + break; + + /* Instruction Cost Metrics */ + case 'A': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST; + break; + + case 'F': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST; + break; + + case 'B': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST; + break; + + case 'L': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.load_cost = LOAD_COST; + break; + + case 'S': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.store_cost = STORE_COST; + break; + + case 'H': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.heapalloc_cost = 0; + break; + + case 'y': + RtsFlags.GranFlags.DoAsyncFetch = rtsTrue; + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.FetchStrategy = 2; + if (RtsFlags.GranFlags.FetchStrategy == 0) + RtsFlags.GranFlags.DoAsyncFetch = rtsFalse; + break; + + case 'K': /* sort overhead (per elem in spark list) */ + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD; + debugBelch("Overhead for pri spark: %d (per elem).\n", + RtsFlags.GranFlags.Costs.pri_spark_overhead); + break; + + case 'O': /* sort overhead (per elem in spark list) */ + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD; + debugBelch("Overhead for pri sched: %d (per elem).\n", + RtsFlags.GranFlags.Costs.pri_sched_overhead); + break; + + /* General Parameters */ + case 'p': + if (rts_argv[arg][3] != '\0') + { + RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3); + if (RtsFlags.GranFlags.proc==0) { + enable_GranSimLight(); /* set flags for GrAnSim-Light mode */ + } else if (RtsFlags.GranFlags.proc > MAX_PROC || + RtsFlags.GranFlags.proc < 1) + { + debugBelch("setupRtsFlags: no more than %u processors allowed\n", + MAX_PROC); + *error = rtsTrue; + } + } + else + RtsFlags.GranFlags.proc = MAX_PROC; + break; + + case 'f': + RtsFlags.GranFlags.Fishing = rtsTrue; + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.maxFishes = MAX_FISHES; + break; + + case 'w': + if (rts_argv[arg][3] != '\0') + RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3); + else + RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE; + break; + + case 'C': + RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue; + RtsFlags.GranFlags.DoThreadMigration=rtsTrue; + break; + + case 'G': + debugBelch("Bulk fetching enabled.\n"); + RtsFlags.GranFlags.DoBulkFetching=rtsTrue; + break; + + case 'M': + debugBelch("Thread migration enabled.\n"); + RtsFlags.GranFlags.DoThreadMigration=rtsTrue; + break; + + case 'R': + debugBelch("Fair Scheduling enabled.\n"); + RtsFlags.GranFlags.DoFairSchedule=rtsTrue; + break; + + case 'I': + debugBelch("Priority Scheduling enabled.\n"); + RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue; + break; + + case 'T': + RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue; + RtsFlags.GranFlags.DoThreadMigration=rtsTrue; + break; + + case 'Z': + RtsFlags.GranFlags.DoAsyncFetch=rtsTrue; + break; + +/* case 'z': */ +/* RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */ +/* break; */ + + case 'N': + RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue; + break; + + case 'b': + RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue; + break; + + case 'P': + /* format is -bP where is one char describing kind of profile */ + RtsFlags.GranFlags.GranSimStats.Full = rtsTrue; + switch(rts_argv[arg][3]) { + case '\0': break; // nothing special, just an ordinary profile + case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue; + break; + case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue; + break; + case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue; + break; + case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue; + break; + case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue; + break; + case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue; + break; + default: barf("Unknown option -bP%c", rts_argv[arg][3]); + } + break; + + case 's': + RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue; + break; + + case 'h': + RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue; + break; + + case 'Y': /* syntax: -bY[,] n ... pos int */ + if (rts_argv[arg][3] != '\0') { + char *arg0, *tmp; + + arg0 = rts_argv[arg]+3; + if ((tmp = strstr(arg0,","))==NULL) { + RtsFlags.GranFlags.SparkPriority = decode(arg0); + debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority); + } else { + *(tmp++) = '\0'; + RtsFlags.GranFlags.SparkPriority = decode(arg0); + RtsFlags.GranFlags.SparkPriority2 = decode(tmp); + debugBelch("SparkPriority: %u.\n", + RtsFlags.GranFlags.SparkPriority); + debugBelch("SparkPriority2:%u.\n", + RtsFlags.GranFlags.SparkPriority2); + if (RtsFlags.GranFlags.SparkPriority2 < + RtsFlags.GranFlags.SparkPriority) { + debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n", + RtsFlags.GranFlags.SparkPriority2, + RtsFlags.GranFlags.SparkPriority); + } + } + } else { + /* plain pri spark is now invoked with -bX + RtsFlags.GranFlags.DoPrioritySparking = 1; + debugBelch("PrioritySparking.\n"); + */ + } + break; + + case 'Q': + if (rts_argv[arg][3] != '\0') { + RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3); + } else { + RtsFlags.GranFlags.ThunksToPack = 1; + } + debugBelch("Thunks To Pack in one packet: %u.\n", + RtsFlags.GranFlags.ThunksToPack); + break; + + case 'e': + RtsFlags.GranFlags.RandomSteal = rtsFalse; + debugBelch("Deterministic mode (no random stealing)\n"); + break; + + /* The following class of options contains eXperimental */ + /* features in connection with exploiting granularity */ + /* information. I.e. if -bY is chosen these options */ + /* tell the RTS what to do with the supplied info --HWL */ + + case 'W': + if (rts_argv[arg][3] != '\0') { + RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3); + } else { + RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE; + } + debugBelch("Size of GranSim internal pack buffer: %u.\n", + RtsFlags.GranFlags.packBufferSize_internal); + break; + + case 'X': + switch(rts_argv[arg][3]) { + + case '\0': + RtsFlags.GranFlags.DoPrioritySparking = 1; + debugBelch("Priority Sparking with Normal Priorities.\n"); + RtsFlags.GranFlags.InversePriorities = rtsFalse; + RtsFlags.GranFlags.RandomPriorities = rtsFalse; + RtsFlags.GranFlags.IgnorePriorities = rtsFalse; + break; + + case 'I': + RtsFlags.GranFlags.DoPrioritySparking = 1; + debugBelch("Priority Sparking with Inverse Priorities.\n"); + RtsFlags.GranFlags.InversePriorities++; + break; + + case 'R': + RtsFlags.GranFlags.DoPrioritySparking = 1; + debugBelch("Priority Sparking with Random Priorities.\n"); + RtsFlags.GranFlags.RandomPriorities++; + break; + + case 'N': + RtsFlags.GranFlags.DoPrioritySparking = 1; + debugBelch("Priority Sparking with No Priorities.\n"); + RtsFlags.GranFlags.IgnorePriorities++; + break; + + default: + bad_option( rts_argv[arg] ); + break; + } + break; + + case '-': + switch(rts_argv[arg][3]) { + + case 'C': + RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse; + RtsFlags.GranFlags.DoThreadMigration=rtsFalse; + break; + + case 'G': + RtsFlags.GranFlags.DoBulkFetching=rtsFalse; + break; + + case 'M': + RtsFlags.GranFlags.DoThreadMigration=rtsFalse; + break; + + case 'R': + RtsFlags.GranFlags.DoFairSchedule=rtsFalse; + break; + + case 'T': + RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse; + RtsFlags.GranFlags.DoThreadMigration=rtsFalse; + break; + + case 'Z': + RtsFlags.GranFlags.DoAsyncFetch=rtsFalse; + break; + + case 'N': + RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse; + break; + + case 'P': + RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue; + break; + + case 's': + RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse; + break; + + case 'h': + RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse; + break; + + case 'b': + RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse; + break; + + case 'X': + RtsFlags.GranFlags.DoPrioritySparking = rtsFalse; + break; + + case 'Y': + RtsFlags.GranFlags.DoPrioritySparking = rtsFalse; + RtsFlags.GranFlags.SparkPriority = rtsFalse; + break; + + case 'I': + RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse; + break; + + case 'e': + RtsFlags.GranFlags.RandomSteal = rtsFalse; + break; + + default: + bad_option( rts_argv[arg] ); + break; + } + break; + +# if defined(GRAN_CHECK) && defined(GRAN) + case 'D': + switch(rts_argv[arg][3]) { + case 'Q': /* Set pack buffer size (same as 'Q' in GUM) */ + if (rts_argv[arg][4] != '\0') { + RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4); + debugBelch("Pack buffer size: %d\n", + RtsFlags.GranFlags.packBufferSize); + } else { + debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n"); + *error = rtsTrue; + } + break; + + default: + if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */ + /* hack warning: interpret the flags as a binary number */ + nat n = decode(rts_argv[arg]+3); + set_GranSim_debug_options(n); + } else { + nat i; + for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++) + if (rts_argv[arg][3] == gran_debug_opts_flags[i]) + break; + + if (i==MAX_GRAN_DEBUG_OPTION+1) { + debugBelch("Valid GranSim debug options are:\n"); + help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK); + bad_option( rts_argv[arg] ); + } else { // flag found; now set it + set_GranSim_debug_options(GRAN_DEBUG_MASK(i)); // 2^i + } + } + break; + +#if 0 + case 'e': /* event trace; also -bD1 */ + debugBelch("DEBUG: event_trace; printing event trace.\n"); + RtsFlags.GranFlags.Debug.event_trace = rtsTrue; + /* RtsFlags.GranFlags.event_trace=rtsTrue; */ + break; + + case 'E': /* event statistics; also -bD2 */ + debugBelch("DEBUG: event_stats; printing event statistics.\n"); + RtsFlags.GranFlags.Debug.event_stats = rtsTrue; + /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics */ + break; + + case 'f': /* thunkStealing; also -bD4 */ + debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n"); + RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; + /* RtsFlags.GranFlags.Debug |= 0x2; print fwd messages */ + break; + + case 'z': /* blockOnFetch; also -bD8 */ + debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n"); + RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; + /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */ + break; + + case 't': /* blockOnFetch_sanity; also -bD16 */ + debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n"); + RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; + /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch */ + break; + + case 'S': /* priSpark; also -bD32 */ + debugBelch("DEBUG: priSpark; priority sparking.\n"); + RtsFlags.GranFlags.Debug.priSpark = rtsTrue; + break; + + case 's': /* priSched; also -bD64 */ + debugBelch("DEBUG: priSched; priority scheduling.\n"); + RtsFlags.GranFlags.Debug.priSched = rtsTrue; + break; + + case 'F': /* findWork; also -bD128 */ + debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n"); + RtsFlags.GranFlags.Debug.findWork = rtsTrue; + break; + + case 'g': /* globalBlock; also -bD256 */ + debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n"); + RtsFlags.GranFlags.Debug.globalBlock = rtsTrue; + break; + + case 'G': /* pack; also -bD512 */ + debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n"); + RtsFlags.GranFlags.Debug.pack = rtsTrue; + break; + + case 'P': /* packBuffer; also -bD1024 */ + debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n"); + RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; + break; + + case 'o': /* sortedQ; also -bD2048 */ + debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n"); + RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; + break; + + case 'r': /* randomSteal; also -bD4096 */ + debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n"); + RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; + break; + + case 'q': /* checkSparkQ; also -bD8192 */ + debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n"); + RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; + break; + + case ':': /* checkLight; also -bD16384 */ + debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n"); + RtsFlags.GranFlags.Debug.checkLight = rtsTrue; + break; + + case 'b': /* bq; also -bD32768 */ + debugBelch("DEBUG: bq; check blocking queues\n"); + RtsFlags.GranFlags.Debug.bq = rtsTrue; + break; + + case 'd': /* all options turned on */ + debugBelch("DEBUG: all options turned on.\n"); + set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK); + /* RtsFlags.GranFlags.Debug |= 0x40; */ + break; + +/* case '\0': */ +/* RtsFlags.GranFlags.Debug = 1; */ +/* break; */ +#endif + } + break; +# endif /* GRAN_CHECK */ + default: + bad_option( rts_argv[arg] ); + break; + } } -static FILE * /* return NULL on error */ +/* + Interpret n as a binary number masking GranSim debug options and set the + correxponding option. See gran_debug_opts_strs for explanations of the flags. +*/ +static void +set_GranSim_debug_options(nat n) { + nat i; + + for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++) + if ((n>>i)&1) { + errorBelch(gran_debug_opts_strs[i]); + switch (i) { + case 0: RtsFlags.GranFlags.Debug.event_trace = rtsTrue; break; + case 1: RtsFlags.GranFlags.Debug.event_stats = rtsTrue; break; + case 2: RtsFlags.GranFlags.Debug.bq = rtsTrue; break; + case 3: RtsFlags.GranFlags.Debug.pack = rtsTrue; break; + case 4: RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue; break; + case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue; break; + case 6: RtsFlags.GranFlags.Debug.randomSteal = rtsTrue; break; + case 7: RtsFlags.GranFlags.Debug.findWork = rtsTrue; break; + case 8: RtsFlags.GranFlags.Debug.unused = rtsTrue; break; + case 9: RtsFlags.GranFlags.Debug.pri = rtsTrue; break; + case 10: RtsFlags.GranFlags.Debug.checkLight = rtsTrue; break; + case 11: RtsFlags.GranFlags.Debug.sortedQ = rtsTrue; break; + case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue; break; + case 13: RtsFlags.GranFlags.Debug.packBuffer = rtsTrue; break; + case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue; break; + default: barf("set_GranSim_debug_options: only %d debug options expected"); + } /* switch */ + } /* if */ +} + +/* + Print one line explanation for each of the GranSim debug options specified + in the bitmask n. +*/ +static void +help_GranSim_debug_options(nat n) { + nat i; + + for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++) + if ((n>>i)&1) + debugBelch(gran_debug_opts_strs[i]); +} + +# elif defined(PAR) + +static void +process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error) +{ + + if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */ + errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]); + return; + } + + /* Communication and task creation cost parameters */ + switch(rts_argv[arg][2]) { + case 'e': /* -qe ... allow local sparks */ + if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */ + RtsFlags.ParFlags.maxLocalSparks + = strtol(rts_argv[arg]+3, (char **) NULL, 10); + + if (RtsFlags.ParFlags.maxLocalSparks <= 0) { + errorBelch("setupRtsFlags: bad value for -e\n"); + *error = rtsTrue; + } + } + IF_PAR_DEBUG(verbose, + errorBelch("-qe: max %d local sparks", + RtsFlags.ParFlags.maxLocalSparks)); + break; + + case 't': + if (rts_argv[arg][3] != '\0') { + RtsFlags.ParFlags.maxThreads + = strtol(rts_argv[arg]+3, (char **) NULL, 10); + } else { + errorBelch("missing size for -qt\n"); + *error = rtsTrue; + } + IF_PAR_DEBUG(verbose, + errorBelch("-qt: max %d threads", + RtsFlags.ParFlags.maxThreads)); + break; + + case 'f': + if (rts_argv[arg][3] != '\0') + RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3); + else + RtsFlags.ParFlags.maxFishes = MAX_FISHES; + break; + IF_PAR_DEBUG(verbose, + errorBelch("-qf: max %d fishes sent out at one time", + RtsFlags.ParFlags.maxFishes)); + break; + + case 'F': + if (rts_argv[arg][3] != '\0') { + RtsFlags.ParFlags.fishDelay + = strtol(rts_argv[arg]+3, (char **) NULL, 10); + } else { + errorBelch("missing fish delay time for -qF\n"); + *error = rtsTrue; + } + IF_PAR_DEBUG(verbose, + errorBelch("-qF: fish delay time %d us", + RtsFlags.ParFlags.fishDelay)); + break; + + case 'O': + RtsFlags.ParFlags.outputDisabled = rtsTrue; + IF_PAR_DEBUG(verbose, + errorBelch("-qO: output disabled")); + break; + + case 'g': /* -qg ... globalisation scheme */ + if (rts_argv[arg][3] != '\0') { + RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3); + } else { + errorBelch("missing identifier for globalisation scheme (for -qg)\n"); + *error = rtsTrue; + } + IF_PAR_DEBUG(verbose, + debugBelch("-qg: globalisation scheme set to %d", + RtsFlags.ParFlags.globalising)); + break; + + case 'h': /* -qh ... max number of thunks (except root) in packet */ + if (rts_argv[arg][3] != '\0') { + RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3); + } else { + errorBelch("missing number of thunks per packet (for -qh)\n"); + *error = rtsTrue; + } + IF_PAR_DEBUG(verbose, + debugBelch("-qh: thunks per packet set to %d", + RtsFlags.ParFlags.thunksToPack)); + break; + + case 'P': /* -qP for writing a log file */ + //RtsFlags.ParFlags.ParStats.Full = rtsFalse; + /* same encoding as in GranSim after -bP */ + switch(rts_argv[arg][3]) { + case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue; + break; // nothing special, just an ordinary profile + case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue; + RtsFlags.ParFlags.ParStats.Full = rtsFalse; + break; + case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue; + break; + case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue; + break; + //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue; + // break; + case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue; + break; + case 'g': +# if defined(PAR_TICKY) + RtsFlags.ParFlags.ParStats.Global = rtsTrue; +# else + errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not"); + stg_exit(EXIT_FAILURE); +# endif + break; + default: barf("Unknown option -qP%c", rts_argv[arg][2]); + } + IF_PAR_DEBUG(verbose, + debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)", + (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse"))); + break; + + case 'Q': /* -qQ ... set pack buffer size to */ + if (rts_argv[arg][3] != '\0') { + RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3); + } else { + errorBelch("missing size of PackBuffer (for -qQ)\n"); + *error = rtsTrue; + } + IF_PAR_DEBUG(verbose, + debugBelch("-qQ: pack buffer size set to %d", + RtsFlags.ParFlags.packBufferSize)); + break; + + case 'R': + RtsFlags.ParFlags.doFairScheduling = rtsTrue; + IF_PAR_DEBUG(verbose, + debugBelch("-qR: fair-ish scheduling")); + break; + +# if defined(DEBUG) + case 'w': + if (rts_argv[arg][3] != '\0') { + RtsFlags.ParFlags.wait + = strtol(rts_argv[arg]+3, (char **) NULL, 10); + } else { + RtsFlags.ParFlags.wait = 1000; + } + IF_PAR_DEBUG(verbose, + debugBelch("-qw: length of wait loop after synchr before reduction: %d", + RtsFlags.ParFlags.wait)); + break; + + case 'D': /* -qD ... all the debugging options */ + if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */ + /* hack warning: interpret the flags as a binary number */ + nat n = decode(rts_argv[arg]+3); + set_par_debug_options(n); + } else { + nat i; + for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++) + if (rts_argv[arg][3] == par_debug_opts_flags[i]) + break; + + if (i==MAX_PAR_DEBUG_OPTION+1) { + errorBelch("Valid GUM debug options are:\n"); + help_par_debug_options(MAX_PAR_DEBUG_MASK); + bad_option( rts_argv[arg] ); + } else { // flag found; now set it + set_par_debug_options(PAR_DEBUG_MASK(i)); // 2^i + } + } + break; +# endif + default: + errorBelch("Unknown option -q%c (%d opts in total)", + rts_argv[arg][2], *rts_argc); + break; + } /* switch */ +} + +/* + Interpret n as a binary number masking Par debug options and set the + correxponding option. See par_debug_opts_strs for explanations of the flags. +*/ +static void +set_par_debug_options(nat n) { + nat i; + + for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++) + if ((n>>i)&1) { + debugBelch(par_debug_opts_strs[i]); + switch (i) { + case 0: RtsFlags.ParFlags.Debug.verbose = rtsTrue; break; + case 1: RtsFlags.ParFlags.Debug.bq = rtsTrue; break; + case 2: RtsFlags.ParFlags.Debug.schedule = rtsTrue; break; + case 3: RtsFlags.ParFlags.Debug.free = rtsTrue; break; + case 4: RtsFlags.ParFlags.Debug.resume = rtsTrue; break; + case 5: RtsFlags.ParFlags.Debug.weight = rtsTrue; break; + case 6: RtsFlags.ParFlags.Debug.fetch = rtsTrue; break; + //case 7: RtsFlags.ParFlags.Debug.ack = rtsTrue; break; + case 7: RtsFlags.ParFlags.Debug.fish = rtsTrue; break; + case 8: RtsFlags.ParFlags.Debug.tables = rtsTrue; break; + case 9: RtsFlags.ParFlags.Debug.packet = rtsTrue; break; + case 10: RtsFlags.ParFlags.Debug.pack = rtsTrue; break; + case 11: RtsFlags.ParFlags.Debug.paranoia = rtsTrue; break; + default: barf("set_par_debug_options: only %d debug options expected", + MAX_PAR_DEBUG_OPTION); + } /* switch */ + } /* if */ +} + +/* + Print one line explanation for each of the GranSim debug options specified + in the bitmask n. +*/ +static void +help_par_debug_options(nat n) { + nat i; + + for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++) + if ((n>>i)&1) + debugBelch(par_debug_opts_strs[i]); +} + +#endif /* PAR */ + +//@node Aux fcts, , GranSim specific options +//@subsection Aux fcts + +static void +stats_fprintf(FILE *f, char *s, ...) +{ + va_list ap; + va_start(ap,s); + if (f == NULL) { + vdebugBelch(s, ap); + } else { + vfprintf(f, s, ap); + } + 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) + const char *FILENAME_FMT, + FILE **file_ret) { FILE *f = NULL; - if (strequal(rts_argv[arg]+2, "stderr")) /* use real stderr */ - f = stderr; - else if (rts_argv[arg][2] != '\0') /* stats file specified */ - f = fopen(rts_argv[arg]+2,"w"); - else { - char stats_filename[STATS_FILENAME_MAXLEN]; /* default . */ - sprintf(stats_filename, FILENAME_FMT, argv[0]); - f = fopen(stats_filename,"w"); - } - if (f == NULL) { - fprintf(stderr, "Can't open stats file %s\n", rts_argv[arg]+2); + if (strequal(rts_argv[arg]+2, "stderr")) { /* use debugBelch */ + f = NULL; /* NULL means use debugBelch */ } else { + if (rts_argv[arg][2] != '\0') { /* stats file specified */ + f = fopen(rts_argv[arg]+2,"w"); + } else { + char stats_filename[STATS_FILENAME_MAXLEN]; /* default . */ + sprintf(stats_filename, FILENAME_FMT, argv[0]); + f = fopen(stats_filename,"w"); + } + if (f == NULL) { + errorBelch("Can't open stats file %s\n", rts_argv[arg]+2); + return -1; + } + } + *file_ret = f; + + { /* Write argv and rtsv into start of stats file */ - I_ count; - for(count = 0; count < argc; count++) - fprintf(f, "%s ", argv[count]); - fprintf(f, "+RTS "); + 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++) - fprintf(f, "%s ", rts_argv[count]); - fprintf(f, "\n"); + stats_fprintf(f, "%s ", rts_argv[count]); + stats_fprintf(f, "\n"); } - - return(f); + return 0; } + + static I_ decode(const char *s) { @@ -866,7 +2201,56 @@ decode(const char *s) static void bad_option(const char *s) { - fflush(stdout); - fprintf(stderr, "initSM: Bad RTS option: %s\n", s); + errorBelch("bad RTS option: %s", s); stg_exit(EXIT_FAILURE); -} +} + +/* ----------------------------------------------------------------------------- + Getting/Setting the program's arguments. + + These are used by System.Environment, and parts of the RTS. + -------------------------------------------------------------------------- */ + +void +setProgName(char *argv[]) +{ + /* Remove directory from argv[0] -- default files in current directory */ +#if !defined(mingw32_HOST_OS) + char *last_slash; + if ( (last_slash = (char *) strrchr(argv[0], '/')) != NULL ) { + prog_name = last_slash+1; + } else { + prog_name = argv[0]; + } +#else + char* last_slash = argv[0] + (strlen(argv[0]) - 1); + while ( last_slash > argv[0] ) { + if ( *last_slash == '/' || *last_slash == '\\' ) { + prog_name = last_slash+1; + return; + } + last_slash--; + } + prog_name = argv[0]; +#endif +} + +void +getProgArgv(int *argc, char **argv[]) +{ + if (argc) { *argc = prog_argc; } + if (argv) { *argv = prog_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); +}