Linker.c 200 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
#if defined(__linux__)  || defined(__GLIBC__)
#define _GNU_SOURCE 1
18
19
#endif

20
21
#include "Rts.h"
#include "HsFFI.h"
Simon Marlow's avatar
Simon Marlow committed
22
23

#include "sm/Storage.h"
Simon Marlow's avatar
Simon Marlow committed
24
#include "Stats.h"
25
#include "Hash.h"
26
#include "LinkerInternals.h"
27
#include "RtsUtils.h"
28
#include "Trace.h"
Simon Marlow's avatar
Simon Marlow committed
29
30
31
32
33
34
#include "StgPrimFloat.h" // for __int_encodeFloat etc.
#include "Stable.h"

#if !defined(mingw32_HOST_OS)
#include "posix/Signals.h"
#endif
35

Simon Marlow's avatar
Simon Marlow committed
36
37
38
// get protos for is*()
#include <ctype.h>

39
#ifdef HAVE_SYS_TYPES_H
40
#include <sys/types.h>
41
42
#endif

Ian Lynagh's avatar
Ian Lynagh committed
43
#include <inttypes.h>
44
45
#include <stdlib.h>
#include <string.h>
46
47
#include <stdio.h>
#include <assert.h>
48

49
#ifdef HAVE_SYS_STAT_H
50
#include <sys/stat.h>
51
#endif
52

53
#if defined(HAVE_DLFCN_H)
54
#include <dlfcn.h>
55
#endif
56

57
#if defined(cygwin32_HOST_OS)
sof's avatar
sof committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#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

73
74
75
76
77
78
#if !defined(powerpc_HOST_ARCH) && \
    (   defined(linux_HOST_OS    ) || defined(freebsd_HOST_OS) || \
        defined(dragonfly_HOST_OS) || defined(netbsd_HOST_OS ) || \
        defined(openbsd_HOST_OS  ) || defined(darwin_HOST_OS ) || \
        defined(kfreebsdgnu_HOST_OS) )
/* Don't use mmap on powerpc_HOST_ARCH as mmap doesn't support
79
80
81
82
 * reallocating but we need to allocate jump islands just after each
 * object images. Otherwise relative branches to jump islands can fail
 * due to 24-bits displacement overflow.
 */
83
84
85
#define USE_MMAP
#include <fcntl.h>
#include <sys/mman.h>
dons's avatar
dons committed
86
87
88
89
90

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

91
92
#endif

93
#if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(kfreebsdgnu_HOST_OS) || defined(dragonfly_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
94
#  define OBJFORMAT_ELF
Ian Lynagh's avatar
Ian Lynagh committed
95
96
#  include <regex.h>    // regex is already used by dlopen() so this is OK
                        // to use here without requiring an additional lib
97
#elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
98
#  define OBJFORMAT_PEi386
99
#  include <windows.h>
sof's avatar
sof committed
100
#  include <math.h>
101
#elif defined(darwin_HOST_OS)
102
#  define OBJFORMAT_MACHO
103
#  include <regex.h>
Ian Lynagh's avatar
Ian Lynagh committed
104
105
#  include <mach/machine.h>
#  include <mach-o/fat.h>
106
107
108
#  include <mach-o/loader.h>
#  include <mach-o/nlist.h>
#  include <mach-o/reloc.h>
109
#if !defined(HAVE_DLFCN_H)
110
#  include <mach-o/dyld.h>
111
#endif
112
113
114
#if defined(powerpc_HOST_ARCH)
#  include <mach-o/ppc/reloc.h>
#endif
115
116
117
#if defined(x86_64_HOST_ARCH)
#  include <mach-o/x86_64/reloc.h>
#endif
118
119
#endif

120
121
122
123
#if defined(x86_64_HOST_ARCH) && defined(darwin_HOST_OS)
#define ALWAYS_PIC
#endif

124
/* Hash table mapping symbol names to Symbol */
125
static /*Str*/HashTable *symhash;
126

127
128
129
/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;

130
/* List of currently loaded objects */
Ian Lynagh's avatar
Ian Lynagh committed
131
ObjectCode *objects = NULL;     /* initially empty */
132

133
static HsInt loadOc( ObjectCode* oc );
134
135
static ObjectCode* mkOc( char *path, char *image, int imageSize,
                         char *archiveMemberName
136
137
138
139
140
141
142
#ifndef USE_MMAP
#ifdef darwin_HOST_OS
                       , int misalignment
#endif
#endif
                       );

143
#if defined(OBJFORMAT_ELF)
144
145
146
static int ocVerifyImage_ELF    ( ObjectCode* oc );
static int ocGetNames_ELF       ( ObjectCode* oc );
static int ocResolve_ELF        ( ObjectCode* oc );
147
#if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
148
static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
149
#endif
150
#elif defined(OBJFORMAT_PEi386)
151
152
153
static int ocVerifyImage_PEi386 ( ObjectCode* oc );
static int ocGetNames_PEi386    ( ObjectCode* oc );
static int ocResolve_PEi386     ( ObjectCode* oc );
154
155
static void *lookupSymbolInDLLs ( unsigned char *lbl );
static void zapTrailingAtSign   ( unsigned char *sym );
156
157
158
159
#elif defined(OBJFORMAT_MACHO)
static int ocVerifyImage_MachO    ( ObjectCode* oc );
static int ocGetNames_MachO       ( ObjectCode* oc );
static int ocResolve_MachO        ( ObjectCode* oc );
160

Ian Lynagh's avatar
Ian Lynagh committed
161
#ifndef USE_MMAP
162
static int machoGetMisalignment( FILE * );
Ian Lynagh's avatar
Ian Lynagh committed
163
#endif
164
165
166
#if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
#endif
167
#ifdef powerpc_HOST_ARCH
168
static void machoInitSymbolsWithoutUnderscore( void );
169
#endif
170
#endif
171

