Linker.c 155 KB
Newer Older
1
2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The GHC Team, 2000-2004
4
5
6
7
8
 *
 * RTS Object Linker
 *
 * ---------------------------------------------------------------------------*/

sof's avatar
sof committed
9
#if 0
10
#include "PosixSource.h"
sof's avatar
sof committed
11
#endif
12

13
/* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14
15
   MREMAP_MAYMOVE from <sys/mman.h>.
 */
16
17
18
19
#ifdef __linux__
#define _GNU_SOURCE
#endif

20
21
22
23
24
#include "Rts.h"
#include "RtsFlags.h"
#include "HsFFI.h"
#include "Hash.h"
#include "Linker.h"
25
#include "LinkerInternals.h"
26
#include "RtsUtils.h"
27
#include "Schedule.h"
28
#include "Sparks.h"
29
#include "RtsGlobals.h"
30
#include "Timer.h"
31
#include "Trace.h"
32

33
#ifdef HAVE_SYS_TYPES_H
34
#include <sys/types.h>
35
36
#endif

37
38
39
#include <stdlib.h>
#include <string.h>

40
#ifdef HAVE_SYS_STAT_H
41
#include <sys/stat.h>
42
#endif
43

44
#if defined(HAVE_DLFCN_H)
45
#include <dlfcn.h>
46
#endif
47

48
#if defined(cygwin32_HOST_OS)
sof's avatar
sof committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#ifdef HAVE_DIRENT_H
#include <dirent.h>
#endif

#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#include <regex.h>
#include <sys/fcntl.h>
#include <sys/termios.h>
#include <sys/utime.h>
#include <sys/utsname.h>
#include <sys/wait.h>
#endif

64
#if defined(ia64_HOST_ARCH) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
65
66
67
#define USE_MMAP
#include <fcntl.h>
#include <sys/mman.h>
dons's avatar
dons committed
68

69
#if defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
dons's avatar
dons committed
70
71
72
73
74
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#endif

75
76
#endif

77
#if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
78
#  define OBJFORMAT_ELF
79
#elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
80
#  define OBJFORMAT_PEi386
81
#  include <windows.h>
sof's avatar
sof committed
82
#  include <math.h>
83
#elif defined(darwin_HOST_OS)
84
85
86
87
#  define OBJFORMAT_MACHO
#  include <mach-o/loader.h>
#  include <mach-o/nlist.h>
#  include <mach-o/reloc.h>
88
#if !defined(HAVE_DLFCN_H)
89
#  include <mach-o/dyld.h>
90
#endif
91
92
93
#if defined(powerpc_HOST_ARCH)
#  include <mach-o/ppc/reloc.h>
#endif
94
95
96
#if defined(x86_64_HOST_ARCH)
#  include <mach-o/x86_64/reloc.h>
#endif
97
98
#endif

99
/* Hash table mapping symbol names to Symbol */
100
static /*Str*/HashTable *symhash;
101

102
103
104
/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;

105
106
107
/* List of currently loaded objects */
ObjectCode *objects = NULL;	/* initially empty */

108
#if defined(OBJFORMAT_ELF)
109
110
111
static int ocVerifyImage_ELF    ( ObjectCode* oc );
static int ocGetNames_ELF       ( ObjectCode* oc );
static int ocResolve_ELF        ( ObjectCode* oc );
112
#if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
113
static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
114
#endif
115
#elif defined(OBJFORMAT_PEi386)
116
117
118
static int ocVerifyImage_PEi386 ( ObjectCode* oc );
static int ocGetNames_PEi386    ( ObjectCode* oc );
static int ocResolve_PEi386     ( ObjectCode* oc );
119
120
static void *lookupSymbolInDLLs ( unsigned char *lbl );
static void zapTrailingAtSign   ( unsigned char *sym );
121
122
123
124
#elif defined(OBJFORMAT_MACHO)
static int ocVerifyImage_MachO    ( ObjectCode* oc );
static int ocGetNames_MachO       ( ObjectCode* oc );
static int ocResolve_MachO        ( ObjectCode* oc );
125

126
static int machoGetMisalignment( FILE * );
127
128
129
#if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
#endif
130
#ifdef powerpc_HOST_ARCH
131
static void machoInitSymbolsWithoutUnderscore( void );
132
#endif
133
#endif
134

135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/* on x86_64 we have a problem with relocating symbol references in
 * code that was compiled without -fPIC.  By default, the small memory
 * model is used, which assumes that symbol references can fit in a
 * 32-bit slot.  The system dynamic linker makes this work for
 * references to shared libraries by either (a) allocating a jump
 * table slot for code references, or (b) moving the symbol at load
 * time (and copying its contents, if necessary) for data references.
 *
 * We unfortunately can't tell whether symbol references are to code
 * or data.  So for now we assume they are code (the vast majority
 * are), and allocate jump-table slots.  Unfortunately this will
 * SILENTLY generate crashing code for data references.  This hack is
 * enabled by X86_64_ELF_NONPIC_HACK.
 * 
 * One workaround is to use shared Haskell libraries.  This is
 * coming.  Another workaround is to keep the static libraries but
 * compile them with -fPIC, because that will generate PIC references
 * to data which can be relocated.  The PIC code is still too green to
 * do this systematically, though.
 *
 * See bug #781
 * See thread http://www.haskell.org/pipermail/cvs-ghc/2007-September/038458.html
157
158
159
160
161
162
163
164
165
166
167
168
 *
 * Naming Scheme for Symbol Macros
 *
 * SymI_*: symbol is internal to the RTS. It resides in an object
 *         file/library that is statically.
 * SymE_*: symbol is external to the RTS library. It might be linked
 *         dynamically.
 *
 * Sym*_HasProto  : the symbol prototype is imported in an include file
 *                  or defined explicitly
 * Sym*_NeedsProto: the symbol is undefined and we add a dummy
 *                  default proto extern void sym(void);
169
170
 */
#define X86_64_ELF_NONPIC_HACK 1
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
/* Link objects into the lower 2Gb on x86_64.  GHC assumes the
 * small memory model on this architecture (see gcc docs,
 * -mcmodel=small).
 *
 * MAP_32BIT not available on OpenBSD/amd64
 */
#if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
#define TRY_MAP_32BIT MAP_32BIT
#else
#define TRY_MAP_32BIT 0
#endif

/*
 * Due to the small memory model (see above), on x86_64 we have to map
 * all our non-PIC object files into the low 2Gb of the address space
 * (why 2Gb and not 4Gb?  Because all addresses must be reachable
 * using a 32-bit signed PC-relative offset). On Linux we can do this
 * using the MAP_32BIT flag to mmap(), however on other OSs
 * (e.g. *BSD, see #2063, and also on Linux inside Xen, see #2512), we
 * can't do this.  So on these systems, we have to pick a base address
 * in the low 2Gb of the address space and try to allocate memory from
 * there.
 *
 * We pick a default address based on the OS, but also make this
 * configurable via an RTS flag (+RTS -xm)
 */
#if defined(x86_64_HOST_ARCH)

#if defined(MAP_32BIT)
// Try to use MAP_32BIT
#define MMAP_32BIT_BASE_DEFAULT 0
#else
// A guess: 1Gb.
#define MMAP_32BIT_BASE_DEFAULT 0x40000000
#endif

Ian Lynagh's avatar
Ian Lynagh committed
208
static void *mmap_32bit_base = (void *)MMAP_32BIT_BASE_DEFAULT;
209
210
211
212
213
214
215
#endif

/* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
#if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
#define MAP_ANONYMOUS MAP_ANON
#endif

216
217
218
219
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

220
221
222
223
224
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;

225
#define Maybe_Stable_Names      SymI_HasProto(mkWeakzh_fast)			\
226
      				SymI_HasProto(mkWeakForeignEnvzh_fast)		\
227
228
      				SymI_HasProto(makeStableNamezh_fast)		\
      				SymI_HasProto(finalizzeWeakzh_fast)
229

230
#if !defined (mingw32_HOST_OS)
231
#define RTS_POSIX_ONLY_SYMBOLS                  \
232
233
234
235
236
237
      SymI_HasProto(shutdownHaskellAndSignal)	\
      SymI_NeedsProto(lockFile)                 \
      SymI_NeedsProto(unlockFile)               \
      SymI_HasProto(signal_handlers)		\
      SymI_HasProto(stg_sig_install)		\
      SymI_NeedsProto(nocldstop)
sof's avatar
sof committed
238
#endif
239

240
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
241
242
243
#define RTS_MINGW_ONLY_SYMBOLS /**/
/* Don't have the ability to read import libs / archives, so
 * we have to stupidly list a lot of what libcygwin.a
244
 * exports; sigh.
sof's avatar
sof committed
245
 */
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#define RTS_CYGWIN_ONLY_SYMBOLS                          \
      SymI_HasProto(regfree)                             \
      SymI_HasProto(regexec)                             \
      SymI_HasProto(regerror)                            \
      SymI_HasProto(regcomp)                             \
      SymI_HasProto(__errno)                             \
      SymI_HasProto(access)                              \
      SymI_HasProto(chmod)                               \
      SymI_HasProto(chdir)                               \
      SymI_HasProto(close)                               \
      SymI_HasProto(creat)                               \
      SymI_HasProto(dup)                                 \
      SymI_HasProto(dup2)                                \
      SymI_HasProto(fstat)                               \
      SymI_HasProto(fcntl)                               \
      SymI_HasProto(getcwd)                              \
      SymI_HasProto(getenv)                              \
      SymI_HasProto(lseek)                               \
      SymI_HasProto(open)                                \
      SymI_HasProto(fpathconf)                           \
      SymI_HasProto(pathconf)                            \
      SymI_HasProto(stat)                                \
      SymI_HasProto(pow)                                 \
      SymI_HasProto(tanh)                                \
      SymI_HasProto(cosh)                                \
      SymI_HasProto(sinh)                                \
      SymI_HasProto(atan)                                \
      SymI_HasProto(acos)                                \
      SymI_HasProto(asin)                                \
      SymI_HasProto(tan)                                 \
      SymI_HasProto(cos)                                 \
      SymI_HasProto(sin)                                 \
      SymI_HasProto(exp)                                 \
      SymI_HasProto(log)                                 \
      SymI_HasProto(sqrt)                                \
      SymI_HasProto(localtime_r)                         \
      SymI_HasProto(gmtime_r)                            \
      SymI_HasProto(mktime)                              \
      SymI_NeedsProto(_imp___tzname)                     \
      SymI_HasProto(gettimeofday)                        \
      SymI_HasProto(timezone)                            \
      SymI_HasProto(tcgetattr)                           \
      SymI_HasProto(tcsetattr)                           \
      SymI_HasProto(memcpy)                              \
      SymI_HasProto(memmove)                             \
      SymI_HasProto(realloc)                             \
      SymI_HasProto(malloc)                              \
      SymI_HasProto(free)                                \
      SymI_HasProto(fork)                                \
      SymI_HasProto(lstat)                               \
      SymI_HasProto(isatty)                              \
      SymI_HasProto(mkdir)                               \
      SymI_HasProto(opendir)                             \
      SymI_HasProto(readdir)                             \
      SymI_HasProto(rewinddir)                           \
      SymI_HasProto(closedir)                            \
      SymI_HasProto(link)                                \
      SymI_HasProto(mkfifo)                              \
      SymI_HasProto(pipe)                                \
      SymI_HasProto(read)                                \
      SymI_HasProto(rename)                              \
      SymI_HasProto(rmdir)                               \
      SymI_HasProto(select)                              \
      SymI_HasProto(system)                              \
      SymI_HasProto(write)                               \
      SymI_HasProto(strcmp)                              \
      SymI_HasProto(strcpy)                              \
      SymI_HasProto(strncpy)                             \
      SymI_HasProto(strerror)                            \
      SymI_HasProto(sigaddset)                           \
      SymI_HasProto(sigemptyset)                         \
      SymI_HasProto(sigprocmask)                         \
      SymI_HasProto(umask)                               \
      SymI_HasProto(uname)                               \
      SymI_HasProto(unlink)                              \
      SymI_HasProto(utime)                               \
      SymI_HasProto(waitpid)
323

324
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
325
326
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
327
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
328
329
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
330

331
332
333
/* Extra syms gen'ed by mingw-2's gcc-3.2: */
#if __GNUC__>=3
#define RTS_MINGW_EXTRA_SYMS                    \
334
335
      SymI_NeedsProto(_imp____mb_cur_max)       \
      SymI_NeedsProto(_imp___pctype)
336
337
338
339
#else
#define RTS_MINGW_EXTRA_SYMS
#endif

340
#if HAVE_GETTIMEOFDAY
341
#define RTS_MINGW_GETTIMEOFDAY_SYM SymI_NeedsProto(gettimeofday)
342
343
344
345
#else
#define RTS_MINGW_GETTIMEOFDAY_SYM /**/
#endif

346
347
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
#define RTS_MINGW_ONLY_SYMBOLS                           \
      SymI_HasProto(asyncReadzh_fast)			 \
      SymI_HasProto(asyncWritezh_fast)			 \
      SymI_HasProto(asyncDoProczh_fast)			 \
      SymI_HasProto(memset)                              \
      SymI_HasProto(inet_ntoa)                           \
      SymI_HasProto(inet_addr)                           \
      SymI_HasProto(htonl)                               \
      SymI_HasProto(recvfrom)                            \
      SymI_HasProto(listen)                              \
      SymI_HasProto(bind)                                \
      SymI_HasProto(shutdown)                            \
      SymI_HasProto(connect)                             \
      SymI_HasProto(htons)                               \
      SymI_HasProto(ntohs)                               \
      SymI_HasProto(getservbyname)                       \
      SymI_HasProto(getservbyport)                       \
      SymI_HasProto(getprotobynumber)                    \
      SymI_HasProto(getprotobyname)                      \
      SymI_HasProto(gethostbyname)                       \
      SymI_HasProto(gethostbyaddr)                       \
      SymI_HasProto(gethostname)                         \
      SymI_HasProto(strcpy)                              \
      SymI_HasProto(strncpy)                             \
      SymI_HasProto(abort)                               \
      SymI_NeedsProto(_alloca)                           \
      SymI_NeedsProto(isxdigit)                          \
      SymI_NeedsProto(isupper)                           \
      SymI_NeedsProto(ispunct)                           \
      SymI_NeedsProto(islower)                           \
      SymI_NeedsProto(isspace)                           \
      SymI_NeedsProto(isprint)                           \
      SymI_NeedsProto(isdigit)                           \
      SymI_NeedsProto(iscntrl)                           \
      SymI_NeedsProto(isalpha)                           \
      SymI_NeedsProto(isalnum)                           \
      SymI_HasProto(strcmp)                              \
      SymI_HasProto(memmove)                             \
      SymI_HasProto(realloc)                             \
      SymI_HasProto(malloc)                              \
      SymI_HasProto(pow)                                 \
      SymI_HasProto(tanh)                                \
      SymI_HasProto(cosh)                                \
      SymI_HasProto(sinh)                                \
      SymI_HasProto(atan)                                \
      SymI_HasProto(acos)                                \
      SymI_HasProto(asin)                                \
      SymI_HasProto(tan)                                 \
      SymI_HasProto(cos)                                 \
      SymI_HasProto(sin)                                 \
      SymI_HasProto(exp)                                 \
      SymI_HasProto(log)                                 \
      SymI_HasProto(sqrt)                                \
      SymI_HasProto(powf)                                \
      SymI_HasProto(tanhf)                               \
      SymI_HasProto(coshf)                               \
      SymI_HasProto(sinhf)                               \
      SymI_HasProto(atanf)                               \
      SymI_HasProto(acosf)                               \
      SymI_HasProto(asinf)                               \
      SymI_HasProto(tanf)                                \
      SymI_HasProto(cosf)                                \
      SymI_HasProto(sinf)                                \
      SymI_HasProto(expf)                                \
      SymI_HasProto(logf)                                \
      SymI_HasProto(sqrtf)                               \
      SymI_HasProto(memcpy)                              \
      SymI_HasProto(rts_InstallConsoleEvent)             \
      SymI_HasProto(rts_ConsoleHandlerDone)              \
      SymI_NeedsProto(mktime)                            \
      SymI_NeedsProto(_imp___timezone)                   \
      SymI_NeedsProto(_imp___tzname)                     \
      SymI_NeedsProto(_imp__tzname)                      \
      SymI_NeedsProto(_imp___iob)                        \
      SymI_NeedsProto(_imp___osver)                      \
      SymI_NeedsProto(localtime)                         \
      SymI_NeedsProto(gmtime)                            \
      SymI_NeedsProto(opendir)                           \
      SymI_NeedsProto(readdir)                           \
      SymI_NeedsProto(rewinddir)                         \
      RTS_MINGW_EXTRA_SYMS                               \
      RTS_MINGW_GETTIMEOFDAY_SYM		         \
      SymI_NeedsProto(closedir)
