Rts.h 6.74 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 11 12
 *
 * ---------------------------------------------------------------------------*/

#ifndef RTS_H
#define RTS_H

13 14 15 16
#ifdef __cplusplus
extern "C" {
#endif

17
#ifndef IN_STG_CODE
18
#define IN_STG_CODE 0
19 20 21
#endif
#include "Stg.h"

Simon Marlow's avatar
Simon Marlow committed
22 23
#include "HsFFI.h"
#include "RtsAPI.h"
24

25 26 27 28 29 30
// 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
31
#include "rts/Types.h"
32 33 34 35 36 37 38 39 40 41

#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

42 43 44 45 46 47
#if __GNUC__ >= 3
#define ATTRIBUTE_ALIGNED(n) __attribute__((aligned(n)))
#else
#define ATTRIBUTE_ALIGNED(n) /*nothing*/
#endif

48
/* Fix for mingw stat problem (done here so it's early enough) */
49
#ifdef mingw32_HOST_OS
50 51 52
#define __MSVCRT__ 1
#endif

53 54
/* Needed to get the macro version of errno on some OSs, and also to
   get prototypes for the _r versions of C library functions. */
55
#ifndef _REENTRANT
56
#define _REENTRANT 1
57
#endif
58

59 60 61 62
/*
 * We often want to know the size of something in units of an
 * StgWord... (rounded up, of course!)
 */
63 64 65
#define ROUNDUP_BYTES_TO_WDS(n) (((n) + sizeof(W_) - 1) / sizeof(W_))

#define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
66 67 68 69

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

70 71 72
   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
   -------------------------------------------------------------------------- */
73

Simon Marlow's avatar
Simon Marlow committed
74 75
void _assertFail(const char *filename, unsigned int linenum)
   GNUC3_ATTRIBUTE(__noreturn__);
76

77
#define CHECK(predicate)			\
78 79 80
	if (predicate)				\
	    /*null*/;				\
	else					\
81
	    _assertFail(__FILE__, __LINE__)
82 83 84 85 86

#ifndef DEBUG
#define ASSERT(predicate) /* nothing */
#else
#define ASSERT(predicate) CHECK(predicate)
87 88 89 90 91 92 93 94 95 96
#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)

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
#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
113 114 115 116 117 118 119 120 121 122 123
/*
 * 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

124 125 126 127 128 129 130 131 132 133 134
/* -----------------------------------------------------------------------------
   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
135 136
#include "rts/Config.h"

137
/* Global constaints */
Simon Marlow's avatar
Simon Marlow committed
138
#include "rts/Constants.h"
139 140

/* Profiling information */
Simon Marlow's avatar
Simon Marlow committed
141 142
#include "rts/prof/CCS.h"
#include "rts/prof/LDV.h"
143 144

/* Parallel information */
Simon Marlow's avatar
Simon Marlow committed
145 146
#include "rts/OSThreads.h"
#include "rts/SpinLock.h"
147

Simon Marlow's avatar
Simon Marlow committed
148
#include "rts/Messages.h"
149

Simon Marlow's avatar
Simon Marlow committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/* 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"
#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"
176
#include "rts/Ticky.h"
Simon Marlow's avatar
Simon Marlow committed
177 178
#include "rts/Timer.h"
#include "rts/Stable.h"
179 180 181 182 183 184

/* 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
185
void stackOverflow(void);
186

Simon Marlow's avatar
Simon Marlow committed
187
void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
188

Simon Marlow's avatar
Simon Marlow committed
189 190 191
#ifndef mingw32_HOST_OS
int stg_sig_install (int, int, void *);
#endif
192

193
/* -----------------------------------------------------------------------------
194
   RTS Exit codes
195 196
   -------------------------------------------------------------------------- */

197 198 199 200 201 202 203 204 205 206 207
/* 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
   -------------------------------------------------------------------------- */

208 209 210
/* declarations for runtime flags/values */
#define MAX_RTS_ARGS 32

Simon Marlow's avatar
Simon Marlow committed
211 212 213 214 215 216 217 218 219 220 221 222
#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

223
/* -----------------------------------------------------------------------------
224
   Assertions and Debuggery
225 226
   -------------------------------------------------------------------------- */

227
#define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
228

229
#ifdef DEBUG
230 231 232
#if IN_STG_CODE
#define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
#else
233
#define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
234
#endif
235
#else
236
#define IF_DEBUG(c,s)  doNothing()
237 238
#endif

239 240 241 242 243 244
#ifdef DEBUG
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) doNothing()
#endif

245
/* -----------------------------------------------------------------------------
246
   Useful macros and inline functions
247 248
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
249 250 251 252 253
#if defined(__GNUC__)
#define SUPPORTS_TYPEOF
#endif

#if defined(SUPPORTS_TYPEOF)
254 255
#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
256 257 258 259
#else
#define stg_min(a,b) ((a) <= (b) ? (a) : (b))
#define stg_max(a,b) ((a) <= (b) ? (b) : (a))
#endif
260

261 262 263 264 265 266
/* -------------------------------------------------------------------------- */

#ifdef __cplusplus
}
#endif

267
#endif /* RTS_H */