172
173
174
175
176
177
178
179
180
181
182
183
184
/* 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.
Ian Lynagh's avatar
Ian Lynagh committed
185
 *
186
187
188
189
190
191
192
193
 * 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
194
195
196
197
198
199
200
201
202
203
204
205
 *
 * 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);
206
207
 */
#define X86_64_ELF_NONPIC_HACK 1
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
/* 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)
 */
235
#if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
236
237
238
239
240
241
242
243
244

#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
245
static void *mmap_32bit_base = (void *)MMAP_32BIT_BASE_DEFAULT;
246
247
248
249
250
251
252
#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

253
254
255
256
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

257
258
259
260
261
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;

Ian Lynagh's avatar
Ian Lynagh committed
262
263
264
265
#define Maybe_Stable_Names      SymI_HasProto(stg_mkWeakzh)                     \
                                SymI_HasProto(stg_mkWeakForeignEnvzh)           \
                                SymI_HasProto(stg_makeStableNamezh)             \
                                SymI_HasProto(stg_finalizzeWeakzh)
266

267
#if !defined (mingw32_HOST_OS)
268
#define RTS_POSIX_ONLY_SYMBOLS                  \
Ian Lynagh's avatar
Ian Lynagh committed
269
270
271
      SymI_HasProto(__hscore_get_saved_termios) \
      SymI_HasProto(__hscore_set_saved_termios) \
      SymI_HasProto(shutdownHaskellAndSignal)   \
Simon Marlow's avatar
Simon Marlow committed
272
273
      SymI_HasProto(lockFile)                   \
      SymI_HasProto(unlockFile)                 \
Ian Lynagh's avatar
Ian Lynagh committed
274
275
      SymI_HasProto(signal_handlers)            \
      SymI_HasProto(stg_sig_install)            \
276
      SymI_HasProto(rtsTimerSignal)             \
Simon Marlow's avatar
Simon Marlow committed
277
      SymI_HasProto(atexit)                     \
278
      SymI_NeedsProto(nocldstop)
sof's avatar
sof committed
279
#endif
280

281
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
282
283
284
#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
285
 * exports; sigh.
sof's avatar
sof committed
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
#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)
364

365
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
366
367
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
368
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
369
370
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
371

372
#if HAVE_GETTIMEOFDAY
373
#define RTS_MINGW_GETTIMEOFDAY_SYM SymI_NeedsProto(gettimeofday)
374
375
376
377
#else
#define RTS_MINGW_GETTIMEOFDAY_SYM /**/
#endif

378
379
380
381
382
383
#if HAVE___MINGW_VFPRINTF
#define RTS___MINGW_VFPRINTF_SYM SymI_HasProto(__mingw_vfprintf)
#else
#define RTS___MINGW_VFPRINTF_SYM /**/
#endif

384
385
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
386
#define RTS_MINGW_ONLY_SYMBOLS                           \
Ian Lynagh's avatar
Ian Lynagh committed
387
388
389
      SymI_HasProto(stg_asyncReadzh)                     \
      SymI_HasProto(stg_asyncWritezh)                    \
      SymI_HasProto(stg_asyncDoProczh)                   \
390
391
      SymI_HasProto(getWin32ProgArgv)                    \
      SymI_HasProto(setWin32ProgArgv)                    \
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
      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)                           \
Ian Lynagh's avatar
Ian Lynagh committed
414
415
416
417
418
419
420
421
422
423
424
      SymI_HasProto(isxdigit)                            \
      SymI_HasProto(isupper)                             \
      SymI_HasProto(ispunct)                             \
      SymI_HasProto(islower)                             \
      SymI_HasProto(isspace)                             \
      SymI_HasProto(isprint)                             \
      SymI_HasProto(isdigit)                             \
      SymI_HasProto(iscntrl)                             \
      SymI_HasProto(isalpha)                             \
      SymI_HasProto(isalnum)                             \
      SymI_HasProto(isascii)                             \
425
      RTS___MINGW_VFPRINTF_SYM                           \
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
      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)                               \
Ian Lynagh's avatar
Ian Lynagh committed
456
      SymI_HasProto(erf)                                 \
457
458
459
      SymI_HasProto(erfc)                                \
      SymI_HasProto(erff)                                \
      SymI_HasProto(erfcf)                               \
460
461
462
463
464
465
466
467
468
469
470
471
472
473
      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)                         \
Ian Lynagh's avatar
Ian Lynagh committed
474
475
476
477
      SymI_NeedsProto(_imp____mb_cur_max)                \
      SymI_NeedsProto(_imp___pctype)                     \
      SymI_NeedsProto(__chkstk)                          \
      RTS_MINGW_GETTIMEOFDAY_SYM                         \
478
      SymI_NeedsProto(closedir)
479
#endif
480

481

482
#if defined(darwin_HOST_OS) && HAVE_PRINTF_LDBLSTUB
Ian Lynagh's avatar
Ian Lynagh committed
483
#define RTS_DARWIN_ONLY_SYMBOLS                             \
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
     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)
528
529
530
531
#else
#define RTS_DARWIN_ONLY_SYMBOLS
#endif

sof's avatar
sof committed
532
#ifndef SMP
533
# define MAIN_CAP_SYM SymI_HasProto(MainCapability)
sof's avatar
sof committed
534
535
536
#else
# define MAIN_CAP_SYM
#endif
537

sof's avatar
sof committed
538
#if !defined(mingw32_HOST_OS)
Ian Lynagh's avatar
Ian Lynagh committed
539
#define RTS_USER_SIGNALS_SYMBOLS        \
540
   SymI_HasProto(setIOManagerControlFd) \
