Flags.h 8.69 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
1 2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The GHC Team, 1998-2009
Simon Marlow's avatar
Simon Marlow committed
4 5 6
 *
 * Datatypes that holds the command-line flag settings.
 *
7 8 9
 * Do not #include this file directly: #include "Rts.h" instead.
 *
 * To understand the structure of the RTS headers, see the wiki:
10
 *   http://ghc.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
11
 *
Simon Marlow's avatar
Simon Marlow committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 * ---------------------------------------------------------------------------*/

#ifndef RTS_FLAGS_H
#define RTS_FLAGS_H

#include <stdio.h>

/* For defaults, see the @initRtsFlagsDefaults@ routine. */

struct GC_FLAGS {
    FILE   *statsFile;
    nat	    giveStats;
#define NO_GC_STATS	 0
#define COLLECT_GC_STATS 1
#define ONELINE_GC_STATS 2
#define SUMMARY_GC_STATS 3
#define VERBOSE_GC_STATS 4

    nat     maxStkSize;         /* in *words* */
    nat     initialStkSize;     /* in *words* */
32 33
    nat     stkChunkSize;       /* in *words* */
    nat     stkChunkBufferSize; /* in *words* */
Simon Marlow's avatar
Simon Marlow committed
34 35 36 37 38

    nat	    maxHeapSize;        /* in *blocks* */
    nat     minAllocAreaSize;   /* in *blocks* */
    nat     minOldGenSize;      /* in *blocks* */
    nat     heapSizeSuggestion; /* in *blocks* */
39
    rtsBool heapSizeSuggestionAuto;
Simon Marlow's avatar
Simon Marlow committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
    double  oldGenFactor;
    double  pcFreeHeap;

    nat     generations;
    nat     steps;
    rtsBool squeezeUpdFrames;

    rtsBool compact;		/* True <=> "compact all the time" */
    double  compactThreshold;

    rtsBool sweep;		/* use "mostly mark-sweep" instead of copying
                                 * for the oldest generation */
    rtsBool ringBell;
    rtsBool frontpanel;

Simon Marlow's avatar
Simon Marlow committed
55
    Time    idleGCDelayTime;    /* units: TIME_RESOLUTION */
56
    rtsBool doIdleGC;
Simon Marlow's avatar
Simon Marlow committed
57 58

    StgWord heapBase;           /* address to ask the OS for memory */
59 60 61 62 63 64 65 66

    StgWord allocLimitGrace;    /* units: *blocks*
                                 * After an AllocationLimitExceeded
                                 * exception has been raised, how much
                                 * extra space is given to the thread
                                 * to handle the exception before we
                                 * raise it again.
                                 */
Simon Marlow's avatar
Simon Marlow committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
};

struct DEBUG_FLAGS {  
    /* flags to control debugging output & extra checking in various subsystems */
    rtsBool scheduler;      /* 's' */
    rtsBool interpreter;    /* 'i' */
    rtsBool weak;           /* 'w' */
    rtsBool gccafs;         /* 'G' */
    rtsBool gc;             /* 'g' */
    rtsBool block_alloc;    /* 'b' */
    rtsBool sanity;         /* 'S'   warning: might be expensive! */
    rtsBool stable;         /* 't' */
    rtsBool prof;           /* 'p' */
    rtsBool linker;         /* 'l'   the object linker */
    rtsBool apply;          /* 'a' */
    rtsBool stm;            /* 'm' */
    rtsBool squeeze;        /* 'z'  stack squeezing & lazy blackholing */
    rtsBool hpc; 	    /* 'c' coverage */
85
    rtsBool sparks; 	    /* 'r' */
Simon Marlow's avatar
Simon Marlow committed
86 87 88
};

struct COST_CENTRE_FLAGS {
Gabor Greif's avatar
Gabor Greif committed
89
    nat	    doCostCentres;
Simon Marlow's avatar
Simon Marlow committed
90 91 92 93 94 95 96 97 98 99
# define COST_CENTRES_SUMMARY	1
# define COST_CENTRES_VERBOSE	2 /* incl. serial time profile */
# define COST_CENTRES_ALL	3
# define COST_CENTRES_XML       4

    int	    profilerTicks;   /* derived */
    int	    msecsPerTick;    /* derived */
};

