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 StgWord linkerMemBase; /* address to ask the OS for memory
125 * for the linker, NULL ==> off */
129 /* currently the same as GRAN_STATS_FLAGS */
130 struct PAR_STATS_FLAGS {
131 rtsBool Full; /* Full .gr profile (rtsTrue) or only END events? */
132 rtsBool Suppressed; /* No .gr profile at all */
133 rtsBool Binary; /* Binary profile? (not yet implemented) */
134 rtsBool Sparks; /* Info on sparks in profile? */
135 rtsBool Heap; /* Info on heap allocs in profile? */
136 rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
137 rtsBool Global; /* Global statistics? (printed on shutdown; no log file) */
140 struct PAR_DEBUG_FLAGS {
141 /* flags to control debugging output in various subsystems */
142 rtsBool verbose : 1; /* 1 */
143 rtsBool bq : 1; /* 2 */
144 rtsBool schedule : 1; /* 4 */
145 rtsBool free : 1; /* 8 */
146 rtsBool resume : 1; /* 16 */
147 rtsBool weight : 1; /* 32 */
148 rtsBool fetch : 1; /* 64 */
149 rtsBool fish : 1; /* 128 */
150 rtsBool tables : 1; /* 256 */
151 rtsBool packet : 1; /* 512 */
152 rtsBool pack : 1; /* 1024 */
153 rtsBool paranoia : 1; /* 2048 */
156 #define MAX_PAR_DEBUG_OPTION 11
157 #define PAR_DEBUG_MASK(n) ((nat)(ldexp(1,n)))
158 #define MAX_PAR_DEBUG_MASK ((nat)(ldexp(1,(MAX_PAR_DEBUG_OPTION+1))-1))
161 struct PAR_STATS_FLAGS ParStats; /* profile and stats output */
162 struct PAR_DEBUG_FLAGS Debug; /* debugging options */
163 rtsBool outputDisabled; /* Disable output for performance purposes */
164 rtsBool doFairScheduling; /* Fair-ish scheduling (round robin; no time-slices) */
166 nat thunksToPack; /* number of thunks in packet + 1 */
167 nat globalising; /* globalisation scheme */
168 nat maxLocalSparks; /* spark pool size */
169 nat maxThreads; /* thread pool size */
170 nat maxFishes; /* max number of active fishes */
171 rtsTime fishDelay; /* delay before sending a new fish */
178 nat nNodes; /* number of threads to run simultaneously */
179 rtsBool migrate; /* migrate threads between capabilities */
180 rtsBool wakeupMigrate; /* migrate a thread on wakeup */
181 unsigned int maxLocalSparks;
182 nat gcThreads; /* number of threads for parallel GC */
184 #endif /* THREADED_RTS */
187 struct GRAN_STATS_FLAGS {
188 rtsBool Full; /* Full .gr profile (rtsTrue) or only END events? */
189 rtsBool Suppressed; /* No .gr profile at all */
190 rtsBool Binary; /* Binary profile? (not yet implemented) */
191 rtsBool Sparks; /* Info on sparks in profile? */
192 rtsBool Heap; /* Info on heap allocs in profile? */
193 rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
194 rtsBool Global; /* Global statistics? (printed on shutdown; no log file) */
197 struct GRAN_COST_FLAGS {
198 /* Communication Cost Variables -- set in main program */
199 nat latency; /* Latency for single packet */
200 nat additional_latency; /* Latency for additional packets */
202 nat lunblocktime; /* Time for local unblock */
203 nat gunblocktime; /* Time for global unblock */
204 nat mpacktime; /* Cost of creating a packet */
205 nat munpacktime; /* Cost of receiving a packet */
206 nat mtidytime; /* Cost of cleaning up after send */
208 nat threadcreatetime; /* Thread creation costs */
209 nat threadqueuetime; /* Cost of adding a thread to the running/runnable queue */
210 nat threaddescheduletime; /* Cost of descheduling a thread */
211 nat threadscheduletime; /* Cost of scheduling a thread */
212 nat threadcontextswitchtime; /* Cost of context switch */
214 /* Instruction Costs */
215 nat arith_cost; /* arithmetic instructions (+,i,< etc) */
216 nat branch_cost; /* branch instructions */
217 nat load_cost; /* load into register */
218 nat store_cost; /* store into memory */
219 nat float_cost; /* floating point operations */
221 nat heapalloc_cost; /* heap allocation costs */
223 /* Overhead for granularity control mechanisms */
224 /* overhead per elem of spark queue */
225 nat pri_spark_overhead;
226 /* overhead per elem of thread queue */
227 nat pri_sched_overhead;
230 struct GRAN_DEBUG_FLAGS {
231 /* flags to control debugging output in various subsystems */
232 rtsBool event_trace : 1; /* 1 */
233 rtsBool event_stats : 1; /* 2 */
234 rtsBool bq : 1; /* 4 */
235 rtsBool pack : 1; /* 8 */
236 rtsBool checkSparkQ : 1; /* 16 */
237 rtsBool thunkStealing : 1; /* 32 */
238 rtsBool randomSteal : 1; /* 64 */
239 rtsBool findWork : 1; /* 128 */
240 rtsBool unused : 1; /* 256 */
241 rtsBool pri : 1; /* 512 */
242 rtsBool checkLight : 1; /* 1024 */
243 rtsBool sortedQ : 1; /* 2048 */
244 rtsBool blockOnFetch : 1; /* 4096 */
245 rtsBool packBuffer : 1; /* 8192 */
246 rtsBool blockOnFetch_sanity : 1; /* 16384 */
249 #define MAX_GRAN_DEBUG_OPTION 14
250 #define GRAN_DEBUG_MASK(n) ((nat)(ldexp(1,n)))
251 #define MAX_GRAN_DEBUG_MASK ((nat)(ldexp(1,(MAX_GRAN_DEBUG_OPTION+1))-1))
254 struct GRAN_STATS_FLAGS GranSimStats; /* profile and stats output */
255 struct GRAN_COST_FLAGS Costs; /* cost metric for simulation */
256 struct GRAN_DEBUG_FLAGS Debug; /* debugging options */
258 nat maxThreads; /* ToDo: share with THREADED_RTS and GUM */
259 /* rtsBool labelling; */
261 nat packBufferSize_internal;
263 PEs proc; /* number of processors */
264 rtsBool Fishing; /* Simulate GUM style fishing mechanism? */
265 nat maxFishes; /* max number of spark or thread steals */
266 rtsTime time_slice; /* max time slice of one reduction thread */
268 /* GrAnSim-Light: This version puts no bound on the number of
269 processors but in exchange doesn't model communication costs
270 (all communication is 0 cost). Mainly intended to show maximal
271 degree of parallelism in the program (*not* to simulate the
272 execution on a real machine). */
276 rtsBool DoFairSchedule ; /* fair scheduling alg? default: unfair */
277 rtsBool DoAsyncFetch; /* async. communication? */
278 rtsBool DoStealThreadsFirst; /* prefer threads over sparks when stealing */
279 rtsBool DoAlwaysCreateThreads; /* eager thread creation */
280 rtsBool DoBulkFetching; /* bulk fetching */
281 rtsBool DoThreadMigration; /* allow to move threads */
282 nat FetchStrategy; /* what to do when waiting for data */
283 rtsBool PreferSparksOfLocalNodes; /* prefer local over global sparks */
284 rtsBool DoPrioritySparking; /* sparks sorted by priorities */
285 rtsBool DoPriorityScheduling; /* threads sorted by priorities */
286 nat SparkPriority; /* threshold for cut-off mechanism */
288 rtsBool RandomPriorities;
289 rtsBool InversePriorities;
290 rtsBool IgnorePriorities;
291 nat ThunksToPack; /* number of thunks in packet + 1 */
292 rtsBool RandomSteal; /* steal spark/thread from random proc */
293 rtsBool NoForward; /* no forwarding of fetch messages */
295 /* unsigned int debug; */
296 /* rtsBool event_trace; */
297 /* rtsBool event_trace_all; */
302 rtsBool showTickyStats;
307 rtsBool sched; /* trace scheduler events for profiling */
308 rtsBool gc; /* trace GC events */
309 rtsBool timestamp; /* add timestamps to traces */
313 #define MAX_PAPI_USER_EVENTS 8
316 nat eventType; /* The type of events to count */
318 char * userEvents[MAX_PAPI_USER_EVENTS];
321 #define PAPI_FLAG_CACHE_L1 1
322 #define PAPI_FLAG_CACHE_L2 2
323 #define PAPI_FLAG_BRANCH 3
324 #define PAPI_FLAG_STALLS 4
325 #define PAPI_FLAG_CB_EVENTS 5
326 #define PAPI_USER_EVENTS 6
330 /* Put them together: */
332 typedef struct _RTS_FLAGS {
333 /* The first portion of RTS_FLAGS is invariant. */
334 struct GC_FLAGS GcFlags;
335 struct CONCURRENT_FLAGS ConcFlags;
336 struct MISC_FLAGS MiscFlags;
337 struct DEBUG_FLAGS DebugFlags;
338 struct COST_CENTRE_FLAGS CcFlags;
339 struct PROFILING_FLAGS ProfFlags;
340 struct TICKY_FLAGS TickyFlags;
341 struct TRACE_FLAGS TraceFlags;
343 #if defined(THREADED_RTS) || defined(PAR)
344 struct PAR_FLAGS ParFlags;
347 struct GRAN_FLAGS GranFlags;
350 struct PAPI_FLAGS PapiFlags;
354 #ifdef COMPILING_RTS_MAIN
355 extern DLLIMPORT RTS_FLAGS RtsFlags;
357 /* Hack because the C code generator can't generate '&label'. */
358 extern RTS_FLAGS RtsFlags[];
360 extern RTS_FLAGS RtsFlags;
363 /* Routines that operate-on/to-do-with RTS flags: */
365 extern void initRtsFlagsDefaults(void);
366 extern void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]);
367 extern void setProgName(char *argv[]);
371 * The printf formats are here, so we are less likely to make
372 * overly-long filenames (with disastrous results). No more than 128
376 #define STATS_FILENAME_MAXLEN 128
378 #define GR_FILENAME_FMT "%0.124s.gr"
379 #define GR_FILENAME_FMT_GUM "%0.120s.%03d.%s"
380 #define HP_FILENAME_FMT "%0.124s.hp"
381 #define LIFE_FILENAME_FMT "%0.122s.life"
382 #define PROF_FILENAME_FMT "%0.122s.prof"
383 #define PROF_FILENAME_FMT_GUM "%0.118s.%03d.prof"
384 #define QP_FILENAME_FMT "%0.124s.qp"
385 #define STAT_FILENAME_FMT "%0.122s.stat"
386 #define TICKY_FILENAME_FMT "%0.121s.ticky"
387 #define TIME_FILENAME_FMT "%0.122s.time"
388 #define TIME_FILENAME_FMT_GUM "%0.118s.%03d.time"
390 /* an "int" so as to match normal "argc" */
391 /* Now defined in Stg.h (lib/std/cbits need these too.)
392 extern int prog_argc;
393 extern char **prog_argv;
395 extern int rts_argc; /* ditto */
396 extern char *rts_argv[];
398 #endif /* RTSFLAGS_H */