[project @ 2000-11-07 17:05:47 by simonmar]
[ghc-hetmet.git] / ghc / includes / Stg.h
1 /* -----------------------------------------------------------------------------
2  * $Id: Stg.h,v 1.33 2000/11/07 17:05:47 simonmar Exp $
3  *
4  * (c) The GHC Team, 1998-1999
5  *
6  * Top-level include file for everything STG-ish.  
7  *
8  * This file is included *automatically* by all .hc files.
9  *
10  * ---------------------------------------------------------------------------*/
11
12 #ifndef STG_H
13 #define STG_H
14
15 #ifndef NON_POSIX_SOURCE
16 #define _POSIX_SOURCE   1
17 #define _POSIX_C_SOURCE 199309L
18 #define _ISOC9X_SOURCE
19 #endif
20
21 /* Let's be ISO C9X too... */
22
23 /* If we include "Stg.h" directly, we're in STG code, and we therefore
24  * get all the global register variables, macros etc. that go along
25  * with that.  If "Stg.h" is included via "Rts.h", we're assumed to
26  * be in vanilla C.
27  */
28 #ifndef IN_STG_CODE
29 # define IN_STG_CODE 1
30 #endif
31
32 #if IN_STG_CODE == 0
33 # ifndef NO_REGS
34 #  define NO_REGS                       /* don't define fixed registers */
35 # endif
36 #endif
37
38 /* Configuration */
39 #include "config.h"
40 #ifdef __HUGS__ /* vile hack till the GHC folks come on board */
41 #include "options.h"
42 #endif
43
44 /* Some macros to handle DLLing (Win32 only at the moment). */
45 #include "StgDLL.h"
46
47 /* Turn lazy blackholing and eager blackholing on/off.
48  *
49  * Using eager blackholing makes things easier to debug because
50  * the blackholes are more predictable - but it's slower and less sexy.
51  *
52  * For now, do lazy and not eager.
53  */
54
55 /* TICKY_TICKY needs EAGER_BLACKHOLING to verify no double-entries of
56  * single-entry thunks.
57  *
58  * SMP needs EAGER_BLACKHOLING because it has to lock thunks
59  * synchronously, in case another thread is trying to evaluate the
60  * same thunk simultaneously.
61  */
62 #if defined(SMP) || defined(TICKY_TICKY)
63 #  define EAGER_BLACKHOLING
64 #else
65 #  define LAZY_BLACKHOLING
66 #endif
67
68 /* ToDo: Set this flag properly: COMPILER and INTERPRETER should not be mutually exclusive. */
69 #ifndef INTERPRETER
70 #define COMPILER 1
71 #endif
72
73 /* TABLES_NEXT_TO_CODE says whether to assume that info tables are
74  * assumed to reside just before the code for a function.
75  *
76  * UNDEFINING THIS WON'T WORK ON ITS OWN.  You have been warned.
77  */
78 #ifndef USE_MINIINTERPRETER
79 #define TABLES_NEXT_TO_CODE
80 #endif
81
82 /* bit macros
83  */
84 #define BITS_PER_BYTE 8
85 #define BITS_IN(x) (BITS_PER_BYTE * sizeof(x))
86
87 /* -----------------------------------------------------------------------------
88    Assertions and Debuggery
89    -------------------------------------------------------------------------- */
90
91 #ifndef DEBUG
92 #define ASSERT(predicate) /* nothing */
93 #else
94
95 void _stgAssert (char *, unsigned int);
96
97 #define ASSERT(predicate)                       \
98         if (predicate)                          \
99             /*null*/;                           \
100         else                                    \
101             _stgAssert(__FILE__, __LINE__)
102 #endif /* DEBUG */
103
104 /* -----------------------------------------------------------------------------
105    Global type definitions
106    -------------------------------------------------------------------------- */
107
108 #include "StgTypes.h"
109 #include "RtsTypes.h"
110
111 /* -----------------------------------------------------------------------------
112    Shorthand forms
113    -------------------------------------------------------------------------- */
114
115 typedef StgChar         C_;
116 typedef StgWord         W_;
117 typedef StgWord*        P_;
118 typedef P_*             PP_;
119 typedef StgInt          I_;
120 typedef StgAddr         A_;
121 typedef const StgWord*  D_;
122 typedef StgFunPtr       F_;
123 typedef StgByteArray    B_;
124 typedef StgClosurePtr   L_;
125
126 typedef StgInt64        LI_;
127 typedef StgWord64       LW_;
128
129 /*
130  * We often want to know the size of something in units of an
131  * StgWord... (rounded up, of course!)
132  */
133
134 #define sizeofW(t) ((sizeof(t)+sizeof(W_)-1)/sizeof(W_))
135
136 /* 
137  * It's nice to be able to grep for casts
138  */
139
140 #define stgCast(ty,e) ((ty)(e))
141
142 /* -----------------------------------------------------------------------------
143    Include everything STG-ish
144    -------------------------------------------------------------------------- */
145
146 /* Global constaints */
147 #include "Constants.h"
148
149 /* Profiling information */
150 #include "StgProf.h"
151
152 /* Storage format definitions */
153 #include "Closures.h"
154 #include "ClosureTypes.h"
155 #include "InfoTables.h"
156 #include "TSO.h"
157
158 /* Simulated-parallel information */
159 #include "GranSim.h"
160
161 /* Parallel information */
162 #include "Parallel.h"
163
164 /* STG/Optimised-C related stuff */
165 #include "SMP.h"
166 #include "MachRegs.h"
167 #include "Regs.h"
168 #include "TailCalls.h"
169 #include "Block.h"
170
171 /* RTS public interface */
172 #include "RtsAPI.h"
173
174 /* these are all ANSI C headers */
175 #include <stdlib.h>
176 #include <string.h>
177 #include <math.h>
178 #include <assert.h>
179 #include <errno.h>
180 #include <stdio.h>
181
182 #ifdef HAVE_SIGNAL_H
183 #include <signal.h>
184 #endif
185
186 #ifdef HAVE_UNISTD_H
187 #include <unistd.h>
188 #endif
189
190 #ifdef SMP
191 #include <pthread.h>
192 #endif
193
194 /* GNU mp library */
195 #include "gmp.h"
196
197 /* Storage Manager */
198 #include "StgStorage.h"
199
200 /* Macros for STG/C code */
201 #include "ClosureMacros.h"
202 #include "InfoMacros.h"
203 #include "StgMacros.h"
204 #include "PrimOps.h"
205 #include "Updates.h"
206 #include "StgTicky.h"
207 #include "CCall.h"
208 #include "Stable.h"
209
210 /* Built-in entry points */
211 #include "StgMiscClosures.h"
212
213 /* Runtime-system hooks */
214 #include "Hooks.h"
215
216 /* Misc stuff without a home */
217 DLL_IMPORT_RTS extern char **prog_argv; /* so we can get at these from Haskell */
218 DLL_IMPORT_RTS extern int    prog_argc;
219
220 extern char **environ;
221
222 extern void stackOverflow(void);
223
224 /* Creating and destroying an adjustor thunk.
225    I cannot make myself create a separate .h file
226    for these two (sof.) 
227    
228 */
229 extern void* createAdjustor(int cconv, StgStablePtr hptr, StgFunPtr wptr);
230 extern void  freeHaskellFunctionPtr(void* ptr);
231
232 #endif /* STG_H */