summaryrefslogtreecommitdiff
path: root/ghc/includes/stgdefs.h
blob: 88b0f40007e41be5471e8dc39c94686f84160dd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/* these are the definitions included at the beginning
 * of every compiled-to-C module
 */
#ifndef STGDEFS_H
#define STGDEFS_H

/* machine/compiler/system dependencies :-(  Must be first! */
#include "platform.h" /* generated by configure */
#include "config.h"   /* generated by configure */
#include "error.h"
#include "StgMachDeps.h"

#include "COptRegs.h"

/* our own ASSERT macro (for C) */
#ifndef DEBUG
#define NDEBUG 1 /* for assert.h */
#define ASSERT(predicate) /*nothing*/

#else
#undef NDEBUG	/* for assert.h */

void _stgAssert PROTO((char *, unsigned int));

#define ASSERT(predicate)			\
	if (predicate)				\
	    /*null*/;				\
	else					\
	    _stgAssert(__FILE__, __LINE__)
#endif

#if macos7_TARGET_OS
#define NON_POSIX_SOURCE
#endif

#ifdef NON_POSIX_SOURCE
#undef _POSIX_SOURCE
#undef _POSIX_C_SOURCE
#else
#define _POSIX_SOURCE 1
#define _POSIX_C_SOURCE 199301L
/* Alphas set _POSIX_VERSION (unistd.h) */
/* ditto _POSIX2_C_VERSION
	 _POSIX2_VERSION
	 _POSIX_4SOURCE
*/
#include <unistd.h>
#include <signal.h>
#endif

/* these are all ANSI C headers */
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <assert.h>
#include <errno.h>
#include <stdio.h>

#ifndef STDC_HEADERS
/* hack: though the following are defined in the ANSI C library,
    they may not be defined in a systems stdio.h (Suns, for example).
    GCC is schizophrenic about whether it adds these into its
    own headers for you; so we have no choice but to throw them in.
*/
extern int fclose PROTO((FILE *));
extern int fflush PROTO((FILE *));
extern int fgetc PROTO((FILE *));
/* extern int fgetpos PROTO((FILE *, fpos_t *)); */
extern int fprintf PROTO((FILE *, const char *, ...));
extern int fputc PROTO((int, FILE *));
extern int fputs PROTO((const char *, FILE *));
extern size_t fread PROTO((void *, size_t, size_t, FILE *));
extern int fscanf PROTO((FILE *, const char *, ...));
extern int fseek PROTO((FILE *, long int, int));
/* extern int fsetpos PROTO((FILE *, const fpos_t *)); */
extern size_t fwrite PROTO((const void *, size_t, size_t, FILE *));
extern void perror PROTO((const char *));
extern int printf PROTO((const char *, ...));
extern int puts PROTO((const char *));
extern int remove PROTO((const char *));
extern int rename PROTO((const char *, const char *));
extern void rewind PROTO((FILE *));
extern int scanf PROTO((const char *, ...));
extern void setbuf PROTO((FILE *, char *));
extern int setvbuf PROTO((FILE *, char *, int, size_t));
extern int sscanf PROTO((const char *, const char *, ...));
/* end of hack */
#endif /* STDC_HEADERS */

#if ! defined(EXIT_SUCCESS) || ! defined(EXIT_FAILURE)
/* "stdlib.h" should have defined these; but at least
   on SunOS 4.1.3, this is not so.
*/
#define EXIT_SUCCESS 0
#define EXIT_FAILURE 1
#endif

/* Make sure that *some* register map is defined */
#ifdef __STG_GCC_REGS__
# if !(defined(NULL_REG_MAP) || defined(FLUSH_REG_MAP) || defined(MAIN_REG_MAP) \
    || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP)  || defined(SCAV_REG_MAP))
yikes! no register map defined!
# endif
#endif

/* Make sure that *some* garbage-collector is expected; GCap is the default */
#if !(defined(GCap) || defined(GC2s) || defined(GC1s) || defined(GCdu) || defined(GCgn))
#define GCap 1
#endif

