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