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