Ian Lynagh's avatar
Ian Lynagh committed
541
542
543
   SymI_HasProto(setIOManagerWakeupFd)  \
   SymI_HasProto(ioManagerWakeup)       \
   SymI_HasProto(blockUserSignals)      \
544
   SymI_HasProto(unblockUserSignals)
sof's avatar
sof committed
545
#else
Ian Lynagh's avatar
Ian Lynagh committed
546
547
548
549
550
#define RTS_USER_SIGNALS_SYMBOLS        \
   SymI_HasProto(ioManagerWakeup)       \
   SymI_HasProto(sendIOManagerEvent)    \
   SymI_HasProto(readIOManagerEvent)    \
   SymI_HasProto(getIOManagerEvent)     \
551
   SymI_HasProto(console_handler)
sof's avatar
sof committed
552
553
#endif

554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
#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)
569

570
571
572
#ifdef TABLES_NEXT_TO_CODE
#define RTS_RET_SYMBOLS /* nothing */
#else
Ian Lynagh's avatar
Ian Lynagh committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
#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)                   \
589
      SymI_HasProto(stg_ap_pppppp_ret)
590
591
#endif

592
593
/* Modules compiled with -ticky may mention ticky counters */
/* This list should marry up with the one in $(TOP)/includes/stg/Ticky.h */
Ian Lynagh's avatar
Ian Lynagh committed
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
#define RTS_TICKY_SYMBOLS                               \
      SymI_NeedsProto(ticky_entry_ctrs)                 \
      SymI_NeedsProto(top_ct)                           \
                                                        \
      SymI_HasProto(ENT_VIA_NODE_ctr)                   \
      SymI_HasProto(ENT_STATIC_THK_ctr)                 \
      SymI_HasProto(ENT_DYN_THK_ctr)                    \
      SymI_HasProto(ENT_STATIC_FUN_DIRECT_ctr)          \
      SymI_HasProto(ENT_DYN_FUN_DIRECT_ctr)             \
      SymI_HasProto(ENT_STATIC_CON_ctr)                 \
      SymI_HasProto(ENT_DYN_CON_ctr)                    \
      SymI_HasProto(ENT_STATIC_IND_ctr)                 \
      SymI_HasProto(ENT_DYN_IND_ctr)                    \
      SymI_HasProto(ENT_PERM_IND_ctr)                   \
      SymI_HasProto(ENT_PAP_ctr)                        \
      SymI_HasProto(ENT_AP_ctr)                         \
      SymI_HasProto(ENT_AP_STACK_ctr)                   \
      SymI_HasProto(ENT_BH_ctr)                         \
      SymI_HasProto(UNKNOWN_CALL_ctr)                   \
      SymI_HasProto(SLOW_CALL_v_ctr)                    \
      SymI_HasProto(SLOW_CALL_f_ctr)                    \
      SymI_HasProto(SLOW_CALL_d_ctr)                    \
      SymI_HasProto(SLOW_CALL_l_ctr)                    \
      SymI_HasProto(SLOW_CALL_n_ctr)                    \
      SymI_HasProto(SLOW_CALL_p_ctr)                    \
      SymI_HasProto(SLOW_CALL_pv_ctr)                   \
      SymI_HasProto(SLOW_CALL_pp_ctr)                   \
      SymI_HasProto(SLOW_CALL_ppv_ctr)                  \
      SymI_HasProto(SLOW_CALL_ppp_ctr)                  \
      SymI_HasProto(SLOW_CALL_pppv_ctr)                 \
      SymI_HasProto(SLOW_CALL_pppp_ctr)                 \
      SymI_HasProto(SLOW_CALL_ppppp_ctr)                \
      SymI_HasProto(SLOW_CALL_pppppp_ctr)               \
      SymI_HasProto(SLOW_CALL_OTHER_ctr)                \
628
      SymI_HasProto(ticky_slow_call_unevald)            \