431
#endif
432

433
#if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
#define RTS_DARWIN_ONLY_SYMBOLS			            \
     SymI_NeedsProto(asprintf$LDBLStub)                     \
     SymI_NeedsProto(err$LDBLStub)                          \
     SymI_NeedsProto(errc$LDBLStub)                         \
     SymI_NeedsProto(errx$LDBLStub)                         \
     SymI_NeedsProto(fprintf$LDBLStub)                      \
     SymI_NeedsProto(fscanf$LDBLStub)                       \
     SymI_NeedsProto(fwprintf$LDBLStub)                     \
     SymI_NeedsProto(fwscanf$LDBLStub)                      \
     SymI_NeedsProto(printf$LDBLStub)                       \
     SymI_NeedsProto(scanf$LDBLStub)                        \
     SymI_NeedsProto(snprintf$LDBLStub)                     \
     SymI_NeedsProto(sprintf$LDBLStub)                      \
     SymI_NeedsProto(sscanf$LDBLStub)                       \
     SymI_NeedsProto(strtold$LDBLStub)                      \
     SymI_NeedsProto(swprintf$LDBLStub)                     \
     SymI_NeedsProto(swscanf$LDBLStub)                      \
     SymI_NeedsProto(syslog$LDBLStub)                       \
     SymI_NeedsProto(vasprintf$LDBLStub)                    \
     SymI_NeedsProto(verr$LDBLStub)                         \
     SymI_NeedsProto(verrc$LDBLStub)                        \
     SymI_NeedsProto(verrx$LDBLStub)                        \
     SymI_NeedsProto(vfprintf$LDBLStub)                     \
     SymI_NeedsProto(vfscanf$LDBLStub)                      \
     SymI_NeedsProto(vfwprintf$LDBLStub)                    \
     SymI_NeedsProto(vfwscanf$LDBLStub)                     \
     SymI_NeedsProto(vprintf$LDBLStub)                      \
     SymI_NeedsProto(vscanf$LDBLStub)                       \
     SymI_NeedsProto(vsnprintf$LDBLStub)                    \
     SymI_NeedsProto(vsprintf$LDBLStub)                     \
     SymI_NeedsProto(vsscanf$LDBLStub)                      \
     SymI_NeedsProto(vswprintf$LDBLStub)                    \
     SymI_NeedsProto(vswscanf$LDBLStub)                     \
     SymI_NeedsProto(vsyslog$LDBLStub)                      \
     SymI_NeedsProto(vwarn$LDBLStub)                        \
     SymI_NeedsProto(vwarnc$LDBLStub)                       \
     SymI_NeedsProto(vwarnx$LDBLStub)                       \
     SymI_NeedsProto(vwprintf$LDBLStub)                     \
     SymI_NeedsProto(vwscanf$LDBLStub)                      \
     SymI_NeedsProto(warn$LDBLStub)                         \
     SymI_NeedsProto(warnc$LDBLStub)                        \
     SymI_NeedsProto(warnx$LDBLStub)                        \
     SymI_NeedsProto(wcstold$LDBLStub)                      \
     SymI_NeedsProto(wprintf$LDBLStub)                      \
     SymI_NeedsProto(wscanf$LDBLStub)
479
480
481
482
#else
#define RTS_DARWIN_ONLY_SYMBOLS
#endif

sof's avatar
sof committed
483
#ifndef SMP
484
# define MAIN_CAP_SYM SymI_HasProto(MainCapability)
sof's avatar
sof committed
485
486
487
#else
# define MAIN_CAP_SYM
#endif
488

sof's avatar
sof committed
489
490
#if !defined(mingw32_HOST_OS)
#define RTS_USER_SIGNALS_SYMBOLS \
491
492
493
   SymI_HasProto(setIOManagerPipe) \
   SymI_NeedsProto(blockUserSignals) \
   SymI_NeedsProto(unblockUserSignals)
sof's avatar
sof committed
494
#else
495
496
497
498
499
#define RTS_USER_SIGNALS_SYMBOLS     \
   SymI_HasProto(sendIOManagerEvent) \
   SymI_HasProto(readIOManagerEvent) \
   SymI_HasProto(getIOManagerEvent)  \
   SymI_HasProto(console_handler)
sof's avatar
sof committed
500
501
#endif

502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
#define RTS_LIBFFI_SYMBOLS                                  \
     SymE_NeedsProto(ffi_prep_cif)                          \
     SymE_NeedsProto(ffi_call)                              \
     SymE_NeedsProto(ffi_type_void)                         \
     SymE_NeedsProto(ffi_type_float)                        \
     SymE_NeedsProto(ffi_type_double)                       \
     SymE_NeedsProto(ffi_type_sint64)                       \
     SymE_NeedsProto(ffi_type_uint64)                       \
     SymE_NeedsProto(ffi_type_sint32)                       \
     SymE_NeedsProto(ffi_type_uint32)                       \
     SymE_NeedsProto(ffi_type_sint16)                       \
     SymE_NeedsProto(ffi_type_uint16)                       \
     SymE_NeedsProto(ffi_type_sint8)                        \
     SymE_NeedsProto(ffi_type_uint8)                        \
     SymE_NeedsProto(ffi_type_pointer)
517

518
519
520
#ifdef TABLES_NEXT_TO_CODE
#define RTS_RET_SYMBOLS /* nothing */
#else
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
#define RTS_RET_SYMBOLS 		                \
      SymI_HasProto(stg_enter_ret)			\
      SymI_HasProto(stg_gc_fun_ret)			\
      SymI_HasProto(stg_ap_v_ret)			\
      SymI_HasProto(stg_ap_f_ret)			\
      SymI_HasProto(stg_ap_d_ret)			\
      SymI_HasProto(stg_ap_l_ret)			\
      SymI_HasProto(stg_ap_n_ret)			\
      SymI_HasProto(stg_ap_p_ret)			\
      SymI_HasProto(stg_ap_pv_ret)			\
      SymI_HasProto(stg_ap_pp_ret)			\
      SymI_HasProto(stg_ap_ppv_ret)			\
      SymI_HasProto(stg_ap_ppp_ret)			\
      SymI_HasProto(stg_ap_pppv_ret)			\
      SymI_HasProto(stg_ap_pppp_ret)			\
      SymI_HasProto(stg_ap_ppppp_ret)			\
      SymI_HasProto(stg_ap_pppppp_ret)
