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