ghc/includes/stgdefs.h

   1 /* these are the definitions included at the beginning
   2  * of every compiled-to-C module
   3  */
   4 #ifndef STGDEFS_H
   5 #define STGDEFS_H
   6
   7 /* machine/compiler/system dependencies :-(  Must be first! */
   8 #include "platform.h" /* generated by configure */
   9 #include "config.h"   /* generated by configure */
  10 #include "error.h"
  11 #include "StgMachDeps.h"
  12
  13 #include "COptRegs.h"
  14
  15 /* our own ASSERT macro (for C) */
  16 #ifndef DEBUG
  17 #define NDEBUG 1 /* for assert.h */
  18 #define ASSERT(predicate) /*nothing*/
  19
  20 #else
  21 #undef NDEBUG   /* for assert.h */
  22
  23 void _stgAssert PROTO((char *, unsigned int));
  24
  25 #define ASSERT(predicate)                       \
  26         if (predicate)                          \
  27             /*null*/;                           \
  28         else                                    \
  29             _stgAssert(__FILE__, __LINE__)
  30 #endif
  31
  32 #if macos7_TARGET_OS
  33 #define NON_POSIX_SOURCE
  34 #endif
  35
  36 #ifdef NON_POSIX_SOURCE
  37 #undef _POSIX_SOURCE
  38 #undef _POSIX_C_SOURCE
  39 #else
  40 #define _POSIX_SOURCE 1
  41 #define _POSIX_C_SOURCE 199301L
  42 /* Alphas set _POSIX_VERSION (unistd.h) */
  43 /* ditto _POSIX2_C_VERSION
  44          _POSIX2_VERSION
  45          _POSIX_4SOURCE
  46 */
  47 #include <unistd.h>
  48 #include <signal.h>
  49 #endif
  50
  51 /* these are all ANSI C headers */
  52 #include <stdlib.h>
  53 #include <string.h>
  54 #include <math.h>
  55 #include <assert.h>
  56 #include <errno.h>
  57 #include <stdio.h>
  58
  59 #ifndef STDC_HEADERS
  60 /* hack: though the following are defined in the ANSI C library,
  61     they may not be defined in a systems stdio.h (Suns, for example).
  62     GCC is schizophrenic about whether it adds these into its
  63     own headers for you; so we have no choice but to throw them in.
  64 */
  65 int     fclose PROTO((FILE *));
  66 int     fflush PROTO((FILE *));
  67 int     fgetc PROTO((FILE *));
  68 int     fprintf PROTO((FILE *, const char *, ...));
  69 int     fputc PROTO((int, FILE *));
  70 int     fputs PROTO((const char *, FILE *));
  71 size_t  fread PROTO((void *, size_t, size_t, FILE *));
  72 int     fscanf PROTO((FILE *, const char *, ...));
  73 int     fseek PROTO((FILE *, long int, int));
  74 size_t  fwrite PROTO((const void *, size_t, size_t, FILE *));
  75 void    perror PROTO((const char *));
  76 int     printf PROTO((const char *, ...));
  77 int     puts PROTO((const char *));
  78 int     remove PROTO((const char *));
  79 int     rename PROTO((const char *, const char *));
  80 void    rewind PROTO((FILE *));
  81 int     scanf PROTO((const char *, ...));
  82 void    setbuf PROTO((FILE *, char *));
  83 int     setvbuf PROTO((FILE *, char *, int, size_t));
  84 int     sscanf PROTO((const char *, const char *, ...));
  85 /* end of hack */
  86 #endif /* STDC_HEADERS */
  87
  88 /*
  89  * threadWaitWrite# uses FD_SETSIZE to distinguish
  90  * between read file descriptors and write fd's.
  91  * Hence we need to include <sys/types.h>, but
  92  * is this the best place to do it?
  93  * (the following has been moved from libposix.h)
  94  */
  95
  96 #ifdef HAVE_SYS_TYPES_H
  97 #include <sys/types.h>
  98 #endif  /* HAVE_SYS_TYPES_H */
  99
 100 #ifndef FD_SETSIZE
 101 #define FD_SETSIZE 1024
 102 #endif
 103
 104 #if ! defined(EXIT_SUCCESS) || ! defined(EXIT_FAILURE)
 105 /* "stdlib.h" should have defined these; but at least
 106    on SunOS 4.1.3, this is not so.
 107 */
 108 #define EXIT_SUCCESS 0
 109 #define EXIT_FAILURE 1
 110 #endif
 111
 112 /* Make sure that *some* register map is defined */
 113 #ifdef __STG_GCC_REGS__
 114 # if !(defined(NULL_REG_MAP) || defined(FLUSH_REG_MAP) || defined(MAIN_REG_MAP) \
 115     || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP)  || defined(SCAV_REG_MAP))
 116 yikes! no register map defined!
 117 # endif
 118 #endif
 119
 120 /* Make sure that *some* garbage-collector is expected; GCap is the default */
 121 #if !(defined(GCap) || defined(GC2s) || defined(GC1s) || defined(GCdu) || defined(GCgn))
 122 #define GCap 1
 123 #endif
 124
 125 #ifdef IN_GHC_RTS
 126 #define IF_RTS(x) x
 127 #else
 128 #define IF_RTS(x) /*nothing*/
 129 #endif
 130
 131 /* GNU multi-precision arith */
 132 #include "gmp.h"
 133
 134 /* typedefs for the basic entities */
 135 #include "StgTypes.h"
 136
 137 /* constants about the system known to *everybody* (compiler & RTS) */
 138 #include "GhcConstants.h"
 139
 140 /* macros to deal with stacks (no longer heap) growing in either dirn */
 141 #include "StgDirections.h"
 142
 143 /* declarations for all the runtime flags for the RTS */
 144 #ifdef IN_GHC_RTS
 145 #include "RtsFlags.h"
 146 #endif
 147 /* and those that are visible *everywhere* (RTS + Haskell code) */
 148 struct ALL_FLAGS {
 149 #ifdef TICKY_TICKY
 150     W_ doUpdEntryCounts;    /* if true, we cannot short-circuit Inds,
 151                                  common-up {Int,Char}Likes or Consts
 152                             */
 153 #endif
 154     W_ dummy_entry; /* so there is *something* in it... */
 155 };
 156 extern struct ALL_FLAGS AllFlags;
 157
 158 /* declarations for garbage collection routines */
 159 #include "SMinterface.h"
 160
 161 /* Macros for declaring "registers" and other Optimising stuff */
 162 #include "COptJumps.h"
 163 #include "COptRegs.h"
 164 #include "COptWraps.h"
 165
 166 /* these will come into play if you use -DTICKY_TICKY (default: off) */
 167 #include "Ticky.h"
 168
 169 hash_t hash_str   PROTO((char *str));
 170 hash_t hash_fixed PROTO((char *data, I_ len));
 171
 172 /* ullong (64bit) formatting */
 173 char *ullong_format_string PROTO((ullong x, char *s, rtsBool with_commas));
 174
 175 /* declarations of macros for "high-level instructions" */
 176 #include "StgMacros.h"
 177
 178 /* You always need these */
 179 #include "Info.h"
 180
 181 /* You need these if you are using the threads package or a parallel machine... */
 182 #include "Threads.h"
 183 #include "Parallel.h"
 184
 185 /* Things will happen in here if the driver does -DPROFILING */
 186 #include "CostCentre.h"
 187
 188 /* GRAN and PAR stuff */
 189 #include "GranSim.h"
 190
 191 #if defined(PROFILING) || defined(CONCURRENT)
 192 char * time_str(STG_NO_ARGS);
 193 #endif
 194
 195 /* declarations for runtime-system entry points */
 196 void miniInterpret PROTO((StgFunPtr));
 197 void miniInterpret_debug PROTO(( StgFunPtr, void(*)(STG_NO_ARGS) ));
 198 void miniInterpretEnd(STG_NO_ARGS);
 199
 200 StgFunPtr evaluateMain(STG_NO_ARGS);
 201 StgFunPtr returnMain(STG_NO_ARGS);
 202 StgFunPtr impossible_jump_after_switch(STG_NO_ARGS);
 203
 204 /* hooks: user might write some of their own */
 205 void ErrorHdrHook       PROTO((FILE *));
 206 void OutOfHeapHook      PROTO((W_, W_));
 207 void StackOverflowHook  PROTO((I_));
 208 #ifdef CONCURRENT
 209 void NoRunnableThreadsHook (STG_NO_ARGS);
 210 #endif
 211 void MallocFailHook     PROTO((I_, char *));
 212 void PatErrorHdrHook    PROTO((FILE *));
 213 void PreTraceHook       PROTO((FILE *));
 214 void PostTraceHook      PROTO((FILE *));
 215 void defaultsHook       (STG_NO_ARGS);
 216 void initEachPEHook     (STG_NO_ARGS);
 217
 218 EXTFUN(startStgWorld);
 219 #ifdef CONCURRENT
 220 EXTFUN(CheckHeapCode);
 221 EXTFUN(Continue);
 222 EXTFUN(resumeThread);
 223 #endif
 224
 225 extern char **prog_argv; /* from runtime/main/main.lc */
 226 extern int    prog_argc;
 227 extern char **environ; /* we can get this one straight */
 228
 229 EXTDATA(STK_STUB_closure);
 230
 231 /* now these really *DO* need to be somewhere else... */
 232 char   *time_str(STG_NO_ARGS);
 233 I_      stg_exit PROTO((I_));
 234 I_      _stg_rem PROTO((I_, I_));
 235 char   *stgMallocBytes PROTO((I_, char *));
 236 char   *stgMallocWords PROTO((I_, char *));
 237
 238 /* definitions for closures */
 239 #include "SMClosures.h"
 240
 241 /* definitions for info tables */
 242 #include "SMInfoTables.h"
 243
 244 /* declarations for Update & Indirection stuff */
 245 #include "SMupdate.h"
 246
 247 /* declarations for runtime flags/values */
 248 #define MAX_RTS_ARGS 32
 249
 250 /* Saving and restoring registers */
 251 #include "StgRegs.h"
 252
 253 #endif /* ! STGDEFS_H */