538
539
#endif

540
541
/* On Windows, we link libgmp.a statically into libHSrts.dll */
#ifdef mingw32_HOST_OS
542
543
544
545
546
547
#define GMP_SYMS				        \
      SymI_HasProto(__gmpz_cmp)				\
      SymI_HasProto(__gmpz_cmp_si)			\
      SymI_HasProto(__gmpz_cmp_ui)			\
      SymI_HasProto(__gmpz_get_si)			\
      SymI_HasProto(__gmpz_get_ui)
548
#else
549
550
551
552
553
554
#define GMP_SYMS				        \
      SymE_HasProto(__gmpz_cmp)			        \
      SymE_HasProto(__gmpz_cmp_si)			\
      SymE_HasProto(__gmpz_cmp_ui)			\
      SymE_HasProto(__gmpz_get_si)			\
      SymE_HasProto(__gmpz_get_ui)
555
556
#endif

557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
#define RTS_SYMBOLS				        \
      Maybe_Stable_Names			        \
      SymI_HasProto(StgReturn)				\
      SymI_HasProto(stg_enter_info)			\
      SymI_HasProto(stg_gc_void_info)			\
      SymI_HasProto(__stg_gc_enter_1)			\
      SymI_HasProto(stg_gc_noregs)			\
      SymI_HasProto(stg_gc_unpt_r1_info)		\
      SymI_HasProto(stg_gc_unpt_r1)			\
      SymI_HasProto(stg_gc_unbx_r1_info)		\
      SymI_HasProto(stg_gc_unbx_r1)			\
      SymI_HasProto(stg_gc_f1_info)			\
      SymI_HasProto(stg_gc_f1)				\
      SymI_HasProto(stg_gc_d1_info)			\
      SymI_HasProto(stg_gc_d1)				\
      SymI_HasProto(stg_gc_l1_info)			\
      SymI_HasProto(stg_gc_l1)				\
      SymI_HasProto(__stg_gc_fun)			\
      SymI_HasProto(stg_gc_fun_info)			\
      SymI_HasProto(stg_gc_gen)				\
      SymI_HasProto(stg_gc_gen_info)			\
      SymI_HasProto(stg_gc_gen_hp)			\
      SymI_HasProto(stg_gc_ut)				\
      SymI_HasProto(stg_gen_yield)			\
      SymI_HasProto(stg_yield_noregs)			\
      SymI_HasProto(stg_yield_to_interpreter)		\
      SymI_HasProto(stg_gen_block)			\
      SymI_HasProto(stg_block_noregs)			\
      SymI_HasProto(stg_block_1)			\
      SymI_HasProto(stg_block_takemvar)			\
      SymI_HasProto(stg_block_putmvar)			\
      MAIN_CAP_SYM                                      \
      SymI_HasProto(MallocFailHook)			\
      SymI_HasProto(OnExitHook)				\
      SymI_HasProto(OutOfHeapHook)			\
      SymI_HasProto(StackOverflowHook)			\
      SymI_HasProto(__encodeDouble)			\
      SymI_HasProto(__encodeFloat)			\
      SymI_HasProto(addDLL)               		\
      GMP_SYMS					        \
      SymI_HasProto(__int_encodeDouble)			\
      SymI_HasProto(__word_encodeDouble)		\
      SymI_HasProto(__2Int_encodeDouble)		\
      SymI_HasProto(__int_encodeFloat)			\
      SymI_HasProto(__word_encodeFloat)			\
      SymI_HasProto(andIntegerzh_fast)			\
      SymI_HasProto(atomicallyzh_fast)			\
      SymI_HasProto(barf)				\
      SymI_HasProto(debugBelch)				\
      SymI_HasProto(errorBelch)				\
Simon Marlow's avatar
Simon Marlow committed
607
      SymI_HasProto(sysErrorBelch)                      \
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
      SymI_HasProto(asyncExceptionsBlockedzh_fast)	\
      SymI_HasProto(blockAsyncExceptionszh_fast)	\
      SymI_HasProto(catchzh_fast)			\
      SymI_HasProto(catchRetryzh_fast)			\
      SymI_HasProto(catchSTMzh_fast)			\
      SymI_HasProto(checkzh_fast)                       \
      SymI_HasProto(closure_flags)                      \
      SymI_HasProto(cmp_thread)				\
      SymI_HasProto(cmpIntegerzh_fast)	        	\
      SymI_HasProto(cmpIntegerIntzh_fast)	      	\
      SymI_HasProto(complementIntegerzh_fast)		\
      SymI_HasProto(createAdjustor)			\
      SymI_HasProto(decodeDoublezh_fast)		\
      SymI_HasProto(decodeDoublezu2Intzh_fast)		\
      SymI_HasProto(decodeFloatzuIntzh_fast)		\
      SymI_HasProto(defaultsHook)			\
      SymI_HasProto(delayzh_fast)			\
      SymI_HasProto(deRefWeakzh_fast)			\
      SymI_HasProto(deRefStablePtrzh_fast)		\
      SymI_HasProto(dirty_MUT_VAR)			\
      SymI_HasProto(divExactIntegerzh_fast)		\
      SymI_HasProto(divModIntegerzh_fast)		\
      SymI_HasProto(forkzh_fast)			\
      SymI_HasProto(forkOnzh_fast)			\
      SymI_HasProto(forkProcess)			\
      SymI_HasProto(forkOS_createThread)		\
      SymI_HasProto(freeHaskellFunctionPtr)		\
      SymI_HasProto(freeStablePtr)		        \
      SymI_HasProto(getOrSetTypeableStore)		\
637
      SymI_HasProto(getOrSetSignalHandlerStore)		\
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
      SymI_HasProto(gcdIntegerzh_fast)			\
      SymI_HasProto(gcdIntegerIntzh_fast)		\
      SymI_HasProto(gcdIntzh_fast)			\
      SymI_HasProto(genSymZh)				\
      SymI_HasProto(genericRaise)			\
      SymI_HasProto(getProgArgv)			\
      SymI_HasProto(getFullProgArgv)			\
      SymI_HasProto(getStablePtr)			\
      SymI_HasProto(hs_init)				\
      SymI_HasProto(hs_exit)				\
      SymI_HasProto(hs_set_argv)			\
      SymI_HasProto(hs_add_root)			\
      SymI_HasProto(hs_perform_gc)			\
      SymI_HasProto(hs_free_stable_ptr)			\
      SymI_HasProto(hs_free_fun_ptr)			\
      SymI_HasProto(hs_hpc_rootModule)		        \
654
      SymI_HasProto(hs_hpc_module)		        \
655
656
657
      SymI_HasProto(initLinker)				\
      SymI_HasProto(unpackClosurezh_fast)               \
      SymI_HasProto(getApStackValzh_fast)               \
658
      SymI_HasProto(getSparkzh_fast)                    \
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
      SymI_HasProto(int2Integerzh_fast)			\
      SymI_HasProto(integer2Intzh_fast)			\
      SymI_HasProto(integer2Wordzh_fast)		\
      SymI_HasProto(isCurrentThreadBoundzh_fast)	\
      SymI_HasProto(isDoubleDenormalized)		\
      SymI_HasProto(isDoubleInfinite)			\
      SymI_HasProto(isDoubleNaN)			\
      SymI_HasProto(isDoubleNegativeZero)		\
      SymI_HasProto(isEmptyMVarzh_fast)			\
      SymI_HasProto(isFloatDenormalized)		\
      SymI_HasProto(isFloatInfinite)			\
      SymI_HasProto(isFloatNaN)				\
      SymI_HasProto(isFloatNegativeZero)		\
      SymI_HasProto(killThreadzh_fast)			\
      SymI_HasProto(loadObj)          			\
      SymI_HasProto(insertStableSymbol) 		\
      SymI_HasProto(insertSymbol)     			\
      SymI_HasProto(lookupSymbol)     			\
      SymI_HasProto(makeStablePtrzh_fast)		\
      SymI_HasProto(minusIntegerzh_fast)		\
      SymI_HasProto(mkApUpd0zh_fast)			\
      SymI_HasProto(myThreadIdzh_fast)			\
      SymI_HasProto(labelThreadzh_fast)                 \
      SymI_HasProto(newArrayzh_fast)			\
      SymI_HasProto(newBCOzh_fast)			\
      SymI_HasProto(newByteArrayzh_fast)		\
      SymI_HasProto_redirect(newCAF, newDynCAF)		\
      SymI_HasProto(newMVarzh_fast)			\
      SymI_HasProto(newMutVarzh_fast)			\
      SymI_HasProto(newTVarzh_fast)			\
      SymI_HasProto(noDuplicatezh_fast)			\
      SymI_HasProto(atomicModifyMutVarzh_fast)		\
      SymI_HasProto(newPinnedByteArrayzh_fast)		\
