1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2004
5 * Top-level include file for the RTS itself
7 * ---------------------------------------------------------------------------*/
21 // ToDo: move RtsExternal stuff elsewhere
22 #include "RtsExternal.h"
24 // Turn off inlining when debugging - it obfuscates things
27 # define STATIC_INLINE static
33 /* Assume that a flexible array member at the end of a struct
34 * can be defined thus: T arr[]; */
35 #define FLEXIBLE_ARRAY
37 /* Assume that it must be defined thus: T arr[0]; */
38 #define FLEXIBLE_ARRAY 0
41 /* Fix for mingw stat problem (done here so it's early enough) */
42 #ifdef mingw32_HOST_OS
46 /* Needed to get the macro version of errno on some OSs, and also to
47 get prototypes for the _r versions of C library functions. */
51 * We often want to know the size of something in units of an
52 * StgWord... (rounded up, of course!)
54 #define sizeofW(t) ((sizeof(t)+sizeof(W_)-1)/sizeof(W_))
57 * It's nice to be able to grep for casts
59 #define stgCast(ty,e) ((ty)(e))
61 /* -----------------------------------------------------------------------------
62 Assertions and Debuggery
63 -------------------------------------------------------------------------- */
66 #define ASSERT(predicate) /* nothing */
69 extern void _assertFail (const char *, unsigned int);
71 #define ASSERT(predicate) \
75 _assertFail(__FILE__, __LINE__)
79 * Use this on the RHS of macros which expand to nothing
80 * to make sure that the macro can be used in a context which
81 * demands a non-empty statement.
84 #define doNothing() do { } while (0)
88 #define USED_IF_NOT_DEBUG STG_UNUSED
90 #define USED_IF_DEBUG STG_UNUSED
91 #define USED_IF_NOT_DEBUG
95 #define USED_IF_THREADS
96 #define USED_IF_NOT_THREADS STG_UNUSED
98 #define USED_IF_THREADS STG_UNUSED
99 #define USED_IF_NOT_THREADS
103 * Getting printf formats right for platform-dependent typedefs
106 #define FMT_Word64 "lu"
107 #define FMT_Int64 "ld"
109 #define FMT_Word64 "llu"
110 #define FMT_Int64 "lld"
114 * Macros for untagging and retagging closure pointers
115 * For more information look at the comments in Cmm.h
118 static inline StgWord
119 GET_CLOSURE_TAG(StgClosure * p)
121 return (StgWord)p & TAG_MASK;
124 static inline StgClosure *
125 UNTAG_CLOSURE(StgClosure * p)
127 return (StgClosure*)((StgWord)p & ~TAG_MASK);
130 static inline StgClosure *
131 TAG_CLOSURE(StgWord tag,StgClosure * p)
133 return (StgClosure*)((StgWord)p | tag);
136 /* -----------------------------------------------------------------------------
137 Include everything STG-ish
138 -------------------------------------------------------------------------- */
140 /* System headers: stdlib.h is eeded so that we can use NULL. It must
141 * come after MachRegs.h, because stdlib.h might define some inline
142 * functions which may only be defined after register variables have
147 /* Global constaints */
148 #include "Constants.h"
150 /* Profiling information */
152 #include "StgLdvProf.h"
154 /* Storage format definitions */
156 #include "Closures.h"
157 #include "Liveness.h"
158 #include "ClosureTypes.h"
159 #include "InfoTables.h"
162 /* Info tables, closures & code fragments defined in the RTS */
163 #include "StgMiscClosures.h"
165 /* Simulated-parallel information */
168 /* Parallel information */
169 #include "Parallel.h"
170 #include "OSThreads.h"
171 #include "SMPClosureOps.h"
172 #include "SpinLock.h"
175 #if defined(HAVE_FRAMEWORK_GMP)
181 /* Macros for STG/C code */
183 #include "ClosureMacros.h"
185 /* Ticky-ticky counters */
186 #include "TickyCounters.h"
188 /* Runtime-system hooks */
190 #include "RtsMessages.h"
192 /* for StablePtr/getStablePtr/deRefStablePtr */
196 #include "ieee-flpt.h"
200 /* Misc stuff without a home */
201 DLL_IMPORT_RTS extern char **prog_argv; /* so we can get at these from Haskell */
202 DLL_IMPORT_RTS extern int prog_argc;
203 DLL_IMPORT_RTS extern char *prog_name;
205 extern void stackOverflow(void);
207 extern void __decodeDouble (MP_INT *man, I_ *_exp, StgDouble dbl);
208 extern void __decodeFloat (MP_INT *man, I_ *_exp, StgFloat flt);
209 extern void __decodeDouble_2Int (I_ *man_sign, W_ *man_high, W_ *man_low, I_ *exp, StgDouble dbl);
210 extern void __decodeFloat_Int (I_ *man, I_ *exp, StgFloat flt);
212 #if defined(WANT_DOTNET_SUPPORT)
213 #include "DNInvoke.h"
216 /* Initialising the whole adjustor thunk machinery. */
217 extern void initAdjustor(void);
219 extern void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
221 /* -----------------------------------------------------------------------------
223 -------------------------------------------------------------------------- */
225 /* 255 is allegedly used by dynamic linkers to report linking failure */
226 #define EXIT_INTERNAL_ERROR 254
227 #define EXIT_DEADLOCK 253
228 #define EXIT_INTERRUPTED 252
229 #define EXIT_HEAPOVERFLOW 251
230 #define EXIT_KILLED 250
232 /* -----------------------------------------------------------------------------
233 Miscellaneous garbage
234 -------------------------------------------------------------------------- */
236 /* declarations for runtime flags/values */
237 #define MAX_RTS_ARGS 32
240 #define TICK_VAR(arity) \
241 extern StgInt SLOW_CALLS_##arity; \
242 extern StgInt RIGHT_ARITY_##arity; \
243 extern StgInt TAGGED_PTR_##arity;
245 #define TICK_VAR_INI(arity) \
246 StgInt SLOW_CALLS_##arity = 1; \
247 StgInt RIGHT_ARITY_##arity = 1; \
248 StgInt TAGGED_PTR_##arity = 0;
250 extern StgInt TOTAL_CALLS;
256 /* -----------------------------------------------------------------------------
257 Assertions and Debuggery
258 -------------------------------------------------------------------------- */
260 #define IF_RTSFLAGS(c,s) if (RtsFlags.c) { s; }
262 /* -----------------------------------------------------------------------------
263 Assertions and Debuggery
264 -------------------------------------------------------------------------- */
268 #define IF_DEBUG(c,s) if (RtsFlags[0].DebugFlags.c) { s; }
270 #define IF_DEBUG(c,s) if (RtsFlags.DebugFlags.c) { s; }
273 #define IF_DEBUG(c,s) doNothing()
277 #define DEBUG_ONLY(s) s
279 #define DEBUG_ONLY(s) doNothing()
282 #if defined(GRAN) && defined(DEBUG)
283 #define IF_GRAN_DEBUG(c,s) if (RtsFlags.GranFlags.Debug.c) { s; }
285 #define IF_GRAN_DEBUG(c,s) doNothing()
288 #if defined(PAR) && defined(DEBUG)
289 #define IF_PAR_DEBUG(c,s) if (RtsFlags.ParFlags.Debug.c) { s; }
291 #define IF_PAR_DEBUG(c,s) doNothing()
294 /* -----------------------------------------------------------------------------
295 Useful macros and inline functions
296 -------------------------------------------------------------------------- */
298 #if defined(__GNUC__)
299 #define SUPPORTS_TYPEOF
302 #if defined(SUPPORTS_TYPEOF)
303 #define stg_min(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _a : _b; })
304 #define stg_max(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _b : _a; })
306 #define stg_min(a,b) ((a) <= (b) ? (a) : (b))
307 #define stg_max(a,b) ((a) <= (b) ? (b) : (a))
310 /* -------------------------------------------------------------------------- */
317 /* krc: I put this here because I don't think
318 it needs to be visible externally.
319 It used to be in StgTicky.h, but I got rid
322 /* -----------------------------------------------------------------------------
323 The StgEntCounter type - needed regardless of TICKY_TICKY
324 -------------------------------------------------------------------------- */
326 typedef struct _StgEntCounter {
327 /* Using StgWord for everything, becuase both the C and asm code
328 generators make trouble if you try to pack things tighter */
329 StgWord registeredp; /* 0 == no, 1 == yes */
330 StgInt arity; /* arity (static info) */
331 StgInt stk_args; /* # of args off stack */
332 /* (rest of args are in registers) */
333 char *str; /* name of the thing */
334 char *arg_kinds; /* info about the args types */
335 StgInt entry_count; /* Trips to fast entry code */
336 StgInt allocs; /* number of allocations by this fun */
337 struct _StgEntCounter *link;/* link to chain them all together */