Ian Lynagh's avatar
Ian Lynagh committed
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
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
692
693
694
695
696
697
698
699
700
701
      SymI_HasProto(SLOW_CALL_ctr)                      \
      SymI_HasProto(MULTI_CHUNK_SLOW_CALL_ctr)          \
      SymI_HasProto(MULTI_CHUNK_SLOW_CALL_CHUNKS_ctr)   \
      SymI_HasProto(KNOWN_CALL_ctr)                     \
      SymI_HasProto(KNOWN_CALL_TOO_FEW_ARGS_ctr)        \
      SymI_HasProto(KNOWN_CALL_EXTRA_ARGS_ctr)          \
      SymI_HasProto(SLOW_CALL_FUN_TOO_FEW_ctr)          \
      SymI_HasProto(SLOW_CALL_FUN_CORRECT_ctr)          \
      SymI_HasProto(SLOW_CALL_FUN_TOO_MANY_ctr)         \
      SymI_HasProto(SLOW_CALL_PAP_TOO_FEW_ctr)          \
      SymI_HasProto(SLOW_CALL_PAP_CORRECT_ctr)          \
      SymI_HasProto(SLOW_CALL_PAP_TOO_MANY_ctr)         \
      SymI_HasProto(SLOW_CALL_UNEVALD_ctr)              \
      SymI_HasProto(UPDF_OMITTED_ctr)                   \
      SymI_HasProto(UPDF_PUSHED_ctr)                    \
      SymI_HasProto(CATCHF_PUSHED_ctr)                  \
      SymI_HasProto(UPDF_RCC_PUSHED_ctr)                \
      SymI_HasProto(UPDF_RCC_OMITTED_ctr)               \
      SymI_HasProto(UPD_SQUEEZED_ctr)                   \
      SymI_HasProto(UPD_CON_IN_NEW_ctr)                 \
      SymI_HasProto(UPD_CON_IN_PLACE_ctr)               \
      SymI_HasProto(UPD_PAP_IN_NEW_ctr)                 \
      SymI_HasProto(UPD_PAP_IN_PLACE_ctr)               \
      SymI_HasProto(ALLOC_HEAP_ctr)                     \
      SymI_HasProto(ALLOC_HEAP_tot)                     \
      SymI_HasProto(ALLOC_FUN_ctr)                      \
      SymI_HasProto(ALLOC_FUN_adm)                      \
      SymI_HasProto(ALLOC_FUN_gds)                      \
      SymI_HasProto(ALLOC_FUN_slp)                      \
      SymI_HasProto(UPD_NEW_IND_ctr)                    \
      SymI_HasProto(UPD_NEW_PERM_IND_ctr)               \
      SymI_HasProto(UPD_OLD_IND_ctr)                    \
      SymI_HasProto(UPD_OLD_PERM_IND_ctr)               \
      SymI_HasProto(UPD_BH_UPDATABLE_ctr)               \
      SymI_HasProto(UPD_BH_SINGLE_ENTRY_ctr)            \
      SymI_HasProto(UPD_CAF_BH_UPDATABLE_ctr)           \
      SymI_HasProto(UPD_CAF_BH_SINGLE_ENTRY_ctr)        \
      SymI_HasProto(GC_SEL_ABANDONED_ctr)               \
      SymI_HasProto(GC_SEL_MINOR_ctr)                   \
      SymI_HasProto(GC_SEL_MAJOR_ctr)                   \
      SymI_HasProto(GC_FAILED_PROMOTION_ctr)            \
      SymI_HasProto(ALLOC_UP_THK_ctr)                   \
      SymI_HasProto(ALLOC_SE_THK_ctr)                   \
      SymI_HasProto(ALLOC_THK_adm)                      \
      SymI_HasProto(ALLOC_THK_gds)                      \
      SymI_HasProto(ALLOC_THK_slp)                      \
      SymI_HasProto(ALLOC_CON_ctr)                      \
      SymI_HasProto(ALLOC_CON_adm)                      \
      SymI_HasProto(ALLOC_CON_gds)                      \
      SymI_HasProto(ALLOC_CON_slp)                      \
      SymI_HasProto(ALLOC_TUP_ctr)                      \
      SymI_HasProto(ALLOC_TUP_adm)                      \
      SymI_HasProto(ALLOC_TUP_gds)                      \
      SymI_HasProto(ALLOC_TUP_slp)                      \
      SymI_HasProto(ALLOC_BH_ctr)                       \
      SymI_HasProto(ALLOC_BH_adm)                       \
      SymI_HasProto(ALLOC_BH_gds)                       \
      SymI_HasProto(ALLOC_BH_slp)                       \
      SymI_HasProto(ALLOC_PRIM_ctr)                     \
      SymI_HasProto(ALLOC_PRIM_adm)                     \
      SymI_HasProto(ALLOC_PRIM_gds)                     \
      SymI_HasProto(ALLOC_PRIM_slp)                     \
      SymI_HasProto(ALLOC_PAP_ctr)                      \
      SymI_HasProto(ALLOC_PAP_adm)                      \
      SymI_HasProto(ALLOC_PAP_gds)                      \
      SymI_HasProto(ALLOC_PAP_slp)                      \
      SymI_HasProto(ALLOC_TSO_ctr)                      \
      SymI_HasProto(ALLOC_TSO_adm)                      \
      SymI_HasProto(ALLOC_TSO_gds)                      \
      SymI_HasProto(ALLOC_TSO_slp)                      \
      SymI_HasProto(RET_NEW_ctr)                        \
      SymI_HasProto(RET_OLD_ctr)                        \
      SymI_HasProto(RET_UNBOXED_TUP_ctr)                \
702
703
704
      SymI_HasProto(RET_SEMI_loads_avoided)


705
// On most platforms, the garbage collector rewrites references
Ian Lynagh's avatar
Ian Lynagh committed
706
//      to small integer and char objects to a set of common, shared ones.
707
708
//
// We don't do this when compiling to Windows DLLs at the moment because
Ian Lynagh's avatar
Ian Lynagh committed
709
//      it doesn't support cross package data references well.
710
711
712
713
//
#if defined(__PIC__) && defined(mingw32_HOST_OS)
#define RTS_INTCHAR_SYMBOLS
#else
Ian Lynagh's avatar
Ian Lynagh committed
714
715
716
#define RTS_INTCHAR_SYMBOLS                             \
      SymI_HasProto(stg_CHARLIKE_closure)               \
      SymI_HasProto(stg_INTLIKE_closure)
717
718
719
#endif


Ian Lynagh's avatar
Ian Lynagh committed
720
721
#define RTS_SYMBOLS                                     \
      Maybe_Stable_Names                                \
722
      RTS_TICKY_SYMBOLS                                 \
Ian Lynagh's avatar
Ian Lynagh committed
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
      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)                  \
752
      MAIN_CAP_SYM                                      \
Ian Lynagh's avatar
Ian Lynagh committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
      SymI_HasProto(MallocFailHook)                     \
      SymI_HasProto(OnExitHook)                         \
      SymI_HasProto(OutOfHeapHook)                      \
      SymI_HasProto(StackOverflowHook)                  \
      SymI_HasProto(addDLL)                             \
      SymI_HasProto(__int_encodeDouble)                 \
      SymI_HasProto(__word_encodeDouble)                \
      SymI_HasProto(__2Int_encodeDouble)                \
      SymI_HasProto(__int_encodeFloat)                  \
      SymI_HasProto(__word_encodeFloat)                 \
      SymI_HasProto(stg_atomicallyzh)                   \
      SymI_HasProto(barf)                               \
      SymI_HasProto(debugBelch)                         \
      SymI_HasProto(errorBelch)                         \
Simon Marlow's avatar
Simon Marlow committed
767
      SymI_HasProto(sysErrorBelch)                      \