Simon Marlow's avatar
Simon Marlow committed
692
      SymI_HasProto(newAlignedPinnedByteArrayzh_fast)	\
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
      SymI_HasProto(newSpark)				\
      SymI_HasProto(orIntegerzh_fast)			\
      SymI_HasProto(performGC)				\
      SymI_HasProto(performMajorGC)			\
      SymI_HasProto(plusIntegerzh_fast)			\
      SymI_HasProto(prog_argc)				\
      SymI_HasProto(prog_argv)				\
      SymI_HasProto(putMVarzh_fast)			\
      SymI_HasProto(quotIntegerzh_fast)			\
      SymI_HasProto(quotRemIntegerzh_fast)		\
      SymI_HasProto(raisezh_fast)			\
      SymI_HasProto(raiseIOzh_fast)			\
      SymI_HasProto(readTVarzh_fast)			\
      SymI_HasProto(readTVarIOzh_fast)			\
      SymI_HasProto(remIntegerzh_fast)			\
      SymI_HasProto(resetNonBlockingFd)			\
      SymI_HasProto(resumeThread)			\
      SymI_HasProto(resolveObjs)                        \
      SymI_HasProto(retryzh_fast)                       \
      SymI_HasProto(rts_apply)				\
      SymI_HasProto(rts_checkSchedStatus)		\
      SymI_HasProto(rts_eval)				\
      SymI_HasProto(rts_evalIO)				\
      SymI_HasProto(rts_evalLazyIO)			\
      SymI_HasProto(rts_evalStableIO)			\
      SymI_HasProto(rts_eval_)				\
      SymI_HasProto(rts_getBool)			\
      SymI_HasProto(rts_getChar)			\
      SymI_HasProto(rts_getDouble)			\
      SymI_HasProto(rts_getFloat)			\
      SymI_HasProto(rts_getInt)				\
      SymI_HasProto(rts_getInt8)			\
      SymI_HasProto(rts_getInt16)			\
      SymI_HasProto(rts_getInt32)			\
      SymI_HasProto(rts_getInt64)			\
      SymI_HasProto(rts_getPtr)				\
      SymI_HasProto(rts_getFunPtr)			\
      SymI_HasProto(rts_getStablePtr)			\
      SymI_HasProto(rts_getThreadId)			\
      SymI_HasProto(rts_getWord)			\
      SymI_HasProto(rts_getWord8)			\
      SymI_HasProto(rts_getWord16)			\
      SymI_HasProto(rts_getWord32)			\
      SymI_HasProto(rts_getWord64)			\
      SymI_HasProto(rts_lock)				\
      SymI_HasProto(rts_mkBool)				\
      SymI_HasProto(rts_mkChar)				\
      SymI_HasProto(rts_mkDouble)			\
      SymI_HasProto(rts_mkFloat)			\
      SymI_HasProto(rts_mkInt)				\
      SymI_HasProto(rts_mkInt8)				\
      SymI_HasProto(rts_mkInt16)			\
      SymI_HasProto(rts_mkInt32)			\
      SymI_HasProto(rts_mkInt64)			\
      SymI_HasProto(rts_mkPtr)				\
      SymI_HasProto(rts_mkFunPtr)			\
      SymI_HasProto(rts_mkStablePtr)			\
      SymI_HasProto(rts_mkString)			\
      SymI_HasProto(rts_mkWord)				\
      SymI_HasProto(rts_mkWord8)			\
      SymI_HasProto(rts_mkWord16)			\
      SymI_HasProto(rts_mkWord32)			\
      SymI_HasProto(rts_mkWord64)			\
      SymI_HasProto(rts_unlock)				\
      SymI_HasProto(rtsSupportsBoundThreads)		\
      SymI_HasProto(__hscore_get_saved_termios)		\
      SymI_HasProto(__hscore_set_saved_termios)		\
      SymI_HasProto(setProgArgv)			\
      SymI_HasProto(startupHaskell)			\
      SymI_HasProto(shutdownHaskell)			\
      SymI_HasProto(shutdownHaskellAndExit)		\
      SymI_HasProto(stable_ptr_table)			\
      SymI_HasProto(stackOverflow)			\
      SymI_HasProto(stg_CAF_BLACKHOLE_info)		\
