1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2009
5 * RTS external APIs. This file declares everything that the GHC RTS
8 * To understand the structure of the RTS headers, see the wiki:
9 * http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
11 * ---------------------------------------------------------------------------*/
28 // Turn off inlining when debugging - it obfuscates things
31 # define STATIC_INLINE static
34 #include "rts/Types.h"
37 /* Assume that a flexible array member at the end of a struct
38 * can be defined thus: T arr[]; */
39 #define FLEXIBLE_ARRAY
41 /* Assume that it must be defined thus: T arr[0]; */
42 #define FLEXIBLE_ARRAY 0
46 #define ATTRIBUTE_ALIGNED(n) __attribute__((aligned(n)))
48 #define ATTRIBUTE_ALIGNED(n) /*nothing*/
51 // Symbols that are extern, but private to the RTS, are declared
52 // with visibility "hidden" to hide them outside the RTS shared
54 #define RTS_PRIVATE GNUC3_ATTRIBUTE(visibility("hidden"))
56 /* Fix for mingw stat problem (done here so it's early enough) */
57 #ifdef mingw32_HOST_OS
61 /* Needed to get the macro version of errno on some OSs, and also to
62 get prototypes for the _r versions of C library functions. */
68 * We often want to know the size of something in units of an
69 * StgWord... (rounded up, of course!)
71 #define ROUNDUP_BYTES_TO_WDS(n) (((n) + sizeof(W_) - 1) / sizeof(W_))
73 #define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
75 /* -----------------------------------------------------------------------------
76 Assertions and Debuggery
78 CHECK(p) evaluates p and terminates with an error if p is false
79 ASSERT(p) like CHECK(p) if DEBUG is on, otherwise a no-op
80 -------------------------------------------------------------------------- */
82 void _assertFail(const char *filename, unsigned int linenum)
83 GNUC3_ATTRIBUTE(__noreturn__);
85 #define CHECK(predicate) \
89 _assertFail(__FILE__, __LINE__)
92 #define ASSERT(predicate) /* nothing */
94 #define ASSERT(predicate) CHECK(predicate)
98 * Use this on the RHS of macros which expand to nothing
99 * to make sure that the macro can be used in a context which
100 * demands a non-empty statement.
103 #define doNothing() do { } while (0)
106 #define USED_IF_DEBUG
107 #define USED_IF_NOT_DEBUG STG_UNUSED
109 #define USED_IF_DEBUG STG_UNUSED
110 #define USED_IF_NOT_DEBUG
114 #define USED_IF_THREADS
115 #define USED_IF_NOT_THREADS STG_UNUSED
117 #define USED_IF_THREADS STG_UNUSED
118 #define USED_IF_NOT_THREADS
122 * Getting printf formats right for platform-dependent typedefs
125 #define FMT_Word64 "lu"
126 #define FMT_Int64 "ld"
128 #define FMT_Word64 "llu"
129 #define FMT_Int64 "lld"
132 /* -----------------------------------------------------------------------------
133 Include everything STG-ish
134 -------------------------------------------------------------------------- */
136 /* System headers: stdlib.h is eeded so that we can use NULL. It must
137 * come after MachRegs.h, because stdlib.h might define some inline
138 * functions which may only be defined after register variables have
143 #include "rts/Config.h"
145 /* Global constaints */
146 #include "rts/Constants.h"
148 /* Profiling information */
149 #include "rts/prof/CCS.h"
150 #include "rts/prof/LDV.h"
152 /* Parallel information */
153 #include "rts/OSThreads.h"
154 #include "rts/SpinLock.h"
156 #include "rts/Messages.h"
158 /* Storage format definitions */
159 #include "rts/storage/FunTypes.h"
160 #include "rts/storage/InfoTables.h"
161 #include "rts/storage/Closures.h"
162 #include "rts/storage/Liveness.h"
163 #include "rts/storage/ClosureTypes.h"
164 #include "rts/storage/TSO.h"
165 #include "stg/MiscClosures.h" /* InfoTables, closures etc. defined in the RTS */
166 #include "rts/storage/SMPClosureOps.h"
167 #include "rts/storage/Block.h"
168 #include "rts/storage/ClosureMacros.h"
169 #include "rts/storage/MBlock.h"
170 #include "rts/storage/GC.h"
172 /* Other RTS external APIs */
173 #include "rts/Parallel.h"
174 #include "rts/Hooks.h"
175 #include "rts/Signals.h"
176 #include "rts/BlockSignals.h"
178 #include "rts/Flags.h"
179 #include "rts/Adjustor.h"
180 #include "rts/FileLock.h"
181 #include "rts/Globals.h"
182 #include "rts/IOManager.h"
183 #include "rts/Linker.h"
184 #include "rts/Threads.h"
185 #include "rts/Ticky.h"
186 #include "rts/Timer.h"
187 #include "rts/Stable.h"
189 #include "rts/Utils.h"
190 #include "rts/PrimFloat.h"
192 /* Misc stuff without a home */
193 DLL_IMPORT_RTS extern char **prog_argv; /* so we can get at these from Haskell */
194 DLL_IMPORT_RTS extern int prog_argc;
195 DLL_IMPORT_RTS extern char *prog_name;
197 void stackOverflow(void);
199 void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
201 #ifndef mingw32_HOST_OS
202 int stg_sig_install (int, int, void *);
205 /* -----------------------------------------------------------------------------
207 -------------------------------------------------------------------------- */
209 /* 255 is allegedly used by dynamic linkers to report linking failure */
210 #define EXIT_INTERNAL_ERROR 254
211 #define EXIT_DEADLOCK 253
212 #define EXIT_INTERRUPTED 252
213 #define EXIT_HEAPOVERFLOW 251
214 #define EXIT_KILLED 250
216 /* -----------------------------------------------------------------------------
217 Miscellaneous garbage
218 -------------------------------------------------------------------------- */
220 /* declarations for runtime flags/values */
221 #define MAX_RTS_ARGS 32
224 #define TICK_VAR(arity) \
225 extern StgInt SLOW_CALLS_##arity; \
226 extern StgInt RIGHT_ARITY_##arity; \
227 extern StgInt TAGGED_PTR_##arity;
229 extern StgInt TOTAL_CALLS;
235 /* -----------------------------------------------------------------------------
236 Assertions and Debuggery
237 -------------------------------------------------------------------------- */
239 #define IF_RTSFLAGS(c,s) if (RtsFlags.c) { s; }
243 #define IF_DEBUG(c,s) if (RtsFlags[0].DebugFlags.c) { s; }
245 #define IF_DEBUG(c,s) if (RtsFlags.DebugFlags.c) { s; }
248 #define IF_DEBUG(c,s) doNothing()
252 #define DEBUG_ONLY(s) s
254 #define DEBUG_ONLY(s) doNothing()
257 /* -----------------------------------------------------------------------------
258 Useful macros and inline functions
259 -------------------------------------------------------------------------- */
261 #if defined(__GNUC__)
262 #define SUPPORTS_TYPEOF
265 #if defined(SUPPORTS_TYPEOF)
266 #define stg_min(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _a : _b; })
267 #define stg_max(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _b : _a; })
269 #define stg_min(a,b) ((a) <= (b) ? (a) : (b))
270 #define stg_max(a,b) ((a) <= (b) ? (b) : (a))
273 /* -------------------------------------------------------------------------- */