Ian Lynagh's avatar
Ian Lynagh committed
768
769
770
771
772
773
      SymI_HasProto(stg_getMaskingStatezh)              \
      SymI_HasProto(stg_maskAsyncExceptionszh)          \
      SymI_HasProto(stg_maskUninterruptiblezh)          \
      SymI_HasProto(stg_catchzh)                        \
      SymI_HasProto(stg_catchRetryzh)                   \
      SymI_HasProto(stg_catchSTMzh)                     \
774
      SymI_HasProto(stg_checkzh)                        \
775
      SymI_HasProto(closure_flags)                      \
Ian Lynagh's avatar
Ian Lynagh committed
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
      SymI_HasProto(cmp_thread)                         \
      SymI_HasProto(createAdjustor)                     \
      SymI_HasProto(stg_decodeDoublezu2Intzh)           \
      SymI_HasProto(stg_decodeFloatzuIntzh)             \
      SymI_HasProto(defaultsHook)                       \
      SymI_HasProto(stg_delayzh)                        \
      SymI_HasProto(stg_deRefWeakzh)                    \
      SymI_HasProto(stg_deRefStablePtrzh)               \
      SymI_HasProto(dirty_MUT_VAR)                      \
      SymI_HasProto(stg_forkzh)                         \
      SymI_HasProto(stg_forkOnzh)                       \
      SymI_HasProto(forkProcess)                        \
      SymI_HasProto(forkOS_createThread)                \
      SymI_HasProto(freeHaskellFunctionPtr)             \
      SymI_HasProto(getOrSetGHCConcSignalSignalHandlerStore)            \
      SymI_HasProto(getOrSetGHCConcWindowsPendingDelaysStore)           \
      SymI_HasProto(getOrSetGHCConcWindowsIOManagerThreadStore)         \
      SymI_HasProto(getOrSetGHCConcWindowsProddingStore)                \
      SymI_HasProto(getOrSetSystemEventThreadEventManagerStore)         \
      SymI_HasProto(getOrSetSystemEventThreadIOManagerThreadStore)      \
796
      SymI_HasProto(getGCStats)                         \
Ian Lynagh's avatar
Ian Lynagh committed
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
      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)                  \
      SymI_HasProto(hs_hpc_module)                      \
      SymI_HasProto(initLinker)                         \
812
813
814
      SymI_HasProto(stg_unpackClosurezh)                \
      SymI_HasProto(stg_getApStackValzh)                \
      SymI_HasProto(stg_getSparkzh)                     \
Simon Marlow's avatar
Simon Marlow committed
815
      SymI_HasProto(stg_numSparkszh)                    \
Ian Lynagh's avatar
Ian Lynagh committed
816
817
818
819
820
821
822
823
824
825
826
      SymI_HasProto(stg_isCurrentThreadBoundzh)         \
      SymI_HasProto(stg_isEmptyMVarzh)                  \
      SymI_HasProto(stg_killThreadzh)                   \
      SymI_HasProto(loadArchive)                        \
      SymI_HasProto(loadObj)                            \
      SymI_HasProto(insertStableSymbol)                 \
      SymI_HasProto(insertSymbol)                       \
      SymI_HasProto(lookupSymbol)                       \
      SymI_HasProto(stg_makeStablePtrzh)                \
      SymI_HasProto(stg_mkApUpd0zh)                     \
      SymI_HasProto(stg_myThreadIdzh)                   \
827
      SymI_HasProto(stg_labelThreadzh)                  \
Ian Lynagh's avatar
Ian Lynagh committed
828
829
830
831
832
833
834
835
836
      SymI_HasProto(stg_newArrayzh)                     \
      SymI_HasProto(stg_newBCOzh)                       \
      SymI_HasProto(stg_newByteArrayzh)                 \
      SymI_HasProto_redirect(newCAF, newDynCAF)         \
      SymI_HasProto(stg_newMVarzh)                      \
      SymI_HasProto(stg_newMutVarzh)                    \
      SymI_HasProto(stg_newTVarzh)                      \
      SymI_HasProto(stg_noDuplicatezh)                  \
      SymI_HasProto(stg_atomicModifyMutVarzh)           \
Simon Marlow's avatar
Simon Marlow committed
837
      SymI_HasProto(stg_casMutVarzh)                    \
Ian Lynagh's avatar
Ian Lynagh committed
838
839
840
841
842
843
844
845
846
847
848
849
850
      SymI_HasProto(stg_newPinnedByteArrayzh)           \
      SymI_HasProto(stg_newAlignedPinnedByteArrayzh)    \
      SymI_HasProto(newSpark)                           \
      SymI_HasProto(performGC)                          \
      SymI_HasProto(performMajorGC)                     \
      SymI_HasProto(prog_argc)                          \
      SymI_HasProto(prog_argv)                          \
      SymI_HasProto(stg_putMVarzh)                      \
      SymI_HasProto(stg_raisezh)                        \
      SymI_HasProto(stg_raiseIOzh)                      \
      SymI_HasProto(stg_readTVarzh)                     \
      SymI_HasProto(stg_readTVarIOzh)                   \
      SymI_HasProto(resumeThread)                       \
851
      SymI_HasProto(resolveObjs)                        \
852
      SymI_HasProto(stg_retryzh)                        \
Ian Lynagh's avatar
Ian Lynagh committed
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
      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)                         \
898
      SymI_HasProto(rts_unsafeGetMyCapability)          \
Ian Lynagh's avatar
Ian Lynagh committed
899
      SymI_HasProto(rtsSupportsBoundThreads)            \
900
      SymI_HasProto(rts_isProfiled)                     \
