1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-1999
5 * Datatypes that holds the command-line flag settings.
7 * ---------------------------------------------------------------------------*/
14 /* For defaults, see the @initRtsFlagsDefaults@ routine. */
20 #define COLLECT_GC_STATS 1
21 #define ONELINE_GC_STATS 2
22 #define SUMMARY_GC_STATS 3
23 #define VERBOSE_GC_STATS 4
25 nat maxStkSize; /* in *words* */
26 nat initialStkSize; /* in *words* */
28 nat maxHeapSize; /* in *blocks* */
29 nat minAllocAreaSize; /* in *blocks* */
30 nat minOldGenSize; /* in *blocks* */
31 nat heapSizeSuggestion; /* in *blocks* */
37 rtsBool squeezeUpdFrames;
39 rtsBool compact; /* True <=> "compact all the time" */
40 double compactThreshold;
42 rtsBool sweep; /* use "mostly mark-sweep" instead of copying
43 * for the oldest generation */
47 int idleGCDelayTime; /* in milliseconds */
49 StgWord heapBase; /* address to ask the OS for memory */
53 /* flags to control debugging output & extra checking in various subsystems */
54 rtsBool scheduler; /* 's' */
55 rtsBool interpreter; /* 'i' */
56 rtsBool weak; /* 'w' */
57 rtsBool gccafs; /* 'G' */
59 rtsBool block_alloc; /* 'b' */
60 rtsBool sanity; /* 'S' warning: might be expensive! */
61 rtsBool stable; /* 't' */
62 rtsBool prof; /* 'p' */
63 rtsBool gran; /* 'r' */
64 rtsBool par; /* 'P' */
65 rtsBool linker; /* 'l' the object linker */
66 rtsBool apply; /* 'a' */
67 rtsBool stm; /* 'm' */
68 rtsBool squeeze; /* 'z' stack squeezing & lazy blackholing */
69 rtsBool hpc; /* 'c' coverage */
72 struct COST_CENTRE_FLAGS {
73 unsigned int doCostCentres;
74 # define COST_CENTRES_SUMMARY 1
75 # define COST_CENTRES_VERBOSE 2 /* incl. serial time profile */
76 # define COST_CENTRES_ALL 3
77 # define COST_CENTRES_XML 4
79 int profilerTicks; /* derived */
80 int msecsPerTick; /* derived */
83 struct PROFILING_FLAGS {
84 unsigned int doHeapProfile;
85 # define NO_HEAP_PROFILING 0 /* N.B. Used as indexes into arrays */
86 # define HEAP_BY_CCS 1
87 # define HEAP_BY_MOD 2
88 # define HEAP_BY_DESCR 4
89 # define HEAP_BY_TYPE 5
90 # define HEAP_BY_RETAINER 6
91 # define HEAP_BY_LDV 7
93 # define HEAP_BY_CLOSURE_TYPE 8
95 nat profileInterval; /* delta between samples (in ms) */
96 nat profileIntervalTicks; /* delta between samples (in 'ticks') */
100 rtsBool showCCSOnException;
102 nat maxRetainerSetSize;
111 char* retainerSelector;
116 struct CONCURRENT_FLAGS {
117 int ctxtSwitchTime; /* in milliseconds */
118 int ctxtSwitchTicks; /* derived */
122 int tickInterval; /* in milliseconds */
123 rtsBool install_signal_handlers;
124 rtsBool machineReadable;
125 StgWord linkerMemBase; /* address to ask the OS for memory
126 * for the linker, NULL ==> off */
130 /* currently the same as GRAN_STATS_FLAGS */
131 struct PAR_STATS_FLAGS {
132 rtsBool Full; /* Full .gr profile (rtsTrue) or only END events? */
133 rtsBool Suppressed; /* No .gr profile at all */
134 rtsBool Binary; /* Binary profile? (not yet implemented) */
135 rtsBool Sparks; /* Info on sparks in profile? */
136 rtsBool Heap; /* Info on heap allocs in profile? */
137 rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
138 rtsBool Global; /* Global statistics? (printed on shutdown; no log file) */
141 struct PAR_DEBUG_FLAGS {
142 /* flags to control debugging output in various subsystems */
143 rtsBool verbose : 1; /* 1 */
144 rtsBool bq : 1; /* 2 */
145 rtsBool schedule : 1; /* 4 */
146 rtsBool free : 1; /* 8 */
147 rtsBool resume : 1; /* 16 */
148 rtsBool weight : 1; /* 32 */
149 rtsBool fetch : 1; /* 64 */
150 rtsBool fish : 1; /* 128 */
151 rtsBool tables : 1; /* 256 */
152 rtsBool packet : 1; /* 512 */
153 rtsBool pack : 1; /* 1024 */
154 rtsBool paranoia : 1; /* 2048 */
157 #define MAX_PAR_DEBUG_OPTION 11
158 #define PAR_DEBUG_MASK(n) ((nat)(ldexp(1,n)))
159 #define MAX_PAR_DEBUG_MASK ((nat)(ldexp(1,(MAX_PAR_DEBUG_OPTION+1))-1))
162 struct PAR_STATS_FLAGS ParStats; /* profile and stats output */
163 struct PAR_DEBUG_FLAGS Debug; /* debugging options */
164 rtsBool outputDisabled; /* Disable output for performance purposes */
165 rtsBool doFairScheduling; /* Fair-ish scheduling (round robin; no time-slices) */
167 nat thunksToPack; /* number of thunks in packet + 1 */
168 nat globalising; /* globalisation scheme */
169 nat maxLocalSparks; /* spark pool size */
170 nat maxThreads; /* thread pool size */
171 nat maxFishes; /* max number of active fishes */
172 rtsTime fishDelay; /* delay before sending a new fish */
179 nat nNodes; /* number of threads to run simultaneously */
180 rtsBool migrate; /* migrate threads between capabilities */
181 rtsBool wakeupMigrate; /* migrate a thread on wakeup */
182 unsigned int maxLocalSparks;
183 rtsBool parGcEnabled; /* enable parallel GC */
184 rtsBool parGcGen; /* do parallel GC in this generation
187 #endif /* THREADED_RTS */
190 struct GRAN_STATS_FLAGS {
191 rtsBool Full; /* Full .gr profile (rtsTrue) or only END events? */
192 rtsBool Suppressed; /* No .gr profile at all */
193 rtsBool Binary; /* Binary profile? (not yet implemented) */
194 rtsBool Sparks; /* Info on sparks in profile? */
195 rtsBool Heap; /* Info on heap allocs in profile? */
196 rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
197 rtsBool Global; /* Global statistics? (printed on shutdown; no log file) */
200 struct GRAN_COST_FLAGS {
201 /* Communication Cost Variables -- set in main program */
202 nat latency; /* Latency for single packet */
203 nat additional_latency; /* Latency for additional packets */
205 nat lunblocktime; /* Time for local unblock */
206 nat gunblocktime; /* Time for global unblock */
207 nat mpacktime; /* Cost of creating a packet */
208 nat munpacktime; /* Cost of receiving a packet */
209 nat mtidytime; /* Cost of cleaning up after send */
211 nat threadcreatetime; /* Thread creation costs */
212 nat threadqueuetime; /* Cost of adding a thread to the running/runnable queue */
213 nat threaddescheduletime; /* Cost of descheduling a thread */
214 nat threadscheduletime; /* Cost of scheduling a thread */
215 nat threadcontextswitchtime; /* Cost of context switch */
217 /* Instruction Costs */
218 nat arith_cost; /* arithmetic instructions (+,i,< etc) */
219 nat branch_cost; /* branch instructions */
220 nat load_cost; /* load into register */
221 nat store_cost; /* store into memory */
222 nat float_cost; /* floating point operations */
224 nat heapalloc_cost; /* heap allocation costs */
226 /* Overhead for granularity control mechanisms */
227 /* overhead per elem of spark queue */
228 nat pri_spark_overhead;
229 /* overhead per elem of thread queue */
230 nat pri_sched_overhead;
233 struct GRAN_DEBUG_FLAGS {
234 /* flags to control debugging output in various subsystems */
235 rtsBool event_trace : 1; /* 1 */
236 rtsBool event_stats : 1; /* 2 */
237 rtsBool bq : 1; /* 4 */
238 rtsBool pack : 1; /* 8 */
239 rtsBool checkSparkQ : 1; /* 16 */
240 rtsBool thunkStealing : 1; /* 32 */
241 rtsBool randomSteal : 1; /* 64 */
242 rtsBool findWork : 1; /* 128 */
243 rtsBool unused : 1; /* 256 */
244 rtsBool pri : 1; /* 512 */
245 rtsBool checkLight : 1; /* 1024 */
246 rtsBool sortedQ : 1; /* 2048 */
247 rtsBool blockOnFetch : 1; /* 4096 */
248 rtsBool packBuffer : 1; /* 8192 */
249 rtsBool blockOnFetch_sanity : 1; /* 16384 */
252 #define MAX_GRAN_DEBUG_OPTION 14
253 #define GRAN_DEBUG_MASK(n) ((nat)(ldexp(1,n)))
254 #define MAX_GRAN_DEBUG_MASK ((nat)(ldexp(1,(MAX_GRAN_DEBUG_OPTION+1))-1))
257 struct GRAN_STATS_FLAGS GranSimStats; /* profile and stats output */
258 struct GRAN_COST_FLAGS Costs; /* cost metric for simulation */
259 struct GRAN_DEBUG_FLAGS Debug; /* debugging options */
261 nat maxThreads; /* ToDo: share with THREADED_RTS and GUM */
262 /* rtsBool labelling; */
264 nat packBufferSize_internal;
266 PEs proc; /* number of processors */
267 rtsBool Fishing; /* Simulate GUM style fishing mechanism? */
268 nat maxFishes; /* max number of spark or thread steals */
269 rtsTime time_slice; /* max time slice of one reduction thread */
271 /* GrAnSim-Light: This version puts no bound on the number of
272 processors but in exchange doesn't model communication costs
273 (all communication is 0 cost). Mainly intended to show maximal
274 degree of parallelism in the program (*not* to simulate the
275 execution on a real machine). */
279 rtsBool DoFairSchedule ; /* fair scheduling alg? default: unfair */
280 rtsBool DoAsyncFetch; /* async. communication? */
281 rtsBool DoStealThreadsFirst; /* prefer threads over sparks when stealing */
282 rtsBool DoAlwaysCreateThreads; /* eager thread creation */
283 rtsBool DoBulkFetching; /* bulk fetching */
284 rtsBool DoThreadMigration; /* allow to move threads */
285 nat FetchStrategy; /* what to do when waiting for data */
286 rtsBool PreferSparksOfLocalNodes; /* prefer local over global sparks */
287 rtsBool DoPrioritySparking; /* sparks sorted by priorities */
288 rtsBool DoPriorityScheduling; /* threads sorted by priorities */
289 nat SparkPriority; /* threshold for cut-off mechanism */
291 rtsBool RandomPriorities;
292 rtsBool InversePriorities;
293 rtsBool IgnorePriorities;
294 nat ThunksToPack; /* number of thunks in packet + 1 */
295 rtsBool RandomSteal; /* steal spark/thread from random proc */
296 rtsBool NoForward; /* no forwarding of fetch messages */
298 /* unsigned int debug; */
299 /* rtsBool event_trace; */
300 /* rtsBool event_trace_all; */
305 rtsBool showTickyStats;
310 rtsBool sched; /* trace scheduler events for profiling */
311 rtsBool gc; /* trace GC events */
312 rtsBool timestamp; /* add timestamps to traces */
316 #define MAX_PAPI_USER_EVENTS 8
319 nat eventType; /* The type of events to count */
321 char * userEvents[MAX_PAPI_USER_EVENTS];
324 #define PAPI_FLAG_CACHE_L1 1
325 #define PAPI_FLAG_CACHE_L2 2
326 #define PAPI_FLAG_BRANCH 3
327 #define PAPI_FLAG_STALLS 4
328 #define PAPI_FLAG_CB_EVENTS 5
329 #define PAPI_USER_EVENTS 6
333 /* Put them together: */
335 typedef struct _RTS_FLAGS {
336 /* The first portion of RTS_FLAGS is invariant. */
337 struct GC_FLAGS GcFlags;
338 struct CONCURRENT_FLAGS ConcFlags;
339 struct MISC_FLAGS MiscFlags;
340 struct DEBUG_FLAGS DebugFlags;
341 struct COST_CENTRE_FLAGS CcFlags;
342 struct PROFILING_FLAGS ProfFlags;
343 struct TICKY_FLAGS TickyFlags;
344 struct TRACE_FLAGS TraceFlags;
346 #if defined(THREADED_RTS) || defined(PAR)
347 struct PAR_FLAGS ParFlags;
350 struct GRAN_FLAGS GranFlags;
353 struct PAPI_FLAGS PapiFlags;
357 #ifdef COMPILING_RTS_MAIN
358 extern DLLIMPORT RTS_FLAGS RtsFlags;
360 /* Hack because the C code generator can't generate '&label'. */
361 extern RTS_FLAGS RtsFlags[];
363 extern RTS_FLAGS RtsFlags;
366 /* Routines that operate-on/to-do-with RTS flags: */
368 extern void initRtsFlagsDefaults(void);
369 extern void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]);
370 extern void setProgName(char *argv[]);
374 * The printf formats are here, so we are less likely to make
375 * overly-long filenames (with disastrous results). No more than 128
379 #define STATS_FILENAME_MAXLEN 128
381 #define GR_FILENAME_FMT "%0.124s.gr"
382 #define GR_FILENAME_FMT_GUM "%0.120s.%03d.%s"
383 #define HP_FILENAME_FMT "%0.124s.hp"
384 #define LIFE_FILENAME_FMT "%0.122s.life"
385 #define PROF_FILENAME_FMT "%0.122s.prof"
386 #define PROF_FILENAME_FMT_GUM "%0.118s.%03d.prof"
387 #define QP_FILENAME_FMT "%0.124s.qp"
388 #define STAT_FILENAME_FMT "%0.122s.stat"
389 #define TICKY_FILENAME_FMT "%0.121s.ticky"
390 #define TIME_FILENAME_FMT "%0.122s.time"
391 #define TIME_FILENAME_FMT_GUM "%0.118s.%03d.time"
393 /* an "int" so as to match normal "argc" */
394 /* Now defined in Stg.h (lib/std/cbits need these too.)
395 extern int prog_argc;
396 extern char **prog_argv;
398 extern int rts_argc; /* ditto */
399 extern char *rts_argv[];
401 #endif /* RTSFLAGS_H */