767
      SymI_HasProto(__stg_EAGER_BLACKHOLE_info)		\
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
      SymI_HasProto(awakenBlockedQueue)			\
      SymI_HasProto(startTimer)                         \
      SymI_HasProto(stg_CHARLIKE_closure)		\
      SymI_HasProto(stg_MVAR_CLEAN_info)		\
      SymI_HasProto(stg_MVAR_DIRTY_info)		\
      SymI_HasProto(stg_IND_STATIC_info)		\
      SymI_HasProto(stg_INTLIKE_closure)		\
      SymI_HasProto(stg_MUT_ARR_PTRS_DIRTY_info)	\
      SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN_info)	\
      SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN0_info)	\
      SymI_HasProto(stg_WEAK_info)                      \
      SymI_HasProto(stg_ap_v_info)			\
      SymI_HasProto(stg_ap_f_info)			\
      SymI_HasProto(stg_ap_d_info)			\
      SymI_HasProto(stg_ap_l_info)			\
      SymI_HasProto(stg_ap_n_info)			\
      SymI_HasProto(stg_ap_p_info)			\
      SymI_HasProto(stg_ap_pv_info)			\
      SymI_HasProto(stg_ap_pp_info)			\
      SymI_HasProto(stg_ap_ppv_info)			\
      SymI_HasProto(stg_ap_ppp_info)			\
      SymI_HasProto(stg_ap_pppv_info)			\
      SymI_HasProto(stg_ap_pppp_info)			\
      SymI_HasProto(stg_ap_ppppp_info)			\
      SymI_HasProto(stg_ap_pppppp_info)			\
      SymI_HasProto(stg_ap_0_fast)			\
      SymI_HasProto(stg_ap_v_fast)			\
      SymI_HasProto(stg_ap_f_fast)			\
      SymI_HasProto(stg_ap_d_fast)			\
      SymI_HasProto(stg_ap_l_fast)			\
      SymI_HasProto(stg_ap_n_fast)			\
      SymI_HasProto(stg_ap_p_fast)			\
      SymI_HasProto(stg_ap_pv_fast)			\
      SymI_HasProto(stg_ap_pp_fast)			\
      SymI_HasProto(stg_ap_ppv_fast)			\
      SymI_HasProto(stg_ap_ppp_fast)			\
      SymI_HasProto(stg_ap_pppv_fast)			\
      SymI_HasProto(stg_ap_pppp_fast)			\
      SymI_HasProto(stg_ap_ppppp_fast)			\
      SymI_HasProto(stg_ap_pppppp_fast)			\
      SymI_HasProto(stg_ap_1_upd_info)			\
      SymI_HasProto(stg_ap_2_upd_info)			\
      SymI_HasProto(stg_ap_3_upd_info)			\
      SymI_HasProto(stg_ap_4_upd_info)			\
      SymI_HasProto(stg_ap_5_upd_info)			\
      SymI_HasProto(stg_ap_6_upd_info)			\
      SymI_HasProto(stg_ap_7_upd_info)			\
      SymI_HasProto(stg_exit)				\
      SymI_HasProto(stg_sel_0_upd_info)			\
      SymI_HasProto(stg_sel_10_upd_info)		\
      SymI_HasProto(stg_sel_11_upd_info)		\
      SymI_HasProto(stg_sel_12_upd_info)		\
      SymI_HasProto(stg_sel_13_upd_info)		\
      SymI_HasProto(stg_sel_14_upd_info)		\
      SymI_HasProto(stg_sel_15_upd_info)		\
      SymI_HasProto(stg_sel_1_upd_info)			\
      SymI_HasProto(stg_sel_2_upd_info)			\
      SymI_HasProto(stg_sel_3_upd_info)			\
      SymI_HasProto(stg_sel_4_upd_info)			\
      SymI_HasProto(stg_sel_5_upd_info)			\
      SymI_HasProto(stg_sel_6_upd_info)			\
      SymI_HasProto(stg_sel_7_upd_info)			\
      SymI_HasProto(stg_sel_8_upd_info)			\
      SymI_HasProto(stg_sel_9_upd_info)			\
      SymI_HasProto(stg_upd_frame_info)			\
      SymI_HasProto(suspendThread)			\
      SymI_HasProto(takeMVarzh_fast)			\
      SymI_HasProto(threadStatuszh_fast)		\
      SymI_HasProto(timesIntegerzh_fast)		\
      SymI_HasProto(tryPutMVarzh_fast)			\
      SymI_HasProto(tryTakeMVarzh_fast)			\
      SymI_HasProto(unblockAsyncExceptionszh_fast)	\
      SymI_HasProto(unloadObj)                          \
      SymI_HasProto(unsafeThawArrayzh_fast)		\
      SymI_HasProto(waitReadzh_fast)			\
      SymI_HasProto(waitWritezh_fast)			\
      SymI_HasProto(word2Integerzh_fast)		\
      SymI_HasProto(writeTVarzh_fast)			\
      SymI_HasProto(xorIntegerzh_fast)			\
      SymI_HasProto(yieldzh_fast)                       \
      SymI_NeedsProto(stg_interp_constr_entry)          \
      SymI_HasProto(allocateExec)	                \
      SymI_HasProto(freeExec)		                \
      SymI_HasProto(getAllocations)                     \
      SymI_HasProto(revertCAFs)                         \
      SymI_HasProto(RtsFlags)                           \
      SymI_NeedsProto(rts_breakpoint_io_action)		\
      SymI_NeedsProto(rts_stop_next_breakpoint)		\
      SymI_NeedsProto(rts_stop_on_exception)		\
      SymI_HasProto(stopTimer)				\
      SymI_HasProto(n_capabilities)			\
859
      SymI_HasProto(traceCcszh_fast)                    \
sof's avatar
sof committed
860
      RTS_USER_SIGNALS_SYMBOLS
861

862
#ifdef SUPPORT_LONG_LONGS
863
864
865
#define RTS_LONG_LONG_SYMS			        \
      SymI_HasProto(int64ToIntegerzh_fast)		\
      SymI_HasProto(word64ToIntegerzh_fast)
866
867
868
869
#else
#define RTS_LONG_LONG_SYMS /* nothing */
#endif

870
871
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
872
873
874
875
876
877
878
879
880
881
#define RTS_LIBGCC_SYMBOLS			       \
      SymI_NeedsProto(__divdi3)                        \
      SymI_NeedsProto(__udivdi3)                       \
      SymI_NeedsProto(__moddi3)                        \
      SymI_NeedsProto(__umoddi3)		       \
      SymI_NeedsProto(__muldi3)			       \
      SymI_NeedsProto(__ashldi3)		       \
      SymI_NeedsProto(__ashrdi3)		       \
      SymI_NeedsProto(__lshrdi3)		       \
      SymI_NeedsProto(__eprintf)
882
#elif defined(ia64_HOST_ARCH)
883
884
885
886
887
888
889
#define RTS_LIBGCC_SYMBOLS			        \
      SymI_NeedsProto(__divdi3)				\
      SymI_NeedsProto(__udivdi3)                        \
      SymI_NeedsProto(__moddi3)				\
      SymI_NeedsProto(__umoddi3)			\
      SymI_NeedsProto(__divsf3)				\
      SymI_NeedsProto(__divdf3)
890
891
892
893
#else
#define RTS_LIBGCC_SYMBOLS
#endif

894
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
895
896
897
898
      // Symbols that don't have a leading underscore
      // on Mac OS X. They have to receive special treatment,
      // see machoInitSymbolsWithoutUnderscore()
#define RTS_MACHO_NOUNDERLINE_SYMBOLS		\
899
900
      SymI_NeedsProto(saveFP)				\
      SymI_NeedsProto(restFP)
901
#endif
902
903

/* entirely bogus claims about types of these symbols */
904
#define SymI_NeedsProto(vvv)  extern void vvv(void);
905
#if defined(__PIC__) && defined(mingw32_TARGET_OS)
906
907
#define SymE_HasProto(vvv)    SymE_HasProto(vvv);
#define SymE_NeedsProto(vvv)    extern void _imp__ ## vvv (void);
908
#else
909
910
#define SymE_NeedsProto(vvv)  SymI_NeedsProto(vvv);
#define SymE_HasProto(vvv)    SymI_HasProto(vvv)
911
#endif
912
913
#define SymI_HasProto(vvv) /**/
#define SymI_HasProto_redirect(vvv,xxx) /**/
914
RTS_SYMBOLS
915
RTS_RET_SYMBOLS
916
RTS_LONG_LONG_SYMS
917
RTS_POSIX_ONLY_SYMBOLS
918
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
919
RTS_CYGWIN_ONLY_SYMBOLS
920
RTS_DARWIN_ONLY_SYMBOLS
921
RTS_LIBGCC_SYMBOLS
922
RTS_LIBFFI_SYMBOLS
923
924
925
926
927
#undef SymI_NeedsProto
#undef SymI_HasProto
#undef SymI_HasProto_redirect
#undef SymE_HasProto
#undef SymE_NeedsProto
928
929
930
931
932
933
934

#ifdef LEADING_UNDERSCORE
#define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
#else
#define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
#endif

935
#define SymI_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
936
                    (void*)(&(vvv)) },
937
#define SymE_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
938
	    (void*)DLL_IMPORT_DATA_REF(vvv) },
939

940
941
942
943
#define SymI_NeedsProto(vvv) SymI_HasProto(vvv)
#define SymE_NeedsProto(vvv) SymE_HasProto(vvv)

// SymI_HasProto_redirect allows us to redirect references to one symbol to
944
// another symbol.  See newCAF/newDynCAF for an example.
945
#define SymI_HasProto_redirect(vvv,xxx) \
946
947
948
    { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
      (void*)(&(xxx)) },

949
static RtsSymbolVal rtsSyms[] = {
950
      RTS_SYMBOLS
951
      RTS_RET_SYMBOLS
952
      RTS_LONG_LONG_SYMS
953
      RTS_POSIX_ONLY_SYMBOLS
954
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
955
      RTS_CYGWIN_ONLY_SYMBOLS
956
      RTS_DARWIN_ONLY_SYMBOLS
957
      RTS_LIBGCC_SYMBOLS
958
      RTS_LIBFFI_SYMBOLS
959
960
961
962
#if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
      // dyld stub code contains references to this,
      // but it should never be called because we treat
      // lazy pointers as nonlazy.
963
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
964
#endif
965
966
967
      { 0, 0 } /* sentinel */
};

