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