Ian Lynagh's avatar
Ian Lynagh committed
901
902
903
904
905
906
907
908
909
      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)             \
      SymI_HasProto(stg_BLACKHOLE_info)                 \
      SymI_HasProto(__stg_EAGER_BLACKHOLE_info)         \
910
      SymI_HasProto(stg_BLOCKING_QUEUE_CLEAN_info)      \
Ian Lynagh's avatar
Ian Lynagh committed
911
      SymI_HasProto(stg_BLOCKING_QUEUE_DIRTY_info)      \
912
      SymI_HasProto(startTimer)                         \
Ian Lynagh's avatar
Ian Lynagh committed
913
914
915
      SymI_HasProto(stg_MVAR_CLEAN_info)                \
      SymI_HasProto(stg_MVAR_DIRTY_info)                \
      SymI_HasProto(stg_IND_STATIC_info)                \
916
      SymI_HasProto(stg_ARR_WORDS_info)                 \
Ian Lynagh's avatar
Ian Lynagh committed
917
918
919
      SymI_HasProto(stg_MUT_ARR_PTRS_DIRTY_info)        \
      SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN_info)       \
      SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN0_info)      \
920
      SymI_HasProto(stg_WEAK_info)                      \
Ian Lynagh's avatar
Ian Lynagh committed
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
      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(stg_bh_upd_frame_info)              \
      SymI_HasProto(suspendThread)                      \
      SymI_HasProto(stg_takeMVarzh)                     \
      SymI_HasProto(stg_threadStatuszh)                 \
      SymI_HasProto(stg_tryPutMVarzh)                   \
      SymI_HasProto(stg_tryTakeMVarzh)                  \
      SymI_HasProto(stg_unmaskAsyncExceptionszh)        \
982
      SymI_HasProto(unloadObj)                          \
Ian Lynagh's avatar
Ian Lynagh committed
983
984
985
986
      SymI_HasProto(stg_unsafeThawArrayzh)              \
      SymI_HasProto(stg_waitReadzh)                     \
      SymI_HasProto(stg_waitWritezh)                    \
      SymI_HasProto(stg_writeTVarzh)                    \
987
      SymI_HasProto(stg_yieldzh)                        \
988
      SymI_NeedsProto(stg_interp_constr_entry)          \
989
      SymI_HasProto(stg_arg_bitmaps)                    \
990
      SymI_HasProto(large_alloc_lim)                    \
Simon Marlow's avatar
Simon Marlow committed
991
      SymI_HasProto(g0)                                 \
992
      SymI_HasProto(allocate)                           \
Ian Lynagh's avatar
Ian Lynagh committed
993
994
      SymI_HasProto(allocateExec)                       \
      SymI_HasProto(freeExec)                           \
995
996
997
      SymI_HasProto(getAllocations)                     \
      SymI_HasProto(revertCAFs)                         \
      SymI_HasProto(RtsFlags)                           \
Ian Lynagh's avatar
Ian Lynagh committed
998
999
1000
1001
1002
      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)                     \
1003
      SymI_HasProto(stg_traceCcszh)                     \
1004
      SymI_HasProto(stg_traceEventzh)                   \
Ian Lynagh's avatar
Ian Lynagh committed
1005
      RTS_USER_SIGNALS_SYMBOLS                          \
1006
      RTS_INTCHAR_SYMBOLS
1007

1008

1009
1010
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
Ian Lynagh's avatar
Ian Lynagh committed
1011
#define RTS_LIBGCC_SYMBOLS                             \
1012
1013
1014
      SymI_NeedsProto(__divdi3)                        \
      SymI_NeedsProto(__udivdi3)                       \
      SymI_NeedsProto(__moddi3)                        \
Ian Lynagh's avatar
Ian Lynagh committed
1015
1016
1017
1018
      SymI_NeedsProto(__umoddi3)                       \
      SymI_NeedsProto(__muldi3)                        \
      SymI_NeedsProto(__ashldi3)                       \
      SymI_NeedsProto(__ashrdi3)                       \
1019
      SymI_NeedsProto(__lshrdi3)
1020
1021
1022
1023
#else
#define RTS_LIBGCC_SYMBOLS
#endif

1024
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
1025
1026
1027
      // Symbols that don't have a leading underscore
      // on Mac OS X. They have to receive special treatment,
      // see machoInitSymbolsWithoutUnderscore()
Ian Lynagh's avatar
Ian Lynagh committed
1028
1029
#define RTS_MACHO_NOUNDERLINE_SYMBOLS                   \
      SymI_NeedsProto(saveFP)                           \
1030
      SymI_NeedsProto(restFP)
1031
#endif
1032
1033

/* entirely bogus claims about types of these symbols */
1034
#define SymI_NeedsProto(vvv)  extern void vvv(void);
1035
#if defined(__PIC__) && defined(mingw32_HOST_OS)
1036
1037
#define SymE_HasProto(vvv)    SymE_HasProto(vvv);
#define SymE_NeedsProto(vvv)    extern void _imp__ ## vvv (void);
1038
#else
1039
1040
#define SymE_NeedsProto(vvv)  SymI_NeedsProto(vvv);
#define SymE_HasProto(vvv)    SymI_HasProto(vvv)
1041
#endif
1042
1043
#define SymI_HasProto(vvv) /**/
#define SymI_HasProto_redirect(vvv,xxx) /**/
1044
RTS_SYMBOLS
1045
RTS_RET_SYMBOLS
1046
RTS_POSIX_ONLY_SYMBOLS
1047
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
1048
RTS_CYGWIN_ONLY_SYMBOLS
1049
RTS_DARWIN_ONLY_SYMBOLS
1050
RTS_LIBGCC_SYMBOLS
1051
RTS_LIBFFI_SYMBOLS
1052
1053
1054
1055
1056
#undef SymI_NeedsProto
#undef SymI_HasProto
#undef SymI_HasProto_redirect
#undef SymE_HasProto
#undef SymE_NeedsProto
1057
1058
1059
1060
1061
1062
1063

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

