includes/Rts.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2009
   4  *
   5  * RTS external APIs.  This file declares everything that the GHC RTS
   6  * exposes externally.
   7  *
   8  * To understand the structure of the RTS headers, see the wiki:
   9  *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
  10  *
  11  * ---------------------------------------------------------------------------*/
  12
  13 #ifndef RTS_H
  14 #define RTS_H
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #ifndef IN_STG_CODE
  21 #define IN_STG_CODE 0
  22 #endif
  23 #include "Stg.h"
  24
  25 #include "HsFFI.h"
  26 #include "RtsAPI.h"
  27
  28 // Turn off inlining when debugging - it obfuscates things
  29 #ifdef DEBUG
  30 # undef  STATIC_INLINE
  31 # define STATIC_INLINE static
  32 #endif
  33
  34 #include "rts/Types.h"
  35
  36 #if __GNUC__ >= 3
  37 /* Assume that a flexible array member at the end of a struct
  38  * can be defined thus: T arr[]; */
  39 #define FLEXIBLE_ARRAY
  40 #else
  41 /* Assume that it must be defined thus: T arr[0]; */
  42 #define FLEXIBLE_ARRAY 0
  43 #endif
  44
  45 #if __GNUC__ >= 3
  46 #define ATTRIBUTE_ALIGNED(n) __attribute__((aligned(n)))
  47 #else
  48 #define ATTRIBUTE_ALIGNED(n) /*nothing*/
  49 #endif
  50
  51 // Symbols that are extern, but private to the RTS, are declared
  52 // with visibility "hidden" to hide them outside the RTS shared
  53 // library.
  54 #if defined(HAS_VISIBILITY_HIDDEN)
  55 #define RTS_PRIVATE  GNUC3_ATTRIBUTE(visibility("hidden"))
  56 #else
  57 #define RTS_PRIVATE  /* disabled: RTS_PRIVATE */
  58 #endif
  59
  60 #if __GNUC__ >= 4
  61 #define RTS_UNLIKELY(p) __builtin_expect((p),0)
  62 #else
  63 #define RTS_UNLIKELY(p) p
  64 #endif
  65
  66 /* Fix for mingw stat problem (done here so it's early enough) */
  67 #ifdef mingw32_HOST_OS
  68 #define __MSVCRT__ 1
  69 #endif
  70
  71 /* Needed to get the macro version of errno on some OSs, and also to
  72    get prototypes for the _r versions of C library functions. */
  73 #ifndef _REENTRANT
  74 #define _REENTRANT 1
  75 #endif
  76
  77 /*
  78  * We often want to know the size of something in units of an
  79  * StgWord... (rounded up, of course!)
  80  */
  81 #define ROUNDUP_BYTES_TO_WDS(n) (((n) + sizeof(W_) - 1) / sizeof(W_))
  82
  83 #define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
  84
  85 /* -----------------------------------------------------------------------------
  86    Assertions and Debuggery
  87
  88    CHECK(p)   evaluates p and terminates with an error if p is false
  89    ASSERT(p)  like CHECK(p) if DEBUG is on, otherwise a no-op
  90    -------------------------------------------------------------------------- */
  91
  92 void _assertFail(const char *filename, unsigned int linenum)
  93    GNUC3_ATTRIBUTE(__noreturn__);
  94
  95 #define CHECK(predicate)                        \
  96         if (predicate)                          \
  97             /*null*/;                           \
  98         else                                    \
  99             _assertFail(__FILE__, __LINE__)
 100
 101 #define CHECKM(predicate, msg, ...)             \
 102         if (predicate)                          \
 103             /*null*/;                           \
 104         else                                    \
 105             barf(msg, ##__VA_ARGS__)
 106
 107 #ifndef DEBUG
 108 #define ASSERT(predicate) /* nothing */
 109 #define ASSERTM(predicate,msg,...) /* nothing */
 110 #else
 111 #define ASSERT(predicate) CHECK(predicate)
 112 #define ASSERTM(predicate,msg,...) CHECKM(predicate,msg,##__VA_ARGS__)
 113 #endif /* DEBUG */
 114
 115 /*
 116  * Use this on the RHS of macros which expand to nothing
 117  * to make sure that the macro can be used in a context which
 118  * demands a non-empty statement.
 119  */
 120
 121 #define doNothing() do { } while (0)
 122
 123 #ifdef DEBUG
 124 #define USED_IF_DEBUG
 125 #define USED_IF_NOT_DEBUG STG_UNUSED
 126 #else
 127 #define USED_IF_DEBUG STG_UNUSED
 128 #define USED_IF_NOT_DEBUG
 129 #endif
 130
 131 #ifdef THREADED_RTS
 132 #define USED_IF_THREADS
 133 #define USED_IF_NOT_THREADS STG_UNUSED
 134 #else
 135 #define USED_IF_THREADS STG_UNUSED
 136 #define USED_IF_NOT_THREADS
 137 #endif
 138
 139 /*
 140  * Getting printf formats right for platform-dependent typedefs
 141  */
 142 #if SIZEOF_LONG == 8
 143 #define FMT_Word64 "lu"
 144 #define FMT_Int64  "ld"
 145 #else
 146 #if defined(mingw32_HOST_OS)
 147 /* mingw doesn't understand %llu/%lld - it treats them as 32-bit
 148    rather than 64-bit */
 149 #define FMT_Word64 "I64u"
 150 #define FMT_Int64  "I64d"
 151 #else
 152 #define FMT_Word64 "llu"
 153 #define FMT_Int64  "lld"
 154 #endif
 155 #endif
 156
 157 /* -----------------------------------------------------------------------------
 158    Include everything STG-ish
 159    -------------------------------------------------------------------------- */
 160
 161 /* System headers: stdlib.h is eeded so that we can use NULL.  It must
 162  * come after MachRegs.h, because stdlib.h might define some inline
 163  * functions which may only be defined after register variables have
 164  * been declared.
 165  */
 166 #include <stdlib.h>
 167
 168 #include "rts/Config.h"
 169
 170 /* Global constaints */
 171 #include "rts/Constants.h"
 172
 173 /* Profiling information */
 174 #include "rts/prof/CCS.h"
 175 #include "rts/prof/LDV.h"
 176
 177 /* Parallel information */
 178 #include "rts/OSThreads.h"
 179 #include "rts/SpinLock.h"
 180
 181 #include "rts/Messages.h"
 182
 183 /* Storage format definitions */
 184 #include "rts/storage/FunTypes.h"
 185 #include "rts/storage/InfoTables.h"
 186 #include "rts/storage/Closures.h"
 187 #include "rts/storage/Liveness.h"
 188 #include "rts/storage/ClosureTypes.h"
 189 #include "rts/storage/TSO.h"
 190 #include "stg/MiscClosures.h" /* InfoTables, closures etc. defined in the RTS */
 191 #include "rts/storage/SMPClosureOps.h"
 192 #include "rts/storage/Block.h"
 193 #include "rts/storage/ClosureMacros.h"
 194 #include "rts/storage/MBlock.h"
 195 #include "rts/storage/GC.h"
 196
 197 /* Other RTS external APIs */
 198 #include "rts/Parallel.h"
 199 #include "rts/Hooks.h"
 200 #include "rts/Signals.h"
 201 #include "rts/BlockSignals.h"
 202 #include "rts/Hpc.h"
 203 #include "rts/Flags.h"
 204 #include "rts/Adjustor.h"
 205 #include "rts/FileLock.h"
 206 #include "rts/Globals.h"
 207 #include "rts/IOManager.h"
 208 #include "rts/Linker.h"
 209 #include "rts/Threads.h"
 210 #include "rts/Ticky.h"
 211 #include "rts/Timer.h"
 212 #include "rts/Stable.h"
 213 #include "rts/TTY.h"
 214 #include "rts/Utils.h"
 215 #include "rts/PrimFloat.h"
 216
 217 /* Misc stuff without a home */
 218 DLL_IMPORT_RTS extern char **prog_argv; /* so we can get at these from Haskell */
 219 DLL_IMPORT_RTS extern int    prog_argc;
 220 DLL_IMPORT_RTS extern char  *prog_name;
 221
 222 void stackOverflow(void);
 223
 224 void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
 225
 226 #ifndef mingw32_HOST_OS
 227 int stg_sig_install (int, int, void *);
 228 #endif
 229
 230 /* -----------------------------------------------------------------------------
 231    RTS Exit codes
 232    -------------------------------------------------------------------------- */
 233
 234 /* 255 is allegedly used by dynamic linkers to report linking failure */
 235 #define EXIT_INTERNAL_ERROR 254
 236 #define EXIT_DEADLOCK       253
 237 #define EXIT_INTERRUPTED    252
 238 #define EXIT_HEAPOVERFLOW   251
 239 #define EXIT_KILLED         250
 240
 241 /* -----------------------------------------------------------------------------
 242    Miscellaneous garbage
 243    -------------------------------------------------------------------------- */
 244
 245 /* declarations for runtime flags/values */
 246 #define MAX_RTS_ARGS 32
 247
 248 #ifdef DEBUG
 249 #define TICK_VAR(arity) \
 250   extern StgInt SLOW_CALLS_##arity; \
 251   extern StgInt RIGHT_ARITY_##arity; \
 252   extern StgInt TAGGED_PTR_##arity;
 253
 254 extern StgInt TOTAL_CALLS;
 255
 256 TICK_VAR(1)
 257 TICK_VAR(2)
 258 #endif
 259
 260 /* -----------------------------------------------------------------------------
 261    Assertions and Debuggery
 262    -------------------------------------------------------------------------- */
 263
 264 #define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
 265
 266 #ifdef DEBUG
 267 #if IN_STG_CODE
 268 #define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
 269 #else
 270 #define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
 271 #endif
 272 #else
 273 #define IF_DEBUG(c,s)  doNothing()
 274 #endif
 275
 276 #ifdef DEBUG
 277 #define DEBUG_ONLY(s) s
 278 #else
 279 #define DEBUG_ONLY(s) doNothing()
 280 #endif
 281
 282 /* -----------------------------------------------------------------------------
 283    Useful macros and inline functions
 284    -------------------------------------------------------------------------- */
 285
 286 #if defined(__GNUC__)
 287 #define SUPPORTS_TYPEOF
 288 #endif
 289
 290 #if defined(SUPPORTS_TYPEOF)
 291 #define stg_min(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _a : _b; })
 292 #define stg_max(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _b : _a; })
 293 #else
 294 #define stg_min(a,b) ((a) <= (b) ? (a) : (b))
 295 #define stg_max(a,b) ((a) <= (b) ? (b) : (a))
 296 #endif
 297
 298 /* -------------------------------------------------------------------------- */
 299
 300 #ifdef __cplusplus
 301 }
 302 #endif
 303
 304 #endif /* RTS_H */