1 /* -----------------------------------------------------------------------------
2 * $Id: RtsFlags.h,v 1.32 2001/03/22 03:51:10 hwloidl Exp $
4 * (c) The GHC Team, 1998-1999
6 * Datatypes that holds the command-line flag settings.
8 * ---------------------------------------------------------------------------*/
13 /* For defaults, see the @initRtsFlagsDefaults@ routine. */
19 #define COLLECT_GC_STATS 1
20 #define ONELINE_GC_STATS 2
21 #define SUMMARY_GC_STATS 3
22 #define VERBOSE_GC_STATS 4
24 nat maxStkSize; /* in *words* */
25 nat initialStkSize; /* in *words* */
27 nat maxHeapSize; /* in *blocks* */
28 nat minAllocAreaSize; /* in *blocks* */
29 nat minOldGenSize; /* in *blocks* */
30 nat heapSizeSuggestion; /* in *blocks* */
39 rtsBool squeezeUpdFrames;
44 /* Hack: this struct uses bitfields so that we can use a binary arg
46 * Remember to update the corresponding bit of RtsFlags.c if you
47 * change/extend this struct.
50 /* flags to control debugging output in various subsystems */
51 rtsBool scheduler : 1; /* 1 */
52 rtsBool evaluator : 1; /* 2 */
53 rtsBool codegen : 1; /* 4 */
54 rtsBool weak : 1; /* 8 */
55 rtsBool gccafs : 1; /* 16 */
56 rtsBool gc : 1; /* 32 */
57 rtsBool block_alloc : 1; /* 64 */
59 /* flags to control consistency checking (often very expensive!) */
60 rtsBool sanity : 1; /* 128 */
62 rtsBool stable : 1; /* 256 */
63 rtsBool prof : 1; /* 512 */
64 rtsBool gran : 1; /* 1024 */
65 rtsBool par : 1; /* 2048 */
67 /* The object linker */
68 rtsBool linker : 1; /* 4096 */
71 #define MAX_DEBUG_OPTION 12
72 #define DEBUG_MASK(n) ((nat)(ldexp(1,n)))
73 #define MAX_DEBUG_MASK ((nat)(ldexp(1,(MAX_DEBUG_OPTION+1))-1))
75 struct COST_CENTRE_FLAGS {
76 unsigned int doCostCentres;
77 # define COST_CENTRES_SUMMARY 1
78 # define COST_CENTRES_VERBOSE 2 /* incl. serial time profile */
79 # define COST_CENTRES_ALL 3
80 # define COST_CENTRES_XML 4
82 int profilerTicks; /* derived */
83 int msecsPerTick; /* derived */
87 struct PROFILING_FLAGS {
88 unsigned int doHeapProfile;
90 # define NO_HEAP_PROFILING 0 /* N.B. Used as indexes into arrays */
91 # define HEAP_BY_CCS 1
92 # define HEAP_BY_MOD 2
93 # define HEAP_BY_DESCR 4
94 # define HEAP_BY_TYPE 5
96 rtsBool showCCSOnException;
100 # define DESCRchar 'D'
101 # define TYPEchar 'Y'
110 # define NO_HEAP_PROFILING 0
111 # define HEAP_BY_INFOPTR 1
112 # define HEAP_BY_CLOSURE_TYPE 2
113 struct PROFILING_FLAGS {
114 unsigned int doHeapProfile; /* heap profile using symbol table */
116 #endif /* DEBUG || PROFILING */
118 struct CONCURRENT_FLAGS {
119 int ctxtSwitchTime; /* in milliseconds */
120 int ctxtSwitchTicks; /* derived */
124 /* currently the same as GRAN_STATS_FLAGS */
125 struct PAR_STATS_FLAGS {
126 rtsBool Full; /* Full .gr profile (rtsTrue) or only END events? */
127 rtsBool Suppressed; /* No .gr profile at all */
128 rtsBool Binary; /* Binary profile? (not yet implemented) */
129 rtsBool Sparks; /* Info on sparks in profile? */
130 rtsBool Heap; /* Info on heap allocs in profile? */
131 rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
132 rtsBool Global; /* Global statistics? (printed on shutdown; no log file) */
135 struct PAR_DEBUG_FLAGS {
136 /* flags to control debugging output in various subsystems */
137 rtsBool verbose : 1; /* 1 */
138 rtsBool bq : 1; /* 2 */
139 rtsBool schedule : 1; /* 4 */
140 rtsBool free : 1; /* 8 */
141 rtsBool resume : 1; /* 16 */
142 rtsBool weight : 1; /* 32 */
143 rtsBool fetch : 1; /* 64 */
144 rtsBool fish : 1; /* 128 */
145 rtsBool tables : 1; /* 256 */
146 rtsBool packet : 1; /* 512 */
147 rtsBool pack : 1; /* 1024 */
148 rtsBool paranoia : 1; /* 2048 */
151 #define MAX_PAR_DEBUG_OPTION 11
152 #define PAR_DEBUG_MASK(n) ((nat)(ldexp(1,n)))
153 #define MAX_PAR_DEBUG_MASK ((nat)(ldexp(1,(MAX_PAR_DEBUG_OPTION+1))-1))
156 struct PAR_STATS_FLAGS ParStats; /* profile and stats output */
157 struct PAR_DEBUG_FLAGS Debug; /* debugging options */
158 rtsBool outputDisabled; /* Disable output for performance purposes */
159 rtsBool doFairScheduling; /* Fair-ish scheduling (round robin; no time-slices) */
161 nat thunksToPack; /* number of thunks in packet + 1 */
162 nat globalising; /* globalisation scheme */
163 nat maxLocalSparks; /* spark pool size */
164 nat maxThreads; /* thread pool size */
165 nat maxFishes; /* max number of active fishes */
166 rtsTime fishDelay; /* delay before sending a new fish */
173 nat nNodes; /* number of threads to run simultaneously */
174 unsigned int maxLocalSparks;
179 struct GRAN_STATS_FLAGS {
180 rtsBool Full; /* Full .gr profile (rtsTrue) or only END events? */
181 rtsBool Suppressed; /* No .gr profile at all */
182 rtsBool Binary; /* Binary profile? (not yet implemented) */
183 rtsBool Sparks; /* Info on sparks in profile? */
184 rtsBool Heap; /* Info on heap allocs in profile? */
185 rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
186 rtsBool Global; /* Global statistics? (printed on shutdown; no log file) */
189 struct GRAN_COST_FLAGS {
190 /* Communication Cost Variables -- set in main program */
191 nat latency; /* Latency for single packet */
192 nat additional_latency; /* Latency for additional packets */
194 nat lunblocktime; /* Time for local unblock */
195 nat gunblocktime; /* Time for global unblock */
196 nat mpacktime; /* Cost of creating a packet */
197 nat munpacktime; /* Cost of receiving a packet */
198 nat mtidytime; /* Cost of cleaning up after send */
200 nat threadcreatetime; /* Thread creation costs */
201 nat threadqueuetime; /* Cost of adding a thread to the running/runnable queue */
202 nat threaddescheduletime; /* Cost of descheduling a thread */
203 nat threadscheduletime; /* Cost of scheduling a thread */
204 nat threadcontextswitchtime; /* Cost of context switch */
206 /* Instruction Costs */
207 nat arith_cost; /* arithmetic instructions (+,i,< etc) */
208 nat branch_cost; /* branch instructions */
209 nat load_cost; /* load into register */
210 nat store_cost; /* store into memory */
211 nat float_cost; /* floating point operations */
213 nat heapalloc_cost; /* heap allocation costs */
215 /* Overhead for granularity control mechanisms */
216 /* overhead per elem of spark queue */
217 nat pri_spark_overhead;
218 /* overhead per elem of thread queue */
219 nat pri_sched_overhead;
222 struct GRAN_DEBUG_FLAGS {
223 /* flags to control debugging output in various subsystems */
224 rtsBool event_trace : 1; /* 1 */
225 rtsBool event_stats : 1; /* 2 */
226 rtsBool bq : 1; /* 4 */
227 rtsBool pack : 1; /* 8 */
228 rtsBool checkSparkQ : 1; /* 16 */
229 rtsBool thunkStealing : 1; /* 32 */
230 rtsBool randomSteal : 1; /* 64 */
231 rtsBool findWork : 1; /* 128 */
232 rtsBool unused : 1; /* 256 */
233 rtsBool pri : 1; /* 512 */
234 rtsBool checkLight : 1; /* 1024 */
235 rtsBool sortedQ : 1; /* 2048 */
236 rtsBool blockOnFetch : 1; /* 4096 */
237 rtsBool packBuffer : 1; /* 8192 */
238 rtsBool blockOnFetch_sanity : 1; /* 16384 */
241 #define MAX_GRAN_DEBUG_OPTION 14
242 #define GRAN_DEBUG_MASK(n) ((nat)(ldexp(1,n)))
243 #define MAX_GRAN_DEBUG_MASK ((nat)(ldexp(1,(MAX_GRAN_DEBUG_OPTION+1))-1))
246 struct GRAN_STATS_FLAGS GranSimStats; /* profile and stats output */
247 struct GRAN_COST_FLAGS Costs; /* cost metric for simulation */
248 struct GRAN_DEBUG_FLAGS Debug; /* debugging options */
250 nat maxThreads; // ToDo: share with SMP and GUM
251 // rtsBool labelling;
253 nat packBufferSize_internal;
255 PEs proc; /* number of processors */
256 rtsBool Fishing; /* Simulate GUM style fishing mechanism? */
257 nat maxFishes; /* max number of spark or thread steals */
258 rtsTime time_slice; /* max time slice of one reduction thread */
260 /* GrAnSim-Light: This version puts no bound on the number of
261 processors but in exchange doesn't model communication costs
262 (all communication is 0 cost). Mainly intended to show maximal
263 degree of parallelism in the program (*not* to simulate the
264 execution on a real machine). */
268 rtsBool DoFairSchedule ; /* fair scheduling alg? default: unfair */
269 rtsBool DoAsyncFetch; /* async. communication? */
270 rtsBool DoStealThreadsFirst; /* prefer threads over sparks when stealing */
271 rtsBool DoAlwaysCreateThreads; /* eager thread creation */
272 rtsBool DoBulkFetching; /* bulk fetching */
273 rtsBool DoThreadMigration; /* allow to move threads */
274 nat FetchStrategy; /* what to do when waiting for data */
275 rtsBool PreferSparksOfLocalNodes; /* prefer local over global sparks */
276 rtsBool DoPrioritySparking; /* sparks sorted by priorities */
277 rtsBool DoPriorityScheduling; /* threads sorted by priorities */
278 nat SparkPriority; /* threshold for cut-off mechanism */
280 rtsBool RandomPriorities;
281 rtsBool InversePriorities;
282 rtsBool IgnorePriorities;
283 nat ThunksToPack; /* number of thunks in packet + 1 */
284 rtsBool RandomSteal; /* steal spark/thread from random proc */
285 rtsBool NoForward; /* no forwarding of fetch messages */
287 // unsigned int debug;
288 // rtsBool event_trace;
289 // rtsBool event_trace_all;
295 rtsBool showTickyStats;
298 #endif /* TICKY_TICKY */
301 /* Put them together: */
304 struct GC_FLAGS GcFlags;
305 struct DEBUG_FLAGS DebugFlags;
306 struct CONCURRENT_FLAGS ConcFlags;
308 #if defined(PROFILING) || defined(PAR)
309 struct COST_CENTRE_FLAGS CcFlags;
311 #if defined(PROFILING) || defined(DEBUG)
312 struct PROFILING_FLAGS ProfFlags;
314 #if defined(SMP) || defined(PAR)
315 struct PAR_FLAGS ParFlags;
318 struct GRAN_FLAGS GranFlags;
321 struct TICKY_FLAGS TickyFlags;
325 #ifdef COMPILING_RTS_MAIN
326 extern DLLIMPORT struct RTS_FLAGS RtsFlags;
328 extern struct RTS_FLAGS RtsFlags;
331 /* Routines that operate-on/to-do-with RTS flags: */
333 void initRtsFlagsDefaults(void);
334 void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]);
337 * The printf formats are here, so we are less likely to make
338 * overly-long filenames (with disastrous results). No more than 128
342 #define STATS_FILENAME_MAXLEN 128
344 #define GR_FILENAME_FMT "%0.124s.gr"
345 #define GR_FILENAME_FMT_GUM "%0.120s.%03d.%s"
346 #define HP_FILENAME_FMT "%0.124s.hp"
347 #define LIFE_FILENAME_FMT "%0.122s.life"
348 #define PROF_FILENAME_FMT "%0.122s.prof"
349 #define PROF_FILENAME_FMT_GUM "%0.118s.%03d.prof"
350 #define QP_FILENAME_FMT "%0.124s.qp"
351 #define STAT_FILENAME_FMT "%0.122s.stat"
352 #define TICKY_FILENAME_FMT "%0.121s.ticky"
353 #define TIME_FILENAME_FMT "%0.122s.time"
354 #define TIME_FILENAME_FMT_GUM "%0.118s.%03d.time"
356 /* an "int" so as to match normal "argc" */
357 /* Now defined in Stg.h (lib/std/cbits need these too.)
358 extern int prog_argc;
359 extern char **prog_argv;
361 extern int rts_argc; /* ditto */
362 extern char *rts_argv[];
364 #endif /* RTSFLAGS_H */