1064
#define SymI_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1065
                    (void*)(&(vvv)) },
1066
#define SymE_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
Ian Lynagh's avatar
Ian Lynagh committed
1067
            (void*)DLL_IMPORT_DATA_REF(vvv) },
1068

1069
1070
1071
1072
#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
1073
// another symbol.  See newCAF/newDynCAF for an example.
Ian Lynagh's avatar
Ian Lynagh committed
1074
#define SymI_HasProto_redirect(vvv,xxx)   \
1075
1076
1077
    { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
      (void*)(&(xxx)) },

1078
static RtsSymbolVal rtsSyms[] = {
1079
      RTS_SYMBOLS
1080
      RTS_RET_SYMBOLS
1081
      RTS_POSIX_ONLY_SYMBOLS
1082
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
1083
      RTS_CYGWIN_ONLY_SYMBOLS
1084
      RTS_DARWIN_ONLY_SYMBOLS
1085
      RTS_LIBGCC_SYMBOLS
1086
      RTS_LIBFFI_SYMBOLS
1087
1088
1089
1090
#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.
1091
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
1092
#endif
1093
1094
1095
      { 0, 0 } /* sentinel */
};

1096
1097


1098
1099
1100
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
1101

1102
1103
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
1104
                                     char* key,
1105
                                     void *data
Ian Lynagh's avatar
Ian Lynagh committed
1106
                                   )
1107
{
Simon Marlow's avatar
Simon Marlow committed
1108
1109
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
1110
1111
      insertStrHashTable(table, (StgWord)key, data);
      return;
Simon Marlow's avatar
Simon Marlow committed
1112
1113
   }
   debugBelch(
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
      "\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
Simon Marlow's avatar
Simon Marlow committed
1128
   );
1129
   stg_exit(1);
1130
}
1131
1132
1133
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
1134
1135
1136
1137


static int linker_init_done = 0 ;

1138
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1139
static void *dl_prog_handle;
1140
1141
1142
1143
1144
static regex_t re_invalid;
static regex_t re_realso;
#ifdef THREADED_RTS
static Mutex dl_mutex; // mutex to protect dlopen/dlerror critical section
#endif
1145
#endif
1146
1147
1148
1149

void
initLinker( void )
{
1150
    RtsSymbolVal *sym;
Simon Marlow's avatar
Simon Marlow committed
1151
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1152
    int compileResult;
Simon Marlow's avatar
Simon Marlow committed
1153
#endif
1154

1155
1156
    IF_DEBUG(linker, debugBelch("initLinker: start\n"));

1157
1158
1159
    /* Make initLinker idempotent, so we can call it
       before evey relevant operation; that means we
       don't need to initialise the linker separately */
Ian Lynagh's avatar
Ian Lynagh committed
1160
1161
1162
    if (linker_init_done == 1) {
        IF_DEBUG(linker, debugBelch("initLinker: idempotent return\n"));
        return;
1163
1164
    } else {
        linker_init_done = 1;
1165
1166
    }

Simon Marlow's avatar
Simon Marlow committed
1167
#if defined(THREADED_RTS) && (defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO))
1168
1169
    initMutex(&dl_mutex);
#endif
1170
    stablehash = allocStrHashTable();
1171
1172
1173
1174
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
Ian Lynagh's avatar
Ian Lynagh committed
1175
        ghciInsertStrHashTable("(GHCi built-in symbols)",
1176
                               symhash, sym->lbl, sym->addr);
Ian Lynagh's avatar
Ian Lynagh committed
1177
        IF_DEBUG(linker, debugBelch("initLinker: inserting rts symbol %s, %p\n", sym->lbl, sym->addr));
1178
    }
1179
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
1180
1181
1182
    machoInitSymbolsWithoutUnderscore();
#   endif

1183
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1184
#   if defined(RTLD_DEFAULT)
1185
1186
    dl_prog_handle = RTLD_DEFAULT;
#   else
1187
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
1188
#   endif /* RTLD_DEFAULT */
1189
1190

    compileResult = regcomp(&re_invalid,
1191
           "(([^ \t()])+\\.so([^ \t:()])*):([ \t])*(invalid ELF header|file too short)",
1192
           REG_EXTENDED);
Ian Lynagh's avatar
Ian Lynagh committed
1193
1194
1195
    if (compileResult != 0) {
        barf("Compiling re_invalid failed");
    }
1196
    compileResult = regcomp(&re_realso,
1197
           "(GROUP|INPUT) *\\( *(([^ )])+)",
1198
           REG_EXTENDED);
Ian Lynagh's avatar
Ian Lynagh committed
1199
1200
1201
    if (compileResult != 0) {
        barf("Compiling re_realso failed");
    }
1202
#   endif
1203

1204
#if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
1205
1206
1207
1208
1209
    if (RtsFlags.MiscFlags.linkerMemBase != 0) {
        // User-override for mmap_32bit_base
        mmap_32bit_base = (void*)RtsFlags.MiscFlags.linkerMemBase;
    }
#endif
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219

#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
1220
1221
1222

    IF_DEBUG(linker, debugBelch("initLinker: done\n"));
    return;
1223
1224
}

1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
void
exitLinker( void ) {
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
   if (linker_init_done == 1) {
      regfree(&re_invalid);
      regfree(&re_realso);
#ifdef THREADED_RTS
      closeMutex(&dl_mutex);
#endif
   }
#endif
}

1238
/* -----------------------------------------------------------------------------
1239
1240
1241
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
1242
1243
1244
1245
 * 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
1246
1247
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
1248
 * In the PEi386 case, open the DLLs and put handles to them in a
1249
 * linked list.  When looking for a symbol, try all handles in the
1250
1251
1252
1253
1254
 * 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.
1255
 *
1256
 */
