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(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
67 #if defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_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 \
179 SymX(signal_handlers) \
180 SymX(stg_sig_install) \
184 #if defined (cygwin32_HOST_OS)
185 #define RTS_MINGW_ONLY_SYMBOLS /**/
186 /* Don't have the ability to read import libs / archives, so
187 * we have to stupidly list a lot of what libcygwin.a
190 #define RTS_CYGWIN_ONLY_SYMBOLS \
268 #elif !defined(mingw32_HOST_OS)
269 #define RTS_MINGW_ONLY_SYMBOLS /**/
270 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
271 #else /* defined(mingw32_HOST_OS) */
272 #define RTS_POSIX_ONLY_SYMBOLS /**/
273 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
275 /* Extra syms gen'ed by mingw-2's gcc-3.2: */
277 #define RTS_MINGW_EXTRA_SYMS \
278 Sym(_imp____mb_cur_max) \
281 #define RTS_MINGW_EXTRA_SYMS
284 #if HAVE_GETTIMEOFDAY
285 #define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
287 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
290 /* These are statically linked from the mingw libraries into the ghc
291 executable, so we have to employ this hack. */
292 #define RTS_MINGW_ONLY_SYMBOLS \
293 SymX(asyncReadzh_fast) \
294 SymX(asyncWritezh_fast) \
295 SymX(asyncDoProczh_fast) \
307 SymX(getservbyname) \
308 SymX(getservbyport) \
309 SymX(getprotobynumber) \
310 SymX(getprotobyname) \
311 SymX(gethostbyname) \
312 SymX(gethostbyaddr) \
359 SymX(rts_InstallConsoleEvent) \
360 SymX(rts_ConsoleHandlerDone) \
362 Sym(_imp___timezone) \
372 RTS_MINGW_EXTRA_SYMS \
373 RTS_MINGW_GETTIMEOFDAY_SYM \
377 #if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
378 #define RTS_DARWIN_ONLY_SYMBOLS \
379 Sym(asprintf$LDBLStub) \
383 Sym(fprintf$LDBLStub) \
384 Sym(fscanf$LDBLStub) \
385 Sym(fwprintf$LDBLStub) \
386 Sym(fwscanf$LDBLStub) \
387 Sym(printf$LDBLStub) \
388 Sym(scanf$LDBLStub) \
389 Sym(snprintf$LDBLStub) \
390 Sym(sprintf$LDBLStub) \
391 Sym(sscanf$LDBLStub) \
392 Sym(strtold$LDBLStub) \
393 Sym(swprintf$LDBLStub) \
394 Sym(swscanf$LDBLStub) \
395 Sym(syslog$LDBLStub) \
396 Sym(vasprintf$LDBLStub) \
398 Sym(verrc$LDBLStub) \
399 Sym(verrx$LDBLStub) \
400 Sym(vfprintf$LDBLStub) \
401 Sym(vfscanf$LDBLStub) \
402 Sym(vfwprintf$LDBLStub) \
403 Sym(vfwscanf$LDBLStub) \
404 Sym(vprintf$LDBLStub) \
405 Sym(vscanf$LDBLStub) \
406 Sym(vsnprintf$LDBLStub) \
407 Sym(vsprintf$LDBLStub) \
408 Sym(vsscanf$LDBLStub) \
409 Sym(vswprintf$LDBLStub) \
410 Sym(vswscanf$LDBLStub) \
411 Sym(vsyslog$LDBLStub) \
412 Sym(vwarn$LDBLStub) \
413 Sym(vwarnc$LDBLStub) \
414 Sym(vwarnx$LDBLStub) \
415 Sym(vwprintf$LDBLStub) \
416 Sym(vwscanf$LDBLStub) \
418 Sym(warnc$LDBLStub) \
419 Sym(warnx$LDBLStub) \
420 Sym(wcstold$LDBLStub) \
421 Sym(wprintf$LDBLStub) \
424 #define RTS_DARWIN_ONLY_SYMBOLS
428 # define MAIN_CAP_SYM SymX(MainCapability)
430 # define MAIN_CAP_SYM
433 #if !defined(mingw32_HOST_OS)
434 #define RTS_USER_SIGNALS_SYMBOLS \
435 SymX(setIOManagerPipe)
437 #define RTS_USER_SIGNALS_SYMBOLS \
438 SymX(sendIOManagerEvent) \
439 SymX(readIOManagerEvent) \
440 SymX(getIOManagerEvent) \
441 SymX(console_handler)
444 #ifdef TABLES_NEXT_TO_CODE
445 #define RTS_RET_SYMBOLS /* nothing */
447 #define RTS_RET_SYMBOLS \
448 SymX(stg_enter_ret) \
449 SymX(stg_gc_fun_ret) \
456 SymX(stg_ap_pv_ret) \
457 SymX(stg_ap_pp_ret) \
458 SymX(stg_ap_ppv_ret) \
459 SymX(stg_ap_ppp_ret) \
460 SymX(stg_ap_pppv_ret) \
461 SymX(stg_ap_pppp_ret) \
462 SymX(stg_ap_ppppp_ret) \
463 SymX(stg_ap_pppppp_ret)
466 /* On Windows, we link libgmp.a statically into libHSrts.dll */
467 #ifdef mingw32_HOST_OS
470 SymX(__gmpz_cmp_si) \
471 SymX(__gmpz_cmp_ui) \
472 SymX(__gmpz_get_si) \
476 SymExtern(__gmpz_cmp) \
477 SymExtern(__gmpz_cmp_si) \
478 SymExtern(__gmpz_cmp_ui) \
479 SymExtern(__gmpz_get_si) \
480 SymExtern(__gmpz_get_ui)
483 #define RTS_SYMBOLS \
486 SymX(stg_enter_info) \
487 SymX(stg_gc_void_info) \
488 SymX(__stg_gc_enter_1) \
489 SymX(stg_gc_noregs) \
490 SymX(stg_gc_unpt_r1_info) \
491 SymX(stg_gc_unpt_r1) \
492 SymX(stg_gc_unbx_r1_info) \
493 SymX(stg_gc_unbx_r1) \
494 SymX(stg_gc_f1_info) \
496 SymX(stg_gc_d1_info) \
498 SymX(stg_gc_l1_info) \
501 SymX(stg_gc_fun_info) \
503 SymX(stg_gc_gen_info) \
504 SymX(stg_gc_gen_hp) \
506 SymX(stg_gen_yield) \
507 SymX(stg_yield_noregs) \
508 SymX(stg_yield_to_interpreter) \
509 SymX(stg_gen_block) \
510 SymX(stg_block_noregs) \
512 SymX(stg_block_takemvar) \
513 SymX(stg_block_putmvar) \
515 SymX(MallocFailHook) \
517 SymX(OutOfHeapHook) \
518 SymX(StackOverflowHook) \
519 SymX(__encodeDouble) \
520 SymX(__encodeFloat) \
523 SymX(__int_encodeDouble) \
524 SymX(__int_encodeFloat) \
525 SymX(andIntegerzh_fast) \
526 SymX(atomicallyzh_fast) \
530 SymX(blockAsyncExceptionszh_fast) \
532 SymX(catchRetryzh_fast) \
533 SymX(catchSTMzh_fast) \
535 SymX(closure_flags) \
537 SymX(cmpIntegerzh_fast) \
538 SymX(cmpIntegerIntzh_fast) \
539 SymX(complementIntegerzh_fast) \
540 SymX(createAdjustor) \
541 SymX(decodeDoublezh_fast) \
542 SymX(decodeFloatzh_fast) \
545 SymX(deRefWeakzh_fast) \
546 SymX(deRefStablePtrzh_fast) \
547 SymX(dirty_MUT_VAR) \
548 SymX(divExactIntegerzh_fast) \
549 SymX(divModIntegerzh_fast) \
551 SymX(forkOnzh_fast) \
553 SymX(forkOS_createThread) \
554 SymX(freeHaskellFunctionPtr) \
555 SymX(freeStablePtr) \
556 SymX(getOrSetTypeableStore) \
557 SymX(gcdIntegerzh_fast) \
558 SymX(gcdIntegerIntzh_fast) \
559 SymX(gcdIntzh_fast) \
563 SymX(getFullProgArgv) \
569 SymX(hs_perform_gc) \
570 SymX(hs_free_stable_ptr) \
571 SymX(hs_free_fun_ptr) \
572 SymX(hs_hpc_rootModule) \
574 SymX(unpackClosurezh_fast) \
575 SymX(getApStackValzh_fast) \
576 SymX(int2Integerzh_fast) \
577 SymX(integer2Intzh_fast) \
578 SymX(integer2Wordzh_fast) \
579 SymX(isCurrentThreadBoundzh_fast) \
580 SymX(isDoubleDenormalized) \
581 SymX(isDoubleInfinite) \
583 SymX(isDoubleNegativeZero) \
584 SymX(isEmptyMVarzh_fast) \
585 SymX(isFloatDenormalized) \
586 SymX(isFloatInfinite) \
588 SymX(isFloatNegativeZero) \
589 SymX(killThreadzh_fast) \
591 SymX(insertStableSymbol) \
594 SymX(makeStablePtrzh_fast) \
595 SymX(minusIntegerzh_fast) \
596 SymX(mkApUpd0zh_fast) \
597 SymX(myThreadIdzh_fast) \
598 SymX(labelThreadzh_fast) \
599 SymX(newArrayzh_fast) \
600 SymX(newBCOzh_fast) \
601 SymX(newByteArrayzh_fast) \
602 SymX_redirect(newCAF, newDynCAF) \
603 SymX(newMVarzh_fast) \
604 SymX(newMutVarzh_fast) \
605 SymX(newTVarzh_fast) \
606 SymX(noDuplicatezh_fast) \
607 SymX(atomicModifyMutVarzh_fast) \
608 SymX(newPinnedByteArrayzh_fast) \
610 SymX(orIntegerzh_fast) \
612 SymX(performMajorGC) \
613 SymX(plusIntegerzh_fast) \
616 SymX(putMVarzh_fast) \
617 SymX(quotIntegerzh_fast) \
618 SymX(quotRemIntegerzh_fast) \
620 SymX(raiseIOzh_fast) \
621 SymX(readTVarzh_fast) \
622 SymX(remIntegerzh_fast) \
623 SymX(resetNonBlockingFd) \
628 SymX(rts_checkSchedStatus) \
631 SymX(rts_evalLazyIO) \
632 SymX(rts_evalStableIO) \
636 SymX(rts_getDouble) \
644 SymX(rts_getFunPtr) \
645 SymX(rts_getStablePtr) \
646 SymX(rts_getThreadId) \
649 SymX(rts_getWord16) \
650 SymX(rts_getWord32) \
651 SymX(rts_getWord64) \
664 SymX(rts_mkStablePtr) \
672 SymX(rtsSupportsBoundThreads) \
673 SymX(__hscore_get_saved_termios) \
674 SymX(__hscore_set_saved_termios) \
676 SymX(startupHaskell) \
677 SymX(shutdownHaskell) \
678 SymX(shutdownHaskellAndExit) \
679 SymX(stable_ptr_table) \
680 SymX(stackOverflow) \
681 SymX(stg_CAF_BLACKHOLE_info) \
682 SymX(awakenBlockedQueue) \
683 SymX(stg_CHARLIKE_closure) \
684 SymX(stg_MVAR_CLEAN_info) \
685 SymX(stg_MVAR_DIRTY_info) \
686 SymX(stg_IND_STATIC_info) \
687 SymX(stg_INTLIKE_closure) \
688 SymX(stg_MUT_ARR_PTRS_DIRTY_info) \
689 SymX(stg_MUT_ARR_PTRS_FROZEN_info) \
690 SymX(stg_MUT_ARR_PTRS_FROZEN0_info) \
691 SymX(stg_WEAK_info) \
692 SymX(stg_ap_v_info) \
693 SymX(stg_ap_f_info) \
694 SymX(stg_ap_d_info) \
695 SymX(stg_ap_l_info) \
696 SymX(stg_ap_n_info) \
697 SymX(stg_ap_p_info) \
698 SymX(stg_ap_pv_info) \
699 SymX(stg_ap_pp_info) \
700 SymX(stg_ap_ppv_info) \
701 SymX(stg_ap_ppp_info) \
702 SymX(stg_ap_pppv_info) \
703 SymX(stg_ap_pppp_info) \
704 SymX(stg_ap_ppppp_info) \
705 SymX(stg_ap_pppppp_info) \
706 SymX(stg_ap_0_fast) \
707 SymX(stg_ap_v_fast) \
708 SymX(stg_ap_f_fast) \
709 SymX(stg_ap_d_fast) \
710 SymX(stg_ap_l_fast) \
711 SymX(stg_ap_n_fast) \
712 SymX(stg_ap_p_fast) \
713 SymX(stg_ap_pv_fast) \
714 SymX(stg_ap_pp_fast) \
715 SymX(stg_ap_ppv_fast) \
716 SymX(stg_ap_ppp_fast) \
717 SymX(stg_ap_pppv_fast) \
718 SymX(stg_ap_pppp_fast) \
719 SymX(stg_ap_ppppp_fast) \
720 SymX(stg_ap_pppppp_fast) \
721 SymX(stg_ap_1_upd_info) \
722 SymX(stg_ap_2_upd_info) \
723 SymX(stg_ap_3_upd_info) \
724 SymX(stg_ap_4_upd_info) \
725 SymX(stg_ap_5_upd_info) \
726 SymX(stg_ap_6_upd_info) \
727 SymX(stg_ap_7_upd_info) \
729 SymX(stg_sel_0_upd_info) \
730 SymX(stg_sel_10_upd_info) \
731 SymX(stg_sel_11_upd_info) \
732 SymX(stg_sel_12_upd_info) \
733 SymX(stg_sel_13_upd_info) \
734 SymX(stg_sel_14_upd_info) \
735 SymX(stg_sel_15_upd_info) \
736 SymX(stg_sel_1_upd_info) \
737 SymX(stg_sel_2_upd_info) \
738 SymX(stg_sel_3_upd_info) \
739 SymX(stg_sel_4_upd_info) \
740 SymX(stg_sel_5_upd_info) \
741 SymX(stg_sel_6_upd_info) \
742 SymX(stg_sel_7_upd_info) \
743 SymX(stg_sel_8_upd_info) \
744 SymX(stg_sel_9_upd_info) \
745 SymX(stg_upd_frame_info) \
746 SymX(suspendThread) \
747 SymX(takeMVarzh_fast) \
748 SymX(timesIntegerzh_fast) \
749 SymX(tryPutMVarzh_fast) \
750 SymX(tryTakeMVarzh_fast) \
751 SymX(unblockAsyncExceptionszh_fast) \
753 SymX(unsafeThawArrayzh_fast) \
754 SymX(waitReadzh_fast) \
755 SymX(waitWritezh_fast) \
756 SymX(word2Integerzh_fast) \
757 SymX(writeTVarzh_fast) \
758 SymX(xorIntegerzh_fast) \
760 SymX(stg_interp_constr_entry) \
763 SymX(getAllocations) \
766 SymX(rts_breakpoint_io_action) \
767 SymX(rts_stop_next_breakpoint) \
768 SymX(rts_stop_on_exception) \
770 SymX(n_capabilities) \
771 RTS_USER_SIGNALS_SYMBOLS
773 #ifdef SUPPORT_LONG_LONGS
774 #define RTS_LONG_LONG_SYMS \
775 SymX(int64ToIntegerzh_fast) \
776 SymX(word64ToIntegerzh_fast)
778 #define RTS_LONG_LONG_SYMS /* nothing */
781 // 64-bit support functions in libgcc.a
782 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
783 #define RTS_LIBGCC_SYMBOLS \
793 #elif defined(ia64_HOST_ARCH)
794 #define RTS_LIBGCC_SYMBOLS \
802 #define RTS_LIBGCC_SYMBOLS
805 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
806 // Symbols that don't have a leading underscore
807 // on Mac OS X. They have to receive special treatment,
808 // see machoInitSymbolsWithoutUnderscore()
809 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
814 /* entirely bogus claims about types of these symbols */
815 #define Sym(vvv) extern void vvv(void);
816 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
817 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
819 #define SymExtern(vvv) SymX(vvv)
821 #define SymX(vvv) /**/
822 #define SymX_redirect(vvv,xxx) /**/
826 RTS_POSIX_ONLY_SYMBOLS
827 RTS_MINGW_ONLY_SYMBOLS
828 RTS_CYGWIN_ONLY_SYMBOLS
829 RTS_DARWIN_ONLY_SYMBOLS
836 #ifdef LEADING_UNDERSCORE
837 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
839 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
842 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
844 #define SymX(vvv) Sym(vvv)
845 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
846 (void*)DLL_IMPORT_DATA_REF(vvv) },
848 // SymX_redirect allows us to redirect references to one symbol to
849 // another symbol. See newCAF/newDynCAF for an example.
850 #define SymX_redirect(vvv,xxx) \
851 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
854 static RtsSymbolVal rtsSyms[] = {
858 RTS_POSIX_ONLY_SYMBOLS
859 RTS_MINGW_ONLY_SYMBOLS
860 RTS_CYGWIN_ONLY_SYMBOLS
861 RTS_DARWIN_ONLY_SYMBOLS
863 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
864 // dyld stub code contains references to this,
865 // but it should never be called because we treat
866 // lazy pointers as nonlazy.
867 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
869 { 0, 0 } /* sentinel */
874 /* -----------------------------------------------------------------------------
875 * Insert symbols into hash tables, checking for duplicates.
878 static void ghciInsertStrHashTable ( char* obj_name,
884 if (lookupHashTable(table, (StgWord)key) == NULL)
886 insertStrHashTable(table, (StgWord)key, data);
891 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
893 "whilst processing object file\n"
895 "This could be caused by:\n"
896 " * Loading two different object files which export the same symbol\n"
897 " * Specifying the same object file twice on the GHCi command line\n"
898 " * An incorrect `package.conf' entry, causing some object to be\n"
900 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
907 /* -----------------------------------------------------------------------------
908 * initialize the object linker
912 static int linker_init_done = 0 ;
914 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
915 static void *dl_prog_handle;
923 /* Make initLinker idempotent, so we can call it
924 before evey relevant operation; that means we
925 don't need to initialise the linker separately */
926 if (linker_init_done == 1) { return; } else {
927 linker_init_done = 1;
930 stablehash = allocStrHashTable();
931 symhash = allocStrHashTable();
933 /* populate the symbol table with stuff from the RTS */
934 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
935 ghciInsertStrHashTable("(GHCi built-in symbols)",
936 symhash, sym->lbl, sym->addr);
938 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
939 machoInitSymbolsWithoutUnderscore();
942 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
943 # if defined(RTLD_DEFAULT)
944 dl_prog_handle = RTLD_DEFAULT;
946 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
947 # endif /* RTLD_DEFAULT */
951 /* -----------------------------------------------------------------------------
952 * Loading DLL or .so dynamic libraries
953 * -----------------------------------------------------------------------------
955 * Add a DLL from which symbols may be found. In the ELF case, just
956 * do RTLD_GLOBAL-style add, so no further messing around needs to
957 * happen in order that symbols in the loaded .so are findable --
958 * lookupSymbol() will subsequently see them by dlsym on the program's
959 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
961 * In the PEi386 case, open the DLLs and put handles to them in a
962 * linked list. When looking for a symbol, try all handles in the
963 * list. This means that we need to load even DLLs that are guaranteed
964 * to be in the ghc.exe image already, just so we can get a handle
965 * to give to loadSymbol, so that we can find the symbols. For such
966 * libraries, the LoadLibrary call should be a no-op except for returning
971 #if defined(OBJFORMAT_PEi386)
972 /* A record for storing handles into DLLs. */
977 struct _OpenedDLL* next;
982 /* A list thereof. */
983 static OpenedDLL* opened_dlls = NULL;
987 addDLL( char *dll_name )
989 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
990 /* ------------------- ELF DLL loader ------------------- */
996 hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
999 /* dlopen failed; return a ptr to the error msg. */
1001 if (errmsg == NULL) errmsg = "addDLL: unknown error";
1008 # elif defined(OBJFORMAT_PEi386)
1009 /* ------------------- Win32 DLL loader ------------------- */
1017 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1019 /* See if we've already got it, and ignore if so. */
1020 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1021 if (0 == strcmp(o_dll->name, dll_name))
1025 /* The file name has no suffix (yet) so that we can try
1026 both foo.dll and foo.drv
1028 The documentation for LoadLibrary says:
1029 If no file name extension is specified in the lpFileName
1030 parameter, the default library extension .dll is
1031 appended. However, the file name string can include a trailing
1032 point character (.) to indicate that the module name has no
1035 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1036 sprintf(buf, "%s.DLL", dll_name);
1037 instance = LoadLibrary(buf);
1038 if (instance == NULL) {
1039 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1040 instance = LoadLibrary(buf);
1041 if (instance == NULL) {
1044 /* LoadLibrary failed; return a ptr to the error msg. */
1045 return "addDLL: unknown error";
1050 /* Add this DLL to the list of DLLs in which to search for symbols. */
1051 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1052 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1053 strcpy(o_dll->name, dll_name);
1054 o_dll->instance = instance;
1055 o_dll->next = opened_dlls;
1056 opened_dlls = o_dll;
1060 barf("addDLL: not implemented on this platform");
1064 /* -----------------------------------------------------------------------------
1065 * insert a stable symbol in the hash table
1069 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1071 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1075 /* -----------------------------------------------------------------------------
1076 * insert a symbol in the hash table
1079 insertSymbol(char* obj_name, char* key, void* data)
1081 ghciInsertStrHashTable(obj_name, symhash, key, data);
1084 /* -----------------------------------------------------------------------------
1085 * lookup a symbol in the hash table
1088 lookupSymbol( char *lbl )
1092 ASSERT(symhash != NULL);
1093 val = lookupStrHashTable(symhash, lbl);
1096 # if defined(OBJFORMAT_ELF)
1097 return dlsym(dl_prog_handle, lbl);
1098 # elif defined(OBJFORMAT_MACHO)
1100 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1103 HACK: On OS X, global symbols are prefixed with an underscore.
1104 However, dlsym wants us to omit the leading underscore from the
1105 symbol name. For now, we simply strip it off here (and ONLY
1108 ASSERT(lbl[0] == '_');
1109 return dlsym(dl_prog_handle, lbl+1);
1111 if(NSIsSymbolNameDefined(lbl)) {
1112 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1113 return NSAddressOfSymbol(symbol);
1117 # endif /* HAVE_DLFCN_H */
1118 # elif defined(OBJFORMAT_PEi386)
1121 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1122 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1123 if (lbl[0] == '_') {
1124 /* HACK: if the name has an initial underscore, try stripping
1125 it off & look that up first. I've yet to verify whether there's
1126 a Rule that governs whether an initial '_' *should always* be
1127 stripped off when mapping from import lib name to the DLL name.
1129 sym = GetProcAddress(o_dll->instance, (lbl+1));
1131 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1135 sym = GetProcAddress(o_dll->instance, lbl);
1137 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1152 __attribute((unused))
1154 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1158 val = lookupStrHashTable(oc->lochash, lbl);
1168 /* -----------------------------------------------------------------------------
1169 * Debugging aid: look in GHCi's object symbol tables for symbols
1170 * within DELTA bytes of the specified address, and show their names.
1173 void ghci_enquire ( char* addr );
1175 void ghci_enquire ( char* addr )
1180 const int DELTA = 64;
1185 for (oc = objects; oc; oc = oc->next) {
1186 for (i = 0; i < oc->n_symbols; i++) {
1187 sym = oc->symbols[i];
1188 if (sym == NULL) continue;
1189 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1191 if (oc->lochash != NULL) {
1192 a = lookupStrHashTable(oc->lochash, sym);
1195 a = lookupStrHashTable(symhash, sym);
1198 // debugBelch("ghci_enquire: can't find %s\n", sym);
1200 else if (addr-DELTA <= a && a <= addr+DELTA) {
1201 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1208 #ifdef ia64_HOST_ARCH
1209 static unsigned int PLTSize(void);
1212 /* -----------------------------------------------------------------------------
1213 * Load an obj (populate the global symbol table, but don't resolve yet)
1215 * Returns: 1 if ok, 0 on error.
1218 loadObj( char *path )
1225 void *map_addr = NULL;
1231 /* debugBelch("loadObj %s\n", path ); */
1233 /* Check that we haven't already loaded this object.
1234 Ignore requests to load multiple times */
1238 for (o = objects; o; o = o->next) {
1239 if (0 == strcmp(o->fileName, path)) {
1241 break; /* don't need to search further */
1245 IF_DEBUG(linker, debugBelch(
1246 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1247 "same object file twice:\n"
1249 "GHCi will ignore this, but be warned.\n"
1251 return 1; /* success */
1255 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1257 # if defined(OBJFORMAT_ELF)
1258 oc->formatName = "ELF";
1259 # elif defined(OBJFORMAT_PEi386)
1260 oc->formatName = "PEi386";
1261 # elif defined(OBJFORMAT_MACHO)
1262 oc->formatName = "Mach-O";
1265 barf("loadObj: not implemented on this platform");
1268 r = stat(path, &st);
1269 if (r == -1) { return 0; }
1271 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1272 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1273 strcpy(oc->fileName, path);
1275 oc->fileSize = st.st_size;
1277 oc->sections = NULL;
1278 oc->lochash = allocStrHashTable();
1279 oc->proddables = NULL;
1281 /* chain it onto the list of objects */
1286 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1288 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1290 #if defined(openbsd_HOST_OS)
1291 fd = open(path, O_RDONLY, S_IRUSR);
1293 fd = open(path, O_RDONLY);
1296 barf("loadObj: can't open `%s'", path);
1298 pagesize = getpagesize();
1300 #ifdef ia64_HOST_ARCH
1301 /* The PLT needs to be right before the object */
1302 n = ROUND_UP(PLTSize(), pagesize);
1303 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1304 if (oc->plt == MAP_FAILED)
1305 barf("loadObj: can't allocate PLT");
1308 map_addr = oc->plt + n;
1311 n = ROUND_UP(oc->fileSize, pagesize);
1313 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1314 * small memory model on this architecture (see gcc docs,
1317 * MAP_32BIT not available on OpenBSD/amd64
1319 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
1320 #define EXTRA_MAP_FLAGS MAP_32BIT
1322 #define EXTRA_MAP_FLAGS 0
1325 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
1326 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
1327 #define MAP_ANONYMOUS MAP_ANON
1330 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1331 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1332 if (oc->image == MAP_FAILED)
1333 barf("loadObj: can't map `%s'", path);
1337 #else /* !USE_MMAP */
1339 /* load the image into memory */
1340 f = fopen(path, "rb");
1342 barf("loadObj: can't read `%s'", path);
1344 # if defined(mingw32_HOST_OS)
1345 // TODO: We would like to use allocateExec here, but allocateExec
1346 // cannot currently allocate blocks large enough.
1347 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1348 PAGE_EXECUTE_READWRITE);
1349 # elif defined(darwin_HOST_OS)
1350 // In a Mach-O .o file, all sections can and will be misaligned
1351 // if the total size of the headers is not a multiple of the
1352 // desired alignment. This is fine for .o files that only serve
1353 // as input for the static linker, but it's not fine for us,
1354 // as SSE (used by gcc for floating point) and Altivec require
1355 // 16-byte alignment.
1356 // We calculate the correct alignment from the header before
1357 // reading the file, and then we misalign oc->image on purpose so
1358 // that the actual sections end up aligned again.
1359 oc->misalignment = machoGetMisalignment(f);
1360 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1361 oc->image += oc->misalignment;
1363 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1366 n = fread ( oc->image, 1, oc->fileSize, f );
1367 if (n != oc->fileSize)
1368 barf("loadObj: error whilst reading `%s'", path);
1371 #endif /* USE_MMAP */
1373 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1374 r = ocAllocateSymbolExtras_MachO ( oc );
1375 if (!r) { return r; }
1376 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1377 r = ocAllocateSymbolExtras_ELF ( oc );
1378 if (!r) { return r; }
1381 /* verify the in-memory image */
1382 # if defined(OBJFORMAT_ELF)
1383 r = ocVerifyImage_ELF ( oc );
1384 # elif defined(OBJFORMAT_PEi386)
1385 r = ocVerifyImage_PEi386 ( oc );
1386 # elif defined(OBJFORMAT_MACHO)
1387 r = ocVerifyImage_MachO ( oc );
1389 barf("loadObj: no verify method");
1391 if (!r) { return r; }
1393 /* build the symbol list for this image */
1394 # if defined(OBJFORMAT_ELF)
1395 r = ocGetNames_ELF ( oc );
1396 # elif defined(OBJFORMAT_PEi386)
1397 r = ocGetNames_PEi386 ( oc );
1398 # elif defined(OBJFORMAT_MACHO)
1399 r = ocGetNames_MachO ( oc );
1401 barf("loadObj: no getNames method");
1403 if (!r) { return r; }
1405 /* loaded, but not resolved yet */
1406 oc->status = OBJECT_LOADED;
1411 /* -----------------------------------------------------------------------------
1412 * resolve all the currently unlinked objects in memory
1414 * Returns: 1 if ok, 0 on error.
1424 for (oc = objects; oc; oc = oc->next) {
1425 if (oc->status != OBJECT_RESOLVED) {
1426 # if defined(OBJFORMAT_ELF)
1427 r = ocResolve_ELF ( oc );
1428 # elif defined(OBJFORMAT_PEi386)
1429 r = ocResolve_PEi386 ( oc );
1430 # elif defined(OBJFORMAT_MACHO)
1431 r = ocResolve_MachO ( oc );
1433 barf("resolveObjs: not implemented on this platform");
1435 if (!r) { return r; }
1436 oc->status = OBJECT_RESOLVED;
1442 /* -----------------------------------------------------------------------------
1443 * delete an object from the pool
1446 unloadObj( char *path )
1448 ObjectCode *oc, *prev;
1450 ASSERT(symhash != NULL);
1451 ASSERT(objects != NULL);
1456 for (oc = objects; oc; prev = oc, oc = oc->next) {
1457 if (!strcmp(oc->fileName,path)) {
1459 /* Remove all the mappings for the symbols within this
1464 for (i = 0; i < oc->n_symbols; i++) {
1465 if (oc->symbols[i] != NULL) {
1466 removeStrHashTable(symhash, oc->symbols[i], NULL);
1474 prev->next = oc->next;
1477 // We're going to leave this in place, in case there are
1478 // any pointers from the heap into it:
1479 // #ifdef mingw32_HOST_OS
1480 // VirtualFree(oc->image);
1482 // stgFree(oc->image);
1484 stgFree(oc->fileName);
1485 stgFree(oc->symbols);
1486 stgFree(oc->sections);
1487 /* The local hash table should have been freed at the end
1488 of the ocResolve_ call on it. */
1489 ASSERT(oc->lochash == NULL);
1495 errorBelch("unloadObj: can't find `%s' to unload", path);
1499 /* -----------------------------------------------------------------------------
1500 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1501 * which may be prodded during relocation, and abort if we try and write
1502 * outside any of these.
1504 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1507 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1508 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1512 pb->next = oc->proddables;
1513 oc->proddables = pb;
1516 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1519 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1520 char* s = (char*)(pb->start);
1521 char* e = s + pb->size - 1;
1522 char* a = (char*)addr;
1523 /* Assumes that the biggest fixup involves a 4-byte write. This
1524 probably needs to be changed to 8 (ie, +7) on 64-bit
1526 if (a >= s && (a+3) <= e) return;
1528 barf("checkProddableBlock: invalid fixup in runtime linker");
1531 /* -----------------------------------------------------------------------------
1532 * Section management.
1534 static void addSection ( ObjectCode* oc, SectionKind kind,
1535 void* start, void* end )
1537 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1541 s->next = oc->sections;
1544 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1545 start, ((char*)end)-1, end - start + 1, kind );
1550 /* --------------------------------------------------------------------------
1552 * This is about allocating a small chunk of memory for every symbol in the
1553 * object file. We make sure that the SymboLExtras are always "in range" of
1554 * limited-range PC-relative instructions on various platforms by allocating
1555 * them right next to the object code itself.
1558 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
1561 ocAllocateSymbolExtras
1563 Allocate additional space at the end of the object file image to make room
1564 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1566 PowerPC relative branch instructions have a 24 bit displacement field.
1567 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1568 If a particular imported symbol is outside this range, we have to redirect
1569 the jump to a short piece of new code that just loads the 32bit absolute
1570 address and jumps there.
1571 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1574 This function just allocates space for one SymbolExtra for every
1575 undefined symbol in the object file. The code for the jump islands is
1576 filled in by makeSymbolExtra below.
1579 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1586 int misalignment = 0;
1587 #ifdef darwin_HOST_OS
1588 misalignment = oc->misalignment;
1594 // round up to the nearest 4
1595 aligned = (oc->fileSize + 3) & ~3;
1598 #ifndef linux_HOST_OS /* mremap is a linux extension */
1599 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1602 pagesize = getpagesize();
1603 n = ROUND_UP( oc->fileSize, pagesize );
1604 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1606 /* If we have a half-page-size file and map one page of it then
1607 * the part of the page after the size of the file remains accessible.
1608 * If, however, we map in 2 pages, the 2nd page is not accessible
1609 * and will give a "Bus Error" on access. To get around this, we check
1610 * if we need any extra pages for the jump islands and map them in
1611 * anonymously. We must check that we actually require extra pages
1612 * otherwise the attempt to mmap 0 pages of anonymous memory will
1618 /* The effect of this mremap() call is only the ensure that we have
1619 * a sufficient number of virtually contiguous pages. As returned from
1620 * mremap, the pages past the end of the file are not backed. We give
1621 * them a backing by using MAP_FIXED to map in anonymous pages.
1623 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1625 if( oc->image == MAP_FAILED )
1627 errorBelch( "Unable to mremap for Jump Islands\n" );
1631 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1632 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1634 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1640 oc->image -= misalignment;
1641 oc->image = stgReallocBytes( oc->image,
1643 aligned + sizeof (SymbolExtra) * count,
1644 "ocAllocateSymbolExtras" );
1645 oc->image += misalignment;
1646 #endif /* USE_MMAP */
1648 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1649 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1652 oc->symbol_extras = NULL;
1654 oc->first_symbol_extra = first;
1655 oc->n_symbol_extras = count;
1660 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1661 unsigned long symbolNumber,
1662 unsigned long target )
1666 ASSERT( symbolNumber >= oc->first_symbol_extra
1667 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1669 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1671 #ifdef powerpc_HOST_ARCH
1672 // lis r12, hi16(target)
1673 extra->jumpIsland.lis_r12 = 0x3d80;
1674 extra->jumpIsland.hi_addr = target >> 16;
1676 // ori r12, r12, lo16(target)
1677 extra->jumpIsland.ori_r12_r12 = 0x618c;
1678 extra->jumpIsland.lo_addr = target & 0xffff;
1681 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1684 extra->jumpIsland.bctr = 0x4e800420;
1686 #ifdef x86_64_HOST_ARCH
1688 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1689 extra->addr = target;
1690 memcpy(extra->jumpIsland, jmp, 6);
1698 /* --------------------------------------------------------------------------
1699 * PowerPC specifics (instruction cache flushing)
1700 * ------------------------------------------------------------------------*/
1702 #ifdef powerpc_TARGET_ARCH
1704 ocFlushInstructionCache
1706 Flush the data & instruction caches.
1707 Because the PPC has split data/instruction caches, we have to
1708 do that whenever we modify code at runtime.
1711 static void ocFlushInstructionCache( ObjectCode *oc )
1713 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1714 unsigned long *p = (unsigned long *) oc->image;
1718 __asm__ volatile ( "dcbf 0,%0\n\t"
1726 __asm__ volatile ( "sync\n\t"
1732 /* --------------------------------------------------------------------------
1733 * PEi386 specifics (Win32 targets)
1734 * ------------------------------------------------------------------------*/
1736 /* The information for this linker comes from
1737 Microsoft Portable Executable
1738 and Common Object File Format Specification
1739 revision 5.1 January 1998
1740 which SimonM says comes from the MS Developer Network CDs.
1742 It can be found there (on older CDs), but can also be found
1745 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1747 (this is Rev 6.0 from February 1999).
1749 Things move, so if that fails, try searching for it via
1751 http://www.google.com/search?q=PE+COFF+specification
1753 The ultimate reference for the PE format is the Winnt.h
1754 header file that comes with the Platform SDKs; as always,
1755 implementations will drift wrt their documentation.
1757 A good background article on the PE format is Matt Pietrek's
1758 March 1994 article in Microsoft System Journal (MSJ)
1759 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1760 Win32 Portable Executable File Format." The info in there
1761 has recently been updated in a two part article in
1762 MSDN magazine, issues Feb and March 2002,
1763 "Inside Windows: An In-Depth Look into the Win32 Portable
1764 Executable File Format"
1766 John Levine's book "Linkers and Loaders" contains useful
1771 #if defined(OBJFORMAT_PEi386)
1775 typedef unsigned char UChar;
1776 typedef unsigned short UInt16;
1777 typedef unsigned int UInt32;
1784 UInt16 NumberOfSections;
1785 UInt32 TimeDateStamp;
1786 UInt32 PointerToSymbolTable;
1787 UInt32 NumberOfSymbols;
1788 UInt16 SizeOfOptionalHeader;
1789 UInt16 Characteristics;
1793 #define sizeof_COFF_header 20
1800 UInt32 VirtualAddress;
1801 UInt32 SizeOfRawData;
1802 UInt32 PointerToRawData;
1803 UInt32 PointerToRelocations;
1804 UInt32 PointerToLinenumbers;
1805 UInt16 NumberOfRelocations;
1806 UInt16 NumberOfLineNumbers;
1807 UInt32 Characteristics;
1811 #define sizeof_COFF_section 40
1818 UInt16 SectionNumber;
1821 UChar NumberOfAuxSymbols;
1825 #define sizeof_COFF_symbol 18
1830 UInt32 VirtualAddress;
1831 UInt32 SymbolTableIndex;
1836 #define sizeof_COFF_reloc 10
1839 /* From PE spec doc, section 3.3.2 */
1840 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1841 windows.h -- for the same purpose, but I want to know what I'm
1843 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1844 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1845 #define MYIMAGE_FILE_DLL 0x2000
1846 #define MYIMAGE_FILE_SYSTEM 0x1000
1847 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1848 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1849 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1851 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1852 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1853 #define MYIMAGE_SYM_CLASS_STATIC 3
1854 #define MYIMAGE_SYM_UNDEFINED 0
1856 /* From PE spec doc, section 4.1 */
1857 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1858 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1859 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1861 /* From PE spec doc, section 5.2.1 */
1862 #define MYIMAGE_REL_I386_DIR32 0x0006
1863 #define MYIMAGE_REL_I386_REL32 0x0014
1866 /* We use myindex to calculate array addresses, rather than
1867 simply doing the normal subscript thing. That's because
1868 some of the above structs have sizes which are not
1869 a whole number of words. GCC rounds their sizes up to a
1870 whole number of words, which means that the address calcs
1871 arising from using normal C indexing or pointer arithmetic
1872 are just plain wrong. Sigh.
1875 myindex ( int scale, void* base, int index )
1878 ((UChar*)base) + scale * index;
1883 printName ( UChar* name, UChar* strtab )
1885 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1886 UInt32 strtab_offset = * (UInt32*)(name+4);
1887 debugBelch("%s", strtab + strtab_offset );
1890 for (i = 0; i < 8; i++) {
1891 if (name[i] == 0) break;
1892 debugBelch("%c", name[i] );
1899 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1901 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1902 UInt32 strtab_offset = * (UInt32*)(name+4);
1903 strncpy ( dst, strtab+strtab_offset, dstSize );
1909 if (name[i] == 0) break;
1919 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1922 /* If the string is longer than 8 bytes, look in the
1923 string table for it -- this will be correctly zero terminated.
1925 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1926 UInt32 strtab_offset = * (UInt32*)(name+4);
1927 return ((UChar*)strtab) + strtab_offset;
1929 /* Otherwise, if shorter than 8 bytes, return the original,
1930 which by defn is correctly terminated.
1932 if (name[7]==0) return name;
1933 /* The annoying case: 8 bytes. Copy into a temporary
1934 (which is never freed ...)
1936 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1938 strncpy(newstr,name,8);
1944 /* Just compares the short names (first 8 chars) */
1945 static COFF_section *
1946 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1950 = (COFF_header*)(oc->image);
1951 COFF_section* sectab
1953 ((UChar*)(oc->image))
1954 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1956 for (i = 0; i < hdr->NumberOfSections; i++) {
1959 COFF_section* section_i
1961 myindex ( sizeof_COFF_section, sectab, i );
1962 n1 = (UChar*) &(section_i->Name);
1964 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1965 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1966 n1[6]==n2[6] && n1[7]==n2[7])
1975 zapTrailingAtSign ( UChar* sym )
1977 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
1979 if (sym[0] == 0) return;
1981 while (sym[i] != 0) i++;
1984 while (j > 0 && my_isdigit(sym[j])) j--;
1985 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
1991 ocVerifyImage_PEi386 ( ObjectCode* oc )
1996 COFF_section* sectab;
1997 COFF_symbol* symtab;
1999 /* debugBelch("\nLOADING %s\n", oc->fileName); */
2000 hdr = (COFF_header*)(oc->image);
2001 sectab = (COFF_section*) (
2002 ((UChar*)(oc->image))
2003 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2005 symtab = (COFF_symbol*) (
2006 ((UChar*)(oc->image))
2007 + hdr->PointerToSymbolTable
2009 strtab = ((UChar*)symtab)
2010 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2012 if (hdr->Machine != 0x14c) {
2013 errorBelch("%s: Not x86 PEi386", oc->fileName);
2016 if (hdr->SizeOfOptionalHeader != 0) {
2017 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
2020 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
2021 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
2022 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
2023 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
2024 errorBelch("%s: Not a PEi386 object file", oc->fileName);
2027 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
2028 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
2029 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
2031 (int)(hdr->Characteristics));
2034 /* If the string table size is way crazy, this might indicate that
2035 there are more than 64k relocations, despite claims to the
2036 contrary. Hence this test. */
2037 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2039 if ( (*(UInt32*)strtab) > 600000 ) {
2040 /* Note that 600k has no special significance other than being
2041 big enough to handle the almost-2MB-sized lumps that
2042 constitute HSwin32*.o. */
2043 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2048 /* No further verification after this point; only debug printing. */
2050 IF_DEBUG(linker, i=1);
2051 if (i == 0) return 1;
2053 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2054 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2055 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2058 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2059 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2060 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2061 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2062 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2063 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2064 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2066 /* Print the section table. */
2068 for (i = 0; i < hdr->NumberOfSections; i++) {
2070 COFF_section* sectab_i
2072 myindex ( sizeof_COFF_section, sectab, i );
2079 printName ( sectab_i->Name, strtab );
2089 sectab_i->VirtualSize,
2090 sectab_i->VirtualAddress,
2091 sectab_i->SizeOfRawData,
2092 sectab_i->PointerToRawData,
2093 sectab_i->NumberOfRelocations,
2094 sectab_i->PointerToRelocations,
2095 sectab_i->PointerToRawData
2097 reltab = (COFF_reloc*) (
2098 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2101 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2102 /* If the relocation field (a short) has overflowed, the
2103 * real count can be found in the first reloc entry.
2105 * See Section 4.1 (last para) of the PE spec (rev6.0).
2107 COFF_reloc* rel = (COFF_reloc*)
2108 myindex ( sizeof_COFF_reloc, reltab, 0 );
2109 noRelocs = rel->VirtualAddress;
2112 noRelocs = sectab_i->NumberOfRelocations;
2116 for (; j < noRelocs; j++) {
2118 COFF_reloc* rel = (COFF_reloc*)
2119 myindex ( sizeof_COFF_reloc, reltab, j );
2121 " type 0x%-4x vaddr 0x%-8x name `",
2123 rel->VirtualAddress );
2124 sym = (COFF_symbol*)
2125 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2126 /* Hmm..mysterious looking offset - what's it for? SOF */
2127 printName ( sym->Name, strtab -10 );
2134 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2135 debugBelch("---START of string table---\n");
2136 for (i = 4; i < *(Int32*)strtab; i++) {
2138 debugBelch("\n"); else
2139 debugBelch("%c", strtab[i] );
2141 debugBelch("--- END of string table---\n");
2146 COFF_symbol* symtab_i;
2147 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2148 symtab_i = (COFF_symbol*)
2149 myindex ( sizeof_COFF_symbol, symtab, i );
2155 printName ( symtab_i->Name, strtab );
2164 (Int32)(symtab_i->SectionNumber),
2165 (UInt32)symtab_i->Type,
2166 (UInt32)symtab_i->StorageClass,
2167 (UInt32)symtab_i->NumberOfAuxSymbols
2169 i += symtab_i->NumberOfAuxSymbols;
2179 ocGetNames_PEi386 ( ObjectCode* oc )
2182 COFF_section* sectab;
2183 COFF_symbol* symtab;
2190 hdr = (COFF_header*)(oc->image);
2191 sectab = (COFF_section*) (
2192 ((UChar*)(oc->image))
2193 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2195 symtab = (COFF_symbol*) (
2196 ((UChar*)(oc->image))
2197 + hdr->PointerToSymbolTable
2199 strtab = ((UChar*)(oc->image))
2200 + hdr->PointerToSymbolTable
2201 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2203 /* Allocate space for any (local, anonymous) .bss sections. */
2205 for (i = 0; i < hdr->NumberOfSections; i++) {
2208 COFF_section* sectab_i
2210 myindex ( sizeof_COFF_section, sectab, i );
2211 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2212 /* sof 10/05: the PE spec text isn't too clear regarding what
2213 * the SizeOfRawData field is supposed to hold for object
2214 * file sections containing just uninitialized data -- for executables,
2215 * it is supposed to be zero; unclear what it's supposed to be
2216 * for object files. However, VirtualSize is guaranteed to be
2217 * zero for object files, which definitely suggests that SizeOfRawData
2218 * will be non-zero (where else would the size of this .bss section be
2219 * stored?) Looking at the COFF_section info for incoming object files,
2220 * this certainly appears to be the case.
2222 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2223 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2224 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2225 * variable decls into to the .bss section. (The specific function in Q which
2226 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2228 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2229 /* This is a non-empty .bss section. Allocate zeroed space for
2230 it, and set its PointerToRawData field such that oc->image +
2231 PointerToRawData == addr_of_zeroed_space. */
2232 bss_sz = sectab_i->VirtualSize;
2233 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2234 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2235 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2236 addProddableBlock(oc, zspace, bss_sz);
2237 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2240 /* Copy section information into the ObjectCode. */
2242 for (i = 0; i < hdr->NumberOfSections; i++) {
2248 = SECTIONKIND_OTHER;
2249 COFF_section* sectab_i
2251 myindex ( sizeof_COFF_section, sectab, i );
2252 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2255 /* I'm sure this is the Right Way to do it. However, the
2256 alternative of testing the sectab_i->Name field seems to
2257 work ok with Cygwin.
2259 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2260 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2261 kind = SECTIONKIND_CODE_OR_RODATA;
2264 if (0==strcmp(".text",sectab_i->Name) ||
2265 0==strcmp(".rdata",sectab_i->Name)||
2266 0==strcmp(".rodata",sectab_i->Name))
2267 kind = SECTIONKIND_CODE_OR_RODATA;
2268 if (0==strcmp(".data",sectab_i->Name) ||
2269 0==strcmp(".bss",sectab_i->Name))
2270 kind = SECTIONKIND_RWDATA;
2272 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2273 sz = sectab_i->SizeOfRawData;
2274 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2276 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2277 end = start + sz - 1;
2279 if (kind == SECTIONKIND_OTHER
2280 /* Ignore sections called which contain stabs debugging
2282 && 0 != strcmp(".stab", sectab_i->Name)
2283 && 0 != strcmp(".stabstr", sectab_i->Name)
2284 /* ignore constructor section for now */
2285 && 0 != strcmp(".ctors", sectab_i->Name)
2286 /* ignore section generated from .ident */
2287 && 0!= strcmp("/4", sectab_i->Name)
2289 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2293 if (kind != SECTIONKIND_OTHER && end >= start) {
2294 addSection(oc, kind, start, end);
2295 addProddableBlock(oc, start, end - start + 1);
2299 /* Copy exported symbols into the ObjectCode. */
2301 oc->n_symbols = hdr->NumberOfSymbols;
2302 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2303 "ocGetNames_PEi386(oc->symbols)");
2304 /* Call me paranoid; I don't care. */
2305 for (i = 0; i < oc->n_symbols; i++)
2306 oc->symbols[i] = NULL;
2310 COFF_symbol* symtab_i;
2311 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2312 symtab_i = (COFF_symbol*)
2313 myindex ( sizeof_COFF_symbol, symtab, i );
2317 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2318 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2319 /* This symbol is global and defined, viz, exported */
2320 /* for MYIMAGE_SYMCLASS_EXTERNAL
2321 && !MYIMAGE_SYM_UNDEFINED,
2322 the address of the symbol is:
2323 address of relevant section + offset in section
2325 COFF_section* sectabent
2326 = (COFF_section*) myindex ( sizeof_COFF_section,
2328 symtab_i->SectionNumber-1 );
2329 addr = ((UChar*)(oc->image))
2330 + (sectabent->PointerToRawData
2334 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2335 && symtab_i->Value > 0) {
2336 /* This symbol isn't in any section at all, ie, global bss.
2337 Allocate zeroed space for it. */
2338 addr = stgCallocBytes(1, symtab_i->Value,
2339 "ocGetNames_PEi386(non-anonymous bss)");
2340 addSection(oc, SECTIONKIND_RWDATA, addr,
2341 ((UChar*)addr) + symtab_i->Value - 1);
2342 addProddableBlock(oc, addr, symtab_i->Value);
2343 /* debugBelch("BSS section at 0x%x\n", addr); */
2346 if (addr != NULL ) {
2347 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2348 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2349 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2350 ASSERT(i >= 0 && i < oc->n_symbols);
2351 /* cstring_from_COFF_symbol_name always succeeds. */
2352 oc->symbols[i] = sname;
2353 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2357 "IGNORING symbol %d\n"
2361 printName ( symtab_i->Name, strtab );
2370 (Int32)(symtab_i->SectionNumber),
2371 (UInt32)symtab_i->Type,
2372 (UInt32)symtab_i->StorageClass,
2373 (UInt32)symtab_i->NumberOfAuxSymbols
2378 i += symtab_i->NumberOfAuxSymbols;
2387 ocResolve_PEi386 ( ObjectCode* oc )
2390 COFF_section* sectab;
2391 COFF_symbol* symtab;
2401 /* ToDo: should be variable-sized? But is at least safe in the
2402 sense of buffer-overrun-proof. */
2404 /* debugBelch("resolving for %s\n", oc->fileName); */
2406 hdr = (COFF_header*)(oc->image);
2407 sectab = (COFF_section*) (
2408 ((UChar*)(oc->image))
2409 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2411 symtab = (COFF_symbol*) (
2412 ((UChar*)(oc->image))
2413 + hdr->PointerToSymbolTable
2415 strtab = ((UChar*)(oc->image))
2416 + hdr->PointerToSymbolTable
2417 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2419 for (i = 0; i < hdr->NumberOfSections; i++) {
2420 COFF_section* sectab_i
2422 myindex ( sizeof_COFF_section, sectab, i );
2425 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2428 /* Ignore sections called which contain stabs debugging
2430 if (0 == strcmp(".stab", sectab_i->Name)
2431 || 0 == strcmp(".stabstr", sectab_i->Name)
2432 || 0 == strcmp(".ctors", sectab_i->Name))
2435 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2436 /* If the relocation field (a short) has overflowed, the
2437 * real count can be found in the first reloc entry.
2439 * See Section 4.1 (last para) of the PE spec (rev6.0).
2441 * Nov2003 update: the GNU linker still doesn't correctly
2442 * handle the generation of relocatable object files with
2443 * overflown relocations. Hence the output to warn of potential
2446 COFF_reloc* rel = (COFF_reloc*)
2447 myindex ( sizeof_COFF_reloc, reltab, 0 );
2448 noRelocs = rel->VirtualAddress;
2450 /* 10/05: we now assume (and check for) a GNU ld that is capable
2451 * of handling object files with (>2^16) of relocs.
2454 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2459 noRelocs = sectab_i->NumberOfRelocations;
2464 for (; j < noRelocs; j++) {
2466 COFF_reloc* reltab_j
2468 myindex ( sizeof_COFF_reloc, reltab, j );
2470 /* the location to patch */
2472 ((UChar*)(oc->image))
2473 + (sectab_i->PointerToRawData
2474 + reltab_j->VirtualAddress
2475 - sectab_i->VirtualAddress )
2477 /* the existing contents of pP */
2479 /* the symbol to connect to */
2480 sym = (COFF_symbol*)
2481 myindex ( sizeof_COFF_symbol,
2482 symtab, reltab_j->SymbolTableIndex );
2485 "reloc sec %2d num %3d: type 0x%-4x "
2486 "vaddr 0x%-8x name `",
2488 (UInt32)reltab_j->Type,
2489 reltab_j->VirtualAddress );
2490 printName ( sym->Name, strtab );
2491 debugBelch("'\n" ));
2493 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2494 COFF_section* section_sym
2495 = findPEi386SectionCalled ( oc, sym->Name );
2497 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2500 S = ((UInt32)(oc->image))
2501 + (section_sym->PointerToRawData
2504 copyName ( sym->Name, strtab, symbol, 1000-1 );
2505 S = (UInt32) lookupLocalSymbol( oc, symbol );
2506 if ((void*)S != NULL) goto foundit;
2507 S = (UInt32) lookupSymbol( symbol );
2508 if ((void*)S != NULL) goto foundit;
2509 zapTrailingAtSign ( symbol );
2510 S = (UInt32) lookupLocalSymbol( oc, symbol );
2511 if ((void*)S != NULL) goto foundit;
2512 S = (UInt32) lookupSymbol( symbol );
2513 if ((void*)S != NULL) goto foundit;
2514 /* Newline first because the interactive linker has printed "linking..." */
2515 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2519 checkProddableBlock(oc, pP);
2520 switch (reltab_j->Type) {
2521 case MYIMAGE_REL_I386_DIR32:
2524 case MYIMAGE_REL_I386_REL32:
2525 /* Tricky. We have to insert a displacement at
2526 pP which, when added to the PC for the _next_
2527 insn, gives the address of the target (S).
2528 Problem is to know the address of the next insn
2529 when we only know pP. We assume that this
2530 literal field is always the last in the insn,
2531 so that the address of the next insn is pP+4
2532 -- hence the constant 4.
2533 Also I don't know if A should be added, but so
2534 far it has always been zero.
2536 SOF 05/2005: 'A' (old contents of *pP) have been observed
2537 to contain values other than zero (the 'wx' object file
2538 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2539 So, add displacement to old value instead of asserting
2540 A to be zero. Fixes wxhaskell-related crashes, and no other
2541 ill effects have been observed.
2543 Update: the reason why we're seeing these more elaborate
2544 relocations is due to a switch in how the NCG compiles SRTs
2545 and offsets to them from info tables. SRTs live in .(ro)data,
2546 while info tables live in .text, causing GAS to emit REL32/DISP32
2547 relocations with non-zero values. Adding the displacement is
2548 the right thing to do.
2550 *pP = S - ((UInt32)pP) - 4 + A;
2553 debugBelch("%s: unhandled PEi386 relocation type %d",
2554 oc->fileName, reltab_j->Type);
2561 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2565 #endif /* defined(OBJFORMAT_PEi386) */
2568 /* --------------------------------------------------------------------------
2570 * ------------------------------------------------------------------------*/
2572 #if defined(OBJFORMAT_ELF)
2577 #if defined(sparc_HOST_ARCH)
2578 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2579 #elif defined(i386_HOST_ARCH)
2580 # define ELF_TARGET_386 /* Used inside <elf.h> */
2581 #elif defined(x86_64_HOST_ARCH)
2582 # define ELF_TARGET_X64_64
2584 #elif defined (ia64_HOST_ARCH)
2585 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2587 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2588 # define ELF_NEED_GOT /* needs Global Offset Table */
2589 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2592 #if !defined(openbsd_HOST_OS)
2595 /* openbsd elf has things in different places, with diff names */
2596 # include <elf_abi.h>
2597 # include <machine/reloc.h>
2598 # define R_386_32 RELOC_32
2599 # define R_386_PC32 RELOC_PC32
2602 /* If elf.h doesn't define it */
2603 # ifndef R_X86_64_PC64
2604 # define R_X86_64_PC64 24
2608 * Define a set of types which can be used for both ELF32 and ELF64
2612 #define ELFCLASS ELFCLASS64
2613 #define Elf_Addr Elf64_Addr
2614 #define Elf_Word Elf64_Word
2615 #define Elf_Sword Elf64_Sword
2616 #define Elf_Ehdr Elf64_Ehdr
2617 #define Elf_Phdr Elf64_Phdr
2618 #define Elf_Shdr Elf64_Shdr
2619 #define Elf_Sym Elf64_Sym
2620 #define Elf_Rel Elf64_Rel
2621 #define Elf_Rela Elf64_Rela
2622 #define ELF_ST_TYPE ELF64_ST_TYPE
2623 #define ELF_ST_BIND ELF64_ST_BIND
2624 #define ELF_R_TYPE ELF64_R_TYPE
2625 #define ELF_R_SYM ELF64_R_SYM
2627 #define ELFCLASS ELFCLASS32
2628 #define Elf_Addr Elf32_Addr
2629 #define Elf_Word Elf32_Word
2630 #define Elf_Sword Elf32_Sword
2631 #define Elf_Ehdr Elf32_Ehdr
2632 #define Elf_Phdr Elf32_Phdr
2633 #define Elf_Shdr Elf32_Shdr
2634 #define Elf_Sym Elf32_Sym
2635 #define Elf_Rel Elf32_Rel
2636 #define Elf_Rela Elf32_Rela
2638 #define ELF_ST_TYPE ELF32_ST_TYPE
2641 #define ELF_ST_BIND ELF32_ST_BIND
2644 #define ELF_R_TYPE ELF32_R_TYPE
2647 #define ELF_R_SYM ELF32_R_SYM
2653 * Functions to allocate entries in dynamic sections. Currently we simply
2654 * preallocate a large number, and we don't check if a entry for the given
2655 * target already exists (a linear search is too slow). Ideally these
2656 * entries would be associated with symbols.
2659 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2660 #define GOT_SIZE 0x20000
2661 #define FUNCTION_TABLE_SIZE 0x10000
2662 #define PLT_SIZE 0x08000
2665 static Elf_Addr got[GOT_SIZE];
2666 static unsigned int gotIndex;
2667 static Elf_Addr gp_val = (Elf_Addr)got;
2670 allocateGOTEntry(Elf_Addr target)
2674 if (gotIndex >= GOT_SIZE)
2675 barf("Global offset table overflow");
2677 entry = &got[gotIndex++];
2679 return (Elf_Addr)entry;
2683 #ifdef ELF_FUNCTION_DESC
2689 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2690 static unsigned int functionTableIndex;
2693 allocateFunctionDesc(Elf_Addr target)
2695 FunctionDesc *entry;
2697 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2698 barf("Function table overflow");
2700 entry = &functionTable[functionTableIndex++];
2702 entry->gp = (Elf_Addr)gp_val;
2703 return (Elf_Addr)entry;
2707 copyFunctionDesc(Elf_Addr target)
2709 FunctionDesc *olddesc = (FunctionDesc *)target;
2710 FunctionDesc *newdesc;
2712 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2713 newdesc->gp = olddesc->gp;
2714 return (Elf_Addr)newdesc;
2719 #ifdef ia64_HOST_ARCH
2720 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2721 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2723 static unsigned char plt_code[] =
2725 /* taken from binutils bfd/elfxx-ia64.c */
2726 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2727 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2728 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2729 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2730 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2731 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2734 /* If we can't get to the function descriptor via gp, take a local copy of it */
2735 #define PLT_RELOC(code, target) { \
2736 Elf64_Sxword rel_value = target - gp_val; \
2737 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2738 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2740 ia64_reloc_gprel22((Elf_Addr)code, target); \
2745 unsigned char code[sizeof(plt_code)];
2749 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2751 PLTEntry *plt = (PLTEntry *)oc->plt;
2754 if (oc->pltIndex >= PLT_SIZE)
2755 barf("Procedure table overflow");
2757 entry = &plt[oc->pltIndex++];
2758 memcpy(entry->code, plt_code, sizeof(entry->code));
2759 PLT_RELOC(entry->code, target);
2760 return (Elf_Addr)entry;
2766 return (PLT_SIZE * sizeof(PLTEntry));
2772 * Generic ELF functions
2776 findElfSection ( void* objImage, Elf_Word sh_type )
2778 char* ehdrC = (char*)objImage;
2779 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2780 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2781 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2785 for (i = 0; i < ehdr->e_shnum; i++) {
2786 if (shdr[i].sh_type == sh_type
2787 /* Ignore the section header's string table. */
2788 && i != ehdr->e_shstrndx
2789 /* Ignore string tables named .stabstr, as they contain
2791 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2793 ptr = ehdrC + shdr[i].sh_offset;
2800 #if defined(ia64_HOST_ARCH)
2802 findElfSegment ( void* objImage, Elf_Addr vaddr )
2804 char* ehdrC = (char*)objImage;
2805 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2806 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2807 Elf_Addr segaddr = 0;
2810 for (i = 0; i < ehdr->e_phnum; i++) {
2811 segaddr = phdr[i].p_vaddr;
2812 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2820 ocVerifyImage_ELF ( ObjectCode* oc )
2824 int i, j, nent, nstrtab, nsymtabs;
2828 char* ehdrC = (char*)(oc->image);
2829 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2831 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2832 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2833 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2834 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2835 errorBelch("%s: not an ELF object", oc->fileName);
2839 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2840 errorBelch("%s: unsupported ELF format", oc->fileName);
2844 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2845 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2847 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2848 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2850 errorBelch("%s: unknown endiannness", oc->fileName);
2854 if (ehdr->e_type != ET_REL) {
2855 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2858 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2860 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2861 switch (ehdr->e_machine) {
2862 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2863 #ifdef EM_SPARC32PLUS
2864 case EM_SPARC32PLUS:
2866 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2868 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2870 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2872 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2873 #elif defined(EM_AMD64)
2874 case EM_AMD64: IF_DEBUG(linker,debugBelch( "amd64" )); break;
2876 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2877 errorBelch("%s: unknown architecture (e_machine == %d)"
2878 , oc->fileName, ehdr->e_machine);
2882 IF_DEBUG(linker,debugBelch(
2883 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2884 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2886 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2888 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2890 if (ehdr->e_shstrndx == SHN_UNDEF) {
2891 errorBelch("%s: no section header string table", oc->fileName);
2894 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2896 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2899 for (i = 0; i < ehdr->e_shnum; i++) {
2900 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2901 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2902 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2903 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2904 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2905 ehdrC + shdr[i].sh_offset,
2906 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2908 if (shdr[i].sh_type == SHT_REL) {
2909 IF_DEBUG(linker,debugBelch("Rel " ));
2910 } else if (shdr[i].sh_type == SHT_RELA) {
2911 IF_DEBUG(linker,debugBelch("RelA " ));
2913 IF_DEBUG(linker,debugBelch(" "));
2916 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2920 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2923 for (i = 0; i < ehdr->e_shnum; i++) {
2924 if (shdr[i].sh_type == SHT_STRTAB
2925 /* Ignore the section header's string table. */
2926 && i != ehdr->e_shstrndx
2927 /* Ignore string tables named .stabstr, as they contain
2929 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2931 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2932 strtab = ehdrC + shdr[i].sh_offset;
2937 errorBelch("%s: no string tables, or too many", oc->fileName);
2942 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2943 for (i = 0; i < ehdr->e_shnum; i++) {
2944 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2945 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2947 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2948 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2949 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2951 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2953 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2954 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2957 for (j = 0; j < nent; j++) {
2958 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2959 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2960 (int)stab[j].st_shndx,
2961 (int)stab[j].st_size,
2962 (char*)stab[j].st_value ));
2964 IF_DEBUG(linker,debugBelch("type=" ));
2965 switch (ELF_ST_TYPE(stab[j].st_info)) {
2966 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2967 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2968 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2969 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
2970 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
2971 default: IF_DEBUG(linker,debugBelch("? " )); break;
2973 IF_DEBUG(linker,debugBelch(" " ));
2975 IF_DEBUG(linker,debugBelch("bind=" ));
2976 switch (ELF_ST_BIND(stab[j].st_info)) {
2977 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
2978 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
2979 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
2980 default: IF_DEBUG(linker,debugBelch("? " )); break;
2982 IF_DEBUG(linker,debugBelch(" " ));
2984 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
2988 if (nsymtabs == 0) {
2989 errorBelch("%s: didn't find any symbol tables", oc->fileName);
2996 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
3000 if (hdr->sh_type == SHT_PROGBITS
3001 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
3002 /* .text-style section */
3003 return SECTIONKIND_CODE_OR_RODATA;
3006 if (hdr->sh_type == SHT_PROGBITS
3007 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3008 /* .data-style section */
3009 return SECTIONKIND_RWDATA;
3012 if (hdr->sh_type == SHT_PROGBITS
3013 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3014 /* .rodata-style section */
3015 return SECTIONKIND_CODE_OR_RODATA;
3018 if (hdr->sh_type == SHT_NOBITS
3019 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3020 /* .bss-style section */
3022 return SECTIONKIND_RWDATA;
3025 return SECTIONKIND_OTHER;
3030 ocGetNames_ELF ( ObjectCode* oc )
3035 char* ehdrC = (char*)(oc->image);
3036 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3037 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3038 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3040 ASSERT(symhash != NULL);
3043 errorBelch("%s: no strtab", oc->fileName);
3048 for (i = 0; i < ehdr->e_shnum; i++) {
3049 /* Figure out what kind of section it is. Logic derived from
3050 Figure 1.14 ("Special Sections") of the ELF document
3051 ("Portable Formats Specification, Version 1.1"). */
3053 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3055 if (is_bss && shdr[i].sh_size > 0) {
3056 /* This is a non-empty .bss section. Allocate zeroed space for
3057 it, and set its .sh_offset field such that
3058 ehdrC + .sh_offset == addr_of_zeroed_space. */
3059 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3060 "ocGetNames_ELF(BSS)");
3061 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3063 debugBelch("BSS section at 0x%x, size %d\n",
3064 zspace, shdr[i].sh_size);
3068 /* fill in the section info */
3069 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3070 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3071 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3072 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3075 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3077 /* copy stuff into this module's object symbol table */
3078 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3079 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3081 oc->n_symbols = nent;
3082 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3083 "ocGetNames_ELF(oc->symbols)");
3085 for (j = 0; j < nent; j++) {
3087 char isLocal = FALSE; /* avoids uninit-var warning */
3089 char* nm = strtab + stab[j].st_name;
3090 int secno = stab[j].st_shndx;
3092 /* Figure out if we want to add it; if so, set ad to its
3093 address. Otherwise leave ad == NULL. */
3095 if (secno == SHN_COMMON) {
3097 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3099 debugBelch("COMMON symbol, size %d name %s\n",
3100 stab[j].st_size, nm);
3102 /* Pointless to do addProddableBlock() for this area,
3103 since the linker should never poke around in it. */
3106 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3107 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3109 /* and not an undefined symbol */
3110 && stab[j].st_shndx != SHN_UNDEF
3111 /* and not in a "special section" */
3112 && stab[j].st_shndx < SHN_LORESERVE
3114 /* and it's a not a section or string table or anything silly */
3115 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3116 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3117 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3120 /* Section 0 is the undefined section, hence > and not >=. */
3121 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3123 if (shdr[secno].sh_type == SHT_NOBITS) {
3124 debugBelch(" BSS symbol, size %d off %d name %s\n",
3125 stab[j].st_size, stab[j].st_value, nm);
3128 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3129 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3132 #ifdef ELF_FUNCTION_DESC
3133 /* dlsym() and the initialisation table both give us function
3134 * descriptors, so to be consistent we store function descriptors
3135 * in the symbol table */
3136 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3137 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3139 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3140 ad, oc->fileName, nm ));
3145 /* And the decision is ... */
3149 oc->symbols[j] = nm;
3152 /* Ignore entirely. */
3154 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3158 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3159 strtab + stab[j].st_name ));
3162 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3163 (int)ELF_ST_BIND(stab[j].st_info),
3164 (int)ELF_ST_TYPE(stab[j].st_info),
3165 (int)stab[j].st_shndx,
3166 strtab + stab[j].st_name
3169 oc->symbols[j] = NULL;
3178 /* Do ELF relocations which lack an explicit addend. All x86-linux
3179 relocations appear to be of this form. */
3181 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3182 Elf_Shdr* shdr, int shnum,
3183 Elf_Sym* stab, char* strtab )
3188 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3189 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3190 int target_shndx = shdr[shnum].sh_info;
3191 int symtab_shndx = shdr[shnum].sh_link;
3193 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3194 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3195 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3196 target_shndx, symtab_shndx ));
3198 /* Skip sections that we're not interested in. */
3201 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3202 if (kind == SECTIONKIND_OTHER) {
3203 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3208 for (j = 0; j < nent; j++) {
3209 Elf_Addr offset = rtab[j].r_offset;
3210 Elf_Addr info = rtab[j].r_info;
3212 Elf_Addr P = ((Elf_Addr)targ) + offset;
3213 Elf_Word* pP = (Elf_Word*)P;
3218 StgStablePtr stablePtr;
3221 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3222 j, (void*)offset, (void*)info ));
3224 IF_DEBUG(linker,debugBelch( " ZERO" ));
3227 Elf_Sym sym = stab[ELF_R_SYM(info)];
3228 /* First see if it is a local symbol. */
3229 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3230 /* Yes, so we can get the address directly from the ELF symbol
3232 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3234 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3235 + stab[ELF_R_SYM(info)].st_value);
3238 symbol = strtab + sym.st_name;
3239 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3240 if (NULL == stablePtr) {
3241 /* No, so look up the name in our global table. */
3242 S_tmp = lookupSymbol( symbol );
3243 S = (Elf_Addr)S_tmp;
3245 stableVal = deRefStablePtr( stablePtr );
3247 S = (Elf_Addr)S_tmp;
3251 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3254 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3257 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3258 (void*)P, (void*)S, (void*)A ));
3259 checkProddableBlock ( oc, pP );
3263 switch (ELF_R_TYPE(info)) {
3264 # ifdef i386_HOST_ARCH
3265 case R_386_32: *pP = value; break;
3266 case R_386_PC32: *pP = value - P; break;
3269 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3270 oc->fileName, (lnat)ELF_R_TYPE(info));
3278 /* Do ELF relocations for which explicit addends are supplied.
3279 sparc-solaris relocations appear to be of this form. */
3281 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3282 Elf_Shdr* shdr, int shnum,
3283 Elf_Sym* stab, char* strtab )
3286 char *symbol = NULL;
3288 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3289 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3290 int target_shndx = shdr[shnum].sh_info;
3291 int symtab_shndx = shdr[shnum].sh_link;
3293 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3294 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3295 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3296 target_shndx, symtab_shndx ));
3298 for (j = 0; j < nent; j++) {
3299 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3300 /* This #ifdef only serves to avoid unused-var warnings. */
3301 Elf_Addr offset = rtab[j].r_offset;
3302 Elf_Addr P = targ + offset;
3304 Elf_Addr info = rtab[j].r_info;
3305 Elf_Addr A = rtab[j].r_addend;
3309 # if defined(sparc_HOST_ARCH)
3310 Elf_Word* pP = (Elf_Word*)P;
3312 # elif defined(ia64_HOST_ARCH)
3313 Elf64_Xword *pP = (Elf64_Xword *)P;
3315 # elif defined(powerpc_HOST_ARCH)
3319 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3320 j, (void*)offset, (void*)info,
3323 IF_DEBUG(linker,debugBelch( " ZERO" ));
3326 Elf_Sym sym = stab[ELF_R_SYM(info)];
3327 /* First see if it is a local symbol. */
3328 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3329 /* Yes, so we can get the address directly from the ELF symbol
3331 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3333 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3334 + stab[ELF_R_SYM(info)].st_value);
3335 #ifdef ELF_FUNCTION_DESC
3336 /* Make a function descriptor for this function */
3337 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3338 S = allocateFunctionDesc(S + A);
3343 /* No, so look up the name in our global table. */
3344 symbol = strtab + sym.st_name;
3345 S_tmp = lookupSymbol( symbol );
3346 S = (Elf_Addr)S_tmp;
3348 #ifdef ELF_FUNCTION_DESC
3349 /* If a function, already a function descriptor - we would
3350 have to copy it to add an offset. */
3351 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3352 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3356 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3359 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3362 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3363 (void*)P, (void*)S, (void*)A ));
3364 /* checkProddableBlock ( oc, (void*)P ); */
3368 switch (ELF_R_TYPE(info)) {
3369 # if defined(sparc_HOST_ARCH)
3370 case R_SPARC_WDISP30:
3371 w1 = *pP & 0xC0000000;
3372 w2 = (Elf_Word)((value - P) >> 2);
3373 ASSERT((w2 & 0xC0000000) == 0);
3378 w1 = *pP & 0xFFC00000;
3379 w2 = (Elf_Word)(value >> 10);
3380 ASSERT((w2 & 0xFFC00000) == 0);
3386 w2 = (Elf_Word)(value & 0x3FF);
3387 ASSERT((w2 & ~0x3FF) == 0);
3391 /* According to the Sun documentation:
3393 This relocation type resembles R_SPARC_32, except it refers to an
3394 unaligned word. That is, the word to be relocated must be treated
3395 as four separate bytes with arbitrary alignment, not as a word
3396 aligned according to the architecture requirements.
3398 (JRS: which means that freeloading on the R_SPARC_32 case
3399 is probably wrong, but hey ...)
3403 w2 = (Elf_Word)value;
3406 # elif defined(ia64_HOST_ARCH)
3407 case R_IA64_DIR64LSB:
3408 case R_IA64_FPTR64LSB:
3411 case R_IA64_PCREL64LSB:
3414 case R_IA64_SEGREL64LSB:
3415 addr = findElfSegment(ehdrC, value);
3418 case R_IA64_GPREL22:
3419 ia64_reloc_gprel22(P, value);
3421 case R_IA64_LTOFF22:
3422 case R_IA64_LTOFF22X:
3423 case R_IA64_LTOFF_FPTR22:
3424 addr = allocateGOTEntry(value);
3425 ia64_reloc_gprel22(P, addr);
3427 case R_IA64_PCREL21B:
3428 ia64_reloc_pcrel21(P, S, oc);
3431 /* This goes with R_IA64_LTOFF22X and points to the load to
3432 * convert into a move. We don't implement relaxation. */
3434 # elif defined(powerpc_HOST_ARCH)
3435 case R_PPC_ADDR16_LO:
3436 *(Elf32_Half*) P = value;
3439 case R_PPC_ADDR16_HI:
3440 *(Elf32_Half*) P = value >> 16;
3443 case R_PPC_ADDR16_HA:
3444 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3448 *(Elf32_Word *) P = value;
3452 *(Elf32_Word *) P = value - P;
3458 if( delta << 6 >> 6 != delta )
3460 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3464 if( value == 0 || delta << 6 >> 6 != delta )
3466 barf( "Unable to make SymbolExtra for #%d",
3472 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3473 | (delta & 0x3fffffc);
3477 #if x86_64_HOST_ARCH
3479 *(Elf64_Xword *)P = value;
3484 StgInt64 off = value - P;
3485 if (off >= 0x7fffffffL || off < -0x80000000L) {
3486 #if X86_64_ELF_NONPIC_HACK
3487 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3489 off = pltAddress + A - P;
3491 barf("R_X86_64_PC32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3492 symbol, off, oc->fileName );
3495 *(Elf64_Word *)P = (Elf64_Word)off;
3501 StgInt64 off = value - P;
3502 *(Elf64_Word *)P = (Elf64_Word)off;
3507 if (value >= 0x7fffffffL) {
3508 #if X86_64_ELF_NONPIC_HACK
3509 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3511 value = pltAddress + A;
3513 barf("R_X86_64_32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3514 symbol, value, oc->fileName );
3517 *(Elf64_Word *)P = (Elf64_Word)value;
3521 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3522 #if X86_64_ELF_NONPIC_HACK
3523 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3525 value = pltAddress + A;
3527 barf("R_X86_64_32S relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3528 symbol, value, oc->fileName );
3531 *(Elf64_Sword *)P = (Elf64_Sword)value;
3534 case R_X86_64_GOTPCREL:
3536 StgInt64 gotAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)->addr;
3537 StgInt64 off = gotAddress + A - P;
3538 *(Elf64_Word *)P = (Elf64_Word)off;
3542 case R_X86_64_PLT32:
3544 StgInt64 off = value - P;
3545 if (off >= 0x7fffffffL || off < -0x80000000L) {
3546 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3548 off = pltAddress + A - P;
3550 *(Elf64_Word *)P = (Elf64_Word)off;
3556 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3557 oc->fileName, (lnat)ELF_R_TYPE(info));
3566 ocResolve_ELF ( ObjectCode* oc )
3570 Elf_Sym* stab = NULL;
3571 char* ehdrC = (char*)(oc->image);
3572 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3573 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3575 /* first find "the" symbol table */
3576 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3578 /* also go find the string table */
3579 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3581 if (stab == NULL || strtab == NULL) {
3582 errorBelch("%s: can't find string or symbol table", oc->fileName);
3586 /* Process the relocation sections. */
3587 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3588 if (shdr[shnum].sh_type == SHT_REL) {
3589 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3590 shnum, stab, strtab );
3594 if (shdr[shnum].sh_type == SHT_RELA) {
3595 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3596 shnum, stab, strtab );
3601 /* Free the local symbol table; we won't need it again. */
3602 freeHashTable(oc->lochash, NULL);
3605 #if defined(powerpc_HOST_ARCH)
3606 ocFlushInstructionCache( oc );
3614 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3615 * at the front. The following utility functions pack and unpack instructions, and
3616 * take care of the most common relocations.
3619 #ifdef ia64_HOST_ARCH
3622 ia64_extract_instruction(Elf64_Xword *target)
3625 int slot = (Elf_Addr)target & 3;
3626 target = (Elf_Addr)target & ~3;
3634 return ((w1 >> 5) & 0x1ffffffffff);
3636 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3640 barf("ia64_extract_instruction: invalid slot %p", target);
3645 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3647 int slot = (Elf_Addr)target & 3;
3648 target = (Elf_Addr)target & ~3;
3653 *target |= value << 5;
3656 *target |= value << 46;
3657 *(target+1) |= value >> 18;
3660 *(target+1) |= value << 23;
3666 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3668 Elf64_Xword instruction;
3669 Elf64_Sxword rel_value;
3671 rel_value = value - gp_val;
3672 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3673 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3675 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3676 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3677 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3678 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3679 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3680 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3684 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3686 Elf64_Xword instruction;
3687 Elf64_Sxword rel_value;
3690 entry = allocatePLTEntry(value, oc);
3692 rel_value = (entry >> 4) - (target >> 4);
3693 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3694 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3696 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3697 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3698 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3699 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3705 * PowerPC & X86_64 ELF specifics
3708 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3710 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3716 ehdr = (Elf_Ehdr *) oc->image;
3717 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3719 for( i = 0; i < ehdr->e_shnum; i++ )
3720 if( shdr[i].sh_type == SHT_SYMTAB )
3723 if( i == ehdr->e_shnum )
3725 errorBelch( "This ELF file contains no symtab" );
3729 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3731 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3732 (int) shdr[i].sh_entsize, (int) sizeof( Elf_Sym ) );
3737 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3740 #endif /* powerpc */
3744 /* --------------------------------------------------------------------------
3746 * ------------------------------------------------------------------------*/
3748 #if defined(OBJFORMAT_MACHO)
3751 Support for MachO linking on Darwin/MacOS X
3752 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3754 I hereby formally apologize for the hackish nature of this code.
3755 Things that need to be done:
3756 *) implement ocVerifyImage_MachO
3757 *) add still more sanity checks.
3760 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3761 #define mach_header mach_header_64
3762 #define segment_command segment_command_64
3763 #define section section_64
3764 #define nlist nlist_64
3767 #ifdef powerpc_HOST_ARCH
3768 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3770 struct mach_header *header = (struct mach_header *) oc->image;
3771 struct load_command *lc = (struct load_command *) (header + 1);
3774 for( i = 0; i < header->ncmds; i++ )
3776 if( lc->cmd == LC_SYMTAB )
3778 // Find out the first and last undefined external
3779 // symbol, so we don't have to allocate too many
3781 struct symtab_command *symLC = (struct symtab_command *) lc;
3782 unsigned min = symLC->nsyms, max = 0;
3783 struct nlist *nlist =
3784 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3786 for(i=0;i<symLC->nsyms;i++)
3788 if(nlist[i].n_type & N_STAB)
3790 else if(nlist[i].n_type & N_EXT)
3792 if((nlist[i].n_type & N_TYPE) == N_UNDF
3793 && (nlist[i].n_value == 0))
3803 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3808 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3810 return ocAllocateSymbolExtras(oc,0,0);
3813 #ifdef x86_64_HOST_ARCH
3814 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3816 struct mach_header *header = (struct mach_header *) oc->image;
3817 struct load_command *lc = (struct load_command *) (header + 1);
3820 for( i = 0; i < header->ncmds; i++ )
3822 if( lc->cmd == LC_SYMTAB )
3824 // Just allocate one entry for every symbol
3825 struct symtab_command *symLC = (struct symtab_command *) lc;
3827 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3830 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3832 return ocAllocateSymbolExtras(oc,0,0);
3836 static int ocVerifyImage_MachO(ObjectCode* oc)
3838 char *image = (char*) oc->image;
3839 struct mach_header *header = (struct mach_header*) image;
3841 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3842 if(header->magic != MH_MAGIC_64)
3845 if(header->magic != MH_MAGIC)
3848 // FIXME: do some more verifying here
3852 static int resolveImports(
3855 struct symtab_command *symLC,
3856 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3857 unsigned long *indirectSyms,
3858 struct nlist *nlist)
3861 size_t itemSize = 4;
3864 int isJumpTable = 0;
3865 if(!strcmp(sect->sectname,"__jump_table"))
3869 ASSERT(sect->reserved2 == itemSize);
3873 for(i=0; i*itemSize < sect->size;i++)
3875 // according to otool, reserved1 contains the first index into the indirect symbol table
3876 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3877 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3880 if((symbol->n_type & N_TYPE) == N_UNDF
3881 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3882 addr = (void*) (symbol->n_value);
3883 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3886 addr = lookupSymbol(nm);
3889 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3897 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3898 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3899 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3900 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3905 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3906 ((void**)(image + sect->offset))[i] = addr;
3913 static unsigned long relocateAddress(
3916 struct section* sections,
3917 unsigned long address)
3920 for(i = 0; i < nSections; i++)
3922 if(sections[i].addr <= address
3923 && address < sections[i].addr + sections[i].size)
3925 return (unsigned long)oc->image
3926 + sections[i].offset + address - sections[i].addr;
3929 barf("Invalid Mach-O file:"
3930 "Address out of bounds while relocating object file");
3934 static int relocateSection(
3937 struct symtab_command *symLC, struct nlist *nlist,
3938 int nSections, struct section* sections, struct section *sect)
3940 struct relocation_info *relocs;
3943 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3945 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3947 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3949 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3953 relocs = (struct relocation_info*) (image + sect->reloff);
3957 #ifdef x86_64_HOST_ARCH
3958 struct relocation_info *reloc = &relocs[i];
3960 char *thingPtr = image + sect->offset + reloc->r_address;
3964 int type = reloc->r_type;
3966 checkProddableBlock(oc,thingPtr);
3967 switch(reloc->r_length)
3970 thing = *(uint8_t*)thingPtr;
3971 baseValue = (uint64_t)thingPtr + 1;
3974 thing = *(uint16_t*)thingPtr;
3975 baseValue = (uint64_t)thingPtr + 2;
3978 thing = *(uint32_t*)thingPtr;
3979 baseValue = (uint64_t)thingPtr + 4;
3982 thing = *(uint64_t*)thingPtr;
3983 baseValue = (uint64_t)thingPtr + 8;
3986 barf("Unknown size.");
3989 if(type == X86_64_RELOC_GOT
3990 || type == X86_64_RELOC_GOT_LOAD)
3992 ASSERT(reloc->r_extern);
3993 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
3995 type = X86_64_RELOC_SIGNED;
3997 else if(reloc->r_extern)
3999 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4000 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4001 if(symbol->n_value == 0)
4002 value = (uint64_t) lookupSymbol(nm);
4004 value = relocateAddress(oc, nSections, sections,
4009 value = sections[reloc->r_symbolnum-1].offset
4010 - sections[reloc->r_symbolnum-1].addr
4014 if(type == X86_64_RELOC_BRANCH)
4016 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4018 ASSERT(reloc->r_extern);
4019 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4022 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4023 type = X86_64_RELOC_SIGNED;
4028 case X86_64_RELOC_UNSIGNED:
4029 ASSERT(!reloc->r_pcrel);
4032 case X86_64_RELOC_SIGNED:
4033 ASSERT(reloc->r_pcrel);
4034 thing += value - baseValue;
4036 case X86_64_RELOC_SUBTRACTOR:
4037 ASSERT(!reloc->r_pcrel);
4041 barf("unkown relocation");
4044 switch(reloc->r_length)
4047 *(uint8_t*)thingPtr = thing;
4050 *(uint16_t*)thingPtr = thing;
4053 *(uint32_t*)thingPtr = thing;
4056 *(uint64_t*)thingPtr = thing;
4060 if(relocs[i].r_address & R_SCATTERED)
4062 struct scattered_relocation_info *scat =
4063 (struct scattered_relocation_info*) &relocs[i];
4067 if(scat->r_length == 2)
4069 unsigned long word = 0;
4070 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4071 checkProddableBlock(oc,wordPtr);
4073 // Note on relocation types:
4074 // i386 uses the GENERIC_RELOC_* types,
4075 // while ppc uses special PPC_RELOC_* types.
4076 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4077 // in both cases, all others are different.
4078 // Therefore, we use GENERIC_RELOC_VANILLA
4079 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4080 // and use #ifdefs for the other types.
4082 // Step 1: Figure out what the relocated value should be
4083 if(scat->r_type == GENERIC_RELOC_VANILLA)
4085 word = *wordPtr + (unsigned long) relocateAddress(
4092 #ifdef powerpc_HOST_ARCH
4093 else if(scat->r_type == PPC_RELOC_SECTDIFF
4094 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4095 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4096 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4098 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4101 struct scattered_relocation_info *pair =
4102 (struct scattered_relocation_info*) &relocs[i+1];
4104 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4105 barf("Invalid Mach-O file: "
4106 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4108 word = (unsigned long)
4109 (relocateAddress(oc, nSections, sections, scat->r_value)
4110 - relocateAddress(oc, nSections, sections, pair->r_value));
4113 #ifdef powerpc_HOST_ARCH
4114 else if(scat->r_type == PPC_RELOC_HI16
4115 || scat->r_type == PPC_RELOC_LO16
4116 || scat->r_type == PPC_RELOC_HA16
4117 || scat->r_type == PPC_RELOC_LO14)
4118 { // these are generated by label+offset things
4119 struct relocation_info *pair = &relocs[i+1];
4120 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4121 barf("Invalid Mach-O file: "
4122 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4124 if(scat->r_type == PPC_RELOC_LO16)
4126 word = ((unsigned short*) wordPtr)[1];
4127 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4129 else if(scat->r_type == PPC_RELOC_LO14)
4131 barf("Unsupported Relocation: PPC_RELOC_LO14");
4132 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4133 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4135 else if(scat->r_type == PPC_RELOC_HI16)
4137 word = ((unsigned short*) wordPtr)[1] << 16;
4138 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4140 else if(scat->r_type == PPC_RELOC_HA16)
4142 word = ((unsigned short*) wordPtr)[1] << 16;
4143 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4147 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4154 continue; // ignore the others
4156 #ifdef powerpc_HOST_ARCH
4157 if(scat->r_type == GENERIC_RELOC_VANILLA
4158 || scat->r_type == PPC_RELOC_SECTDIFF)
4160 if(scat->r_type == GENERIC_RELOC_VANILLA
4161 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4166 #ifdef powerpc_HOST_ARCH
4167 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4169 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4171 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4173 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4175 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4177 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4178 + ((word & (1<<15)) ? 1 : 0);
4184 continue; // FIXME: I hope it's OK to ignore all the others.
4188 struct relocation_info *reloc = &relocs[i];
4189 if(reloc->r_pcrel && !reloc->r_extern)
4192 if(reloc->r_length == 2)
4194 unsigned long word = 0;
4195 #ifdef powerpc_HOST_ARCH
4196 unsigned long jumpIsland = 0;
4197 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4198 // to avoid warning and to catch
4202 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4203 checkProddableBlock(oc,wordPtr);
4205 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4209 #ifdef powerpc_HOST_ARCH
4210 else if(reloc->r_type == PPC_RELOC_LO16)
4212 word = ((unsigned short*) wordPtr)[1];
4213 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4215 else if(reloc->r_type == PPC_RELOC_HI16)
4217 word = ((unsigned short*) wordPtr)[1] << 16;
4218 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4220 else if(reloc->r_type == PPC_RELOC_HA16)
4222 word = ((unsigned short*) wordPtr)[1] << 16;
4223 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4225 else if(reloc->r_type == PPC_RELOC_BR24)
4228 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4232 if(!reloc->r_extern)
4235 sections[reloc->r_symbolnum-1].offset
4236 - sections[reloc->r_symbolnum-1].addr
4243 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4244 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4245 void *symbolAddress = lookupSymbol(nm);
4248 errorBelch("\nunknown symbol `%s'", nm);
4254 #ifdef powerpc_HOST_ARCH
4255 // In the .o file, this should be a relative jump to NULL
4256 // and we'll change it to a relative jump to the symbol
4257 ASSERT(word + reloc->r_address == 0);
4258 jumpIsland = (unsigned long)
4259 &makeSymbolExtra(oc,
4261 (unsigned long) symbolAddress)
4265 offsetToJumpIsland = word + jumpIsland
4266 - (((long)image) + sect->offset - sect->addr);
4269 word += (unsigned long) symbolAddress
4270 - (((long)image) + sect->offset - sect->addr);
4274 word += (unsigned long) symbolAddress;
4278 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4283 #ifdef powerpc_HOST_ARCH
4284 else if(reloc->r_type == PPC_RELOC_LO16)
4286 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4289 else if(reloc->r_type == PPC_RELOC_HI16)
4291 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4294 else if(reloc->r_type == PPC_RELOC_HA16)
4296 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4297 + ((word & (1<<15)) ? 1 : 0);
4300 else if(reloc->r_type == PPC_RELOC_BR24)
4302 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4304 // The branch offset is too large.
4305 // Therefore, we try to use a jump island.
4308 barf("unconditional relative branch out of range: "
4309 "no jump island available");
4312 word = offsetToJumpIsland;
4313 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4314 barf("unconditional relative branch out of range: "
4315 "jump island out of range");
4317 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4322 barf("\nunknown relocation %d",reloc->r_type);
4330 static int ocGetNames_MachO(ObjectCode* oc)
4332 char *image = (char*) oc->image;
4333 struct mach_header *header = (struct mach_header*) image;
4334 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4335 unsigned i,curSymbol = 0;
4336 struct segment_command *segLC = NULL;
4337 struct section *sections;
4338 struct symtab_command *symLC = NULL;
4339 struct nlist *nlist;
4340 unsigned long commonSize = 0;
4341 char *commonStorage = NULL;
4342 unsigned long commonCounter;
4344 for(i=0;i<header->ncmds;i++)
4346 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4347 segLC = (struct segment_command*) lc;
4348 else if(lc->cmd == LC_SYMTAB)
4349 symLC = (struct symtab_command*) lc;
4350 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4353 sections = (struct section*) (segLC+1);
4354 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4358 barf("ocGetNames_MachO: no segment load command");
4360 for(i=0;i<segLC->nsects;i++)
4362 if(sections[i].size == 0)
4365 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4367 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4368 "ocGetNames_MachO(common symbols)");
4369 sections[i].offset = zeroFillArea - image;
4372 if(!strcmp(sections[i].sectname,"__text"))
4373 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4374 (void*) (image + sections[i].offset),
4375 (void*) (image + sections[i].offset + sections[i].size));
4376 else if(!strcmp(sections[i].sectname,"__const"))
4377 addSection(oc, SECTIONKIND_RWDATA,
4378 (void*) (image + sections[i].offset),
4379 (void*) (image + sections[i].offset + sections[i].size));
4380 else if(!strcmp(sections[i].sectname,"__data"))
4381 addSection(oc, SECTIONKIND_RWDATA,
4382 (void*) (image + sections[i].offset),
4383 (void*) (image + sections[i].offset + sections[i].size));
4384 else if(!strcmp(sections[i].sectname,"__bss")
4385 || !strcmp(sections[i].sectname,"__common"))
4386 addSection(oc, SECTIONKIND_RWDATA,
4387 (void*) (image + sections[i].offset),
4388 (void*) (image + sections[i].offset + sections[i].size));
4390 addProddableBlock(oc, (void*) (image + sections[i].offset),
4394 // count external symbols defined here
4398 for(i=0;i<symLC->nsyms;i++)
4400 if(nlist[i].n_type & N_STAB)
4402 else if(nlist[i].n_type & N_EXT)
4404 if((nlist[i].n_type & N_TYPE) == N_UNDF
4405 && (nlist[i].n_value != 0))
4407 commonSize += nlist[i].n_value;
4410 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4415 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4416 "ocGetNames_MachO(oc->symbols)");
4420 for(i=0;i<symLC->nsyms;i++)
4422 if(nlist[i].n_type & N_STAB)
4424 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4426 if(nlist[i].n_type & N_EXT)
4428 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4429 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4430 ; // weak definition, and we already have a definition
4433 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4435 + sections[nlist[i].n_sect-1].offset
4436 - sections[nlist[i].n_sect-1].addr
4437 + nlist[i].n_value);
4438 oc->symbols[curSymbol++] = nm;
4445 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4446 commonCounter = (unsigned long)commonStorage;
4449 for(i=0;i<symLC->nsyms;i++)
4451 if((nlist[i].n_type & N_TYPE) == N_UNDF
4452 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4454 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4455 unsigned long sz = nlist[i].n_value;
4457 nlist[i].n_value = commonCounter;
4459 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4460 (void*)commonCounter);
4461 oc->symbols[curSymbol++] = nm;
4463 commonCounter += sz;
4470 static int ocResolve_MachO(ObjectCode* oc)
4472 char *image = (char*) oc->image;
4473 struct mach_header *header = (struct mach_header*) image;
4474 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4476 struct segment_command *segLC = NULL;
4477 struct section *sections;
4478 struct symtab_command *symLC = NULL;
4479 struct dysymtab_command *dsymLC = NULL;
4480 struct nlist *nlist;
4482 for(i=0;i<header->ncmds;i++)
4484 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4485 segLC = (struct segment_command*) lc;
4486 else if(lc->cmd == LC_SYMTAB)
4487 symLC = (struct symtab_command*) lc;
4488 else if(lc->cmd == LC_DYSYMTAB)
4489 dsymLC = (struct dysymtab_command*) lc;
4490 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4493 sections = (struct section*) (segLC+1);
4494 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4499 unsigned long *indirectSyms
4500 = (unsigned long*) (image + dsymLC->indirectsymoff);
4502 for(i=0;i<segLC->nsects;i++)
4504 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4505 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4506 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4508 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4511 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4512 || !strcmp(sections[i].sectname,"__pointers"))
4514 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4517 else if(!strcmp(sections[i].sectname,"__jump_table"))
4519 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4525 for(i=0;i<segLC->nsects;i++)
4527 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4531 /* Free the local symbol table; we won't need it again. */
4532 freeHashTable(oc->lochash, NULL);
4535 #if defined (powerpc_HOST_ARCH)
4536 ocFlushInstructionCache( oc );
4542 #ifdef powerpc_HOST_ARCH
4544 * The Mach-O object format uses leading underscores. But not everywhere.
4545 * There is a small number of runtime support functions defined in
4546 * libcc_dynamic.a whose name does not have a leading underscore.
4547 * As a consequence, we can't get their address from C code.
4548 * We have to use inline assembler just to take the address of a function.
4552 static void machoInitSymbolsWithoutUnderscore()
4554 extern void* symbolsWithoutUnderscore[];
4555 void **p = symbolsWithoutUnderscore;
4556 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4560 __asm__ volatile(".long " # x);
4562 RTS_MACHO_NOUNDERLINE_SYMBOLS
4564 __asm__ volatile(".text");
4568 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4570 RTS_MACHO_NOUNDERLINE_SYMBOLS
4577 * Figure out by how much to shift the entire Mach-O file in memory
4578 * when loading so that its single segment ends up 16-byte-aligned
4580 static int machoGetMisalignment( FILE * f )
4582 struct mach_header header;
4585 fread(&header, sizeof(header), 1, f);
4588 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4589 if(header.magic != MH_MAGIC_64)
4592 if(header.magic != MH_MAGIC)
4596 misalignment = (header.sizeofcmds + sizeof(header))
4599 return misalignment ? (16 - misalignment) : 0;