Rts.h 8.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
 * To understand the structure of the RTS headers, see the wiki:
9
 *   https://gitlab.haskell.org/ghc/ghc/wikis/commentary/source-tree/includes
10
 *
11 12
 * ---------------------------------------------------------------------------*/

13
#pragma once
14

Ben Gamari's avatar
Ben Gamari committed
15
#if defined(__cplusplus)
16 17 18
extern "C" {
#endif

19 20 21 22 23 24 25
/* We include windows.h very early, as on Win64 the CONTEXT type has
   fields "R8", "R9" and "R10", which goes bad if we've already
   #define'd those names for our own purposes (in stg/Regs.h) */
#if defined(HAVE_WINDOWS_H)
#include <windows.h>
#endif

Ben Gamari's avatar
Ben Gamari committed
26
#if !defined(IN_STG_CODE)
27
#define IN_STG_CODE 0
28 29 30
#endif
#include "Stg.h"

Simon Marlow's avatar
Simon Marlow committed
31 32
#include "HsFFI.h"
#include "RtsAPI.h"
33

34
// Turn off inlining when debugging - it obfuscates things
Ben Gamari's avatar
Ben Gamari committed
35
#if defined(DEBUG)
36 37 38 39
# undef  STATIC_INLINE
# define STATIC_INLINE static
#endif

Simon Marlow's avatar
Simon Marlow committed
40
#include "rts/Types.h"
Simon Marlow's avatar
Simon Marlow committed
41
#include "rts/Time.h"
42

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

Simon Marlow's avatar
Simon Marlow committed
49 50 51
// Symbols that are extern, but private to the RTS, are declared
// with visibility "hidden" to hide them outside the RTS shared
// library.
52
#if defined(HAS_VISIBILITY_HIDDEN)
Simon Marlow's avatar
Simon Marlow committed
53
#define RTS_PRIVATE  GNUC3_ATTRIBUTE(visibility("hidden"))
54 55 56 57
#else
#define RTS_PRIVATE  /* disabled: RTS_PRIVATE */
#endif

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

#if __GNUC__ >= 4
#define RTS_LIKELY(p) __builtin_expect(!!(p), 1)
#else
#define RTS_LIKELY(p) (p)
68 69
#endif

70 71 72 73 74 75 76
/* __builtin_unreachable is supported since GNU C 4.5 */
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
#define RTS_UNREACHABLE __builtin_unreachable()
#else
#define RTS_UNREACHABLE abort()
#endif

77
/* Fix for mingw stat problem (done here so it's early enough) */
Ben Gamari's avatar
Ben Gamari committed
78
#if defined(mingw32_HOST_OS)
79 80 81
#define __MSVCRT__ 1
#endif

82 83
/* Needed to get the macro version of errno on some OSs, and also to
   get prototypes for the _r versions of C library functions. */
Ben Gamari's avatar
Ben Gamari committed
84
#if !defined(_REENTRANT)
85
#define _REENTRANT 1
86
#endif
87

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

#define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
95 96 97 98

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

99 100 101
   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
   -------------------------------------------------------------------------- */
102

Simon Marlow's avatar
Simon Marlow committed
103 104
void _assertFail(const char *filename, unsigned int linenum)
   GNUC3_ATTRIBUTE(__noreturn__);
105

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

112
#define CHECKM(predicate, msg, ...)             \
113 114 115
        if (predicate)                          \
            /*null*/;                           \
        else                                    \
116 117
            barf(msg, ##__VA_ARGS__)

Ben Gamari's avatar
Ben Gamari committed
118
#if !defined(DEBUG)
119
#define ASSERT(predicate) /* nothing */
120
#define ASSERTM(predicate,msg,...) /* nothing */
121 122
#else
#define ASSERT(predicate) CHECK(predicate)
123
#define ASSERTM(predicate,msg,...) CHECKM(predicate,msg,##__VA_ARGS__)
124 125
#endif /* DEBUG */

126
/*
127 128 129 130 131 132 133
 * 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)

Ben Gamari's avatar
Ben Gamari committed
134
#if defined(DEBUG)
135 136 137 138 139 140 141
#define USED_IF_DEBUG
#define USED_IF_NOT_DEBUG STG_UNUSED
#else
#define USED_IF_DEBUG STG_UNUSED
#define USED_IF_NOT_DEBUG
#endif

Ben Gamari's avatar
Ben Gamari committed
142
#if defined(THREADED_RTS)
143 144 145 146 147 148 149
#define USED_IF_THREADS
#define USED_IF_NOT_THREADS STG_UNUSED
#else
#define USED_IF_THREADS STG_UNUSED
#define USED_IF_NOT_THREADS
#endif

150 151 152 153 154 155 156 157
#if defined(PROFILING)
#define USED_IF_PROFILING
#define USED_IF_NOT_PROFILING STG_UNUSED
#else
#define USED_IF_PROFILING STG_UNUSED
#define USED_IF_NOT_PROFILING
#endif

Ian Lynagh's avatar
Ian Lynagh committed
158 159
#define FMT_SizeT    "zu"
#define FMT_HexSizeT "zx"
Simon Marlow's avatar
Simon Marlow committed
160

161 162 163 164
/* -----------------------------------------------------------------------------
   Include everything STG-ish
   -------------------------------------------------------------------------- */

ian@well-typed.com's avatar
ian@well-typed.com committed
165
/* System headers: stdlib.h is needed so that we can use NULL.  It must
166 167 168 169 170 171
 * 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
172 173
#include "rts/Config.h"

174
/* Global constraints */
Simon Marlow's avatar
Simon Marlow committed
175
#include "rts/Constants.h"
176 177

/* Profiling information */
Simon Marlow's avatar
Simon Marlow committed
178 179
#include "rts/prof/CCS.h"
#include "rts/prof/LDV.h"
180 181

/* Parallel information */
Simon Marlow's avatar
Simon Marlow committed
182 183
#include "rts/OSThreads.h"
#include "rts/SpinLock.h"
184

Simon Marlow's avatar
Simon Marlow committed
185
#include "rts/Messages.h"
186
#include "rts/Threads.h"
187

Simon Marlow's avatar
Simon Marlow committed
188 189 190 191
/* Storage format definitions */
#include "rts/storage/FunTypes.h"
#include "rts/storage/InfoTables.h"
#include "rts/storage/Closures.h"
patrickdoc's avatar
patrickdoc committed
192
#include "rts/storage/Heap.h"
Simon Marlow's avatar
Simon Marlow committed
193 194 195 196 197 198 199
#include "rts/storage/ClosureTypes.h"
#include "rts/storage/TSO.h"
#include "stg/MiscClosures.h" /* InfoTables, closures etc. defined in the RTS */
#include "rts/storage/Block.h"
#include "rts/storage/ClosureMacros.h"
#include "rts/storage/MBlock.h"
#include "rts/storage/GC.h"
200
#include "rts/NonMoving.h"
Simon Marlow's avatar
Simon Marlow committed
201 202 203 204

/* Other RTS external APIs */
#include "rts/Parallel.h"
#include "rts/Signals.h"
205
#include "rts/BlockSignals.h"
Simon Marlow's avatar
Simon Marlow committed
206 207 208 209
#include "rts/Hpc.h"
#include "rts/Flags.h"
#include "rts/Adjustor.h"
#include "rts/FileLock.h"
210
#include "rts/GetTime.h"
Simon Marlow's avatar
Simon Marlow committed
211 212 213
#include "rts/Globals.h"
#include "rts/IOManager.h"
#include "rts/Linker.h"
214
#include "rts/Ticky.h"
Simon Marlow's avatar
Simon Marlow committed
215
#include "rts/Timer.h"
David Feuer's avatar
David Feuer committed
216 217
#include "rts/StablePtr.h"
#include "rts/StableName.h"
218
#include "rts/TTY.h"
219 220
#include "rts/Utils.h"
#include "rts/PrimFloat.h"
221
#include "rts/Main.h"
222
#include "rts/Profiling.h"
223
#include "rts/StaticPtrTable.h"
224
#include "rts/Libdw.h"
225
#include "rts/LibdwPool.h"
226 227

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

232 233
void reportStackOverflow(StgTSO* tso);
void reportHeapOverflow(void);
234

Simon Marlow's avatar
Simon Marlow committed
235
void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
236

Ben Gamari's avatar
Ben Gamari committed
237
#if !defined(mingw32_HOST_OS)
Simon Marlow's avatar
Simon Marlow committed
238 239
int stg_sig_install (int, int, void *);
#endif
240

241 242 243 244 245 246 247 248 249 250
/* -----------------------------------------------------------------------------
   Ways
   -------------------------------------------------------------------------- */

// Returns non-zero if the RTS is a profiling version
int rts_isProfiled(void);

// Returns non-zero if the RTS is a dynamically-linked version
int rts_isDynamic(void);

251
/* -----------------------------------------------------------------------------
252
   RTS Exit codes
253 254
   -------------------------------------------------------------------------- */

255 256 257 258 259 260 261 262 263 264 265
/* 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
   -------------------------------------------------------------------------- */

Ben Gamari's avatar
Ben Gamari committed
266
#if defined(DEBUG)
Simon Marlow's avatar
Simon Marlow committed
267 268 269 270 271 272 273 274 275 276 277
#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

278
/* -----------------------------------------------------------------------------
279
   Assertions and Debuggery
280 281
   -------------------------------------------------------------------------- */

282
#define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; } doNothing()
283

Ben Gamari's avatar
Ben Gamari committed
284
#if defined(DEBUG)
285
/* See Note [RtsFlags is a pointer in STG code] */
286
#if IN_STG_CODE
287
#define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; } doNothing()
288
#else
289
#define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; } doNothing()
290
#endif /* IN_STG_CODE */
291
#else
292
#define IF_DEBUG(c,s)  doNothing()
293
#endif /* DEBUG */
294

Ben Gamari's avatar
Ben Gamari committed
295
#if defined(DEBUG)
296 297 298
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) doNothing()
299
#endif /* DEBUG */
300

Ben Gamari's avatar
Ben Gamari committed
301
#if defined(DEBUG)
302 303 304
#define DEBUG_IS_ON   1
#else
#define DEBUG_IS_ON   0
305
#endif /* DEBUG */
306

307
/* -----------------------------------------------------------------------------
308
   Useful macros and inline functions
309 310
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
311 312 313 314 315
#if defined(__GNUC__)
#define SUPPORTS_TYPEOF
#endif

#if defined(SUPPORTS_TYPEOF)
316 317
#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
318 319 320 321
#else
#define stg_min(a,b) ((a) <= (b) ? (a) : (b))
#define stg_max(a,b) ((a) <= (b) ? (b) : (a))
#endif
322

323 324
/* -------------------------------------------------------------------------- */

Ben Gamari's avatar
Ben Gamari committed
325
#if defined(__cplusplus)
326 327
}
#endif