includes/Rts.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * Top-level include file for the RTS itself
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef RTS_H
  10 #define RTS_H
  11
  12 #ifdef __cplusplus
  13 extern "C" {
  14 #endif
  15
  16 #ifndef IN_STG_CODE
  17 #define IN_STG_CODE 0
  18 #endif
  19 #include "Stg.h"
  20
  21 #include "RtsTypes.h"
  22
  23 #if __GNUC__ >= 3
  24 /* Assume that a flexible array member at the end of a struct
  25  * can be defined thus: T arr[]; */
  26 #define FLEXIBLE_ARRAY
  27 #else
  28 /* Assume that it must be defined thus: T arr[0]; */
  29 #define FLEXIBLE_ARRAY 0
  30 #endif
  31
  32 /* Fix for mingw stat problem (done here so it's early enough) */
  33 #ifdef mingw32_HOST_OS
  34 #define __MSVCRT__ 1
  35 #endif
  36
  37 /*
  38  * We often want to know the size of something in units of an
  39  * StgWord... (rounded up, of course!)
  40  */
  41 #define sizeofW(t) ((sizeof(t)+sizeof(W_)-1)/sizeof(W_))
  42
  43 /*
  44  * It's nice to be able to grep for casts
  45  */
  46 #define stgCast(ty,e) ((ty)(e))
  47
  48 /* -----------------------------------------------------------------------------
  49    Assertions and Debuggery
  50    -------------------------------------------------------------------------- */
  51
  52 #ifndef DEBUG
  53 #define ASSERT(predicate) /* nothing */
  54 #else
  55
  56 extern void _assertFail (char *, unsigned int);
  57
  58 #define ASSERT(predicate)                       \
  59         if (predicate)                          \
  60             /*null*/;                           \
  61         else                                    \
  62             _assertFail(__FILE__, __LINE__)
  63 #endif /* DEBUG */
  64
  65 /*
  66  * Use this on the RHS of macros which expand to nothing
  67  * to make sure that the macro can be used in a context which
  68  * demands a non-empty statement.
  69  */
  70
  71 #define doNothing() do { } while (0)
  72
  73 #ifdef DEBUG
  74 #define USED_IF_DEBUG
  75 #define USED_IF_NOT_DEBUG STG_UNUSED
  76 #else
  77 #define USED_IF_DEBUG STG_UNUSED
  78 #define USED_IF_NOT_DEBUG
  79 #endif
  80
  81 #ifdef THREADED_RTS
  82 #define USED_IF_THREADS
  83 #define USED_IF_NOT_THREADS STG_UNUSED
  84 #else
  85 #define USED_IF_THREADS STG_UNUSED
  86 #define USED_IF_NOT_THREADS
  87 #endif
  88
  89 /* -----------------------------------------------------------------------------
  90    Include everything STG-ish
  91    -------------------------------------------------------------------------- */
  92
  93 /* System headers: stdlib.h is eeded so that we can use NULL.  It must
  94  * come after MachRegs.h, because stdlib.h might define some inline
  95  * functions which may only be defined after register variables have
  96  * been declared.
  97  */
  98 #include <stdlib.h>
  99
 100 /* Global constaints */
 101 #include "Constants.h"
 102
 103 /* Profiling information */
 104 #include "StgProf.h"
 105 #include "StgLdvProf.h"
 106
 107 /* Storage format definitions */
 108 #include "StgFun.h"
 109 #include "Closures.h"
 110 #include "Liveness.h"
 111 #include "ClosureTypes.h"
 112 #include "InfoTables.h"
 113 #include "TSO.h"
 114
 115 /* Info tables, closures & code fragments defined in the RTS */
 116 #include "StgMiscClosures.h"
 117
 118 /* Simulated-parallel information */
 119 #include "GranSim.h"
 120
 121 /* Parallel information */
 122 #include "Parallel.h"
 123 #include "OSThreads.h"
 124 #include "SMP.h"
 125
 126 /* STG/Optimised-C related stuff */
 127 #include "Block.h"
 128
 129 /* GNU mp library */
 130 #include "gmp.h"
 131
 132 /* Macros for STG/C code */
 133 #include "ClosureMacros.h"
 134 #include "StgTicky.h"
 135 #include "Stable.h"
 136
 137 /* Runtime-system hooks */
 138 #include "Hooks.h"
 139 #include "RtsMessages.h"
 140
 141 #include "ieee-flpt.h"
 142
 143 #include "Signals.h"
 144
 145 /* Misc stuff without a home */
 146 DLL_IMPORT_RTS extern char **prog_argv; /* so we can get at these from Haskell */
 147 DLL_IMPORT_RTS extern int    prog_argc;
 148 DLL_IMPORT_RTS extern char  *prog_name;
 149
 150 extern void stackOverflow(void);
 151
 152 extern void      __decodeDouble (MP_INT *man, I_ *_exp, StgDouble dbl);
 153 extern void      __decodeFloat  (MP_INT *man, I_ *_exp, StgFloat flt);
 154
 155 #if defined(WANT_DOTNET_SUPPORT)
 156 #include "DNInvoke.h"
 157 #endif
 158
 159 /* Initialising the whole adjustor thunk machinery. */
 160 extern void initAdjustor(void);
 161
 162 extern void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
 163
 164 /* -----------------------------------------------------------------------------
 165    RTS Exit codes
 166    -------------------------------------------------------------------------- */
 167
 168 /* 255 is allegedly used by dynamic linkers to report linking failure */
 169 #define EXIT_INTERNAL_ERROR 254
 170 #define EXIT_DEADLOCK       253
 171 #define EXIT_INTERRUPTED    252
 172 #define EXIT_HEAPOVERFLOW   251
 173 #define EXIT_KILLED         250
 174
 175 /* -----------------------------------------------------------------------------
 176    Miscellaneous garbage
 177    -------------------------------------------------------------------------- */
 178
 179 /* declarations for runtime flags/values */
 180 #define MAX_RTS_ARGS 32
 181
 182 /* -----------------------------------------------------------------------------
 183    Assertions and Debuggery
 184    -------------------------------------------------------------------------- */
 185
 186 #define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
 187
 188 /* -----------------------------------------------------------------------------
 189    Assertions and Debuggery
 190    -------------------------------------------------------------------------- */
 191
 192 #ifdef DEBUG
 193 #define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
 194 #else
 195 #define IF_DEBUG(c,s)  doNothing()
 196 #endif
 197
 198 #ifdef DEBUG
 199 #define DEBUG_ONLY(s) s
 200 #else
 201 #define DEBUG_ONLY(s) doNothing()
 202 #endif
 203
 204 #if defined(GRAN) && defined(DEBUG)
 205 #define IF_GRAN_DEBUG(c,s)  if (RtsFlags.GranFlags.Debug.c) { s; }
 206 #else
 207 #define IF_GRAN_DEBUG(c,s)  doNothing()
 208 #endif
 209
 210 #if defined(PAR) && defined(DEBUG)
 211 #define IF_PAR_DEBUG(c,s)  if (RtsFlags.ParFlags.Debug.c) { s; }
 212 #else
 213 #define IF_PAR_DEBUG(c,s)  doNothing()
 214 #endif
 215
 216 /* -----------------------------------------------------------------------------
 217    Useful macros and inline functions
 218    -------------------------------------------------------------------------- */
 219
 220 #if defined(__GNUC__)
 221 #define SUPPORTS_TYPEOF
 222 #endif
 223
 224 #if defined(SUPPORTS_TYPEOF)
 225 #define stg_min(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _a : _b; })
 226 #define stg_max(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _b : _a; })
 227 #else
 228 #define stg_min(a,b) ((a) <= (b) ? (a) : (b))
 229 #define stg_max(a,b) ((a) <= (b) ? (b) : (a))
 230 #endif
 231
 232 /* -------------------------------------------------------------------------- */
 233
 234 #ifdef __cplusplus
 235 }
 236 #endif
 237
 238 #endif /* RTS_H */