968
969


970
971
972
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
973

974
975
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
976
                                     char* key,
977
978
979
980
981
982
983
984
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
985
   debugBelch(
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
      "\n\n"
      "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
      "   %s\n"
      "whilst processing object file\n"
      "   %s\n"
      "This could be caused by:\n"
      "   * Loading two different object files which export the same symbol\n"
      "   * Specifying the same object file twice on the GHCi command line\n"
      "   * An incorrect `package.conf' entry, causing some object to be\n"
      "     loaded twice.\n"
      "GHCi cannot safely continue in this situation.  Exiting now.  Sorry.\n"
      "\n",
      (char*)key,
      obj_name
   );
   exit(1);
}
1003
1004
1005
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
1006
1007
1008
1009


static int linker_init_done = 0 ;

1010
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1011
static void *dl_prog_handle;
1012
#endif
1013
1014
1015
1016

void
initLinker( void )
{
1017
    RtsSymbolVal *sym;
1018

1019
1020
1021
1022
1023
1024
1025
    /* Make initLinker idempotent, so we can call it
       before evey relevant operation; that means we
       don't need to initialise the linker separately */
    if (linker_init_done == 1) { return; } else {
      linker_init_done = 1;
    }

1026
    stablehash = allocStrHashTable();
1027
1028
1029
1030
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
1031
1032
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
1033
    }
1034
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
1035
1036
1037
    machoInitSymbolsWithoutUnderscore();
#   endif

1038
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1039
#   if defined(RTLD_DEFAULT)
1040
1041
    dl_prog_handle = RTLD_DEFAULT;
#   else
1042
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
1043
#   endif /* RTLD_DEFAULT */
1044
#   endif
1045
1046
1047
1048
1049
1050
1051

#if defined(x86_64_HOST_ARCH)
    if (RtsFlags.MiscFlags.linkerMemBase != 0) {
        // User-override for mmap_32bit_base
        mmap_32bit_base = (void*)RtsFlags.MiscFlags.linkerMemBase;
    }
#endif
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061

#if defined(mingw32_HOST_OS)
    /*
     * These two libraries cause problems when added to the static link,
     * but are necessary for resolving symbols in GHCi, hence we load
     * them manually here.
     */
    addDLL("msvcrt");
    addDLL("kernel32");
#endif
1062
1063
}

1064
/* -----------------------------------------------------------------------------
1065
1066
1067
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
1068
1069
1070
1071
 * Add a DLL from which symbols may be found.  In the ELF case, just
 * do RTLD_GLOBAL-style add, so no further messing around needs to
 * happen in order that symbols in the loaded .so are findable --
 * lookupSymbol() will subsequently see them by dlsym on the program's
1072
1073
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
1074
 * In the PEi386 case, open the DLLs and put handles to them in a
1075
 * linked list.  When looking for a symbol, try all handles in the
1076
1077
1078
1079
1080
 * list.  This means that we need to load even DLLs that are guaranteed
 * to be in the ghc.exe image already, just so we can get a handle
 * to give to loadSymbol, so that we can find the symbols.  For such
 * libraries, the LoadLibrary call should be a no-op except for returning
 * the handle.
1081
 *
1082
 */
1083
1084
1085
1086
1087
1088

#if defined(OBJFORMAT_PEi386)
/* A record for storing handles into DLLs. */

typedef
   struct _OpenedDLL {
1089
      char*              name;
1090
1091
      struct _OpenedDLL* next;
      HINSTANCE instance;
1092
   }
1093
1094
1095
1096
1097
1098
   OpenedDLL;

/* A list thereof. */
static OpenedDLL* opened_dlls = NULL;
#endif

1099
const char *
1100
addDLL( char *dll_name )
1101
{
1102
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1103
   /* ------------------- ELF DLL loader ------------------- */
1104
   void *hdl;
1105
   const char *errmsg;
1106

1107
1108
   initLinker();

1109
1110
1111
   // omitted: RTLD_NOW
   // see http://www.haskell.org/pipermail/cvs-ghc/2007-September/038570.html
   hdl= dlopen(dll_name, RTLD_LAZY | RTLD_GLOBAL);
dons's avatar
dons committed
1112

1113
1114
1115
1116
1117
1118
1119
1120
   if (hdl == NULL) {
      /* dlopen failed; return a ptr to the error msg. */
      errmsg = dlerror();
      if (errmsg == NULL) errmsg = "addDLL: unknown error";
      return errmsg;
   } else {
      return NULL;
   }
1121
1122
   /*NOTREACHED*/

1123
#  elif defined(OBJFORMAT_PEi386)
1124
   /* ------------------- Win32 DLL loader ------------------- */
1125

1126
   char*      buf;
1127
   OpenedDLL* o_dll;
1128
   HINSTANCE  instance;
1129

1130
1131
   initLinker();

1132
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1133
1134
1135
1136
1137

   /* See if we've already got it, and ignore if so. */
   for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
      if (0 == strcmp(o_dll->name, dll_name))
         return NULL;
1138
1139
   }

1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
   /* The file name has no suffix (yet) so that we can try
      both foo.dll and foo.drv

      The documentation for LoadLibrary says:
      	If no file name extension is specified in the lpFileName
      	parameter, the default library extension .dll is
      	appended. However, the file name string can include a trailing
      	point character (.) to indicate that the module name has no
      	extension. */

1150
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1151
1152
1153
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
       if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
       // KAA: allow loading of drivers (like winspool.drv)
       sprintf(buf, "%s.DRV", dll_name);
       instance = LoadLibrary(buf);
       if (instance == NULL) {
           if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
           // #1883: allow loading of unix-style libfoo.dll DLLs
           sprintf(buf, "lib%s.DLL", dll_name);
           instance = LoadLibrary(buf);
           if (instance == NULL) {
               goto error;
           }
       }
1167
   }
sof's avatar
sof committed
1168
   stgFree(buf);
1169

1170
   /* Add this DLL to the list of DLLs in which to search for symbols. */
1171
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1172
1173
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
1174
   o_dll->instance = instance;
1175
1176
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
1177
1178

   return NULL;
1179
1180
1181
1182

error:
   stgFree(buf);
   sysErrorBelch(dll_name);
Simon Marlow's avatar
Simon Marlow committed
1183

1184
1185
   /* LoadLibrary failed; return a ptr to the error msg. */
   return "addDLL: could not load DLL";
Simon Marlow's avatar
Simon Marlow committed
1186
1187
1188
1189

#  else
   barf("addDLL: not implemented on this platform");
#  endif
1190
1191
}

1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
/* -----------------------------------------------------------------------------
 * insert a stable symbol in the hash table
 */

void
insertStableSymbol(char* obj_name, char* key, StgPtr p)
{
  ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
}


/* -----------------------------------------------------------------------------
 * insert a symbol in the hash table
 */
void
insertSymbol(char* obj_name, char* key, void* data)
{
  ghciInsertStrHashTable(obj_name, symhash, key, data);
}

1212
1213
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
1214
 */
