Revert "Revert "Make the linker API thread-safe""
[ghc.git] / rts / Linker.c
1 /* -----------------------------------------------------------------------------
2 *
3 * (c) The GHC Team, 2000-2012
4 *
5 * RTS Object Linker
6 *
7 * ---------------------------------------------------------------------------*/
8
9 #if 0
10 #include "PosixSource.h"
11 #endif
12
13 /* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14 MREMAP_MAYMOVE from <sys/mman.h>.
15 */
16 #if defined(__linux__) || defined(__GLIBC__)
17 #define _GNU_SOURCE 1
18 #endif
19
20 #include "Rts.h"
21 #include "HsFFI.h"
22
23 #include "sm/Storage.h"
24 #include "Stats.h"
25 #include "Hash.h"
26 #include "LinkerInternals.h"
27 #include "RtsUtils.h"
28 #include "Trace.h"
29 #include "StgPrimFloat.h" // for __int_encodeFloat etc.
30 #include "Proftimer.h"
31 #include "GetEnv.h"
32 #include "Stable.h"
33
34 #if !defined(mingw32_HOST_OS)
35 #include "posix/Signals.h"
36 #endif
37
38 // get protos for is*()
39 #include <ctype.h>
40
41 #ifdef HAVE_SYS_TYPES_H
42 #include <sys/types.h>
43 #endif
44
45 #include <inttypes.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <stdio.h>
49 #include <assert.h>
50 #include <libgen.h>
51
52 #ifdef HAVE_SYS_STAT_H
53 #include <sys/stat.h>
54 #endif
55
56 #if defined(HAVE_DLFCN_H)
57 #include <dlfcn.h>
58 #endif
59
60 #if defined(cygwin32_HOST_OS)
61 #ifdef HAVE_DIRENT_H
62 #include <dirent.h>
63 #endif
64
65 #ifdef HAVE_SYS_TIME_H
66 #include <sys/time.h>
67 #endif
68 #include <regex.h>
69 #include <sys/fcntl.h>
70 #include <sys/termios.h>
71 #include <sys/utime.h>
72 #include <sys/utsname.h>
73 #include <sys/wait.h>
74 #endif
75
76 #if (defined(powerpc_HOST_ARCH) && defined(linux_HOST_OS)) \
77 || (!defined(powerpc_HOST_ARCH) && \
78 ( defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || \
79 defined(dragonfly_HOST_OS) || defined(netbsd_HOST_OS ) || \
80 defined(openbsd_HOST_OS ) || defined(darwin_HOST_OS ) || \
81 defined(kfreebsdgnu_HOST_OS) || defined(gnu_HOST_OS)))
82 /* Don't use mmap on powerpc_HOST_ARCH as mmap doesn't support
83 * reallocating but we need to allocate jump islands just after each
84 * object images. Otherwise relative branches to jump islands can fail
85 * due to 24-bits displacement overflow.
86 */
87 #define USE_MMAP
88 #include <fcntl.h>
89 #include <sys/mman.h>
90
91 #ifdef HAVE_UNISTD_H
92 #include <unistd.h>
93 #endif
94
95 #endif
96
97
98 /* PowerPC has relative branch instructions with only 24 bit displacements
99 * and therefore needs jump islands contiguous with each object code module.
100 */
101 #if (defined(USE_MMAP) && defined(powerpc_HOST_ARCH) && defined(linux_HOST_OS))
102 #define USE_CONTIGUOUS_MMAP 1
103 #else
104 #define USE_CONTIGUOUS_MMAP 0
105 #endif
106
107 #if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(kfreebsdgnu_HOST_OS) || defined(dragonfly_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS) || defined(gnu_HOST_OS)
108 # define OBJFORMAT_ELF
109 # include <regex.h> // regex is already used by dlopen() so this is OK
110 // to use here without requiring an additional lib
111 #elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
112 # define OBJFORMAT_PEi386
113 # include <windows.h>
114 # include <math.h>
115 #elif defined(darwin_HOST_OS)
116 # define OBJFORMAT_MACHO
117 # include <regex.h>
118 # include <mach/machine.h>
119 # include <mach-o/fat.h>
120 # include <mach-o/loader.h>
121 # include <mach-o/nlist.h>
122 # include <mach-o/reloc.h>
123 #if !defined(HAVE_DLFCN_H)
124 # include <mach-o/dyld.h>
125 #endif
126 #if defined(powerpc_HOST_ARCH)
127 # include <mach-o/ppc/reloc.h>
128 #endif
129 #if defined(x86_64_HOST_ARCH)
130 # include <mach-o/x86_64/reloc.h>
131 #endif
132 #endif
133
134 #if defined(x86_64_HOST_ARCH) && defined(darwin_HOST_OS)
135 #define ALWAYS_PIC
136 #endif
137
138 #if defined(dragonfly_HOST_OS)
139 #include <sys/tls.h>
140 #endif
141
142 typedef struct _RtsSymbolInfo {
143 void *value;
144 const ObjectCode *owner;
145 HsBool weak;
146 } RtsSymbolInfo;
147
148 /* Hash table mapping symbol names to RtsSymbolInfo */
149 static /*Str*/HashTable *symhash;
150
151 /* List of currently loaded objects */
152 ObjectCode *objects = NULL; /* initially empty */
153
154 /* List of objects that have been unloaded via unloadObj(), but are waiting
155 to be actually freed via checkUnload() */
156 ObjectCode *unloaded_objects = NULL; /* initially empty */
157
158 #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 RTS_USER_SIGNALS_SYMBOLS \
1422 RTS_INTCHAR_SYMBOLS
1423
1424
1425 // 64-bit support functions in libgcc.a
1426 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4 && !defined(_ABIN32)
1427 #define RTS_LIBGCC_SYMBOLS \
1428 SymI_NeedsProto(__divdi3) \
1429 SymI_NeedsProto(__udivdi3) \
1430 SymI_NeedsProto(__moddi3) \
1431 SymI_NeedsProto(__umoddi3) \
1432 SymI_NeedsProto(__muldi3) \
1433 SymI_NeedsProto(__ashldi3) \
1434 SymI_NeedsProto(__ashrdi3) \
1435 SymI_NeedsProto(__lshrdi3) \
1436 SymI_NeedsProto(__fixunsdfdi)
1437 #else
1438 #define RTS_LIBGCC_SYMBOLS
1439 #endif
1440
1441 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
1442 // Symbols that don't have a leading underscore
1443 // on Mac OS X. They have to receive special treatment,
1444 // see machoInitSymbolsWithoutUnderscore()
1445 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
1446 SymI_NeedsProto(saveFP) \
1447 SymI_NeedsProto(restFP)
1448 #endif
1449
1450 /* entirely bogus claims about types of these symbols */
1451 #define SymI_NeedsProto(vvv) extern void vvv(void);
1452 #if defined(COMPILING_WINDOWS_DLL)
1453 #define SymE_HasProto(vvv) SymE_HasProto(vvv);
1454 # if defined(x86_64_HOST_ARCH)
1455 # define SymE_NeedsProto(vvv) extern void __imp_ ## vvv (void);
1456 # else
1457 # define SymE_NeedsProto(vvv) extern void _imp__ ## vvv (void);
1458 # endif
1459 #else
1460 #define SymE_NeedsProto(vvv) SymI_NeedsProto(vvv);
1461 #define SymE_HasProto(vvv) SymI_HasProto(vvv)
1462 #endif
1463 #define SymI_HasProto(vvv) /**/
1464 #define SymI_HasProto_redirect(vvv,xxx) /**/
1465 RTS_SYMBOLS
1466 RTS_RET_SYMBOLS
1467 RTS_POSIX_ONLY_SYMBOLS
1468 RTS_MINGW_ONLY_SYMBOLS
1469 RTS_CYGWIN_ONLY_SYMBOLS
1470 RTS_DARWIN_ONLY_SYMBOLS
1471 RTS_LIBGCC_SYMBOLS
1472 RTS_LIBFFI_SYMBOLS
1473 #undef SymI_NeedsProto
1474 #undef SymI_HasProto
1475 #undef SymI_HasProto_redirect
1476 #undef SymE_HasProto
1477 #undef SymE_NeedsProto
1478
1479 #ifdef LEADING_UNDERSCORE
1480 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
1481 #else
1482 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
1483 #endif
1484
1485 #define SymI_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1486 (void*)(&(vvv)) },
1487 #define SymE_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1488 (void*)DLL_IMPORT_DATA_REF(vvv) },
1489
1490 #define SymI_NeedsProto(vvv) SymI_HasProto(vvv)
1491 #define SymE_NeedsProto(vvv) SymE_HasProto(vvv)
1492
1493 // SymI_HasProto_redirect allows us to redirect references to one symbol to
1494 // another symbol. See newCAF/newDynCAF for an example.
1495 #define SymI_HasProto_redirect(vvv,xxx) \
1496 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
1497 (void*)(&(xxx)) },
1498
1499 static RtsSymbolVal rtsSyms[] = {
1500 RTS_SYMBOLS
1501 RTS_RET_SYMBOLS
1502 RTS_POSIX_ONLY_SYMBOLS
1503 RTS_MINGW_ONLY_SYMBOLS
1504 RTS_CYGWIN_ONLY_SYMBOLS
1505 RTS_DARWIN_ONLY_SYMBOLS
1506 RTS_LIBGCC_SYMBOLS
1507 RTS_LIBFFI_SYMBOLS
1508 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
1509 // dyld stub code contains references to this,
1510 // but it should never be called because we treat
1511 // lazy pointers as nonlazy.
1512 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
1513 #endif
1514 { 0, 0 } /* sentinel */
1515 };
1516
1517
1518 /* -----------------------------------------------------------------------------
1519 * Insert symbols into hash tables, checking for duplicates.
1520 *
1521 * Returns: 0 on failure, nonzero on success
1522 */
1523
1524 static int ghciInsertSymbolTable(
1525 pathchar* obj_name,
1526 HashTable *table,
1527 char* key,
1528 void *data,
1529 HsBool weak,
1530 ObjectCode *owner)
1531 {
1532 RtsSymbolInfo *pinfo = lookupStrHashTable(table, key);
1533 if (!pinfo) /* new entry */
1534 {
1535 pinfo = stgMallocBytes(sizeof (*pinfo), "ghciInsertToSymbolTable");
1536 pinfo->value = data;
1537 pinfo->owner = owner;
1538 pinfo->weak = weak;
1539 insertStrHashTable(table, key, pinfo);
1540 return 1;
1541 }
1542 else if ((!pinfo->weak || pinfo->value) && weak)
1543 {
1544 return 1; /* duplicate weak symbol, throw it away */
1545 }
1546 else if (pinfo->weak) /* weak symbol is in the table */
1547 {
1548 /* override the weak definition with the non-weak one */
1549 pinfo->value = data;
1550 pinfo->owner = owner;
1551 pinfo->weak = HS_BOOL_FALSE;
1552 return 1;
1553 }
1554 debugBelch(
1555 "GHC runtime linker: fatal error: I found a duplicate definition for symbol\n"
1556 " %s\n"
1557 "whilst processing object file\n"
1558 " %" PATH_FMT "\n"
1559 "This could be caused by:\n"
1560 " * Loading two different object files which export the same symbol\n"
1561 " * Specifying the same object file twice on the GHCi command line\n"
1562 " * An incorrect `package.conf' entry, causing some object to be\n"
1563 " loaded twice.\n",
1564 (char*)key,
1565 obj_name
1566 );
1567 return 0;
1568 }
1569
1570 static HsBool ghciLookupSymbolTable(HashTable *table,
1571 const char *key, void **result)
1572 {
1573 RtsSymbolInfo *pinfo = lookupStrHashTable(table, key);
1574 if (!pinfo) {
1575 *result = NULL;
1576 return HS_BOOL_FALSE;
1577 }
1578 if (pinfo->weak)
1579 IF_DEBUG(linker, debugBelch("lookup: promoting %s\n", key));
1580 /* Once it's looked up, it can no longer be overridden */
1581 pinfo->weak = HS_BOOL_FALSE;
1582
1583 *result = pinfo->value;
1584 return HS_BOOL_TRUE;
1585 }
1586
1587 static void ghciRemoveSymbolTable(HashTable *table, const char *key,
1588 ObjectCode *owner)
1589 {
1590 RtsSymbolInfo *pinfo = lookupStrHashTable(table, key);
1591 if (!pinfo || owner != pinfo->owner) return;
1592 removeStrHashTable(table, key, NULL);
1593 stgFree(pinfo);
1594 }
1595 /* -----------------------------------------------------------------------------
1596 * initialize the object linker
1597 */
1598
1599
1600 static int linker_init_done = 0 ;
1601
1602 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1603 static void *dl_prog_handle;
1604 static regex_t re_invalid;
1605 static regex_t re_realso;
1606 #ifdef THREADED_RTS
1607 static Mutex dl_mutex; // mutex to protect dlopen/dlerror critical section
1608 #endif
1609 #elif defined(OBJFORMAT_PEi386)
1610 void addDLLHandle(pathchar* dll_name, HINSTANCE instance);
1611 #endif
1612
1613 void initLinker (void)
1614 {
1615 // default to retaining CAFs for backwards compatibility. Most
1616 // users will want initLinker_(0): otherwise unloadObj() will not
1617 // be able to unload object files when they contain CAFs.
1618 initLinker_(1);
1619 }
1620
1621 void
1622 initLinker_ (int retain_cafs)
1623 {
1624 RtsSymbolVal *sym;
1625 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1626 int compileResult;
1627 #endif
1628
1629 IF_DEBUG(linker, debugBelch("initLinker: start\n"));
1630
1631 /* Make initLinker idempotent, so we can call it
1632 before every relevant operation; that means we
1633 don't need to initialise the linker separately */
1634 if (linker_init_done == 1) {
1635 IF_DEBUG(linker, debugBelch("initLinker: idempotent return\n"));
1636 return;
1637 } else {
1638 linker_init_done = 1;
1639 }
1640
1641 objects = NULL;
1642 unloaded_objects = NULL;
1643
1644 #if defined(THREADED_RTS)
1645 initMutex(&linker_mutex);
1646 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1647 initMutex(&dl_mutex);
1648 #endif
1649 #endif
1650 symhash = allocStrHashTable();
1651
1652 /* populate the symbol table with stuff from the RTS */
1653 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
1654 if (! ghciInsertSymbolTable(WSTR("(GHCi built-in symbols)"),
1655 symhash, sym->lbl, sym->addr, HS_BOOL_FALSE, NULL)) {
1656 barf("ghciInsertSymbolTable failed");
1657 }
1658 IF_DEBUG(linker, debugBelch("initLinker: inserting rts symbol %s, %p\n", sym->lbl, sym->addr));
1659 }
1660 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
1661 machoInitSymbolsWithoutUnderscore();
1662 # endif
1663 /* GCC defines a special symbol __dso_handle which is resolved to NULL if
1664 referenced from a statically linked module. We need to mimic this, but
1665 we cannot use NULL because we use it to mean nonexistent symbols. So we
1666 use an arbitrary (hopefully unique) address here.
1667 */
1668 if (! ghciInsertSymbolTable(WSTR("(GHCi special symbols)"),
1669 symhash, "__dso_handle", (void *)0x12345687, HS_BOOL_FALSE, NULL)) {
1670 barf("ghciInsertSymbolTable failed");
1671 }
1672
1673 // Redurect newCAF to newDynCAF if retain_cafs is true.
1674 if (! ghciInsertSymbolTable(WSTR("(GHCi built-in symbols)"), symhash,
1675 MAYBE_LEADING_UNDERSCORE_STR("newCAF"),
1676 retain_cafs ? newDynCAF : newCAF,
1677 HS_BOOL_FALSE, NULL)) {
1678 barf("ghciInsertSymbolTable failed");
1679 }
1680
1681 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1682 # if defined(RTLD_DEFAULT)
1683 dl_prog_handle = RTLD_DEFAULT;
1684 # else
1685 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
1686 # endif /* RTLD_DEFAULT */
1687
1688 compileResult = regcomp(&re_invalid,
1689 "(([^ \t()])+\\.so([^ \t:()])*):([ \t])*(invalid ELF header|file too short)",
1690 REG_EXTENDED);
1691 if (compileResult != 0) {
1692 barf("Compiling re_invalid failed");
1693 }
1694 compileResult = regcomp(&re_realso,
1695 "(GROUP|INPUT) *\\( *([^ )]+)",
1696 REG_EXTENDED);
1697 if (compileResult != 0) {
1698 barf("Compiling re_realso failed");
1699 }
1700 # endif
1701
1702 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
1703 if (RtsFlags.MiscFlags.linkerMemBase != 0) {
1704 // User-override for mmap_32bit_base
1705 mmap_32bit_base = (void*)RtsFlags.MiscFlags.linkerMemBase;
1706 }
1707 #endif
1708
1709 #if defined(mingw32_HOST_OS)
1710 /*
1711 * These two libraries cause problems when added to the static link,
1712 * but are necessary for resolving symbols in GHCi, hence we load
1713 * them manually here.
1714 */
1715 addDLL(WSTR("msvcrt"));
1716 addDLL(WSTR("kernel32"));
1717 addDLLHandle(WSTR("*.exe"), GetModuleHandle(NULL));
1718 #endif
1719
1720 IF_DEBUG(linker, debugBelch("initLinker: done\n"));
1721 return;
1722 }
1723
1724 void
1725 exitLinker( void ) {
1726 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1727 if (linker_init_done == 1) {
1728 regfree(&re_invalid);
1729 regfree(&re_realso);
1730 #ifdef THREADED_RTS
1731 closeMutex(&dl_mutex);
1732 #endif
1733 }
1734 #endif
1735 if (linker_init_done == 1) {
1736 freeHashTable(symhash, free);
1737 }
1738 #ifdef THREADED_RTS
1739 closeMutex(&linker_mutex);
1740 #endif
1741 }
1742
1743 /* -----------------------------------------------------------------------------
1744 * Loading DLL or .so dynamic libraries
1745 * -----------------------------------------------------------------------------
1746 *
1747 * Add a DLL from which symbols may be found. In the ELF case, just
1748 * do RTLD_GLOBAL-style add, so no further messing around needs to
1749 * happen in order that symbols in the loaded .so are findable --
1750 * lookupSymbol() will subsequently see them by dlsym on the program's
1751 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
1752 *
1753 * In the PEi386 case, open the DLLs and put handles to them in a
1754 * linked list. When looking for a symbol, try all handles in the
1755 * list. This means that we need to load even DLLs that are guaranteed
1756 * to be in the ghc.exe image already, just so we can get a handle
1757 * to give to loadSymbol, so that we can find the symbols. For such
1758 * libraries, the LoadLibrary call should be a no-op except for returning
1759 * the handle.
1760 *
1761 */
1762
1763 #if defined(OBJFORMAT_PEi386)
1764 /* A record for storing handles into DLLs. */
1765
1766 typedef
1767 struct _OpenedDLL {
1768 pathchar* name;
1769 struct _OpenedDLL* next;
1770 HINSTANCE instance;
1771 }
1772 OpenedDLL;
1773
1774 /* A list thereof. */
1775 static OpenedDLL* opened_dlls = NULL;
1776
1777 /* A record for storing indirectly linked functions from DLLs. */
1778 typedef
1779 struct _IndirectAddr {
1780 void* addr;
1781 struct _IndirectAddr* next;
1782 }
1783 IndirectAddr;
1784
1785 /* A list thereof. */
1786 static IndirectAddr* indirects = NULL;
1787
1788 /* Adds a DLL instance to the list of DLLs in which to search for symbols. */
1789 void addDLLHandle(pathchar* dll_name, HINSTANCE instance) {
1790 OpenedDLL* o_dll;
1791 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLLHandle" );
1792 o_dll->name = dll_name ? pathdup(dll_name) : NULL;
1793 o_dll->instance = instance;
1794 o_dll->next = opened_dlls;
1795 opened_dlls = o_dll;
1796 }
1797
1798 #endif
1799
1800 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1801
1802 /* Suppose in ghci we load a temporary SO for a module containing
1803 f = 1
1804 and then modify the module, recompile, and load another temporary
1805 SO with
1806 f = 2
1807 Then as we don't unload the first SO, dlsym will find the
1808 f = 1
1809 symbol whereas we want the
1810 f = 2
1811 symbol. We therefore need to keep our own SO handle list, and
1812 try SOs in the right order. */
1813
1814 typedef
1815 struct _OpenedSO {
1816 struct _OpenedSO* next;
1817 void *handle;
1818 }
1819 OpenedSO;
1820
1821 /* A list thereof. */
1822 static OpenedSO* openedSOs = NULL;
1823
1824 static const char *
1825 internal_dlopen(const char *dll_name)
1826 {
1827 OpenedSO* o_so;
1828 void *hdl;
1829 const char *errmsg;
1830 char *errmsg_copy;
1831
1832 // omitted: RTLD_NOW
1833 // see http://www.haskell.org/pipermail/cvs-ghc/2007-September/038570.html
1834 IF_DEBUG(linker,
1835 debugBelch("internal_dlopen: dll_name = '%s'\n", dll_name));
1836
1837 //-------------- Begin critical section ------------------
1838 // This critical section is necessary because dlerror() is not
1839 // required to be reentrant (see POSIX -- IEEE Std 1003.1-2008)
1840 // Also, the error message returned must be copied to preserve it
1841 // (see POSIX also)
1842
1843 ACQUIRE_LOCK(&dl_mutex);
1844 hdl = dlopen(dll_name, RTLD_LAZY|RTLD_LOCAL); /* see Note [RTLD_LOCAL] */
1845
1846 errmsg = NULL;
1847 if (hdl == NULL) {
1848 /* dlopen failed; return a ptr to the error msg. */
1849 errmsg = dlerror();
1850 if (errmsg == NULL) errmsg = "addDLL: unknown error";
1851 errmsg_copy = stgMallocBytes(strlen(errmsg)+1, "addDLL");
1852 strcpy(errmsg_copy, errmsg);
1853 errmsg = errmsg_copy;
1854 } else {
1855 o_so = stgMallocBytes(sizeof(OpenedSO), "addDLL");
1856 o_so->handle = hdl;
1857 o_so->next = openedSOs;
1858 openedSOs = o_so;
1859 }
1860
1861 RELEASE_LOCK(&dl_mutex);
1862 //--------------- End critical section -------------------
1863
1864 return errmsg;
1865 }
1866
1867 /*
1868 Note [RTLD_LOCAL]
1869
1870 In GHCi we want to be able to override previous .so's with newly
1871 loaded .so's when we recompile something. This further implies that
1872 when we look up a symbol in internal_dlsym() we have to iterate
1873 through the loaded libraries (in order from most recently loaded to
1874 oldest) looking up the symbol in each one until we find it.
1875
1876 However, this can cause problems for some symbols that are copied
1877 by the linker into the executable image at runtime - see #8935 for a
1878 lengthy discussion. To solve that problem we need to look up
1879 symbols in the main executable *first*, before attempting to look
1880 them up in the loaded .so's. But in order to make that work, we
1881 have to always call dlopen with RTLD_LOCAL, so that the loaded
1882 libraries don't populate the global symbol table.
1883 */
1884
1885 static void *
1886 internal_dlsym(const char *symbol) {
1887 OpenedSO* o_so;
1888 void *v;
1889
1890 // We acquire dl_mutex as concurrent dl* calls may alter dlerror
1891 ACQUIRE_LOCK(&dl_mutex);
1892 dlerror();
1893 // look in program first
1894 v = dlsym(dl_prog_handle, symbol);
1895 if (dlerror() == NULL) {
1896 RELEASE_LOCK(&dl_mutex);
1897 return v;
1898 }
1899
1900 for (o_so = openedSOs; o_so != NULL; o_so = o_so->next) {
1901 v = dlsym(o_so->handle, symbol);
1902 if (dlerror() == NULL) {
1903 RELEASE_LOCK(&dl_mutex);
1904 return v;
1905 }
1906 }
1907 RELEASE_LOCK(&dl_mutex);
1908 return v;
1909 }
1910 # endif
1911
1912 const char *
1913 addDLL( pathchar *dll_name )
1914 {
1915 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1916 /* ------------------- ELF DLL loader ------------------- */
1917
1918 #define NMATCH 5
1919 regmatch_t match[NMATCH];
1920 const char *errmsg;
1921 FILE* fp;
1922 size_t match_length;
1923 #define MAXLINE 1000
1924 char line[MAXLINE];
1925 int result;
1926
1927 IF_DEBUG(linker, debugBelch("addDLL: dll_name = '%s'\n", dll_name));
1928 errmsg = internal_dlopen(dll_name);
1929
1930 if (errmsg == NULL) {
1931 return NULL;
1932 }
1933
1934 // GHC Trac ticket #2615
1935 // On some systems (e.g., Gentoo Linux) dynamic files (e.g. libc.so)
1936 // contain linker scripts rather than ELF-format object code. This
1937 // code handles the situation by recognizing the real object code
1938 // file name given in the linker script.
1939 //
1940 // If an "invalid ELF header" error occurs, it is assumed that the
1941 // .so file contains a linker script instead of ELF object code.
1942 // In this case, the code looks for the GROUP ( ... ) linker
1943 // directive. If one is found, the first file name inside the
1944 // parentheses is treated as the name of a dynamic library and the
1945 // code attempts to dlopen that file. If this is also unsuccessful,
1946 // an error message is returned.
1947
1948 // see if the error message is due to an invalid ELF header
1949 IF_DEBUG(linker, debugBelch("errmsg = '%s'\n", errmsg));
1950 result = regexec(&re_invalid, errmsg, (size_t) NMATCH, match, 0);
1951 IF_DEBUG(linker, debugBelch("result = %i\n", result));
1952 if (result == 0) {
1953 // success -- try to read the named file as a linker script
1954 match_length = (size_t) stg_min((match[1].rm_eo - match[1].rm_so),
1955 MAXLINE-1);
1956 strncpy(line, (errmsg+(match[1].rm_so)),match_length);
1957 line[match_length] = '\0'; // make sure string is null-terminated
1958 IF_DEBUG(linker, debugBelch ("file name = '%s'\n", line));
1959 if ((fp = fopen(line, "r")) == NULL) {
1960 return errmsg; // return original error if open fails
1961 }
1962 // try to find a GROUP or INPUT ( ... ) command
1963 while (fgets(line, MAXLINE, fp) != NULL) {
1964 IF_DEBUG(linker, debugBelch("input line = %s", line));
1965 if (regexec(&re_realso, line, (size_t) NMATCH, match, 0) == 0) {
1966 // success -- try to dlopen the first named file
1967 IF_DEBUG(linker, debugBelch("match%s\n",""));
1968 line[match[2].rm_eo] = '\0';
1969 stgFree((void*)errmsg); // Free old message before creating new one
1970 errmsg = internal_dlopen(line+match[2].rm_so);
1971 break;
1972 }
1973 // if control reaches here, no GROUP or INPUT ( ... ) directive
1974 // was found and the original error message is returned to the
1975 // caller
1976 }
1977 fclose(fp);
1978 }
1979 return errmsg;
1980
1981 # elif defined(OBJFORMAT_PEi386)
1982 /* ------------------- Win32 DLL loader ------------------- */
1983
1984 pathchar* buf;
1985 OpenedDLL* o_dll;
1986 HINSTANCE instance;
1987
1988 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1989
1990 /* See if we've already got it, and ignore if so. */
1991 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1992 if (0 == pathcmp(o_dll->name, dll_name))
1993 return NULL;
1994 }
1995
1996 /* The file name has no suffix (yet) so that we can try
1997 both foo.dll and foo.drv
1998
1999 The documentation for LoadLibrary says:
2000 If no file name extension is specified in the lpFileName
2001 parameter, the default library extension .dll is
2002 appended. However, the file name string can include a trailing
2003 point character (.) to indicate that the module name has no
2004 extension. */
2005
2006 size_t bufsize = pathlen(dll_name) + 10;
2007 buf = stgMallocBytes(bufsize * sizeof(wchar_t), "addDLL");
2008 snwprintf(buf, bufsize, L"%s.DLL", dll_name);
2009 instance = LoadLibraryW(buf);
2010 if (instance == NULL) {
2011 if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
2012 // KAA: allow loading of drivers (like winspool.drv)
2013 snwprintf(buf, bufsize, L"%s.DRV", dll_name);
2014 instance = LoadLibraryW(buf);
2015 if (instance == NULL) {
2016 if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
2017 // #1883: allow loading of unix-style libfoo.dll DLLs
2018 snwprintf(buf, bufsize, L"lib%s.DLL", dll_name);
2019 instance = LoadLibraryW(buf);
2020 if (instance == NULL) {
2021 goto error;
2022 }
2023 }
2024 }
2025 stgFree(buf);
2026
2027 addDLLHandle(dll_name, instance);
2028
2029 return NULL;
2030
2031 error:
2032 stgFree(buf);
2033 sysErrorBelch("%" PATH_FMT, dll_name);
2034
2035 /* LoadLibrary failed; return a ptr to the error msg. */
2036 return "addDLL: could not load DLL";
2037
2038 # else
2039 barf("addDLL: not implemented on this platform");
2040 # endif
2041 }
2042
2043 /* -----------------------------------------------------------------------------
2044 * insert a symbol in the hash table
2045 *
2046 * Returns: 0 on failure, nozero on success
2047 */
2048 HsInt insertSymbol(pathchar* obj_name, char* key, void* data)
2049 {
2050 return ghciInsertSymbolTable(obj_name, symhash, key, data, HS_BOOL_FALSE, NULL);
2051 }
2052
2053 /* -----------------------------------------------------------------------------
2054 * lookup a symbol in the hash table
2055 */
2056 static void* lookupSymbol_ (char *lbl)
2057 {
2058 void *val;
2059 IF_DEBUG(linker, debugBelch("lookupSymbol: looking up %s\n", lbl));
2060
2061 ASSERT(symhash != NULL);
2062
2063 if (!ghciLookupSymbolTable(symhash, lbl, &val)) {
2064 IF_DEBUG(linker, debugBelch("lookupSymbol: symbol not found\n"));
2065 # if defined(OBJFORMAT_ELF)
2066 return internal_dlsym(lbl);
2067 # elif defined(OBJFORMAT_MACHO)
2068 # if HAVE_DLFCN_H
2069 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
2070 interface.
2071
2072 HACK: On OS X, all symbols are prefixed with an underscore.
2073 However, dlsym wants us to omit the leading underscore from the
2074 symbol name -- the dlsym routine puts it back on before searching
2075 for the symbol. For now, we simply strip it off here (and ONLY
2076 here).
2077 */
2078 IF_DEBUG(linker, debugBelch("lookupSymbol: looking up %s with dlsym\n", lbl));
2079 ASSERT(lbl[0] == '_');
2080 return internal_dlsym(lbl + 1);
2081 # else
2082 if (NSIsSymbolNameDefined(lbl)) {
2083 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
2084 return NSAddressOfSymbol(symbol);
2085 } else {
2086 return NULL;
2087 }
2088 # endif /* HAVE_DLFCN_H */
2089 # elif defined(OBJFORMAT_PEi386)
2090 void* sym;
2091
2092 sym = lookupSymbolInDLLs((unsigned char*)lbl);
2093 if (sym != NULL) {
2094 return sym;
2095 };
2096
2097 // Also try looking up the symbol without the @N suffix. Some
2098 // DLLs have the suffixes on their symbols, some don't.
2099 zapTrailingAtSign ( (unsigned char*)lbl );
2100 sym = lookupSymbolInDLLs((unsigned char*)lbl);
2101 return sym; // might be NULL if not found
2102
2103 # else
2104 ASSERT(2+2 == 5);
2105 return NULL;
2106 # endif
2107 } else {
2108 IF_DEBUG(linker, debugBelch("lookupSymbol: value of %s is %p\n", lbl, val));
2109 return val;
2110 }
2111 }
2112
2113 void* lookupSymbol( char *lbl )
2114 {
2115 ACQUIRE_LOCK(&linker_mutex);
2116 char *r = lookupSymbol_(lbl);
2117 RELEASE_LOCK(&linker_mutex);
2118 return r;
2119 }
2120
2121 /* -----------------------------------------------------------------------------
2122 Create a StablePtr for a foreign export. This is normally called by
2123 a C function with __attribute__((constructor)), which is generated
2124 by GHC and linked into the module.
2125
2126 If the object code is being loaded dynamically, then we remember
2127 which StablePtrs were allocated by the constructors and free them
2128 again in unloadObj().
2129 -------------------------------------------------------------------------- */
2130
2131 static ObjectCode *loading_obj = NULL;
2132
2133 StgStablePtr foreignExportStablePtr (StgPtr p)
2134 {
2135 ForeignExportStablePtr *fe_sptr;
2136 StgStablePtr *sptr;
2137
2138 sptr = getStablePtr(p);
2139
2140 if (loading_obj != NULL) {
2141 fe_sptr = stgMallocBytes(sizeof(ForeignExportStablePtr),
2142 "foreignExportStablePtr");
2143 fe_sptr->stable_ptr = sptr;
2144 fe_sptr->next = loading_obj->stable_ptrs;
2145 loading_obj->stable_ptrs = fe_sptr;
2146 }
2147
2148 return sptr;
2149 }
2150
2151
2152 /* -----------------------------------------------------------------------------
2153 * Debugging aid: look in GHCi's object symbol tables for symbols
2154 * within DELTA bytes of the specified address, and show their names.
2155 */
2156 #ifdef DEBUG
2157 void ghci_enquire ( char* addr );
2158
2159 void ghci_enquire ( char* addr )
2160 {
2161 int i;
2162 char* sym;
2163 char* a;
2164 const int DELTA = 64;
2165 ObjectCode* oc;
2166
2167 for (oc = objects; oc; oc = oc->next) {
2168 for (i = 0; i < oc->n_symbols; i++) {
2169 sym = oc->symbols[i];
2170 if (sym == NULL) continue;
2171 a = NULL;
2172 if (a == NULL) {
2173 ghciLookupSymbolTable(symhash, sym, (void **)&a);
2174 }
2175 if (a == NULL) {
2176 // debugBelch("ghci_enquire: can't find %s\n", sym);
2177 }
2178 else if (addr-DELTA <= a && a <= addr+DELTA) {
2179 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
2180 }
2181 }
2182 }
2183 }
2184 #endif
2185
2186 #ifdef USE_MMAP
2187 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
2188
2189 //
2190 // Returns NULL on failure.
2191 //
2192 static void * mmapForLinker (size_t bytes, nat flags, int fd)
2193 {
2194 void *map_addr = NULL;
2195 void *result;
2196 int pagesize;
2197 StgWord size;
2198 static nat fixed = 0;
2199
2200 IF_DEBUG(linker, debugBelch("mmapForLinker: start\n"));
2201 pagesize = getpagesize();
2202 size = ROUND_UP(bytes, pagesize);
2203
2204 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
2205 mmap_again:
2206
2207 if (mmap_32bit_base != 0) {
2208 map_addr = mmap_32bit_base;
2209 }
2210 #endif
2211
2212 IF_DEBUG(linker,
2213 debugBelch("mmapForLinker: \tprotection %#0x\n",
2214 PROT_EXEC | PROT_READ | PROT_WRITE));
2215 IF_DEBUG(linker,
2216 debugBelch("mmapForLinker: \tflags %#0x\n",
2217 MAP_PRIVATE | TRY_MAP_32BIT | fixed | flags));
2218
2219 result = mmap(map_addr, size,
2220 PROT_EXEC|PROT_READ|PROT_WRITE,
2221 MAP_PRIVATE|TRY_MAP_32BIT|fixed|flags, fd, 0);
2222
2223 if (result == MAP_FAILED) {
2224 sysErrorBelch("mmap %" FMT_Word " bytes at %p",(W_)size,map_addr);
2225 errorBelch("Try specifying an address with +RTS -xm<addr> -RTS");
2226 return NULL;
2227 }
2228
2229 #if !defined(ALWAYS_PIC) && defined(x86_64_HOST_ARCH)
2230 if (mmap_32bit_base != 0) {
2231 if (result == map_addr) {
2232 mmap_32bit_base = (StgWord8*)map_addr + size;
2233 } else {
2234 if ((W_)result > 0x80000000) {
2235 // oops, we were given memory over 2Gb
2236 munmap(result,size);
2237 #if defined(freebsd_HOST_OS) || \
2238 defined(kfreebsdgnu_HOST_OS) || \
2239 defined(dragonfly_HOST_OS)
2240 // Some platforms require MAP_FIXED. This is normally
2241 // a bad idea, because MAP_FIXED will overwrite
2242 // existing mappings.
2243 fixed = MAP_FIXED;
2244 goto mmap_again;
2245 #else
2246 errorBelch("loadObj: failed to mmap() memory below 2Gb; "
2247 "asked for %lu bytes at %p. "
2248 "Try specifying an address with +RTS -xm<addr> -RTS",
2249 size, map_addr);
2250 return NULL;
2251 #endif
2252 } else {
2253 // hmm, we were given memory somewhere else, but it's
2254 // still under 2Gb so we can use it. Next time, ask
2255 // for memory right after the place we just got some
2256 mmap_32bit_base = (StgWord8*)result + size;
2257 }
2258 }
2259 } else {
2260 if ((W_)result > 0x80000000) {
2261 // oops, we were given memory over 2Gb
2262 // ... try allocating memory somewhere else?;
2263 debugTrace(DEBUG_linker,
2264 "MAP_32BIT didn't work; gave us %lu bytes at 0x%p",
2265 bytes, result);
2266 munmap(result, size);
2267
2268 // Set a base address and try again... (guess: 1Gb)
2269 mmap_32bit_base = (void*)0x40000000;
2270 goto mmap_again;
2271 }
2272 }
2273 #endif
2274
2275 IF_DEBUG(linker,
2276 debugBelch("mmapForLinker: mapped %" FMT_Word
2277 " bytes starting at %p\n", (W_)size, result));
2278 IF_DEBUG(linker,
2279 debugBelch("mmapForLinker: done\n"));
2280
2281 return result;
2282 }
2283 #endif // USE_MMAP
2284
2285 static void removeOcSymbols (ObjectCode *oc)
2286 {
2287 if (oc->symbols == NULL) return;
2288
2289 /* Remove all the mappings for the symbols within this object..
2290 */
2291 int i;
2292 for (i = 0; i < oc->n_symbols; i++) {
2293 if (oc->symbols[i] != NULL) {
2294 ghciRemoveSymbolTable(symhash, oc->symbols[i], oc);
2295 }
2296 }
2297 }
2298
2299 /*
2300 * freeObjectCode() releases all the pieces of an ObjectCode. It is called by
2301 * the GC when a previously unloaded ObjectCode has been determined to be
2302 * unused, and when an error occurs during loadObj().
2303 */
2304 void freeObjectCode (ObjectCode *oc)
2305 {
2306 if (oc->symbols != NULL) {
2307 stgFree(oc->symbols);
2308 oc->symbols = NULL;
2309 }
2310
2311 {
2312 Section *s, *nexts;
2313
2314 for (s = oc->sections; s != NULL; s = nexts) {
2315 nexts = s->next;
2316 stgFree(s);
2317 }
2318 }
2319
2320 freeProddableBlocks(oc);
2321
2322 #ifdef USE_MMAP
2323 int pagesize, size, r;
2324
2325 pagesize = getpagesize();
2326 size = ROUND_UP(oc->fileSize, pagesize);
2327
2328 r = munmap(oc->image, size);
2329 if (r == -1) {
2330 sysErrorBelch("munmap");
2331 }
2332
2333 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
2334 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
2335 if (!USE_CONTIGUOUS_MMAP && oc->symbol_extras != NULL)
2336 {
2337 munmap(oc->symbol_extras,
2338 ROUND_UP(sizeof(SymbolExtra) * oc->n_symbol_extras, pagesize));
2339 }
2340 #endif
2341 #endif
2342
2343 #else
2344
2345 #ifndef mingw32_HOST_OS
2346 stgFree(oc->image);
2347 #else
2348 VirtualFree(oc->image - PEi386_IMAGE_OFFSET, 0, MEM_RELEASE);
2349
2350 IndirectAddr *ia, *ia_next;
2351 ia = indirects;
2352 while (ia != NULL) {
2353 ia_next = ia->next;
2354 stgFree(ia);
2355 ia = ia_next;
2356 }
2357
2358 #endif
2359
2360 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
2361 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
2362 stgFree(oc->symbol_extras);
2363 #endif
2364 #endif
2365
2366 #endif
2367
2368 stgFree(oc->fileName);
2369 stgFree(oc->archiveMemberName);
2370 stgFree(oc);
2371 }
2372
2373
2374 static ObjectCode*
2375 mkOc( pathchar *path, char *image, int imageSize,
2376 char *archiveMemberName
2377 #ifndef USE_MMAP
2378 #ifdef darwin_HOST_OS
2379 , int misalignment
2380 #endif
2381 #endif
2382 ) {
2383 ObjectCode* oc;
2384
2385 IF_DEBUG(linker, debugBelch("mkOc: start\n"));
2386 oc = stgMallocBytes(sizeof(ObjectCode), "mkOc(oc)");
2387
2388 # if defined(OBJFORMAT_ELF)
2389 oc->formatName = "ELF";
2390 # elif defined(OBJFORMAT_PEi386)
2391 oc->formatName = "PEi386";
2392 # elif defined(OBJFORMAT_MACHO)
2393 oc->formatName = "Mach-O";
2394 # else
2395 stgFree(oc);
2396 barf("loadObj: not implemented on this platform");
2397 # endif
2398
2399 oc->image = image;
2400 oc->fileName = pathdup(path);
2401
2402 if (archiveMemberName) {
2403 oc->archiveMemberName = stgMallocBytes( strlen(archiveMemberName)+1, "loadObj" );
2404 strcpy(oc->archiveMemberName, archiveMemberName);
2405 }
2406 else {
2407 oc->archiveMemberName = NULL;
2408 }
2409
2410 oc->fileSize = imageSize;
2411 oc->symbols = NULL;
2412 oc->sections = NULL;
2413 oc->proddables = NULL;
2414 oc->stable_ptrs = NULL;
2415 #if powerpc_HOST_ARCH || x86_64_HOST_ARCH || arm_HOST_ARCH
2416 oc->symbol_extras = NULL;
2417 #endif
2418
2419 #ifndef USE_MMAP
2420 #ifdef darwin_HOST_OS
2421 oc->misalignment = misalignment;
2422 #endif
2423 #endif
2424
2425 /* chain it onto the list of objects */
2426 oc->next = NULL;
2427
2428 IF_DEBUG(linker, debugBelch("mkOc: done\n"));
2429 return oc;
2430 }
2431
2432 /* -----------------------------------------------------------------------------
2433 * Check if an object or archive is already loaded.
2434 *
2435 * Returns: 1 if the path is already loaded, 0 otherwise.
2436 */
2437 static HsInt
2438 isAlreadyLoaded( pathchar *path )
2439 {
2440 ObjectCode *o;
2441 for (o = objects; o; o = o->next) {
2442 if (0 == pathcmp(o->fileName, path)) {
2443 return 1; /* already loaded */
2444 }
2445 }
2446 return 0; /* not loaded yet */
2447 }
2448
2449 static HsInt loadArchive_ (pathchar *path)
2450 {
2451 ObjectCode* oc;
2452 char *image;
2453 int memberSize;
2454 FILE *f;
2455 int n;
2456 size_t thisFileNameSize;
2457 char *fileName;
2458 size_t fileNameSize;
2459 int isObject, isGnuIndex, isThin;
2460 char tmp[20];
2461 char *gnuFileIndex;
2462 int gnuFileIndexSize;
2463 #if defined(darwin_HOST_OS)
2464 int i;
2465 uint32_t nfat_arch, nfat_offset, cputype, cpusubtype;
2466 #if defined(i386_HOST_ARCH)
2467 const uint32_t mycputype = CPU_TYPE_X86;
2468 const uint32_t mycpusubtype = CPU_SUBTYPE_X86_ALL;
2469 #elif defined(x86_64_HOST_ARCH)
2470 const uint32_t mycputype = CPU_TYPE_X86_64;
2471 const uint32_t mycpusubtype = CPU_SUBTYPE_X86_64_ALL;
2472 #elif defined(powerpc_HOST_ARCH)
2473 const uint32_t mycputype = CPU_TYPE_POWERPC;
2474 const uint32_t mycpusubtype = CPU_SUBTYPE_POWERPC_ALL;
2475 #elif defined(powerpc64_HOST_ARCH)
2476 const uint32_t mycputype = CPU_TYPE_POWERPC64;
2477 const uint32_t mycpusubtype = CPU_SUBTYPE_POWERPC_ALL;
2478 #else
2479 #error Unknown Darwin architecture
2480 #endif
2481 #if !defined(USE_MMAP)
2482 int misalignment;
2483 #endif
2484 #endif
2485
2486 /* TODO: don't call barf() on error, instead return an error code, freeing
2487 * all resources correctly. This function is pretty complex, so it needs
2488 * to be refactored to make this practical. */
2489
2490 IF_DEBUG(linker, debugBelch("loadArchive: start\n"));
2491 IF_DEBUG(linker, debugBelch("loadArchive: Loading archive `%" PATH_FMT" '\n", path));
2492
2493 /* Check that we haven't already loaded this archive.
2494 Ignore requests to load multiple times */
2495 if (isAlreadyLoaded(path)) {
2496 IF_DEBUG(linker,
2497 debugBelch("ignoring repeated load of %" PATH_FMT "\n", path));
2498 return 1; /* success */
2499 }
2500
2501 gnuFileIndex = NULL;
2502 gnuFileIndexSize = 0;
2503
2504 fileNameSize = 32;
2505 fileName = stgMallocBytes(fileNameSize, "loadArchive(fileName)");
2506
2507 isThin = 0;
2508
2509 f = pathopen(path, WSTR("rb"));
2510 if (!f)
2511 barf("loadObj: can't read `%s'", path);
2512
2513 /* Check if this is an archive by looking for the magic "!<arch>\n"
2514 * string. Usually, if this fails, we barf and quit. On Darwin however,
2515 * we may have a fat archive, which contains archives for more than
2516 * one architecture. Fat archives start with the magic number 0xcafebabe,
2517 * always stored big endian. If we find a fat_header, we scan through
2518 * the fat_arch structs, searching through for one for our host
2519 * architecture. If a matching struct is found, we read the offset
2520 * of our archive data (nfat_offset) and seek forward nfat_offset bytes
2521 * from the start of the file.
2522 *
2523 * A subtlety is that all of the members of the fat_header and fat_arch
2524 * structs are stored big endian, so we need to call byte order
2525 * conversion functions.
2526 *
2527 * If we find the appropriate architecture in a fat archive, we gobble
2528 * its magic "!<arch>\n" string and continue processing just as if
2529 * we had a single architecture archive.
2530 */
2531
2532 n = fread ( tmp, 1, 8, f );
2533 if (n != 8)
2534 barf("loadArchive: Failed reading header from `%s'", path);
2535 if (strncmp(tmp, "!<arch>\n", 8) == 0) {}
2536 #if !defined(mingw32_HOST_OS)
2537 /* See Note [thin archives on Windows] */
2538 else if (strncmp(tmp, "!<thin>\n", 8) == 0) {
2539 isThin = 1;
2540 }
2541 #endif
2542 #if defined(darwin_HOST_OS)
2543 /* Not a standard archive, look for a fat archive magic number: */
2544 else if (ntohl(*(uint32_t *)tmp) == FAT_MAGIC) {
2545 nfat_arch = ntohl(*(uint32_t *)(tmp + 4));
2546 IF_DEBUG(linker, debugBelch("loadArchive: found a fat archive containing %d architectures\n", nfat_arch));
2547 nfat_offset = 0;
2548
2549 for (i = 0; i < (int)nfat_arch; i++) {
2550 /* search for the right arch */
2551 n = fread( tmp, 1, 20, f );
2552 if (n != 8)
2553 barf("loadArchive: Failed reading arch from `%s'", path);
2554 cputype = ntohl(*(uint32_t *)tmp);
2555 cpusubtype = ntohl(*(uint32_t *)(tmp + 4));
2556
2557 if (cputype == mycputype && cpusubtype == mycpusubtype) {
2558 IF_DEBUG(linker, debugBelch("loadArchive: found my archive in a fat archive\n"));
2559 nfat_offset = ntohl(*(uint32_t *)(tmp + 8));
2560 break;
2561 }
2562 }
2563
2564 if (nfat_offset == 0) {
2565 barf ("loadArchive: searched %d architectures, but no host arch found", (int)nfat_arch);
2566 }
2567 else {
2568 n = fseek( f, nfat_offset, SEEK_SET );
2569 if (n != 0)
2570 barf("loadArchive: Failed to seek to arch in `%s'", path);
2571 n = fread ( tmp, 1, 8, f );
2572 if (n != 8)
2573 barf("loadArchive: Failed reading header from `%s'", path);
2574 if (strncmp(tmp, "!<arch>\n", 8) != 0) {
2575 barf("loadArchive: couldn't find archive in `%s' at offset %d", path, nfat_offset);
2576 }
2577 }
2578 }
2579 else {
2580 barf("loadArchive: Neither an archive, nor a fat archive: `%s'", path);
2581 }
2582 #else
2583 else {
2584 barf("loadArchive: Not an archive: `%s'", path);
2585 }
2586 #endif
2587
2588 IF_DEBUG(linker, debugBelch("loadArchive: loading archive contents\n"));
2589
2590 while(1) {
2591 n = fread ( fileName, 1, 16, f );
2592 if (n != 16) {
2593 if (feof(f)) {
2594 IF_DEBUG(linker, debugBelch("loadArchive: EOF while reading from '%" PATH_FMT "'\n", path));
2595 break;
2596 }
2597 else {
2598 barf("loadArchive: Failed reading file name from `%s'", path);
2599 }
2600 }
2601
2602 #if defined(darwin_HOST_OS)
2603 if (strncmp(fileName, "!<arch>\n", 8) == 0) {
2604 IF_DEBUG(linker, debugBelch("loadArchive: found the start of another archive, breaking\n"));
2605 break;
2606 }
2607 #endif
2608
2609 n = fread ( tmp, 1, 12, f );
2610 if (n != 12)
2611 barf("loadArchive: Failed reading mod time from `%s'", path);
2612 n = fread ( tmp, 1, 6, f );
2613 if (n != 6)
2614 barf("loadArchive: Failed reading owner from `%s'", path);
2615 n = fread ( tmp, 1, 6, f );
2616 if (n != 6)
2617 barf("loadArchive: Failed reading group from `%s'", path);
2618 n = fread ( tmp, 1, 8, f );
2619 if (n != 8)
2620 barf("loadArchive: Failed reading mode from `%s'", path);
2621 n = fread ( tmp, 1, 10, f );
2622 if (n != 10)
2623 barf("loadArchive: Failed reading size from `%s'", path);
2624 tmp[10] = '\0';
2625 for (n = 0; isdigit(tmp[n]); n++);
2626 tmp[n] = '\0';
2627 memberSize = atoi(tmp);
2628
2629 IF_DEBUG(linker, debugBelch("loadArchive: size of this archive member is %d\n", memberSize));
2630 n = fread ( tmp, 1, 2, f );
2631 if (n != 2)
2632 barf("loadArchive: Failed reading magic from `%s'", path);
2633 if (strncmp(tmp, "\x60\x0A", 2) != 0)
2634 barf("loadArchive: Failed reading magic from `%s' at %ld. Got %c%c",
2635 path, ftell(f), tmp[0], tmp[1]);
2636
2637 isGnuIndex = 0;
2638 /* Check for BSD-variant large filenames */
2639 if (0 == strncmp(fileName, "#1/", 3)) {
2640 fileName[16] = '\0';
2641 if (isdigit(fileName[3])) {
2642 for (n = 4; isdigit(fileName[n]); n++);
2643 fileName[n] = '\0';
2644 thisFileNameSize = atoi(fileName + 3);
2645 memberSize -= thisFileNameSize;
2646 if (thisFileNameSize >= fileNameSize) {
2647 /* Double it to avoid potentially continually
2648 increasing it by 1 */
2649 fileNameSize = thisFileNameSize * 2;
2650 fileName = stgReallocBytes(fileName, fileNameSize, "loadArchive(fileName)");
2651 }
2652 n = fread ( fileName, 1, thisFileNameSize, f );
2653 if (n != (int)thisFileNameSize) {
2654 barf("loadArchive: Failed reading filename from `%s'",
2655 path);
2656 }
2657 fileName[thisFileNameSize] = 0;
2658
2659 /* On OS X at least, thisFileNameSize is the size of the
2660 fileName field, not the length of the fileName
2661 itself. */
2662 thisFileNameSize = strlen(fileName);
2663 }
2664 else {
2665 barf("loadArchive: BSD-variant filename size not found while reading filename from `%s'", path);
2666 }
2667 }
2668 /* Check for GNU file index file */
2669 else if (0 == strncmp(fileName, "//", 2)) {
2670 fileName[0] = '\0';
2671 thisFileNameSize = 0;
2672 isGnuIndex = 1;
2673 }
2674 /* Check for a file in the GNU file index */
2675 else if (fileName[0] == '/') {
2676 if (isdigit(fileName[1])) {
2677 int i;
2678
2679 for (n = 2; isdigit(fileName[n]); n++);
2680 fileName[n] = '\0';
2681 n = atoi(fileName + 1);
2682
2683 if (gnuFileIndex == NULL) {
2684 barf("loadArchive: GNU-variant filename without an index while reading from `%s'", path);
2685 }
2686 if (n < 0 || n > gnuFileIndexSize) {
2687 barf("loadArchive: GNU-variant filename offset %d out of range [0..%d] while reading filename from `%s'", n, gnuFileIndexSize, path);
2688 }
2689 if (n != 0 && gnuFileIndex[n - 1] != '\n') {
2690 barf("loadArchive: GNU-variant filename offset %d invalid (range [0..%d]) while reading filename from `%s'", n, gnuFileIndexSize, path);
2691 }
2692 for (i = n; gnuFileIndex[i] != '\n'; i++);
2693 thisFileNameSize = i - n - 1;
2694 if (thisFileNameSize >= fileNameSize) {
2695 /* Double it to avoid potentially continually
2696 increasing it by 1 */
2697 fileNameSize = thisFileNameSize * 2;
2698 fileName = stgReallocBytes(fileName, fileNameSize, "loadArchive(fileName)");
2699 }
2700 memcpy(fileName, gnuFileIndex + n, thisFileNameSize);
2701 fileName[thisFileNameSize] = '\0';
2702 }
2703 else if (fileName[1] == ' ') {
2704 fileName[0] = '\0';
2705 thisFileNameSize = 0;
2706 }
2707 else {
2708 barf("loadArchive: GNU-variant filename offset not found while reading filename from `%s'", path);
2709 }
2710 }
2711 /* Finally, the case where the filename field actually contains
2712 the filename */
2713 else {
2714 /* GNU ar terminates filenames with a '/', this allowing
2715 spaces in filenames. So first look to see if there is a
2716 terminating '/'. */
2717 for (thisFileNameSize = 0;
2718 thisFileNameSize < 16;
2719 thisFileNameSize++) {
2720 if (fileName[thisFileNameSize] == '/') {
2721 fileName[thisFileNameSize] = '\0';
2722 break;
2723 }
2724 }
2725 /* If we didn't find a '/', then a space teminates the
2726 filename. Note that if we don't find one, then
2727 thisFileNameSize ends up as 16, and we already have the
2728 '\0' at the end. */
2729 if (thisFileNameSize == 16) {
2730 for (thisFileNameSize = 0;
2731 thisFileNameSize < 16;
2732 thisFileNameSize++) {
2733 if (fileName[thisFileNameSize] == ' ') {
2734 fileName[thisFileNameSize] = '\0';
2735 break;
2736 }
2737 }
2738 }
2739 }
2740
2741 IF_DEBUG(linker,
2742 debugBelch("loadArchive: Found member file `%s'\n", fileName));
2743
2744 isObject = thisFileNameSize >= 2
2745 && fileName[thisFileNameSize - 2] == '.'
2746 && fileName[thisFileNameSize - 1] == 'o';
2747
2748 IF_DEBUG(linker, debugBelch("loadArchive: \tthisFileNameSize = %d\n", (int)thisFileNameSize));
2749 IF_DEBUG(linker, debugBelch("loadArchive: \tisObject = %d\n", isObject));
2750
2751 if (isObject) {
2752 char *archiveMemberName;
2753
2754 IF_DEBUG(linker, debugBelch("loadArchive: Member is an object file...loading...\n"));
2755
2756 /* We can't mmap from the archive directly, as object
2757 files need to be 8-byte aligned but files in .ar
2758 archives are 2-byte aligned. When possible we use mmap
2759 to get some anonymous memory, as on 64-bit platforms if
2760 we use malloc then we can be given memory above 2^32.
2761 In the mmap case we're probably wasting lots of space;
2762 we could do better. */
2763 #if defined(USE_MMAP)
2764 image = mmapForLinker(memberSize, MAP_ANONYMOUS, -1);
2765 #elif defined(mingw32_HOST_OS)
2766 // TODO: We would like to use allocateExec here, but allocateExec
2767 // cannot currently allocate blocks large enough.
2768 image = allocateImageAndTrampolines(path, fileName,
2769 #if defined(x86_64_HOST_ARCH)
2770 f,
2771 #endif
2772 memberSize);
2773 #elif defined(darwin_HOST_OS)
2774 /* See loadObj() */
2775 misalignment = machoGetMisalignment(f);
2776 image = stgMallocBytes(memberSize + misalignment, "loadArchive(image)");
2777 image += misalignment;
2778 #else
2779 image = stgMallocBytes(memberSize, "loadArchive(image)");
2780 #endif
2781
2782 #if !defined(mingw32_HOST_OS)
2783 /*
2784 * Note [thin archives on Windows]
2785 * This doesn't compile on Windows because it assumes
2786 * char* pathnames, and we use wchar_t* on Windows. It's
2787 * not trivial to fix, so I'm leaving it disabled on
2788 * Windows for now --SDM
2789 */
2790 if (isThin) {
2791 FILE *member;
2792 char *pathCopy, *dirName, *memberPath;
2793
2794 /* Allocate and setup the dirname of the archive. We'll need
2795 this to locate the thin member */
2796 pathCopy = stgMallocBytes(strlen(path) + 1, "loadArchive(file)");
2797 strcpy(pathCopy, path);
2798 dirName = dirname(pathCopy);
2799
2800 /* Append the relative member name to the dirname. This should be
2801 be the full path to the actual thin member. */
2802 memberPath = stgMallocBytes(
2803 strlen(path) + 1 + strlen(fileName) + 1, "loadArchive(file)");
2804 strcpy(memberPath, dirName);
2805 memberPath[strlen(dirName)] = '/';
2806 strcpy(memberPath + strlen(dirName) + 1, fileName);
2807
2808 member = pathopen(memberPath, WSTR("rb"));
2809 if (!member)
2810 barf("loadObj: can't read `%s'", path);
2811
2812 n = fread ( image, 1, memberSize, member );
2813 if (n != memberSize) {
2814 barf("loadArchive: error whilst reading `%s'", fileName);
2815 }
2816
2817 fclose(member);
2818 stgFree(memberPath);
2819 stgFree(pathCopy);
2820 }
2821 else
2822 #endif
2823 {
2824 n = fread ( image, 1, memberSize, f );
2825 if (n != memberSize) {
2826 barf("loadArchive: error whilst reading `%s'", path);
2827 }
2828 }
2829
2830 archiveMemberName = stgMallocBytes(pathlen(path) + thisFileNameSize + 3,
2831 "loadArchive(file)");
2832 sprintf(archiveMemberName, "%" PATH_FMT "(%.*s)",
2833 path, (int)thisFileNameSize, fileName);
2834
2835 oc = mkOc(path, image, memberSize, archiveMemberName
2836 #ifndef USE_MMAP
2837 #ifdef darwin_HOST_OS
2838 , misalignment
2839 #endif
2840 #endif
2841 );
2842
2843 stgFree(archiveMemberName);
2844
2845 if (0 == loadOc(oc)) {
2846 stgFree(fileName);
2847 fclose(f);
2848 return 0;
2849 } else {
2850 oc->next = objects;
2851 objects = oc;
2852 }
2853 }
2854 else if (isGnuIndex) {
2855 if (gnuFileIndex != NULL) {
2856 barf("loadArchive: GNU-variant index found, but already have an index, while reading filename from `%s'", path);
2857 }
2858 IF_DEBUG(linker, debugBelch("loadArchive: Found GNU-variant file index\n"));
2859 #ifdef USE_MMAP
2860 gnuFileIndex = mmapForLinker(memberSize + 1, MAP_ANONYMOUS, -1);
2861 #else
2862 gnuFileIndex = stgMallocBytes(memberSize + 1, "loadArchive(image)");
2863 #endif
2864 n = fread ( gnuFileIndex, 1, memberSize, f );
2865 if (n != memberSize) {
2866 barf("loadArchive: error whilst reading `%s'", path);
2867 }
2868 gnuFileIndex[memberSize] = '/';
2869 gnuFileIndexSize = memberSize;
2870 }
2871 else {
2872 IF_DEBUG(linker, debugBelch("loadArchive: '%s' does not appear to be an object file\n", fileName));
2873 if (!isThin || thisFileNameSize == 0) {
2874 n = fseek(f, memberSize, SEEK_CUR);
2875 if (n != 0)
2876 barf("loadArchive: error whilst seeking by %d in `%s'",
2877 memberSize, path);
2878 }
2879 }
2880
2881 /* .ar files are 2-byte aligned */
2882 if (!(isThin && thisFileNameSize > 0) && memberSize % 2) {
2883 IF_DEBUG(linker, debugBelch("loadArchive: trying to read one pad byte\n"));
2884 n = fread ( tmp, 1, 1, f );
2885 if (n != 1) {
2886 if (feof(f)) {
2887 IF_DEBUG(linker, debugBelch("loadArchive: found EOF while reading one pad byte\n"));
2888 break;
2889 }
2890 else {
2891 barf("loadArchive: Failed reading padding from `%s'", path);
2892 }
2893 }
2894 IF_DEBUG(linker, debugBelch("loadArchive: successfully read one pad byte\n"));
2895 }
2896 IF_DEBUG(linker, debugBelch("loadArchive: reached end of archive loading while loop\n"));
2897 }
2898
2899 fclose(f);
2900
2901 stgFree(fileName);
2902 if (gnuFileIndex != NULL) {
2903 #ifdef USE_MMAP
2904 munmap(gnuFileIndex, gnuFileIndexSize + 1);
2905 #else
2906 stgFree(gnuFileIndex);
2907 #endif
2908 }
2909
2910 IF_DEBUG(linker, debugBelch("loadArchive: done\n"));
2911 return 1;
2912 }
2913
2914 HsInt loadArchive (pathchar *path)
2915 {
2916 ACQUIRE_LOCK(&linker_mutex);
2917 HsInt r = loadArchive_(path);
2918 RELEASE_LOCK(&linker_mutex);
2919 return r;
2920 }
2921
2922 /* -----------------------------------------------------------------------------
2923 * Load an obj (populate the global symbol table, but don't resolve yet)
2924 *
2925 * Returns: 1 if ok, 0 on error.
2926 */
2927 static HsInt loadObj_ (pathchar *path)
2928 {
2929 ObjectCode* oc;
2930 char *image;
2931 int fileSize;
2932 struct_stat st;
2933 int r;
2934 #ifdef USE_MMAP
2935 int fd;
2936 #else
2937 FILE *f;
2938 # if defined(darwin_HOST_OS)
2939 int misalignment;
2940 # endif
2941 #endif
2942 IF_DEBUG(linker, debugBelch("loadObj %" PATH_FMT "\n", path));
2943
2944 /* debugBelch("loadObj %s\n", path ); */
2945
2946 /* Check that we haven't already loaded this object.
2947 Ignore requests to load multiple times */
2948
2949 if (isAlreadyLoaded(path)) {
2950 IF_DEBUG(linker,
2951 debugBelch("ignoring repeated load of %" PATH_FMT "\n", path));
2952 return 1; /* success */
2953 }
2954
2955 r = pathstat(path, &st);
2956 if (r == -1) {
2957 IF_DEBUG(linker, debugBelch("File doesn't exist\n"));
2958 return 0;
2959 }
2960
2961 fileSize = st.st_size;
2962
2963 #ifdef USE_MMAP
2964 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
2965
2966 #if defined(openbsd_HOST_OS)
2967 /* coverity[toctou] */
2968 fd = open(path, O_RDONLY, S_IRUSR);
2969 #else
2970 /* coverity[toctou] */
2971 fd = open(path, O_RDONLY);
2972 #endif
2973 if (fd == -1) {
2974 errorBelch("loadObj: can't open `%s'", path);
2975 return 0;
2976 }
2977
2978 image = mmapForLinker(fileSize, 0, fd);
2979 close(fd);
2980 if (image == NULL) {
2981 return 0;
2982 }
2983
2984 #else /* !USE_MMAP */
2985 /* load the image into memory */
2986 /* coverity[toctou] */
2987 f = pathopen(path, WSTR("rb"));
2988 if (!f) {
2989 errorBelch("loadObj: can't read `%" PATH_FMT "'", path);
2990 return 0;
2991 }
2992
2993 # if defined(mingw32_HOST_OS)
2994 // TODO: We would like to use allocateExec here, but allocateExec
2995 // cannot currently allocate blocks large enough.
2996 image = allocateImageAndTrampolines(path, "itself",
2997 #if defined(x86_64_HOST_ARCH)
2998 f,
2999 #endif
3000 fileSize);
3001 if (image == NULL) {
3002 fclose(f);
3003 return 0;
3004 }
3005 # elif defined(darwin_HOST_OS)
3006 // In a Mach-O .o file, all sections can and will be misaligned
3007 // if the total size of the headers is not a multiple of the
3008 // desired alignment. This is fine for .o files that only serve
3009 // as input for the static linker, but it's not fine for us,
3010 // as SSE (used by gcc for floating point) and Altivec require
3011 // 16-byte alignment.
3012 // We calculate the correct alignment from the header before
3013 // reading the file, and then we misalign image on purpose so
3014 // that the actual sections end up aligned again.
3015 misalignment = machoGetMisalignment(f);
3016 image = stgMallocBytes(fileSize + misalignment, "loadObj(image)");
3017 image += misalignment;
3018 # else
3019 image = stgMallocBytes(fileSize, "loadObj(image)");
3020 # endif
3021
3022 {
3023 int n;
3024 n = fread ( image, 1, fileSize, f );
3025 fclose(f);
3026 if (n != fileSize) {
3027 errorBelch("loadObj: error whilst reading `%" PATH_FMT "'", path);
3028 stgFree(image);
3029 return 0;
3030 }
3031 }
3032 #endif /* USE_MMAP */
3033
3034 oc = mkOc(path, image, fileSize, NULL
3035 #ifndef USE_MMAP
3036 #ifdef darwin_HOST_OS
3037 , misalignment
3038 #endif
3039 #endif
3040 );
3041
3042 if (! loadOc(oc)) {
3043 // failed; free everything we've allocated
3044 removeOcSymbols(oc);
3045 freeObjectCode(oc);
3046 return 0;
3047 }
3048
3049 oc->next = objects;
3050 objects = oc;
3051 return 1;
3052 }
3053
3054 HsInt loadObj (pathchar *path)
3055 {
3056 ACQUIRE_LOCK(&linker_mutex);
3057 HsInt r = loadObj_(path);
3058 RELEASE_LOCK(&linker_mutex);
3059 return r;
3060 }
3061
3062 static HsInt
3063 loadOc( ObjectCode* oc ) {
3064 int r;
3065
3066 IF_DEBUG(linker, debugBelch("loadOc: start\n"));
3067
3068 /* verify the in-memory image */
3069 # if defined(OBJFORMAT_ELF)
3070 r = ocVerifyImage_ELF ( oc );
3071 # elif defined(OBJFORMAT_PEi386)
3072 r = ocVerifyImage_PEi386 ( oc );
3073 # elif defined(OBJFORMAT_MACHO)
3074 r = ocVerifyImage_MachO ( oc );
3075 # else
3076 barf("loadObj: no verify method");
3077 # endif
3078 if (!r) {
3079 IF_DEBUG(linker, debugBelch("loadOc: ocVerifyImage_* failed\n"));
3080 return r;
3081 }
3082
3083 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
3084 r = ocAllocateSymbolExtras_MachO ( oc );
3085 if (!r) {
3086 IF_DEBUG(linker, debugBelch("loadOc: ocAllocateSymbolExtras_MachO failed\n"));
3087 return r;
3088 }
3089 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH))
3090 r = ocAllocateSymbolExtras_ELF ( oc );
3091 if (!r) {
3092 IF_DEBUG(linker, debugBelch("loadOc: ocAllocateSymbolExtras_ELF failed\n"));
3093 return r;
3094 }
3095 # elif defined(OBJFORMAT_PEi386) && defined(x86_64_HOST_ARCH)
3096 ocAllocateSymbolExtras_PEi386 ( oc );
3097 #endif
3098
3099 /* build the symbol list for this image */
3100 # if defined(OBJFORMAT_ELF)
3101 r = ocGetNames_ELF ( oc );
3102 # elif defined(OBJFORMAT_PEi386)
3103 r = ocGetNames_PEi386 ( oc );
3104 # elif defined(OBJFORMAT_MACHO)
3105 r = ocGetNames_MachO ( oc );
3106 # else
3107 barf("loadObj: no getNames method");
3108 # endif
3109 if (!r) {
3110 IF_DEBUG(linker, debugBelch("loadOc: ocGetNames_* failed\n"));
3111 return r;
3112 }
3113
3114 /* loaded, but not resolved yet */
3115 oc->status = OBJECT_LOADED;
3116 IF_DEBUG(linker, debugBelch("loadOc: done.\n"));
3117
3118 return 1;
3119 }
3120
3121 /* -----------------------------------------------------------------------------
3122 * resolve all the currently unlinked objects in memory
3123 *
3124 * Returns: 1 if ok, 0 on error.
3125 */
3126 static HsInt resolveObjs_ (void)
3127 {
3128 ObjectCode *oc;
3129 int r;
3130
3131 IF_DEBUG(linker, debugBelch("resolveObjs: start\n"));
3132
3133 for (oc = objects; oc; oc = oc->next) {
3134 if (oc->status != OBJECT_RESOLVED) {
3135 # if defined(OBJFORMAT_ELF)
3136 r = ocResolve_ELF ( oc );
3137 # elif defined(OBJFORMAT_PEi386)
3138 r = ocResolve_PEi386 ( oc );
3139 # elif defined(OBJFORMAT_MACHO)
3140 r = ocResolve_MachO ( oc );
3141 # else
3142 barf("resolveObjs: not implemented on this platform");
3143 # endif
3144 if (!r) { return r; }
3145
3146 // run init/init_array/ctors/mod_init_func
3147
3148 loading_obj = oc; // tells foreignExportStablePtr what to do
3149 #if defined(OBJFORMAT_ELF)
3150 r = ocRunInit_ELF ( oc );
3151 #elif defined(OBJFORMAT_PEi386)
3152 r = ocRunInit_PEi386 ( oc );
3153 #elif defined(OBJFORMAT_MACHO)
3154 r = ocRunInit_MachO ( oc );
3155 #else
3156 barf("resolveObjs: initializers not implemented on this platform");
3157 #endif
3158 loading_obj = NULL;
3159
3160 if (!r) { return r; }
3161
3162 oc->status = OBJECT_RESOLVED;
3163 }
3164 }
3165 IF_DEBUG(linker, debugBelch("resolveObjs: done\n"));
3166 return 1;
3167 }
3168
3169 HsInt resolveObjs (void)
3170 {
3171 ACQUIRE_LOCK(&linker_mutex);
3172 HsInt r = resolveObjs_();
3173 RELEASE_LOCK(&linker_mutex);
3174 return r;
3175 }
3176
3177 /* -----------------------------------------------------------------------------
3178 * delete an object from the pool
3179 */
3180 static HsInt unloadObj_ (pathchar *path)
3181 {
3182 ObjectCode *oc, *prev, *next;
3183 HsBool unloadedAnyObj = HS_BOOL_FALSE;
3184
3185 ASSERT(symhash != NULL);
3186 ASSERT(objects != NULL);
3187
3188 IF_DEBUG(linker, debugBelch("unloadObj: %" PATH_FMT "\n", path));
3189
3190 prev = NULL;
3191 for (oc = objects; oc; oc = next) {
3192 next = oc->next; // oc might be freed
3193
3194 if (!pathcmp(oc->fileName,path)) {
3195
3196 removeOcSymbols(oc);
3197
3198 if (prev == NULL) {
3199 objects = oc->next;
3200 } else {
3201 prev->next = oc->next;
3202 }
3203 oc->next = unloaded_objects;
3204 unloaded_objects = oc;
3205
3206 // Release any StablePtrs that were created when this
3207 // object module was initialized.
3208 {
3209 ForeignExportStablePtr *fe_ptr, *next;
3210
3211 for (fe_ptr = oc->stable_ptrs; fe_ptr != NULL; fe_ptr = next) {
3212 next = fe_ptr->next;
3213 freeStablePtr(fe_ptr->stable_ptr);
3214 stgFree(fe_ptr);
3215 }
3216 }
3217
3218 oc->status = OBJECT_UNLOADED;
3219
3220 /* This could be a member of an archive so continue
3221 * unloading other members. */
3222 unloadedAnyObj = HS_BOOL_TRUE;
3223 } else {
3224 prev = oc;
3225 }
3226 }
3227
3228 if (unloadedAnyObj) {
3229 return 1;
3230 }
3231 else {
3232 errorBelch("unloadObj: can't find `%" PATH_FMT "' to unload", path);
3233 return 0;
3234 }
3235 }
3236
3237 HsInt unloadObj (pathchar *path)
3238 {
3239 ACQUIRE_LOCK(&linker_mutex);
3240 HsInt r = unloadObj_(path);
3241 RELEASE_LOCK(&linker_mutex);
3242 return r;
3243 }
3244
3245 /* -----------------------------------------------------------------------------
3246 * Sanity checking. For each ObjectCode, maintain a list of address ranges
3247 * which may be prodded during relocation, and abort if we try and write
3248 * outside any of these.
3249 */
3250 static void
3251 addProddableBlock ( ObjectCode* oc, void* start, int size )
3252 {
3253 ProddableBlock* pb
3254 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
3255
3256 IF_DEBUG(linker, debugBelch("addProddableBlock: %p %p %d\n", oc, start, size));
3257 ASSERT(size > 0);
3258 pb->start = start;
3259 pb->size = size;
3260 pb->next = oc->proddables;
3261 oc->proddables = pb;
3262 }
3263
3264 static void
3265 checkProddableBlock (ObjectCode *oc, void *addr, size_t size )
3266 {
3267 ProddableBlock* pb;
3268
3269 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
3270 char* s = (char*)(pb->start);
3271 char* e = s + pb->size;
3272 char* a = (char*)addr;
3273 if (a >= s && (a+size) <= e) return;
3274 }
3275 barf("checkProddableBlock: invalid fixup in runtime linker: %p", addr);
3276 }
3277
3278 static void freeProddableBlocks (ObjectCode *oc)
3279 {
3280 ProddableBlock *pb, *next;
3281
3282 for (pb = oc->proddables; pb != NULL; pb = next) {
3283 next = pb->next;
3284 stgFree(pb);
3285 }
3286 oc->proddables = NULL;
3287 }
3288
3289 /* -----------------------------------------------------------------------------
3290 * Section management.
3291 */
3292 static void
3293 addSection ( ObjectCode* oc, SectionKind kind,
3294 void* start, void* end )
3295 {
3296 Section* s = stgMallocBytes(sizeof(Section), "addSection");
3297 s->start = start;
3298 s->end = end;
3299 s->kind = kind;
3300 s->next = oc->sections;
3301 oc->sections = s;
3302
3303 IF_DEBUG(linker, debugBelch("addSection: %p-%p (size %lld), kind %d\n",
3304 start, ((char*)end)-1, ((long long)(size_t)end) - ((long long)(size_t)start) + 1, kind ));
3305 }
3306
3307
3308 /* --------------------------------------------------------------------------
3309 * Symbol Extras.
3310 * This is about allocating a small chunk of memory for every symbol in the
3311 * object file. We make sure that the SymboLExtras are always "in range" of
3312 * limited-range PC-relative instructions on various platforms by allocating
3313 * them right next to the object code itself.
3314 */
3315
3316 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
3317 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
3318
3319 /*
3320 ocAllocateSymbolExtras
3321
3322 Allocate additional space at the end of the object file image to make room
3323 for jump islands (powerpc, x86_64, arm) and GOT entries (x86_64).
3324
3325 PowerPC relative branch instructions have a 24 bit displacement field.
3326 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
3327 If a particular imported symbol is outside this range, we have to redirect
3328 the jump to a short piece of new code that just loads the 32bit absolute
3329 address and jumps there.
3330 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
3331 to 32 bits (+-2GB).
3332
3333 This function just allocates space for one SymbolExtra for every
3334 undefined symbol in the object file. The code for the jump islands is
3335 filled in by makeSymbolExtra below.
3336 */
3337
3338 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
3339 {
3340 #ifdef USE_MMAP
3341 int pagesize, n, m;
3342 #endif
3343 int aligned;
3344 #ifndef USE_MMAP
3345 int misalignment = 0;
3346 #ifdef darwin_HOST_OS
3347 misalignment = oc->misalignment;
3348 #endif
3349 #endif
3350
3351 if( count > 0 )
3352 {
3353 // round up to the nearest 4
3354 aligned = (oc->fileSize + 3) & ~3;
3355
3356 #ifdef USE_MMAP
3357 pagesize = getpagesize();
3358 n = ROUND_UP( oc->fileSize, pagesize );
3359 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
3360
3361 /* we try to use spare space at the end of the last page of the
3362 * image for the jump islands, but if there isn't enough space
3363 * then we have to map some (anonymously, remembering MAP_32BIT).
3364 */
3365 if( m > n ) // we need to allocate more pages
3366 {
3367 if (USE_CONTIGUOUS_MMAP)
3368 {
3369 /* Keep image and symbol_extras contiguous */
3370 void *new = mmapForLinker(n + (sizeof(SymbolExtra) * count),
3371 MAP_ANONYMOUS, -1);
3372 if (new)
3373 {
3374 memcpy(new, oc->image, oc->fileSize);
3375 munmap(oc->image, n);
3376 oc->image = new;
3377 oc->fileSize = n + (sizeof(SymbolExtra) * count);
3378 oc->symbol_extras = (SymbolExtra *) (oc->image + n);
3379 }
3380 else {
3381 oc->symbol_extras = NULL;
3382 return 0;
3383 }
3384 }
3385 else
3386 {
3387 oc->symbol_extras = mmapForLinker(sizeof(SymbolExtra) * count,
3388 MAP_ANONYMOUS, -1);
3389 if (oc->symbol_extras == NULL) return 0;
3390 }
3391 }
3392 else
3393 {
3394 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
3395 }
3396 #else
3397 oc->image -= misalignment;
3398 oc->image = stgReallocBytes( oc->image,
3399 misalignment +
3400 aligned + sizeof (SymbolExtra) * count,
3401 "ocAllocateSymbolExtras" );
3402 oc->image += misalignment;
3403
3404 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
3405 #endif /* USE_MMAP */
3406
3407 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
3408 }
3409 else
3410 oc->symbol_extras = NULL;
3411
3412 oc->first_symbol_extra = first;
3413 oc->n_symbol_extras = count;
3414
3415 return 1;
3416 }
3417
3418 #endif
3419 #endif // defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH) || defined(arm_HOST_ARCH)
3420
3421 #if defined(arm_HOST_ARCH)
3422
3423 static void
3424 ocFlushInstructionCache( ObjectCode *oc )
3425 {
3426 // Object code
3427 __clear_cache(oc->image, oc->image + oc->fileSize);
3428 // Jump islands
3429 __clear_cache(oc->symbol_extras, &oc->symbol_extras[oc->n_symbol_extras]);
3430 }
3431
3432 #endif
3433
3434 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3435 #if !defined(x86_64_HOST_ARCH) || !defined(mingw32_HOST_OS)
3436
3437 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
3438 unsigned long symbolNumber,
3439 unsigned long target )
3440 {
3441 SymbolExtra *extra;
3442
3443 ASSERT( symbolNumber >= oc->first_symbol_extra
3444 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
3445
3446 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
3447
3448 #ifdef powerpc_HOST_ARCH
3449 // lis r12, hi16(target)
3450 extra->jumpIsland.lis_r12 = 0x3d80;
3451 extra->jumpIsland.hi_addr = target >> 16;
3452
3453 // ori r12, r12, lo16(target)
3454 extra->jumpIsland.ori_r12_r12 = 0x618c;
3455 extra->jumpIsland.lo_addr = target & 0xffff;
3456
3457 // mtctr r12
3458 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
3459
3460 // bctr
3461 extra->jumpIsland.bctr = 0x4e800420;
3462 #endif
3463 #ifdef x86_64_HOST_ARCH
3464 // jmp *-14(%rip)
3465 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
3466 extra->addr = target;
3467 memcpy(extra->jumpIsland, jmp, 6);
3468 #endif
3469
3470 return extra;
3471 }
3472
3473 #endif
3474 #endif // defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3475
3476 #ifdef arm_HOST_ARCH
3477 static SymbolExtra* makeArmSymbolExtra( ObjectCode* oc,
3478 unsigned long symbolNumber,
3479 unsigned long target,
3480 int fromThumb,
3481 int toThumb )
3482 {
3483 SymbolExtra *extra;
3484
3485 ASSERT( symbolNumber >= oc->first_symbol_extra
3486 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
3487
3488 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
3489
3490 // Make sure instruction mode bit is set properly
3491 if (toThumb)
3492 target |= 1;
3493 else
3494 target &= ~1;
3495
3496 if (!fromThumb) {
3497 // In ARM encoding:
3498 // movw r12, #0
3499 // movt r12, #0
3500 // bx r12
3501 uint32_t code[] = { 0xe300c000, 0xe340c000, 0xe12fff1c };
3502
3503 // Patch lower half-word into movw
3504 code[0] |= ((target>>12) & 0xf) << 16;
3505 code[0] |= target & 0xfff;
3506 // Patch upper half-word into movt
3507 target >>= 16;
3508 code[1] |= ((target>>12) & 0xf) << 16;
3509 code[1] |= target & 0xfff;
3510
3511 memcpy(extra->jumpIsland, code, 12);
3512
3513 } else {
3514 // In Thumb encoding:
3515 // movw r12, #0
3516 // movt r12, #0
3517 // bx r12
3518 uint16_t code[] = { 0xf240, 0x0c00,
3519 0xf2c0, 0x0c00,
3520 0x4760 };
3521
3522 // Patch lower half-word into movw
3523 code[0] |= (target>>12) & 0xf;
3524 code[0] |= ((target>>11) & 0x1) << 10;
3525 code[1] |= ((target>>8) & 0x7) << 12;
3526 code[1] |= target & 0xff;
3527 // Patch upper half-word into movt
3528 target >>= 16;
3529 code[2] |= (target>>12) & 0xf;
3530 code[2] |= ((target>>11) & 0x1) << 10;
3531 code[3] |= ((target>>8) & 0x7) << 12;
3532 code[3] |= target & 0xff;
3533
3534 memcpy(extra->jumpIsland, code, 10);
3535 }
3536
3537 return extra;
3538 }
3539 #endif // arm_HOST_ARCH
3540
3541 /* --------------------------------------------------------------------------
3542 * PowerPC specifics (instruction cache flushing)
3543 * ------------------------------------------------------------------------*/
3544
3545 #ifdef powerpc_HOST_ARCH
3546 /*
3547 ocFlushInstructionCache
3548
3549 Flush the data & instruction caches.
3550 Because the PPC has split data/instruction caches, we have to
3551 do that whenever we modify code at runtime.
3552 */
3553
3554 static void
3555 ocFlushInstructionCacheFrom(void* begin, size_t length)
3556 {
3557 size_t n = (length + 3) / 4;
3558 unsigned long* p = begin;
3559
3560 while (n--)
3561 {
3562 __asm__ volatile ( "dcbf 0,%0\n\t"
3563 "sync\n\t"
3564 "icbi 0,%0"
3565 :
3566 : "r" (p)
3567 );
3568 p++;
3569 }
3570 __asm__ volatile ( "sync\n\t"
3571 "isync"
3572 );
3573 }
3574
3575 static void
3576 ocFlushInstructionCache( ObjectCode *oc )
3577 {
3578 /* The main object code */
3579 ocFlushInstructionCacheFrom(oc->image
3580 #ifdef darwin_HOST_OS
3581 + oc->misalignment
3582 #endif
3583 , oc->fileSize);
3584
3585 /* Jump Islands */
3586 ocFlushInstructionCacheFrom(oc->symbol_extras, sizeof(SymbolExtra) * oc->n_symbol_extras);
3587 }
3588 #endif /* powerpc_HOST_ARCH */
3589
3590
3591 /* --------------------------------------------------------------------------
3592 * PEi386 specifics (Win32 targets)
3593 * ------------------------------------------------------------------------*/
3594
3595 /* The information for this linker comes from
3596 Microsoft Portable Executable
3597 and Common Object File Format Specification
3598 revision 5.1 January 1998
3599 which SimonM says comes from the MS Developer Network CDs.
3600
3601 It can be found there (on older CDs), but can also be found
3602 online at:
3603
3604 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
3605
3606 (this is Rev 6.0 from February 1999).
3607
3608 Things move, so if that fails, try searching for it via
3609
3610 http://www.google.com/search?q=PE+COFF+specification
3611
3612 The ultimate reference for the PE format is the Winnt.h
3613 header file that comes with the Platform SDKs; as always,
3614 implementations will drift wrt their documentation.
3615
3616 A good background article on the PE format is Matt Pietrek's
3617 March 1994 article in Microsoft System Journal (MSJ)
3618 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
3619 Win32 Portable Executable File Format." The info in there
3620 has recently been updated in a two part article in
3621 MSDN magazine, issues Feb and March 2002,
3622 "Inside Windows: An In-Depth Look into the Win32 Portable
3623 Executable File Format"
3624
3625 John Levine's book "Linkers and Loaders" contains useful
3626 info on PE too.
3627 */
3628
3629
3630 #if defined(OBJFORMAT_PEi386)
3631
3632
3633
3634 typedef unsigned char UChar;
3635 typedef unsigned short UInt16;
3636 typedef unsigned int UInt32;
3637 typedef int Int32;
3638 typedef unsigned long long int UInt64;
3639
3640
3641 typedef
3642 struct {
3643 UInt16 Machine;
3644 UInt16 NumberOfSections;
3645 UInt32 TimeDateStamp;
3646 UInt32 PointerToSymbolTable;
3647 UInt32 NumberOfSymbols;
3648 UInt16 SizeOfOptionalHeader;
3649 UInt16 Characteristics;
3650 }
3651 COFF_header;
3652
3653 #define sizeof_COFF_header 20
3654
3655
3656 typedef
3657 struct {
3658 UChar Name[8];
3659 UInt32 VirtualSize;
3660 UInt32 VirtualAddress;
3661 UInt32 SizeOfRawData;
3662 UInt32 PointerToRawData;
3663 UInt32 PointerToRelocations;
3664 UInt32 PointerToLinenumbers;
3665 UInt16 NumberOfRelocations;
3666 UInt16 NumberOfLineNumbers;
3667 UInt32 Characteristics;
3668 }
3669 COFF_section;
3670
3671 #define sizeof_COFF_section 40
3672
3673
3674 typedef
3675 struct {
3676 UChar Name[8];
3677 UInt32 Value;
3678 UInt16 SectionNumber;
3679 UInt16 Type;
3680 UChar StorageClass;
3681 UChar NumberOfAuxSymbols;
3682 }
3683 COFF_symbol;
3684
3685 #define sizeof_COFF_symbol 18
3686
3687
3688 typedef
3689 struct {
3690 UInt32 VirtualAddress;
3691 UInt32 SymbolTableIndex;
3692 UInt16 Type;
3693 }
3694 COFF_reloc;
3695
3696 #define sizeof_COFF_reloc 10
3697
3698
3699 /* From PE spec doc, section 3.3.2 */
3700 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
3701 windows.h -- for the same purpose, but I want to know what I'm
3702 getting, here. */
3703 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
3704 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
3705 #define MYIMAGE_FILE_DLL 0x2000
3706 #define MYIMAGE_FILE_SYSTEM 0x1000
3707 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
3708 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
3709 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
3710
3711 /* From PE spec doc, section 5.4.2 and 5.4.4 */
3712 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
3713 #define MYIMAGE_SYM_CLASS_STATIC 3
3714 #define MYIMAGE_SYM_UNDEFINED 0
3715
3716 /* From PE spec doc, section 4.1 */
3717 #define MYIMAGE_SCN_CNT_CODE 0x00000020
3718 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
3719 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
3720
3721 /* From PE spec doc, section 5.2.1 */
3722 #define MYIMAGE_REL_I386_DIR32 0x0006
3723 #define MYIMAGE_REL_I386_REL32 0x0014
3724
3725 static int verifyCOFFHeader ( COFF_header *hdr, pathchar *filename);
3726
3727 /* We assume file pointer is right at the
3728 beginning of COFF object.
3729 */
3730 static char *
3731 allocateImageAndTrampolines (
3732 pathchar* arch_name, char* member_name,
3733 #if defined(x86_64_HOST_ARCH)
3734 FILE* f,
3735 #endif
3736 int size )
3737 {
3738 char* image;
3739 #if defined(x86_64_HOST_ARCH)
3740 /* PeCoff contains number of symbols right in it's header, so
3741 we can reserve the room for symbolExtras right here. */
3742 COFF_header hdr;
3743 size_t n;
3744
3745 n = fread ( &hdr, 1, sizeof_COFF_header, f );
3746 if (n != sizeof( COFF_header )) {
3747 errorBelch("getNumberOfSymbols: error whilst reading `%s' header in `%S'",
3748 member_name, arch_name);
3749 return NULL;
3750 }
3751 fseek( f, -sizeof_COFF_header, SEEK_CUR );
3752
3753 if (!verifyCOFFHeader(&hdr, arch_name)) {
3754 return 0;
3755 }
3756
3757 /* We get back 8-byte aligned memory (is that guaranteed?), but
3758 the offsets to the sections within the file are all 4 mod 8
3759 (is that guaranteed?). We therefore need to offset the image
3760 by 4, so that all the pointers are 8-byte aligned, so that
3761 pointer tagging works. */
3762 /* For 32-bit case we don't need this, hence we use macro PEi386_IMAGE_OFFSET,
3763 which equals to 4 for 64-bit case and 0 for 32-bit case. */
3764 /* We allocate trampolines area for all symbols right behind
3765 image data, aligned on 8. */
3766 size = ((PEi386_IMAGE_OFFSET + size + 0x7) & ~0x7)
3767 + hdr.NumberOfSymbols * sizeof(SymbolExtra);
3768 #endif
3769 image = VirtualAlloc(NULL, size,
3770 MEM_RESERVE | MEM_COMMIT,
3771 PAGE_EXECUTE_READWRITE);
3772
3773 if (image == NULL) {
3774 errorBelch("%" PATH_FMT ": failed to allocate memory for image for %s",
3775 arch_name, member_name);
3776 return NULL;
3777 }
3778
3779 return image + PEi386_IMAGE_OFFSET;
3780 }
3781
3782 /* We use myindex to calculate array addresses, rather than
3783 simply doing the normal subscript thing. That's because
3784 some of the above structs have sizes which are not
3785 a whole number of words. GCC rounds their sizes up to a
3786 whole number of words, which means that the address calcs
3787 arising from using normal C indexing or pointer arithmetic
3788 are just plain wrong. Sigh.
3789 */
3790 static UChar *
3791 myindex ( int scale, void* base, int index )
3792 {
3793 return
3794 ((UChar*)base) + scale * index;
3795 }
3796
3797
3798 static void
3799 printName ( UChar* name, UChar* strtab )
3800 {
3801 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3802 UInt32 strtab_offset = * (UInt32*)(name+4);
3803 debugBelch("%s", strtab + strtab_offset );
3804 } else {
3805 int i;
3806 for (i = 0; i < 8; i++) {
3807 if (name[i] == 0) break;
3808 debugBelch("%c", name[i] );
3809 }
3810 }
3811 }
3812
3813
3814 static void
3815 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
3816 {
3817 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3818 UInt32 strtab_offset = * (UInt32*)(name+4);
3819 strncpy ( (char*)dst, (char*)strtab+strtab_offset, dstSize );
3820 dst[dstSize-1] = 0;
3821 } else {
3822 int i = 0;
3823 while (1) {
3824 if (i >= 8) break;
3825 if (name[i] == 0) break;
3826 dst[i] = name[i];
3827 i++;
3828 }
3829 dst[i] = 0;
3830 }
3831 }
3832
3833
3834 static UChar *
3835 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
3836 {
3837 UChar* newstr;
3838 /* If the string is longer than 8 bytes, look in the
3839 string table for it -- this will be correctly zero terminated.
3840 */
3841 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3842 UInt32 strtab_offset = * (UInt32*)(name+4);
3843 return ((UChar*)strtab) + strtab_offset;
3844 }
3845 /* Otherwise, if shorter than 8 bytes, return the original,
3846 which by defn is correctly terminated.
3847 */
3848 if (name[7]==0) return name;
3849 /* The annoying case: 8 bytes. Copy into a temporary
3850 (XXX which is never freed ...)
3851 */
3852 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
3853 ASSERT(newstr);
3854 strncpy((char*)newstr,(char*)name,8);
3855 newstr[8] = 0;
3856 return newstr;
3857 }
3858
3859 /* Getting the name of a section is mildly tricky, so we make a
3860 function for it. Sadly, in one case we have to copy the string
3861 (when it is exactly 8 bytes long there's no trailing '\0'), so for
3862 consistency we *always* copy the string; the caller must free it
3863 */
3864 static char *
3865 cstring_from_section_name (UChar* name, UChar* strtab)
3866 {
3867 char *newstr;
3868
3869 if (name[0]=='/') {
3870 int strtab_offset = strtol((char*)name+1,NULL,10);
3871 int len = strlen(((char*)strtab) + strtab_offset);
3872
3873 newstr = stgMallocBytes(len+1, "cstring_from_section_symbol_name");
3874 strcpy((char*)newstr, (char*)((UChar*)strtab) + strtab_offset);
3875 return newstr;
3876 }
3877 else
3878 {
3879 newstr = stgMallocBytes(9, "cstring_from_section_symbol_name");
3880 ASSERT(newstr);
3881 strncpy((char*)newstr,(char*)name,8);
3882 newstr[8] = 0;
3883 return newstr;
3884 }
3885 }
3886
3887 /* Just compares the short names (first 8 chars) */
3888 static COFF_section *
3889 findPEi386SectionCalled ( ObjectCode* oc, UChar* name, UChar* strtab )
3890 {
3891 int i;
3892 rtsBool long_name = rtsFalse;
3893 COFF_header* hdr
3894 = (COFF_header*)(oc->image);
3895 COFF_section* sectab
3896 = (COFF_section*) (
3897 ((UChar*)(oc->image))
3898 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
3899 );
3900 // String is longer than 8 bytes, swap in the proper
3901 // (NULL-terminated) version, and make a note that this
3902 // is a long name.
3903 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
3904 UInt32 strtab_offset = * (UInt32*)(name+4);
3905 name = ((UChar*)strtab) + strtab_offset;
3906 long_name = rtsTrue;
3907 }
3908 for (i = 0; i < hdr->NumberOfSections; i++) {
3909 UChar* n1;
3910 UChar* n2;
3911 COFF_section* section_i
3912 = (COFF_section*)
3913 myindex ( sizeof_COFF_section, sectab, i );
3914 n1 = (UChar*) &(section_i->Name);
3915 n2 = name;
3916 // Long section names are prefixed with a slash, see
3917 // also cstring_from_section_name
3918 if (n1[0] == '/' && long_name) {
3919 // Long name check
3920 // We don't really want to make an assumption that the string
3921 // table indexes are the same, so we'll do a proper check.
3922 int n1_strtab_offset = strtol((char*)n1+1,NULL,10);
3923 n1 = (UChar*) (((char*)strtab) + n1_strtab_offset);
3924 if (0==strcmp((const char*)n1, (const char*)n2)) {
3925 return section_i;
3926 }
3927 } else if (n1[0] != '/' && !long_name) {
3928 // Short name check
3929 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
3930 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
3931 n1[6]==n2[6] && n1[7]==n2[7]) {
3932 return section_i;
3933 }
3934 } else {
3935 // guaranteed to mismatch, because we never attempt to link
3936 // in an executable where the section name may be truncated
3937 }
3938 }
3939
3940 return NULL;
3941 }
3942
3943 static void
3944 zapTrailingAtSign ( UChar* sym )
3945 {
3946 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
3947 int i, j;
3948 if (sym[0] == 0) return;
3949 i = 0;
3950 while (sym[i] != 0) i++;
3951 i--;
3952 j = i;
3953 while (j > 0 && my_isdigit(sym[j])) j--;
3954 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
3955 # undef my_isdigit
3956 }
3957
3958 static void *
3959 lookupSymbolInDLLs ( UChar *lbl )
3960 {
3961 OpenedDLL* o_dll;
3962 void *sym;
3963
3964 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
3965 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
3966
3967 if (lbl[0] == '_') {
3968 /* HACK: if the name has an initial underscore, try stripping
3969 it off & look that up first. I've yet to verify whether there's
3970 a Rule that governs whether an initial '_' *should always* be
3971 stripped off when mapping from import lib name to the DLL name.
3972 */
3973 sym = GetProcAddress(o_dll->instance, (char*)(lbl+1));
3974 if (sym != NULL) {
3975 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
3976 return sym;
3977 }
3978 }
3979
3980 /* Ticket #2283.
3981 Long description: http://support.microsoft.com/kb/132044
3982 tl;dr:
3983 If C/C++ compiler sees __declspec(dllimport) ... foo ...
3984 it generates call *__imp_foo, and __imp_foo here has exactly
3985 the same semantics as in __imp_foo = GetProcAddress(..., "foo")
3986 */
3987 if (sym == NULL && strncmp ((const char*)lbl, "__imp_", 6) == 0) {
3988 sym = GetProcAddress(o_dll->instance, (char*)(lbl+6));
3989 if (sym != NULL) {
3990 IndirectAddr* ret;
3991 ret = stgMallocBytes( sizeof(IndirectAddr), "lookupSymbolInDLLs" );
3992 ret->addr = sym;
3993 ret->next = indirects;
3994 indirects = ret;
3995 errorBelch("warning: %s from %S is linked instead of %s",
3996 (char*)(lbl+6), o_dll->name, (char*)lbl);
3997 return (void*) & ret->addr;
3998 }
3999 }
4000
4001 sym = GetProcAddress(o_dll->instance, (char*)lbl);
4002 if (sym != NULL) {
4003 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
4004 return sym;
4005 }
4006 }
4007 return NULL;
4008 }
4009
4010 static int
4011 verifyCOFFHeader (COFF_header *hdr, pathchar *fileName)
4012 {
4013 #if defined(i386_HOST_ARCH)
4014 if (hdr->Machine != 0x14c) {
4015 errorBelch("%" PATH_FMT ": Not x86 PEi386", fileName);
4016 return 0;
4017 }
4018 #elif defined(x86_64_HOST_ARCH)
4019 if (hdr->Machine != 0x8664) {
4020 errorBelch("%" PATH_FMT ": Not x86_64 PEi386", fileName);
4021 return 0;
4022 }
4023 #else
4024 errorBelch("PEi386 not supported on this arch");
4025 #endif
4026
4027 if (hdr->SizeOfOptionalHeader != 0) {
4028 errorBelch("%" PATH_FMT ": PEi386 with nonempty optional header",
4029 fileName);
4030 return 0;
4031 }
4032 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
4033 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
4034 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
4035 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
4036 errorBelch("%" PATH_FMT ": Not a PEi386 object file", fileName);
4037 return 0;
4038 }
4039 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
4040 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
4041 errorBelch("%" PATH_FMT ": Invalid PEi386 word size or endiannness: %d",
4042 fileName,
4043 (int)(hdr->Characteristics));
4044 return 0;
4045 }
4046 return 1;
4047 }
4048
4049 static int
4050 ocVerifyImage_PEi386 ( ObjectCode* oc )
4051 {
4052 int i;
4053 UInt32 j, noRelocs;
4054 COFF_header* hdr;
4055 COFF_section* sectab;
4056 COFF_symbol* symtab;
4057 UChar* strtab;