Rts.h 7.93 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(HAS_VISIBILITY_HIDDEN)
Simon Marlow's avatar
Simon Marlow committed
55
#define RTS_PRIVATE  GNUC3_ATTRIBUTE(visibility("hidden"))
56 57 58 59
#else
#define RTS_PRIVATE  /* disabled: RTS_PRIVATE */
#endif

60
#if __GNUC__ >= 4
61 62 63 64 65
#define RTS_UNLIKELY(p) __builtin_expect((p),0)
#else
#define RTS_UNLIKELY(p) p
#endif

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

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

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

#define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
84 85 86 87

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

88 89 90
   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
   -------------------------------------------------------------------------- */
91

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

95
#define CHECK(predicate)			\
96 97 98
	if (predicate)				\
	    /*null*/;				\
	else					\
99
	    _assertFail(__FILE__, __LINE__)
100

101 102 103 104 105 106
#define CHECKM(predicate, msg, ...)             \
	if (predicate)				\
	    /*null*/;				\
	else					\
            barf(msg, ##__VA_ARGS__)

107 108
#ifndef DEBUG
#define ASSERT(predicate) /* nothing */
109
#define ASSERTM(predicate,msg,...) /* nothing */
110 111
#else
#define ASSERT(predicate) CHECK(predicate)
112
#define ASSERTM(predicate,msg,...) CHECKM(predicate,msg,##__VA_ARGS__)
113 114 115 116 117 118 119 120 121 122
#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)

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
#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
139 140 141 142 143 144 145
/*
 * Getting printf formats right for platform-dependent typedefs
 */
#if SIZEOF_LONG == 8
#define FMT_Word64 "lu"
#define FMT_Int64  "ld"
#else
146 147 148 149 150 151
#if defined(mingw32_HOST_OS)
/* mingw doesn't understand %llu/%lld - it treats them as 32-bit
   rather than 64-bit */
#define FMT_Word64 "I64u"
#define FMT_Int64  "I64d"
#else
Simon Marlow's avatar
Simon Marlow committed
152 153 154
#define FMT_Word64 "llu"
#define FMT_Int64  "lld"
#endif
155
#endif
Simon Marlow's avatar
Simon Marlow committed
156

157 158 159 160 161 162 163 164 165 166 167
/* -----------------------------------------------------------------------------
   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
168 169
#include "rts/Config.h"

170
/* Global constaints */
Simon Marlow's avatar
Simon Marlow committed
171
#include "rts/Constants.h"
172 173

/* Profiling information */
Simon Marlow's avatar
Simon Marlow committed
174 175
#include "rts/prof/CCS.h"
#include "rts/prof/LDV.h"
176 177

/* Parallel information */
Simon Marlow's avatar
Simon Marlow committed
178 179
#include "rts/OSThreads.h"
#include "rts/SpinLock.h"
180

Simon Marlow's avatar
Simon Marlow committed
181
#include "rts/Messages.h"
182

Simon Marlow's avatar
Simon Marlow committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
/* 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"
201
#include "rts/BlockSignals.h"
Simon Marlow's avatar
Simon Marlow committed
202 203 204 205 206 207 208 209
#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"
210
#include "rts/Ticky.h"
Simon Marlow's avatar
Simon Marlow committed
211 212
#include "rts/Timer.h"
#include "rts/Stable.h"
213
#include "rts/TTY.h"
214 215
#include "rts/Utils.h"
#include "rts/PrimFloat.h"
216
#include "rts/Main.h"
217 218 219 220 221 222

/* 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;

223 224 225 226 227 228
#ifdef mingw32_HOST_OS
// We need these two from Haskell too
void getWin32ProgArgv(int *argc, wchar_t **argv[]);
void setWin32ProgArgv(int argc, wchar_t *argv[]);
#endif

Simon Marlow's avatar
Simon Marlow committed
229
void stackOverflow(void);
230

Simon Marlow's avatar
Simon Marlow committed
231
void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
232

Simon Marlow's avatar
Simon Marlow committed
233 234 235
#ifndef mingw32_HOST_OS
int stg_sig_install (int, int, void *);
#endif
236

237
/* -----------------------------------------------------------------------------
238
   RTS Exit codes
239 240
   -------------------------------------------------------------------------- */

241 242 243 244 245 246 247 248 249 250 251
/* 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
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
252 253 254 255 256 257 258 259 260 261 262 263
#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

264
/* -----------------------------------------------------------------------------
265
   Assertions and Debuggery
266 267
   -------------------------------------------------------------------------- */

268
#define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
269

270
#ifdef DEBUG
271 272 273
#if IN_STG_CODE
#define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
#else
274
#define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
275
#endif
276
#else
277
#define IF_DEBUG(c,s)  doNothing()
278 279
#endif

280 281 282 283 284 285
#ifdef DEBUG
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) doNothing()
#endif

286
/* -----------------------------------------------------------------------------
287
   Useful macros and inline functions
288 289
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
290 291 292 293 294
#if defined(__GNUC__)
#define SUPPORTS_TYPEOF
#endif

#if defined(SUPPORTS_TYPEOF)
295 296
#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
297 298 299 300
#else
#define stg_min(a,b) ((a) <= (b) ? (a) : (b))
#define stg_max(a,b) ((a) <= (b) ? (b) : (a))
#endif
301

302 303 304 305 306 307
/* -------------------------------------------------------------------------- */

#ifdef __cplusplus
}
#endif

308
#endif /* RTS_H */