Rts.h 7.52 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2
 *
Simon Marlow's avatar
Simon Marlow committed
3
 * (c) The GHC Team, 1998-2009
4
 *
Simon Marlow's avatar
Simon Marlow committed
5
6
 * RTS external APIs.  This file declares everything that the GHC RTS
 * exposes externally.
7
 *
8
9
10
 * To understand the structure of the RTS headers, see the wiki:
 *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
 *
11
12
13
14
15
 * ---------------------------------------------------------------------------*/

#ifndef RTS_H
#define RTS_H

16
17
18
19
#ifdef __cplusplus
extern "C" {
#endif

20
#ifndef IN_STG_CODE
21
#define IN_STG_CODE 0
22
23
24
#endif
#include "Stg.h"

Simon Marlow's avatar
Simon Marlow committed
25
26
#include "HsFFI.h"
#include "RtsAPI.h"
27

28
29
30
31
32
33
// Turn off inlining when debugging - it obfuscates things
#ifdef DEBUG
# undef  STATIC_INLINE
# define STATIC_INLINE static
#endif

Simon Marlow's avatar
Simon Marlow committed
34
#include "rts/Types.h"
35
36
37
38
39
40
41
42
43
44

#if __GNUC__ >= 3
/* Assume that a flexible array member at the end of a struct
 * can be defined thus: T arr[]; */
#define FLEXIBLE_ARRAY
#else
/* Assume that it must be defined thus: T arr[0]; */
#define FLEXIBLE_ARRAY 0
#endif

45
46
47
48
49
50
#if __GNUC__ >= 3
#define ATTRIBUTE_ALIGNED(n) __attribute__((aligned(n)))
#else
#define ATTRIBUTE_ALIGNED(n) /*nothing*/
#endif

Simon Marlow's avatar
Simon Marlow committed
51
52
53
// Symbols that are extern, but private to the RTS, are declared
// with visibility "hidden" to hide them outside the RTS shared
// library.
54
#if !defined(mingw32_HOST_OS)
Simon Marlow's avatar
Simon Marlow committed
55
#define RTS_PRIVATE  GNUC3_ATTRIBUTE(visibility("hidden"))
56
57
58
59
60
61
62
63
64
65
66
#else
#define RTS_PRIVATE  /* disabled: RTS_PRIVATE */
#endif

#if __GNUC__ > 4
#define BEGIN_RTS_PRIVATE #pragma GCC visibility push(hidden)
#define END_RTS_PRIVATE   #pragma GCC visibility pop
#else
#define BEGIN_RTS_PRIVATE /* disabled: BEGIN_RTS_PRIVATE */
#define END_RTS_PRIVATE   /* disabled: END_RTS_PRIVATE */
#endif
Simon Marlow's avatar
Simon Marlow committed
67

68
/* Fix for mingw stat problem (done here so it's early enough) */
69
#ifdef mingw32_HOST_OS
70
71
72
#define __MSVCRT__ 1
#endif

73
74
/* Needed to get the macro version of errno on some OSs, and also to
   get prototypes for the _r versions of C library functions. */
75
#ifndef _REENTRANT
76
#define _REENTRANT 1
77
#endif
78

79
80
81
82
/*
 * We often want to know the size of something in units of an
 * StgWord... (rounded up, of course!)
 */
83
84
85
#define ROUNDUP_BYTES_TO_WDS(n) (((n) + sizeof(W_) - 1) / sizeof(W_))

#define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
86
87
88
89

/* -----------------------------------------------------------------------------
   Assertions and Debuggery

90
91
92
   CHECK(p)   evaluates p and terminates with an error if p is false
   ASSERT(p)  like CHECK(p) if DEBUG is on, otherwise a no-op
   -------------------------------------------------------------------------- */
93

Simon Marlow's avatar
Simon Marlow committed
94
95
void _assertFail(const char *filename, unsigned int linenum)
   GNUC3_ATTRIBUTE(__noreturn__);
96

97
#define CHECK(predicate)			\
98
99
100
	if (predicate)				\
	    /*null*/;				\
	else					\
101
	    _assertFail(__FILE__, __LINE__)
102
103
104
105
106

#ifndef DEBUG
#define ASSERT(predicate) /* nothing */
#else
#define ASSERT(predicate) CHECK(predicate)
107
108
109
110
111
112
113
114
115
116
#endif /* DEBUG */

/* 
 * Use this on the RHS of macros which expand to nothing
 * to make sure that the macro can be used in a context which
 * demands a non-empty statement.
 */

#define doNothing() do { } while (0)

117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
#ifdef DEBUG
#define USED_IF_DEBUG
#define USED_IF_NOT_DEBUG STG_UNUSED
#else
#define USED_IF_DEBUG STG_UNUSED
#define USED_IF_NOT_DEBUG
#endif

#ifdef THREADED_RTS
#define USED_IF_THREADS
#define USED_IF_NOT_THREADS STG_UNUSED
#else
#define USED_IF_THREADS STG_UNUSED
#define USED_IF_NOT_THREADS
#endif

Simon Marlow's avatar
Simon Marlow committed
133
134
135
136
137
138
139
140
141
142
143
/*
 * Getting printf formats right for platform-dependent typedefs
 */
#if SIZEOF_LONG == 8
#define FMT_Word64 "lu"
#define FMT_Int64  "ld"
#else
#define FMT_Word64 "llu"
#define FMT_Int64  "lld"
#endif

144
145
146
147
148
149
150
151
152
153
154
/* -----------------------------------------------------------------------------
   Include everything STG-ish
   -------------------------------------------------------------------------- */

/* System headers: stdlib.h is eeded so that we can use NULL.  It must
 * come after MachRegs.h, because stdlib.h might define some inline
 * functions which may only be defined after register variables have
 * been declared.
 */
#include <stdlib.h>

Simon Marlow's avatar
Simon Marlow committed
155
156
#include "rts/Config.h"

157
/* Global constaints */
Simon Marlow's avatar
Simon Marlow committed
158
#include "rts/Constants.h"
159
160

/* Profiling information */
Simon Marlow's avatar
Simon Marlow committed
161
162
#include "rts/prof/CCS.h"
#include "rts/prof/LDV.h"
163
164

/* Parallel information */
Simon Marlow's avatar
Simon Marlow committed
165
166
#include "rts/OSThreads.h"
#include "rts/SpinLock.h"
167

Simon Marlow's avatar
Simon Marlow committed
168
#include "rts/Messages.h"
169

Simon Marlow's avatar
Simon Marlow committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/* Storage format definitions */
#include "rts/storage/FunTypes.h"
#include "rts/storage/InfoTables.h"
#include "rts/storage/Closures.h"
#include "rts/storage/Liveness.h"
#include "rts/storage/ClosureTypes.h"
#include "rts/storage/TSO.h"
#include "stg/MiscClosures.h" /* InfoTables, closures etc. defined in the RTS */
#include "rts/storage/SMPClosureOps.h"
#include "rts/storage/Block.h"
#include "rts/storage/ClosureMacros.h"
#include "rts/storage/MBlock.h"
#include "rts/storage/GC.h"

/* Other RTS external APIs */
#include "rts/Parallel.h"
#include "rts/Hooks.h"
#include "rts/Signals.h"
188
#include "rts/BlockSignals.h"
Simon Marlow's avatar
Simon Marlow committed
189
190
191
192
193
194
195
196
#include "rts/Hpc.h"
#include "rts/Flags.h"
#include "rts/Adjustor.h"
#include "rts/FileLock.h"
#include "rts/Globals.h"
#include "rts/IOManager.h"
#include "rts/Linker.h"
#include "rts/Threads.h"
197
#include "rts/Ticky.h"
Simon Marlow's avatar
Simon Marlow committed
198
199
#include "rts/Timer.h"
#include "rts/Stable.h"
200
#include "rts/TTY.h"
201
202
#include "rts/Utils.h"
#include "rts/PrimFloat.h"
203
204
205
206
207
208

/* Misc stuff without a home */
DLL_IMPORT_RTS extern char **prog_argv;	/* so we can get at these from Haskell */
DLL_IMPORT_RTS extern int    prog_argc;
DLL_IMPORT_RTS extern char  *prog_name;

Simon Marlow's avatar
Simon Marlow committed
209
void stackOverflow(void);
210

Simon Marlow's avatar
Simon Marlow committed
211
void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
212

Simon Marlow's avatar
Simon Marlow committed
213
214
215
#ifndef mingw32_HOST_OS
int stg_sig_install (int, int, void *);
#endif
216

217
/* -----------------------------------------------------------------------------
218
   RTS Exit codes
219
220
   -------------------------------------------------------------------------- */

221
222
223
224
225
226
227
228
229
230
231
/* 255 is allegedly used by dynamic linkers to report linking failure */
#define EXIT_INTERNAL_ERROR 254
#define EXIT_DEADLOCK       253
#define EXIT_INTERRUPTED    252
#define EXIT_HEAPOVERFLOW   251
#define EXIT_KILLED         250

/* -----------------------------------------------------------------------------
   Miscellaneous garbage
   -------------------------------------------------------------------------- */

232
233
234
/* declarations for runtime flags/values */
#define MAX_RTS_ARGS 32

Simon Marlow's avatar
Simon Marlow committed
235
236
237
238
239
240
241
242
243
244
245
246
#ifdef DEBUG
#define TICK_VAR(arity) \
  extern StgInt SLOW_CALLS_##arity; \
  extern StgInt RIGHT_ARITY_##arity; \
  extern StgInt TAGGED_PTR_##arity;

extern StgInt TOTAL_CALLS;

TICK_VAR(1)
TICK_VAR(2)
#endif

247
/* -----------------------------------------------------------------------------
248
   Assertions and Debuggery
249
250
   -------------------------------------------------------------------------- */

251
#define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
252

253
#ifdef DEBUG
254
255
256
#if IN_STG_CODE
#define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
#else
257
#define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
258
#endif
259
#else
260
#define IF_DEBUG(c,s)  doNothing()
261
262
#endif

263
264
265
266
267
268
#ifdef DEBUG
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) doNothing()
#endif

269
/* -----------------------------------------------------------------------------
270
   Useful macros and inline functions
271
272
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
273
274
275
276
277
#if defined(__GNUC__)
#define SUPPORTS_TYPEOF
#endif

#if defined(SUPPORTS_TYPEOF)
278
279
#define stg_min(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _a : _b; })
#define stg_max(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _b : _a; })
sof's avatar
sof committed
280
281
282
283
#else
#define stg_min(a,b) ((a) <= (b) ? (a) : (b))
#define stg_max(a,b) ((a) <= (b) ? (b) : (a))
#endif
284

285
286
287
288
289
290
/* -------------------------------------------------------------------------- */

#ifdef __cplusplus
}
#endif

291
#endif /* RTS_H */