1215
1216
1217
void *
lookupSymbol( char *lbl )
{
1218
    void *val;
1219
    initLinker() ;
1220
    ASSERT(symhash != NULL);
1221
1222
1223
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
1224
#       if defined(OBJFORMAT_ELF)
1225
	return dlsym(dl_prog_handle, lbl);
1226
#       elif defined(OBJFORMAT_MACHO)
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
#       if HAVE_DLFCN_H
        /* On OS X 10.3 and later, we use dlsym instead of the old legacy
           interface.

           HACK: On OS X, global symbols are prefixed with an underscore.
                 However, dlsym wants us to omit the leading underscore from the
                 symbol name. For now, we simply strip it off here (and ONLY
                 here).
        */
        ASSERT(lbl[0] == '_');
        return dlsym(dl_prog_handle, lbl+1);
#       else
1239
1240
1241
1242
1243
1244
	if(NSIsSymbolNameDefined(lbl)) {
	    NSSymbol symbol = NSLookupAndBindSymbol(lbl);
	    return NSAddressOfSymbol(symbol);
	} else {
	    return NULL;
	}
1245
#       endif /* HAVE_DLFCN_H */
1246
#       elif defined(OBJFORMAT_PEi386)
1247
        void* sym;
1248

1249
1250
        sym = lookupSymbolInDLLs(lbl);
        if (sym != NULL) { return sym; };
1251

1252
1253
1254
1255
1256
        // Also try looking up the symbol without the @N suffix.  Some
        // DLLs have the suffixes on their symbols, some don't.
        zapTrailingAtSign ( lbl );
        sym = lookupSymbolInDLLs(lbl);
        if (sym != NULL) { return sym; };
1257
        return NULL;
1258

ken's avatar
ken committed
1259
1260
1261
#       else
        ASSERT(2+2 == 5);
        return NULL;
1262
#       endif
1263
    } else {
1264
	return val;
1265
1266
1267
    }
}

1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
/* -----------------------------------------------------------------------------
 * Debugging aid: look in GHCi's object symbol tables for symbols
 * within DELTA bytes of the specified address, and show their names.
 */
#ifdef DEBUG
void ghci_enquire ( char* addr );

void ghci_enquire ( char* addr )
{
   int   i;
   char* sym;
   char* a;
   const int DELTA = 64;
   ObjectCode* oc;
1282
1283
1284

   initLinker();

1285
1286
1287
1288
1289
   for (oc = objects; oc; oc = oc->next) {
      for (i = 0; i < oc->n_symbols; i++) {
         sym = oc->symbols[i];
         if (sym == NULL) continue;
         a = NULL;
1290
         if (a == NULL) {
1291
            a = lookupStrHashTable(symhash, sym);
1292
	 }
1293
         if (a == NULL) {
1294
	     // debugBelch("ghci_enquire: can't find %s\n", sym);
1295
         }
1296
         else if (addr-DELTA <= a && a <= addr+DELTA) {
1297
            debugBelch("%p + %3d  ==  `%s'\n", addr, (int)(a - addr), sym);
1298
1299
1300
1301
1302
1303
         }
      }
   }
}
#endif

1304
#ifdef ia64_HOST_ARCH
1305
1306
static unsigned int PLTSize(void);
#endif
1307

Simon Marlow's avatar
Simon Marlow committed
1308
#ifdef USE_MMAP
1309
1310
#define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))

1311
1312
1313
1314
1315
static void *
mmapForLinker (size_t bytes, nat flags, int fd)
{
   void *map_addr = NULL;
   void *result;
1316
   int pagesize, size;
1317
   static nat fixed = 0;
1318
1319
1320

   pagesize = getpagesize();
   size = ROUND_UP(bytes, pagesize);
1321

Simon Marlow's avatar
Simon Marlow committed
1322
#if defined(x86_64_HOST_ARCH)
1323
1324
1325
1326
1327
1328
1329
mmap_again:

   if (mmap_32bit_base != 0) {
       map_addr = mmap_32bit_base;
   }
#endif

1330
   result = mmap(map_addr, size, PROT_EXEC|PROT_READ|PROT_WRITE,
1331
		    MAP_PRIVATE|TRY_MAP_32BIT|fixed|flags, fd, 0);
1332
1333

   if (result == MAP_FAILED) {
1334
1335
       sysErrorBelch("mmap %lu bytes at %p",(lnat)size,map_addr);
       errorBelch("Try specifying an address with +RTS -xm<addr> -RTS");
1336
1337
1338
1339
1340
1341
       stg_exit(EXIT_FAILURE);
   }
   
#if defined(x86_64_HOST_ARCH)
   if (mmap_32bit_base != 0) {
       if (result == map_addr) {
1342
           mmap_32bit_base = map_addr + size;
1343
1344
1345
       } else {
           if ((W_)result > 0x80000000) {
               // oops, we were given memory over 2Gb
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
#if defined(freebsd_HOST_OS)
               // Some platforms require MAP_FIXED.  This is normally
               // a bad idea, because MAP_FIXED will overwrite
               // existing mappings.
               munmap(result,size);
               fixed = MAP_FIXED;
               goto mmap_again;
#else
               barf("loadObj: failed to mmap() memory below 2Gb; asked for %lu bytes at %p.  Try specifying an address with +RTS -xm<addr> -RTS", size, map_addr, result);
#endif
1356
1357
1358
1359
           } else {
               // hmm, we were given memory somewhere else, but it's
               // still under 2Gb so we can use it.  Next time, ask
               // for memory right after the place we just got some
1360
               mmap_32bit_base = (void*)result + size;
1361
1362
1363
1364
1365
1366
1367
           }
       }
   } else {
       if ((W_)result > 0x80000000) {
           // oops, we were given memory over 2Gb
           // ... try allocating memory somewhere else?;
           debugTrace(DEBUG_linker,"MAP_32BIT didn't work; gave us %lu bytes at 0x%p", bytes, result);
1368
           munmap(result, size);
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
           
           // Set a base address and try again... (guess: 1Gb)
           mmap_32bit_base = (void*)0x40000000;
           goto mmap_again;
       }
   }
#endif

   return result;
}
Simon Marlow's avatar
Simon Marlow committed
1379
#endif // USE_MMAP
1380

1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
/* -----------------------------------------------------------------------------
 * Load an obj (populate the global symbol table, but don't resolve yet)
 *
 * Returns: 1 if ok, 0 on error.
 */
HsInt
loadObj( char *path )
{
   ObjectCode* oc;
   struct stat st;
1391
   int r;
1392
#ifdef USE_MMAP
1393
   int fd;
1394
#else
1395
   FILE *f;
1396
#endif
1397
1398
   initLinker();

1399
   /* debugBelch("loadObj %s\n", path ); */
1400

1401
   /* Check that we haven't already loaded this object.
dons's avatar
dons committed
1402
      Ignore requests to load multiple times */
1403
   {
1404
       ObjectCode *o;
1405
1406
       int is_dup = 0;
       for (o = objects; o; o = o->next) {
dons's avatar
dons committed
1407
          if (0 == strcmp(o->fileName, path)) {
1408
             is_dup = 1;
dons's avatar
dons committed
1409
1410
             break; /* don't need to search further */
          }
1411
1412
       }
       if (is_dup) {
1413
          IF_DEBUG(linker, debugBelch(
1414
1415
1416
            "GHCi runtime linker: warning: looks like you're trying to load the\n"
            "same object file twice:\n"
            "   %s\n"
dons's avatar
dons committed
1417
1418
1419
            "GHCi will ignore this, but be warned.\n"
            , path));
          return 1; /* success */
1420
       }
1421
1422
1423
1424
   }

   oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");

1425
#  if defined(OBJFORMAT_ELF)
1426
   oc->formatName = "ELF";
1427
#  elif defined(OBJFORMAT_PEi386)
1428
   oc->formatName = "PEi386";
1429
1430
#  elif defined(OBJFORMAT_MACHO)
   oc->formatName = "Mach-O";
1431
#  else
sof's avatar
sof committed
1432
   stgFree(oc);
1433
1434
1435
1436
1437
1438
   barf("loadObj: not implemented on this platform");
#  endif

   r = stat(path, &st);
   if (r == -1) { return 0; }

1439
   /* sigh, strdup() isn't a POSIX function, so do it the long way */
1440
1441
1442
   oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
   strcpy(oc->fileName, path);

1443
1444
1445
   oc->fileSize          = st.st_size;
   oc->symbols           = NULL;
   oc->sections          = NULL;
1446
   oc->proddables        = NULL;
1447
1448
1449
1450
1451

   /* chain it onto the list of objects */
   oc->next              =