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