Revert "Make the linker API thread-safe"
[ghc.git] / rts / Linker.c
1 /* -----------------------------------------------------------------------------
2 *
3 * (c) The GHC Team, 2000-2012
4 *
5 * RTS Object Linker
6 *
7 * ---------------------------------------------------------------------------*/
8
9 #if 0
10 #include "PosixSource.h"
11 #endif
12
13 /* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14 MREMAP_MAYMOVE from <sys/mman.h>.
15 */
16 #if defined(__linux__) || defined(__GLIBC__)
17 #define _GNU_SOURCE 1
18 #endif
19
20 #include "Rts.h"
21 #include "HsFFI.h"
22
23 #include "sm/Storage.h"
24 #include "Stats.h"
25 #include "Hash.h"
26 #include "LinkerInternals.h"
27 #include "RtsUtils.h"
28 #include "Trace.h"
29 #include "StgPrimFloat.h" // for __int_encodeFloat etc.
30 #include "Proftimer.h"
31 #include "GetEnv.h"
32 #include "Stable.h"
33
34 #if !defined(mingw32_HOST_OS)
35 #include "posix/Signals.h"
36 #endif
37
38 // get protos for is*()
39 #include <ctype.h>
40
41 #ifdef HAVE_SYS_TYPES_H
42 #include <sys/types.h>
43 #endif
44
45 #include <inttypes.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <stdio.h>
49 #include <assert.h>
50 #include <libgen.h>
51
52 #ifdef HAVE_SYS_STAT_H
53 #include <sys/stat.h>
54 #endif
55
56 #if defined(HAVE_DLFCN_H)
57 #include <dlfcn.h>
58 #endif
59
60 #if defined(cygwin32_HOST_OS)
61 #ifdef HAVE_DIRENT_H
62 #include <dirent.h>
63 #endif
64
65 #ifdef HAVE_SYS_TIME_H
66 #include <sys/time.h>
67 #endif
68 #include <regex.h>
69 #include <sys/fcntl.h>
70 #include <sys/termios.h>
71 #include <sys/utime.h>
72 #include <sys/utsname.h>
73 #include <sys/wait.h>
74 #endif
75
76 #if (defined(powerpc_HOST_ARCH) && defined(linux_HOST_OS)) \
77 || (!defined(powerpc_HOST_ARCH) && \
78 ( defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || \
79 defined(dragonfly_HOST_OS) || defined(netbsd_HOST_OS ) || \
80 defined(openbsd_HOST_OS ) || defined(darwin_HOST_OS ) || \
81 defined(kfreebsdgnu_HOST_OS) || defined(gnu_HOST_OS)))
82 /* Don't use mmap on powerpc_HOST_ARCH as mmap doesn't support
83 * reallocating but we need to allocate jump islands just after each
84 * object images. Otherwise relative branches to jump islands can fail
85 * due to 24-bits displacement overflow.
86 */
87 #define USE_MMAP
88 #include <fcntl.h>
89 #include <sys/mman.h>
90
91 #ifdef HAVE_UNISTD_H
92 #include <unistd.h>
93 #endif
94
95 #endif
96
97
98 /* PowerPC has relative branch instructions with only 24 bit displacements
99 * and therefore needs jump islands contiguous with each object code module.
100 */
101 #if (defined(USE_MMAP) && defined(powerpc_HOST_ARCH) && defined(linux_HOST_OS))
102 #define USE_CONTIGUOUS_MMAP 1
103 #else
104 #define USE_CONTIGUOUS_MMAP 0
105 #endif
106
107 #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) || defined(gnu_HOST_OS)
108 # define OBJFORMAT_ELF
109 # include <regex.h> // regex is already used by dlopen() so this is OK
110 // to use here without requiring an additional lib
111 #elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
112 # define OBJFORMAT_PEi386
113 # include <windows.h>
114 # include <math.h>
115 #elif defined(darwin_HOST_OS)
116 # define OBJFORMAT_MACHO
117 # include <regex.h>
118 # include <mach/machine.h>
119 # include <mach-o/fat.h>
120 # include <mach-o/loader.h>
121 # include <mach-o/nlist.h>
122 # include <mach-o/reloc.h>
123 #if !defined(HAVE_DLFCN_H)
124 # include <mach-o/dyld.h>
125 #endif
126 #if defined(powerpc_HOST_ARCH)
127 # include <mach-o/ppc/reloc.h>
128 #endif
129 #if defined(x86_64_HOST_ARCH)
130 # include <mach-o/x86_64/reloc.h>
131 #endif
132 #endif
133
134 #if defined(x86_64_HOST_ARCH) && defined(darwin_HOST_OS)
135 #define ALWAYS_PIC
136 #endif
137
138 #if defined(dragonfly_HOST_OS)
139 #include <sys/tls.h>
140 #endif
141
142 typedef struct _RtsSymbolInfo {
143 void *value;
144 const ObjectCode *owner;
145 HsBool weak;
146 } RtsSymbolInfo;
147
148 /* Hash table mapping symbol names to RtsSymbolInfo */
149 static /*Str*/HashTable *symhash;
150
151 /* List of currently loaded objects */
152 ObjectCode *objects = NULL; /* initially empty */
153
154 /* List of objects that have been unloaded via unloadObj(), but are waiting
155 to be actually freed via checkUnload() */
156 ObjectCode *unloaded_objects = NULL; /* initially empty */
157
158 /* Type of the initializer */
159 typedef void (*init_t) (int argc, char **argv, char **env);
160
161 static HsInt isAlreadyLoaded( pathchar *path );
162 static HsInt loadOc( ObjectCode* oc );
163 static ObjectCode* mkOc( pathchar *path, char *image, int imageSize,
164 char *archiveMemberName
165 #ifndef USE_MMAP
166 #ifdef darwin_HOST_OS
167 , int misalignment
168 #endif
169 #endif
170 );
171
172 // Use wchar_t for pathnames on Windows (#5697)
173 #if defined(mingw32_HOST_OS)
174 #define pathcmp wcscmp
175 #define pathlen wcslen
176 #define pathopen _wfopen
177 #define pathstat _wstat
178 #define struct_stat struct _stat
179 #define open wopen
180 #define WSTR(s) L##s
181 #else
182 #define pathcmp strcmp
183 #define pathlen strlen
184 #define pathopen fopen
185 #define pathstat stat
186 #define struct_stat struct stat
187 #define WSTR(s) s
188 #endif
189
190 static pathchar* pathdup(pathchar *path)
191 {
192 pathchar *ret;
193 #if defined(mingw32_HOST_OS)
194 ret = wcsdup(path);
195 #else
196 /* sigh, strdup() isn't a POSIX function, so do it the long way */
197 ret = stgMallocBytes( strlen(path)+1, "loadObj" );
198 strcpy(ret, path);
199 #endif
200 return ret;
201 }
202
203
204 #if defined(OBJFORMAT_ELF)
205 static int ocVerifyImage_ELF ( ObjectCode* oc );
206 static int ocGetNames_ELF ( ObjectCode* oc );
207 static int ocResolve_ELF ( ObjectCode* oc );
208 static int ocRunInit_ELF ( ObjectCode* oc );
209 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
210 static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
211 #endif
212 #elif defined(OBJFORMAT_PEi386)
213 static int ocVerifyImage_PEi386 ( ObjectCode* oc );
214 static int ocGetNames_PEi386 ( ObjectCode* oc );
215 static int ocResolve_PEi386 ( ObjectCode* oc );
216 static int ocRunInit_PEi386 ( ObjectCode* oc );
217 static void *lookupSymbolInDLLs ( unsigned char *lbl );
218 static void zapTrailingAtSign ( unsigned char *sym );
219 static char *allocateImageAndTrampolines (
220 pathchar* arch_name, char* member_name,
221 #if defined(x86_64_HOST_ARCH)
222 FILE* f,
223 #endif
224 int size );
225 #if defined(x86_64_HOST_ARCH)
226 static int ocAllocateSymbolExtras_PEi386 ( ObjectCode* oc );
227 static size_t makeSymbolExtra_PEi386( ObjectCode* oc, size_t, char* symbol );
228 #define PEi386_IMAGE_OFFSET 4
229 #else
230 #define PEi386_IMAGE_OFFSET 0
231 #endif
232 #elif defined(OBJFORMAT_MACHO)
233 static int ocVerifyImage_MachO ( ObjectCode* oc );
234 static int ocGetNames_MachO ( ObjectCode* oc );
235 static int ocResolve_MachO ( ObjectCode* oc );
236 static int ocRunInit_MachO ( ObjectCode* oc );
237
238 #ifndef USE_MMAP
239 static int machoGetMisalignment( FILE * );
240 #endif
241 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
242 static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
243 #endif
244 #ifdef powerpc_HOST_ARCH
245 static void machoInitSymbolsWithoutUnderscore( void );
246 #endif
247 #endif
248
249 static void freeProddableBlocks (ObjectCode *oc);
250
251 /* on x86_64 we have a problem with relocating symbol references in
252 * code that was compiled without -fPIC. By default, the small memory
253 * model is used, which assumes that symbol references can fit in a
254 * 32-bit slot. The system dynamic linker makes this work for
255 * references to shared libraries by either (a) allocating a jump
256 * table slot for code references, or (b) moving the symbol at load
257 * time (and copying its contents, if necessary) for data references.
258 *
259 * We unfortunately can't tell whether symbol references are to code
260 * or data. So for now we assume they are code (the vast majority
261 * are), and allocate jump-table slots. Unfortunately this will
262 * SILENTLY generate crashing code for data references. This hack is
263 * enabled by X86_64_ELF_NONPIC_HACK.
264 *
265 * One workaround is to use shared Haskell libraries. This is
266 * coming. Another workaround is to keep the static libraries but
267 * compile them with -fPIC, because that will generate PIC references
268 * to data which can be relocated. The PIC code is still too green to
269 * do this systematically, though.
270 *
271 * See bug #781
272 * See thread http://www.haskell.org/pipermail/cvs-ghc/2007-September/038458.html
273 *
274 * Naming Scheme for Symbol Macros
275 *
276 * SymI_*: symbol is internal to the RTS. It resides in an object
277 * file/library that is statically.
278 * SymE_*: symbol is external to the RTS library. It might be linked
279 * dynamically.
280 *
281 * Sym*_HasProto : the symbol prototype is imported in an include file
282 * or defined explicitly
283 * Sym*_NeedsProto: the symbol is undefined and we add a dummy
284 * default proto extern void sym(void);
285 */
286 #define X86_64_ELF_NONPIC_HACK 1
287
288 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
289 * small memory model on this architecture (see gcc docs,
290 * -mcmodel=small).
291 *
292 * MAP_32BIT not available on OpenBSD/amd64
293 */
294 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
295 #define TRY_MAP_32BIT MAP_32BIT
296 #else
297 #define TRY_MAP_32BIT 0
298 #endif
299
300 /*
301 * Due to the small memory model (see above), on x86_64 we have to map
302 * all our non-PIC object files into the low 2Gb of the address space
303 * (why 2Gb and not 4Gb? Because all addresses must be reachable
304 * using a 32-bit signed PC-relative offset). On Linux we can do this
305 * using the MAP_32BIT flag to mmap(), however on other OSs
306 * (e.g. *BSD, see #2063, and also on Linux inside Xen, see #2512), we
307 * can't do this. So on these systems, we have to pick a base address
308 * in the low 2Gb of the address space and try to allocate memory from
309 * there.
310 *
311 * We pick a default address based on the OS, but also make this
312 * configurable via an RTS flag (+RTS -xm)
313 */
314 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
315
316 #if defined(MAP_32BIT)
317 // Try to use MAP_32BIT
318 #define MMAP_32BIT_BASE_DEFAULT 0
319 #else
320 // A guess: 1Gb.
321 #define MMAP_32BIT_BASE_DEFAULT 0x40000000
322 #endif
323
324 static void *mmap_32bit_base = (void *)MMAP_32BIT_BASE_DEFAULT;
325 #endif
326
327 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
328 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
329 #define MAP_ANONYMOUS MAP_ANON
330 #endif
331
332 /* -----------------------------------------------------------------------------
333 * Built-in symbols from the RTS
334 */
335
336 typedef struct _RtsSymbolVal {
337 char *lbl;
338 void *addr;
339 } RtsSymbolVal;
340
341 #define Maybe_Stable_Names SymI_HasProto(stg_mkWeakzh) \
342 SymI_HasProto(stg_mkWeakNoFinalizzerzh) \
343 SymI_HasProto(stg_addCFinalizzerToWeakzh) \
344 SymI_HasProto(stg_makeStableNamezh) \
345 SymI_HasProto(stg_finalizzeWeakzh)
346
347 #if !defined (mingw32_HOST_OS)
348 #define RTS_POSIX_ONLY_SYMBOLS \
349 SymI_HasProto(__hscore_get_saved_termios) \
350 SymI_HasProto(__hscore_set_saved_termios) \
351 SymI_HasProto(shutdownHaskellAndSignal) \
352 SymI_HasProto(signal_handlers) \
353 SymI_HasProto(stg_sig_install) \
354 SymI_HasProto(rtsTimerSignal) \
355 SymI_HasProto(atexit) \
356 SymI_NeedsProto(nocldstop)
357 #endif
358
359 #if defined (cygwin32_HOST_OS)
360 #define RTS_MINGW_ONLY_SYMBOLS /**/
361 /* Don't have the ability to read import libs / archives, so
362 * we have to stupidly list a lot of what libcygwin.a
363 * exports; sigh.
364 */
365 #define RTS_CYGWIN_ONLY_SYMBOLS \
366 SymI_HasProto(regfree) \
367 SymI_HasProto(regexec) \
368 SymI_HasProto(regerror) \
369 SymI_HasProto(regcomp) \
370 SymI_HasProto(__errno) \
371 SymI_HasProto(access) \
372 SymI_HasProto(chmod) \
373 SymI_HasProto(chdir) \
374 SymI_HasProto(close) \
375 SymI_HasProto(creat) \
376 SymI_HasProto(dup) \
377 SymI_HasProto(dup2) \
378 SymI_HasProto(fstat) \
379 SymI_HasProto(fcntl) \
380 SymI_HasProto(getcwd) \
381 SymI_HasProto(getenv) \
382 SymI_HasProto(lseek) \
383 SymI_HasProto(open) \
384 SymI_HasProto(fpathconf) \
385 SymI_HasProto(pathconf) \
386 SymI_HasProto(stat) \
387 SymI_HasProto(pow) \
388 SymI_HasProto(tanh) \
389 SymI_HasProto(cosh) \
390 SymI_HasProto(sinh) \
391 SymI_HasProto(atan) \
392 SymI_HasProto(acos) \
393 SymI_HasProto(asin) \
394 SymI_HasProto(tan) \
395 SymI_HasProto(cos) \
396 SymI_HasProto(sin) \
397 SymI_HasProto(exp) \
398 SymI_HasProto(log) \
399 SymI_HasProto(sqrt) \
400 SymI_HasProto(localtime_r) \
401 SymI_HasProto(gmtime_r) \
402 SymI_HasProto(mktime) \
403 SymI_NeedsProto(_imp___tzname) \
404 SymI_HasProto(gettimeofday) \
405 SymI_HasProto(timezone) \
406 SymI_HasProto(tcgetattr) \
407 SymI_HasProto(tcsetattr) \
408 SymI_HasProto(memcpy) \
409 SymI_HasProto(memmove) \
410 SymI_HasProto(realloc) \
411 SymI_HasProto(malloc) \
412 SymI_HasProto(free) \
413 SymI_HasProto(fork) \
414 SymI_HasProto(lstat) \
415 SymI_HasProto(isatty) \
416 SymI_HasProto(mkdir) \
417 SymI_HasProto(opendir) \
418 SymI_HasProto(readdir) \
419 SymI_HasProto(rewinddir) \
420 SymI_HasProto(closedir) \
421 SymI_HasProto(link) \
422 SymI_HasProto(mkfifo) \
423 SymI_HasProto(pipe) \
424 SymI_HasProto(read) \
425 SymI_HasProto(rename) \
426 SymI_HasProto(rmdir) \
427 SymI_HasProto(select) \
428 SymI_HasProto(system) \
429 SymI_HasProto(write) \
430 SymI_HasProto(strcmp) \
431 SymI_HasProto(strcpy) \
432 SymI_HasProto(strncpy) \
433 SymI_HasProto(strerror) \
434 SymI_HasProto(sigaddset) \
435 SymI_HasProto(sigemptyset) \
436 SymI_HasProto(sigprocmask) \
437 SymI_HasProto(umask) \
438 SymI_HasProto(uname) \
439 SymI_HasProto(unlink) \
440 SymI_HasProto(utime) \
441 SymI_HasProto(waitpid)
442
443 #elif defined(mingw32_HOST_OS)
444 #define RTS_POSIX_ONLY_SYMBOLS /**/
445 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
446
447 #if HAVE_GETTIMEOFDAY
448 #define RTS_MINGW_GETTIMEOFDAY_SYM SymI_NeedsProto(gettimeofday)
449 #else
450 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
451 #endif
452
453 #if HAVE___MINGW_VFPRINTF
454 #define RTS___MINGW_VFPRINTF_SYM SymI_HasProto(__mingw_vfprintf)
455 #else
456 #define RTS___MINGW_VFPRINTF_SYM /**/
457 #endif
458
459 #if defined(i386_HOST_ARCH)
460 #define RTS_WIN32_ONLY(X) X
461 #else
462 #define RTS_WIN32_ONLY(X) /**/
463 #endif
464
465 #if defined(x86_64_HOST_ARCH)
466 #define RTS_WIN64_ONLY(X) X
467 #else
468 #define RTS_WIN64_ONLY(X) /**/
469 #endif
470
471 /* These are statically linked from the mingw libraries into the ghc
472 executable, so we have to employ this hack. */
473 #define RTS_MINGW_ONLY_SYMBOLS \
474 SymI_HasProto(stg_asyncReadzh) \
475 SymI_HasProto(stg_asyncWritezh) \
476 SymI_HasProto(stg_asyncDoProczh) \
477 SymI_HasProto(getWin32ProgArgv) \
478 SymI_HasProto(setWin32ProgArgv) \
479 SymI_HasProto(memset) \
480 SymI_HasProto(inet_ntoa) \
481 SymI_HasProto(inet_addr) \
482 SymI_HasProto(htonl) \
483 SymI_HasProto(recvfrom) \
484 SymI_HasProto(listen) \
485 SymI_HasProto(bind) \
486 SymI_HasProto(shutdown) \
487 SymI_HasProto(connect) \
488 SymI_HasProto(htons) \
489 SymI_HasProto(ntohs) \
490 SymI_HasProto(getservbyname) \
491 SymI_HasProto(getservbyport) \
492 SymI_HasProto(getprotobynumber) \
493 SymI_HasProto(getprotobyname) \
494 SymI_HasProto(gethostbyname) \
495 SymI_HasProto(gethostbyaddr) \
496 SymI_HasProto(gethostname) \
497 SymI_HasProto(strcpy) \
498 SymI_HasProto(strncpy) \
499 SymI_HasProto(abort) \
500 RTS_WIN32_ONLY(SymI_NeedsProto(_alloca)) \
501 SymI_HasProto(isxdigit) \
502 SymI_HasProto(isupper) \
503 SymI_HasProto(ispunct) \
504 SymI_HasProto(islower) \
505 SymI_HasProto(isspace) \
506 SymI_HasProto(isprint) \
507 SymI_HasProto(isdigit) \
508 SymI_HasProto(iscntrl) \
509 SymI_HasProto(isalpha) \
510 SymI_HasProto(isalnum) \
511 SymI_HasProto(isascii) \
512 RTS___MINGW_VFPRINTF_SYM \
513 SymI_HasProto(strcmp) \
514 SymI_HasProto(memmove) \
515 SymI_HasProto(realloc) \
516 SymI_HasProto(malloc) \
517 SymI_HasProto(pow) \
518 SymI_HasProto(tanh) \
519 SymI_HasProto(cosh) \
520 SymI_HasProto(sinh) \
521 SymI_HasProto(atan) \
522 SymI_HasProto(acos) \
523 SymI_HasProto(asin) \
524 SymI_HasProto(tan) \
525 SymI_HasProto(cos) \
526 SymI_HasProto(sin) \
527 SymI_HasProto(exp) \
528 SymI_HasProto(log) \
529 SymI_HasProto(sqrt) \
530 SymI_HasProto(powf) \
531 SymI_HasProto(tanhf) \
532 SymI_HasProto(coshf) \
533 SymI_HasProto(sinhf) \
534 SymI_HasProto(atanf) \
535 SymI_HasProto(acosf) \
536 SymI_HasProto(asinf) \
537 SymI_HasProto(tanf) \
538 SymI_HasProto(cosf) \
539 SymI_HasProto(sinf) \
540 SymI_HasProto(expf) \
541 SymI_HasProto(logf) \
542 SymI_HasProto(sqrtf) \
543 SymI_HasProto(erf) \
544 SymI_HasProto(erfc) \
545 SymI_HasProto(erff) \
546 SymI_HasProto(erfcf) \
547 SymI_HasProto(memcpy) \
548 SymI_HasProto(rts_InstallConsoleEvent) \
549 SymI_HasProto(rts_ConsoleHandlerDone) \
550 SymI_NeedsProto(mktime) \
551 RTS_WIN32_ONLY(SymI_NeedsProto(_imp___timezone)) \
552 RTS_WIN32_ONLY(SymI_NeedsProto(_imp___tzname)) \
553 RTS_WIN32_ONLY(SymI_NeedsProto(_imp__tzname)) \
554 RTS_WIN32_ONLY(SymI_NeedsProto(_imp___iob)) \
555 RTS_WIN32_ONLY(SymI_NeedsProto(_imp___osver)) \
556 SymI_NeedsProto(localtime) \
557 SymI_NeedsProto(gmtime) \
558 SymI_NeedsProto(opendir) \
559 SymI_NeedsProto(readdir) \
560 SymI_NeedsProto(rewinddir) \
561 RTS_WIN32_ONLY(SymI_NeedsProto(_imp____mb_cur_max)) \
562 RTS_WIN32_ONLY(SymI_NeedsProto(_imp___pctype)) \
563 RTS_WIN32_ONLY(SymI_NeedsProto(__chkstk)) \
564 RTS_WIN64_ONLY(SymI_NeedsProto(__imp___iob_func)) \
565 RTS_WIN64_ONLY(SymI_NeedsProto(___chkstk_ms)) \
566 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_localeconv)) \
567 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_islower)) \
568 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_isspace)) \
569 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_isxdigit)) \
570 RTS_WIN64_ONLY(SymI_HasProto(close)) \
571 RTS_WIN64_ONLY(SymI_HasProto(read)) \
572 RTS_WIN64_ONLY(SymI_HasProto(dup)) \
573 RTS_WIN64_ONLY(SymI_HasProto(dup2)) \
574 RTS_WIN64_ONLY(SymI_HasProto(write)) \
575 SymI_NeedsProto(getpid) \
576 RTS_WIN64_ONLY(SymI_HasProto(access)) \
577 SymI_HasProto(chmod) \
578 RTS_WIN64_ONLY(SymI_HasProto(creat)) \
579 RTS_WIN64_ONLY(SymI_HasProto(umask)) \
580 SymI_HasProto(unlink) \
581 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__errno)) \
582 RTS_WIN64_ONLY(SymI_NeedsProto(ftruncate64)) \
583 RTS_WIN64_ONLY(SymI_HasProto(setmode)) \
584 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__wstat64)) \
585 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__fstat64)) \
586 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__wsopen)) \
587 RTS_WIN64_ONLY(SymI_HasProto(__imp__environ)) \
588 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetFileAttributesA)) \
589 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetFileInformationByHandle)) \
590 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetFileType)) \
591 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetLastError)) \
592 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_QueryPerformanceFrequency)) \
593 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_QueryPerformanceCounter)) \
594 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetTickCount)) \
595 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_WaitForSingleObject)) \
596 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_PeekConsoleInputA)) \
597 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_ReadConsoleInputA)) \
598 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_PeekNamedPipe)) \
599 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__isatty)) \
600 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_select)) \
601 RTS_WIN64_ONLY(SymI_HasProto(isatty)) \
602 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__get_osfhandle)) \
603 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetConsoleMode)) \
604 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_SetConsoleMode)) \
605 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_FlushConsoleInputBuffer)) \
606 RTS_WIN64_ONLY(SymI_HasProto(free)) \
607 RTS_WIN64_ONLY(SymI_NeedsProto(raise)) \
608 RTS_WIN64_ONLY(SymI_NeedsProto(_getpid)) \
609 RTS_WIN64_ONLY(SymI_HasProto(getc)) \
610 RTS_WIN64_ONLY(SymI_HasProto(ungetc)) \
611 RTS_WIN64_ONLY(SymI_HasProto(puts)) \
612 RTS_WIN64_ONLY(SymI_HasProto(putc)) \
613 RTS_WIN64_ONLY(SymI_HasProto(putchar)) \
614 RTS_WIN64_ONLY(SymI_HasProto(fputc)) \
615 RTS_WIN64_ONLY(SymI_HasProto(fread)) \
616 RTS_WIN64_ONLY(SymI_HasProto(fwrite)) \
617 RTS_WIN64_ONLY(SymI_HasProto(ferror)) \
618 RTS_WIN64_ONLY(SymI_HasProto(printf)) \
619 RTS_WIN64_ONLY(SymI_HasProto(fprintf)) \
620 RTS_WIN64_ONLY(SymI_HasProto(sprintf)) \
621 RTS_WIN64_ONLY(SymI_HasProto(vsprintf)) \
622 RTS_WIN64_ONLY(SymI_HasProto(sscanf)) \
623 RTS_WIN64_ONLY(SymI_HasProto(ldexp)) \
624 RTS_WIN64_ONLY(SymI_HasProto(strlen)) \
625 RTS_WIN64_ONLY(SymI_HasProto(strnlen)) \
626 RTS_WIN64_ONLY(SymI_HasProto(strchr)) \
627 RTS_WIN64_ONLY(SymI_HasProto(strtol)) \
628 RTS_WIN64_ONLY(SymI_HasProto(strerror)) \
629 RTS_WIN64_ONLY(SymI_HasProto(memchr)) \
630 RTS_WIN64_ONLY(SymI_HasProto(memcmp)) \
631 RTS_WIN64_ONLY(SymI_HasProto(wcscpy)) \
632 RTS_WIN64_ONLY(SymI_HasProto(wcslen)) \
633 RTS_WIN64_ONLY(SymI_HasProto(_lseeki64)) \
634 RTS_WIN64_ONLY(SymI_HasProto(_wchmod)) \
635 RTS_WIN64_ONLY(SymI_HasProto(closesocket)) \
636 RTS_WIN64_ONLY(SymI_HasProto(send)) \
637 RTS_WIN64_ONLY(SymI_HasProto(recv)) \
638 RTS_WIN64_ONLY(SymI_HasProto(bsearch)) \
639 RTS_WIN64_ONLY(SymI_HasProto(CommandLineToArgvW)) \
640 RTS_WIN64_ONLY(SymI_HasProto(CreateBitmap)) \
641 RTS_WIN64_ONLY(SymI_HasProto(CreateBitmapIndirect)) \
642 RTS_WIN64_ONLY(SymI_HasProto(CreateCompatibleBitmap)) \
643 RTS_WIN64_ONLY(SymI_HasProto(CreateDIBPatternBrushPt)) \
644 RTS_WIN64_ONLY(SymI_HasProto(CreateDIBitmap)) \
645 RTS_WIN64_ONLY(SymI_HasProto(SetBitmapDimensionEx)) \
646 RTS_WIN64_ONLY(SymI_HasProto(GetBitmapDimensionEx)) \
647 RTS_WIN64_ONLY(SymI_HasProto(GetStockObject)) \
648 RTS_WIN64_ONLY(SymI_HasProto(GetObjectW)) \
649 RTS_WIN64_ONLY(SymI_HasProto(DeleteObject)) \
650 RTS_WIN64_ONLY(SymI_HasProto(SetDIBits)) \
651 RTS_WIN64_ONLY(SymI_HasProto(GetDIBits)) \
652 RTS_WIN64_ONLY(SymI_HasProto(CreateSolidBrush)) \
653 RTS_WIN64_ONLY(SymI_HasProto(CreateHatchBrush)) \
654 RTS_WIN64_ONLY(SymI_HasProto(CreatePatternBrush)) \
655 RTS_WIN64_ONLY(SymI_HasProto(CreateFontW)) \
656 RTS_WIN64_ONLY(SymI_HasProto(AngleArc)) \
657 RTS_WIN64_ONLY(SymI_HasProto(Arc)) \
658 RTS_WIN64_ONLY(SymI_HasProto(ArcTo)) \
659 RTS_WIN64_ONLY(SymI_HasProto(BeginPath)) \
660 RTS_WIN64_ONLY(SymI_HasProto(BitBlt)) \
661 RTS_WIN64_ONLY(SymI_HasProto(CancelDC)) \
662 RTS_WIN64_ONLY(SymI_HasProto(Chord)) \
663 RTS_WIN64_ONLY(SymI_HasProto(CloseFigure)) \
664 RTS_WIN64_ONLY(SymI_HasProto(CombineRgn)) \
665 RTS_WIN64_ONLY(SymI_HasProto(CreateCompatibleDC)) \
666 RTS_WIN64_ONLY(SymI_HasProto(CreateEllipticRgn)) \
667 RTS_WIN64_ONLY(SymI_HasProto(CreateEllipticRgnIndirect)) \
668 RTS_WIN64_ONLY(SymI_HasProto(CreatePen)) \
669 RTS_WIN64_ONLY(SymI_HasProto(CreatePolygonRgn)) \
670 RTS_WIN64_ONLY(SymI_HasProto(CreateRectRgn)) \
671 RTS_WIN64_ONLY(SymI_HasProto(CreateRectRgnIndirect)) \
672 RTS_WIN64_ONLY(SymI_HasProto(CreateRoundRectRgn)) \
673 RTS_WIN64_ONLY(SymI_HasProto(DeleteDC)) \
674 RTS_WIN64_ONLY(SymI_HasProto(Ellipse)) \
675 RTS_WIN64_ONLY(SymI_HasProto(EndPath)) \
676 RTS_WIN64_ONLY(SymI_HasProto(EqualRgn)) \
677 RTS_WIN64_ONLY(SymI_HasProto(ExtSelectClipRgn)) \
678 RTS_WIN64_ONLY(SymI_HasProto(FillPath)) \
679 RTS_WIN64_ONLY(SymI_HasProto(FillRgn)) \
680 RTS_WIN64_ONLY(SymI_HasProto(FlattenPath)) \
681 RTS_WIN64_ONLY(SymI_HasProto(FrameRgn)) \
682 RTS_WIN64_ONLY(SymI_HasProto(GetArcDirection)) \
683 RTS_WIN64_ONLY(SymI_HasProto(GetBkColor)) \
684 RTS_WIN64_ONLY(SymI_HasProto(GetBkMode)) \
685 RTS_WIN64_ONLY(SymI_HasProto(GetBrushOrgEx)) \
686 RTS_WIN64_ONLY(SymI_HasProto(GetCurrentObject)) \
687 RTS_WIN64_ONLY(SymI_HasProto(GetDCOrgEx)) \
688 RTS_WIN64_ONLY(SymI_HasProto(GetGraphicsMode)) \
689 RTS_WIN64_ONLY(SymI_HasProto(GetMiterLimit)) \
690 RTS_WIN64_ONLY(SymI_HasProto(GetPolyFillMode)) \
691 RTS_WIN64_ONLY(SymI_HasProto(GetRgnBox)) \
692 RTS_WIN64_ONLY(SymI_HasProto(GetStretchBltMode)) \
693 RTS_WIN64_ONLY(SymI_HasProto(GetTextAlign)) \
694 RTS_WIN64_ONLY(SymI_HasProto(GetTextCharacterExtra)) \
695 RTS_WIN64_ONLY(SymI_HasProto(GetTextColor)) \
696 RTS_WIN64_ONLY(SymI_HasProto(GetTextExtentPoint32W)) \
697 RTS_WIN64_ONLY(SymI_HasProto(InvertRgn)) \
698 RTS_WIN64_ONLY(SymI_HasProto(LineTo)) \
699 RTS_WIN64_ONLY(SymI_HasProto(MaskBlt)) \
700 RTS_WIN64_ONLY(SymI_HasProto(MoveToEx)) \
701 RTS_WIN64_ONLY(SymI_HasProto(OffsetRgn)) \
702 RTS_WIN64_ONLY(SymI_HasProto(PaintRgn)) \
703 RTS_WIN64_ONLY(SymI_HasProto(PathToRegion)) \
704 RTS_WIN64_ONLY(SymI_HasProto(Pie)) \
705 RTS_WIN64_ONLY(SymI_HasProto(PlgBlt)) \
706 RTS_WIN64_ONLY(SymI_HasProto(PolyBezier)) \
707 RTS_WIN64_ONLY(SymI_HasProto(PolyBezierTo)) \
708 RTS_WIN64_ONLY(SymI_HasProto(Polygon)) \
709 RTS_WIN64_ONLY(SymI_HasProto(Polyline)) \
710 RTS_WIN64_ONLY(SymI_HasProto(PolylineTo)) \
711 RTS_WIN64_ONLY(SymI_HasProto(PtInRegion)) \
712 RTS_WIN64_ONLY(SymI_HasProto(Rectangle)) \
713 RTS_WIN64_ONLY(SymI_HasProto(RectInRegion)) \
714 RTS_WIN64_ONLY(SymI_HasProto(RestoreDC)) \
715 RTS_WIN64_ONLY(SymI_HasProto(RoundRect)) \
716 RTS_WIN64_ONLY(SymI_HasProto(SaveDC)) \
717 RTS_WIN64_ONLY(SymI_HasProto(SelectClipPath)) \
718 RTS_WIN64_ONLY(SymI_HasProto(SelectClipRgn)) \
719 RTS_WIN64_ONLY(SymI_HasProto(SelectObject)) \
720 RTS_WIN64_ONLY(SymI_HasProto(SelectPalette)) \
721 RTS_WIN64_ONLY(SymI_HasProto(SetArcDirection)) \
722 RTS_WIN64_ONLY(SymI_HasProto(SetBkColor)) \
723 RTS_WIN64_ONLY(SymI_HasProto(SetBkMode)) \
724 RTS_WIN64_ONLY(SymI_HasProto(SetBrushOrgEx)) \
725 RTS_WIN64_ONLY(SymI_HasProto(SetGraphicsMode)) \
726 RTS_WIN64_ONLY(SymI_HasProto(SetMiterLimit)) \
727 RTS_WIN64_ONLY(SymI_HasProto(SetPolyFillMode)) \
728 RTS_WIN64_ONLY(SymI_HasProto(SetStretchBltMode)) \
729 RTS_WIN64_ONLY(SymI_HasProto(SetTextAlign)) \
730 RTS_WIN64_ONLY(SymI_HasProto(SetTextCharacterExtra)) \
731 RTS_WIN64_ONLY(SymI_HasProto(SetTextColor)) \
732 RTS_WIN64_ONLY(SymI_HasProto(StretchBlt)) \
733 RTS_WIN64_ONLY(SymI_HasProto(StrokeAndFillPath)) \
734 RTS_WIN64_ONLY(SymI_HasProto(StrokePath)) \
735 RTS_WIN64_ONLY(SymI_HasProto(TextOutW)) \
736 RTS_WIN64_ONLY(SymI_HasProto(timeGetTime)) \
737 RTS_WIN64_ONLY(SymI_HasProto(WidenPath)) \
738 RTS_WIN64_ONLY(SymI_HasProto(GetFileSecurityW)) \
739 RTS_WIN64_ONLY(SymI_HasProto(RegCloseKey)) \
740 RTS_WIN64_ONLY(SymI_HasProto(RegConnectRegistryW)) \
741 RTS_WIN64_ONLY(SymI_HasProto(RegCreateKeyExW)) \
742 RTS_WIN64_ONLY(SymI_HasProto(RegCreateKeyW)) \
743 RTS_WIN64_ONLY(SymI_HasProto(RegDeleteKeyW)) \
744 RTS_WIN64_ONLY(SymI_HasProto(RegDeleteValueW)) \
745 RTS_WIN64_ONLY(SymI_HasProto(RegEnumKeyW)) \
746 RTS_WIN64_ONLY(SymI_HasProto(RegEnumValueW)) \
747 RTS_WIN64_ONLY(SymI_HasProto(RegFlushKey)) \
748 RTS_WIN64_ONLY(SymI_HasProto(RegLoadKeyW)) \
749 RTS_WIN64_ONLY(SymI_HasProto(RegNotifyChangeKeyValue)) \
750 RTS_WIN64_ONLY(SymI_HasProto(RegOpenKeyExW)) \
751 RTS_WIN64_ONLY(SymI_HasProto(RegOpenKeyW)) \
752 RTS_WIN64_ONLY(SymI_HasProto(RegQueryInfoKeyW)) \
753 RTS_WIN64_ONLY(SymI_HasProto(RegQueryValueExW)) \
754 RTS_WIN64_ONLY(SymI_HasProto(RegQueryValueW)) \
755 RTS_WIN64_ONLY(SymI_HasProto(RegReplaceKeyW)) \
756 RTS_WIN64_ONLY(SymI_HasProto(RegRestoreKeyW)) \
757 RTS_WIN64_ONLY(SymI_HasProto(RegSaveKeyW)) \
758 RTS_WIN64_ONLY(SymI_HasProto(RegSetValueExW)) \
759 RTS_WIN64_ONLY(SymI_HasProto(RegSetValueW)) \
760 RTS_WIN64_ONLY(SymI_HasProto(RegUnLoadKeyW)) \
761 RTS_WIN64_ONLY(SymI_NeedsProto(SHGetFolderPathW)) \
762 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_SetWindowLongPtrW)) \
763 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetWindowLongPtrW)) \
764 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_MenuItemFromPoint)) \
765 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_ChildWindowFromPoint)) \
766 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_ChildWindowFromPointEx)) \
767 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_DeleteObject)) \
768 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_UnmapViewOfFile)) \
769 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_CloseHandle)) \
770 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_FreeLibrary)) \
771 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetMessageW)) \
772 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_TranslateMessage)) \
773 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_DispatchMessageW)) \
774 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_DefWindowProcW)) \
775 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetDIBits)) \
776 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GlobalAlloc)) \
777 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GlobalFree)) \
778 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_CreateFileW)) \
779 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_WriteFile)) \
780 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_CreateCompatibleBitmap)) \
781 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_SelectObject)) \
782 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_Polygon)) \
783 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_FormatMessageW)) \
784 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__localtime64)) \
785 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__tzname)) \
786 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__timezone)) \
787 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_CreatePipe)) \
788 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_SetHandleInformation)) \
789 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetStdHandle)) \
790 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetCurrentProcess)) \
791 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_DuplicateHandle)) \
792 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_CreateProcessW)) \
793 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_TerminateProcess)) \
794 RTS_WIN64_ONLY(SymI_NeedsProto(__imp__open_osfhandle)) \
795 RTS_WIN64_ONLY(SymI_NeedsProto(__imp_GetExitCodeProcess)) \
796 RTS_MINGW_GETTIMEOFDAY_SYM \
797 SymI_NeedsProto(closedir)
798
799 #else
800 #define RTS_MINGW_ONLY_SYMBOLS /**/
801 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
802 #endif
803
804
805 #if defined(darwin_HOST_OS) && HAVE_PRINTF_LDBLSTUB
806 #define RTS_DARWIN_ONLY_SYMBOLS \
807 SymI_NeedsProto(asprintf$LDBLStub) \
808 SymI_NeedsProto(err$LDBLStub) \
809 SymI_NeedsProto(errc$LDBLStub) \
810 SymI_NeedsProto(errx$LDBLStub) \
811 SymI_NeedsProto(fprintf$LDBLStub) \
812 SymI_NeedsProto(fscanf$LDBLStub) \
813 SymI_NeedsProto(fwprintf$LDBLStub) \
814 SymI_NeedsProto(fwscanf$LDBLStub) \
815 SymI_NeedsProto(printf$LDBLStub) \
816 SymI_NeedsProto(scanf$LDBLStub) \
817 SymI_NeedsProto(snprintf$LDBLStub) \
818 SymI_NeedsProto(sprintf$LDBLStub) \
819 SymI_NeedsProto(sscanf$LDBLStub) \
820 SymI_NeedsProto(strtold$LDBLStub) \
821 SymI_NeedsProto(swprintf$LDBLStub) \
822 SymI_NeedsProto(swscanf$LDBLStub) \
823 SymI_NeedsProto(syslog$LDBLStub) \
824 SymI_NeedsProto(vasprintf$LDBLStub) \
825 SymI_NeedsProto(verr$LDBLStub) \
826 SymI_NeedsProto(verrc$LDBLStub) \
827 SymI_NeedsProto(verrx$LDBLStub) \
828 SymI_NeedsProto(vfprintf$LDBLStub) \
829 SymI_NeedsProto(vfscanf$LDBLStub) \
830 SymI_NeedsProto(vfwprintf$LDBLStub) \
831 SymI_NeedsProto(vfwscanf$LDBLStub) \
832 SymI_NeedsProto(vprintf$LDBLStub) \
833 SymI_NeedsProto(vscanf$LDBLStub) \
834 SymI_NeedsProto(vsnprintf$LDBLStub) \
835 SymI_NeedsProto(vsprintf$LDBLStub) \
836 SymI_NeedsProto(vsscanf$LDBLStub) \
837 SymI_NeedsProto(vswprintf$LDBLStub) \
838 SymI_NeedsProto(vswscanf$LDBLStub) \
839 SymI_NeedsProto(vsyslog$LDBLStub) \
840 SymI_NeedsProto(vwarn$LDBLStub) \
841 SymI_NeedsProto(vwarnc$LDBLStub) \
842 SymI_NeedsProto(vwarnx$LDBLStub) \
843 SymI_NeedsProto(vwprintf$LDBLStub) \
844 SymI_NeedsProto(vwscanf$LDBLStub) \
845 SymI_NeedsProto(warn$LDBLStub) \
846 SymI_NeedsProto(warnc$LDBLStub) \
847 SymI_NeedsProto(warnx$LDBLStub) \
848 SymI_NeedsProto(wcstold$LDBLStub) \
849 SymI_NeedsProto(wprintf$LDBLStub) \
850 SymI_NeedsProto(wscanf$LDBLStub)
851 #else
852 #define RTS_DARWIN_ONLY_SYMBOLS
853 #endif
854
855 #ifndef SMP
856 # define MAIN_CAP_SYM SymI_HasProto(MainCapability)
857 #else
858 # define MAIN_CAP_SYM
859 #endif
860
861 #if !defined(mingw32_HOST_OS)
862 #define RTS_USER_SIGNALS_SYMBOLS \
863 SymI_HasProto(setIOManagerControlFd) \
864 SymI_HasProto(setTimerManagerControlFd) \
865 SymI_HasProto(setIOManagerWakeupFd) \
866 SymI_HasProto(ioManagerWakeup) \
867 SymI_HasProto(blockUserSignals) \
868 SymI_HasProto(unblockUserSignals)
869 #else
870 #define RTS_USER_SIGNALS_SYMBOLS \
871 SymI_HasProto(ioManagerWakeup) \
872 SymI_HasProto(sendIOManagerEvent) \
873 SymI_HasProto(readIOManagerEvent) \
874 SymI_HasProto(getIOManagerEvent) \
875 SymI_HasProto(console_handler)
876 #endif
877
878 #define RTS_LIBFFI_SYMBOLS \
879 SymE_NeedsProto(ffi_prep_cif) \
880 SymE_NeedsProto(ffi_call) \
881 SymE_NeedsProto(ffi_type_void) \
882 SymE_NeedsProto(ffi_type_float) \
883 SymE_NeedsProto(ffi_type_double) \
884 SymE_NeedsProto(ffi_type_sint64) \
885 SymE_NeedsProto(ffi_type_uint64) \
886 SymE_NeedsProto(ffi_type_sint32) \
887 SymE_NeedsProto(ffi_type_uint32) \
888 SymE_NeedsProto(ffi_type_sint16) \
889 SymE_NeedsProto(ffi_type_uint16) \
890 SymE_NeedsProto(ffi_type_sint8) \
891 SymE_NeedsProto(ffi_type_uint8) \
892 SymE_NeedsProto(ffi_type_pointer)
893
894 #ifdef TABLES_NEXT_TO_CODE
895 #define RTS_RET_SYMBOLS /* nothing */
896 #else
897 #define RTS_RET_SYMBOLS \
898 SymI_HasProto(stg_enter_ret) \
899 SymI_HasProto(stg_gc_fun_ret) \
900 SymI_HasProto(stg_ap_v_ret) \
901 SymI_HasProto(stg_ap_f_ret) \
902 SymI_HasProto(stg_ap_d_ret) \
903 SymI_HasProto(stg_ap_l_ret) \
904 SymI_HasProto(stg_ap_v16_ret) \
905 SymI_HasProto(stg_ap_v32_ret) \
906 SymI_HasProto(stg_ap_v64_ret) \
907 SymI_HasProto(stg_ap_n_ret) \
908 SymI_HasProto(stg_ap_p_ret) \
909 SymI_HasProto(stg_ap_pv_ret) \
910 SymI_HasProto(stg_ap_pp_ret) \
911 SymI_HasProto(stg_ap_ppv_ret) \
912 SymI_HasProto(stg_ap_ppp_ret) \
913 SymI_HasProto(stg_ap_pppv_ret) \
914 SymI_HasProto(stg_ap_pppp_ret) \
915 SymI_HasProto(stg_ap_ppppp_ret) \
916 SymI_HasProto(stg_ap_pppppp_ret)
917 #endif
918
919 /* Modules compiled with -ticky may mention ticky counters */
920 /* This list should marry up with the one in $(TOP)/includes/stg/Ticky.h */
921 #define RTS_TICKY_SYMBOLS \
922 SymI_NeedsProto(ticky_entry_ctrs) \
923 SymI_NeedsProto(top_ct) \
924 \
925 SymI_HasProto(ENT_VIA_NODE_ctr) \
926 SymI_HasProto(ENT_STATIC_THK_SINGLE_ctr) \
927 SymI_HasProto(ENT_STATIC_THK_MANY_ctr) \
928 SymI_HasProto(ENT_DYN_THK_SINGLE_ctr) \
929 SymI_HasProto(ENT_DYN_THK_MANY_ctr) \
930 SymI_HasProto(ENT_STATIC_FUN_DIRECT_ctr) \
931 SymI_HasProto(ENT_DYN_FUN_DIRECT_ctr) \
932 SymI_HasProto(ENT_STATIC_CON_ctr) \
933 SymI_HasProto(ENT_DYN_CON_ctr) \
934 SymI_HasProto(ENT_STATIC_IND_ctr) \
935 SymI_HasProto(ENT_DYN_IND_ctr) \
936 SymI_HasProto(ENT_PERM_IND_ctr) \
937 SymI_HasProto(ENT_PAP_ctr) \
938 SymI_HasProto(ENT_AP_ctr) \
939 SymI_HasProto(ENT_AP_STACK_ctr) \
940 SymI_HasProto(ENT_BH_ctr) \
941 SymI_HasProto(ENT_LNE_ctr) \
942 SymI_HasProto(UNKNOWN_CALL_ctr) \
943 SymI_HasProto(SLOW_CALL_fast_v16_ctr) \
944 SymI_HasProto(SLOW_CALL_fast_v_ctr) \
945 SymI_HasProto(SLOW_CALL_fast_f_ctr) \
946 SymI_HasProto(SLOW_CALL_fast_d_ctr) \
947 SymI_HasProto(SLOW_CALL_fast_l_ctr) \
948 SymI_HasProto(SLOW_CALL_fast_n_ctr) \
949 SymI_HasProto(SLOW_CALL_fast_p_ctr) \
950 SymI_HasProto(SLOW_CALL_fast_pv_ctr) \
951 SymI_HasProto(SLOW_CALL_fast_pp_ctr) \
952 SymI_HasProto(SLOW_CALL_fast_ppv_ctr) \
953 SymI_HasProto(SLOW_CALL_fast_ppp_ctr) \
954 SymI_HasProto(SLOW_CALL_fast_pppv_ctr) \
955 SymI_HasProto(SLOW_CALL_fast_pppp_ctr) \
956 SymI_HasProto(SLOW_CALL_fast_ppppp_ctr) \
957 SymI_HasProto(SLOW_CALL_fast_pppppp_ctr) \
958 SymI_HasProto(VERY_SLOW_CALL_ctr) \
959 SymI_HasProto(ticky_slow_call_unevald) \
960 SymI_HasProto(SLOW_CALL_ctr) \
961 SymI_HasProto(MULTI_CHUNK_SLOW_CALL_ctr) \
962 SymI_HasProto(MULTI_CHUNK_SLOW_CALL_CHUNKS_ctr) \
963 SymI_HasProto(KNOWN_CALL_ctr) \
964 SymI_HasProto(KNOWN_CALL_TOO_FEW_ARGS_ctr) \
965 SymI_HasProto(KNOWN_CALL_EXTRA_ARGS_ctr) \
966 SymI_HasProto(SLOW_CALL_FUN_TOO_FEW_ctr) \
967 SymI_HasProto(SLOW_CALL_FUN_CORRECT_ctr) \
968 SymI_HasProto(SLOW_CALL_FUN_TOO_MANY_ctr) \
969 SymI_HasProto(SLOW_CALL_PAP_TOO_FEW_ctr) \
970 SymI_HasProto(SLOW_CALL_PAP_CORRECT_ctr) \
971 SymI_HasProto(SLOW_CALL_PAP_TOO_MANY_ctr) \
972 SymI_HasProto(SLOW_CALL_UNEVALD_ctr) \
973 SymI_HasProto(UPDF_OMITTED_ctr) \
974 SymI_HasProto(UPDF_PUSHED_ctr) \
975 SymI_HasProto(CATCHF_PUSHED_ctr) \
976 SymI_HasProto(UPDF_RCC_PUSHED_ctr) \
977 SymI_HasProto(UPDF_RCC_OMITTED_ctr) \
978 SymI_HasProto(UPD_SQUEEZED_ctr) \
979 SymI_HasProto(UPD_CON_IN_NEW_ctr) \
980 SymI_HasProto(UPD_CON_IN_PLACE_ctr) \
981 SymI_HasProto(UPD_PAP_IN_NEW_ctr) \
982 SymI_HasProto(UPD_PAP_IN_PLACE_ctr) \
983 SymI_HasProto(ALLOC_HEAP_ctr) \
984 SymI_HasProto(ALLOC_HEAP_tot) \
985 SymI_HasProto(HEAP_CHK_ctr) \
986 SymI_HasProto(STK_CHK_ctr) \
987 SymI_HasProto(ALLOC_RTS_ctr) \
988 SymI_HasProto(ALLOC_RTS_tot) \
989 SymI_HasProto(ALLOC_FUN_ctr) \
990 SymI_HasProto(ALLOC_FUN_adm) \
991 SymI_HasProto(ALLOC_FUN_gds) \
992 SymI_HasProto(ALLOC_FUN_slp) \
993 SymI_HasProto(UPD_NEW_IND_ctr) \
994 SymI_HasProto(UPD_NEW_PERM_IND_ctr) \
995 SymI_HasProto(UPD_OLD_IND_ctr) \
996 SymI_HasProto(UPD_OLD_PERM_IND_ctr) \
997 SymI_HasProto(UPD_CAF_BH_UPDATABLE_ctr) \
998 SymI_HasProto(UPD_CAF_BH_SINGLE_ENTRY_ctr) \
999 SymI_HasProto(GC_SEL_ABANDONED_ctr) \
1000 SymI_HasProto(GC_SEL_MINOR_ctr) \
1001 SymI_HasProto(GC_SEL_MAJOR_ctr) \
1002 SymI_HasProto(GC_FAILED_PROMOTION_ctr) \
1003 SymI_HasProto(ALLOC_UP_THK_ctr) \
1004 SymI_HasProto(ALLOC_SE_THK_ctr) \
1005 SymI_HasProto(ALLOC_THK_adm) \
1006 SymI_HasProto(ALLOC_THK_gds) \
1007 SymI_HasProto(ALLOC_THK_slp) \
1008 SymI_HasProto(ALLOC_CON_ctr) \
1009 SymI_HasProto(ALLOC_CON_adm) \
1010 SymI_HasProto(ALLOC_CON_gds) \
1011 SymI_HasProto(ALLOC_CON_slp) \
1012 SymI_HasProto(ALLOC_TUP_ctr) \
1013 SymI_HasProto(ALLOC_TUP_adm) \
1014 SymI_HasProto(ALLOC_TUP_gds) \
1015 SymI_HasProto(ALLOC_TUP_slp) \
1016 SymI_HasProto(ALLOC_BH_ctr) \
1017 SymI_HasProto(ALLOC_BH_adm) \
1018 SymI_HasProto(ALLOC_BH_gds) \
1019 SymI_HasProto(ALLOC_BH_slp) \
1020 SymI_HasProto(ALLOC_PRIM_ctr) \
1021 SymI_HasProto(ALLOC_PRIM_adm) \
1022 SymI_HasProto(ALLOC_PRIM_gds) \
1023 SymI_HasProto(ALLOC_PRIM_slp) \
1024 SymI_HasProto(ALLOC_PAP_ctr) \
1025 SymI_HasProto(ALLOC_PAP_adm) \
1026 SymI_HasProto(ALLOC_PAP_gds) \
1027 SymI_HasProto(ALLOC_PAP_slp) \
1028 SymI_HasProto(ALLOC_TSO_ctr) \
1029 SymI_HasProto(ALLOC_TSO_adm) \
1030 SymI_HasProto(ALLOC_TSO_gds) \
1031 SymI_HasProto(ALLOC_TSO_slp) \
1032 SymI_HasProto(RET_NEW_ctr) \
1033 SymI_HasProto(RET_OLD_ctr) \
1034 SymI_HasProto(RET_UNBOXED_TUP_ctr) \
1035 SymI_HasProto(RET_SEMI_loads_avoided)
1036
1037
1038 // On most platforms, the garbage collector rewrites references
1039 // to small integer and char objects to a set of common, shared ones.
1040 //
1041 // We don't do this when compiling to Windows DLLs at the moment because
1042 // it doesn't support cross package data references well.
1043 //
1044 #if defined(COMPILING_WINDOWS_DLL)
1045 #define RTS_INTCHAR_SYMBOLS
1046 #else
1047 #define RTS_INTCHAR_SYMBOLS \
1048 SymI_HasProto(stg_CHARLIKE_closure) \
1049 SymI_HasProto(stg_INTLIKE_closure)
1050 #endif
1051
1052
1053 #define RTS_SYMBOLS \
1054 Maybe_Stable_Names \
1055 RTS_TICKY_SYMBOLS \
1056 SymI_HasProto(StgReturn) \
1057 SymI_HasProto(stg_gc_noregs) \
1058 SymI_HasProto(stg_ret_v_info) \
1059 SymI_HasProto(stg_ret_p_info) \
1060 SymI_HasProto(stg_ret_n_info) \
1061 SymI_HasProto(stg_ret_f_info) \
1062 SymI_HasProto(stg_ret_d_info) \
1063 SymI_HasProto(stg_ret_l_info) \
1064 SymI_HasProto(stg_gc_prim_p) \
1065 SymI_HasProto(stg_gc_prim_pp) \
1066 SymI_HasProto(stg_gc_prim_n) \
1067 SymI_HasProto(stg_enter_info) \
1068 SymI_HasProto(__stg_gc_enter_1) \
1069 SymI_HasProto(stg_gc_unpt_r1) \
1070 SymI_HasProto(stg_gc_unbx_r1) \
1071 SymI_HasProto(stg_gc_f1) \
1072 SymI_HasProto(stg_gc_d1) \
1073 SymI_HasProto(stg_gc_l1) \
1074 SymI_HasProto(stg_gc_pp) \
1075 SymI_HasProto(stg_gc_ppp) \
1076 SymI_HasProto(stg_gc_pppp) \
1077 SymI_HasProto(__stg_gc_fun) \
1078 SymI_HasProto(stg_gc_fun_info) \
1079 SymI_HasProto(stg_yield_noregs) \
1080 SymI_HasProto(stg_yield_to_interpreter) \
1081 SymI_HasProto(stg_block_noregs) \
1082 SymI_HasProto(stg_block_takemvar) \
1083 SymI_HasProto(stg_block_readmvar) \
1084 SymI_HasProto(stg_block_putmvar) \
1085 MAIN_CAP_SYM \
1086 SymI_HasProto(MallocFailHook) \
1087 SymI_HasProto(OnExitHook) \
1088 SymI_HasProto(OutOfHeapHook) \
1089 SymI_HasProto(StackOverflowHook) \
1090 SymI_HasProto(addDLL) \
1091 SymI_HasProto(__int_encodeDouble) \
1092 SymI_HasProto(__word_encodeDouble) \
1093 SymI_HasProto(__int_encodeFloat) \
1094 SymI_HasProto(__word_encodeFloat) \
1095 SymI_HasProto(stg_atomicallyzh) \
1096 SymI_HasProto(barf) \
1097 SymI_HasProto(deRefStablePtr) \
1098 SymI_HasProto(debugBelch) \
1099 SymI_HasProto(errorBelch) \
1100 SymI_HasProto(sysErrorBelch) \
1101 SymI_HasProto(stg_getMaskingStatezh) \
1102 SymI_HasProto(stg_maskAsyncExceptionszh) \
1103 SymI_HasProto(stg_maskUninterruptiblezh) \
1104 SymI_HasProto(stg_catchzh) \
1105 SymI_HasProto(stg_catchRetryzh) \
1106 SymI_HasProto(stg_catchSTMzh) \
1107 SymI_HasProto(stg_checkzh) \
1108 SymI_HasProto(closure_flags) \
1109 SymI_HasProto(cmp_thread) \
1110 SymI_HasProto(createAdjustor) \
1111 SymI_HasProto(stg_decodeDoublezu2Intzh) \
1112 SymI_HasProto(stg_decodeDoublezuInt64zh) \
1113 SymI_HasProto(stg_decodeFloatzuIntzh) \
1114 SymI_HasProto(defaultsHook) \
1115 SymI_HasProto(stg_delayzh) \
1116 SymI_HasProto(stg_deRefWeakzh) \
1117 SymI_HasProto(stg_deRefStablePtrzh) \
1118 SymI_HasProto(dirty_MUT_VAR) \
1119 SymI_HasProto(dirty_TVAR) \
1120 SymI_HasProto(stg_forkzh) \
1121 SymI_HasProto(stg_forkOnzh) \
1122 SymI_HasProto(forkProcess) \
1123 SymI_HasProto(forkOS_createThread) \
1124 SymI_HasProto(freeHaskellFunctionPtr) \
1125 SymI_HasProto(getOrSetGHCConcSignalSignalHandlerStore) \
1126 SymI_HasProto(getOrSetGHCConcWindowsPendingDelaysStore) \
1127 SymI_HasProto(getOrSetGHCConcWindowsIOManagerThreadStore) \
1128 SymI_HasProto(getOrSetGHCConcWindowsProddingStore) \
1129 SymI_HasProto(getOrSetSystemEventThreadEventManagerStore) \
1130 SymI_HasProto(getOrSetSystemEventThreadIOManagerThreadStore) \
1131 SymI_HasProto(getOrSetSystemTimerThreadEventManagerStore) \
1132 SymI_HasProto(getOrSetSystemTimerThreadIOManagerThreadStore) \
1133 SymI_HasProto(getOrSetLibHSghcFastStringTable) \
1134 SymI_HasProto(getGCStats) \
1135 SymI_HasProto(getGCStatsEnabled) \
1136 SymI_HasProto(genericRaise) \
1137 SymI_HasProto(getProgArgv) \
1138 SymI_HasProto(getFullProgArgv) \
1139 SymI_HasProto(getStablePtr) \
1140 SymI_HasProto(foreignExportStablePtr) \
1141 SymI_HasProto(hs_init) \
1142 SymI_HasProto(hs_exit) \
1143 SymI_HasProto(hs_set_argv) \
1144 SymI_HasProto(hs_add_root) \
1145 SymI_HasProto(hs_perform_gc) \
1146 SymI_HasProto(hs_lock_stable_tables) \
1147 SymI_HasProto(hs_unlock_stable_tables) \
1148 SymI_HasProto(hs_free_stable_ptr) \
1149 SymI_HasProto(hs_free_stable_ptr_unsafe) \
1150 SymI_HasProto(hs_free_fun_ptr) \
1151 SymI_HasProto(hs_hpc_rootModule) \
1152 SymI_HasProto(hs_hpc_module) \
1153 SymI_HasProto(initLinker) \
1154 SymI_HasProto(initLinker_) \
1155 SymI_HasProto(stg_unpackClosurezh) \
1156 SymI_HasProto(stg_getApStackValzh) \
1157 SymI_HasProto(stg_getSparkzh) \
1158 SymI_HasProto(stg_numSparkszh) \
1159 SymI_HasProto(stg_isCurrentThreadBoundzh) \
1160 SymI_HasProto(stg_isEmptyMVarzh) \
1161 SymI_HasProto(stg_killThreadzh) \
1162 SymI_HasProto(loadArchive) \
1163 SymI_HasProto(loadObj) \
1164 SymI_HasProto(insertSymbol) \
1165 SymI_HasProto(lookupSymbol) \
1166 SymI_HasProto(stg_makeStablePtrzh) \
1167 SymI_HasProto(stg_mkApUpd0zh) \
1168 SymI_HasProto(stg_myThreadIdzh) \
1169 SymI_HasProto(stg_labelThreadzh) \
1170 SymI_HasProto(stg_newArrayzh) \
1171 SymI_HasProto(stg_copyArrayzh) \
1172 SymI_HasProto(stg_copyMutableArrayzh) \
1173 SymI_HasProto(stg_copyArrayArrayzh) \
1174 SymI_HasProto(stg_copyMutableArrayArrayzh) \
1175 SymI_HasProto(stg_cloneArrayzh) \
1176 SymI_HasProto(stg_cloneMutableArrayzh) \
1177 SymI_HasProto(stg_freezzeArrayzh) \
1178 SymI_HasProto(stg_thawArrayzh) \
1179 SymI_HasProto(stg_newArrayArrayzh) \
1180 SymI_HasProto(stg_casArrayzh) \
1181 SymI_HasProto(stg_newSmallArrayzh) \
1182 SymI_HasProto(stg_unsafeThawSmallArrayzh) \
1183 SymI_HasProto(stg_cloneSmallArrayzh) \
1184 SymI_HasProto(stg_cloneSmallMutableArrayzh) \
1185 SymI_HasProto(stg_freezzeSmallArrayzh) \
1186 SymI_HasProto(stg_thawSmallArrayzh) \
1187 SymI_HasProto(stg_copySmallArrayzh) \
1188 SymI_HasProto(stg_copySmallMutableArrayzh) \
1189 SymI_HasProto(stg_casSmallArrayzh) \
1190 SymI_HasProto(stg_newBCOzh) \
1191 SymI_HasProto(stg_newByteArrayzh) \
1192 SymI_HasProto(stg_casIntArrayzh) \
1193 SymI_HasProto(stg_newMVarzh) \
1194 SymI_HasProto(stg_newMutVarzh) \
1195 SymI_HasProto(stg_newTVarzh) \
1196 SymI_HasProto(stg_noDuplicatezh) \
1197 SymI_HasProto(stg_atomicModifyMutVarzh) \
1198 SymI_HasProto(stg_casMutVarzh) \
1199 SymI_HasProto(stg_newPinnedByteArrayzh) \
1200 SymI_HasProto(stg_newAlignedPinnedByteArrayzh) \
1201 SymI_HasProto(stg_shrinkMutableByteArrayzh) \
1202 SymI_HasProto(stg_resizzeMutableByteArrayzh) \
1203 SymI_HasProto(newSpark) \
1204 SymI_HasProto(performGC) \
1205 SymI_HasProto(performMajorGC) \
1206 SymI_HasProto(prog_argc) \
1207 SymI_HasProto(prog_argv) \
1208 SymI_HasProto(stg_putMVarzh) \
1209 SymI_HasProto(stg_raisezh) \
1210 SymI_HasProto(stg_raiseIOzh) \
1211 SymI_HasProto(stg_readTVarzh) \
1212 SymI_HasProto(stg_readTVarIOzh) \
1213 SymI_HasProto(resumeThread) \
1214 SymI_HasProto(setNumCapabilities) \
1215 SymI_HasProto(getNumberOfProcessors) \
1216 SymI_HasProto(resolveObjs) \
1217 SymI_HasProto(stg_retryzh) \
1218 SymI_HasProto(rts_apply) \
1219 SymI_HasProto(rts_checkSchedStatus) \
1220 SymI_HasProto(rts_eval) \
1221 SymI_HasProto(rts_evalIO) \
1222 SymI_HasProto(rts_evalLazyIO) \
1223 SymI_HasProto(rts_evalStableIO) \
1224 SymI_HasProto(rts_eval_) \
1225 SymI_HasProto(rts_getBool) \
1226 SymI_HasProto(rts_getChar) \
1227 SymI_HasProto(rts_getDouble) \
1228 SymI_HasProto(rts_getFloat) \
1229 SymI_HasProto(rts_getInt) \
1230 SymI_HasProto(rts_getInt8) \
1231 SymI_HasProto(rts_getInt16) \
1232 SymI_HasProto(rts_getInt32) \
1233 SymI_HasProto(rts_getInt64) \
1234 SymI_HasProto(rts_getPtr) \
1235 SymI_HasProto(rts_getFunPtr) \
1236 SymI_HasProto(rts_getStablePtr) \
1237 SymI_HasProto(rts_getThreadId) \
1238 SymI_HasProto(rts_getWord) \
1239 SymI_HasProto(rts_getWord8) \
1240 SymI_HasProto(rts_getWord16) \
1241 SymI_HasProto(rts_getWord32) \
1242 SymI_HasProto(rts_getWord64) \
1243 SymI_HasProto(rts_lock) \
1244 SymI_HasProto(rts_mkBool) \
1245 SymI_HasProto(rts_mkChar) \
1246 SymI_HasProto(rts_mkDouble) \
1247 SymI_HasProto(rts_mkFloat) \
1248 SymI_HasProto(rts_mkInt) \
1249 SymI_HasProto(rts_mkInt8) \
1250 SymI_HasProto(rts_mkInt16) \
1251 SymI_HasProto(rts_mkInt32) \
1252 SymI_HasProto(rts_mkInt64) \
1253 SymI_HasProto(rts_mkPtr) \
1254 SymI_HasProto(rts_mkFunPtr) \
1255 SymI_HasProto(rts_mkStablePtr) \
1256 SymI_HasProto(rts_mkString) \
1257 SymI_HasProto(rts_mkWord) \
1258 SymI_HasProto(rts_mkWord8) \
1259 SymI_HasProto(rts_mkWord16) \
1260 SymI_HasProto(rts_mkWord32) \
1261 SymI_HasProto(rts_mkWord64) \
1262 SymI_HasProto(rts_unlock) \
1263 SymI_HasProto(rts_unsafeGetMyCapability) \
1264 SymI_HasProto(rtsSupportsBoundThreads) \
1265 SymI_HasProto(rts_isProfiled) \
1266 SymI_HasProto(rts_isDynamic) \
1267 SymI_HasProto(rts_getThreadAllocationCounter) \
1268 SymI_HasProto(rts_setThreadAllocationCounter) \
1269 SymI_HasProto(rts_enableThreadAllocationLimit) \
1270 SymI_HasProto(rts_disableThreadAllocationLimit) \
1271 SymI_HasProto(setProgArgv) \
1272 SymI_HasProto(startupHaskell) \
1273 SymI_HasProto(shutdownHaskell) \
1274 SymI_HasProto(shutdownHaskellAndExit) \
1275 SymI_HasProto(stable_name_table) \
1276 SymI_HasProto(stable_ptr_table) \
1277 SymI_HasProto(stackOverflow) \
1278 SymI_HasProto(stg_CAF_BLACKHOLE_info) \
1279 SymI_HasProto(stg_BLACKHOLE_info) \
1280 SymI_HasProto(__stg_EAGER_BLACKHOLE_info) \
1281 SymI_HasProto(stg_BLOCKING_QUEUE_CLEAN_info) \
1282 SymI_HasProto(stg_BLOCKING_QUEUE_DIRTY_info) \
1283 SymI_HasProto(startTimer) \
1284 SymI_HasProto(stg_MVAR_CLEAN_info) \
1285 SymI_HasProto(stg_MVAR_DIRTY_info) \
1286 SymI_HasProto(stg_TVAR_CLEAN_info) \
1287 SymI_HasProto(stg_TVAR_DIRTY_info) \
1288 SymI_HasProto(stg_IND_STATIC_info) \
1289 SymI_HasProto(stg_ARR_WORDS_info) \
1290 SymI_HasProto(stg_MUT_ARR_PTRS_DIRTY_info) \
1291 SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN_info) \
1292 SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN0_info) \
1293 SymI_HasProto(stg_SMALL_MUT_ARR_PTRS_DIRTY_info) \
1294 SymI_HasProto(stg_SMALL_MUT_ARR_PTRS_FROZEN_info) \
1295 SymI_HasProto(stg_SMALL_MUT_ARR_PTRS_FROZEN0_info) \
1296 SymI_HasProto(stg_MUT_VAR_CLEAN_info) \
1297 SymI_HasProto(stg_MUT_VAR_DIRTY_info) \
1298 SymI_HasProto(stg_WEAK_info) \
1299 SymI_HasProto(stg_ap_v_info) \
1300 SymI_HasProto(stg_ap_f_info) \
1301 SymI_HasProto(stg_ap_d_info) \
1302 SymI_HasProto(stg_ap_l_info) \
1303 SymI_HasProto(stg_ap_v16_info) \
1304 SymI_HasProto(stg_ap_v32_info) \
1305 SymI_HasProto(stg_ap_v64_info) \
1306 SymI_HasProto(stg_ap_n_info) \
1307 SymI_HasProto(stg_ap_p_info) \
1308 SymI_HasProto(stg_ap_pv_info) \
1309 SymI_HasProto(stg_ap_pp_info) \
1310 SymI_HasProto(stg_ap_ppv_info) \
1311 SymI_HasProto(stg_ap_ppp_info) \
1312 SymI_HasProto(stg_ap_pppv_info) \
1313 SymI_HasProto(stg_ap_pppp_info) \
1314 SymI_HasProto(stg_ap_ppppp_info) \
1315 SymI_HasProto(stg_ap_pppppp_info) \
1316 SymI_HasProto(stg_ap_0_fast) \
1317 SymI_HasProto(stg_ap_v_fast) \
1318 SymI_HasProto(stg_ap_f_fast) \
1319 SymI_HasProto(stg_ap_d_fast) \
1320 SymI_HasProto(stg_ap_l_fast) \
1321 SymI_HasProto(stg_ap_v16_fast) \
1322 SymI_HasProto(stg_ap_v32_fast) \
1323 SymI_HasProto(stg_ap_v64_fast) \
1324 SymI_HasProto(stg_ap_n_fast) \
1325 SymI_HasProto(stg_ap_p_fast) \
1326 SymI_HasProto(stg_ap_pv_fast) \
1327 SymI_HasProto(stg_ap_pp_fast) \
1328 SymI_HasProto(stg_ap_ppv_fast) \
1329 SymI_HasProto(stg_ap_ppp_fast) \
1330 SymI_HasProto(stg_ap_pppv_fast) \
1331 SymI_HasProto(stg_ap_pppp_fast) \
1332 SymI_HasProto(stg_ap_ppppp_fast) \
1333 SymI_HasProto(stg_ap_pppppp_fast) \
1334 SymI_HasProto(stg_ap_1_upd_info) \
1335 SymI_HasProto(stg_ap_2_upd_info) \
1336 SymI_HasProto(stg_ap_3_upd_info) \
1337 SymI_HasProto(stg_ap_4_upd_info) \
1338 SymI_HasProto(stg_ap_5_upd_info) \
1339 SymI_HasProto(stg_ap_6_upd_info) \
1340 SymI_HasProto(stg_ap_7_upd_info) \
1341 SymI_HasProto(stg_exit) \
1342 SymI_HasProto(stg_sel_0_upd_info) \
1343 SymI_HasProto(stg_sel_1_upd_info) \
1344 SymI_HasProto(stg_sel_2_upd_info) \
1345 SymI_HasProto(stg_sel_3_upd_info) \
1346 SymI_HasProto(stg_sel_4_upd_info) \
1347 SymI_HasProto(stg_sel_5_upd_info) \
1348 SymI_HasProto(stg_sel_6_upd_info) \
1349 SymI_HasProto(stg_sel_7_upd_info) \
1350 SymI_HasProto(stg_sel_8_upd_info) \
1351 SymI_HasProto(stg_sel_9_upd_info) \
1352 SymI_HasProto(stg_sel_10_upd_info) \
1353 SymI_HasProto(stg_sel_11_upd_info) \
1354 SymI_HasProto(stg_sel_12_upd_info) \
1355 SymI_HasProto(stg_sel_13_upd_info) \
1356 SymI_HasProto(stg_sel_14_upd_info) \
1357 SymI_HasProto(stg_sel_15_upd_info) \
1358 SymI_HasProto(stg_sel_0_noupd_info) \
1359 SymI_HasProto(stg_sel_1_noupd_info) \
1360 SymI_HasProto(stg_sel_2_noupd_info) \
1361 SymI_HasProto(stg_sel_3_noupd_info) \
1362 SymI_HasProto(stg_sel_4_noupd_info) \
1363 SymI_HasProto(stg_sel_5_noupd_info) \
1364 SymI_HasProto(stg_sel_6_noupd_info) \
1365 SymI_HasProto(stg_sel_7_noupd_info) \
1366 SymI_HasProto(stg_sel_8_noupd_info) \
1367 SymI_HasProto(stg_sel_9_noupd_info) \
1368 SymI_HasProto(stg_sel_10_noupd_info) \
1369 SymI_HasProto(stg_sel_11_noupd_info) \
1370 SymI_HasProto(stg_sel_12_noupd_info) \
1371 SymI_HasProto(stg_sel_13_noupd_info) \
1372 SymI_HasProto(stg_sel_14_noupd_info) \
1373 SymI_HasProto(stg_sel_15_noupd_info) \
1374 SymI_HasProto(stg_upd_frame_info) \
1375 SymI_HasProto(stg_bh_upd_frame_info) \
1376 SymI_HasProto(suspendThread) \
1377 SymI_HasProto(stg_takeMVarzh) \
1378 SymI_HasProto(stg_readMVarzh) \
1379 SymI_HasProto(stg_threadStatuszh) \
1380 SymI_HasProto(stg_tryPutMVarzh) \
1381 SymI_HasProto(stg_tryTakeMVarzh) \
1382 SymI_HasProto(stg_tryReadMVarzh) \
1383 SymI_HasProto(stg_unmaskAsyncExceptionszh) \
1384 SymI_HasProto(unloadObj) \
1385 SymI_HasProto(stg_unsafeThawArrayzh) \
1386 SymI_HasProto(stg_waitReadzh) \
1387 SymI_HasProto(stg_waitWritezh) \
1388 SymI_HasProto(stg_writeTVarzh) \
1389 SymI_HasProto(stg_yieldzh) \
1390 SymI_NeedsProto(stg_interp_constr_entry) \
1391 SymI_HasProto(stg_arg_bitmaps) \
1392 SymI_HasProto(large_alloc_lim) \
1393 SymI_HasProto(g0) \
1394 SymI_HasProto(allocate) \
1395 SymI_HasProto(allocateExec) \
1396 SymI_HasProto(flushExec) \
1397 SymI_HasProto(freeExec) \
1398 SymI_HasProto(getAllocations) \
1399 SymI_HasProto(revertCAFs) \
1400 SymI_HasProto(RtsFlags) \
1401 SymI_NeedsProto(rts_breakpoint_io_action) \
1402 SymI_NeedsProto(rts_stop_next_breakpoint) \
1403 SymI_NeedsProto(rts_stop_on_exception) \
1404 SymI_HasProto(stopTimer) \
1405 SymI_HasProto(n_capabilities) \
1406 SymI_HasProto(enabled_capabilities) \
1407 SymI_HasProto(stg_traceCcszh) \
1408 SymI_HasProto(stg_traceEventzh) \
1409 SymI_HasProto(stg_traceMarkerzh) \
1410 SymI_HasProto(getMonotonicNSec) \
1411 SymI_HasProto(lockFile) \
1412 SymI_HasProto(unlockFile) \
1413 SymI_HasProto(startProfTimer) \
1414 SymI_HasProto(stopProfTimer) \
1415 SymI_HasProto(atomic_inc) \
1416 SymI_HasProto(atomic_dec) \
1417 RTS_USER_SIGNALS_SYMBOLS \
1418 RTS_INTCHAR_SYMBOLS
1419
1420
1421 // 64-bit support functions in libgcc.a
1422 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4 && !defined(_ABIN32)
1423 #define RTS_LIBGCC_SYMBOLS \
1424 SymI_NeedsProto(__divdi3) \
1425 SymI_NeedsProto(__udivdi3) \
1426 SymI_NeedsProto(__moddi3) \
1427 SymI_NeedsProto(__umoddi3) \
1428 SymI_NeedsProto(__muldi3) \
1429 SymI_NeedsProto(__ashldi3) \
1430 SymI_NeedsProto(__ashrdi3) \
1431 SymI_NeedsProto(__lshrdi3) \
1432 SymI_NeedsProto(__fixunsdfdi)
1433 #else
1434 #define RTS_LIBGCC_SYMBOLS
1435 #endif
1436
1437 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
1438 // Symbols that don't have a leading underscore
1439 // on Mac OS X. They have to receive special treatment,
1440 // see machoInitSymbolsWithoutUnderscore()
1441 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
1442 SymI_NeedsProto(saveFP) \
1443 SymI_NeedsProto(restFP)
1444 #endif
1445
1446 /* entirely bogus claims about types of these symbols */
1447 #define SymI_NeedsProto(vvv) extern void vvv(void);
1448 #if defined(COMPILING_WINDOWS_DLL)
1449 #define SymE_HasProto(vvv) SymE_HasProto(vvv);
1450 # if defined(x86_64_HOST_ARCH)
1451 # define SymE_NeedsProto(vvv) extern void __imp_ ## vvv (void);
1452 # else
1453 # define SymE_NeedsProto(vvv) extern void _imp__ ## vvv (void);
1454 # endif
1455 #else
1456 #define SymE_NeedsProto(vvv) SymI_NeedsProto(vvv);
1457 #define SymE_HasProto(vvv) SymI_HasProto(vvv)
1458 #endif
1459 #define SymI_HasProto(vvv) /**/
1460 #define SymI_HasProto_redirect(vvv,xxx) /**/
1461 RTS_SYMBOLS
1462 RTS_RET_SYMBOLS
1463 RTS_POSIX_ONLY_SYMBOLS
1464 RTS_MINGW_ONLY_SYMBOLS
1465 RTS_CYGWIN_ONLY_SYMBOLS
1466 RTS_DARWIN_ONLY_SYMBOLS
1467 RTS_LIBGCC_SYMBOLS
1468 RTS_LIBFFI_SYMBOLS
1469 #undef SymI_NeedsProto
1470 #undef SymI_HasProto
1471 #undef SymI_HasProto_redirect
1472 #undef SymE_HasProto
1473 #undef SymE_NeedsProto
1474
1475 #ifdef LEADING_UNDERSCORE
1476 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
1477 #else
1478 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
1479 #endif
1480
1481 #define SymI_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1482 (void*)(&(vvv)) },
1483 #define SymE_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1484 (void*)DLL_IMPORT_DATA_REF(vvv) },
1485
1486 #define SymI_NeedsProto(vvv) SymI_HasProto(vvv)
1487 #define SymE_NeedsProto(vvv) SymE_HasProto(vvv)
1488
1489 // SymI_HasProto_redirect allows us to redirect references to one symbol to
1490 // another symbol. See newCAF/newDynCAF for an example.
1491 #define SymI_HasProto_redirect(vvv,xxx) \
1492 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1493 (void*)(&(xxx)) },
1494
1495 static RtsSymbolVal rtsSyms[] = {
1496 RTS_SYMBOLS
1497 RTS_RET_SYMBOLS
1498 RTS_POSIX_ONLY_SYMBOLS
1499 RTS_MINGW_ONLY_SYMBOLS
1500 RTS_CYGWIN_ONLY_SYMBOLS
1501 RTS_DARWIN_ONLY_SYMBOLS
1502 RTS_LIBGCC_SYMBOLS
1503 RTS_LIBFFI_SYMBOLS
1504 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
1505 // dyld stub code contains references to this,
1506 // but it should never be called because we treat
1507 // lazy pointers as nonlazy.
1508 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
1509 #endif
1510 { 0, 0 } /* sentinel */
1511 };
1512
1513
1514 /* -----------------------------------------------------------------------------
1515 * Insert symbols into hash tables, checking for duplicates.
1516 *
1517 * Returns: 0 on failure, nonzero on success
1518 */
1519
1520 static int ghciInsertSymbolTable(
1521 pathchar* obj_name,
1522 HashTable *table,
1523 char* key,
1524 void *data,
1525 HsBool weak,
1526 ObjectCode *owner)
1527 {
1528 RtsSymbolInfo *pinfo = lookupStrHashTable(table, key);
1529 if (!pinfo) /* new entry */
1530 {
1531 pinfo = stgMallocBytes(sizeof (*pinfo), "ghciInsertToSymbolTable");
1532 pinfo->value = data;
1533 pinfo->owner = owner;
1534 pinfo->weak = weak;
1535 insertStrHashTable(table, key, pinfo);
1536 return 1;
1537 }
1538 else if ((!pinfo->weak || pinfo->value) && weak)
1539 {
1540 return 1; /* duplicate weak symbol, throw it away */
1541 }
1542 else if (pinfo->weak) /* weak symbol is in the table */
1543 {
1544 /* override the weak definition with the non-weak one */
1545 pinfo->value = data;
1546 pinfo->owner = owner;
1547 pinfo->weak = HS_BOOL_FALSE;
1548 return 1;
1549 }
1550 debugBelch(
1551 "GHC runtime linker: fatal error: I found a duplicate definition for symbol\n"
1552 " %s\n"
1553 "whilst processing object file\n"
1554 " %" PATH_FMT "\n"
1555 "This could be caused by:\n"
1556 " * Loading two different object files which export the same symbol\n"
1557 " * Specifying the same object file twice on the GHCi command line\n"
1558 " * An incorrect `package.conf' entry, causing some object to be\n"
1559 " loaded twice.\n",
1560 (char*)key,
1561 obj_name
1562 );
1563 return 0;
1564 }
1565
1566 static HsBool ghciLookupSymbolTable(HashTable *table,
1567 const char *key, void **result)
1568 {
1569 RtsSymbolInfo *pinfo = lookupStrHashTable(table, key);
1570 if (!pinfo) {
1571 *result = NULL;
1572 return HS_BOOL_FALSE;
1573 }
1574 if (pinfo->weak)
1575 IF_DEBUG(linker, debugBelch("lookup: promoting %s\n", key));
1576 /* Once it's looked up, it can no longer be overridden */
1577 pinfo->weak = HS_BOOL_FALSE;
1578
1579 *result = pinfo->value;
1580 return HS_BOOL_TRUE;
1581 }
1582
1583 static void ghciRemoveSymbolTable(HashTable *table, const char *key,
1584 ObjectCode *owner)
1585 {
1586 RtsSymbolInfo *pinfo = lookupStrHashTable(table, key);
1587 if (!pinfo || owner != pinfo->owner) return;
1588 removeStrHashTable(table, key, NULL);
1589 stgFree(pinfo);
1590 }
1591 /* -----------------------------------------------------------------------------
1592 * initialize the object linker
1593 */
1594
1595
1596 static int linker_init_done = 0 ;
1597
1598 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1599 static void *dl_prog_handle;
1600 static regex_t re_invalid;
1601 static regex_t re_realso;
1602 #ifdef THREADED_RTS
1603 static Mutex dl_mutex; // mutex to protect dlopen/dlerror critical section
1604 #endif
1605 #elif defined(OBJFORMAT_PEi386)
1606 void addDLLHandle(pathchar* dll_name, HINSTANCE instance);
1607 #endif
1608
1609 void initLinker (void)
1610 {
1611 // default to retaining CAFs for backwards compatibility. Most
1612 // users will want initLinker_(0): otherwise unloadObj() will not
1613 // be able to unload object files when they contain CAFs.
1614 initLinker_(1);
1615 }
1616
1617 void
1618 initLinker_ (int retain_cafs)
1619 {
1620 RtsSymbolVal *sym;
1621 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1622 int compileResult;
1623 #endif
1624
1625 IF_DEBUG(linker, debugBelch("initLinker: start\n"));
1626
1627 /* Make initLinker idempotent, so we can call it
1628 before every relevant operation; that means we
1629 don't need to initialise the linker separately */
1630 if (linker_init_done == 1) {
1631 IF_DEBUG(linker, debugBelch("initLinker: idempotent return\n"));
1632 return;
1633 } else {
1634 linker_init_done = 1;
1635 }
1636
1637 objects = NULL;
1638 unloaded_objects = NULL;
1639
1640 #if defined(THREADED_RTS) && (defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO))
1641 initMutex(&dl_mutex);
1642 #endif
1643 symhash = allocStrHashTable();
1644
1645 /* populate the symbol table with stuff from the RTS */
1646 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
1647 if (! ghciInsertSymbolTable(WSTR("(GHCi built-in symbols)"),
1648 symhash, sym->lbl, sym->addr, HS_BOOL_FALSE, NULL)) {
1649 barf("ghciInsertSymbolTable failed");
1650 }
1651 IF_DEBUG(linker, debugBelch("initLinker: inserting rts symbol %s, %p\n", sym->lbl, sym->addr));
1652 }
1653 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
1654 machoInitSymbolsWithoutUnderscore();
1655 # endif
1656 /* GCC defines a special symbol __dso_handle which is resolved to NULL if
1657 referenced from a statically linked module. We need to mimic this, but
1658 we cannot use NULL because we use it to mean nonexistent symbols. So we
1659 use an arbitrary (hopefully unique) address here.
1660 */
1661 if (! ghciInsertSymbolTable(WSTR("(GHCi special symbols)"),
1662 symhash, "__dso_handle", (void *)0x12345687, HS_BOOL_FALSE, NULL)) {
1663 barf("ghciInsertSymbolTable failed");
1664 }
1665
1666 // Redurect newCAF to newDynCAF if retain_cafs is true.
1667 if (! ghciInsertSymbolTable(WSTR("(GHCi built-in symbols)"), symhash,
1668 MAYBE_LEADING_UNDERSCORE_STR("newCAF"),
1669 retain_cafs ? newDynCAF : newCAF,
1670 HS_BOOL_FALSE, NULL)) {
1671 barf("ghciInsertSymbolTable failed");
1672 }
1673
1674 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1675 # if defined(RTLD_DEFAULT)
1676 dl_prog_handle = RTLD_DEFAULT;
1677 # else
1678 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
1679 # endif /* RTLD_DEFAULT */
1680
1681 compileResult = regcomp(&re_invalid,
1682 "(([^ \t()])+\\.so([^ \t:()])*):([ \t])*(invalid ELF header|file too short)",
1683 REG_EXTENDED);
1684 if (compileResult != 0) {
1685 barf("Compiling re_invalid failed");
1686 }
1687 compileResult = regcomp(&re_realso,
1688 "(GROUP|INPUT) *\\( *([^ )]+)",
1689 REG_EXTENDED);
1690 if (compileResult != 0) {
1691 barf("Compiling re_realso failed");
1692 }
1693 # endif
1694
1695 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
1696 if (RtsFlags.MiscFlags.linkerMemBase != 0) {
1697 // User-override for mmap_32bit_base
1698 mmap_32bit_base = (void*)RtsFlags.MiscFlags.linkerMemBase;
1699 }
1700 #endif
1701
1702 #if defined(mingw32_HOST_OS)
1703 /*
1704 * These two libraries cause problems when added to the static link,
1705 * but are necessary for resolving symbols in GHCi, hence we load
1706 * them manually here.
1707 */
1708 addDLL(WSTR("msvcrt"));
1709 addDLL(WSTR("kernel32"));
1710 addDLLHandle(WSTR("*.exe"), GetModuleHandle(NULL));
1711 #endif
1712
1713 IF_DEBUG(linker, debugBelch("initLinker: done\n"));
1714 return;
1715 }
1716
1717 void
1718 exitLinker( void ) {
1719 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1720 if (linker_init_done == 1) {
1721 regfree(&re_invalid);
1722 regfree(&re_realso);
1723 #ifdef THREADED_RTS
1724 closeMutex(&dl_mutex);
1725 #endif
1726 }
1727 #endif
1728 if (linker_init_done == 1) {
1729 freeHashTable(symhash, free);
1730 }
1731 }
1732
1733 /* -----------------------------------------------------------------------------
1734 * Loading DLL or .so dynamic libraries
1735 * -----------------------------------------------------------------------------
1736 *
1737 * Add a DLL from which symbols may be found. In the ELF case, just
1738 * do RTLD_GLOBAL-style add, so no further messing around needs to
1739 * happen in order that symbols in the loaded .so are findable --
1740 * lookupSymbol() will subsequently see them by dlsym on the program's
1741 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
1742 *
1743 * In the PEi386 case, open the DLLs and put handles to them in a
1744 * linked list. When looking for a symbol, try all handles in the
1745 * list. This means that we need to load even DLLs that are guaranteed
1746 * to be in the ghc.exe image already, just so we can get a handle
1747 * to give to loadSymbol, so that we can find the symbols. For such
1748 * libraries, the LoadLibrary call should be a no-op except for returning
1749 * the handle.
1750 *
1751 */
1752
1753 #if defined(OBJFORMAT_PEi386)
1754 /* A record for storing handles into DLLs. */
1755
1756 typedef
1757 struct _OpenedDLL {
1758 pathchar* name;
1759 struct _OpenedDLL* next;
1760 HINSTANCE instance;
1761 }
1762 OpenedDLL;
1763
1764 /* A list thereof. */
1765 static OpenedDLL* opened_dlls = NULL;
1766
1767 /* A record for storing indirectly linked functions from DLLs. */
1768 typedef
1769 struct _IndirectAddr {
1770 void* addr;
1771 struct _IndirectAddr* next;
1772 }
1773 IndirectAddr;
1774
1775 /* A list thereof. */
1776 static IndirectAddr* indirects = NULL;
1777
1778 /* Adds a DLL instance to the list of DLLs in which to search for symbols. */
1779 void addDLLHandle(pathchar* dll_name, HINSTANCE instance) {
1780 OpenedDLL* o_dll;
1781 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLLHandle" );
1782 o_dll->name = dll_name ? pathdup(dll_name) : NULL;
1783 o_dll->instance = instance;
1784 o_dll->next = opened_dlls;
1785 opened_dlls = o_dll;
1786 }
1787
1788 #endif
1789
1790 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1791
1792 /* Suppose in ghci we load a temporary SO for a module containing
1793 f = 1
1794 and then modify the module, recompile, and load another temporary
1795 SO with
1796 f = 2
1797 Then as we don't unload the first SO, dlsym will find the
1798 f = 1
1799 symbol whereas we want the
1800 f = 2
1801 symbol. We therefore need to keep our own SO handle list, and
1802 try SOs in the right order. */
1803
1804 typedef
1805 struct _OpenedSO {
1806 struct _OpenedSO* next;
1807 void *handle;
1808 }
1809 OpenedSO;
1810
1811 /* A list thereof. */
1812 static OpenedSO* openedSOs = NULL;
1813
1814 static const char *
1815 internal_dlopen(const char *dll_name)
1816 {
1817 OpenedSO* o_so;
1818 void *hdl;
1819 const char *errmsg;
1820 char *errmsg_copy;
1821
1822 // omitted: RTLD_NOW
1823 // see http://www.haskell.org/pipermail/cvs-ghc/2007-September/038570.html
1824 IF_DEBUG(linker,
1825 debugBelch("internal_dlopen: dll_name = '%s'\n", dll_name));
1826
1827 //-------------- Begin critical section ------------------
1828 // This critical section is necessary because dlerror() is not
1829 // required to be reentrant (see POSIX -- IEEE Std 1003.1-2008)
1830 // Also, the error message returned must be copied to preserve it
1831 // (see POSIX also)
1832
1833 ACQUIRE_LOCK(&dl_mutex);
1834 hdl = dlopen(dll_name, RTLD_LAZY|RTLD_LOCAL); /* see Note [RTLD_LOCAL] */
1835
1836 errmsg = NULL;
1837 if (hdl == NULL) {
1838 /* dlopen failed; return a ptr to the error msg. */
1839 errmsg = dlerror();
1840 if (errmsg == NULL) errmsg = "addDLL: unknown error";
1841 errmsg_copy = stgMallocBytes(strlen(errmsg)+1, "addDLL");
1842 strcpy(errmsg_copy, errmsg);
1843 errmsg = errmsg_copy;
1844 } else {
1845 o_so = stgMallocBytes(sizeof(OpenedSO), "addDLL");
1846 o_so->handle = hdl;
1847 o_so->next = openedSOs;
1848 openedSOs = o_so;
1849 }
1850
1851 RELEASE_LOCK(&dl_mutex);
1852 //--------------- End critical section -------------------
1853
1854 return errmsg;
1855 }
1856
1857 /*
1858 Note [RTLD_LOCAL]
1859
1860 In GHCi we want to be able to override previous .so's with newly
1861 loaded .so's when we recompile something. This further implies that
1862 when we look up a symbol in internal_dlsym() we have to iterate
1863 through the loaded libraries (in order from most recently loaded to
1864 oldest) looking up the symbol in each one until we find it.
1865
1866 However, this can cause problems for some symbols that are copied
1867 by the linker into the executable image at runtime - see #8935 for a
1868 lengthy discussion. To solve that problem we need to look up
1869 symbols in the main executable *first*, before attempting to look
1870 them up in the loaded .so's. But in order to make that work, we
1871 have to always call dlopen with RTLD_LOCAL, so that the loaded
1872 libraries don't populate the global symbol table.
1873 */
1874
1875 static void *
1876 internal_dlsym(const char *symbol) {
1877 OpenedSO* o_so;
1878 void *v;
1879
1880 // We acquire dl_mutex as concurrent dl* calls may alter dlerror
1881 ACQUIRE_LOCK(&dl_mutex);
1882 dlerror();
1883 // look in program first
1884 v = dlsym(dl_prog_handle, symbol);
1885 if (dlerror() == NULL) {
1886 RELEASE_LOCK(&dl_mutex);
1887 return v;
1888 }
1889
1890 for (o_so = openedSOs; o_so != NULL; o_so = o_so->next) {
1891 v = dlsym(o_so->handle, symbol);
1892 if (dlerror() == NULL) {
1893 RELEASE_LOCK(&dl_mutex);
1894 return v;
1895 }
1896 }
1897 RELEASE_LOCK(&dl_mutex);
1898 return v;
1899 }
1900 # endif
1901
1902 const char *
1903 addDLL( pathchar *dll_name )
1904 {
1905 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1906 /* ------------------- ELF DLL loader ------------------- */
1907
1908 #define NMATCH 5
1909 regmatch_t match[NMATCH];
1910 const char *errmsg;
1911 FILE* fp;
1912 size_t match_length;
1913 #define MAXLINE 1000
1914 char line[MAXLINE];
1915 int result;
1916
1917 initLinker();
1918
1919 IF_DEBUG(linker, debugBelch("addDLL: dll_name = '%s'\n", dll_name));
1920 errmsg = internal_dlopen(dll_name);
1921
1922 if (errmsg == NULL) {
1923 return NULL;
1924 }
1925
1926 // GHC Trac ticket #2615
1927 // On some systems (e.g., Gentoo Linux) dynamic files (e.g. libc.so)
1928 // contain linker scripts rather than ELF-format object code. This
1929 // code handles the situation by recognizing the real object code
1930 // file name given in the linker script.
1931 //
1932 // If an "invalid ELF header" error occurs, it is assumed that the
1933 // .so file contains a linker script instead of ELF object code.
1934 // In this case, the code looks for the GROUP ( ... ) linker
1935 // directive. If one is found, the first file name inside the
1936 // parentheses is treated as the name of a dynamic library and the
1937 // code attempts to dlopen that file. If this is also unsuccessful,
1938 // an error message is returned.
1939
1940 // see if the error message is due to an invalid ELF header
1941 IF_DEBUG(linker, debugBelch("errmsg = '%s'\n", errmsg));
1942 result = regexec(&re_invalid, errmsg, (size_t) NMATCH, match, 0);
1943 IF_DEBUG(linker, debugBelch("result = %i\n", result));
1944 if (result == 0) {
1945 // success -- try to read the named file as a linker script
1946 match_length = (size_t) stg_min((match[1].rm_eo - match[1].rm_so),
1947 MAXLINE-1);
1948 strncpy(line, (errmsg+(match[1].rm_so)),match_length);
1949 line[match_length] = '\0'; // make sure string is null-terminated
1950 IF_DEBUG(linker, debugBelch ("file name = '%s'\n", line));
1951 if ((fp = fopen(line, "r")) == NULL) {
1952 return errmsg; // return original error if open fails
1953 }
1954 // try to find a GROUP or INPUT ( ... ) command
1955 while (fgets(line, MAXLINE, fp) != NULL) {
1956 IF_DEBUG(linker, debugBelch("input line = %s", line));
1957 if (regexec(&re_realso, line, (size_t) NMATCH, match, 0) == 0) {
1958 // success -- try to dlopen the first named file
1959 IF_DEBUG(linker, debugBelch("match%s\n",""));
1960 line[match[2].rm_eo] = '\0';
1961 stgFree((void*)errmsg); // Free old message before creating new one
1962 errmsg = internal_dlopen(line+match[2].rm_so);
1963 break;
1964 }
1965 // if control reaches here, no GROUP or INPUT ( ... ) directive
1966 // was found and the original error message is returned to the
1967 // caller
1968 }
1969 fclose(fp);
1970 }
1971 return errmsg;
1972
1973 # elif defined(OBJFORMAT_PEi386)
1974 /* ------------------- Win32 DLL loader ------------------- */
1975
1976 pathchar* buf;
1977 OpenedDLL* o_dll;
1978 HINSTANCE instance;
1979
1980 initLinker();
1981
1982 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1983
1984 /* See if we've already got it, and ignore if so. */
1985 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1986 if (0 == pathcmp(o_dll->name, dll_name))
1987 return NULL;
1988 }
1989
1990 /* The file name has no suffix (yet) so that we can try
1991 both foo.dll and foo.drv
1992
1993 The documentation for LoadLibrary says:
1994 If no file name extension is specified in the lpFileName
1995 parameter, the default library extension .dll is
1996 appended. However, the file name string can include a trailing
1997 point character (.) to indicate that the module name has no
1998 extension. */
1999
2000 size_t bufsize = pathlen(dll_name) + 10;
2001 buf = stgMallocBytes(bufsize * sizeof(wchar_t), "addDLL");
2002 snwprintf(buf, bufsize, L"%s.DLL", dll_name);
2003 instance = LoadLibraryW(buf);
2004 if (instance == NULL) {
2005 if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
2006 // KAA: allow loading of drivers (like winspool.drv)
2007 snwprintf(buf, bufsize, L"%s.DRV", dll_name);
2008 instance = LoadLibraryW(buf);
2009 if (instance == NULL) {
2010 if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
2011 // #1883: allow loading of unix-style libfoo.dll DLLs
2012 snwprintf(buf, bufsize, L"lib%s.DLL", dll_name);
2013 instance = LoadLibraryW(buf);
2014 if (instance == NULL) {
2015 goto error;
2016 }
2017 }
2018 }
2019 stgFree(buf);
2020
2021 addDLLHandle(dll_name, instance);
2022
2023 return NULL;
2024
2025 error:
2026 stgFree(buf);
2027 sysErrorBelch("%" PATH_FMT, dll_name);
2028
2029 /* LoadLibrary failed; return a ptr to the error msg. */
2030 return "addDLL: could not load DLL";
2031
2032 # else
2033 barf("addDLL: not implemented on this platform");
2034 # endif
2035 }
2036
2037 /* -----------------------------------------------------------------------------
2038 * insert a symbol in the hash table
2039 *
2040 * Returns: 0 on failure, nozero on success
2041 */
2042 HsInt insertSymbol(pathchar* obj_name, char* key, void* data)
2043 {
2044 return ghciInsertSymbolTable(obj_name, symhash, key, data, HS_BOOL_FALSE, NULL);
2045 }
2046
2047 /* -----------------------------------------------------------------------------
2048 * lookup a symbol in the hash table
2049 */
2050 void *
2051 lookupSymbol( char *lbl )
2052 {
2053 void *val;
2054 IF_DEBUG(linker, debugBelch("lookupSymbol: looking up %s\n", lbl));
2055 initLinker() ;
2056 ASSERT(symhash != NULL);
2057
2058 if (!ghciLookupSymbolTable(symhash, lbl, &val)) {
2059 IF_DEBUG(linker, debugBelch("lookupSymbol: symbol not found\n"));
2060 # if defined(OBJFORMAT_ELF)
2061 return internal_dlsym(lbl);
2062 # elif defined(OBJFORMAT_MACHO)
2063 # if HAVE_DLFCN_H
2064 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
2065 interface.
2066
2067 HACK: On OS X, all symbols are prefixed with an underscore.
2068 However, dlsym wants us to omit the leading underscore from the
2069 symbol name -- the dlsym routine puts it back on before searching
2070 for the symbol. For now, we simply strip it off here (and ONLY
2071 here).
2072 */
2073 IF_DEBUG(linker, debugBelch("lookupSymbol: looking up %s with dlsym\n", lbl));
2074 ASSERT(lbl[0] == '_');
2075 return internal_dlsym(lbl + 1);
2076 # else
2077 if (NSIsSymbolNameDefined(lbl)) {
2078 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
2079 return NSAddressOfSymbol(symbol);
2080 } else {
2081 return NULL;
2082 }
2083 # endif /* HAVE_DLFCN_H */
2084 # elif defined(OBJFORMAT_PEi386)
2085 void* sym;
2086
2087 sym = lookupSymbolInDLLs((unsigned char*)lbl);
2088 if (sym != NULL) { return sym; };
2089
2090 // Also try looking up the symbol without the @N suffix. Some
2091 // DLLs have the suffixes on their symbols, some don't.
2092 zapTrailingAtSign ( (unsigned char*)lbl );
2093 sym = lookupSymbolInDLLs((unsigned char*)lbl);
2094 if (sym != NULL) { return sym; };
2095 return NULL;
2096
2097 # else
2098 ASSERT(2+2 == 5);
2099 return NULL;
2100 # endif
2101 } else {
2102 IF_DEBUG(linker, debugBelch("lookupSymbol: value of %s is %p\n", lbl, val));
2103 return val;
2104 }
2105 }
2106
2107 /* -----------------------------------------------------------------------------
2108 Create a StablePtr for a foreign export. This is normally called by
2109 a C function with __attribute__((constructor)), which is generated
2110 by GHC and linked into the module.
2111
2112 If the object code is being loaded dynamically, then we remember
2113 which StablePtrs were allocated by the constructors and free them
2114 again in unloadObj().
2115 -------------------------------------------------------------------------- */
2116
2117 static ObjectCode *loading_obj = NULL;
2118
2119 StgStablePtr foreignExportStablePtr (StgPtr p)
2120 {
2121 ForeignExportStablePtr *fe_sptr;
2122 StgStablePtr *sptr;
2123
2124 sptr = getStablePtr(p);
2125
2126 if (loading_obj != NULL) {
2127 fe_sptr = stgMallocBytes(sizeof(ForeignExportStablePtr),
2128 "foreignExportStablePtr");
2129 fe_sptr->stable_ptr = sptr;
2130 fe_sptr->next = loading_obj->stable_ptrs;
2131 loading_obj->stable_ptrs = fe_sptr;
2132 }
2133
2134 return sptr;
2135 }
2136
2137
2138 /* -----------------------------------------------------------------------------
2139 * Debugging aid: look in GHCi's object symbol tables for symbols
2140 * within DELTA bytes of the specified address, and show their names.
2141 */
2142 #ifdef DEBUG
2143 void ghci_enquire ( char* addr );
2144
2145 void ghci_enquire ( char* addr )
2146 {
2147 int i;
2148 char* sym;
2149 char* a;
2150 const int DELTA = 64;
2151 ObjectCode* oc;
2152
2153 initLinker();
2154
2155 for (oc = objects; oc; oc = oc->next) {
2156 for (i = 0; i < oc->n_symbols; i++) {
2157 sym = oc->symbols[i];
2158 if (sym == NULL) continue;
2159 a = NULL;
2160 if (a == NULL) {
2161 ghciLookupSymbolTable(symhash, sym, (void **)&a);
2162 }
2163 if (a == NULL) {
2164 // debugBelch("ghci_enquire: can't find %s\n", sym);
2165 }
2166 else if (addr-DELTA <= a && a <= addr+DELTA) {
2167 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
2168 }
2169 }
2170 }
2171 }
2172 #endif
2173
2174 #ifdef USE_MMAP
2175 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
2176
2177 //
2178 // Returns NULL on failure.
2179 //
2180 static void * mmapForLinker (size_t bytes, nat flags, int fd)
2181 {
2182 void *map_addr = NULL;
2183 void *result;
2184 int pagesize;
2185 StgWord size;
2186 static nat fixed = 0;
2187
2188 IF_DEBUG(linker, debugBelch("mmapForLinker: start\n"));
2189 pagesize = getpagesize();
2190 size = ROUND_UP(bytes, pagesize);
2191
2192 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
2193 mmap_again:
2194
2195 if (mmap_32bit_base != 0) {
2196 map_addr = mmap_32bit_base;
2197 }
2198 #endif
2199
2200 IF_DEBUG(linker,
2201 debugBelch("mmapForLinker: \tprotection %#0x\n",
2202 PROT_EXEC | PROT_READ | PROT_WRITE));
2203 IF_DEBUG(linker,
2204 debugBelch("mmapForLinker: \tflags %#0x\n",
2205 MAP_PRIVATE | TRY_MAP_32BIT | fixed | flags));
2206
2207 result = mmap(map_addr, size,
2208 PROT_EXEC|PROT_READ|PROT_WRITE,
2209 MAP_PRIVATE|TRY_MAP_32BIT|fixed|flags, fd, 0);
2210
2211 if (result == MAP_FAILED) {
2212 sysErrorBelch("mmap %" FMT_Word " bytes at %p",(W_)size,map_addr);
2213 errorBelch("Try specifying an address with +RTS -xm<addr> -RTS");
2214 return NULL;
2215 }
2216
2217 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
2218 if (mmap_32bit_base != 0) {
2219 if (result == map_addr) {
2220 mmap_32bit_base = (StgWord8*)map_addr + size;
2221 } else {
2222 if ((W_)result > 0x80000000) {
2223 // oops, we were given memory over 2Gb
2224 munmap(result,size);
2225 #if defined(freebsd_HOST_OS) || \
2226 defined(kfreebsdgnu_HOST_OS) || \
2227 defined(dragonfly_HOST_OS)
2228 // Some platforms require MAP_FIXED. This is normally
2229 // a bad idea, because MAP_FIXED will overwrite
2230 // existing mappings.
2231 fixed = MAP_FIXED;
2232 goto mmap_again;
2233 #else
2234 errorBelch("loadObj: failed to mmap() memory below 2Gb; "
2235 "asked for %lu bytes at %p. "
2236 "Try specifying an address with +RTS -xm<addr> -RTS",
2237 size, map_addr);
2238 return NULL;
2239 #endif
2240 } else {
2241 // hmm, we were given memory somewhere else, but it's
2242 // still under 2Gb so we can use it. Next time, ask
2243 // for memory right after the place we just got some
2244 mmap_32bit_base = (StgWord8*)result + size;
2245 }
2246 }
2247 } else {
2248 if ((W_)result > 0x80000000) {
2249 // oops, we were given memory over 2Gb
2250 // ... try allocating memory somewhere else?;
2251 debugTrace(DEBUG_linker,
2252 "MAP_32BIT didn't work; gave us %lu bytes at 0x%p",
2253 bytes, result);
2254 munmap(result, size);
2255
2256 // Set a base address and try again... (guess: 1Gb)
2257 mmap_32bit_base = (void*)0x40000000;
2258 goto mmap_again;
2259 }
2260 }
2261 #endif
2262
2263 IF_DEBUG(linker,
2264 debugBelch("mmapForLinker: mapped %" FMT_Word
2265 " bytes starting at %p\n", (W_)size, result));
2266 IF_DEBUG(linker,
2267 debugBelch("mmapForLinker: done\n"));
2268
2269 return result;
2270 }
2271 #endif // USE_MMAP
2272
2273 static void removeOcSymbols (ObjectCode *oc)
2274 {
2275 if (oc->symbols == NULL) return;
2276
2277 /* Remove all the mappings for the symbols within this object..
2278 */
2279 int i;
2280 for (i = 0; i < oc->n_symbols; i++) {
2281 if (oc->symbols[i] != NULL) {
2282 ghciRemoveSymbolTable(symhash, oc->symbols[i], oc);
2283 }
2284 }
2285 }
2286
2287 /*
2288 * freeObjectCode() releases all the pieces of an ObjectCode. It is called by
2289 * the GC when a previously unloaded ObjectCode has been determined to be
2290 * unused, and when an error occurs during loadObj().
2291 */
2292 void freeObjectCode (ObjectCode *oc)
2293 {
2294 if (oc->symbols != NULL) {
2295 stgFree(oc->symbols);
2296 oc->symbols = NULL;
2297 }
2298
2299 {
2300 Section *s, *nexts;
2301
2302 for (s = oc->sections; s != NULL; s = nexts) {
2303 nexts = s->next;
2304 stgFree(s);
2305 }
2306 }
2307
2308 freeProddableBlocks(oc);
2309
2310 #ifdef USE_MMAP
2311 int pagesize, size, r;
2312
2313 pagesize = getpagesize();
2314 size = ROUND_UP(oc->fileSize, pagesize);
2315
2316 r = munmap(oc->image, size);
2317 if (r == -1) {
2318 sysErrorBelch("munmap");
2319 }
2320
2321 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
2322 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
2323 if (!USE_CONTIGUOUS_MMAP && oc->symbol_extras != NULL)
2324 {
2325 munmap(oc->symbol_extras,
2326 ROUND_UP(sizeof(SymbolExtra) * oc->n_symbol_extras, pagesize));
2327 }
2328 #endif
2329 #endif
2330
2331 #else
2332
2333 #ifndef mingw32_HOST_OS
2334 stgFree(oc->image);
2335 #else
2336 VirtualFree(oc->image - PEi386_IMAGE_OFFSET, 0, MEM_RELEASE);
2337
2338 IndirectAddr *ia, *ia_next;
2339 ia = indirects;
2340 while (ia != NULL) {
2341 ia_next = ia->next;
2342 stgFree(ia);
2343 ia = ia_next;
2344 }
2345
2346 #endif
2347
2348 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
2349 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
2350 stgFree(oc->symbol_extras);
2351 #endif
2352 #endif
2353
2354 #endif
2355
2356 stgFree(oc->fileName);
2357 stgFree(oc->archiveMemberName);
2358 stgFree(oc);
2359 }
2360
2361
2362 static ObjectCode*
2363 mkOc( pathchar *path, char *image, int imageSize,
2364 char *archiveMemberName
2365 #ifndef USE_MMAP
2366 #ifdef darwin_HOST_OS
2367 , int misalignment
2368 #endif
2369 #endif
2370 ) {
2371 ObjectCode* oc;
2372
2373 IF_DEBUG(linker, debugBelch("mkOc: start\n"));
2374 oc = stgMallocBytes(sizeof(ObjectCode), "mkOc(oc)");
2375
2376 # if defined(OBJFORMAT_ELF)
2377 oc->formatName = "ELF";
2378 # elif defined(OBJFORMAT_PEi386)
2379 oc->formatName = "PEi386";
2380 # elif defined(OBJFORMAT_MACHO)
2381 oc->formatName = "Mach-O";
2382 # else
2383 stgFree(oc);
2384 barf("loadObj: not implemented on this platform");
2385 # endif
2386
2387 oc->image = image;
2388 oc->fileName = pathdup(path);
2389
2390 if (archiveMemberName) {
2391 oc->archiveMemberName = stgMallocBytes( strlen(archiveMemberName)+1, "loadObj" );
2392 strcpy(oc->archiveMemberName, archiveMemberName);
2393 }
2394 else {
2395 oc->archiveMemberName = NULL;
2396 }
2397
2398 oc->fileSize = imageSize;
2399 oc->symbols = NULL;
2400 oc->sections = NULL;
2401 oc->proddables = NULL;
2402 oc->stable_ptrs = NULL;
2403 #if powerpc_HOST_ARCH || x86_64_HOST_ARCH || arm_HOST_ARCH
2404 oc->symbol_extras = NULL;
2405 #endif
2406
2407 #ifndef USE_MMAP
2408 #ifdef darwin_HOST_OS
2409 oc->misalignment = misalignment;
2410 #endif
2411 #endif
2412
2413 /* chain it onto the list of objects */
2414 oc->next = NULL;
2415
2416 IF_DEBUG(linker, debugBelch("mkOc: done\n"));
2417 return oc;
2418 }
2419
2420 /* -----------------------------------------------------------------------------
2421 * Check if an object or archive is already loaded.
2422 *
2423 * Returns: 1 if the path is already loaded, 0 otherwise.
2424 */
2425 static HsInt
2426 isAlreadyLoaded( pathchar *path )
2427 {
2428 ObjectCode *o;
2429 for (o = objects; o; o = o->next) {
2430 if (0 == pathcmp(o->fileName, path)) {
2431 return 1; /* already loaded */
2432 }
2433 }
2434 return 0; /* not loaded yet */
2435 }
2436
2437 HsInt
2438 loadArchive( pathchar *path )
2439 {
2440 ObjectCode* oc;
2441 char *image;
2442 int memberSize;
2443 FILE *f;
2444 int n;
2445 size_t thisFileNameSize;
2446 char *fileName;
2447 size_t fileNameSize;
2448 int isObject, isGnuIndex, isThin;
2449 char tmp[20];
2450 char *gnuFileIndex;
2451 int gnuFileIndexSize;
2452 #if defined(darwin_HOST_OS)
2453 int i;
2454 uint32_t nfat_arch, nfat_offset, cputype, cpusubtype;
2455 #if defined(i386_HOST_ARCH)
2456 const uint32_t mycputype = CPU_TYPE_X86;
2457 const uint32_t mycpusubtype = CPU_SUBTYPE_X86_ALL;
2458 #elif defined(x86_64_HOST_ARCH)
2459 const uint32_t mycputype = CPU_TYPE_X86_64;
2460 const uint32_t mycpusubtype = CPU_SUBTYPE_X86_64_ALL;
2461 #elif defined(powerpc_HOST_ARCH)
2462 const uint32_t mycputype = CPU_TYPE_POWERPC;
2463 const uint32_t mycpusubtype = CPU_SUBTYPE_POWERPC_ALL;
2464 #elif defined(powerpc64_HOST_ARCH)
2465 const uint32_t mycputype = CPU_TYPE_POWERPC64;
2466 const uint32_t mycpusubtype = CPU_SUBTYPE_POWERPC_ALL;
2467 #else
2468 #error Unknown Darwin architecture
2469 #endif
2470 #if !defined(USE_MMAP)
2471 int misalignment;
2472 #endif
2473 #endif
2474
2475 /* TODO: don't call barf() on error, instead return an error code, freeing
2476 * all resources correctly. This function is pretty complex, so it needs
2477 * to be refactored to make this practical. */
2478
2479 initLinker();
2480
2481 IF_DEBUG(linker, debugBelch("loadArchive: start\n"));
2482 IF_DEBUG(linker, debugBelch("loadArchive: Loading archive `%" PATH_FMT" '\n", path));
2483
2484 /* Check that we haven't already loaded this archive.
2485 Ignore requests to load multiple times */
2486 if (isAlreadyLoaded(path)) {
2487 IF_DEBUG(linker,
2488 debugBelch("ignoring repeated load of %" PATH_FMT "\n", path));
2489 return 1; /* success */
2490 }
2491
2492 gnuFileIndex = NULL;
2493 gnuFileIndexSize = 0;
2494
2495 fileNameSize = 32;
2496 fileName = stgMallocBytes(fileNameSize, "loadArchive(fileName)");
2497
2498 isThin = 0;
2499
2500 f = pathopen(path, WSTR("rb"));
2501 if (!f)
2502 barf("loadObj: can't read `%s'", path);
2503
2504 /* Check if this is an archive by looking for the magic "!<arch>\n"
2505 * string. Usually, if this fails, we barf and quit. On Darwin however,
2506 * we may have a fat archive, which contains archives for more than
2507 * one architecture. Fat archives start with the magic number 0xcafebabe,
2508 * always stored big endian. If we find a fat_header, we scan through
2509 * the fat_arch structs, searching through for one for our host
2510 * architecture. If a matching struct is found, we read the offset
2511 * of our archive data (nfat_offset) and seek forward nfat_offset bytes
2512 * from the start of the file.
2513 *
2514 * A subtlety is that all of the members of the fat_header and fat_arch
2515 * structs are stored big endian, so we need to call byte order
2516 * conversion functions.
2517 *
2518 * If we find the appropriate architecture in a fat archive, we gobble
2519 * its magic "!<arch>\n" string and continue processing just as if
2520 * we had a single architecture archive.
2521 */
2522
2523 n = fread ( tmp, 1, 8, f );
2524 if (n != 8)
2525 barf("loadArchive: Failed reading header from `%s'", path);
2526 if (strncmp(tmp, "!<arch>\n", 8) == 0) {}
2527 #if !defined(mingw32_HOST_OS)
2528 /* See Note [thin archives on Windows] */
2529 else if (strncmp(tmp, "!<thin>\n", 8) == 0) {
2530 isThin = 1;
2531 }
2532 #endif
2533 #if defined(darwin_HOST_OS)
2534 /* Not a standard archive, look for a fat archive magic number: */
2535 else if (ntohl(*(uint32_t *)tmp) == FAT_MAGIC) {
2536 nfat_arch = ntohl(*(uint32_t *)(tmp + 4));
2537 IF_DEBUG(linker, debugBelch("loadArchive: found a fat archive containing %d architectures\n", nfat_arch));
2538 nfat_offset = 0;
2539
2540 for (i = 0; i < (int)nfat_arch; i++) {
2541 /* search for the right arch */
2542 n = fread( tmp, 1, 20, f );
2543 if (n != 8)
2544 barf("loadArchive: Failed reading arch from `%s'", path);
2545 cputype = ntohl(*(uint32_t *)tmp);
2546 cpusubtype = ntohl(*(uint32_t *)(tmp + 4));
2547
2548 if (cputype == mycputype && cpusubtype == mycpusubtype) {
2549 IF_DEBUG(linker, debugBelch("loadArchive: found my archive in a fat archive\n"));
2550 nfat_offset = ntohl(*(uint32_t *)(tmp + 8));
2551 break;
2552 }
2553 }
2554
2555 if (nfat_offset == 0) {
2556 barf ("loadArchive: searched %d architectures, but no host arch found", (int)nfat_arch);
2557 }
2558 else {
2559 n = fseek( f, nfat_offset, SEEK_SET );
2560 if (n != 0)
2561 barf("loadArchive: Failed to seek to arch in `%s'", path);
2562 n = fread ( tmp, 1, 8, f );
2563 if (n != 8)
2564 barf("loadArchive: Failed reading header from `%s'", path);
2565 if (strncmp(tmp, "!<arch>\n", 8) != 0) {
2566 barf("loadArchive: couldn't find archive in `%s' at offset %d", path, nfat_offset);
2567 }
2568 }
2569 }
2570 else {
2571 barf("loadArchive: Neither an archive, nor a fat archive: `%s'", path);
2572 }
2573 #else
2574 else {
2575 barf("loadArchive: Not an archive: `%s'", path);
2576 }
2577 #endif
2578
2579 IF_DEBUG(linker, debugBelch("loadArchive: loading archive contents\n"));
2580
2581 while(1) {
2582 n = fread ( fileName, 1, 16, f );
2583 if (n != 16) {
2584 if (feof(f)) {
2585 IF_DEBUG(linker, debugBelch("loadArchive: EOF while reading from '%" PATH_FMT "'\n", path));
2586 break;
2587 }
2588 else {
2589 barf("loadArchive: Failed reading file name from `%s'", path);
2590 }
2591 }
2592
2593 #if defined(darwin_HOST_OS)
2594 if (strncmp(fileName, "!<arch>\n", 8) == 0) {
2595 IF_DEBUG(linker, debugBelch("loadArchive: found the start of another archive, breaking\n"));
2596 break;
2597 }
2598 #endif
2599
2600 n = fread ( tmp, 1, 12, f );
2601 if (n != 12)
2602 barf("loadArchive: Failed reading mod time from `%s'", path);
2603 n = fread ( tmp, 1, 6, f );
2604 if (n != 6)
2605 barf("loadArchive: Failed reading owner from `%s'", path);
2606 n = fread ( tmp, 1, 6, f );
2607 if (n != 6)
2608 barf("loadArchive: Failed reading group from `%s'", path);
2609 n = fread ( tmp, 1, 8, f );
2610 if (n != 8)
2611 barf("loadArchive: Failed reading mode from `%s'", path);
2612 n = fread ( tmp, 1, 10, f );
2613 if (n != 10)
2614 barf("loadArchive: Failed reading size from `%s'", path);
2615 tmp[10] = '\0';
2616 for (n = 0; isdigit(tmp[n]); n++);
2617 tmp[n] = '\0';
2618 memberSize = atoi(tmp);
2619
2620 IF_DEBUG(linker, debugBelch("loadArchive: size of this archive member is %d\n", memberSize));
2621 n = fread ( tmp, 1, 2, f );
2622 if (n != 2)
2623 barf("loadArchive: Failed reading magic from `%s'", path);
2624 if (strncmp(tmp, "\x60\x0A", 2) != 0)
2625 barf("loadArchive: Failed reading magic from `%s' at %ld. Got %c%c",
2626 path, ftell(f), tmp[0], tmp[1]);
2627
2628 isGnuIndex = 0;
2629 /* Check for BSD-variant large filenames */
2630 if (0 == strncmp(fileName, "#1/", 3)) {
2631 fileName[16] = '\0';
2632 if (isdigit(fileName[3])) {
2633 for (n = 4; isdigit(fileName[n]); n++);
2634 fileName[n] = '\0';
2635 thisFileNameSize = atoi(fileName + 3);
2636 memberSize -= thisFileNameSize;
2637 if (thisFileNameSize >= fileNameSize) {
2638 /* Double it to avoid potentially continually
2639 increasing it by 1 */
2640 fileNameSize = thisFileNameSize * 2;
2641 fileName = stgReallocBytes(fileName, fileNameSize, "loadArchive(fileName)");
2642 }
2643 n = fread ( fileName, 1, thisFileNameSize, f );
2644 if (n != (int)thisFileNameSize) {
2645 barf("loadArchive: Failed reading filename from `%s'",
2646 path);
2647 }
2648 fileName[thisFileNameSize] = 0;
2649
2650 /* On OS X at least, thisFileNameSize is the size of the
2651 fileName field, not the length of the fileName
2652 itself. */
2653 thisFileNameSize = strlen(fileName);
2654 }
2655 else {
2656 barf("loadArchive: BSD-variant filename size not found while reading filename from `%s'", path);
2657 }
2658 }
2659 /* Check for GNU file index file */
2660 else if (0 == strncmp(fileName, "//", 2)) {
2661 fileName[0] = '\0';
2662 thisFileNameSize = 0;
2663 isGnuIndex = 1;
2664 }
2665 /* Check for a file in the GNU file index */
2666 else if (fileName[0] == '/') {
2667 if (isdigit(fileName[1])) {
2668 int i;
2669
2670 for (n = 2; isdigit(fileName[n]); n++);
2671 fileName[n] = '\0';
2672 n = atoi(fileName + 1);
2673
2674 if (gnuFileIndex == NULL) {
2675 barf("loadArchive: GNU-variant filename without an index while reading from `%s'", path);
2676 }
2677 if (n < 0 || n > gnuFileIndexSize) {
2678 barf("loadArchive: GNU-variant filename offset %d out of range [0..%d] while reading filename from `%s'", n, gnuFileIndexSize, path);
2679 }
2680 if (n != 0 && gnuFileIndex[n - 1] != '\n') {
2681 barf("loadArchive: GNU-variant filename offset %d invalid (range [0..%d]) while reading filename from `%s'", n, gnuFileIndexSize, path);
2682 }
2683 for (i = n; gnuFileIndex[i] != '\n'; i++);
2684 thisFileNameSize = i - n - 1;
2685 if (thisFileNameSize >= fileNameSize) {
2686 /* Double it to avoid potentially continually
2687 increasing it by 1 */
2688 fileNameSize = thisFileNameSize * 2;
2689 fileName = stgReallocBytes(fileName, fileNameSize, "loadArchive(fileName)");
2690 }
2691 memcpy(fileName, gnuFileIndex + n, thisFileNameSize);
2692 fileName[thisFileNameSize] = '\0';
2693 }
2694 else if (fileName[1] == ' ') {
2695 fileName[0] = '\0';
2696 thisFileNameSize = 0;
2697 }
2698 else {
2699 barf("loadArchive: GNU-variant filename offset not found while reading filename from `%s'", path);
2700 }
2701 }
2702 /* Finally, the case where the filename field actually contains
2703 the filename */
2704 else {
2705 /* GNU ar terminates filenames with a '/', this allowing
2706 spaces in filenames. So first look to see if there is a
2707 terminating '/'. */
2708 for (thisFileNameSize = 0;
2709 thisFileNameSize < 16;
2710 thisFileNameSize++) {
2711 if (fileName[thisFileNameSize] == '/') {
2712 fileName[thisFileNameSize] = '\0';
2713 break;
2714 }
2715 }
2716 /* If we didn't find a '/', then a space teminates the
2717 filename. Note that if we don't find one, then
2718 thisFileNameSize ends up as 16, and we already have the
2719 '\0' at the end. */
2720 if (thisFileNameSize == 16) {
2721 for (thisFileNameSize = 0;
2722 thisFileNameSize < 16;
2723 thisFileNameSize++) {
2724 if (fileName[thisFileNameSize] == ' ') {
2725 fileName[thisFileNameSize] = '\0';
2726 break;
2727 }
2728 }
2729 }
2730 }
2731
2732 IF_DEBUG(linker,
2733 debugBelch("loadArchive: Found member file `%s'\n", fileName));
2734
2735 isObject = thisFileNameSize >= 2
2736 && fileName[thisFileNameSize - 2] == '.'
2737 && fileName[thisFileNameSize - 1] == 'o';
2738
2739 IF_DEBUG(linker, debugBelch("loadArchive: \tthisFileNameSize = %d\n", (int)thisFileNameSize));
2740 IF_DEBUG(linker, debugBelch("loadArchive: \tisObject = %d\n", isObject));
2741
2742 if (isObject) {
2743 char *archiveMemberName;
2744
2745 IF_DEBUG(linker, debugBelch("loadArchive: Member is an object file...loading...\n"));
2746
2747 /* We can't mmap from the archive directly, as object
2748 files need to be 8-byte aligned but files in .ar
2749 archives are 2-byte aligned. When possible we use mmap
2750 to get some anonymous memory, as on 64-bit platforms if
2751 we use malloc then we can be given memory above 2^32.
2752 In the mmap case we're probably wasting lots of space;
2753 we could do better. */
2754 #if defined(USE_MMAP)
2755 image = mmapForLinker(memberSize, MAP_ANONYMOUS, -1);
2756 #elif defined(mingw32_HOST_OS)
2757 // TODO: We would like to use allocateExec here, but allocateExec
2758 // cannot currently allocate blocks large enough.
2759 image = allocateImageAndTrampolines(path, fileName,
2760 #if defined(x86_64_HOST_ARCH)
2761 f,
2762 #endif
2763 memberSize);
2764 #elif defined(darwin_HOST_OS)
2765 /* See loadObj() */
2766 misalignment = machoGetMisalignment(f);
2767 image = stgMallocBytes(memberSize + misalignment, "loadArchive(image)");
2768 image += misalignment;
2769 #else
2770 image = stgMallocBytes(memberSize, "loadArchive(image)");
2771 #endif
2772
2773 #if !defined(mingw32_HOST_OS)
2774 /*
2775 * Note [thin archives on Windows]
2776 * This doesn't compile on Windows because it assumes
2777 * char* pathnames, and we use wchar_t* on Windows. It's
2778 * not trivial to fix, so I'm leaving it disabled on
2779 * Windows for now --SDM
2780 */
2781 if (isThin) {
2782 FILE *member;
2783 char *pathCopy, *dirName, *memberPath;
2784
2785 /* Allocate and setup the dirname of the archive. We'll need
2786 this to locate the thin member */
2787 pathCopy = stgMallocBytes(strlen(path) + 1, "loadArchive(file)");
2788 strcpy(pathCopy, path);
2789 dirName = dirname(pathCopy);
2790
2791 /* Append the relative member name to the dirname. This should be
2792 be the full path to the actual thin member. */
2793 memberPath = stgMallocBytes(
2794 strlen(path) + 1 + strlen(fileName) + 1, "loadArchive(file)");
2795 strcpy(memberPath, dirName);
2796 memberPath[strlen(dirName)] = '/';
2797 strcpy(memberPath + strlen(dirName) + 1, fileName);
2798
2799 member = pathopen(memberPath, WSTR("rb"));
2800 if (!member)
2801 barf("loadObj: can't read `%s'", path);
2802
2803 n = fread ( image, 1, memberSize, member );
2804 if (n != memberSize) {
2805 barf("loadArchive: error whilst reading `%s'", fileName);
2806 }
2807
2808 fclose(member);
2809 stgFree(memberPath);
2810 stgFree(pathCopy);
2811 }
2812 else
2813 #endif
2814 {
2815 n = fread ( image, 1, memberSize, f );
2816 if (n != memberSize) {
2817 barf("loadArchive: error whilst reading `%s'", path);
2818 }
2819 }
2820
2821 archiveMemberName = stgMallocBytes(pathlen(path) + thisFileNameSize + 3,
2822 "loadArchive(file)");
2823 sprintf(archiveMemberName, "%" PATH_FMT "(%.*s)",
2824 path, (int)thisFileNameSize, fileName);
2825
2826 oc = mkOc(path, image, memberSize, archiveMemberName
2827 #ifndef USE_MMAP
2828 #ifdef darwin_HOST_OS
2829 , misalignment
2830 #endif
2831 #endif
2832 );
2833
2834 stgFree(archiveMemberName);
2835
2836 if (0 == loadOc(oc)) {
2837 stgFree(fileName);
2838 fclose(f);
2839 return 0;
2840 } else {
2841 oc->next = objects;
2842 objects = oc;
2843 }
2844 }
2845 else if (isGnuIndex) {
2846 if (gnuFileIndex != NULL) {
2847 barf("loadArchive: GNU-variant index found, but already have an index, while reading filename from `%s'", path);
2848 }
2849 IF_DEBUG(linker, debugBelch("loadArchive: Found GNU-variant file index\n"));
2850 #ifdef USE_MMAP
2851 gnuFileIndex = mmapForLinker(memberSize + 1, MAP_ANONYMOUS, -1);
2852 #else
2853 gnuFileIndex = stgMallocBytes(memberSize + 1, "loadArchive(image)");
2854 #endif
2855 n = fread ( gnuFileIndex, 1, memberSize, f );
2856 if (n != memberSize) {
2857 barf("loadArchive: error whilst reading `%s'", path);
2858 }
2859 gnuFileIndex[memberSize] = '/';
2860 gnuFileIndexSize = memberSize;
2861 }
2862 else {
2863 IF_DEBUG(linker, debugBelch("loadArchive: '%s' does not appear to be an object file\n", fileName));
2864 if (!isThin || thisFileNameSize == 0) {
2865 n = fseek(f, memberSize, SEEK_CUR);
2866 if (n != 0)
2867 barf("loadArchive: error whilst seeking by %d in `%s'",
2868 memberSize, path);
2869 }
2870 }
2871
2872 /* .ar files are 2-byte aligned */
2873 if (!(isThin && thisFileNameSize > 0) && memberSize % 2) {
2874 IF_DEBUG(linker, debugBelch("loadArchive: trying to read one pad byte\n"));
2875 n = fread ( tmp, 1, 1, f );
2876 if (n != 1) {
2877 if (feof(f)) {
2878 IF_DEBUG(linker, debugBelch("loadArchive: found EOF while reading one pad byte\n"));
2879 break;
2880 }
2881 else {
2882 barf("loadArchive: Failed reading padding from `%s'", path);
2883 }
2884 }
2885 IF_DEBUG(linker, debugBelch("loadArchive: successfully read one pad byte\n"));
2886 }
2887 IF_DEBUG(linker, debugBelch("loadArchive: reached end of archive loading while loop\n"));
2888 }
2889
2890 fclose(f);
2891
2892 stgFree(fileName);
2893 if (gnuFileIndex != NULL) {
2894 #ifdef USE_MMAP
2895 munmap(gnuFileIndex, gnuFileIndexSize + 1);
2896 #else
2897 stgFree(gnuFileIndex);
2898 #endif
2899 }
2900
2901 IF_DEBUG(linker, debugBelch("loadArchive: done\n"));
2902 return 1;
2903 }
2904
2905 /* -----------------------------------------------------------------------------
2906 * Load an obj (populate the global symbol table, but don't resolve yet)
2907 *
2908 * Returns: 1 if ok, 0 on error.
2909 */
2910 HsInt
2911 loadObj( pathchar *path )
2912 {
2913 ObjectCode* oc;
2914 char *image;
2915 int fileSize;
2916 struct_stat st;
2917 int r;
2918 #ifdef USE_MMAP
2919 int fd;
2920 #else
2921 FILE *f;
2922 # if defined(darwin_HOST_OS)
2923 int misalignment;
2924 # endif
2925 #endif
2926 IF_DEBUG(linker, debugBelch("loadObj %" PATH_FMT "\n", path));
2927
2928 initLinker();
2929
2930 /* debugBelch("loadObj %s\n", path ); */
2931
2932 /* Check that we haven't already loaded this object.
2933 Ignore requests to load multiple times */
2934
2935 if (isAlreadyLoaded(path)) {
2936 IF_DEBUG(linker,
2937 debugBelch("ignoring repeated load of %" PATH_FMT "\n", path));
2938 return 1; /* success */
2939 }
2940
2941 r = pathstat(path, &st);
2942 if (r == -1) {
2943 IF_DEBUG(linker, debugBelch("File doesn't exist\n"));
2944 return 0;
2945 }
2946
2947 fileSize = st.st_size;
2948
2949 #ifdef USE_MMAP
2950 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
2951
2952 #if defined(openbsd_HOST_OS)
2953 /* coverity[toctou] */
2954 fd = open(path, O_RDONLY, S_IRUSR);
2955 #else
2956 /* coverity[toctou] */
2957 fd = open(path, O_RDONLY);
2958 #endif
2959 if (fd == -1) {
2960 errorBelch("loadObj: can't open `%s'", path);
2961 return 0;
2962 }
2963
2964 image = mmapForLinker(fileSize, 0, fd);
2965 close(fd);
2966 if (image == NULL) return 0;
2967
2968 #else /* !USE_MMAP */
2969 /* load the image into memory */
2970 /* coverity[toctou] */
2971 f = pathopen(path, WSTR("rb"));
2972 if (!f) {
2973 errorBelch("loadObj: can't read `%" PATH_FMT "'", path);
2974 return 0;
2975 }
2976
2977 # if defined(mingw32_HOST_OS)
2978 // TODO: We would like to use allocateExec here, but allocateExec
2979 // cannot currently allocate blocks large enough.
2980 image = allocateImageAndTrampolines(path, "itself",
2981 #if defined(x86_64_HOST_ARCH)
2982 f,
2983 #endif
2984 fileSize);
2985 if (image == NULL) {
2986 fclose(f);
2987 return 0;
2988 }
2989 # elif defined(darwin_HOST_OS)
2990 // In a Mach-O .o file, all sections can and will be misaligned
2991 // if the total size of the headers is not a multiple of the
2992 // desired alignment. This is fine for .o files that only serve
2993 // as input for the static linker, but it's not fine for us,
2994 // as SSE (used by gcc for floating point) and Altivec require
2995 // 16-byte alignment.
2996 // We calculate the correct alignment from the header before
2997 // reading the file, and then we misalign image on purpose so
2998 // that the actual sections end up aligned again.
2999 misalignment = machoGetMisalignment(f);
3000 image = stgMallocBytes(fileSize + misalignment, "loadObj(image)");
3001 image += misalignment;
3002 # else
3003 image = stgMallocBytes(fileSize, "loadObj(image)");
3004 # endif
3005
3006 {
3007 int n;
3008 n = fread ( image, 1, fileSize, f );
3009 fclose(f);
3010 if (n != fileSize) {
3011 errorBelch("loadObj: error whilst reading `%" PATH_FMT "'", path);
3012 stgFree(image);
3013 return 0;
3014 }
3015 }
3016 #endif /* USE_MMAP */
3017
3018 oc = mkOc(path, image, fileSize, NULL
3019 #ifndef USE_MMAP
3020 #ifdef darwin_HOST_OS
3021 , misalignment
3022 #endif
3023 #endif
3024 );
3025
3026 if (! loadOc(oc)) {
3027 // failed; free everything we've allocated
3028 removeOcSymbols(oc);
3029 freeObjectCode(oc);
3030 return 0;
3031 }
3032
3033 oc->next = objects;
3034 objects = oc;
3035 return 1;
3036 }
3037
3038 static HsInt
3039 loadOc( ObjectCode* oc ) {
3040 int r;
3041
3042 IF_DEBUG(linker, debugBelch("loadOc: start\n"));
3043
3044 /* verify the in-memory image */
3045 # if defined(OBJFORMAT_ELF)
3046 r = ocVerifyImage_ELF ( oc );
3047 # elif defined(OBJFORMAT_PEi386)
3048 r = ocVerifyImage_PEi386 ( oc );
3049 # elif defined(OBJFORMAT_MACHO)
3050 r = ocVerifyImage_MachO ( oc );
3051 # else
3052 barf("loadObj: no verify method");
3053 # endif
3054 if (!r) {
3055 IF_DEBUG(linker, debugBelch("loadOc: ocVerifyImage_* failed\n"));
3056 return r;
3057 }
3058
3059 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
3060 r = ocAllocateSymbolExtras_MachO ( oc );
3061 if (!r) {
3062 IF_DEBUG(linker, debugBelch("loadOc: ocAllocateSymbolExtras_MachO failed\n"));
3063 return r;
3064 }
3065 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH))
3066 r = ocAllocateSymbolExtras_ELF ( oc );
3067 if (!r) {
3068 IF_DEBUG(linker, debugBelch("loadOc: ocAllocateSymbolExtras_ELF failed\n"));
3069 return r;
3070 }
3071 # elif defined(OBJFORMAT_PEi386) && defined(x86_64_HOST_ARCH)
3072 ocAllocateSymbolExtras_PEi386 ( oc );
3073 #endif
3074
3075 /* build the symbol list for this image */
3076 # if defined(OBJFORMAT_ELF)
3077 r = ocGetNames_ELF ( oc );
3078 # elif defined(OBJFORMAT_PEi386)
3079 r = ocGetNames_PEi386 ( oc );
3080 # elif defined(OBJFORMAT_MACHO)
3081 r = ocGetNames_MachO ( oc );
3082 # else
3083 barf("loadObj: no getNames method");
3084 # endif
3085 if (!r) {
3086 IF_DEBUG(linker, debugBelch("loadOc: ocGetNames_* failed\n"));
3087 return r;
3088 }
3089
3090 /* loaded, but not resolved yet */
3091 oc->status = OBJECT_LOADED;
3092 IF_DEBUG(linker, debugBelch("loadOc: done.\n"));
3093
3094 return 1;
3095 }
3096
3097 /* -----------------------------------------------------------------------------
3098 * resolve all the currently unlinked objects in memory
3099 *
3100 * Returns: 1 if ok, 0 on error.
3101 */
3102 HsInt
3103 resolveObjs( void )
3104 {
3105 ObjectCode *oc;
3106 int r;
3107
3108 IF_DEBUG(linker, debugBelch("resolveObjs: start\n"));
3109 initLinker();
3110
3111 for (oc = objects; oc; oc = oc->next) {
3112 if (oc->status != OBJECT_RESOLVED) {
3113 # if defined(OBJFORMAT_ELF)
3114 r = ocResolve_ELF ( oc );
3115 # elif defined(OBJFORMAT_PEi386)
3116 r = ocResolve_PEi386 ( oc );
3117 # elif defined(OBJFORMAT_MACHO)
3118 r = ocResolve_MachO ( oc );
3119 # else
3120 barf("resolveObjs: not implemented on this platform");
3121 # endif
3122 if (!r) { return r; }
3123
3124 // run init/init_array/ctors/mod_init_func
3125
3126 loading_obj = oc; // tells foreignExportStablePtr what to do
3127 #if defined(OBJFORMAT_ELF)
3128 r = ocRunInit_ELF ( oc );
3129 #elif defined(OBJFORMAT_PEi386)
3130 r = ocRunInit_PEi386 ( oc );
3131 #elif defined(OBJFORMAT_MACHO)
3132 r = ocRunInit_MachO ( oc );
3133 #else
3134 barf("resolveObjs: initializers not implemented on this platform");
3135 #endif
3136 loading_obj = NULL;
3137
3138 if (!r) { return r; }
3139
3140 oc->status = OBJECT_RESOLVED;
3141 }
3142 }
3143 IF_DEBUG(linker, debugBelch("resolveObjs: done\n"));
3144 return 1;
3145 }
3146
3147 /* -----------------------------------------------------------------------------
3148 * delete an object from the pool
3149 */
3150 HsInt
3151 unloadObj( pathchar *path )
3152 {
3153 ObjectCode *oc, *prev, *next;
3154 HsBool unloadedAnyObj = HS_BOOL_FALSE;
3155
3156 ASSERT(symhash != NULL);
3157 ASSERT(objects != NULL);
3158
3159 initLinker();
3160
3161 IF_DEBUG(linker, debugBelch("unloadObj: %" PATH_FMT "\n", path));
3162
3163 prev = NULL;
3164 for (oc = objects; oc; oc = next) {
3165 next = oc->next; // oc might be freed
3166
3167 if (!pathcmp(oc->fileName,path)) {
3168
3169 removeOcSymbols(oc);
3170
3171 if (prev == NULL) {
3172 objects = oc->next;
3173 } else {
3174 prev->next = oc->next;
3175 }
3176 oc->next = unloaded_objects;
3177 unloaded_objects = oc;
3178
3179 // Release any StablePtrs that were created when this
3180 // object module was initialized.
3181 {
3182 ForeignExportStablePtr *fe_ptr, *next;
3183
3184 for (fe_ptr = oc->stable_ptrs; fe_ptr != NULL; fe_ptr = next) {
3185 next = fe_ptr->next;
3186 freeStablePtr(fe_ptr->stable_ptr);
3187 stgFree(fe_ptr);
3188 }
3189 }
3190
3191 oc->status = OBJECT_UNLOADED;
3192
3193 /* This could be a member of an archive so continue
3194 * unloading other members. */
3195 unloadedAnyObj = HS_BOOL_TRUE;
3196 } else {
3197 prev = oc;
3198 }
3199 }
3200
3201 if (unloadedAnyObj) {
3202 return 1;
3203 }
3204 else {
3205 errorBelch("unloadObj: can't find `%" PATH_FMT "' to unload", path);
3206 return 0;
3207 }
3208 }
3209
3210 /* -----------------------------------------------------------------------------
3211 * Sanity checking. For each ObjectCode, maintain a list of address ranges
3212 * which may be prodded during relocation, and abort if we try and write
3213 * outside any of these.
3214 */
3215 static void
3216 addProddableBlock ( ObjectCode* oc, void* start, int size )
3217 {
3218 ProddableBlock* pb
3219 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
3220
3221 IF_DEBUG(linker, debugBelch("addProddableBlock: %p %p %d\n", oc, start, size));
3222 ASSERT(size > 0);
3223 pb->start = start;
3224 pb->size = size;
3225 pb->next = oc->proddables;
3226 oc->proddables = pb;
3227 }
3228
3229 static void
3230 checkProddableBlock (ObjectCode *oc, void *addr, size_t size )
3231 {
3232 ProddableBlock* pb;
3233
3234 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
3235 char* s = (char*)(pb->start);
3236 char* e = s + pb->size;
3237 char* a = (char*)addr;
3238 if (a >= s && (a+size) <= e) return;
3239 }
3240 barf("checkProddableBlock: invalid fixup in runtime linker: %p", addr);
3241 }
3242
3243 static void freeProddableBlocks (ObjectCode *oc)
3244 {
3245 ProddableBlock *pb, *next;
3246
3247 for (pb = oc->proddables; pb != NULL; pb = next) {
3248 next = pb->next;
3249 stgFree(pb);
3250 }
3251 oc->proddables = NULL;
3252 }
3253
3254 /* -----------------------------------------------------------------------------
3255 * Section management.
3256 */
3257 static void
3258 addSection ( ObjectCode* oc, SectionKind kind,
3259 void* start, void* end )
3260 {
3261 Section* s = stgMallocBytes(sizeof(Section), "addSection");
3262 s->start = start;
3263 s->end = end;
3264 s->kind = kind;
3265 s->next = oc->sections;
3266 oc->sections = s;
3267
3268 IF_DEBUG(linker, debugBelch("addSection: %p-%p (size %lld), kind %d\n",
3269 start, ((char*)end)-1, ((long long)(size_t)end) - ((long long)(size_t)start) + 1, kind ));
3270 }
3271
3272
3273 /* --------------------------------------------------------------------------
3274 * Symbol Extras.
3275 * This is about allocating a small chunk of memory for every symbol in the
3276 * object file. We make sure that the SymboLExtras are always "in range" of
3277 * limited-range PC-relative instructions on various platforms by allocating
3278 * them right next to the object code itself.
3279 */
3280
3281 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
3282 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
3283
3284 /*
3285 ocAllocateSymbolExtras
3286
3287 Allocate additional space at the end of the object file image to make room
3288 for jump islands (powerpc, x86_64, arm) and GOT entries (x86_64).
3289
3290 PowerPC relative branch instructions have a 24 bit displacement field.
3291 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
3292 If a particular imported symbol is outside this range, we have to redirect
3293 the jump to a short piece of new code that just loads the 32bit absolute
3294 address and jumps there.
3295 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
3296 to 32 bits (+-2GB).
3297
3298 This function just allocates space for one SymbolExtra for every
3299 undefined symbol in the object file. The code for the jump islands is
3300 filled in by makeSymbolExtra below.
3301 */
3302
3303 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
3304 {
3305 #ifdef USE_MMAP
3306 int pagesize, n, m;
3307 #endif
3308 int aligned;
3309 #ifndef USE_MMAP
3310 int misalignment = 0;
3311 #ifdef darwin_HOST_OS
3312 misalignment = oc->misalignment;
3313 #endif
3314 #endif
3315
3316 if( count > 0 )
3317 {
3318 // round up to the nearest 4
3319 aligned = (oc->fileSize + 3) & ~3;
3320
3321 #ifdef USE_MMAP
3322 pagesize = getpagesize();
3323 n = ROUND_UP( oc->fileSize, pagesize );
3324 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
3325
3326 /* we try to use spare space at the end of the last page of the
3327 * image for the jump islands, but if there isn't enough space
3328 * then we have to map some (anonymously, remembering MAP_32BIT).
3329 */
3330 if( m > n ) // we need to allocate more pages
3331 {
3332 if (USE_CONTIGUOUS_MMAP)
3333 {
3334 /* Keep image and symbol_extras contiguous */
3335 void *new = mmapForLinker(n + (sizeof(SymbolExtra) * count),
3336 MAP_ANONYMOUS, -1);
3337 if (new)
3338 {
3339 memcpy(new, oc->image, oc->fileSize);
3340 munmap(oc->image, n);
3341 oc->image = new;
3342 oc->fileSize = n + (sizeof(SymbolExtra) * count);
3343 oc->symbol_extras = (SymbolExtra *) (oc->image + n);
3344 }
3345 else {
3346 oc->symbol_extras = NULL;
3347 return 0;
3348 }
3349 }
3350 else
3351 {
3352 oc->symbol_extras = mmapForLinker(sizeof(SymbolExtra) * count,
3353 MAP_ANONYMOUS, -1);
3354 if (oc->symbol_extras == NULL) return 0;
3355 }
3356 }
3357 else
3358 {
3359 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
3360 }
3361 #else
3362 oc->image -= misalignment;
3363 oc->image = stgReallocBytes( oc->image,
3364 misalignment +
3365 aligned + sizeof (SymbolExtra) * count,
3366 "ocAllocateSymbolExtras" );
3367 oc->image += misalignment;
3368
3369 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
3370 #endif /* USE_MMAP */
3371
3372 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
3373 }
3374 else
3375 oc->symbol_extras = NULL;
3376
3377 oc->first_symbol_extra = first;
3378 oc->n_symbol_extras = count;
3379
3380 return 1;
3381 }
3382
3383 #endif
3384 #endif // defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
3385
3386 #if defined(arm_HOST_ARCH)
3387
3388 static void
3389 ocFlushInstructionCache( ObjectCode *oc )
3390 {
3391 // Object code
3392 __clear_cache(oc->image, oc->image + oc->fileSize);
3393 // Jump islands
3394 __clear_cache(oc->symbol_extras, &oc->symbol_extras[oc->n_symbol_extras]);
3395 }
3396
3397 #endif
3398
3399 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3400 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
3401
3402 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
3403 unsigned long symbolNumber,
3404 unsigned long target )
3405 {
3406 SymbolExtra *extra;
3407
3408 ASSERT( symbolNumber >= oc->first_symbol_extra
3409 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
3410
3411 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
3412
3413 #ifdef powerpc_HOST_ARCH
3414 // lis r12, hi16(target)
3415 extra->jumpIsland.lis_r12 = 0x3d80;
3416 extra->jumpIsland.hi_addr = target >> 16;
3417
3418 // ori r12, r12, lo16(target)
3419 extra->jumpIsland.ori_r12_r12 = 0x618c;
3420 extra->jumpIsland.lo_addr = target & 0xffff;
3421
3422 // mtctr r12
3423 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
3424
3425 // bctr
3426 extra->jumpIsland.bctr = 0x4e800420;
3427 #endif
3428 #ifdef x86_64_HOST_ARCH
3429 // jmp *-14(%rip)
3430 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
3431 extra->addr = target;
3432 memcpy(extra->jumpIsland, jmp, 6);
3433 #endif
3434
3435 return extra;
3436 }
3437
3438 #endif
3439 #endif // defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3440
3441 #ifdef arm_HOST_ARCH
3442 static SymbolExtra* makeArmSymbolExtra( ObjectCode* oc,
3443 unsigned long symbolNumber,
3444 unsigned long target,
3445 int fromThumb,
3446 int toThumb )
3447 {
3448 SymbolExtra *extra;
3449
3450 ASSERT( symbolNumber >= oc->first_symbol_extra
3451 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
3452
3453 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
3454
3455 // Make sure instruction mode bit is set properly
3456 if (toThumb)
3457 target |= 1;
3458 else
3459 target &= ~1;
3460
3461 if (!fromThumb) {
3462 // In ARM encoding:
3463 // movw r12, #0
3464 // movt r12, #0
3465 // bx r12
3466 uint32_t code[] = { 0xe300c000, 0xe340c000, 0xe12fff1c };
3467
3468 // Patch lower half-word into movw
3469 code[0] |= ((target>>12) & 0xf) << 16;
3470 code[0] |= target & 0xfff;
3471 // Patch upper half-word into movt
3472 target >>= 16;
3473 code[1] |= ((target>>12) & 0xf) << 16;
3474 code[1] |= target & 0xfff;
3475
3476 memcpy(extra->jumpIsland, code, 12);
3477
3478 } else {
3479 // In Thumb encoding:
3480 // movw r12, #0
3481 // movt r12, #0
3482 // bx r12
3483 uint16_t code[] = { 0xf240, 0x0c00,
3484 0xf2c0, 0x0c00,
3485 0x4760 };
3486
3487 // Patch lower half-word into movw
3488 code[0] |= (target>>12) & 0xf;
3489 code[0] |= ((target>>11) & 0x1) << 10;
3490 code[1] |= ((target>>8) & 0x7) << 12;
3491 code[1] |= target & 0xff;
3492 // Patch upper half-word into movt
3493 target >>= 16;
3494 code[2] |= (target>>12) & 0xf;
3495 code[2] |= ((target>>11) & 0x1) << 10;
3496 code[3] |= ((target>>8) & 0x7) << 12;
3497 code[3] |= target & 0xff;
3498
3499 memcpy(extra->jumpIsland, code, 10);
3500 }
3501
3502 return extra;
3503 }
3504 #endif // arm_HOST_ARCH
3505
3506 /* --------------------------------------------------------------------------
3507 * PowerPC specifics (instruction cache flushing)
3508 * ------------------------------------------------------------------------*/
3509
3510 #ifdef powerpc_HOST_ARCH
3511 /*
3512 ocFlushInstructionCache
3513
3514 Flush the data & instruction caches.
3515 Because the PPC has split data/instruction caches, we have to
3516 do that whenever we modify code at runtime.
3517 */
3518
3519 static void
3520 ocFlushInstructionCacheFrom(void* begin, size_t length)
3521 {
3522 size_t n = (length + 3) / 4;
3523 unsigned long* p = begin;
3524
3525 while (n--)
3526 {
3527 __asm__ volatile ( "dcbf 0,%0\n\t"
3528 "sync\n\t"
3529 "icbi 0,%0"
3530 :
3531 : "r" (p)
3532 );
3533 p++;
3534 }
3535 __asm__ volatile ( "sync\n\t"
3536 "isync"
3537 );
3538 }
3539
3540 static void
3541 ocFlushInstructionCache( ObjectCode *oc )
3542 {
3543 /* The main object code */
3544 ocFlushInstructionCacheFrom(oc->image
3545 #ifdef darwin_HOST_OS
3546 + oc->misalignment
3547 #endif
3548 , oc->fileSize);
3549
3550 /* Jump Islands */
3551 ocFlushInstructionCacheFrom(oc->symbol_extras, sizeof(SymbolExtra) * oc->n_symbol_extras);
3552 }
3553 #endif /* powerpc_HOST_ARCH */
3554
3555
3556 /* --------------------------------------------------------------------------
3557 * PEi386 specifics (Win32 targets)
3558 * ------------------------------------------------------------------------*/
3559
3560 /* The information for this linker comes from
3561 Microsoft Portable Executable
3562 and Common Object File Format Specification
3563 revision 5.1 January 1998
3564 which SimonM says comes from the MS Developer Network CDs.
3565
3566 It can be found there (on older CDs), but can also be found
3567 online at:
3568
3569 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
3570
3571 (this is Rev 6.0 from February 1999).
3572
3573 Things move, so if that fails, try searching for it via
3574
3575 http://www.google.com/search?q=PE+COFF+specification
3576
3577 The ultimate reference for the PE format is the Winnt.h
3578 header file that comes with the Platform SDKs; as always,
3579 implementations will drift wrt their documentation.
3580
3581 A good background article on the PE format is Matt Pietrek's
3582 March 1994 article in Microsoft System Journal (MSJ)
3583 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
3584 Win32 Portable Executable File Format." The info in there
3585 has recently been updated in a two part article in
3586 MSDN magazine, issues Feb and March 2002,
3587 "Inside Windows: An In-Depth Look into the Win32 Portable
3588 Executable File Format"
3589
3590 John Levine's book "Linkers and Loaders" contains useful
3591 info on PE too.
3592 */
3593
3594
3595 #if defined(OBJFORMAT_PEi386)
3596
3597
3598
3599 typedef unsigned char UChar;
3600 typedef unsigned short UInt16;
3601 typedef unsigned int UInt32;
3602 typedef int Int32;
3603 typedef unsigned long long int UInt64;
3604
3605
3606 typedef
3607 struct {
3608 UInt16 Machine;
3609 UInt16 NumberOfSections;
3610 UInt32 TimeDateStamp;
3611 UInt32 PointerToSymbolTable;
3612 UInt32 NumberOfSymbols;
3613 UInt16 SizeOfOptionalHeader;
3614 UInt16 Characteristics;
3615 }
3616 COFF_header;
3617
3618 #define sizeof_COFF_header 20
3619
3620
3621 typedef
3622 struct {
3623 UChar Name[8];
3624 UInt32 VirtualSize;
3625 UInt32 VirtualAddress;
3626 UInt32 SizeOfRawData;
3627 UInt32 PointerToRawData;
3628 UInt32 PointerToRelocations;
3629 UInt32 PointerToLinenumbers;
3630 UInt16 NumberOfRelocations;
3631 UInt16 NumberOfLineNumbers;
3632 UInt32 Characteristics;
3633 }
3634 COFF_section;
3635
3636 #define sizeof_COFF_section 40
3637
3638
3639 typedef
3640 struct {
3641 UChar Name[8];
3642 UInt32 Value;
3643 UInt16 SectionNumber;
3644 UInt16 Type;
3645 UChar StorageClass;
3646 UChar NumberOfAuxSymbols;
3647 }
3648 COFF_symbol;
3649
3650 #define sizeof_COFF_symbol 18
3651
3652
3653 typedef
3654 struct {
3655 UInt32 VirtualAddress;
3656 UInt32 SymbolTableIndex;
3657 UInt16 Type;
3658 }
3659 COFF_reloc;
3660
3661 #define sizeof_COFF_reloc 10
3662
3663
3664 /* From PE spec doc, section 3.3.2 */
3665 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
3666 windows.h -- for the same purpose, but I want to know what I'm
3667 getting, here. */
3668 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
3669 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
3670 #define MYIMAGE_FILE_DLL 0x2000
3671 #define MYIMAGE_FILE_SYSTEM 0x1000
3672 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
3673 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
3674 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
3675
3676 /* From PE spec doc, section 5.4.2 and 5.4.4 */
3677 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
3678 #define MYIMAGE_SYM_CLASS_STATIC 3
3679 #define MYIMAGE_SYM_UNDEFINED 0
3680
3681 /* From PE spec doc, section 4.1 */
3682 #define MYIMAGE_SCN_CNT_CODE 0x00000020
3683 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
3684 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
3685
3686 /* From PE spec doc, section 5.2.1 */
3687 #define MYIMAGE_REL_I386_DIR32 0x0006
3688 #define MYIMAGE_REL_I386_REL32 0x0014
3689
3690 static int verifyCOFFHeader ( COFF_header *hdr, pathchar *filename);
3691
3692 /* We assume file pointer is right at the
3693 beginning of COFF object.
3694 */
3695 static char *
3696 allocateImageAndTrampolines (
3697 pathchar* arch_name, char* member_name,
3698 #if defined(x86_64_HOST_ARCH)
3699 FILE* f,
3700 #endif
3701 int size )
3702 {
3703 char* image;
3704 #if defined(x86_64_HOST_ARCH)
3705 /* PeCoff contains number of symbols right in it's header, so
3706 we can reserve the room for symbolExtras right here. */
3707 COFF_header hdr;
3708 size_t n;
3709
3710 n = fread ( &hdr, 1, sizeof_COFF_header, f );
3711 if (n != sizeof( COFF_header )) {
3712 errorBelch("getNumberOfSymbols: error whilst reading `%s' header in `%S'",
3713 member_name, arch_name);
3714 return NULL;
3715 }
3716 fseek( f, -sizeof_COFF_header, SEEK_CUR );
3717
3718 if (!verifyCOFFHeader(&hdr, arch_name)) {
3719 return 0;
3720 }
3721
3722 /* We get back 8-byte aligned memory (is that guaranteed?), but
3723 the offsets to the sections within the file are all 4 mod 8
3724 (is that guaranteed?). We therefore need to offset the image
3725 by 4, so that all the pointers are 8-byte aligned, so that
3726 pointer tagging works. */
3727 /* For 32-bit case we don't need this, hence we use macro PEi386_IMAGE_OFFSET,
3728 which equals to 4 for 64-bit case and 0 for 32-bit case. */
3729 /* We allocate trampolines area for all symbols right behind
3730 image data, aligned on 8. */
3731 size = ((PEi386_IMAGE_OFFSET + size + 0x7) & ~0x7)
3732 + hdr.NumberOfSymbols * sizeof(SymbolExtra);
3733 #endif
3734 image = VirtualAlloc(NULL, size,
3735 MEM_RESERVE | MEM_COMMIT,
3736 PAGE_EXECUTE_READWRITE);
3737
3738 if (image == NULL) {
3739 errorBelch("%" PATH_FMT ": failed to allocate memory for image for %s",
3740 arch_name, member_name);
3741 return NULL;
3742 }
3743
3744 return image + PEi386_IMAGE_OFFSET;
3745 }
3746
3747 /* We use myindex to calculate array addresses, rather than
3748 simply doing the normal subscript thing. That's because
3749 some of the above structs have sizes which are not
3750 a whole number of words. GCC rounds their sizes up to a
3751 whole number of words, which means that the address calcs
3752 arising from using normal C indexing or pointer arithmetic
3753 are just plain wrong. Sigh.
3754 */
3755 static UChar *
3756 myindex ( int scale, void* base, int index )
3757 {
3758 return
3759 ((UChar*)base) + scale * index;
3760 }
3761
3762
3763 static void
3764 printName ( UChar* name, UChar* strtab )
3765 {
3766 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3767 UInt32 strtab_offset = * (UInt32*)(name+4);
3768 debugBelch("%s", strtab + strtab_offset );
3769 } else {
3770 int i;
3771 for (i = 0; i < 8; i++) {
3772 if (name[i] == 0) break;
3773 debugBelch("%c", name[i] );
3774 }
3775 }
3776 }
3777
3778
3779 static void
3780 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
3781 {
3782 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3783 UInt32 strtab_offset = * (UInt32*)(name+4);
3784 strncpy ( (char*)dst, (char*)strtab+strtab_offset, dstSize );
3785 dst[dstSize-1] = 0;
3786 } else {
3787 int i = 0;
3788 while (1) {
3789 if (i >= 8) break;
3790 if (name[i] == 0) break;
3791 dst[i] = name[i];
3792 i++;
3793 }
3794 dst[i] = 0;
3795 }
3796 }
3797
3798
3799 static UChar *
3800 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
3801 {
3802 UChar* newstr;
3803 /* If the string is longer than 8 bytes, look in the
3804 string table for it -- this will be correctly zero terminated.
3805 */
3806 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3807 UInt32 strtab_offset = * (UInt32*)(name+4);
3808 return ((UChar*)strtab) + strtab_offset;
3809 }
3810 /* Otherwise, if shorter than 8 bytes, return the original,
3811 which by defn is correctly terminated.
3812 */
3813 if (name[7]==0) return name;
3814 /* The annoying case: 8 bytes. Copy into a temporary
3815 (XXX which is never freed ...)
3816 */
3817 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
3818 ASSERT(newstr);
3819 strncpy((char*)newstr,(char*)name,8);
3820 newstr[8] = 0;
3821 return newstr;
3822 }
3823
3824 /* Getting the name of a section is mildly tricky, so we make a
3825 function for it. Sadly, in one case we have to copy the string
3826 (when it is exactly 8 bytes long there's no trailing '\0'), so for
3827 consistency we *always* copy the string; the caller must free it
3828 */
3829 static char *
3830 cstring_from_section_name (UChar* name, UChar* strtab)
3831 {
3832 char *newstr;
3833
3834 if (name[0]=='/') {
3835 int strtab_offset = strtol((char*)name+1,NULL,10);
3836 int len = strlen(((char*)strtab) + strtab_offset);
3837
3838 newstr = stgMallocBytes(len+1, "cstring_from_section_symbol_name");
3839 strcpy((char*)newstr, (char*)((UChar*)strtab) + strtab_offset);
3840 return newstr;
3841 }
3842 else
3843 {
3844 newstr = stgMallocBytes(9, "cstring_from_section_symbol_name");
3845 ASSERT(newstr);
3846 strncpy((char*)newstr,(char*)name,8);
3847 newstr[8] = 0;
3848 return newstr;
3849 }
3850 }
3851
3852 /* Just compares the short names (first 8 chars) */
3853 static COFF_section *
3854 findPEi386SectionCalled ( ObjectCode* oc, UChar* name, UChar* strtab )
3855 {
3856 int i;
3857 rtsBool long_name = rtsFalse;
3858 COFF_header* hdr
3859 = (COFF_header*)(oc->image);
3860 COFF_section* sectab
3861 = (COFF_section*) (
3862 ((UChar*)(oc->image))
3863 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
3864 );
3865 // String is longer than 8 bytes, swap in the proper
3866 // (NULL-terminated) version, and make a note that this
3867 // is a long name.
3868 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3869 UInt32 strtab_offset = * (UInt32*)(name+4);
3870 name = ((UChar*)strtab) + strtab_offset;
3871 long_name = rtsTrue;
3872 }
3873 for (i = 0; i < hdr->NumberOfSections; i++) {
3874 UChar* n1;
3875 UChar* n2;
3876 COFF_section* section_i
3877 = (COFF_section*)
3878 myindex ( sizeof_COFF_section, sectab, i );
3879 n1 = (UChar*) &(section_i->Name);
3880 n2 = name;
3881 // Long section names are prefixed with a slash, see
3882 // also cstring_from_section_name
3883 if (n1[0] == '/' && long_name) {
3884 // Long name check
3885 // We don't really want to make an assumption that the string
3886 // table indexes are the same, so we'll do a proper check.
3887 int n1_strtab_offset = strtol((char*)n1+1,NULL,10);
3888 n1 = (UChar*) (((char*)strtab) + n1_strtab_offset);
3889 if (0==strcmp((const char*)n1, (const char*)n2)) {
3890 return section_i;
3891 }
3892 } else if (n1[0] != '/' && !long_name) {
3893 // Short name check
3894 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
3895 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
3896 n1[6]==n2[6] && n1[7]==n2[7]) {
3897 return section_i;
3898 }
3899 } else {
3900 // guaranteed to mismatch, because we never attempt to link
3901 // in an executable where the section name may be truncated
3902 }
3903 }
3904
3905 return NULL;
3906 }
3907
3908 static void
3909 zapTrailingAtSign ( UChar* sym )
3910 {
3911 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
3912 int i, j;
3913 if (sym[0] == 0) return;
3914 i = 0;
3915 while (sym[i] != 0) i++;
3916 i--;
3917 j = i;
3918 while (j > 0 && my_isdigit(sym[j])) j--;
3919 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
3920 # undef my_isdigit
3921 }
3922
3923 static void *
3924 lookupSymbolInDLLs ( UChar *lbl )
3925 {
3926 OpenedDLL* o_dll;
3927 void *sym;
3928
3929 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
3930 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
3931
3932 if (lbl[0] == '_') {
3933 /* HACK: if the name has an initial underscore, try stripping
3934 it off & look that up first. I've yet to verify whether there's
3935 a Rule that governs whether an initial '_' *should always* be
3936 stripped off when mapping from import lib name to the DLL name.
3937 */
3938 sym = GetProcAddress(o_dll->instance, (char*)(lbl+1));
3939 if (sym != NULL) {
3940 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
3941 return sym;
3942 }
3943 }
3944
3945 /* Ticket #2283.
3946 Long description: http://support.microsoft.com/kb/132044
3947 tl;dr:
3948 If C/C++ compiler sees __declspec(dllimport) ... foo ...
3949 it generates call *__imp_foo, and __imp_foo here has exactly
3950 the same semantics as in __imp_foo = GetProcAddress(..., "foo")
3951 */
3952 if (sym == NULL && strncmp ((const char*)lbl, "__imp_", 6) == 0) {
3953 sym = GetProcAddress(o_dll->instance, (char*)(lbl+6));
3954 if (sym != NULL) {
3955 IndirectAddr* ret;
3956 ret = stgMallocBytes( sizeof(IndirectAddr), "lookupSymbolInDLLs" );
3957 ret->addr = sym;
3958 ret->next = indirects;
3959 indirects = ret;
3960 errorBelch("warning: %s from %S is linked instead of %s",
3961 (char*)(lbl+6), o_dll->name, (char*)lbl);
3962 return (void*) & ret->addr;
3963 }
3964 }
3965
3966 sym = GetProcAddress(o_dll->instance, (char*)lbl);
3967 if (sym != NULL) {
3968 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
3969 return sym;
3970 }
3971 }
3972 return NULL;
3973 }
3974
3975 static int
3976 verifyCOFFHeader (COFF_header *hdr, pathchar *fileName)
3977 {
3978 #if defined(i386_HOST_ARCH)
3979 if (hdr->Machine != 0x14c) {
3980 errorBelch("%" PATH_FMT ": Not x86 PEi386", fileName);
3981 return 0;
3982 }
3983 #elif defined(x86_64_HOST_ARCH)
3984 if (hdr->Machine != 0x8664) {
3985 errorBelch("%" PATH_FMT ": Not x86_64 PEi386", fileName);
3986 return 0;
3987 }
3988 #else
3989 errorBelch("PEi386 not supported on this arch");
3990 #endif
3991
3992 if (hdr->SizeOfOptionalHeader != 0) {
3993 errorBelch("%" PATH_FMT ": PEi386 with nonempty optional header",
3994 fileName);
3995 return 0;
3996 }
3997 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
3998 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
3999 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
4000 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
4001 errorBelch("%" PATH_FMT ": Not a PEi386 object file", fileName);
4002 return 0;
4003 }
4004 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
4005 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
4006 errorBelch("%" PATH_FMT ": Invalid PEi386 word size or endiannness: %d",
4007 fileName,
4008 (int)(hdr->Characteristics));
4009 return 0;
4010 }
4011 return 1;
4012 }
4013
4014 static int
4015 ocVerifyImage_PEi386 ( ObjectCode* oc )
4016 {
4017 int i;
4018 UInt32 j, noRelocs;
4019 COFF_header* hdr;
4020 COFF_section* sectab;
4021 COFF_symbol* symtab;
4022 UChar* strtab;
4023 /* debugBelch("\nLOADING %s\n", oc->fileName); */
4024 hdr = (COFF_header*)(oc->image);
4025 sectab = (COFF_section*) (
4026 ((UChar*)(oc->image))
4027 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
4028 );
4029 symtab = (COFF_symbol*) (
4030 ((UChar*)(oc->image))
4031 + hdr->PointerToSymbolTable
4032 );
4033 strtab = ((UChar*)symtab)
4034 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
4035
4036 if (!verifyCOFFHeader(hdr, oc->fileName)) {
4037 return 0;
4038 }
4039
4040 /* If the string table size is way crazy, this might indicate that
4041 there are more than 64k relocations, despite claims to the
4042 contrary. Hence this test. */
4043 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
4044 #if 0
4045 if ( (*(UInt32*)strtab) > 600000 ) {
4046 /* Note that 600k has no special significance other than being
4047 big enough to handle the almost-2MB-sized lumps that
4048 constitute HSwin32*.o. */
4049 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
4050 return 0;
4051 }
4052 #endif
4053
4054 /* No further verification after this point; only debug printing. */
4055 i = 0;
4056 IF_DEBUG(linker, i=1);
4057 if (i == 0)