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 // ToDo: move RtsExternal stuff elsewhere
  22 #include "RtsExternal.h"
  23
  24 // Turn off inlining when debugging - it obfuscates things
  25 #ifdef DEBUG
  26 # undef  STATIC_INLINE
  27 # define STATIC_INLINE static
  28 #endif
  29
  30 #include "RtsTypes.h"
  31
  32 #if __GNUC__ >= 3
  33 /* Assume that a flexible array member at the end of a struct
  34  * can be defined thus: T arr[]; */
  35 #define FLEXIBLE_ARRAY
  36 #else
  37 /* Assume that it must be defined thus: T arr[0]; */
  38 #define FLEXIBLE_ARRAY 0
  39 #endif
  40
  41 #if __GNUC__ >= 3
  42 #define ATTRIBUTE_ALIGNED(n) __attribute__((aligned(n)))
  43 #else
  44 #define ATTRIBUTE_ALIGNED(n) /*nothing*/
  45 #endif
  46
  47 /* Fix for mingw stat problem (done here so it's early enough) */
  48 #ifdef mingw32_HOST_OS
  49 #define __MSVCRT__ 1
  50 #endif
  51
  52 /* Needed to get the macro version of errno on some OSs, and also to
  53    get prototypes for the _r versions of C library functions. */
  54 #ifndef _REENTRANT
  55 #define _REENTRANT 1
  56 #endif
  57
  58 /*
  59  * We often want to know the size of something in units of an
  60  * StgWord... (rounded up, of course!)
  61  */
  62 #define ROUNDUP_BYTES_TO_WDS(n) (((n) + sizeof(W_) - 1) / sizeof(W_))
  63
  64 #define sizeofW(t) ROUNDUP_BYTES_TO_WDS(sizeof(t))
  65
  66 /*
  67  * It's nice to be able to grep for casts
  68  */
  69 #define stgCast(ty,e) ((ty)(e))
  70
  71 /* -----------------------------------------------------------------------------
  72    Assertions and Debuggery
  73    -------------------------------------------------------------------------- */
  74
  75 #ifndef DEBUG
  76 #define ASSERT(predicate) /* nothing */
  77 #else
  78
  79 extern void _assertFail (const char *, unsigned int);
  80
  81 #define ASSERT(predicate)                       \
  82         if (predicate)                          \
  83             /*null*/;                           \
  84         else                                    \
  85             _assertFail(__FILE__, __LINE__)
  86 #endif /* DEBUG */
  87
  88 /*
  89  * Use this on the RHS of macros which expand to nothing
  90  * to make sure that the macro can be used in a context which
  91  * demands a non-empty statement.
  92  */
  93
  94 #define doNothing() do { } while (0)
  95
  96 #ifdef DEBUG
  97 #define USED_IF_DEBUG
  98 #define USED_IF_NOT_DEBUG STG_UNUSED
  99 #else
 100 #define USED_IF_DEBUG STG_UNUSED
 101 #define USED_IF_NOT_DEBUG
 102 #endif
 103
 104 #ifdef THREADED_RTS
 105 #define USED_IF_THREADS
 106 #define USED_IF_NOT_THREADS STG_UNUSED
 107 #else
 108 #define USED_IF_THREADS STG_UNUSED
 109 #define USED_IF_NOT_THREADS
 110 #endif
 111
 112 /*
 113  * Getting printf formats right for platform-dependent typedefs
 114  */
 115 #if SIZEOF_LONG == 8
 116 #define FMT_Word64 "lu"
 117 #define FMT_Int64  "ld"
 118 #else
 119 #define FMT_Word64 "llu"
 120 #define FMT_Int64  "lld"
 121 #endif
 122
 123 /*
 124  * Macros for untagging and retagging closure pointers
 125  * For more information look at the comments in Cmm.h
 126  */
 127
 128 static inline StgWord
 129 GET_CLOSURE_TAG(StgClosure * p)
 130 {
 131     return (StgWord)p & TAG_MASK;
 132 }
 133
 134 static inline StgClosure *
 135 UNTAG_CLOSURE(StgClosure * p)
 136 {
 137     return (StgClosure*)((StgWord)p & ~TAG_MASK);
 138 }
 139
 140 static inline StgClosure *
 141 TAG_CLOSURE(StgWord tag,StgClosure * p)
 142 {
 143     return (StgClosure*)((StgWord)p | tag);
 144 }
 145
 146 /* -----------------------------------------------------------------------------
 147    Include everything STG-ish
 148    -------------------------------------------------------------------------- */
 149
 150 /* System headers: stdlib.h is eeded so that we can use NULL.  It must
 151  * come after MachRegs.h, because stdlib.h might define some inline
 152  * functions which may only be defined after register variables have
 153  * been declared.
 154  */
 155 #include <stdlib.h>
 156
 157 /* Global constaints */
 158 #include "Constants.h"
 159
 160 /* Profiling information */
 161 #include "StgProf.h"
 162 #include "StgLdvProf.h"
 163
 164 /* Storage format definitions */
 165 #include "StgFun.h"
 166 #include "Closures.h"
 167 #include "Liveness.h"
 168 #include "ClosureTypes.h"
 169 #include "InfoTables.h"
 170 #include "TSO.h"
 171
 172 /* Info tables, closures & code fragments defined in the RTS */
 173 #include "StgMiscClosures.h"
 174
 175 /* Parallel information */
 176 #include "OSThreads.h"
 177 #include "SMPClosureOps.h"
 178 #include "SpinLock.h"
 179
 180 /* Macros for STG/C code */
 181 #include "Block.h"
 182 #include "ClosureMacros.h"
 183
 184 /* Runtime-system hooks */
 185 #include "Hooks.h"
 186 #include "RtsMessages.h"
 187
 188 /* for StablePtr/getStablePtr/deRefStablePtr */
 189 #include "Storage.h"
 190 #include "Stable.h"
 191
 192 #include "ieee-flpt.h"
 193
 194 #include "Signals.h"
 195
 196 /* Misc stuff without a home */
 197 DLL_IMPORT_RTS extern char **prog_argv; /* so we can get at these from Haskell */
 198 DLL_IMPORT_RTS extern int    prog_argc;
 199 DLL_IMPORT_RTS extern char  *prog_name;
 200
 201 extern void stackOverflow(void);
 202
 203 extern void      __decodeDouble_2Int (I_ *man_sign, W_ *man_high, W_ *man_low, I_ *exp, StgDouble dbl);
 204 extern void      __decodeFloat_Int (I_ *man, I_ *exp, StgFloat flt);
 205
 206 #if defined(WANT_DOTNET_SUPPORT)
 207 #include "DNInvoke.h"
 208 #endif
 209
 210 /* Initialising the whole adjustor thunk machinery. */
 211 extern void initAdjustor(void);
 212
 213 extern void stg_exit(int n) GNU_ATTRIBUTE(__noreturn__);
 214
 215 /* -----------------------------------------------------------------------------
 216    RTS Exit codes
 217    -------------------------------------------------------------------------- */
 218
 219 /* 255 is allegedly used by dynamic linkers to report linking failure */
 220 #define EXIT_INTERNAL_ERROR 254
 221 #define EXIT_DEADLOCK       253
 222 #define EXIT_INTERRUPTED    252
 223 #define EXIT_HEAPOVERFLOW   251
 224 #define EXIT_KILLED         250
 225
 226 /* -----------------------------------------------------------------------------
 227    Miscellaneous garbage
 228    -------------------------------------------------------------------------- */
 229
 230 /* declarations for runtime flags/values */
 231 #define MAX_RTS_ARGS 32
 232
 233 #ifdef DEBUG
 234 #define TICK_VAR(arity) \
 235   extern StgInt SLOW_CALLS_##arity; \
 236   extern StgInt RIGHT_ARITY_##arity; \
 237   extern StgInt TAGGED_PTR_##arity;
 238
 239 #define TICK_VAR_INI(arity) \
 240   StgInt SLOW_CALLS_##arity = 1; \
 241   StgInt RIGHT_ARITY_##arity = 1; \
 242   StgInt TAGGED_PTR_##arity = 0;
 243
 244 extern StgInt TOTAL_CALLS;
 245
 246 TICK_VAR(1)
 247 TICK_VAR(2)
 248 #endif
 249
 250 /* -----------------------------------------------------------------------------
 251    Assertions and Debuggery
 252    -------------------------------------------------------------------------- */
 253
 254 #define IF_RTSFLAGS(c,s)  if (RtsFlags.c) { s; }
 255
 256 /* -----------------------------------------------------------------------------
 257    Assertions and Debuggery
 258    -------------------------------------------------------------------------- */
 259
 260 #ifdef DEBUG
 261 #if IN_STG_CODE
 262 #define IF_DEBUG(c,s)  if (RtsFlags[0].DebugFlags.c) { s; }
 263 #else
 264 #define IF_DEBUG(c,s)  if (RtsFlags.DebugFlags.c) { s; }
 265 #endif
 266 #else
 267 #define IF_DEBUG(c,s)  doNothing()
 268 #endif
 269
 270 #ifdef DEBUG
 271 #define DEBUG_ONLY(s) s
 272 #else
 273 #define DEBUG_ONLY(s) doNothing()
 274 #endif
 275
 276 /* -----------------------------------------------------------------------------
 277    Useful macros and inline functions
 278    -------------------------------------------------------------------------- */
 279
 280 #if defined(__GNUC__)
 281 #define SUPPORTS_TYPEOF
 282 #endif
 283
 284 #if defined(SUPPORTS_TYPEOF)
 285 #define stg_min(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _a : _b; })
 286 #define stg_max(a,b) ({typeof(a) _a = (a), _b = (b); _a <= _b ? _b : _a; })
 287 #else
 288 #define stg_min(a,b) ((a) <= (b) ? (a) : (b))
 289 #define stg_max(a,b) ((a) <= (b) ? (b) : (a))
 290 #endif
 291
 292 /* -------------------------------------------------------------------------- */
 293
 294 #ifdef __cplusplus
 295 }
 296 #endif
 297
 298
 299 /* krc: I put this here because I don't think
 300    it needs to be visible externally.
 301    It used to be in StgTicky.h, but I got rid
 302    of that. */
 303
 304 /* -----------------------------------------------------------------------------
 305    The StgEntCounter type - needed regardless of TICKY_TICKY
 306    -------------------------------------------------------------------------- */
 307
 308 typedef struct _StgEntCounter {
 309   /* Using StgWord for everything, becuase both the C and asm code
 310      generators make trouble if you try to pack things tighter */
 311     StgWord     registeredp;    /* 0 == no, 1 == yes */
 312     StgInt      arity;          /* arity (static info) */
 313     StgInt      stk_args;       /* # of args off stack */
 314                                 /* (rest of args are in registers) */
 315     char        *str;           /* name of the thing */
 316     char        *arg_kinds;     /* info about the args types */
 317     StgInt      entry_count;    /* Trips to fast entry code */
 318     StgInt      allocs;         /* number of allocations by this fun */
 319     struct _StgEntCounter *link;/* link to chain them all together */
 320 } StgEntCounter;
 321
 322
 323 #endif /* RTS_H */