1257
1258
1259
1260
1261
1262

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

typedef
   struct _OpenedDLL {
1263
      char*              name;
1264
1265
      struct _OpenedDLL* next;
      HINSTANCE instance;
1266
   }
1267
1268
1269
1270
1271
1272
   OpenedDLL;

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

1273
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1274

1275
static const char *
1276
1277
1278
internal_dlopen(const char *dll_name)
{
   void *hdl;
1279
1280
   const char *errmsg;
   char *errmsg_copy;
1281

1282
1283
   // omitted: RTLD_NOW
   // see http://www.haskell.org/pipermail/cvs-ghc/2007-September/038570.html
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
   IF_DEBUG(linker,
      debugBelch("internal_dlopen: dll_name = '%s'\n", dll_name));

   //-------------- Begin critical section ------------------
   // This critical section is necessary because dlerror() is not
   // required to be reentrant (see POSIX -- IEEE Std 1003.1-2008)
   // Also, the error message returned must be copied to preserve it
   // (see POSIX also)

   ACQUIRE_LOCK(&dl_mutex);
   hdl = dlopen(dll_name, RTLD_LAZY | RTLD_GLOBAL);
dons's avatar
dons committed
1295

1296
   errmsg = NULL;
1297
1298
1299
1300
   if (hdl == NULL) {
      /* dlopen failed; return a ptr to the error msg. */
      errmsg = dlerror();
      if (errmsg == NULL) errmsg = "addDLL: unknown error";
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
      errmsg_copy = stgMallocBytes(strlen(errmsg)+1, "addDLL");
      strcpy(errmsg_copy, errmsg);
      errmsg = errmsg_copy;
   }
   RELEASE_LOCK(&dl_mutex);
   //--------------- End critical section -------------------

   return errmsg;
}
#  endif

const char *
addDLL( char *dll_name )
{
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
   /* ------------------- ELF DLL loader ------------------- */

#define NMATCH 5
   regmatch_t match[NMATCH];
1320
   const char *errmsg;
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
   FILE* fp;
   size_t match_length;
#define MAXLINE 1000
   char line[MAXLINE];
   int result;

   initLinker();

   IF_DEBUG(linker, debugBelch("addDLL: dll_name = '%s'\n", dll_name));
   errmsg = internal_dlopen(dll_name);

   if (errmsg == NULL) {
1333
1334
      return NULL;
   }
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356

   // GHC Trac ticket #2615
   // On some systems (e.g., Gentoo Linux) dynamic files (e.g. libc.so)
   // contain linker scripts rather than ELF-format object code. This
   // code handles the situation by recognizing the real object code
   // file name given in the linker script.
   //
   // If an "invalid ELF header" error occurs, it is assumed that the
   // .so file contains a linker script instead of ELF object code.
   // In this case, the code looks for the GROUP ( ... ) linker
   // directive. If one is found, the first file name inside the
   // parentheses is treated as the name of a dynamic library and the
   // code attempts to dlopen that file. If this is also unsuccessful,
   // an error message is returned.

   // see if the error message is due to an invalid ELF header
   IF_DEBUG(linker, debugBelch("errmsg = '%s'\n", errmsg));
   result = regexec(&re_invalid, errmsg, (size_t) NMATCH, match, 0);
   IF_DEBUG(linker, debugBelch("result = %i\n", result));
   if (result == 0) {
      // success -- try to read the named file as a linker script
      match_length = (size_t) stg_min((match[1].rm_eo - match[1].rm_so),
Ian Lynagh's avatar
Ian Lynagh committed
1357
                                 MAXLINE-1);
1358
1359
1360
1361
      strncpy(line, (errmsg+(match[1].rm_so)),match_length);
      line[match_length] = '\0'; // make sure string is null-terminated
      IF_DEBUG(linker, debugBelch ("file name = '%s'\n", line));
      if ((fp = fopen(line, "r")) == NULL) {
Ian Lynagh's avatar
Ian Lynagh committed
1362
         return errmsg; // return original error if open fails
1363
1364
1365
      }
      // try to find a GROUP ( ... ) command
      while (fgets(line, MAXLINE, fp) != NULL) {
Ian Lynagh's avatar
Ian Lynagh committed
1366
1367
         IF_DEBUG(linker, debugBelch("input line = %s", line));
         if (regexec(&re_realso, line, (size_t) NMATCH, match, 0) == 0) {
1368
1369
            // success -- try to dlopen the first named file
            IF_DEBUG(linker, debugBelch("match%s\n",""));
1370
1371
            line[match[2].rm_eo] = '\0';
            errmsg = internal_dlopen(line+match[2].rm_so);
Ian Lynagh's avatar
Ian Lynagh committed
1372
1373
1374
1375
            break;
         }
         // if control reaches here, no GROUP ( ... ) directive was found
         // and the original error message is returned to the caller
1376
1377
1378
1379
      }
      fclose(fp);
   }
   return errmsg;
1380

1381
#  elif defined(OBJFORMAT_PEi386)
1382
   /* ------------------- Win32 DLL loader ------------------- */
1383

1384
   char*      buf;
1385
   OpenedDLL* o_dll;
1386
   HINSTANCE  instance;
1387

1388
1389
   initLinker();

1390
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1391
1392
1393
1394
1395

   /* 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;
1396
1397
   }

1398
1399
1400
1401
   /* The file name has no suffix (yet) so that we can try
      both foo.dll and foo.drv

      The documentation for LoadLibrary says:
Ian Lynagh's avatar
Ian Lynagh committed
1402
1403
1404
1405
1406
        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. */
1407

1408
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1409
1410
1411
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
       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;
           }
       }
1425
   }
sof's avatar
sof committed
1426
   stgFree(buf);
1427

simonpj's avatar