Rts.h 7.62 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 69 70 71 72 73
#if __GNUC__ > 4
#define RTS_UNLIKELY(p) __builtin_expect((p),0)
#else
#define RTS_UNLIKELY(p) p
#endif

74
/* Fix for mingw stat problem (done here so it's early enough) */
75
#ifdef mingw32_HOST_OS
76 77 78
#define __MSVCRT__ 1
#endif

79 80
/* Needed to get the macro version of errno on some OSs, and also to
   get prototypes for the _r versions of C library functions. */
81
#ifndef _REENTRANT
82
#define _REENTRANT 1
83
#endif
84

85 86 87 88
/*
 * We often want to know the size of something in units of an
 * StgWord... (rounded up, of course!)
 */
89 90 91
#define ROUNDUP_BYTES_TO_WDS(n) (((n) + sizeof(W_) - 1) / sizeof(W_))

#define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
92 93 94 95

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

96 97 98
   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
   -------------------------------------------------------------------------- */
99

Simon Marlow's avatar
Simon Marlow committed
100 101
void _assertFail(const char *filename, unsigned int linenum)
   GNUC3_ATTRIBUTE(__noreturn__);
102

103
#define CHECK(predicate)			\
104 105 106
	if (predicate)				\
	    /*null*/;				\
	else					\
107
	    _assertFail(__FILE__, __LINE__)
108 109 110 111 112

#ifndef DEBUG
#define ASSERT(predicate) /* nothing */
#else
#define ASSERT(predicate) CHECK(predicate)
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 146 147 148 149
/*
 * 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

150 151 152 153 154 155 156 157 158 159 160
/* -----------------------------------------------------------------------------
   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
161 162
#include "rts/Config.h"

163
/* Global constaints */
Simon Marlow's avatar
Simon Marlow committed
164
#include "rts/Constants.h"
165 166

/* Profiling information */
Simon Marlow's avatar
Simon Marlow committed
167 168
#include "rts/prof/CCS.h"
#include "rts/prof/LDV.h"
169 170

/* Parallel information */
Simon Marlow's avatar
Simon Marlow committed
171 172
#include "rts/OSThreads.h"
#include "rts/SpinLock.h"
173

Simon Marlow's avatar
Simon Marlow committed
174
#include "rts/Messages.h"
175

Simon Marlow's avatar
Simon Marlow committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/* 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"
194
#include "rts/BlockSignals.h"
Simon Marlow's avatar
Simon Marlow committed
195 196 197 198 199 200 201 202
#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"
203
#include "rts/Ticky.h"
Simon Marlow's avatar
Simon Marlow committed
204 205
#include "rts/Timer.h"
#include "rts/Stable.h"
206
#include "rts/TTY.h"
207 208
#include "rts/Utils.h"
#include "rts/PrimFloat.h"
209 210 211 212 213 214

/* 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
215
void stackOverflow(void);
216

Simon Marlow's avatar
Simon Marlow committed
217
void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
218

Simon Marlow's avatar
Simon Marlow committed
219 220 221
#ifndef mingw32_HOST_OS
int stg_sig_install (int, int, void *);
#endif
222

223
/* -----------------------------------------------------------------------------
224
   RTS Exit codes
225 226
   -------------------------------------------------------------------------- */

227 228 229 230 231 232 233 234 235 236 237
/* 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
   -------------------------------------------------------------------------- */

238 239 240
/* declarations for runtime flags/values */
#define MAX_RTS_ARGS 32

Simon Marlow's avatar
Simon Marlow committed
241 242 243 244 245 246 247 248 249 250 251 252
#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

253
/* -----------------------------------------------------------------------------
254
   Assertions and Debuggery
255 256
   -------------------------------------------------------------------------- */

257
#define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
258

259
#ifdef DEBUG
260 261 262
#if IN_STG_CODE
#define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
#else
263
#define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
264
#endif
265
#else
266
#define IF_DEBUG(c,s)  doNothing()
267 268
#endif

269 270 271 272 273 274
#ifdef DEBUG
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) doNothing()
#endif

275
/* -----------------------------------------------------------------------------
276
   Useful macros and inline functions
277 278
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
279 280 281 282 283
#if defined(__GNUC__)
#define SUPPORTS_TYPEOF
#endif

#if defined(SUPPORTS_TYPEOF)
284 285
#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
286 287 288 289
#else
#define stg_min(a,b) ((a) <= (b) ? (a) : (b))
#define stg_max(a,b) ((a) <= (b) ? (b) : (a))
#endif
290

291 292 293 294 295 296
/* -------------------------------------------------------------------------- */

#ifdef __cplusplus
}
#endif

297
#endif /* RTS_H */