Rts.h 9.33 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
 *   http://ghc.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
10
 *
11 12 13 14 15
 * ---------------------------------------------------------------------------*/

#ifndef RTS_H
#define RTS_H

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

20 21 22 23 24 25 26
/* 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

27
#ifndef IN_STG_CODE
28
#define IN_STG_CODE 0
29 30 31
#endif
#include "Stg.h"

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

35 36 37 38 39 40
// 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
41
#include "rts/Types.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 61 62 63
#define RTS_UNLIKELY(p) __builtin_expect((p),0)
#else
#define RTS_UNLIKELY(p) p
#endif

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

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

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

#define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
82 83 84 85

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

86 87 88
   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
   -------------------------------------------------------------------------- */
89

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

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

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

105 106
#ifndef DEBUG
#define ASSERT(predicate) /* nothing */
107
#define ASSERTM(predicate,msg,...) /* nothing */
108 109
#else
#define ASSERT(predicate) CHECK(predicate)
110
#define ASSERTM(predicate,msg,...) CHECKM(predicate,msg,##__VA_ARGS__)
111 112
#endif /* DEBUG */

113
/*
114 115 116 117 118 119 120
 * 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)

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
#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

Ian Lynagh's avatar
Ian Lynagh committed
137 138
#define FMT_SizeT    "zu"
#define FMT_HexSizeT "zx"
Simon Marlow's avatar
Simon Marlow committed
139

Simon Marlow's avatar
Simon Marlow committed
140 141 142 143 144 145 146 147 148 149
/* -----------------------------------------------------------------------------
   Time values in the RTS
   -------------------------------------------------------------------------- */

// For most time values in the RTS we use a fixed resolution of nanoseconds,
// normalising the time we get from platform-dependent APIs to this
// resolution.
#define TIME_RESOLUTION 1000000000
typedef StgInt64 Time;

150 151
#define TIME_MAX HS_INT64_MAX

Simon Marlow's avatar
Simon Marlow committed
152 153
#if TIME_RESOLUTION == 1000000000
// I'm being lazy, but it's awkward to define fully general versions of these
Ian Lynagh's avatar
Ian Lynagh committed
154
#define TimeToUS(t)      ((t) / 1000)
Simon Marlow's avatar
Simon Marlow committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
#define TimeToNS(t)      (t)
#define USToTime(t)      ((Time)(t) * 1000)
#define NSToTime(t)      ((Time)(t))
#else
#error Fix TimeToNS(), TimeToUS() etc.
#endif

#define SecondsToTime(t) ((Time)(t) * TIME_RESOLUTION)
#define TimeToSeconds(t) ((t) / TIME_RESOLUTION)

// Use instead of SecondsToTime() when we have a floating-point
// seconds value, to avoid truncating it.
INLINE_HEADER Time fsecondsToTime (double t)
{
    return (Time)(t * TIME_RESOLUTION);
}

172 173 174 175
/* -----------------------------------------------------------------------------
   Include everything STG-ish
   -------------------------------------------------------------------------- */

ian@well-typed.com's avatar
ian@well-typed.com committed
176
/* System headers: stdlib.h is needed so that we can use NULL.  It must
177 178 179 180 181 182
 * 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
183 184
#include "rts/Config.h"

185
/* Global constraints */
Simon Marlow's avatar
Simon Marlow committed
186
#include "rts/Constants.h"
187 188

/* Profiling information */
Simon Marlow's avatar
Simon Marlow committed
189 190
#include "rts/prof/CCS.h"
#include "rts/prof/LDV.h"
191 192

/* Parallel information */
Simon Marlow's avatar
Simon Marlow committed
193 194
#include "rts/OSThreads.h"
#include "rts/SpinLock.h"
195

Simon Marlow's avatar
Simon Marlow committed
196
#include "rts/Messages.h"
197
#include "rts/Threads.h"
198

Simon Marlow's avatar
Simon Marlow committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
/* Storage format definitions */
#include "rts/storage/FunTypes.h"
#include "rts/storage/InfoTables.h"
#include "rts/storage/Closures.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/Signals.h"
215
#include "rts/BlockSignals.h"
Simon Marlow's avatar
Simon Marlow committed
216 217 218 219
#include "rts/Hpc.h"
#include "rts/Flags.h"
#include "rts/Adjustor.h"
#include "rts/FileLock.h"
220
#include "rts/GetTime.h"
Simon Marlow's avatar
Simon Marlow committed
221 222 223
#include "rts/Globals.h"
#include "rts/IOManager.h"
#include "rts/Linker.h"
224
#include "rts/Ticky.h"
Simon Marlow's avatar
Simon Marlow committed
225 226
#include "rts/Timer.h"
#include "rts/Stable.h"
227
#include "rts/TTY.h"
228 229
#include "rts/Utils.h"
#include "rts/PrimFloat.h"
230
#include "rts/Main.h"
Facundo Domínguez's avatar
Facundo Domínguez committed
231
#include "rts/StaticPtrTable.h"
232
#include "rts/Libdw.h"
233
#include "rts/LibdwPool.h"
234 235

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

240 241 242 243 244 245
#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

246
void stackOverflow(StgTSO* tso);
247

Simon Marlow's avatar
Simon Marlow committed
248
void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
249

Simon Marlow's avatar
Simon Marlow committed
250 251 252
#ifndef mingw32_HOST_OS
int stg_sig_install (int, int, void *);
#endif
253

254 255 256 257 258 259 260 261 262 263
/* -----------------------------------------------------------------------------
   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);

264
/* -----------------------------------------------------------------------------
265
   RTS Exit codes
266 267
   -------------------------------------------------------------------------- */

268 269 270 271 272 273 274 275 276 277 278
/* 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
279 280 281 282 283 284 285 286 287 288 289 290
#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

291
/* -----------------------------------------------------------------------------
292
   Assertions and Debuggery
293 294
   -------------------------------------------------------------------------- */

295
#define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
296

297
#ifdef DEBUG
298 299 300
#if IN_STG_CODE
#define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
#else
301
#define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
302
#endif
303
#else
304
#define IF_DEBUG(c,s)  doNothing()
305 306
#endif

307 308 309 310 311 312
#ifdef DEBUG
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) doNothing()
#endif

313 314 315 316 317 318
#ifdef DEBUG
#define DEBUG_IS_ON   1
#else
#define DEBUG_IS_ON   0
#endif

319
/* -----------------------------------------------------------------------------
320
   Useful macros and inline functions
321 322
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
323 324 325 326 327
#if defined(__GNUC__)
#define SUPPORTS_TYPEOF
#endif

#if defined(SUPPORTS_TYPEOF)
328 329
#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
330 331 332 333
#else
#define stg_min(a,b) ((a) <= (b) ? (a) : (b))
#define stg_max(a,b) ((a) <= (b) ? (b) : (a))
#endif
334

335 336 337 338 339 340
/* -------------------------------------------------------------------------- */

#ifdef __cplusplus
}
#endif

341
#endif /* RTS_H */