1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2000-2004
7 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
13 /* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14 MREMAP_MAYMOVE from <sys/mman.h>.
25 #include "LinkerInternals.h"
29 #include "RtsTypeable.h"
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
42 #if defined(HAVE_DLFCN_H)
46 #if defined(cygwin32_HOST_OS)
51 #ifdef HAVE_SYS_TIME_H
55 #include <sys/fcntl.h>
56 #include <sys/termios.h>
57 #include <sys/utime.h>
58 #include <sys/utsname.h>
62 #if defined(ia64_HOST_ARCH) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
67 #if defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
75 #if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
76 # define OBJFORMAT_ELF
77 #elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
78 # define OBJFORMAT_PEi386
81 #elif defined(darwin_HOST_OS)
82 # define OBJFORMAT_MACHO
83 # include <mach-o/loader.h>
84 # include <mach-o/nlist.h>
85 # include <mach-o/reloc.h>
86 #if !defined(HAVE_DLFCN_H)
87 # include <mach-o/dyld.h>
89 #if defined(powerpc_HOST_ARCH)
90 # include <mach-o/ppc/reloc.h>
92 #if defined(x86_64_HOST_ARCH)
93 # include <mach-o/x86_64/reloc.h>
97 /* Hash table mapping symbol names to Symbol */
98 static /*Str*/HashTable *symhash;
100 /* Hash table mapping symbol names to StgStablePtr */
101 static /*Str*/HashTable *stablehash;
103 /* List of currently loaded objects */
104 ObjectCode *objects = NULL; /* initially empty */
106 #if defined(OBJFORMAT_ELF)
107 static int ocVerifyImage_ELF ( ObjectCode* oc );
108 static int ocGetNames_ELF ( ObjectCode* oc );
109 static int ocResolve_ELF ( ObjectCode* oc );
110 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
111 static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
113 #elif defined(OBJFORMAT_PEi386)
114 static int ocVerifyImage_PEi386 ( ObjectCode* oc );
115 static int ocGetNames_PEi386 ( ObjectCode* oc );
116 static int ocResolve_PEi386 ( ObjectCode* oc );
117 #elif defined(OBJFORMAT_MACHO)
118 static int ocVerifyImage_MachO ( ObjectCode* oc );
119 static int ocGetNames_MachO ( ObjectCode* oc );
120 static int ocResolve_MachO ( ObjectCode* oc );
122 static int machoGetMisalignment( FILE * );
123 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
124 static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
126 #ifdef powerpc_HOST_ARCH
127 static void machoInitSymbolsWithoutUnderscore( void );
131 /* on x86_64 we have a problem with relocating symbol references in
132 * code that was compiled without -fPIC. By default, the small memory
133 * model is used, which assumes that symbol references can fit in a
134 * 32-bit slot. The system dynamic linker makes this work for
135 * references to shared libraries by either (a) allocating a jump
136 * table slot for code references, or (b) moving the symbol at load
137 * time (and copying its contents, if necessary) for data references.
139 * We unfortunately can't tell whether symbol references are to code
140 * or data. So for now we assume they are code (the vast majority
141 * are), and allocate jump-table slots. Unfortunately this will
142 * SILENTLY generate crashing code for data references. This hack is
143 * enabled by X86_64_ELF_NONPIC_HACK.
145 * One workaround is to use shared Haskell libraries. This is
146 * coming. Another workaround is to keep the static libraries but
147 * compile them with -fPIC, because that will generate PIC references
148 * to data which can be relocated. The PIC code is still too green to
149 * do this systematically, though.
152 * See thread http://www.haskell.org/pipermail/cvs-ghc/2007-September/038458.html
154 #define X86_64_ELF_NONPIC_HACK 1
156 /* -----------------------------------------------------------------------------
157 * Built-in symbols from the RTS
160 typedef struct _RtsSymbolVal {
167 #define Maybe_Stable_Names SymX(mkWeakzh_fast) \
168 SymX(makeStableNamezh_fast) \
169 SymX(finalizzeWeakzh_fast)
171 /* These are not available in GUM!!! -- HWL */
172 #define Maybe_Stable_Names
175 #if !defined (mingw32_HOST_OS)
176 #define RTS_POSIX_ONLY_SYMBOLS \
177 SymX(shutdownHaskellAndSignal) \
180 SymX(signal_handlers) \
181 SymX(stg_sig_install) \
185 #if defined (cygwin32_HOST_OS)
186 #define RTS_MINGW_ONLY_SYMBOLS /**/
187 /* Don't have the ability to read import libs / archives, so
188 * we have to stupidly list a lot of what libcygwin.a
191 #define RTS_CYGWIN_ONLY_SYMBOLS \
269 #elif !defined(mingw32_HOST_OS)
270 #define RTS_MINGW_ONLY_SYMBOLS /**/
271 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
272 #else /* defined(mingw32_HOST_OS) */
273 #define RTS_POSIX_ONLY_SYMBOLS /**/
274 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
276 /* Extra syms gen'ed by mingw-2's gcc-3.2: */
278 #define RTS_MINGW_EXTRA_SYMS \
279 Sym(_imp____mb_cur_max) \
282 #define RTS_MINGW_EXTRA_SYMS
285 #if HAVE_GETTIMEOFDAY
286 #define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
288 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
291 /* These are statically linked from the mingw libraries into the ghc
292 executable, so we have to employ this hack. */
293 #define RTS_MINGW_ONLY_SYMBOLS \
294 SymX(asyncReadzh_fast) \
295 SymX(asyncWritezh_fast) \
296 SymX(asyncDoProczh_fast) \
308 SymX(getservbyname) \
309 SymX(getservbyport) \
310 SymX(getprotobynumber) \
311 SymX(getprotobyname) \
312 SymX(gethostbyname) \
313 SymX(gethostbyaddr) \
360 SymX(rts_InstallConsoleEvent) \
361 SymX(rts_ConsoleHandlerDone) \
363 Sym(_imp___timezone) \
373 RTS_MINGW_EXTRA_SYMS \
374 RTS_MINGW_GETTIMEOFDAY_SYM \
378 #if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
379 #define RTS_DARWIN_ONLY_SYMBOLS \
380 Sym(asprintf$LDBLStub) \
384 Sym(fprintf$LDBLStub) \
385 Sym(fscanf$LDBLStub) \
386 Sym(fwprintf$LDBLStub) \
387 Sym(fwscanf$LDBLStub) \
388 Sym(printf$LDBLStub) \
389 Sym(scanf$LDBLStub) \
390 Sym(snprintf$LDBLStub) \
391 Sym(sprintf$LDBLStub) \
392 Sym(sscanf$LDBLStub) \
393 Sym(strtold$LDBLStub) \
394 Sym(swprintf$LDBLStub) \
395 Sym(swscanf$LDBLStub) \
396 Sym(syslog$LDBLStub) \
397 Sym(vasprintf$LDBLStub) \
399 Sym(verrc$LDBLStub) \
400 Sym(verrx$LDBLStub) \
401 Sym(vfprintf$LDBLStub) \
402 Sym(vfscanf$LDBLStub) \
403 Sym(vfwprintf$LDBLStub) \
404 Sym(vfwscanf$LDBLStub) \
405 Sym(vprintf$LDBLStub) \
406 Sym(vscanf$LDBLStub) \
407 Sym(vsnprintf$LDBLStub) \
408 Sym(vsprintf$LDBLStub) \
409 Sym(vsscanf$LDBLStub) \
410 Sym(vswprintf$LDBLStub) \
411 Sym(vswscanf$LDBLStub) \
412 Sym(vsyslog$LDBLStub) \
413 Sym(vwarn$LDBLStub) \
414 Sym(vwarnc$LDBLStub) \
415 Sym(vwarnx$LDBLStub) \
416 Sym(vwprintf$LDBLStub) \
417 Sym(vwscanf$LDBLStub) \
419 Sym(warnc$LDBLStub) \
420 Sym(warnx$LDBLStub) \
421 Sym(wcstold$LDBLStub) \
422 Sym(wprintf$LDBLStub) \
425 #define RTS_DARWIN_ONLY_SYMBOLS
429 # define MAIN_CAP_SYM SymX(MainCapability)
431 # define MAIN_CAP_SYM
434 #if !defined(mingw32_HOST_OS)
435 #define RTS_USER_SIGNALS_SYMBOLS \
436 SymX(setIOManagerPipe)
438 #define RTS_USER_SIGNALS_SYMBOLS \
439 SymX(sendIOManagerEvent) \
440 SymX(readIOManagerEvent) \
441 SymX(getIOManagerEvent) \
442 SymX(console_handler)
445 #define RTS_LIBFFI_SYMBOLS \
449 Sym(ffi_type_float) \
450 Sym(ffi_type_double) \
451 Sym(ffi_type_sint64) \
452 Sym(ffi_type_uint64) \
453 Sym(ffi_type_sint32) \
454 Sym(ffi_type_uint32) \
455 Sym(ffi_type_sint16) \
456 Sym(ffi_type_uint16) \
457 Sym(ffi_type_sint8) \
458 Sym(ffi_type_uint8) \
459 Sym(ffi_type_pointer)
461 #ifdef TABLES_NEXT_TO_CODE
462 #define RTS_RET_SYMBOLS /* nothing */
464 #define RTS_RET_SYMBOLS \
465 SymX(stg_enter_ret) \
466 SymX(stg_gc_fun_ret) \
473 SymX(stg_ap_pv_ret) \
474 SymX(stg_ap_pp_ret) \
475 SymX(stg_ap_ppv_ret) \
476 SymX(stg_ap_ppp_ret) \
477 SymX(stg_ap_pppv_ret) \
478 SymX(stg_ap_pppp_ret) \
479 SymX(stg_ap_ppppp_ret) \
480 SymX(stg_ap_pppppp_ret)
483 /* On Windows, we link libgmp.a statically into libHSrts.dll */
484 #ifdef mingw32_HOST_OS
487 SymX(__gmpz_cmp_si) \
488 SymX(__gmpz_cmp_ui) \
489 SymX(__gmpz_get_si) \
493 SymExtern(__gmpz_cmp) \
494 SymExtern(__gmpz_cmp_si) \
495 SymExtern(__gmpz_cmp_ui) \
496 SymExtern(__gmpz_get_si) \
497 SymExtern(__gmpz_get_ui)
500 #define RTS_SYMBOLS \
503 SymX(stg_enter_info) \
504 SymX(stg_gc_void_info) \
505 SymX(__stg_gc_enter_1) \
506 SymX(stg_gc_noregs) \
507 SymX(stg_gc_unpt_r1_info) \
508 SymX(stg_gc_unpt_r1) \
509 SymX(stg_gc_unbx_r1_info) \
510 SymX(stg_gc_unbx_r1) \
511 SymX(stg_gc_f1_info) \
513 SymX(stg_gc_d1_info) \
515 SymX(stg_gc_l1_info) \
518 SymX(stg_gc_fun_info) \
520 SymX(stg_gc_gen_info) \
521 SymX(stg_gc_gen_hp) \
523 SymX(stg_gen_yield) \
524 SymX(stg_yield_noregs) \
525 SymX(stg_yield_to_interpreter) \
526 SymX(stg_gen_block) \
527 SymX(stg_block_noregs) \
529 SymX(stg_block_takemvar) \
530 SymX(stg_block_putmvar) \
532 SymX(MallocFailHook) \
534 SymX(OutOfHeapHook) \
535 SymX(StackOverflowHook) \
536 SymX(__encodeDouble) \
537 SymX(__encodeFloat) \
540 SymX(__int_encodeDouble) \
541 SymX(__word_encodeDouble) \
542 SymX(__2Int_encodeDouble) \
543 SymX(__int_encodeFloat) \
544 SymX(__word_encodeFloat) \
545 SymX(andIntegerzh_fast) \
546 SymX(atomicallyzh_fast) \
550 SymX(asyncExceptionsBlockedzh_fast) \
551 SymX(blockAsyncExceptionszh_fast) \
553 SymX(catchRetryzh_fast) \
554 SymX(catchSTMzh_fast) \
556 SymX(closure_flags) \
558 SymX(cmpIntegerzh_fast) \
559 SymX(cmpIntegerIntzh_fast) \
560 SymX(complementIntegerzh_fast) \
561 SymX(createAdjustor) \
562 SymX(decodeDoublezh_fast) \
563 SymX(decodeFloatzh_fast) \
564 SymX(decodeDoublezu2Intzh_fast) \
565 SymX(decodeFloatzuIntzh_fast) \
568 SymX(deRefWeakzh_fast) \
569 SymX(deRefStablePtrzh_fast) \
570 SymX(dirty_MUT_VAR) \
571 SymX(divExactIntegerzh_fast) \
572 SymX(divModIntegerzh_fast) \
574 SymX(forkOnzh_fast) \
576 SymX(forkOS_createThread) \
577 SymX(freeHaskellFunctionPtr) \
578 SymX(freeStablePtr) \
579 SymX(getOrSetTypeableStore) \
580 SymX(gcdIntegerzh_fast) \
581 SymX(gcdIntegerIntzh_fast) \
582 SymX(gcdIntzh_fast) \
586 SymX(getFullProgArgv) \
592 SymX(hs_perform_gc) \
593 SymX(hs_free_stable_ptr) \
594 SymX(hs_free_fun_ptr) \
595 SymX(hs_hpc_rootModule) \
597 SymX(unpackClosurezh_fast) \
598 SymX(getApStackValzh_fast) \
599 SymX(int2Integerzh_fast) \
600 SymX(integer2Intzh_fast) \
601 SymX(integer2Wordzh_fast) \
602 SymX(isCurrentThreadBoundzh_fast) \
603 SymX(isDoubleDenormalized) \
604 SymX(isDoubleInfinite) \
606 SymX(isDoubleNegativeZero) \
607 SymX(isEmptyMVarzh_fast) \
608 SymX(isFloatDenormalized) \
609 SymX(isFloatInfinite) \
611 SymX(isFloatNegativeZero) \
612 SymX(killThreadzh_fast) \
614 SymX(insertStableSymbol) \
617 SymX(makeStablePtrzh_fast) \
618 SymX(minusIntegerzh_fast) \
619 SymX(mkApUpd0zh_fast) \
620 SymX(myThreadIdzh_fast) \
621 SymX(labelThreadzh_fast) \
622 SymX(newArrayzh_fast) \
623 SymX(newBCOzh_fast) \
624 SymX(newByteArrayzh_fast) \
625 SymX_redirect(newCAF, newDynCAF) \
626 SymX(newMVarzh_fast) \
627 SymX(newMutVarzh_fast) \
628 SymX(newTVarzh_fast) \
629 SymX(noDuplicatezh_fast) \
630 SymX(atomicModifyMutVarzh_fast) \
631 SymX(newPinnedByteArrayzh_fast) \
633 SymX(orIntegerzh_fast) \
635 SymX(performMajorGC) \
636 SymX(plusIntegerzh_fast) \
639 SymX(putMVarzh_fast) \
640 SymX(quotIntegerzh_fast) \
641 SymX(quotRemIntegerzh_fast) \
643 SymX(raiseIOzh_fast) \
644 SymX(readTVarzh_fast) \
645 SymX(remIntegerzh_fast) \
646 SymX(resetNonBlockingFd) \
651 SymX(rts_checkSchedStatus) \
654 SymX(rts_evalLazyIO) \
655 SymX(rts_evalStableIO) \
659 SymX(rts_getDouble) \
667 SymX(rts_getFunPtr) \
668 SymX(rts_getStablePtr) \
669 SymX(rts_getThreadId) \
672 SymX(rts_getWord16) \
673 SymX(rts_getWord32) \
674 SymX(rts_getWord64) \
687 SymX(rts_mkStablePtr) \
695 SymX(rtsSupportsBoundThreads) \
696 SymX(__hscore_get_saved_termios) \
697 SymX(__hscore_set_saved_termios) \
699 SymX(startupHaskell) \
700 SymX(shutdownHaskell) \
701 SymX(shutdownHaskellAndExit) \
702 SymX(stable_ptr_table) \
703 SymX(stackOverflow) \
704 SymX(stg_CAF_BLACKHOLE_info) \
705 SymX(awakenBlockedQueue) \
706 SymX(stg_CHARLIKE_closure) \
707 SymX(stg_MVAR_CLEAN_info) \
708 SymX(stg_MVAR_DIRTY_info) \
709 SymX(stg_IND_STATIC_info) \
710 SymX(stg_INTLIKE_closure) \
711 SymX(stg_MUT_ARR_PTRS_DIRTY_info) \
712 SymX(stg_MUT_ARR_PTRS_FROZEN_info) \
713 SymX(stg_MUT_ARR_PTRS_FROZEN0_info) \
714 SymX(stg_WEAK_info) \
715 SymX(stg_ap_v_info) \
716 SymX(stg_ap_f_info) \
717 SymX(stg_ap_d_info) \
718 SymX(stg_ap_l_info) \
719 SymX(stg_ap_n_info) \
720 SymX(stg_ap_p_info) \
721 SymX(stg_ap_pv_info) \
722 SymX(stg_ap_pp_info) \
723 SymX(stg_ap_ppv_info) \
724 SymX(stg_ap_ppp_info) \
725 SymX(stg_ap_pppv_info) \
726 SymX(stg_ap_pppp_info) \
727 SymX(stg_ap_ppppp_info) \
728 SymX(stg_ap_pppppp_info) \
729 SymX(stg_ap_0_fast) \
730 SymX(stg_ap_v_fast) \
731 SymX(stg_ap_f_fast) \
732 SymX(stg_ap_d_fast) \
733 SymX(stg_ap_l_fast) \
734 SymX(stg_ap_n_fast) \
735 SymX(stg_ap_p_fast) \
736 SymX(stg_ap_pv_fast) \
737 SymX(stg_ap_pp_fast) \
738 SymX(stg_ap_ppv_fast) \
739 SymX(stg_ap_ppp_fast) \
740 SymX(stg_ap_pppv_fast) \
741 SymX(stg_ap_pppp_fast) \
742 SymX(stg_ap_ppppp_fast) \
743 SymX(stg_ap_pppppp_fast) \
744 SymX(stg_ap_1_upd_info) \
745 SymX(stg_ap_2_upd_info) \
746 SymX(stg_ap_3_upd_info) \
747 SymX(stg_ap_4_upd_info) \
748 SymX(stg_ap_5_upd_info) \
749 SymX(stg_ap_6_upd_info) \
750 SymX(stg_ap_7_upd_info) \
752 SymX(stg_sel_0_upd_info) \
753 SymX(stg_sel_10_upd_info) \
754 SymX(stg_sel_11_upd_info) \
755 SymX(stg_sel_12_upd_info) \
756 SymX(stg_sel_13_upd_info) \
757 SymX(stg_sel_14_upd_info) \
758 SymX(stg_sel_15_upd_info) \
759 SymX(stg_sel_1_upd_info) \
760 SymX(stg_sel_2_upd_info) \
761 SymX(stg_sel_3_upd_info) \
762 SymX(stg_sel_4_upd_info) \
763 SymX(stg_sel_5_upd_info) \
764 SymX(stg_sel_6_upd_info) \
765 SymX(stg_sel_7_upd_info) \
766 SymX(stg_sel_8_upd_info) \
767 SymX(stg_sel_9_upd_info) \
768 SymX(stg_upd_frame_info) \
769 SymX(suspendThread) \
770 SymX(takeMVarzh_fast) \
771 SymX(threadStatuszh_fast) \
772 SymX(timesIntegerzh_fast) \
773 SymX(tryPutMVarzh_fast) \
774 SymX(tryTakeMVarzh_fast) \
775 SymX(unblockAsyncExceptionszh_fast) \
777 SymX(unsafeThawArrayzh_fast) \
778 SymX(waitReadzh_fast) \
779 SymX(waitWritezh_fast) \
780 SymX(word2Integerzh_fast) \
781 SymX(writeTVarzh_fast) \
782 SymX(xorIntegerzh_fast) \
784 Sym(stg_interp_constr_entry) \
787 SymX(getAllocations) \
790 Sym(rts_breakpoint_io_action) \
791 Sym(rts_stop_next_breakpoint) \
792 Sym(rts_stop_on_exception) \
794 SymX(n_capabilities) \
795 RTS_USER_SIGNALS_SYMBOLS
797 #ifdef SUPPORT_LONG_LONGS
798 #define RTS_LONG_LONG_SYMS \
799 SymX(int64ToIntegerzh_fast) \
800 SymX(word64ToIntegerzh_fast)
802 #define RTS_LONG_LONG_SYMS /* nothing */
805 // 64-bit support functions in libgcc.a
806 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
807 #define RTS_LIBGCC_SYMBOLS \
817 #elif defined(ia64_HOST_ARCH)
818 #define RTS_LIBGCC_SYMBOLS \
826 #define RTS_LIBGCC_SYMBOLS
829 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
830 // Symbols that don't have a leading underscore
831 // on Mac OS X. They have to receive special treatment,
832 // see machoInitSymbolsWithoutUnderscore()
833 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
838 /* entirely bogus claims about types of these symbols */
839 #define Sym(vvv) extern void vvv(void);
840 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
841 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
843 #define SymExtern(vvv) SymX(vvv)
845 #define SymX(vvv) /**/
846 #define SymX_redirect(vvv,xxx) /**/
850 RTS_POSIX_ONLY_SYMBOLS
851 RTS_MINGW_ONLY_SYMBOLS
852 RTS_CYGWIN_ONLY_SYMBOLS
853 RTS_DARWIN_ONLY_SYMBOLS
861 #ifdef LEADING_UNDERSCORE
862 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
864 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
867 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
869 #define SymX(vvv) Sym(vvv)
870 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
871 (void*)DLL_IMPORT_DATA_REF(vvv) },
873 // SymX_redirect allows us to redirect references to one symbol to
874 // another symbol. See newCAF/newDynCAF for an example.
875 #define SymX_redirect(vvv,xxx) \
876 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
879 static RtsSymbolVal rtsSyms[] = {
883 RTS_POSIX_ONLY_SYMBOLS
884 RTS_MINGW_ONLY_SYMBOLS
885 RTS_CYGWIN_ONLY_SYMBOLS
886 RTS_DARWIN_ONLY_SYMBOLS
889 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
890 // dyld stub code contains references to this,
891 // but it should never be called because we treat
892 // lazy pointers as nonlazy.
893 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
895 { 0, 0 } /* sentinel */
900 /* -----------------------------------------------------------------------------
901 * Insert symbols into hash tables, checking for duplicates.
904 static void ghciInsertStrHashTable ( char* obj_name,
910 if (lookupHashTable(table, (StgWord)key) == NULL)
912 insertStrHashTable(table, (StgWord)key, data);
917 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
919 "whilst processing object file\n"
921 "This could be caused by:\n"
922 " * Loading two different object files which export the same symbol\n"
923 " * Specifying the same object file twice on the GHCi command line\n"
924 " * An incorrect `package.conf' entry, causing some object to be\n"
926 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
933 /* -----------------------------------------------------------------------------
934 * initialize the object linker
938 static int linker_init_done = 0 ;
940 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
941 static void *dl_prog_handle;
949 /* Make initLinker idempotent, so we can call it
950 before evey relevant operation; that means we
951 don't need to initialise the linker separately */
952 if (linker_init_done == 1) { return; } else {
953 linker_init_done = 1;
956 stablehash = allocStrHashTable();
957 symhash = allocStrHashTable();
959 /* populate the symbol table with stuff from the RTS */
960 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
961 ghciInsertStrHashTable("(GHCi built-in symbols)",
962 symhash, sym->lbl, sym->addr);
964 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
965 machoInitSymbolsWithoutUnderscore();
968 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
969 # if defined(RTLD_DEFAULT)
970 dl_prog_handle = RTLD_DEFAULT;
972 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
973 # endif /* RTLD_DEFAULT */
977 /* -----------------------------------------------------------------------------
978 * Loading DLL or .so dynamic libraries
979 * -----------------------------------------------------------------------------
981 * Add a DLL from which symbols may be found. In the ELF case, just
982 * do RTLD_GLOBAL-style add, so no further messing around needs to
983 * happen in order that symbols in the loaded .so are findable --
984 * lookupSymbol() will subsequently see them by dlsym on the program's
985 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
987 * In the PEi386 case, open the DLLs and put handles to them in a
988 * linked list. When looking for a symbol, try all handles in the
989 * list. This means that we need to load even DLLs that are guaranteed
990 * to be in the ghc.exe image already, just so we can get a handle
991 * to give to loadSymbol, so that we can find the symbols. For such
992 * libraries, the LoadLibrary call should be a no-op except for returning
997 #if defined(OBJFORMAT_PEi386)
998 /* A record for storing handles into DLLs. */
1003 struct _OpenedDLL* next;
1008 /* A list thereof. */
1009 static OpenedDLL* opened_dlls = NULL;
1013 addDLL( char *dll_name )
1015 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1016 /* ------------------- ELF DLL loader ------------------- */
1022 // omitted: RTLD_NOW
1023 // see http://www.haskell.org/pipermail/cvs-ghc/2007-September/038570.html
1024 hdl= dlopen(dll_name, RTLD_LAZY | RTLD_GLOBAL);
1027 /* dlopen failed; return a ptr to the error msg. */
1029 if (errmsg == NULL) errmsg = "addDLL: unknown error";
1036 # elif defined(OBJFORMAT_PEi386)
1037 /* ------------------- Win32 DLL loader ------------------- */
1045 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1047 /* See if we've already got it, and ignore if so. */
1048 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1049 if (0 == strcmp(o_dll->name, dll_name))
1053 /* The file name has no suffix (yet) so that we can try
1054 both foo.dll and foo.drv
1056 The documentation for LoadLibrary says:
1057 If no file name extension is specified in the lpFileName
1058 parameter, the default library extension .dll is
1059 appended. However, the file name string can include a trailing
1060 point character (.) to indicate that the module name has no
1063 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1064 sprintf(buf, "%s.DLL", dll_name);
1065 instance = LoadLibrary(buf);
1066 if (instance == NULL) {
1067 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1068 instance = LoadLibrary(buf);
1069 if (instance == NULL) {
1072 /* LoadLibrary failed; return a ptr to the error msg. */
1073 return "addDLL: unknown error";
1078 /* Add this DLL to the list of DLLs in which to search for symbols. */
1079 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1080 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1081 strcpy(o_dll->name, dll_name);
1082 o_dll->instance = instance;
1083 o_dll->next = opened_dlls;
1084 opened_dlls = o_dll;
1088 barf("addDLL: not implemented on this platform");
1092 /* -----------------------------------------------------------------------------
1093 * insert a stable symbol in the hash table
1097 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1099 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1103 /* -----------------------------------------------------------------------------
1104 * insert a symbol in the hash table
1107 insertSymbol(char* obj_name, char* key, void* data)
1109 ghciInsertStrHashTable(obj_name, symhash, key, data);
1112 /* -----------------------------------------------------------------------------
1113 * lookup a symbol in the hash table
1116 lookupSymbol( char *lbl )
1120 ASSERT(symhash != NULL);
1121 val = lookupStrHashTable(symhash, lbl);
1124 # if defined(OBJFORMAT_ELF)
1125 return dlsym(dl_prog_handle, lbl);
1126 # elif defined(OBJFORMAT_MACHO)
1128 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1131 HACK: On OS X, global symbols are prefixed with an underscore.
1132 However, dlsym wants us to omit the leading underscore from the
1133 symbol name. For now, we simply strip it off here (and ONLY
1136 ASSERT(lbl[0] == '_');
1137 return dlsym(dl_prog_handle, lbl+1);
1139 if(NSIsSymbolNameDefined(lbl)) {
1140 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1141 return NSAddressOfSymbol(symbol);
1145 # endif /* HAVE_DLFCN_H */
1146 # elif defined(OBJFORMAT_PEi386)
1149 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1150 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1151 if (lbl[0] == '_') {
1152 /* HACK: if the name has an initial underscore, try stripping
1153 it off & look that up first. I've yet to verify whether there's
1154 a Rule that governs whether an initial '_' *should always* be
1155 stripped off when mapping from import lib name to the DLL name.
1157 sym = GetProcAddress(o_dll->instance, (lbl+1));
1159 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1163 sym = GetProcAddress(o_dll->instance, lbl);
1165 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1180 __attribute((unused))
1182 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1186 val = lookupStrHashTable(oc->lochash, lbl);
1196 /* -----------------------------------------------------------------------------
1197 * Debugging aid: look in GHCi's object symbol tables for symbols
1198 * within DELTA bytes of the specified address, and show their names.
1201 void ghci_enquire ( char* addr );
1203 void ghci_enquire ( char* addr )
1208 const int DELTA = 64;
1213 for (oc = objects; oc; oc = oc->next) {
1214 for (i = 0; i < oc->n_symbols; i++) {
1215 sym = oc->symbols[i];
1216 if (sym == NULL) continue;
1217 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1219 if (oc->lochash != NULL) {
1220 a = lookupStrHashTable(oc->lochash, sym);
1223 a = lookupStrHashTable(symhash, sym);
1226 // debugBelch("ghci_enquire: can't find %s\n", sym);
1228 else if (addr-DELTA <= a && a <= addr+DELTA) {
1229 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1236 #ifdef ia64_HOST_ARCH
1237 static unsigned int PLTSize(void);
1240 /* -----------------------------------------------------------------------------
1241 * Load an obj (populate the global symbol table, but don't resolve yet)
1243 * Returns: 1 if ok, 0 on error.
1246 loadObj( char *path )
1253 void *map_addr = NULL;
1259 /* debugBelch("loadObj %s\n", path ); */
1261 /* Check that we haven't already loaded this object.
1262 Ignore requests to load multiple times */
1266 for (o = objects; o; o = o->next) {
1267 if (0 == strcmp(o->fileName, path)) {
1269 break; /* don't need to search further */
1273 IF_DEBUG(linker, debugBelch(
1274 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1275 "same object file twice:\n"
1277 "GHCi will ignore this, but be warned.\n"
1279 return 1; /* success */
1283 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1285 # if defined(OBJFORMAT_ELF)
1286 oc->formatName = "ELF";
1287 # elif defined(OBJFORMAT_PEi386)
1288 oc->formatName = "PEi386";
1289 # elif defined(OBJFORMAT_MACHO)
1290 oc->formatName = "Mach-O";
1293 barf("loadObj: not implemented on this platform");
1296 r = stat(path, &st);
1297 if (r == -1) { return 0; }
1299 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1300 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1301 strcpy(oc->fileName, path);
1303 oc->fileSize = st.st_size;
1305 oc->sections = NULL;
1306 oc->lochash = allocStrHashTable();
1307 oc->proddables = NULL;
1309 /* chain it onto the list of objects */
1314 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1316 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1318 #if defined(openbsd_HOST_OS)
1319 fd = open(path, O_RDONLY, S_IRUSR);
1321 fd = open(path, O_RDONLY);
1324 barf("loadObj: can't open `%s'", path);
1326 pagesize = getpagesize();
1328 #ifdef ia64_HOST_ARCH
1329 /* The PLT needs to be right before the object */
1330 n = ROUND_UP(PLTSize(), pagesize);
1331 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1332 if (oc->plt == MAP_FAILED)
1333 barf("loadObj: can't allocate PLT");
1336 map_addr = oc->plt + n;
1339 n = ROUND_UP(oc->fileSize, pagesize);
1341 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1342 * small memory model on this architecture (see gcc docs,
1345 * MAP_32BIT not available on OpenBSD/amd64
1347 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
1348 #define EXTRA_MAP_FLAGS MAP_32BIT
1350 #define EXTRA_MAP_FLAGS 0
1353 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
1354 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
1355 #define MAP_ANONYMOUS MAP_ANON
1358 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1359 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1360 if (oc->image == MAP_FAILED)
1361 barf("loadObj: can't map `%s'", path);
1365 #else /* !USE_MMAP */
1367 /* load the image into memory */
1368 f = fopen(path, "rb");
1370 barf("loadObj: can't read `%s'", path);
1372 # if defined(mingw32_HOST_OS)
1373 // TODO: We would like to use allocateExec here, but allocateExec
1374 // cannot currently allocate blocks large enough.
1375 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1376 PAGE_EXECUTE_READWRITE);
1377 # elif defined(darwin_HOST_OS)
1378 // In a Mach-O .o file, all sections can and will be misaligned
1379 // if the total size of the headers is not a multiple of the
1380 // desired alignment. This is fine for .o files that only serve
1381 // as input for the static linker, but it's not fine for us,
1382 // as SSE (used by gcc for floating point) and Altivec require
1383 // 16-byte alignment.
1384 // We calculate the correct alignment from the header before
1385 // reading the file, and then we misalign oc->image on purpose so
1386 // that the actual sections end up aligned again.
1387 oc->misalignment = machoGetMisalignment(f);
1388 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1389 oc->image += oc->misalignment;
1391 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1394 n = fread ( oc->image, 1, oc->fileSize, f );
1395 if (n != oc->fileSize)
1396 barf("loadObj: error whilst reading `%s'", path);
1399 #endif /* USE_MMAP */
1401 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1402 r = ocAllocateSymbolExtras_MachO ( oc );
1403 if (!r) { return r; }
1404 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1405 r = ocAllocateSymbolExtras_ELF ( oc );
1406 if (!r) { return r; }
1409 /* verify the in-memory image */
1410 # if defined(OBJFORMAT_ELF)
1411 r = ocVerifyImage_ELF ( oc );
1412 # elif defined(OBJFORMAT_PEi386)
1413 r = ocVerifyImage_PEi386 ( oc );
1414 # elif defined(OBJFORMAT_MACHO)
1415 r = ocVerifyImage_MachO ( oc );
1417 barf("loadObj: no verify method");
1419 if (!r) { return r; }
1421 /* build the symbol list for this image */
1422 # if defined(OBJFORMAT_ELF)
1423 r = ocGetNames_ELF ( oc );
1424 # elif defined(OBJFORMAT_PEi386)
1425 r = ocGetNames_PEi386 ( oc );
1426 # elif defined(OBJFORMAT_MACHO)
1427 r = ocGetNames_MachO ( oc );
1429 barf("loadObj: no getNames method");
1431 if (!r) { return r; }
1433 /* loaded, but not resolved yet */
1434 oc->status = OBJECT_LOADED;
1439 /* -----------------------------------------------------------------------------
1440 * resolve all the currently unlinked objects in memory
1442 * Returns: 1 if ok, 0 on error.
1452 for (oc = objects; oc; oc = oc->next) {
1453 if (oc->status != OBJECT_RESOLVED) {
1454 # if defined(OBJFORMAT_ELF)
1455 r = ocResolve_ELF ( oc );
1456 # elif defined(OBJFORMAT_PEi386)
1457 r = ocResolve_PEi386 ( oc );
1458 # elif defined(OBJFORMAT_MACHO)
1459 r = ocResolve_MachO ( oc );
1461 barf("resolveObjs: not implemented on this platform");
1463 if (!r) { return r; }
1464 oc->status = OBJECT_RESOLVED;
1470 /* -----------------------------------------------------------------------------
1471 * delete an object from the pool
1474 unloadObj( char *path )
1476 ObjectCode *oc, *prev;
1478 ASSERT(symhash != NULL);
1479 ASSERT(objects != NULL);
1484 for (oc = objects; oc; prev = oc, oc = oc->next) {
1485 if (!strcmp(oc->fileName,path)) {
1487 /* Remove all the mappings for the symbols within this
1492 for (i = 0; i < oc->n_symbols; i++) {
1493 if (oc->symbols[i] != NULL) {
1494 removeStrHashTable(symhash, oc->symbols[i], NULL);
1502 prev->next = oc->next;
1505 // We're going to leave this in place, in case there are
1506 // any pointers from the heap into it:
1507 // #ifdef mingw32_HOST_OS
1508 // VirtualFree(oc->image);
1510 // stgFree(oc->image);
1512 stgFree(oc->fileName);
1513 stgFree(oc->symbols);
1514 stgFree(oc->sections);
1515 /* The local hash table should have been freed at the end
1516 of the ocResolve_ call on it. */
1517 ASSERT(oc->lochash == NULL);
1523 errorBelch("unloadObj: can't find `%s' to unload", path);
1527 /* -----------------------------------------------------------------------------
1528 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1529 * which may be prodded during relocation, and abort if we try and write
1530 * outside any of these.
1532 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1535 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1536 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1540 pb->next = oc->proddables;
1541 oc->proddables = pb;
1544 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1547 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1548 char* s = (char*)(pb->start);
1549 char* e = s + pb->size - 1;
1550 char* a = (char*)addr;
1551 /* Assumes that the biggest fixup involves a 4-byte write. This
1552 probably needs to be changed to 8 (ie, +7) on 64-bit
1554 if (a >= s && (a+3) <= e) return;
1556 barf("checkProddableBlock: invalid fixup in runtime linker");
1559 /* -----------------------------------------------------------------------------
1560 * Section management.
1562 static void addSection ( ObjectCode* oc, SectionKind kind,
1563 void* start, void* end )
1565 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1569 s->next = oc->sections;
1572 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1573 start, ((char*)end)-1, end - start + 1, kind );
1578 /* --------------------------------------------------------------------------
1580 * This is about allocating a small chunk of memory for every symbol in the
1581 * object file. We make sure that the SymboLExtras are always "in range" of
1582 * limited-range PC-relative instructions on various platforms by allocating
1583 * them right next to the object code itself.
1586 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
1589 ocAllocateSymbolExtras
1591 Allocate additional space at the end of the object file image to make room
1592 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1594 PowerPC relative branch instructions have a 24 bit displacement field.
1595 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1596 If a particular imported symbol is outside this range, we have to redirect
1597 the jump to a short piece of new code that just loads the 32bit absolute
1598 address and jumps there.
1599 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1602 This function just allocates space for one SymbolExtra for every
1603 undefined symbol in the object file. The code for the jump islands is
1604 filled in by makeSymbolExtra below.
1607 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1614 int misalignment = 0;
1615 #ifdef darwin_HOST_OS
1616 misalignment = oc->misalignment;
1622 // round up to the nearest 4
1623 aligned = (oc->fileSize + 3) & ~3;
1626 #ifndef linux_HOST_OS /* mremap is a linux extension */
1627 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1630 pagesize = getpagesize();
1631 n = ROUND_UP( oc->fileSize, pagesize );
1632 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1634 /* If we have a half-page-size file and map one page of it then
1635 * the part of the page after the size of the file remains accessible.
1636 * If, however, we map in 2 pages, the 2nd page is not accessible
1637 * and will give a "Bus Error" on access. To get around this, we check
1638 * if we need any extra pages for the jump islands and map them in
1639 * anonymously. We must check that we actually require extra pages
1640 * otherwise the attempt to mmap 0 pages of anonymous memory will
1646 /* The effect of this mremap() call is only the ensure that we have
1647 * a sufficient number of virtually contiguous pages. As returned from
1648 * mremap, the pages past the end of the file are not backed. We give
1649 * them a backing by using MAP_FIXED to map in anonymous pages.
1651 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1653 if( oc->image == MAP_FAILED )
1655 errorBelch( "Unable to mremap for Jump Islands\n" );
1659 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1660 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1662 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1668 oc->image -= misalignment;
1669 oc->image = stgReallocBytes( oc->image,
1671 aligned + sizeof (SymbolExtra) * count,
1672 "ocAllocateSymbolExtras" );
1673 oc->image += misalignment;
1674 #endif /* USE_MMAP */
1676 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1677 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1680 oc->symbol_extras = NULL;
1682 oc->first_symbol_extra = first;
1683 oc->n_symbol_extras = count;
1688 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1689 unsigned long symbolNumber,
1690 unsigned long target )
1694 ASSERT( symbolNumber >= oc->first_symbol_extra
1695 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1697 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1699 #ifdef powerpc_HOST_ARCH
1700 // lis r12, hi16(target)
1701 extra->jumpIsland.lis_r12 = 0x3d80;
1702 extra->jumpIsland.hi_addr = target >> 16;
1704 // ori r12, r12, lo16(target)
1705 extra->jumpIsland.ori_r12_r12 = 0x618c;
1706 extra->jumpIsland.lo_addr = target & 0xffff;
1709 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1712 extra->jumpIsland.bctr = 0x4e800420;
1714 #ifdef x86_64_HOST_ARCH
1716 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1717 extra->addr = target;
1718 memcpy(extra->jumpIsland, jmp, 6);
1726 /* --------------------------------------------------------------------------
1727 * PowerPC specifics (instruction cache flushing)
1728 * ------------------------------------------------------------------------*/
1730 #ifdef powerpc_TARGET_ARCH
1732 ocFlushInstructionCache
1734 Flush the data & instruction caches.
1735 Because the PPC has split data/instruction caches, we have to
1736 do that whenever we modify code at runtime.
1739 static void ocFlushInstructionCache( ObjectCode *oc )
1741 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1742 unsigned long *p = (unsigned long *) oc->image;
1746 __asm__ volatile ( "dcbf 0,%0\n\t"
1754 __asm__ volatile ( "sync\n\t"
1760 /* --------------------------------------------------------------------------
1761 * PEi386 specifics (Win32 targets)
1762 * ------------------------------------------------------------------------*/
1764 /* The information for this linker comes from
1765 Microsoft Portable Executable
1766 and Common Object File Format Specification
1767 revision 5.1 January 1998
1768 which SimonM says comes from the MS Developer Network CDs.
1770 It can be found there (on older CDs), but can also be found
1773 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1775 (this is Rev 6.0 from February 1999).
1777 Things move, so if that fails, try searching for it via
1779 http://www.google.com/search?q=PE+COFF+specification
1781 The ultimate reference for the PE format is the Winnt.h
1782 header file that comes with the Platform SDKs; as always,
1783 implementations will drift wrt their documentation.
1785 A good background article on the PE format is Matt Pietrek's
1786 March 1994 article in Microsoft System Journal (MSJ)
1787 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1788 Win32 Portable Executable File Format." The info in there
1789 has recently been updated in a two part article in
1790 MSDN magazine, issues Feb and March 2002,
1791 "Inside Windows: An In-Depth Look into the Win32 Portable
1792 Executable File Format"
1794 John Levine's book "Linkers and Loaders" contains useful
1799 #if defined(OBJFORMAT_PEi386)
1803 typedef unsigned char UChar;
1804 typedef unsigned short UInt16;
1805 typedef unsigned int UInt32;
1812 UInt16 NumberOfSections;
1813 UInt32 TimeDateStamp;
1814 UInt32 PointerToSymbolTable;
1815 UInt32 NumberOfSymbols;
1816 UInt16 SizeOfOptionalHeader;
1817 UInt16 Characteristics;
1821 #define sizeof_COFF_header 20
1828 UInt32 VirtualAddress;
1829 UInt32 SizeOfRawData;
1830 UInt32 PointerToRawData;
1831 UInt32 PointerToRelocations;
1832 UInt32 PointerToLinenumbers;
1833 UInt16 NumberOfRelocations;
1834 UInt16 NumberOfLineNumbers;
1835 UInt32 Characteristics;
1839 #define sizeof_COFF_section 40
1846 UInt16 SectionNumber;
1849 UChar NumberOfAuxSymbols;
1853 #define sizeof_COFF_symbol 18
1858 UInt32 VirtualAddress;
1859 UInt32 SymbolTableIndex;
1864 #define sizeof_COFF_reloc 10
1867 /* From PE spec doc, section 3.3.2 */
1868 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1869 windows.h -- for the same purpose, but I want to know what I'm
1871 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1872 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1873 #define MYIMAGE_FILE_DLL 0x2000
1874 #define MYIMAGE_FILE_SYSTEM 0x1000
1875 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1876 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1877 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1879 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1880 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1881 #define MYIMAGE_SYM_CLASS_STATIC 3
1882 #define MYIMAGE_SYM_UNDEFINED 0
1884 /* From PE spec doc, section 4.1 */
1885 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1886 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1887 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1889 /* From PE spec doc, section 5.2.1 */
1890 #define MYIMAGE_REL_I386_DIR32 0x0006
1891 #define MYIMAGE_REL_I386_REL32 0x0014
1894 /* We use myindex to calculate array addresses, rather than
1895 simply doing the normal subscript thing. That's because
1896 some of the above structs have sizes which are not
1897 a whole number of words. GCC rounds their sizes up to a
1898 whole number of words, which means that the address calcs
1899 arising from using normal C indexing or pointer arithmetic
1900 are just plain wrong. Sigh.
1903 myindex ( int scale, void* base, int index )
1906 ((UChar*)base) + scale * index;
1911 printName ( UChar* name, UChar* strtab )
1913 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1914 UInt32 strtab_offset = * (UInt32*)(name+4);
1915 debugBelch("%s", strtab + strtab_offset );
1918 for (i = 0; i < 8; i++) {
1919 if (name[i] == 0) break;
1920 debugBelch("%c", name[i] );
1927 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1929 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1930 UInt32 strtab_offset = * (UInt32*)(name+4);
1931 strncpy ( dst, strtab+strtab_offset, dstSize );
1937 if (name[i] == 0) break;
1947 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1950 /* If the string is longer than 8 bytes, look in the
1951 string table for it -- this will be correctly zero terminated.
1953 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1954 UInt32 strtab_offset = * (UInt32*)(name+4);
1955 return ((UChar*)strtab) + strtab_offset;
1957 /* Otherwise, if shorter than 8 bytes, return the original,
1958 which by defn is correctly terminated.
1960 if (name[7]==0) return name;
1961 /* The annoying case: 8 bytes. Copy into a temporary
1962 (which is never freed ...)
1964 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1966 strncpy(newstr,name,8);
1972 /* Just compares the short names (first 8 chars) */
1973 static COFF_section *
1974 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1978 = (COFF_header*)(oc->image);
1979 COFF_section* sectab
1981 ((UChar*)(oc->image))
1982 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1984 for (i = 0; i < hdr->NumberOfSections; i++) {
1987 COFF_section* section_i
1989 myindex ( sizeof_COFF_section, sectab, i );
1990 n1 = (UChar*) &(section_i->Name);
1992 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1993 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1994 n1[6]==n2[6] && n1[7]==n2[7])
2003 zapTrailingAtSign ( UChar* sym )
2005 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
2007 if (sym[0] == 0) return;
2009 while (sym[i] != 0) i++;
2012 while (j > 0 && my_isdigit(sym[j])) j--;
2013 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
2019 ocVerifyImage_PEi386 ( ObjectCode* oc )
2024 COFF_section* sectab;
2025 COFF_symbol* symtab;
2027 /* debugBelch("\nLOADING %s\n", oc->fileName); */
2028 hdr = (COFF_header*)(oc->image);
2029 sectab = (COFF_section*) (
2030 ((UChar*)(oc->image))
2031 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2033 symtab = (COFF_symbol*) (
2034 ((UChar*)(oc->image))
2035 + hdr->PointerToSymbolTable
2037 strtab = ((UChar*)symtab)
2038 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2040 if (hdr->Machine != 0x14c) {
2041 errorBelch("%s: Not x86 PEi386", oc->fileName);
2044 if (hdr->SizeOfOptionalHeader != 0) {
2045 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
2048 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
2049 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
2050 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
2051 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
2052 errorBelch("%s: Not a PEi386 object file", oc->fileName);
2055 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
2056 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
2057 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
2059 (int)(hdr->Characteristics));
2062 /* If the string table size is way crazy, this might indicate that
2063 there are more than 64k relocations, despite claims to the
2064 contrary. Hence this test. */
2065 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2067 if ( (*(UInt32*)strtab) > 600000 ) {
2068 /* Note that 600k has no special significance other than being
2069 big enough to handle the almost-2MB-sized lumps that
2070 constitute HSwin32*.o. */
2071 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2076 /* No further verification after this point; only debug printing. */
2078 IF_DEBUG(linker, i=1);
2079 if (i == 0) return 1;
2081 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2082 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2083 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2086 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2087 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2088 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2089 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2090 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2091 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2092 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2094 /* Print the section table. */
2096 for (i = 0; i < hdr->NumberOfSections; i++) {
2098 COFF_section* sectab_i
2100 myindex ( sizeof_COFF_section, sectab, i );
2107 printName ( sectab_i->Name, strtab );
2117 sectab_i->VirtualSize,
2118 sectab_i->VirtualAddress,
2119 sectab_i->SizeOfRawData,
2120 sectab_i->PointerToRawData,
2121 sectab_i->NumberOfRelocations,
2122 sectab_i->PointerToRelocations,
2123 sectab_i->PointerToRawData
2125 reltab = (COFF_reloc*) (
2126 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2129 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2130 /* If the relocation field (a short) has overflowed, the
2131 * real count can be found in the first reloc entry.
2133 * See Section 4.1 (last para) of the PE spec (rev6.0).
2135 COFF_reloc* rel = (COFF_reloc*)
2136 myindex ( sizeof_COFF_reloc, reltab, 0 );
2137 noRelocs = rel->VirtualAddress;
2140 noRelocs = sectab_i->NumberOfRelocations;
2144 for (; j < noRelocs; j++) {
2146 COFF_reloc* rel = (COFF_reloc*)
2147 myindex ( sizeof_COFF_reloc, reltab, j );
2149 " type 0x%-4x vaddr 0x%-8x name `",
2151 rel->VirtualAddress );
2152 sym = (COFF_symbol*)
2153 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2154 /* Hmm..mysterious looking offset - what's it for? SOF */
2155 printName ( sym->Name, strtab -10 );
2162 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2163 debugBelch("---START of string table---\n");
2164 for (i = 4; i < *(Int32*)strtab; i++) {
2166 debugBelch("\n"); else
2167 debugBelch("%c", strtab[i] );
2169 debugBelch("--- END of string table---\n");
2174 COFF_symbol* symtab_i;
2175 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2176 symtab_i = (COFF_symbol*)
2177 myindex ( sizeof_COFF_symbol, symtab, i );
2183 printName ( symtab_i->Name, strtab );
2192 (Int32)(symtab_i->SectionNumber),
2193 (UInt32)symtab_i->Type,
2194 (UInt32)symtab_i->StorageClass,
2195 (UInt32)symtab_i->NumberOfAuxSymbols
2197 i += symtab_i->NumberOfAuxSymbols;
2207 ocGetNames_PEi386 ( ObjectCode* oc )
2210 COFF_section* sectab;
2211 COFF_symbol* symtab;
2218 hdr = (COFF_header*)(oc->image);
2219 sectab = (COFF_section*) (
2220 ((UChar*)(oc->image))
2221 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2223 symtab = (COFF_symbol*) (
2224 ((UChar*)(oc->image))
2225 + hdr->PointerToSymbolTable
2227 strtab = ((UChar*)(oc->image))
2228 + hdr->PointerToSymbolTable
2229 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2231 /* Allocate space for any (local, anonymous) .bss sections. */
2233 for (i = 0; i < hdr->NumberOfSections; i++) {
2236 COFF_section* sectab_i
2238 myindex ( sizeof_COFF_section, sectab, i );
2239 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2240 /* sof 10/05: the PE spec text isn't too clear regarding what
2241 * the SizeOfRawData field is supposed to hold for object
2242 * file sections containing just uninitialized data -- for executables,
2243 * it is supposed to be zero; unclear what it's supposed to be
2244 * for object files. However, VirtualSize is guaranteed to be
2245 * zero for object files, which definitely suggests that SizeOfRawData
2246 * will be non-zero (where else would the size of this .bss section be
2247 * stored?) Looking at the COFF_section info for incoming object files,
2248 * this certainly appears to be the case.
2250 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2251 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2252 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2253 * variable decls into to the .bss section. (The specific function in Q which
2254 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2256 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2257 /* This is a non-empty .bss section. Allocate zeroed space for
2258 it, and set its PointerToRawData field such that oc->image +
2259 PointerToRawData == addr_of_zeroed_space. */
2260 bss_sz = sectab_i->VirtualSize;
2261 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2262 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2263 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2264 addProddableBlock(oc, zspace, bss_sz);
2265 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2268 /* Copy section information into the ObjectCode. */
2270 for (i = 0; i < hdr->NumberOfSections; i++) {
2276 = SECTIONKIND_OTHER;
2277 COFF_section* sectab_i
2279 myindex ( sizeof_COFF_section, sectab, i );
2280 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2283 /* I'm sure this is the Right Way to do it. However, the
2284 alternative of testing the sectab_i->Name field seems to
2285 work ok with Cygwin.
2287 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2288 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2289 kind = SECTIONKIND_CODE_OR_RODATA;
2292 if (0==strcmp(".text",sectab_i->Name) ||
2293 0==strcmp(".rdata",sectab_i->Name)||
2294 0==strcmp(".rodata",sectab_i->Name))
2295 kind = SECTIONKIND_CODE_OR_RODATA;
2296 if (0==strcmp(".data",sectab_i->Name) ||
2297 0==strcmp(".bss",sectab_i->Name))
2298 kind = SECTIONKIND_RWDATA;
2300 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2301 sz = sectab_i->SizeOfRawData;
2302 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2304 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2305 end = start + sz - 1;
2307 if (kind == SECTIONKIND_OTHER
2308 /* Ignore sections called which contain stabs debugging
2310 && 0 != strcmp(".stab", sectab_i->Name)
2311 && 0 != strcmp(".stabstr", sectab_i->Name)
2312 /* ignore constructor section for now */
2313 && 0 != strcmp(".ctors", sectab_i->Name)
2314 /* ignore section generated from .ident */
2315 && 0!= strcmp("/4", sectab_i->Name)
2316 /* ignore unknown section that appeared in gcc 3.4.5(?) */
2317 && 0!= strcmp(".reloc", sectab_i->Name)
2319 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2323 if (kind != SECTIONKIND_OTHER && end >= start) {
2324 addSection(oc, kind, start, end);
2325 addProddableBlock(oc, start, end - start + 1);
2329 /* Copy exported symbols into the ObjectCode. */
2331 oc->n_symbols = hdr->NumberOfSymbols;
2332 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2333 "ocGetNames_PEi386(oc->symbols)");
2334 /* Call me paranoid; I don't care. */
2335 for (i = 0; i < oc->n_symbols; i++)
2336 oc->symbols[i] = NULL;
2340 COFF_symbol* symtab_i;
2341 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2342 symtab_i = (COFF_symbol*)
2343 myindex ( sizeof_COFF_symbol, symtab, i );
2347 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2348 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2349 /* This symbol is global and defined, viz, exported */
2350 /* for MYIMAGE_SYMCLASS_EXTERNAL
2351 && !MYIMAGE_SYM_UNDEFINED,
2352 the address of the symbol is:
2353 address of relevant section + offset in section
2355 COFF_section* sectabent
2356 = (COFF_section*) myindex ( sizeof_COFF_section,
2358 symtab_i->SectionNumber-1 );
2359 addr = ((UChar*)(oc->image))
2360 + (sectabent->PointerToRawData
2364 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2365 && symtab_i->Value > 0) {
2366 /* This symbol isn't in any section at all, ie, global bss.
2367 Allocate zeroed space for it. */
2368 addr = stgCallocBytes(1, symtab_i->Value,
2369 "ocGetNames_PEi386(non-anonymous bss)");
2370 addSection(oc, SECTIONKIND_RWDATA, addr,
2371 ((UChar*)addr) + symtab_i->Value - 1);
2372 addProddableBlock(oc, addr, symtab_i->Value);
2373 /* debugBelch("BSS section at 0x%x\n", addr); */
2376 if (addr != NULL ) {
2377 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2378 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2379 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2380 ASSERT(i >= 0 && i < oc->n_symbols);
2381 /* cstring_from_COFF_symbol_name always succeeds. */
2382 oc->symbols[i] = sname;
2383 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2387 "IGNORING symbol %d\n"
2391 printName ( symtab_i->Name, strtab );
2400 (Int32)(symtab_i->SectionNumber),
2401 (UInt32)symtab_i->Type,
2402 (UInt32)symtab_i->StorageClass,
2403 (UInt32)symtab_i->NumberOfAuxSymbols
2408 i += symtab_i->NumberOfAuxSymbols;
2417 ocResolve_PEi386 ( ObjectCode* oc )
2420 COFF_section* sectab;
2421 COFF_symbol* symtab;
2431 /* ToDo: should be variable-sized? But is at least safe in the
2432 sense of buffer-overrun-proof. */
2434 /* debugBelch("resolving for %s\n", oc->fileName); */
2436 hdr = (COFF_header*)(oc->image);
2437 sectab = (COFF_section*) (
2438 ((UChar*)(oc->image))
2439 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2441 symtab = (COFF_symbol*) (
2442 ((UChar*)(oc->image))
2443 + hdr->PointerToSymbolTable
2445 strtab = ((UChar*)(oc->image))
2446 + hdr->PointerToSymbolTable
2447 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2449 for (i = 0; i < hdr->NumberOfSections; i++) {
2450 COFF_section* sectab_i
2452 myindex ( sizeof_COFF_section, sectab, i );
2455 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2458 /* Ignore sections called which contain stabs debugging
2460 if (0 == strcmp(".stab", sectab_i->Name)
2461 || 0 == strcmp(".stabstr", sectab_i->Name)
2462 || 0 == strcmp(".ctors", sectab_i->Name))
2465 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2466 /* If the relocation field (a short) has overflowed, the
2467 * real count can be found in the first reloc entry.
2469 * See Section 4.1 (last para) of the PE spec (rev6.0).
2471 * Nov2003 update: the GNU linker still doesn't correctly
2472 * handle the generation of relocatable object files with
2473 * overflown relocations. Hence the output to warn of potential
2476 COFF_reloc* rel = (COFF_reloc*)
2477 myindex ( sizeof_COFF_reloc, reltab, 0 );
2478 noRelocs = rel->VirtualAddress;
2480 /* 10/05: we now assume (and check for) a GNU ld that is capable
2481 * of handling object files with (>2^16) of relocs.
2484 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2489 noRelocs = sectab_i->NumberOfRelocations;
2494 for (; j < noRelocs; j++) {
2496 COFF_reloc* reltab_j
2498 myindex ( sizeof_COFF_reloc, reltab, j );
2500 /* the location to patch */
2502 ((UChar*)(oc->image))
2503 + (sectab_i->PointerToRawData
2504 + reltab_j->VirtualAddress
2505 - sectab_i->VirtualAddress )
2507 /* the existing contents of pP */
2509 /* the symbol to connect to */
2510 sym = (COFF_symbol*)
2511 myindex ( sizeof_COFF_symbol,
2512 symtab, reltab_j->SymbolTableIndex );
2515 "reloc sec %2d num %3d: type 0x%-4x "
2516 "vaddr 0x%-8x name `",
2518 (UInt32)reltab_j->Type,
2519 reltab_j->VirtualAddress );
2520 printName ( sym->Name, strtab );
2521 debugBelch("'\n" ));
2523 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2524 COFF_section* section_sym
2525 = findPEi386SectionCalled ( oc, sym->Name );
2527 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2530 S = ((UInt32)(oc->image))
2531 + (section_sym->PointerToRawData
2534 copyName ( sym->Name, strtab, symbol, 1000-1 );
2535 S = (UInt32) lookupLocalSymbol( oc, symbol );
2536 if ((void*)S != NULL) goto foundit;
2537 S = (UInt32) lookupSymbol( symbol );
2538 if ((void*)S != NULL) goto foundit;
2539 zapTrailingAtSign ( symbol );
2540 S = (UInt32) lookupLocalSymbol( oc, symbol );
2541 if ((void*)S != NULL) goto foundit;
2542 S = (UInt32) lookupSymbol( symbol );
2543 if ((void*)S != NULL) goto foundit;
2544 /* Newline first because the interactive linker has printed "linking..." */
2545 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2549 checkProddableBlock(oc, pP);
2550 switch (reltab_j->Type) {
2551 case MYIMAGE_REL_I386_DIR32:
2554 case MYIMAGE_REL_I386_REL32:
2555 /* Tricky. We have to insert a displacement at
2556 pP which, when added to the PC for the _next_
2557 insn, gives the address of the target (S).
2558 Problem is to know the address of the next insn
2559 when we only know pP. We assume that this
2560 literal field is always the last in the insn,
2561 so that the address of the next insn is pP+4
2562 -- hence the constant 4.
2563 Also I don't know if A should be added, but so
2564 far it has always been zero.
2566 SOF 05/2005: 'A' (old contents of *pP) have been observed
2567 to contain values other than zero (the 'wx' object file
2568 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2569 So, add displacement to old value instead of asserting
2570 A to be zero. Fixes wxhaskell-related crashes, and no other
2571 ill effects have been observed.
2573 Update: the reason why we're seeing these more elaborate
2574 relocations is due to a switch in how the NCG compiles SRTs
2575 and offsets to them from info tables. SRTs live in .(ro)data,
2576 while info tables live in .text, causing GAS to emit REL32/DISP32
2577 relocations with non-zero values. Adding the displacement is
2578 the right thing to do.
2580 *pP = S - ((UInt32)pP) - 4 + A;
2583 debugBelch("%s: unhandled PEi386 relocation type %d",
2584 oc->fileName, reltab_j->Type);
2591 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2595 #endif /* defined(OBJFORMAT_PEi386) */
2598 /* --------------------------------------------------------------------------
2600 * ------------------------------------------------------------------------*/
2602 #if defined(OBJFORMAT_ELF)
2607 #if defined(sparc_HOST_ARCH)
2608 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2609 #elif defined(i386_HOST_ARCH)
2610 # define ELF_TARGET_386 /* Used inside <elf.h> */
2611 #elif defined(x86_64_HOST_ARCH)
2612 # define ELF_TARGET_X64_64
2614 #elif defined (ia64_HOST_ARCH)
2615 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2617 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2618 # define ELF_NEED_GOT /* needs Global Offset Table */
2619 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2622 #if !defined(openbsd_HOST_OS)
2625 /* openbsd elf has things in different places, with diff names */
2626 # include <elf_abi.h>
2627 # include <machine/reloc.h>
2628 # define R_386_32 RELOC_32
2629 # define R_386_PC32 RELOC_PC32
2632 /* If elf.h doesn't define it */
2633 # ifndef R_X86_64_PC64
2634 # define R_X86_64_PC64 24
2638 * Define a set of types which can be used for both ELF32 and ELF64
2642 #define ELFCLASS ELFCLASS64
2643 #define Elf_Addr Elf64_Addr
2644 #define Elf_Word Elf64_Word
2645 #define Elf_Sword Elf64_Sword
2646 #define Elf_Ehdr Elf64_Ehdr
2647 #define Elf_Phdr Elf64_Phdr
2648 #define Elf_Shdr Elf64_Shdr
2649 #define Elf_Sym Elf64_Sym
2650 #define Elf_Rel Elf64_Rel
2651 #define Elf_Rela Elf64_Rela
2652 #define ELF_ST_TYPE ELF64_ST_TYPE
2653 #define ELF_ST_BIND ELF64_ST_BIND
2654 #define ELF_R_TYPE ELF64_R_TYPE
2655 #define ELF_R_SYM ELF64_R_SYM
2657 #define ELFCLASS ELFCLASS32
2658 #define Elf_Addr Elf32_Addr
2659 #define Elf_Word Elf32_Word
2660 #define Elf_Sword Elf32_Sword
2661 #define Elf_Ehdr Elf32_Ehdr
2662 #define Elf_Phdr Elf32_Phdr
2663 #define Elf_Shdr Elf32_Shdr
2664 #define Elf_Sym Elf32_Sym
2665 #define Elf_Rel Elf32_Rel
2666 #define Elf_Rela Elf32_Rela
2668 #define ELF_ST_TYPE ELF32_ST_TYPE
2671 #define ELF_ST_BIND ELF32_ST_BIND
2674 #define ELF_R_TYPE ELF32_R_TYPE
2677 #define ELF_R_SYM ELF32_R_SYM
2683 * Functions to allocate entries in dynamic sections. Currently we simply
2684 * preallocate a large number, and we don't check if a entry for the given
2685 * target already exists (a linear search is too slow). Ideally these
2686 * entries would be associated with symbols.
2689 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2690 #define GOT_SIZE 0x20000
2691 #define FUNCTION_TABLE_SIZE 0x10000
2692 #define PLT_SIZE 0x08000
2695 static Elf_Addr got[GOT_SIZE];
2696 static unsigned int gotIndex;
2697 static Elf_Addr gp_val = (Elf_Addr)got;
2700 allocateGOTEntry(Elf_Addr target)
2704 if (gotIndex >= GOT_SIZE)
2705 barf("Global offset table overflow");
2707 entry = &got[gotIndex++];
2709 return (Elf_Addr)entry;
2713 #ifdef ELF_FUNCTION_DESC
2719 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2720 static unsigned int functionTableIndex;
2723 allocateFunctionDesc(Elf_Addr target)
2725 FunctionDesc *entry;
2727 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2728 barf("Function table overflow");
2730 entry = &functionTable[functionTableIndex++];
2732 entry->gp = (Elf_Addr)gp_val;
2733 return (Elf_Addr)entry;
2737 copyFunctionDesc(Elf_Addr target)
2739 FunctionDesc *olddesc = (FunctionDesc *)target;
2740 FunctionDesc *newdesc;
2742 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2743 newdesc->gp = olddesc->gp;
2744 return (Elf_Addr)newdesc;
2749 #ifdef ia64_HOST_ARCH
2750 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2751 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2753 static unsigned char plt_code[] =
2755 /* taken from binutils bfd/elfxx-ia64.c */
2756 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2757 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2758 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2759 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2760 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2761 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2764 /* If we can't get to the function descriptor via gp, take a local copy of it */
2765 #define PLT_RELOC(code, target) { \
2766 Elf64_Sxword rel_value = target - gp_val; \
2767 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2768 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2770 ia64_reloc_gprel22((Elf_Addr)code, target); \
2775 unsigned char code[sizeof(plt_code)];
2779 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2781 PLTEntry *plt = (PLTEntry *)oc->plt;
2784 if (oc->pltIndex >= PLT_SIZE)
2785 barf("Procedure table overflow");
2787 entry = &plt[oc->pltIndex++];
2788 memcpy(entry->code, plt_code, sizeof(entry->code));
2789 PLT_RELOC(entry->code, target);
2790 return (Elf_Addr)entry;
2796 return (PLT_SIZE * sizeof(PLTEntry));
2802 * Generic ELF functions
2806 findElfSection ( void* objImage, Elf_Word sh_type )
2808 char* ehdrC = (char*)objImage;
2809 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2810 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2811 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2815 for (i = 0; i < ehdr->e_shnum; i++) {
2816 if (shdr[i].sh_type == sh_type
2817 /* Ignore the section header's string table. */
2818 && i != ehdr->e_shstrndx
2819 /* Ignore string tables named .stabstr, as they contain
2821 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2823 ptr = ehdrC + shdr[i].sh_offset;
2830 #if defined(ia64_HOST_ARCH)
2832 findElfSegment ( void* objImage, Elf_Addr vaddr )
2834 char* ehdrC = (char*)objImage;
2835 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2836 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2837 Elf_Addr segaddr = 0;
2840 for (i = 0; i < ehdr->e_phnum; i++) {
2841 segaddr = phdr[i].p_vaddr;
2842 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2850 ocVerifyImage_ELF ( ObjectCode* oc )
2854 int i, j, nent, nstrtab, nsymtabs;
2858 char* ehdrC = (char*)(oc->image);
2859 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2861 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2862 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2863 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2864 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2865 errorBelch("%s: not an ELF object", oc->fileName);
2869 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2870 errorBelch("%s: unsupported ELF format", oc->fileName);
2874 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2875 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2877 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2878 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2880 errorBelch("%s: unknown endiannness", oc->fileName);
2884 if (ehdr->e_type != ET_REL) {
2885 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2888 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2890 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2891 switch (ehdr->e_machine) {
2892 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2893 #ifdef EM_SPARC32PLUS
2894 case EM_SPARC32PLUS:
2896 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2898 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2900 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2902 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2903 #elif defined(EM_AMD64)
2904 case EM_AMD64: IF_DEBUG(linker,debugBelch( "amd64" )); break;
2906 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2907 errorBelch("%s: unknown architecture (e_machine == %d)"
2908 , oc->fileName, ehdr->e_machine);
2912 IF_DEBUG(linker,debugBelch(
2913 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2914 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2916 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2918 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2920 if (ehdr->e_shstrndx == SHN_UNDEF) {
2921 errorBelch("%s: no section header string table", oc->fileName);
2924 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2926 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2929 for (i = 0; i < ehdr->e_shnum; i++) {
2930 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2931 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2932 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2933 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2934 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2935 ehdrC + shdr[i].sh_offset,
2936 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2938 if (shdr[i].sh_type == SHT_REL) {
2939 IF_DEBUG(linker,debugBelch("Rel " ));
2940 } else if (shdr[i].sh_type == SHT_RELA) {
2941 IF_DEBUG(linker,debugBelch("RelA " ));
2943 IF_DEBUG(linker,debugBelch(" "));
2946 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2950 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2953 for (i = 0; i < ehdr->e_shnum; i++) {
2954 if (shdr[i].sh_type == SHT_STRTAB
2955 /* Ignore the section header's string table. */
2956 && i != ehdr->e_shstrndx
2957 /* Ignore string tables named .stabstr, as they contain
2959 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2961 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2962 strtab = ehdrC + shdr[i].sh_offset;
2967 errorBelch("%s: no string tables, or too many", oc->fileName);
2972 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2973 for (i = 0; i < ehdr->e_shnum; i++) {
2974 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2975 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2977 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2978 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2979 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2981 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2983 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2984 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2987 for (j = 0; j < nent; j++) {
2988 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2989 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2990 (int)stab[j].st_shndx,
2991 (int)stab[j].st_size,
2992 (char*)stab[j].st_value ));
2994 IF_DEBUG(linker,debugBelch("type=" ));
2995 switch (ELF_ST_TYPE(stab[j].st_info)) {
2996 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2997 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2998 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2999 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
3000 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
3001 default: IF_DEBUG(linker,debugBelch("? " )); break;
3003 IF_DEBUG(linker,debugBelch(" " ));
3005 IF_DEBUG(linker,debugBelch("bind=" ));
3006 switch (ELF_ST_BIND(stab[j].st_info)) {
3007 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
3008 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
3009 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
3010 default: IF_DEBUG(linker,debugBelch("? " )); break;
3012 IF_DEBUG(linker,debugBelch(" " ));
3014 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
3018 if (nsymtabs == 0) {
3019 errorBelch("%s: didn't find any symbol tables", oc->fileName);
3026 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
3030 if (hdr->sh_type == SHT_PROGBITS
3031 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
3032 /* .text-style section */
3033 return SECTIONKIND_CODE_OR_RODATA;
3036 if (hdr->sh_type == SHT_PROGBITS
3037 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3038 /* .data-style section */
3039 return SECTIONKIND_RWDATA;
3042 if (hdr->sh_type == SHT_PROGBITS
3043 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3044 /* .rodata-style section */
3045 return SECTIONKIND_CODE_OR_RODATA;
3048 if (hdr->sh_type == SHT_NOBITS
3049 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3050 /* .bss-style section */
3052 return SECTIONKIND_RWDATA;
3055 return SECTIONKIND_OTHER;
3060 ocGetNames_ELF ( ObjectCode* oc )
3065 char* ehdrC = (char*)(oc->image);
3066 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3067 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3068 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3070 ASSERT(symhash != NULL);
3073 errorBelch("%s: no strtab", oc->fileName);
3078 for (i = 0; i < ehdr->e_shnum; i++) {
3079 /* Figure out what kind of section it is. Logic derived from
3080 Figure 1.14 ("Special Sections") of the ELF document
3081 ("Portable Formats Specification, Version 1.1"). */
3083 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3085 if (is_bss && shdr[i].sh_size > 0) {
3086 /* This is a non-empty .bss section. Allocate zeroed space for
3087 it, and set its .sh_offset field such that
3088 ehdrC + .sh_offset == addr_of_zeroed_space. */
3089 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3090 "ocGetNames_ELF(BSS)");
3091 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3093 debugBelch("BSS section at 0x%x, size %d\n",
3094 zspace, shdr[i].sh_size);
3098 /* fill in the section info */
3099 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3100 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3101 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3102 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3105 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3107 /* copy stuff into this module's object symbol table */
3108 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3109 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3111 oc->n_symbols = nent;
3112 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3113 "ocGetNames_ELF(oc->symbols)");
3115 for (j = 0; j < nent; j++) {
3117 char isLocal = FALSE; /* avoids uninit-var warning */
3119 char* nm = strtab + stab[j].st_name;
3120 int secno = stab[j].st_shndx;
3122 /* Figure out if we want to add it; if so, set ad to its
3123 address. Otherwise leave ad == NULL. */
3125 if (secno == SHN_COMMON) {
3127 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3129 debugBelch("COMMON symbol, size %d name %s\n",
3130 stab[j].st_size, nm);
3132 /* Pointless to do addProddableBlock() for this area,
3133 since the linker should never poke around in it. */
3136 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3137 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3139 /* and not an undefined symbol */
3140 && stab[j].st_shndx != SHN_UNDEF
3141 /* and not in a "special section" */
3142 && stab[j].st_shndx < SHN_LORESERVE
3144 /* and it's a not a section or string table or anything silly */
3145 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3146 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3147 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3150 /* Section 0 is the undefined section, hence > and not >=. */
3151 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3153 if (shdr[secno].sh_type == SHT_NOBITS) {
3154 debugBelch(" BSS symbol, size %d off %d name %s\n",
3155 stab[j].st_size, stab[j].st_value, nm);
3158 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3159 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3162 #ifdef ELF_FUNCTION_DESC
3163 /* dlsym() and the initialisation table both give us function
3164 * descriptors, so to be consistent we store function descriptors
3165 * in the symbol table */
3166 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3167 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3169 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s\n",
3170 ad, oc->fileName, nm ));
3175 /* And the decision is ... */
3179 oc->symbols[j] = nm;
3182 /* Ignore entirely. */
3184 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3188 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3189 strtab + stab[j].st_name ));
3192 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3193 (int)ELF_ST_BIND(stab[j].st_info),
3194 (int)ELF_ST_TYPE(stab[j].st_info),
3195 (int)stab[j].st_shndx,
3196 strtab + stab[j].st_name
3199 oc->symbols[j] = NULL;
3208 /* Do ELF relocations which lack an explicit addend. All x86-linux
3209 relocations appear to be of this form. */
3211 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3212 Elf_Shdr* shdr, int shnum,
3213 Elf_Sym* stab, char* strtab )
3218 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3219 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3220 int target_shndx = shdr[shnum].sh_info;
3221 int symtab_shndx = shdr[shnum].sh_link;
3223 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3224 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3225 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3226 target_shndx, symtab_shndx ));
3228 /* Skip sections that we're not interested in. */
3231 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3232 if (kind == SECTIONKIND_OTHER) {
3233 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3238 for (j = 0; j < nent; j++) {
3239 Elf_Addr offset = rtab[j].r_offset;
3240 Elf_Addr info = rtab[j].r_info;
3242 Elf_Addr P = ((Elf_Addr)targ) + offset;
3243 Elf_Word* pP = (Elf_Word*)P;
3248 StgStablePtr stablePtr;
3251 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3252 j, (void*)offset, (void*)info ));
3254 IF_DEBUG(linker,debugBelch( " ZERO" ));
3257 Elf_Sym sym = stab[ELF_R_SYM(info)];
3258 /* First see if it is a local symbol. */
3259 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3260 /* Yes, so we can get the address directly from the ELF symbol
3262 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3264 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3265 + stab[ELF_R_SYM(info)].st_value);
3268 symbol = strtab + sym.st_name;
3269 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3270 if (NULL == stablePtr) {
3271 /* No, so look up the name in our global table. */
3272 S_tmp = lookupSymbol( symbol );
3273 S = (Elf_Addr)S_tmp;
3275 stableVal = deRefStablePtr( stablePtr );
3277 S = (Elf_Addr)S_tmp;
3281 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3284 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3287 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3288 (void*)P, (void*)S, (void*)A ));
3289 checkProddableBlock ( oc, pP );
3293 switch (ELF_R_TYPE(info)) {
3294 # ifdef i386_HOST_ARCH
3295 case R_386_32: *pP = value; break;
3296 case R_386_PC32: *pP = value - P; break;
3299 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3300 oc->fileName, (lnat)ELF_R_TYPE(info));
3308 /* Do ELF relocations for which explicit addends are supplied.
3309 sparc-solaris relocations appear to be of this form. */
3311 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3312 Elf_Shdr* shdr, int shnum,
3313 Elf_Sym* stab, char* strtab )
3316 char *symbol = NULL;
3318 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3319 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3320 int target_shndx = shdr[shnum].sh_info;
3321 int symtab_shndx = shdr[shnum].sh_link;
3323 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3324 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3325 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3326 target_shndx, symtab_shndx ));
3328 for (j = 0; j < nent; j++) {
3329 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3330 /* This #ifdef only serves to avoid unused-var warnings. */
3331 Elf_Addr offset = rtab[j].r_offset;
3332 Elf_Addr P = targ + offset;
3334 Elf_Addr info = rtab[j].r_info;
3335 Elf_Addr A = rtab[j].r_addend;
3339 # if defined(sparc_HOST_ARCH)
3340 Elf_Word* pP = (Elf_Word*)P;
3342 # elif defined(ia64_HOST_ARCH)
3343 Elf64_Xword *pP = (Elf64_Xword *)P;
3345 # elif defined(powerpc_HOST_ARCH)
3349 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3350 j, (void*)offset, (void*)info,
3353 IF_DEBUG(linker,debugBelch( " ZERO" ));
3356 Elf_Sym sym = stab[ELF_R_SYM(info)];
3357 /* First see if it is a local symbol. */
3358 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3359 /* Yes, so we can get the address directly from the ELF symbol
3361 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3363 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3364 + stab[ELF_R_SYM(info)].st_value);
3365 #ifdef ELF_FUNCTION_DESC
3366 /* Make a function descriptor for this function */
3367 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3368 S = allocateFunctionDesc(S + A);
3373 /* No, so look up the name in our global table. */
3374 symbol = strtab + sym.st_name;
3375 S_tmp = lookupSymbol( symbol );
3376 S = (Elf_Addr)S_tmp;
3378 #ifdef ELF_FUNCTION_DESC
3379 /* If a function, already a function descriptor - we would
3380 have to copy it to add an offset. */
3381 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3382 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3386 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3389 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3392 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3393 (void*)P, (void*)S, (void*)A ));
3394 /* checkProddableBlock ( oc, (void*)P ); */
3398 switch (ELF_R_TYPE(info)) {
3399 # if defined(sparc_HOST_ARCH)
3400 case R_SPARC_WDISP30:
3401 w1 = *pP & 0xC0000000;
3402 w2 = (Elf_Word)((value - P) >> 2);
3403 ASSERT((w2 & 0xC0000000) == 0);
3408 w1 = *pP & 0xFFC00000;
3409 w2 = (Elf_Word)(value >> 10);
3410 ASSERT((w2 & 0xFFC00000) == 0);
3416 w2 = (Elf_Word)(value & 0x3FF);
3417 ASSERT((w2 & ~0x3FF) == 0);
3421 /* According to the Sun documentation:
3423 This relocation type resembles R_SPARC_32, except it refers to an
3424 unaligned word. That is, the word to be relocated must be treated
3425 as four separate bytes with arbitrary alignment, not as a word
3426 aligned according to the architecture requirements.
3428 (JRS: which means that freeloading on the R_SPARC_32 case
3429 is probably wrong, but hey ...)
3433 w2 = (Elf_Word)value;
3436 # elif defined(ia64_HOST_ARCH)
3437 case R_IA64_DIR64LSB:
3438 case R_IA64_FPTR64LSB:
3441 case R_IA64_PCREL64LSB:
3444 case R_IA64_SEGREL64LSB:
3445 addr = findElfSegment(ehdrC, value);
3448 case R_IA64_GPREL22:
3449 ia64_reloc_gprel22(P, value);
3451 case R_IA64_LTOFF22:
3452 case R_IA64_LTOFF22X:
3453 case R_IA64_LTOFF_FPTR22:
3454 addr = allocateGOTEntry(value);
3455 ia64_reloc_gprel22(P, addr);
3457 case R_IA64_PCREL21B:
3458 ia64_reloc_pcrel21(P, S, oc);
3461 /* This goes with R_IA64_LTOFF22X and points to the load to
3462 * convert into a move. We don't implement relaxation. */
3464 # elif defined(powerpc_HOST_ARCH)
3465 case R_PPC_ADDR16_LO:
3466 *(Elf32_Half*) P = value;
3469 case R_PPC_ADDR16_HI:
3470 *(Elf32_Half*) P = value >> 16;
3473 case R_PPC_ADDR16_HA:
3474 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3478 *(Elf32_Word *) P = value;
3482 *(Elf32_Word *) P = value - P;
3488 if( delta << 6 >> 6 != delta )
3490 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3494 if( value == 0 || delta << 6 >> 6 != delta )
3496 barf( "Unable to make SymbolExtra for #%d",
3502 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3503 | (delta & 0x3fffffc);
3507 #if x86_64_HOST_ARCH
3509 *(Elf64_Xword *)P = value;
3514 StgInt64 off = value - P;
3515 if (off >= 0x7fffffffL || off < -0x80000000L) {
3516 #if X86_64_ELF_NONPIC_HACK
3517 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3519 off = pltAddress + A - P;
3521 barf("R_X86_64_PC32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3522 symbol, off, oc->fileName );
3525 *(Elf64_Word *)P = (Elf64_Word)off;
3531 StgInt64 off = value - P;
3532 *(Elf64_Word *)P = (Elf64_Word)off;
3537 if (value >= 0x7fffffffL) {
3538 #if X86_64_ELF_NONPIC_HACK
3539 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3541 value = pltAddress + A;
3543 barf("R_X86_64_32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3544 symbol, value, oc->fileName );
3547 *(Elf64_Word *)P = (Elf64_Word)value;
3551 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3552 #if X86_64_ELF_NONPIC_HACK
3553 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3555 value = pltAddress + A;
3557 barf("R_X86_64_32S relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3558 symbol, value, oc->fileName );
3561 *(Elf64_Sword *)P = (Elf64_Sword)value;
3564 case R_X86_64_GOTPCREL:
3566 StgInt64 gotAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)->addr;
3567 StgInt64 off = gotAddress + A - P;
3568 *(Elf64_Word *)P = (Elf64_Word)off;
3572 case R_X86_64_PLT32:
3574 StgInt64 off = value - P;
3575 if (off >= 0x7fffffffL || off < -0x80000000L) {
3576 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3578 off = pltAddress + A - P;
3580 *(Elf64_Word *)P = (Elf64_Word)off;
3586 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3587 oc->fileName, (lnat)ELF_R_TYPE(info));
3596 ocResolve_ELF ( ObjectCode* oc )
3600 Elf_Sym* stab = NULL;
3601 char* ehdrC = (char*)(oc->image);
3602 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3603 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3605 /* first find "the" symbol table */
3606 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3608 /* also go find the string table */
3609 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3611 if (stab == NULL || strtab == NULL) {
3612 errorBelch("%s: can't find string or symbol table", oc->fileName);
3616 /* Process the relocation sections. */
3617 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3618 if (shdr[shnum].sh_type == SHT_REL) {
3619 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3620 shnum, stab, strtab );
3624 if (shdr[shnum].sh_type == SHT_RELA) {
3625 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3626 shnum, stab, strtab );
3631 /* Free the local symbol table; we won't need it again. */
3632 freeHashTable(oc->lochash, NULL);
3635 #if defined(powerpc_HOST_ARCH)
3636 ocFlushInstructionCache( oc );
3644 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3645 * at the front. The following utility functions pack and unpack instructions, and
3646 * take care of the most common relocations.
3649 #ifdef ia64_HOST_ARCH
3652 ia64_extract_instruction(Elf64_Xword *target)
3655 int slot = (Elf_Addr)target & 3;
3656 target = (Elf_Addr)target & ~3;
3664 return ((w1 >> 5) & 0x1ffffffffff);
3666 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3670 barf("ia64_extract_instruction: invalid slot %p", target);
3675 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3677 int slot = (Elf_Addr)target & 3;
3678 target = (Elf_Addr)target & ~3;
3683 *target |= value << 5;
3686 *target |= value << 46;
3687 *(target+1) |= value >> 18;
3690 *(target+1) |= value << 23;
3696 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3698 Elf64_Xword instruction;
3699 Elf64_Sxword rel_value;
3701 rel_value = value - gp_val;
3702 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3703 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3705 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3706 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3707 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3708 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3709 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3710 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3714 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3716 Elf64_Xword instruction;
3717 Elf64_Sxword rel_value;
3720 entry = allocatePLTEntry(value, oc);
3722 rel_value = (entry >> 4) - (target >> 4);
3723 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3724 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3726 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3727 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3728 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3729 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3735 * PowerPC & X86_64 ELF specifics
3738 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3740 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3746 ehdr = (Elf_Ehdr *) oc->image;
3747 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3749 for( i = 0; i < ehdr->e_shnum; i++ )
3750 if( shdr[i].sh_type == SHT_SYMTAB )
3753 if( i == ehdr->e_shnum )
3755 errorBelch( "This ELF file contains no symtab" );
3759 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3761 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3762 (int) shdr[i].sh_entsize, (int) sizeof( Elf_Sym ) );
3767 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3770 #endif /* powerpc */
3774 /* --------------------------------------------------------------------------
3776 * ------------------------------------------------------------------------*/
3778 #if defined(OBJFORMAT_MACHO)
3781 Support for MachO linking on Darwin/MacOS X
3782 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3784 I hereby formally apologize for the hackish nature of this code.
3785 Things that need to be done:
3786 *) implement ocVerifyImage_MachO
3787 *) add still more sanity checks.
3790 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3791 #define mach_header mach_header_64
3792 #define segment_command segment_command_64
3793 #define section section_64
3794 #define nlist nlist_64
3797 #ifdef powerpc_HOST_ARCH
3798 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3800 struct mach_header *header = (struct mach_header *) oc->image;
3801 struct load_command *lc = (struct load_command *) (header + 1);
3804 for( i = 0; i < header->ncmds; i++ )
3806 if( lc->cmd == LC_SYMTAB )
3808 // Find out the first and last undefined external
3809 // symbol, so we don't have to allocate too many
3811 struct symtab_command *symLC = (struct symtab_command *) lc;
3812 unsigned min = symLC->nsyms, max = 0;
3813 struct nlist *nlist =
3814 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3816 for(i=0;i<symLC->nsyms;i++)
3818 if(nlist[i].n_type & N_STAB)
3820 else if(nlist[i].n_type & N_EXT)
3822 if((nlist[i].n_type & N_TYPE) == N_UNDF
3823 && (nlist[i].n_value == 0))
3833 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3838 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3840 return ocAllocateSymbolExtras(oc,0,0);
3843 #ifdef x86_64_HOST_ARCH
3844 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3846 struct mach_header *header = (struct mach_header *) oc->image;
3847 struct load_command *lc = (struct load_command *) (header + 1);
3850 for( i = 0; i < header->ncmds; i++ )
3852 if( lc->cmd == LC_SYMTAB )
3854 // Just allocate one entry for every symbol
3855 struct symtab_command *symLC = (struct symtab_command *) lc;
3857 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3860 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3862 return ocAllocateSymbolExtras(oc,0,0);
3866 static int ocVerifyImage_MachO(ObjectCode* oc)
3868 char *image = (char*) oc->image;
3869 struct mach_header *header = (struct mach_header*) image;
3871 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3872 if(header->magic != MH_MAGIC_64)
3875 if(header->magic != MH_MAGIC)
3878 // FIXME: do some more verifying here
3882 static int resolveImports(
3885 struct symtab_command *symLC,
3886 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3887 unsigned long *indirectSyms,
3888 struct nlist *nlist)
3891 size_t itemSize = 4;
3894 int isJumpTable = 0;
3895 if(!strcmp(sect->sectname,"__jump_table"))
3899 ASSERT(sect->reserved2 == itemSize);
3903 for(i=0; i*itemSize < sect->size;i++)
3905 // according to otool, reserved1 contains the first index into the indirect symbol table
3906 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3907 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3910 if((symbol->n_type & N_TYPE) == N_UNDF
3911 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3912 addr = (void*) (symbol->n_value);
3913 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3916 addr = lookupSymbol(nm);
3919 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3927 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3928 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3929 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3930 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3935 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3936 ((void**)(image + sect->offset))[i] = addr;
3943 static unsigned long relocateAddress(
3946 struct section* sections,
3947 unsigned long address)
3950 for(i = 0; i < nSections; i++)
3952 if(sections[i].addr <= address
3953 && address < sections[i].addr + sections[i].size)
3955 return (unsigned long)oc->image
3956 + sections[i].offset + address - sections[i].addr;
3959 barf("Invalid Mach-O file:"
3960 "Address out of bounds while relocating object file");
3964 static int relocateSection(
3967 struct symtab_command *symLC, struct nlist *nlist,
3968 int nSections, struct section* sections, struct section *sect)
3970 struct relocation_info *relocs;
3973 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3975 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3977 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3979 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3983 relocs = (struct relocation_info*) (image + sect->reloff);
3987 #ifdef x86_64_HOST_ARCH
3988 struct relocation_info *reloc = &relocs[i];
3990 char *thingPtr = image + sect->offset + reloc->r_address;
3994 int type = reloc->r_type;
3996 checkProddableBlock(oc,thingPtr);
3997 switch(reloc->r_length)
4000 thing = *(uint8_t*)thingPtr;
4001 baseValue = (uint64_t)thingPtr + 1;
4004 thing = *(uint16_t*)thingPtr;
4005 baseValue = (uint64_t)thingPtr + 2;
4008 thing = *(uint32_t*)thingPtr;
4009 baseValue = (uint64_t)thingPtr + 4;
4012 thing = *(uint64_t*)thingPtr;
4013 baseValue = (uint64_t)thingPtr + 8;
4016 barf("Unknown size.");
4019 if(type == X86_64_RELOC_GOT
4020 || type == X86_64_RELOC_GOT_LOAD)
4022 ASSERT(reloc->r_extern);
4023 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
4025 type = X86_64_RELOC_SIGNED;
4027 else if(reloc->r_extern)
4029 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4030 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4031 if(symbol->n_value == 0)
4032 value = (uint64_t) lookupSymbol(nm);
4034 value = relocateAddress(oc, nSections, sections,
4039 value = sections[reloc->r_symbolnum-1].offset
4040 - sections[reloc->r_symbolnum-1].addr
4044 if(type == X86_64_RELOC_BRANCH)
4046 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4048 ASSERT(reloc->r_extern);
4049 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4052 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4053 type = X86_64_RELOC_SIGNED;
4058 case X86_64_RELOC_UNSIGNED:
4059 ASSERT(!reloc->r_pcrel);
4062 case X86_64_RELOC_SIGNED:
4063 ASSERT(reloc->r_pcrel);
4064 thing += value - baseValue;
4066 case X86_64_RELOC_SUBTRACTOR:
4067 ASSERT(!reloc->r_pcrel);
4071 barf("unkown relocation");
4074 switch(reloc->r_length)
4077 *(uint8_t*)thingPtr = thing;
4080 *(uint16_t*)thingPtr = thing;
4083 *(uint32_t*)thingPtr = thing;
4086 *(uint64_t*)thingPtr = thing;
4090 if(relocs[i].r_address & R_SCATTERED)
4092 struct scattered_relocation_info *scat =
4093 (struct scattered_relocation_info*) &relocs[i];
4097 if(scat->r_length == 2)
4099 unsigned long word = 0;
4100 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4101 checkProddableBlock(oc,wordPtr);
4103 // Note on relocation types:
4104 // i386 uses the GENERIC_RELOC_* types,
4105 // while ppc uses special PPC_RELOC_* types.
4106 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4107 // in both cases, all others are different.
4108 // Therefore, we use GENERIC_RELOC_VANILLA
4109 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4110 // and use #ifdefs for the other types.
4112 // Step 1: Figure out what the relocated value should be
4113 if(scat->r_type == GENERIC_RELOC_VANILLA)
4115 word = *wordPtr + (unsigned long) relocateAddress(
4122 #ifdef powerpc_HOST_ARCH
4123 else if(scat->r_type == PPC_RELOC_SECTDIFF
4124 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4125 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4126 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4128 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4131 struct scattered_relocation_info *pair =
4132 (struct scattered_relocation_info*) &relocs[i+1];
4134 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4135 barf("Invalid Mach-O file: "
4136 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4138 word = (unsigned long)
4139 (relocateAddress(oc, nSections, sections, scat->r_value)
4140 - relocateAddress(oc, nSections, sections, pair->r_value));
4143 #ifdef powerpc_HOST_ARCH
4144 else if(scat->r_type == PPC_RELOC_HI16
4145 || scat->r_type == PPC_RELOC_LO16
4146 || scat->r_type == PPC_RELOC_HA16
4147 || scat->r_type == PPC_RELOC_LO14)
4148 { // these are generated by label+offset things
4149 struct relocation_info *pair = &relocs[i+1];
4150 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4151 barf("Invalid Mach-O file: "
4152 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4154 if(scat->r_type == PPC_RELOC_LO16)
4156 word = ((unsigned short*) wordPtr)[1];
4157 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4159 else if(scat->r_type == PPC_RELOC_LO14)
4161 barf("Unsupported Relocation: PPC_RELOC_LO14");
4162 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4163 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4165 else if(scat->r_type == PPC_RELOC_HI16)
4167 word = ((unsigned short*) wordPtr)[1] << 16;
4168 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4170 else if(scat->r_type == PPC_RELOC_HA16)
4172 word = ((unsigned short*) wordPtr)[1] << 16;
4173 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4177 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4184 continue; // ignore the others
4186 #ifdef powerpc_HOST_ARCH
4187 if(scat->r_type == GENERIC_RELOC_VANILLA
4188 || scat->r_type == PPC_RELOC_SECTDIFF)
4190 if(scat->r_type == GENERIC_RELOC_VANILLA
4191 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4196 #ifdef powerpc_HOST_ARCH
4197 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4199 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4201 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4203 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4205 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4207 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4208 + ((word & (1<<15)) ? 1 : 0);
4214 continue; // FIXME: I hope it's OK to ignore all the others.
4218 struct relocation_info *reloc = &relocs[i];
4219 if(reloc->r_pcrel && !reloc->r_extern)
4222 if(reloc->r_length == 2)
4224 unsigned long word = 0;
4225 #ifdef powerpc_HOST_ARCH
4226 unsigned long jumpIsland = 0;
4227 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4228 // to avoid warning and to catch
4232 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4233 checkProddableBlock(oc,wordPtr);
4235 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4239 #ifdef powerpc_HOST_ARCH
4240 else if(reloc->r_type == PPC_RELOC_LO16)
4242 word = ((unsigned short*) wordPtr)[1];
4243 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4245 else if(reloc->r_type == PPC_RELOC_HI16)
4247 word = ((unsigned short*) wordPtr)[1] << 16;
4248 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4250 else if(reloc->r_type == PPC_RELOC_HA16)
4252 word = ((unsigned short*) wordPtr)[1] << 16;
4253 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4255 else if(reloc->r_type == PPC_RELOC_BR24)
4258 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4262 if(!reloc->r_extern)
4265 sections[reloc->r_symbolnum-1].offset
4266 - sections[reloc->r_symbolnum-1].addr
4273 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4274 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4275 void *symbolAddress = lookupSymbol(nm);
4278 errorBelch("\nunknown symbol `%s'", nm);
4284 #ifdef powerpc_HOST_ARCH
4285 // In the .o file, this should be a relative jump to NULL
4286 // and we'll change it to a relative jump to the symbol
4287 ASSERT(word + reloc->r_address == 0);
4288 jumpIsland = (unsigned long)
4289 &makeSymbolExtra(oc,
4291 (unsigned long) symbolAddress)
4295 offsetToJumpIsland = word + jumpIsland
4296 - (((long)image) + sect->offset - sect->addr);
4299 word += (unsigned long) symbolAddress
4300 - (((long)image) + sect->offset - sect->addr);
4304 word += (unsigned long) symbolAddress;
4308 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4313 #ifdef powerpc_HOST_ARCH
4314 else if(reloc->r_type == PPC_RELOC_LO16)
4316 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4319 else if(reloc->r_type == PPC_RELOC_HI16)
4321 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4324 else if(reloc->r_type == PPC_RELOC_HA16)
4326 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4327 + ((word & (1<<15)) ? 1 : 0);
4330 else if(reloc->r_type == PPC_RELOC_BR24)
4332 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4334 // The branch offset is too large.
4335 // Therefore, we try to use a jump island.
4338 barf("unconditional relative branch out of range: "
4339 "no jump island available");
4342 word = offsetToJumpIsland;
4343 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4344 barf("unconditional relative branch out of range: "
4345 "jump island out of range");
4347 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4352 barf("\nunknown relocation %d",reloc->r_type);
4360 static int ocGetNames_MachO(ObjectCode* oc)
4362 char *image = (char*) oc->image;
4363 struct mach_header *header = (struct mach_header*) image;
4364 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4365 unsigned i,curSymbol = 0;
4366 struct segment_command *segLC = NULL;
4367 struct section *sections;
4368 struct symtab_command *symLC = NULL;
4369 struct nlist *nlist;
4370 unsigned long commonSize = 0;
4371 char *commonStorage = NULL;
4372 unsigned long commonCounter;
4374 for(i=0;i<header->ncmds;i++)
4376 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4377 segLC = (struct segment_command*) lc;
4378 else if(lc->cmd == LC_SYMTAB)
4379 symLC = (struct symtab_command*) lc;
4380 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4383 sections = (struct section*) (segLC+1);
4384 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4388 barf("ocGetNames_MachO: no segment load command");
4390 for(i=0;i<segLC->nsects;i++)
4392 if(sections[i].size == 0)
4395 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4397 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4398 "ocGetNames_MachO(common symbols)");
4399 sections[i].offset = zeroFillArea - image;
4402 if(!strcmp(sections[i].sectname,"__text"))
4403 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4404 (void*) (image + sections[i].offset),
4405 (void*) (image + sections[i].offset + sections[i].size));
4406 else if(!strcmp(sections[i].sectname,"__const"))
4407 addSection(oc, SECTIONKIND_RWDATA,
4408 (void*) (image + sections[i].offset),
4409 (void*) (image + sections[i].offset + sections[i].size));
4410 else if(!strcmp(sections[i].sectname,"__data"))
4411 addSection(oc, SECTIONKIND_RWDATA,
4412 (void*) (image + sections[i].offset),
4413 (void*) (image + sections[i].offset + sections[i].size));
4414 else if(!strcmp(sections[i].sectname,"__bss")
4415 || !strcmp(sections[i].sectname,"__common"))
4416 addSection(oc, SECTIONKIND_RWDATA,
4417 (void*) (image + sections[i].offset),
4418 (void*) (image + sections[i].offset + sections[i].size));
4420 addProddableBlock(oc, (void*) (image + sections[i].offset),
4424 // count external symbols defined here
4428 for(i=0;i<symLC->nsyms;i++)
4430 if(nlist[i].n_type & N_STAB)
4432 else if(nlist[i].n_type & N_EXT)
4434 if((nlist[i].n_type & N_TYPE) == N_UNDF
4435 && (nlist[i].n_value != 0))
4437 commonSize += nlist[i].n_value;
4440 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4445 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4446 "ocGetNames_MachO(oc->symbols)");
4450 for(i=0;i<symLC->nsyms;i++)
4452 if(nlist[i].n_type & N_STAB)
4454 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4456 if(nlist[i].n_type & N_EXT)
4458 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4459 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4460 ; // weak definition, and we already have a definition
4463 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4465 + sections[nlist[i].n_sect-1].offset
4466 - sections[nlist[i].n_sect-1].addr
4467 + nlist[i].n_value);
4468 oc->symbols[curSymbol++] = nm;
4475 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4476 commonCounter = (unsigned long)commonStorage;
4479 for(i=0;i<symLC->nsyms;i++)
4481 if((nlist[i].n_type & N_TYPE) == N_UNDF
4482 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4484 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4485 unsigned long sz = nlist[i].n_value;
4487 nlist[i].n_value = commonCounter;
4489 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4490 (void*)commonCounter);
4491 oc->symbols[curSymbol++] = nm;
4493 commonCounter += sz;
4500 static int ocResolve_MachO(ObjectCode* oc)
4502 char *image = (char*) oc->image;
4503 struct mach_header *header = (struct mach_header*) image;
4504 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4506 struct segment_command *segLC = NULL;
4507 struct section *sections;
4508 struct symtab_command *symLC = NULL;
4509 struct dysymtab_command *dsymLC = NULL;
4510 struct nlist *nlist;
4512 for(i=0;i<header->ncmds;i++)
4514 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4515 segLC = (struct segment_command*) lc;
4516 else if(lc->cmd == LC_SYMTAB)
4517 symLC = (struct symtab_command*) lc;
4518 else if(lc->cmd == LC_DYSYMTAB)
4519 dsymLC = (struct dysymtab_command*) lc;
4520 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4523 sections = (struct section*) (segLC+1);
4524 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4529 unsigned long *indirectSyms
4530 = (unsigned long*) (image + dsymLC->indirectsymoff);
4532 for(i=0;i<segLC->nsects;i++)
4534 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4535 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4536 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4538 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4541 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4542 || !strcmp(sections[i].sectname,"__pointers"))
4544 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4547 else if(!strcmp(sections[i].sectname,"__jump_table"))
4549 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4555 for(i=0;i<segLC->nsects;i++)
4557 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4561 /* Free the local symbol table; we won't need it again. */
4562 freeHashTable(oc->lochash, NULL);
4565 #if defined (powerpc_HOST_ARCH)
4566 ocFlushInstructionCache( oc );
4572 #ifdef powerpc_HOST_ARCH
4574 * The Mach-O object format uses leading underscores. But not everywhere.
4575 * There is a small number of runtime support functions defined in
4576 * libcc_dynamic.a whose name does not have a leading underscore.
4577 * As a consequence, we can't get their address from C code.
4578 * We have to use inline assembler just to take the address of a function.
4582 static void machoInitSymbolsWithoutUnderscore()
4584 extern void* symbolsWithoutUnderscore[];
4585 void **p = symbolsWithoutUnderscore;
4586 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4590 __asm__ volatile(".long " # x);
4592 RTS_MACHO_NOUNDERLINE_SYMBOLS
4594 __asm__ volatile(".text");
4598 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4600 RTS_MACHO_NOUNDERLINE_SYMBOLS
4607 * Figure out by how much to shift the entire Mach-O file in memory
4608 * when loading so that its single segment ends up 16-byte-aligned
4610 static int machoGetMisalignment( FILE * f )
4612 struct mach_header header;
4615 fread(&header, sizeof(header), 1, f);
4618 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4619 if(header.magic != MH_MAGIC_64)
4622 if(header.magic != MH_MAGIC)
4626 misalignment = (header.sizeofcmds + sizeof(header))
4629 return misalignment ? (16 - misalignment) : 0;