[project @ 2003-08-01 15:38:41 by panne]
[ghc-hetmet.git] / ghc / includes / RtsFlags.h
1 /* -----------------------------------------------------------------------------
2  * $Id: RtsFlags.h,v 1.45 2003/01/23 12:13:10 simonmar Exp $
3  *
4  * (c) The GHC Team, 1998-1999
5  *
6  * Datatypes that holds the command-line flag settings.
7  *
8  * ---------------------------------------------------------------------------*/
9
10 #ifndef RTSFLAGS_H
11 #define RTSFLAGS_H
12
13 #include <stdio.h>
14
15 /* For defaults, see the @initRtsFlagsDefaults@ routine. */
16
17 struct GC_FLAGS {
18     FILE   *statsFile;
19     nat     giveStats;
20 #define NO_GC_STATS      0
21 #define COLLECT_GC_STATS 1
22 #define ONELINE_GC_STATS 2
23 #define SUMMARY_GC_STATS 3
24 #define VERBOSE_GC_STATS 4
25
26     nat     maxStkSize;         /* in *words* */
27     nat     initialStkSize;     /* in *words* */
28
29     nat     maxHeapSize;        /* in *blocks* */
30     nat     minAllocAreaSize;   /* in *blocks* */
31     nat     minOldGenSize;      /* in *blocks* */
32     nat     heapSizeSuggestion; /* in *blocks* */
33     double  oldGenFactor;
34     double  pcFreeHeap;
35
36     nat     generations;
37     nat     steps;
38     rtsBool squeezeUpdFrames;
39
40     rtsBool compact;            /* True <=> "compact all the time" */
41     double  compactThreshold;
42
43     rtsBool ringBell;
44     rtsBool frontpanel;
45 };
46
47 struct DEBUG_FLAGS {  
48     // flags to control debugging output & extra checking in various subsystems
49     rtsBool scheduler;      // 's'
50     rtsBool interpreter;    // 'i'
51     rtsBool codegen;        // 'c'
52     rtsBool weak;           // 'w'
53     rtsBool gccafs;         // 'G'
54     rtsBool gc;             // 'g'
55     rtsBool block_alloc;    // 'b'
56     rtsBool sanity;         // 'S'   warning: might be expensive!
57     rtsBool stable;         // 't'
58     rtsBool prof;           // 'p'
59     rtsBool gran;           // 'r'
60     rtsBool par;            // 'P'
61     rtsBool linker;         // 'l'   the object linker
62     rtsBool apply;          // 'a'
63 };
64
65 struct COST_CENTRE_FLAGS {
66     unsigned int            doCostCentres;
67 # define COST_CENTRES_SUMMARY   1
68 # define COST_CENTRES_VERBOSE   2 /* incl. serial time profile */
69 # define COST_CENTRES_ALL       3
70 # define COST_CENTRES_XML       4
71
72     int     profilerTicks;   /* derived */
73     int     msecsPerTick;    /* derived */
74 };
75
76 #ifdef PROFILING
77 struct PROFILING_FLAGS {
78     unsigned int        doHeapProfile;
79
80     nat                 profileInterval;      /* delta between samples (in ms) */
81     nat                 profileIntervalTicks; /* delta between samples (in 'ticks') */
82     rtsBool             includeTSOs;
83
84
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
92
93     rtsBool             showCCSOnException;
94
95     nat                 maxRetainerSetSize;
96
97     char*               modSelector;
98     char*               descrSelector;
99     char*               typeSelector;
100     char*               ccSelector;
101     char*               ccsSelector;
102     char*               retainerSelector;
103     char*               bioSelector;
104
105 };
106 #elif defined(DEBUG)
107 # define NO_HEAP_PROFILING      0
108 # define HEAP_BY_INFOPTR        1
109 # define HEAP_BY_CLOSURE_TYPE   2
110 struct PROFILING_FLAGS {
111     unsigned int  doHeapProfile;     /* heap profile using symbol table */
112
113 };
114 #endif /* DEBUG || PROFILING */
115
116 struct CONCURRENT_FLAGS {
117     int ctxtSwitchTime;         /* in milliseconds */
118     int ctxtSwitchTicks;        /* derived */
119 };
120
121 #ifdef PAR
122 /* currently the same as GRAN_STATS_FLAGS */
123 struct PAR_STATS_FLAGS {
124   rtsBool Full;       /* Full .gr profile (rtsTrue) or only END events? */
125   rtsBool Suppressed; /* No .gr profile at all */
126   rtsBool Binary;     /* Binary profile? (not yet implemented) */
127   rtsBool Sparks;     /* Info on sparks in profile? */
128   rtsBool Heap;       /* Info on heap allocs in profile? */ 
129   rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
130   rtsBool Global;     /* Global statistics? (printed on shutdown; no log file) */
131 };
132
133 struct PAR_DEBUG_FLAGS {  
134   /* flags to control debugging output in various subsystems */
135   rtsBool verbose    : 1; /*    1 */
136   rtsBool bq         : 1; /*    2 */
137   rtsBool schedule   : 1; /*    4 */
138   rtsBool free       : 1; /*    8 */
139   rtsBool resume     : 1; /*   16 */
140   rtsBool weight     : 1; /*   32 */
141   rtsBool fetch      : 1; /*   64 */
142   rtsBool fish       : 1; /*  128 */
143   rtsBool tables     : 1; /*  256 */
144   rtsBool packet     : 1; /*  512 */
145   rtsBool pack       : 1; /* 1024 */
146   rtsBool paranoia   : 1; /* 2048 */
147 };
148
149 #define MAX_PAR_DEBUG_OPTION     11
150 #define PAR_DEBUG_MASK(n)        ((nat)(ldexp(1,n)))
151 #define MAX_PAR_DEBUG_MASK       ((nat)(ldexp(1,(MAX_PAR_DEBUG_OPTION+1))-1))
152
153 struct PAR_FLAGS {
154   struct PAR_STATS_FLAGS ParStats;  /* profile and stats output */
155   struct PAR_DEBUG_FLAGS Debug;         /* debugging options */
156   rtsBool  outputDisabled;        /* Disable output for performance purposes */
157   rtsBool  doFairScheduling;      /* Fair-ish scheduling (round robin; no time-slices) */
158   nat      packBufferSize;
159   nat      thunksToPack;          /* number of thunks in packet + 1 */ 
160   nat      globalising;           /* globalisation scheme */
161   nat      maxLocalSparks;        /* spark pool size */
162   nat      maxThreads;            /* thread pool size */
163   nat      maxFishes;             /* max number of active fishes */
164   rtsTime  fishDelay;             /* delay before sending a new fish */
165   long   wait;
166 };
167 #endif /* PAR */
168
169 #ifdef SMP
170 struct PAR_FLAGS {
171   nat            nNodes;         /* number of threads to run simultaneously */
172   unsigned int   maxLocalSparks;
173 };
174 #endif /* SMP */
175
176 #ifdef GRAN
177 struct GRAN_STATS_FLAGS {
178   rtsBool Full;       /* Full .gr profile (rtsTrue) or only END events? */
179   rtsBool Suppressed; /* No .gr profile at all */
180   rtsBool Binary;     /* Binary profile? (not yet implemented) */
181   rtsBool Sparks;     /* Info on sparks in profile? */
182   rtsBool Heap;       /* Info on heap allocs in profile? */ 
183   rtsBool NewLogfile; /* Use new log-file format? (not yet implemented) */
184   rtsBool Global;     /* Global statistics? (printed on shutdown; no log file) */
185 };
186
187 struct GRAN_COST_FLAGS {
188   /* Communication Cost Variables -- set in main program */
189   nat latency;              /* Latency for single packet */
190   nat additional_latency;   /* Latency for additional packets */
191   nat fetchtime;            
192   nat lunblocktime;         /* Time for local unblock */
193   nat gunblocktime;         /* Time for global unblock */
194   nat mpacktime;            /* Cost of creating a packet */     
195   nat munpacktime;          /* Cost of receiving a packet */    
196   nat mtidytime;            /* Cost of cleaning up after send */
197   
198   nat threadcreatetime;     /* Thread creation costs */
199   nat threadqueuetime;      /* Cost of adding a thread to the running/runnable queue */
200   nat threaddescheduletime; /* Cost of descheduling a thread */
201   nat threadscheduletime;   /* Cost of scheduling a thread */
202   nat threadcontextswitchtime;  /* Cost of context switch  */
203   
204   /* Instruction Costs */
205   nat arith_cost;        /* arithmetic instructions (+,i,< etc) */
206   nat branch_cost;       /* branch instructions */ 
207   nat load_cost;         /* load into register */
208   nat store_cost;        /* store into memory */
209   nat float_cost;        /* floating point operations */
210   
211   nat heapalloc_cost;    /* heap allocation costs */
212   
213   /* Overhead for granularity control mechanisms */
214   /* overhead per elem of spark queue */
215   nat pri_spark_overhead;
216   /* overhead per elem of thread queue */
217   nat pri_sched_overhead;
218 };
219
220 struct GRAN_DEBUG_FLAGS {  
221   /* flags to control debugging output in various subsystems */
222   rtsBool event_trace    : 1; /*    1 */
223   rtsBool event_stats    : 1; /*    2 */
224   rtsBool bq             : 1; /*    4 */
225   rtsBool pack           : 1; /*    8 */
226   rtsBool checkSparkQ    : 1; /*   16 */
227   rtsBool thunkStealing  : 1; /*   32 */
228   rtsBool randomSteal    : 1; /*   64 */
229   rtsBool findWork       : 1; /*  128 */
230   rtsBool unused         : 1; /*  256 */
231   rtsBool pri            : 1; /*  512 */
232   rtsBool checkLight     : 1; /* 1024 */
233   rtsBool sortedQ        : 1; /* 2048 */
234   rtsBool blockOnFetch   : 1; /* 4096 */
235   rtsBool packBuffer     : 1; /* 8192 */
236   rtsBool blockOnFetch_sanity : 1; /*  16384 */
237 };
238
239 #define MAX_GRAN_DEBUG_OPTION     14
240 #define GRAN_DEBUG_MASK(n)        ((nat)(ldexp(1,n)))
241 #define MAX_GRAN_DEBUG_MASK       ((nat)(ldexp(1,(MAX_GRAN_DEBUG_OPTION+1))-1))
242
243 struct GRAN_FLAGS {
244   struct GRAN_STATS_FLAGS GranSimStats;  /* profile and stats output */
245   struct GRAN_COST_FLAGS Costs;          /* cost metric for simulation */
246   struct GRAN_DEBUG_FLAGS Debug;         /* debugging options */
247
248   nat  maxThreads;              // ToDo: share with SMP and GUM
249   // rtsBool labelling;
250   nat  packBufferSize;
251   nat  packBufferSize_internal;
252
253   PEs proc;                     /* number of processors */
254   rtsBool Fishing;              /* Simulate GUM style fishing mechanism? */
255   nat maxFishes;                /* max number of spark or thread steals */
256   rtsTime time_slice;           /* max time slice of one reduction thread */
257
258     /* GrAnSim-Light: This version puts no bound on the number of
259          processors but in exchange doesn't model communication costs
260          (all communication is 0 cost). Mainly intended to show maximal
261          degree of parallelism in the program (*not* to simulate the
262          execution on a real machine). */
263    
264     rtsBool Light;
265
266     rtsBool DoFairSchedule ;        /* fair scheduling alg? default: unfair */
267     rtsBool DoAsyncFetch;           /* async. communication? */
268     rtsBool DoStealThreadsFirst;    /* prefer threads over sparks when stealing */
269   rtsBool DoAlwaysCreateThreads;  /* eager thread creation */
270   rtsBool DoBulkFetching;         /* bulk fetching */
271   rtsBool DoThreadMigration;      /* allow to move threads */
272   nat     FetchStrategy;         /* what to do when waiting for data */
273   rtsBool PreferSparksOfLocalNodes; /* prefer local over global sparks */
274   rtsBool DoPrioritySparking;     /* sparks sorted by priorities */
275   rtsBool DoPriorityScheduling;   /* threads sorted by priorities */
276   nat     SparkPriority;         /* threshold for cut-off mechanism */
277   nat     SparkPriority2;
278   rtsBool RandomPriorities;
279   rtsBool InversePriorities;
280   rtsBool IgnorePriorities;
281   nat     ThunksToPack;      /* number of thunks in packet + 1 */ 
282   rtsBool RandomSteal;        /* steal spark/thread from random proc */
283   rtsBool NoForward;        /* no forwarding of fetch messages */
284
285   // unsigned int           debug;
286   //  rtsBool event_trace;
287   //  rtsBool event_trace_all;
288 };
289 #endif /* GRAN */
290
291 #ifdef TICKY_TICKY
292 struct TICKY_FLAGS {
293     rtsBool showTickyStats;
294     FILE   *tickyFile;
295 };
296 #endif /* TICKY_TICKY */
297
298
299 /* Put them together: */
300
301 struct RTS_FLAGS {
302     struct GC_FLAGS     GcFlags;
303     struct CONCURRENT_FLAGS ConcFlags;
304
305 #ifdef DEBUG
306     struct DEBUG_FLAGS  DebugFlags;
307 #endif
308 #if defined(PROFILING) || defined(PAR)
309     struct COST_CENTRE_FLAGS CcFlags;
310 #endif
311 #if defined(PROFILING) || defined(DEBUG)
312     struct PROFILING_FLAGS ProfFlags;
313 #endif
314 #if defined(SMP) || defined(PAR)
315     struct PAR_FLAGS    ParFlags;
316 #endif
317 #ifdef GRAN
318     struct GRAN_FLAGS   GranFlags;
319 #endif
320 #ifdef TICKY_TICKY
321     struct TICKY_FLAGS  TickyFlags;
322 #endif
323 };
324
325 #ifdef COMPILING_RTS_MAIN
326 extern DLLIMPORT struct RTS_FLAGS RtsFlags;
327 #else
328 extern struct RTS_FLAGS RtsFlags;
329 #endif
330
331 /* Routines that operate-on/to-do-with RTS flags: */
332
333 void initRtsFlagsDefaults(void);
334 void setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[]);
335
336 /*
337  * The printf formats are here, so we are less likely to make
338  * overly-long filenames (with disastrous results).  No more than 128
339  * chars, please!  
340  */
341
342 #define STATS_FILENAME_MAXLEN   128
343
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"
355
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;
360 */
361 extern int     rts_argc;  /* ditto */
362 extern char   *rts_argv[];
363
364 #endif  /* RTSFLAGS_H */