struct PROFILING_FLAGS {
Gabor Greif's avatar
Gabor Greif committed
100
    nat	doHeapProfile;
Simon Marlow's avatar
Simon Marlow committed
101 102 103 104 105 106 107 108 109 110
# define NO_HEAP_PROFILING	0	/* N.B. Used as indexes into arrays */
# define HEAP_BY_CCS		1
# define HEAP_BY_MOD		2
# define HEAP_BY_DESCR		4
# define HEAP_BY_TYPE		5
# define HEAP_BY_RETAINER       6
# define HEAP_BY_LDV            7

# define HEAP_BY_CLOSURE_TYPE   8

Simon Marlow's avatar
Simon Marlow committed
111 112
    Time                heapProfileInterval; /* time between samples */
    nat                 heapProfileIntervalTicks; /* ticks between samples (derived) */
Simon Marlow's avatar
Simon Marlow committed
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
    rtsBool             includeTSOs;


    rtsBool		showCCSOnException;

    nat                 maxRetainerSetSize;

    nat                 ccsLength;

    char*               modSelector;
    char*               descrSelector;
    char*               typeSelector;
    char*               ccSelector;
    char*               ccsSelector;
    char*               retainerSelector;
    char*               bioSelector;

};

132 133 134 135
#define TRACE_NONE      0
#define TRACE_EVENTLOG  1
#define TRACE_STDERR    2

136
struct TRACE_FLAGS {
137
    int tracing;
138 139
    rtsBool timestamp;      /* show timestamp in stderr output */
    rtsBool scheduler;      /* trace scheduler events */
140
    rtsBool gc;             /* trace GC events */
141 142
    rtsBool sparks_sampled; /* trace spark events by a sampled method */
    rtsBool sparks_full;    /* trace spark events 100% accurately */
143
    rtsBool user;           /* trace user events (emitted from Haskell code) */
Simon Marlow's avatar
Simon Marlow committed
144 145 146
};

struct CONCURRENT_FLAGS {
Simon Marlow's avatar
Simon Marlow committed
147 148
    Time ctxtSwitchTime;         /* units: TIME_RESOLUTION */
    int ctxtSwitchTicks;         /* derived */
Simon Marlow's avatar
Simon Marlow committed
149 150
};

Simon Marlow's avatar
Simon Marlow committed
151 152 153 154 155 156 157 158 159
/*
 * The tickInterval is the time interval between "ticks", ie.
 * timer signals (see Timer.{c,h}).  It is the frequency at
 * which we sample CCCS for profiling.
 *
 * It is changed by the +RTS -V<secs> flag.
 */
#define DEFAULT_TICK_INTERVAL USToTime(10000)

Simon Marlow's avatar
Simon Marlow committed
160
struct MISC_FLAGS {
Simon Marlow's avatar
Simon Marlow committed
161
    Time    tickInterval;        /* units: TIME_RESOLUTION */
Simon Marlow's avatar
Simon Marlow committed
162 163 164 165 166 167 168 169 170 171
    rtsBool install_signal_handlers;
    rtsBool machineReadable;
    StgWord linkerMemBase;       /* address to ask the OS for memory
                                  * for the linker, NULL ==> off */
};

#ifdef THREADED_RTS
struct PAR_FLAGS {
  nat            nNodes;         /* number of threads to run simultaneously */
  rtsBool        migrate;        /* migrate threads between capabilities */
Gabor Greif's avatar
Gabor Greif committed
172
  nat            maxLocalSparks;
Simon Marlow's avatar
Simon Marlow committed
173
  rtsBool        parGcEnabled;   /* enable parallel GC */
Gabor Greif's avatar
Gabor Greif committed
174
  nat            parGcGen;       /* do parallel GC in this generation
Simon Marlow's avatar
Simon Marlow committed
175
                                  * and higher only */
176 177 178
  rtsBool        parGcLoadBalancingEnabled; 
                                 /* enable load-balancing in the
                                  * parallel GC */
Gabor Greif's avatar
Gabor Greif committed
179
  nat            parGcLoadBalancingGen;
180 181
                                 /* do load-balancing in this
                                  * generation and higher only */
182

Gabor Greif's avatar
Gabor Greif committed
183
  nat            parGcNoSyncWithIdle;
184 185 186 187 188 189
                                 /* if a Capability has been idle for
                                  * this many GCs, do not try to wake
                                  * it up when doing a
                                  * non-load-balancing parallel GC.
                                  * (zero disables) */

Simon Marlow's avatar
Simon Marlow committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  rtsBool        setAffinity;    /* force thread affinity with CPUs */
};
#endif /* THREADED_RTS */