#ifdef IN_GHC_RTS
#define IF_RTS(x) x
#else
#define IF_RTS(x) /*nothing*/
#endif

/* GNU multi-precision arith */
#include "gmp.h"

/* typedefs for the basic entities */
#include "StgTypes.h"

/* constants about the system known to *everybody* (compiler & RTS) */
#include "GhcConstants.h"

/* macros to deal with stacks (no longer heap) growing in either dirn */
#include "StgDirections.h"

/* declarations for all the runtime flags for the RTS */
#ifdef IN_GHC_RTS
#include "RtsFlags.h"
#endif
/* and those that are visible *everywhere* (RTS + Haskell code) */
struct ALL_FLAGS {
#ifdef TICKY_TICKY
    W_ doUpdEntryCounts;    /* if true, we cannot short-circuit Inds,
				 common-up {Int,Char}Likes or Consts
			    */
#endif
    W_ dummy_entry; /* so there is *something* in it... */
};
extern struct ALL_FLAGS AllFlags;

/* declarations for garbage collection routines */
#include "SMinterface.h"

/* Macros for declaring "registers" and other Optimising stuff */
#include "COptJumps.h"
#include "COptRegs.h"
#include "COptWraps.h"

/* these will come into play if you use -DTICKY_TICKY (default: off) */
#include "Ticky.h"

hash_t hash_str   PROTO((char *str));
hash_t hash_fixed PROTO((char *data, I_ len));

/* ullong (64bit) formatting */
char *ullong_format_string PROTO((ullong x, char *s, rtsBool with_commas));

/* declarations of macros for "high-level instructions" */
#include "StgMacros.h"

/* You always need these */
#include "Info.h"

/* You need these if you are using the threads package or a parallel machine... */
#include "Threads.h"
#include "Parallel.h"

/* Things will happen in here if the driver does -DPROFILING */
#include "CostCentre.h"

/* GRAN and PAR stuff */
#include "GranSim.h"

#if defined(PROFILING) || defined(CONCURRENT)
char * time_str(STG_NO_ARGS);
#endif

/* declarations for runtime-system entry points */
extern void miniInterpret PROTO((StgFunPtr));
extern void miniInterpret_debug PROTO(( StgFunPtr, void(*)(STG_NO_ARGS) ));
extern void miniInterpretEnd(STG_NO_ARGS);

extern StgFunPtr evaluateMain(STG_NO_ARGS);
extern StgFunPtr returnMain(STG_NO_ARGS);
extern StgFunPtr impossible_jump_after_switch(STG_NO_ARGS);

/* hooks: user might write some of their own */
extern void ErrorHdrHook	PROTO((FILE *));
extern void OutOfHeapHook	PROTO((W_));
extern void StackOverflowHook	PROTO((I_));
extern void MallocFailHook	PROTO((I_, char *));
extern void PatErrorHdrHook	PROTO((FILE *));
extern void PreTraceHook	PROTO((FILE *));
extern void PostTraceHook	PROTO((FILE *));

EXTFUN(startStgWorld);
#ifdef CONCURRENT
EXTFUN(CheckHeapCode);
EXTFUN(Continue);
EXTFUN(resumeThread);
#endif

extern char **prog_argv; /* from runtime/main/main.lc */
extern int    prog_argc;
extern char **environ; /* we can get this one straight */

EXTDATA(STK_STUB_closure);

/* now these really *DO* need to be somewhere else... */
char   *time_str(STG_NO_ARGS);
I_	stg_exit PROTO((I_));
I_	_stg_rem PROTO((I_, I_));
char   *stgMallocBytes PROTO((I_, char *));
char   *stgMallocWords PROTO((I_, char *));

/* definitions for closures */
#include "SMClosures.h"

/* definitions for info tables */
#include "SMInfoTables.h"

/* declarations for Update & Indirection stuff */
#include "SMupdate.h"

/* declarations for runtime flags/values */
#define MAX_RTS_ARGS 32

/* Saving and restoring registers */
#include "StgRegs.h"

#endif /* ! STGDEFS_H */