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