struct TICKY_FLAGS {
    rtsBool showTickyStats;
    FILE   *tickyFile;
};

#ifdef USE_PAPI
#define MAX_PAPI_USER_EVENTS 8

struct PAPI_FLAGS {
    nat     eventType;          /* The type of events to count */
    nat     numUserEvents;
    char *  userEvents[MAX_PAPI_USER_EVENTS];
206 207
    /* Allow user to enter either PAPI preset or native events */
    nat     userEventsKind[MAX_PAPI_USER_EVENTS];
Simon Marlow's avatar
Simon Marlow committed
208 209 210 211 212 213 214 215
};

#define PAPI_FLAG_CACHE_L1 1
#define PAPI_FLAG_CACHE_L2 2
#define PAPI_FLAG_BRANCH 3
#define PAPI_FLAG_STALLS 4
#define PAPI_FLAG_CB_EVENTS 5
#define PAPI_USER_EVENTS 6
216 217
#define PAPI_PRESET_EVENT_KIND 0
#define PAPI_NATIVE_EVENT_KIND 1
Simon Marlow's avatar
Simon Marlow committed
218 219 220 221 222 223 224 225 226 227 228 229 230

#endif

/* Put them together: */

typedef struct _RTS_FLAGS {
    /* The first portion of RTS_FLAGS is invariant. */
    struct GC_FLAGS	     GcFlags;
    struct CONCURRENT_FLAGS  ConcFlags;
    struct MISC_FLAGS        MiscFlags;
    struct DEBUG_FLAGS	     DebugFlags;
    struct COST_CENTRE_FLAGS CcFlags;
    struct PROFILING_FLAGS   ProfFlags;
231
    struct TRACE_FLAGS       TraceFlags;
Simon Marlow's avatar
Simon Marlow committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    struct TICKY_FLAGS	     TickyFlags;

#if defined(THREADED_RTS)
    struct PAR_FLAGS	ParFlags;
#endif
#ifdef USE_PAPI
    struct PAPI_FLAGS   PapiFlags;
#endif
} RTS_FLAGS;

#ifdef COMPILING_RTS_MAIN
extern DLLIMPORT RTS_FLAGS RtsFlags;
#elif IN_STG_CODE
/* Hack because the C code generator can't generate '&label'. */
extern RTS_FLAGS RtsFlags[];
#else
extern RTS_FLAGS RtsFlags;
#endif

/*
 * The printf formats are here, so we are less likely to make
 * overly-long filenames (with disastrous results).  No more than 128
 * chars, please!  
 */

#define STATS_FILENAME_MAXLEN	128

#define GR_FILENAME_FMT		"%0.124s.gr"
#define GR_FILENAME_FMT_GUM	"%0.120s.%03d.%s"
#define HP_FILENAME_FMT		"%0.124s.hp"
#define LIFE_FILENAME_FMT	"%0.122s.life"
#define PROF_FILENAME_FMT	"%0.122s.prof"
#define PROF_FILENAME_FMT_GUM	"%0.118s.%03d.prof"
#define QP_FILENAME_FMT		"%0.124s.qp"
#define STAT_FILENAME_FMT	"%0.122s.stat"
#define TICKY_FILENAME_FMT	"%0.121s.ticky"
#define TIME_FILENAME_FMT	"%0.122s.time"
#define TIME_FILENAME_FMT_GUM	"%0.118s.%03d.time"

/* an "int" so as to match normal "argc" */
/* Now defined in Stg.h (lib/std/cbits need these too.)
extern int     prog_argc;
extern char  **prog_argv;
*/
276 277
extern int      rts_argc;  /* ditto */
extern char   **rts_argv;
Simon Marlow's avatar
Simon Marlow committed
278 279

#endif	/* RTS_FLAGS_H */