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 \
177 SymX(shutdownHaskellAndSignal) \
180 SymX(signal_handlers) \
181 SymX(stg_sig_install) \
185 #if defined (cygwin32_HOST_OS)
186 #define RTS_MINGW_ONLY_SYMBOLS /**/
187 /* Don't have the ability to read import libs / archives, so
188 * we have to stupidly list a lot of what libcygwin.a
191 #define RTS_CYGWIN_ONLY_SYMBOLS \
269 #elif !defined(mingw32_HOST_OS)
270 #define RTS_MINGW_ONLY_SYMBOLS /**/
271 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
272 #else /* defined(mingw32_HOST_OS) */
273 #define RTS_POSIX_ONLY_SYMBOLS /**/
274 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
276 /* Extra syms gen'ed by mingw-2's gcc-3.2: */
278 #define RTS_MINGW_EXTRA_SYMS \
279 Sym(_imp____mb_cur_max) \
282 #define RTS_MINGW_EXTRA_SYMS
285 #if HAVE_GETTIMEOFDAY
286 #define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
288 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
291 /* These are statically linked from the mingw libraries into the ghc
292 executable, so we have to employ this hack. */
293 #define RTS_MINGW_ONLY_SYMBOLS \
294 SymX(asyncReadzh_fast) \
295 SymX(asyncWritezh_fast) \
296 SymX(asyncDoProczh_fast) \
308 SymX(getservbyname) \
309 SymX(getservbyport) \
310 SymX(getprotobynumber) \
311 SymX(getprotobyname) \
312 SymX(gethostbyname) \
313 SymX(gethostbyaddr) \
360 SymX(rts_InstallConsoleEvent) \
361 SymX(rts_ConsoleHandlerDone) \
363 Sym(_imp___timezone) \
373 RTS_MINGW_EXTRA_SYMS \
374 RTS_MINGW_GETTIMEOFDAY_SYM \
378 #if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
379 #define RTS_DARWIN_ONLY_SYMBOLS \
380 Sym(asprintf$LDBLStub) \
384 Sym(fprintf$LDBLStub) \
385 Sym(fscanf$LDBLStub) \
386 Sym(fwprintf$LDBLStub) \
387 Sym(fwscanf$LDBLStub) \
388 Sym(printf$LDBLStub) \
389 Sym(scanf$LDBLStub) \
390 Sym(snprintf$LDBLStub) \
391 Sym(sprintf$LDBLStub) \
392 Sym(sscanf$LDBLStub) \
393 Sym(strtold$LDBLStub) \
394 Sym(swprintf$LDBLStub) \
395 Sym(swscanf$LDBLStub) \
396 Sym(syslog$LDBLStub) \
397 Sym(vasprintf$LDBLStub) \
399 Sym(verrc$LDBLStub) \
400 Sym(verrx$LDBLStub) \
401 Sym(vfprintf$LDBLStub) \
402 Sym(vfscanf$LDBLStub) \
403 Sym(vfwprintf$LDBLStub) \
404 Sym(vfwscanf$LDBLStub) \
405 Sym(vprintf$LDBLStub) \
406 Sym(vscanf$LDBLStub) \
407 Sym(vsnprintf$LDBLStub) \
408 Sym(vsprintf$LDBLStub) \
409 Sym(vsscanf$LDBLStub) \
410 Sym(vswprintf$LDBLStub) \
411 Sym(vswscanf$LDBLStub) \
412 Sym(vsyslog$LDBLStub) \
413 Sym(vwarn$LDBLStub) \
414 Sym(vwarnc$LDBLStub) \
415 Sym(vwarnx$LDBLStub) \
416 Sym(vwprintf$LDBLStub) \
417 Sym(vwscanf$LDBLStub) \
419 Sym(warnc$LDBLStub) \
420 Sym(warnx$LDBLStub) \
421 Sym(wcstold$LDBLStub) \
422 Sym(wprintf$LDBLStub) \
425 #define RTS_DARWIN_ONLY_SYMBOLS
429 # define MAIN_CAP_SYM SymX(MainCapability)
431 # define MAIN_CAP_SYM
434 #if !defined(mingw32_HOST_OS)
435 #define RTS_USER_SIGNALS_SYMBOLS \
436 SymX(setIOManagerPipe)
438 #define RTS_USER_SIGNALS_SYMBOLS \
439 SymX(sendIOManagerEvent) \
440 SymX(readIOManagerEvent) \
441 SymX(getIOManagerEvent) \
442 SymX(console_handler)
445 #define RTS_LIBFFI_SYMBOLS \
449 Sym(ffi_type_float) \
450 Sym(ffi_type_double) \
451 Sym(ffi_type_sint64) \
452 Sym(ffi_type_uint64) \
453 Sym(ffi_type_sint32) \
454 Sym(ffi_type_uint32) \
455 Sym(ffi_type_sint16) \
456 Sym(ffi_type_uint16) \
457 Sym(ffi_type_sint8) \
458 Sym(ffi_type_uint8) \
459 Sym(ffi_type_pointer)
461 #ifdef TABLES_NEXT_TO_CODE
462 #define RTS_RET_SYMBOLS /* nothing */
464 #define RTS_RET_SYMBOLS \
465 SymX(stg_enter_ret) \
466 SymX(stg_gc_fun_ret) \
473 SymX(stg_ap_pv_ret) \
474 SymX(stg_ap_pp_ret) \
475 SymX(stg_ap_ppv_ret) \
476 SymX(stg_ap_ppp_ret) \
477 SymX(stg_ap_pppv_ret) \
478 SymX(stg_ap_pppp_ret) \
479 SymX(stg_ap_ppppp_ret) \
480 SymX(stg_ap_pppppp_ret)
483 /* On Windows, we link libgmp.a statically into libHSrts.dll */
484 #ifdef mingw32_HOST_OS
487 SymX(__gmpz_cmp_si) \
488 SymX(__gmpz_cmp_ui) \
489 SymX(__gmpz_get_si) \
493 SymExtern(__gmpz_cmp) \
494 SymExtern(__gmpz_cmp_si) \
495 SymExtern(__gmpz_cmp_ui) \
496 SymExtern(__gmpz_get_si) \
497 SymExtern(__gmpz_get_ui)
500 #define RTS_SYMBOLS \
503 SymX(stg_enter_info) \
504 SymX(stg_gc_void_info) \
505 SymX(__stg_gc_enter_1) \
506 SymX(stg_gc_noregs) \
507 SymX(stg_gc_unpt_r1_info) \
508 SymX(stg_gc_unpt_r1) \
509 SymX(stg_gc_unbx_r1_info) \
510 SymX(stg_gc_unbx_r1) \
511 SymX(stg_gc_f1_info) \
513 SymX(stg_gc_d1_info) \
515 SymX(stg_gc_l1_info) \
518 SymX(stg_gc_fun_info) \
520 SymX(stg_gc_gen_info) \
521 SymX(stg_gc_gen_hp) \
523 SymX(stg_gen_yield) \
524 SymX(stg_yield_noregs) \
525 SymX(stg_yield_to_interpreter) \
526 SymX(stg_gen_block) \
527 SymX(stg_block_noregs) \
529 SymX(stg_block_takemvar) \
530 SymX(stg_block_putmvar) \
532 SymX(MallocFailHook) \
534 SymX(OutOfHeapHook) \
535 SymX(StackOverflowHook) \
536 SymX(__encodeDouble) \
537 SymX(__encodeFloat) \
540 SymX(__int_encodeDouble) \
541 SymX(__word_encodeDouble) \
542 SymX(__2Int_encodeDouble) \
543 SymX(__int_encodeFloat) \
544 SymX(__word_encodeFloat) \
545 SymX(andIntegerzh_fast) \
546 SymX(atomicallyzh_fast) \
550 SymX(asyncExceptionsBlockedzh_fast) \
551 SymX(blockAsyncExceptionszh_fast) \
553 SymX(catchRetryzh_fast) \
554 SymX(catchSTMzh_fast) \
556 SymX(closure_flags) \
558 SymX(cmpIntegerzh_fast) \
559 SymX(cmpIntegerIntzh_fast) \
560 SymX(complementIntegerzh_fast) \
561 SymX(createAdjustor) \
562 SymX(decodeDoublezh_fast) \
563 SymX(decodeFloatzh_fast) \
564 SymX(decodeDoublezu2Intzh_fast) \
565 SymX(decodeFloatzuIntzh_fast) \
568 SymX(deRefWeakzh_fast) \
569 SymX(deRefStablePtrzh_fast) \
570 SymX(dirty_MUT_VAR) \
571 SymX(divExactIntegerzh_fast) \
572 SymX(divModIntegerzh_fast) \
574 SymX(forkOnzh_fast) \
576 SymX(forkOS_createThread) \
577 SymX(freeHaskellFunctionPtr) \
578 SymX(freeStablePtr) \
579 SymX(getOrSetTypeableStore) \
580 SymX(gcdIntegerzh_fast) \
581 SymX(gcdIntegerIntzh_fast) \
582 SymX(gcdIntzh_fast) \
586 SymX(getFullProgArgv) \
592 SymX(hs_perform_gc) \
593 SymX(hs_free_stable_ptr) \
594 SymX(hs_free_fun_ptr) \
595 SymX(hs_hpc_rootModule) \
597 SymX(unpackClosurezh_fast) \
598 SymX(getApStackValzh_fast) \
599 SymX(int2Integerzh_fast) \
600 SymX(integer2Intzh_fast) \
601 SymX(integer2Wordzh_fast) \
602 SymX(isCurrentThreadBoundzh_fast) \
603 SymX(isDoubleDenormalized) \
604 SymX(isDoubleInfinite) \
606 SymX(isDoubleNegativeZero) \
607 SymX(isEmptyMVarzh_fast) \
608 SymX(isFloatDenormalized) \
609 SymX(isFloatInfinite) \
611 SymX(isFloatNegativeZero) \
612 SymX(killThreadzh_fast) \
614 SymX(insertStableSymbol) \
617 SymX(makeStablePtrzh_fast) \
618 SymX(minusIntegerzh_fast) \
619 SymX(mkApUpd0zh_fast) \
620 SymX(myThreadIdzh_fast) \
621 SymX(labelThreadzh_fast) \
622 SymX(newArrayzh_fast) \
623 SymX(newBCOzh_fast) \
624 SymX(newByteArrayzh_fast) \
625 SymX_redirect(newCAF, newDynCAF) \
626 SymX(newMVarzh_fast) \
627 SymX(newMutVarzh_fast) \
628 SymX(newTVarzh_fast) \
629 SymX(noDuplicatezh_fast) \
630 SymX(atomicModifyMutVarzh_fast) \
631 SymX(newPinnedByteArrayzh_fast) \
633 SymX(orIntegerzh_fast) \
635 SymX(performMajorGC) \
636 SymX(plusIntegerzh_fast) \
639 SymX(putMVarzh_fast) \
640 SymX(quotIntegerzh_fast) \
641 SymX(quotRemIntegerzh_fast) \
643 SymX(raiseIOzh_fast) \
644 SymX(readTVarzh_fast) \
645 SymX(remIntegerzh_fast) \
646 SymX(resetNonBlockingFd) \
651 SymX(rts_checkSchedStatus) \
654 SymX(rts_evalLazyIO) \
655 SymX(rts_evalStableIO) \
659 SymX(rts_getDouble) \
667 SymX(rts_getFunPtr) \
668 SymX(rts_getStablePtr) \
669 SymX(rts_getThreadId) \
672 SymX(rts_getWord16) \
673 SymX(rts_getWord32) \
674 SymX(rts_getWord64) \
687 SymX(rts_mkStablePtr) \
695 SymX(rtsSupportsBoundThreads) \
696 SymX(__hscore_get_saved_termios) \
697 SymX(__hscore_set_saved_termios) \
699 SymX(startupHaskell) \
700 SymX(shutdownHaskell) \
701 SymX(shutdownHaskellAndExit) \
702 SymX(stable_ptr_table) \
703 SymX(stackOverflow) \
704 SymX(stg_CAF_BLACKHOLE_info) \
705 SymX(awakenBlockedQueue) \
706 SymX(stg_CHARLIKE_closure) \
707 SymX(stg_MVAR_CLEAN_info) \
708 SymX(stg_MVAR_DIRTY_info) \
709 SymX(stg_IND_STATIC_info) \
710 SymX(stg_INTLIKE_closure) \
711 SymX(stg_MUT_ARR_PTRS_DIRTY_info) \
712 SymX(stg_MUT_ARR_PTRS_FROZEN_info) \
713 SymX(stg_MUT_ARR_PTRS_FROZEN0_info) \
714 SymX(stg_WEAK_info) \
715 SymX(stg_ap_v_info) \
716 SymX(stg_ap_f_info) \
717 SymX(stg_ap_d_info) \
718 SymX(stg_ap_l_info) \
719 SymX(stg_ap_n_info) \
720 SymX(stg_ap_p_info) \
721 SymX(stg_ap_pv_info) \
722 SymX(stg_ap_pp_info) \
723 SymX(stg_ap_ppv_info) \
724 SymX(stg_ap_ppp_info) \
725 SymX(stg_ap_pppv_info) \
726 SymX(stg_ap_pppp_info) \
727 SymX(stg_ap_ppppp_info) \
728 SymX(stg_ap_pppppp_info) \
729 SymX(stg_ap_0_fast) \
730 SymX(stg_ap_v_fast) \
731 SymX(stg_ap_f_fast) \
732 SymX(stg_ap_d_fast) \
733 SymX(stg_ap_l_fast) \
734 SymX(stg_ap_n_fast) \
735 SymX(stg_ap_p_fast) \
736 SymX(stg_ap_pv_fast) \
737 SymX(stg_ap_pp_fast) \
738 SymX(stg_ap_ppv_fast) \
739 SymX(stg_ap_ppp_fast) \
740 SymX(stg_ap_pppv_fast) \
741 SymX(stg_ap_pppp_fast) \
742 SymX(stg_ap_ppppp_fast) \
743 SymX(stg_ap_pppppp_fast) \
744 SymX(stg_ap_1_upd_info) \
745 SymX(stg_ap_2_upd_info) \
746 SymX(stg_ap_3_upd_info) \
747 SymX(stg_ap_4_upd_info) \
748 SymX(stg_ap_5_upd_info) \
749 SymX(stg_ap_6_upd_info) \
750 SymX(stg_ap_7_upd_info) \
752 SymX(stg_sel_0_upd_info) \
753 SymX(stg_sel_10_upd_info) \
754 SymX(stg_sel_11_upd_info) \
755 SymX(stg_sel_12_upd_info) \
756 SymX(stg_sel_13_upd_info) \
757 SymX(stg_sel_14_upd_info) \
758 SymX(stg_sel_15_upd_info) \
759 SymX(stg_sel_1_upd_info) \
760 SymX(stg_sel_2_upd_info) \
761 SymX(stg_sel_3_upd_info) \
762 SymX(stg_sel_4_upd_info) \
763 SymX(stg_sel_5_upd_info) \
764 SymX(stg_sel_6_upd_info) \
765 SymX(stg_sel_7_upd_info) \
766 SymX(stg_sel_8_upd_info) \
767 SymX(stg_sel_9_upd_info) \
768 SymX(stg_upd_frame_info) \
769 SymX(suspendThread) \
770 SymX(takeMVarzh_fast) \
771 SymX(threadStatuszh_fast) \
772 SymX(timesIntegerzh_fast) \
773 SymX(tryPutMVarzh_fast) \
774 SymX(tryTakeMVarzh_fast) \
775 SymX(unblockAsyncExceptionszh_fast) \
777 SymX(unsafeThawArrayzh_fast) \
778 SymX(waitReadzh_fast) \
779 SymX(waitWritezh_fast) \
780 SymX(word2Integerzh_fast) \
781 SymX(writeTVarzh_fast) \
782 SymX(xorIntegerzh_fast) \
784 Sym(stg_interp_constr_entry) \
787 SymX(getAllocations) \
790 Sym(rts_breakpoint_io_action) \
791 Sym(rts_stop_next_breakpoint) \
792 Sym(rts_stop_on_exception) \
794 SymX(n_capabilities) \
795 RTS_USER_SIGNALS_SYMBOLS
797 #ifdef SUPPORT_LONG_LONGS
798 #define RTS_LONG_LONG_SYMS \
799 SymX(int64ToIntegerzh_fast) \
800 SymX(word64ToIntegerzh_fast)
802 #define RTS_LONG_LONG_SYMS /* nothing */
805 // 64-bit support functions in libgcc.a
806 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
807 #define RTS_LIBGCC_SYMBOLS \
817 #elif defined(ia64_HOST_ARCH)
818 #define RTS_LIBGCC_SYMBOLS \
826 #define RTS_LIBGCC_SYMBOLS
829 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
830 // Symbols that don't have a leading underscore
831 // on Mac OS X. They have to receive special treatment,
832 // see machoInitSymbolsWithoutUnderscore()
833 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
838 /* entirely bogus claims about types of these symbols */
839 #define Sym(vvv) extern void vvv(void);
840 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
841 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
843 #define SymExtern(vvv) SymX(vvv)
845 #define SymX(vvv) /**/
846 #define SymX_redirect(vvv,xxx) /**/
850 RTS_POSIX_ONLY_SYMBOLS
851 RTS_MINGW_ONLY_SYMBOLS
852 RTS_CYGWIN_ONLY_SYMBOLS
853 RTS_DARWIN_ONLY_SYMBOLS
861 #ifdef LEADING_UNDERSCORE
862 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
864 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
867 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
869 #define SymX(vvv) Sym(vvv)
870 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
871 (void*)DLL_IMPORT_DATA_REF(vvv) },
873 // SymX_redirect allows us to redirect references to one symbol to
874 // another symbol. See newCAF/newDynCAF for an example.
875 #define SymX_redirect(vvv,xxx) \
876 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
879 static RtsSymbolVal rtsSyms[] = {
883 RTS_POSIX_ONLY_SYMBOLS
884 RTS_MINGW_ONLY_SYMBOLS
885 RTS_CYGWIN_ONLY_SYMBOLS
886 RTS_DARWIN_ONLY_SYMBOLS
889 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
890 // dyld stub code contains references to this,
891 // but it should never be called because we treat
892 // lazy pointers as nonlazy.
893 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
895 { 0, 0 } /* sentinel */
900 /* -----------------------------------------------------------------------------
901 * Insert symbols into hash tables, checking for duplicates.
904 static void ghciInsertStrHashTable ( char* obj_name,
910 if (lookupHashTable(table, (StgWord)key) == NULL)
912 insertStrHashTable(table, (StgWord)key, data);
917 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
919 "whilst processing object file\n"
921 "This could be caused by:\n"
922 " * Loading two different object files which export the same symbol\n"
923 " * Specifying the same object file twice on the GHCi command line\n"
924 " * An incorrect `package.conf' entry, causing some object to be\n"
926 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
933 /* -----------------------------------------------------------------------------
934 * initialize the object linker
938 static int linker_init_done = 0 ;
940 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
941 static void *dl_prog_handle;
949 /* Make initLinker idempotent, so we can call it
950 before evey relevant operation; that means we
951 don't need to initialise the linker separately */
952 if (linker_init_done == 1) { return; } else {
953 linker_init_done = 1;
956 stablehash = allocStrHashTable();
957 symhash = allocStrHashTable();
959 /* populate the symbol table with stuff from the RTS */
960 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
961 ghciInsertStrHashTable("(GHCi built-in symbols)",
962 symhash, sym->lbl, sym->addr);
964 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
965 machoInitSymbolsWithoutUnderscore();
968 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
969 # if defined(RTLD_DEFAULT)
970 dl_prog_handle = RTLD_DEFAULT;
972 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
973 # endif /* RTLD_DEFAULT */
977 /* -----------------------------------------------------------------------------
978 * Loading DLL or .so dynamic libraries
979 * -----------------------------------------------------------------------------
981 * Add a DLL from which symbols may be found. In the ELF case, just
982 * do RTLD_GLOBAL-style add, so no further messing around needs to
983 * happen in order that symbols in the loaded .so are findable --
984 * lookupSymbol() will subsequently see them by dlsym on the program's
985 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
987 * In the PEi386 case, open the DLLs and put handles to them in a
988 * linked list. When looking for a symbol, try all handles in the
989 * list. This means that we need to load even DLLs that are guaranteed
990 * to be in the ghc.exe image already, just so we can get a handle
991 * to give to loadSymbol, so that we can find the symbols. For such
992 * libraries, the LoadLibrary call should be a no-op except for returning
997 #if defined(OBJFORMAT_PEi386)
998 /* A record for storing handles into DLLs. */
1003 struct _OpenedDLL* next;
1008 /* A list thereof. */
1009 static OpenedDLL* opened_dlls = NULL;
1013 addDLL( char *dll_name )
1015 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1016 /* ------------------- ELF DLL loader ------------------- */
1022 hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
1025 /* dlopen failed; return a ptr to the error msg. */
1027 if (errmsg == NULL) errmsg = "addDLL: unknown error";
1034 # elif defined(OBJFORMAT_PEi386)
1035 /* ------------------- Win32 DLL loader ------------------- */
1043 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1045 /* See if we've already got it, and ignore if so. */
1046 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1047 if (0 == strcmp(o_dll->name, dll_name))
1051 /* The file name has no suffix (yet) so that we can try
1052 both foo.dll and foo.drv
1054 The documentation for LoadLibrary says:
1055 If no file name extension is specified in the lpFileName
1056 parameter, the default library extension .dll is
1057 appended. However, the file name string can include a trailing
1058 point character (.) to indicate that the module name has no
1061 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1062 sprintf(buf, "%s.DLL", dll_name);
1063 instance = LoadLibrary(buf);
1064 if (instance == NULL) {
1065 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1066 instance = LoadLibrary(buf);
1067 if (instance == NULL) {
1070 /* LoadLibrary failed; return a ptr to the error msg. */
1071 return "addDLL: unknown error";
1076 /* Add this DLL to the list of DLLs in which to search for symbols. */
1077 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1078 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1079 strcpy(o_dll->name, dll_name);
1080 o_dll->instance = instance;
1081 o_dll->next = opened_dlls;
1082 opened_dlls = o_dll;
1086 barf("addDLL: not implemented on this platform");
1090 /* -----------------------------------------------------------------------------
1091 * insert a stable symbol in the hash table
1095 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1097 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1101 /* -----------------------------------------------------------------------------
1102 * insert a symbol in the hash table
1105 insertSymbol(char* obj_name, char* key, void* data)
1107 ghciInsertStrHashTable(obj_name, symhash, key, data);
1110 /* -----------------------------------------------------------------------------
1111 * lookup a symbol in the hash table
1114 lookupSymbol( char *lbl )
1118 ASSERT(symhash != NULL);
1119 val = lookupStrHashTable(symhash, lbl);
1122 # if defined(OBJFORMAT_ELF)
1123 return dlsym(dl_prog_handle, lbl);
1124 # elif defined(OBJFORMAT_MACHO)
1126 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1129 HACK: On OS X, global symbols are prefixed with an underscore.
1130 However, dlsym wants us to omit the leading underscore from the
1131 symbol name. For now, we simply strip it off here (and ONLY
1134 ASSERT(lbl[0] == '_');
1135 return dlsym(dl_prog_handle, lbl+1);
1137 if(NSIsSymbolNameDefined(lbl)) {
1138 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1139 return NSAddressOfSymbol(symbol);
1143 # endif /* HAVE_DLFCN_H */
1144 # elif defined(OBJFORMAT_PEi386)
1147 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1148 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1149 if (lbl[0] == '_') {
1150 /* HACK: if the name has an initial underscore, try stripping
1151 it off & look that up first. I've yet to verify whether there's
1152 a Rule that governs whether an initial '_' *should always* be
1153 stripped off when mapping from import lib name to the DLL name.
1155 sym = GetProcAddress(o_dll->instance, (lbl+1));
1157 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1161 sym = GetProcAddress(o_dll->instance, lbl);
1163 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1178 __attribute((unused))
1180 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1184 val = lookupStrHashTable(oc->lochash, lbl);
1194 /* -----------------------------------------------------------------------------
1195 * Debugging aid: look in GHCi's object symbol tables for symbols
1196 * within DELTA bytes of the specified address, and show their names.
1199 void ghci_enquire ( char* addr );
1201 void ghci_enquire ( char* addr )
1206 const int DELTA = 64;
1211 for (oc = objects; oc; oc = oc->next) {
1212 for (i = 0; i < oc->n_symbols; i++) {
1213 sym = oc->symbols[i];
1214 if (sym == NULL) continue;
1215 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1217 if (oc->lochash != NULL) {
1218 a = lookupStrHashTable(oc->lochash, sym);
1221 a = lookupStrHashTable(symhash, sym);
1224 // debugBelch("ghci_enquire: can't find %s\n", sym);
1226 else if (addr-DELTA <= a && a <= addr+DELTA) {
1227 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1234 #ifdef ia64_HOST_ARCH
1235 static unsigned int PLTSize(void);
1238 /* -----------------------------------------------------------------------------
1239 * Load an obj (populate the global symbol table, but don't resolve yet)
1241 * Returns: 1 if ok, 0 on error.
1244 loadObj( char *path )
1251 void *map_addr = NULL;
1257 /* debugBelch("loadObj %s\n", path ); */
1259 /* Check that we haven't already loaded this object.
1260 Ignore requests to load multiple times */
1264 for (o = objects; o; o = o->next) {
1265 if (0 == strcmp(o->fileName, path)) {
1267 break; /* don't need to search further */
1271 IF_DEBUG(linker, debugBelch(
1272 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1273 "same object file twice:\n"
1275 "GHCi will ignore this, but be warned.\n"
1277 return 1; /* success */
1281 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1283 # if defined(OBJFORMAT_ELF)
1284 oc->formatName = "ELF";
1285 # elif defined(OBJFORMAT_PEi386)
1286 oc->formatName = "PEi386";
1287 # elif defined(OBJFORMAT_MACHO)
1288 oc->formatName = "Mach-O";
1291 barf("loadObj: not implemented on this platform");
1294 r = stat(path, &st);
1295 if (r == -1) { return 0; }
1297 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1298 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1299 strcpy(oc->fileName, path);
1301 oc->fileSize = st.st_size;
1303 oc->sections = NULL;
1304 oc->lochash = allocStrHashTable();
1305 oc->proddables = NULL;
1307 /* chain it onto the list of objects */
1312 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1314 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1316 #if defined(openbsd_HOST_OS)
1317 fd = open(path, O_RDONLY, S_IRUSR);
1319 fd = open(path, O_RDONLY);
1322 barf("loadObj: can't open `%s'", path);
1324 pagesize = getpagesize();
1326 #ifdef ia64_HOST_ARCH
1327 /* The PLT needs to be right before the object */
1328 n = ROUND_UP(PLTSize(), pagesize);
1329 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1330 if (oc->plt == MAP_FAILED)
1331 barf("loadObj: can't allocate PLT");
1334 map_addr = oc->plt + n;
1337 n = ROUND_UP(oc->fileSize, pagesize);
1339 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1340 * small memory model on this architecture (see gcc docs,
1343 * MAP_32BIT not available on OpenBSD/amd64
1345 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
1346 #define EXTRA_MAP_FLAGS MAP_32BIT
1348 #define EXTRA_MAP_FLAGS 0
1351 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
1352 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
1353 #define MAP_ANONYMOUS MAP_ANON
1356 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1357 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1358 if (oc->image == MAP_FAILED)
1359 barf("loadObj: can't map `%s'", path);
1363 #else /* !USE_MMAP */
1365 /* load the image into memory */
1366 f = fopen(path, "rb");
1368 barf("loadObj: can't read `%s'", path);
1370 # if defined(mingw32_HOST_OS)
1371 // TODO: We would like to use allocateExec here, but allocateExec
1372 // cannot currently allocate blocks large enough.
1373 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1374 PAGE_EXECUTE_READWRITE);
1375 # elif defined(darwin_HOST_OS)
1376 // In a Mach-O .o file, all sections can and will be misaligned
1377 // if the total size of the headers is not a multiple of the
1378 // desired alignment. This is fine for .o files that only serve
1379 // as input for the static linker, but it's not fine for us,
1380 // as SSE (used by gcc for floating point) and Altivec require
1381 // 16-byte alignment.
1382 // We calculate the correct alignment from the header before
1383 // reading the file, and then we misalign oc->image on purpose so
1384 // that the actual sections end up aligned again.
1385 oc->misalignment = machoGetMisalignment(f);
1386 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1387 oc->image += oc->misalignment;
1389 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1392 n = fread ( oc->image, 1, oc->fileSize, f );
1393 if (n != oc->fileSize)
1394 barf("loadObj: error whilst reading `%s'", path);
1397 #endif /* USE_MMAP */
1399 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1400 r = ocAllocateSymbolExtras_MachO ( oc );
1401 if (!r) { return r; }
1402 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1403 r = ocAllocateSymbolExtras_ELF ( oc );
1404 if (!r) { return r; }
1407 /* verify the in-memory image */
1408 # if defined(OBJFORMAT_ELF)
1409 r = ocVerifyImage_ELF ( oc );
1410 # elif defined(OBJFORMAT_PEi386)
1411 r = ocVerifyImage_PEi386 ( oc );
1412 # elif defined(OBJFORMAT_MACHO)
1413 r = ocVerifyImage_MachO ( oc );
1415 barf("loadObj: no verify method");
1417 if (!r) { return r; }
1419 /* build the symbol list for this image */
1420 # if defined(OBJFORMAT_ELF)
1421 r = ocGetNames_ELF ( oc );
1422 # elif defined(OBJFORMAT_PEi386)
1423 r = ocGetNames_PEi386 ( oc );
1424 # elif defined(OBJFORMAT_MACHO)
1425 r = ocGetNames_MachO ( oc );
1427 barf("loadObj: no getNames method");
1429 if (!r) { return r; }
1431 /* loaded, but not resolved yet */
1432 oc->status = OBJECT_LOADED;
1437 /* -----------------------------------------------------------------------------
1438 * resolve all the currently unlinked objects in memory
1440 * Returns: 1 if ok, 0 on error.
1450 for (oc = objects; oc; oc = oc->next) {
1451 if (oc->status != OBJECT_RESOLVED) {
1452 # if defined(OBJFORMAT_ELF)
1453 r = ocResolve_ELF ( oc );
1454 # elif defined(OBJFORMAT_PEi386)
1455 r = ocResolve_PEi386 ( oc );
1456 # elif defined(OBJFORMAT_MACHO)
1457 r = ocResolve_MachO ( oc );
1459 barf("resolveObjs: not implemented on this platform");
1461 if (!r) { return r; }
1462 oc->status = OBJECT_RESOLVED;
1468 /* -----------------------------------------------------------------------------
1469 * delete an object from the pool
1472 unloadObj( char *path )
1474 ObjectCode *oc, *prev;
1476 ASSERT(symhash != NULL);
1477 ASSERT(objects != NULL);
1482 for (oc = objects; oc; prev = oc, oc = oc->next) {
1483 if (!strcmp(oc->fileName,path)) {
1485 /* Remove all the mappings for the symbols within this
1490 for (i = 0; i < oc->n_symbols; i++) {
1491 if (oc->symbols[i] != NULL) {
1492 removeStrHashTable(symhash, oc->symbols[i], NULL);
1500 prev->next = oc->next;
1503 // We're going to leave this in place, in case there are
1504 // any pointers from the heap into it:
1505 // #ifdef mingw32_HOST_OS
1506 // VirtualFree(oc->image);
1508 // stgFree(oc->image);
1510 stgFree(oc->fileName);
1511 stgFree(oc->symbols);
1512 stgFree(oc->sections);
1513 /* The local hash table should have been freed at the end
1514 of the ocResolve_ call on it. */
1515 ASSERT(oc->lochash == NULL);
1521 errorBelch("unloadObj: can't find `%s' to unload", path);
1525 /* -----------------------------------------------------------------------------
1526 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1527 * which may be prodded during relocation, and abort if we try and write
1528 * outside any of these.
1530 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1533 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1534 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1538 pb->next = oc->proddables;
1539 oc->proddables = pb;
1542 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1545 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1546 char* s = (char*)(pb->start);
1547 char* e = s + pb->size - 1;
1548 char* a = (char*)addr;
1549 /* Assumes that the biggest fixup involves a 4-byte write. This
1550 probably needs to be changed to 8 (ie, +7) on 64-bit
1552 if (a >= s && (a+3) <= e) return;
1554 barf("checkProddableBlock: invalid fixup in runtime linker");
1557 /* -----------------------------------------------------------------------------
1558 * Section management.
1560 static void addSection ( ObjectCode* oc, SectionKind kind,
1561 void* start, void* end )
1563 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1567 s->next = oc->sections;
1570 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1571 start, ((char*)end)-1, end - start + 1, kind );
1576 /* --------------------------------------------------------------------------
1578 * This is about allocating a small chunk of memory for every symbol in the
1579 * object file. We make sure that the SymboLExtras are always "in range" of
1580 * limited-range PC-relative instructions on various platforms by allocating
1581 * them right next to the object code itself.
1584 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
1587 ocAllocateSymbolExtras
1589 Allocate additional space at the end of the object file image to make room
1590 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1592 PowerPC relative branch instructions have a 24 bit displacement field.
1593 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1594 If a particular imported symbol is outside this range, we have to redirect
1595 the jump to a short piece of new code that just loads the 32bit absolute
1596 address and jumps there.
1597 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1600 This function just allocates space for one SymbolExtra for every
1601 undefined symbol in the object file. The code for the jump islands is
1602 filled in by makeSymbolExtra below.
1605 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1612 int misalignment = 0;
1613 #ifdef darwin_HOST_OS
1614 misalignment = oc->misalignment;
1620 // round up to the nearest 4
1621 aligned = (oc->fileSize + 3) & ~3;
1624 #ifndef linux_HOST_OS /* mremap is a linux extension */
1625 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1628 pagesize = getpagesize();
1629 n = ROUND_UP( oc->fileSize, pagesize );
1630 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1632 /* If we have a half-page-size file and map one page of it then
1633 * the part of the page after the size of the file remains accessible.
1634 * If, however, we map in 2 pages, the 2nd page is not accessible
1635 * and will give a "Bus Error" on access. To get around this, we check
1636 * if we need any extra pages for the jump islands and map them in
1637 * anonymously. We must check that we actually require extra pages
1638 * otherwise the attempt to mmap 0 pages of anonymous memory will
1644 /* The effect of this mremap() call is only the ensure that we have
1645 * a sufficient number of virtually contiguous pages. As returned from
1646 * mremap, the pages past the end of the file are not backed. We give
1647 * them a backing by using MAP_FIXED to map in anonymous pages.
1649 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1651 if( oc->image == MAP_FAILED )
1653 errorBelch( "Unable to mremap for Jump Islands\n" );
1657 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1658 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1660 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1666 oc->image -= misalignment;
1667 oc->image = stgReallocBytes( oc->image,
1669 aligned + sizeof (SymbolExtra) * count,
1670 "ocAllocateSymbolExtras" );
1671 oc->image += misalignment;
1672 #endif /* USE_MMAP */
1674 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1675 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1678 oc->symbol_extras = NULL;
1680 oc->first_symbol_extra = first;
1681 oc->n_symbol_extras = count;
1686 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1687 unsigned long symbolNumber,
1688 unsigned long target )
1692 ASSERT( symbolNumber >= oc->first_symbol_extra
1693 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1695 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1697 #ifdef powerpc_HOST_ARCH
1698 // lis r12, hi16(target)
1699 extra->jumpIsland.lis_r12 = 0x3d80;
1700 extra->jumpIsland.hi_addr = target >> 16;
1702 // ori r12, r12, lo16(target)
1703 extra->jumpIsland.ori_r12_r12 = 0x618c;
1704 extra->jumpIsland.lo_addr = target & 0xffff;
1707 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1710 extra->jumpIsland.bctr = 0x4e800420;
1712 #ifdef x86_64_HOST_ARCH
1714 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1715 extra->addr = target;
1716 memcpy(extra->jumpIsland, jmp, 6);
1724 /* --------------------------------------------------------------------------
1725 * PowerPC specifics (instruction cache flushing)
1726 * ------------------------------------------------------------------------*/
1728 #ifdef powerpc_TARGET_ARCH
1730 ocFlushInstructionCache
1732 Flush the data & instruction caches.
1733 Because the PPC has split data/instruction caches, we have to
1734 do that whenever we modify code at runtime.
1737 static void ocFlushInstructionCache( ObjectCode *oc )
1739 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1740 unsigned long *p = (unsigned long *) oc->image;
1744 __asm__ volatile ( "dcbf 0,%0\n\t"
1752 __asm__ volatile ( "sync\n\t"
1758 /* --------------------------------------------------------------------------
1759 * PEi386 specifics (Win32 targets)
1760 * ------------------------------------------------------------------------*/
1762 /* The information for this linker comes from
1763 Microsoft Portable Executable
1764 and Common Object File Format Specification
1765 revision 5.1 January 1998
1766 which SimonM says comes from the MS Developer Network CDs.
1768 It can be found there (on older CDs), but can also be found
1771 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1773 (this is Rev 6.0 from February 1999).
1775 Things move, so if that fails, try searching for it via
1777 http://www.google.com/search?q=PE+COFF+specification
1779 The ultimate reference for the PE format is the Winnt.h
1780 header file that comes with the Platform SDKs; as always,
1781 implementations will drift wrt their documentation.
1783 A good background article on the PE format is Matt Pietrek's
1784 March 1994 article in Microsoft System Journal (MSJ)
1785 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1786 Win32 Portable Executable File Format." The info in there
1787 has recently been updated in a two part article in
1788 MSDN magazine, issues Feb and March 2002,
1789 "Inside Windows: An In-Depth Look into the Win32 Portable
1790 Executable File Format"
1792 John Levine's book "Linkers and Loaders" contains useful
1797 #if defined(OBJFORMAT_PEi386)
1801 typedef unsigned char UChar;
1802 typedef unsigned short UInt16;
1803 typedef unsigned int UInt32;
1810 UInt16 NumberOfSections;
1811 UInt32 TimeDateStamp;
1812 UInt32 PointerToSymbolTable;
1813 UInt32 NumberOfSymbols;
1814 UInt16 SizeOfOptionalHeader;
1815 UInt16 Characteristics;
1819 #define sizeof_COFF_header 20
1826 UInt32 VirtualAddress;
1827 UInt32 SizeOfRawData;
1828 UInt32 PointerToRawData;
1829 UInt32 PointerToRelocations;
1830 UInt32 PointerToLinenumbers;
1831 UInt16 NumberOfRelocations;
1832 UInt16 NumberOfLineNumbers;
1833 UInt32 Characteristics;
1837 #define sizeof_COFF_section 40
1844 UInt16 SectionNumber;
1847 UChar NumberOfAuxSymbols;
1851 #define sizeof_COFF_symbol 18
1856 UInt32 VirtualAddress;
1857 UInt32 SymbolTableIndex;
1862 #define sizeof_COFF_reloc 10
1865 /* From PE spec doc, section 3.3.2 */
1866 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1867 windows.h -- for the same purpose, but I want to know what I'm
1869 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1870 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1871 #define MYIMAGE_FILE_DLL 0x2000
1872 #define MYIMAGE_FILE_SYSTEM 0x1000
1873 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1874 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1875 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1877 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1878 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1879 #define MYIMAGE_SYM_CLASS_STATIC 3
1880 #define MYIMAGE_SYM_UNDEFINED 0
1882 /* From PE spec doc, section 4.1 */
1883 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1884 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1885 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1887 /* From PE spec doc, section 5.2.1 */
1888 #define MYIMAGE_REL_I386_DIR32 0x0006
1889 #define MYIMAGE_REL_I386_REL32 0x0014
1892 /* We use myindex to calculate array addresses, rather than
1893 simply doing the normal subscript thing. That's because
1894 some of the above structs have sizes which are not
1895 a whole number of words. GCC rounds their sizes up to a
1896 whole number of words, which means that the address calcs
1897 arising from using normal C indexing or pointer arithmetic
1898 are just plain wrong. Sigh.
1901 myindex ( int scale, void* base, int index )
1904 ((UChar*)base) + scale * index;
1909 printName ( UChar* name, UChar* strtab )
1911 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1912 UInt32 strtab_offset = * (UInt32*)(name+4);
1913 debugBelch("%s", strtab + strtab_offset );
1916 for (i = 0; i < 8; i++) {
1917 if (name[i] == 0) break;
1918 debugBelch("%c", name[i] );
1925 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1927 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1928 UInt32 strtab_offset = * (UInt32*)(name+4);
1929 strncpy ( dst, strtab+strtab_offset, dstSize );
1935 if (name[i] == 0) break;
1945 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1948 /* If the string is longer than 8 bytes, look in the
1949 string table for it -- this will be correctly zero terminated.
1951 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1952 UInt32 strtab_offset = * (UInt32*)(name+4);
1953 return ((UChar*)strtab) + strtab_offset;
1955 /* Otherwise, if shorter than 8 bytes, return the original,
1956 which by defn is correctly terminated.
1958 if (name[7]==0) return name;
1959 /* The annoying case: 8 bytes. Copy into a temporary
1960 (which is never freed ...)
1962 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1964 strncpy(newstr,name,8);
1970 /* Just compares the short names (first 8 chars) */
1971 static COFF_section *
1972 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1976 = (COFF_header*)(oc->image);
1977 COFF_section* sectab
1979 ((UChar*)(oc->image))
1980 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1982 for (i = 0; i < hdr->NumberOfSections; i++) {
1985 COFF_section* section_i
1987 myindex ( sizeof_COFF_section, sectab, i );
1988 n1 = (UChar*) &(section_i->Name);
1990 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1991 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1992 n1[6]==n2[6] && n1[7]==n2[7])
2001 zapTrailingAtSign ( UChar* sym )
2003 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
2005 if (sym[0] == 0) return;
2007 while (sym[i] != 0) i++;
2010 while (j > 0 && my_isdigit(sym[j])) j--;
2011 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
2017 ocVerifyImage_PEi386 ( ObjectCode* oc )
2022 COFF_section* sectab;
2023 COFF_symbol* symtab;
2025 /* debugBelch("\nLOADING %s\n", oc->fileName); */
2026 hdr = (COFF_header*)(oc->image);
2027 sectab = (COFF_section*) (
2028 ((UChar*)(oc->image))
2029 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2031 symtab = (COFF_symbol*) (
2032 ((UChar*)(oc->image))
2033 + hdr->PointerToSymbolTable
2035 strtab = ((UChar*)symtab)
2036 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2038 if (hdr->Machine != 0x14c) {
2039 errorBelch("%s: Not x86 PEi386", oc->fileName);
2042 if (hdr->SizeOfOptionalHeader != 0) {
2043 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
2046 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
2047 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
2048 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
2049 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
2050 errorBelch("%s: Not a PEi386 object file", oc->fileName);
2053 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
2054 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
2055 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
2057 (int)(hdr->Characteristics));
2060 /* If the string table size is way crazy, this might indicate that
2061 there are more than 64k relocations, despite claims to the
2062 contrary. Hence this test. */
2063 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2065 if ( (*(UInt32*)strtab) > 600000 ) {
2066 /* Note that 600k has no special significance other than being
2067 big enough to handle the almost-2MB-sized lumps that
2068 constitute HSwin32*.o. */
2069 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2074 /* No further verification after this point; only debug printing. */
2076 IF_DEBUG(linker, i=1);
2077 if (i == 0) return 1;
2079 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2080 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2081 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2084 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2085 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2086 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2087 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2088 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2089 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2090 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2092 /* Print the section table. */
2094 for (i = 0; i < hdr->NumberOfSections; i++) {
2096 COFF_section* sectab_i
2098 myindex ( sizeof_COFF_section, sectab, i );
2105 printName ( sectab_i->Name, strtab );
2115 sectab_i->VirtualSize,
2116 sectab_i->VirtualAddress,
2117 sectab_i->SizeOfRawData,
2118 sectab_i->PointerToRawData,
2119 sectab_i->NumberOfRelocations,
2120 sectab_i->PointerToRelocations,
2121 sectab_i->PointerToRawData
2123 reltab = (COFF_reloc*) (
2124 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2127 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2128 /* If the relocation field (a short) has overflowed, the
2129 * real count can be found in the first reloc entry.
2131 * See Section 4.1 (last para) of the PE spec (rev6.0).
2133 COFF_reloc* rel = (COFF_reloc*)
2134 myindex ( sizeof_COFF_reloc, reltab, 0 );
2135 noRelocs = rel->VirtualAddress;
2138 noRelocs = sectab_i->NumberOfRelocations;
2142 for (; j < noRelocs; j++) {
2144 COFF_reloc* rel = (COFF_reloc*)
2145 myindex ( sizeof_COFF_reloc, reltab, j );
2147 " type 0x%-4x vaddr 0x%-8x name `",
2149 rel->VirtualAddress );
2150 sym = (COFF_symbol*)
2151 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2152 /* Hmm..mysterious looking offset - what's it for? SOF */
2153 printName ( sym->Name, strtab -10 );
2160 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2161 debugBelch("---START of string table---\n");
2162 for (i = 4; i < *(Int32*)strtab; i++) {
2164 debugBelch("\n"); else
2165 debugBelch("%c", strtab[i] );
2167 debugBelch("--- END of string table---\n");
2172 COFF_symbol* symtab_i;
2173 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2174 symtab_i = (COFF_symbol*)
2175 myindex ( sizeof_COFF_symbol, symtab, i );
2181 printName ( symtab_i->Name, strtab );
2190 (Int32)(symtab_i->SectionNumber),
2191 (UInt32)symtab_i->Type,
2192 (UInt32)symtab_i->StorageClass,
2193 (UInt32)symtab_i->NumberOfAuxSymbols
2195 i += symtab_i->NumberOfAuxSymbols;
2205 ocGetNames_PEi386 ( ObjectCode* oc )
2208 COFF_section* sectab;
2209 COFF_symbol* symtab;
2216 hdr = (COFF_header*)(oc->image);
2217 sectab = (COFF_section*) (
2218 ((UChar*)(oc->image))
2219 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2221 symtab = (COFF_symbol*) (
2222 ((UChar*)(oc->image))
2223 + hdr->PointerToSymbolTable
2225 strtab = ((UChar*)(oc->image))
2226 + hdr->PointerToSymbolTable
2227 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2229 /* Allocate space for any (local, anonymous) .bss sections. */
2231 for (i = 0; i < hdr->NumberOfSections; i++) {
2234 COFF_section* sectab_i
2236 myindex ( sizeof_COFF_section, sectab, i );
2237 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2238 /* sof 10/05: the PE spec text isn't too clear regarding what
2239 * the SizeOfRawData field is supposed to hold for object
2240 * file sections containing just uninitialized data -- for executables,
2241 * it is supposed to be zero; unclear what it's supposed to be
2242 * for object files. However, VirtualSize is guaranteed to be
2243 * zero for object files, which definitely suggests that SizeOfRawData
2244 * will be non-zero (where else would the size of this .bss section be
2245 * stored?) Looking at the COFF_section info for incoming object files,
2246 * this certainly appears to be the case.
2248 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2249 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2250 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2251 * variable decls into to the .bss section. (The specific function in Q which
2252 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2254 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2255 /* This is a non-empty .bss section. Allocate zeroed space for
2256 it, and set its PointerToRawData field such that oc->image +
2257 PointerToRawData == addr_of_zeroed_space. */
2258 bss_sz = sectab_i->VirtualSize;
2259 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2260 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2261 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2262 addProddableBlock(oc, zspace, bss_sz);
2263 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2266 /* Copy section information into the ObjectCode. */
2268 for (i = 0; i < hdr->NumberOfSections; i++) {
2274 = SECTIONKIND_OTHER;
2275 COFF_section* sectab_i
2277 myindex ( sizeof_COFF_section, sectab, i );
2278 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2281 /* I'm sure this is the Right Way to do it. However, the
2282 alternative of testing the sectab_i->Name field seems to
2283 work ok with Cygwin.
2285 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2286 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2287 kind = SECTIONKIND_CODE_OR_RODATA;
2290 if (0==strcmp(".text",sectab_i->Name) ||
2291 0==strcmp(".rdata",sectab_i->Name)||
2292 0==strcmp(".rodata",sectab_i->Name))
2293 kind = SECTIONKIND_CODE_OR_RODATA;
2294 if (0==strcmp(".data",sectab_i->Name) ||
2295 0==strcmp(".bss",sectab_i->Name))
2296 kind = SECTIONKIND_RWDATA;
2298 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2299 sz = sectab_i->SizeOfRawData;
2300 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2302 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2303 end = start + sz - 1;
2305 if (kind == SECTIONKIND_OTHER
2306 /* Ignore sections called which contain stabs debugging
2308 && 0 != strcmp(".stab", sectab_i->Name)
2309 && 0 != strcmp(".stabstr", sectab_i->Name)
2310 /* ignore constructor section for now */
2311 && 0 != strcmp(".ctors", sectab_i->Name)
2312 /* ignore section generated from .ident */
2313 && 0!= strcmp("/4", sectab_i->Name)
2314 /* ignore unknown section that appeared in gcc 3.4.5(?) */
2315 && 0!= strcmp(".reloc", sectab_i->Name)
2317 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2321 if (kind != SECTIONKIND_OTHER && end >= start) {
2322 addSection(oc, kind, start, end);
2323 addProddableBlock(oc, start, end - start + 1);
2327 /* Copy exported symbols into the ObjectCode. */
2329 oc->n_symbols = hdr->NumberOfSymbols;
2330 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2331 "ocGetNames_PEi386(oc->symbols)");
2332 /* Call me paranoid; I don't care. */
2333 for (i = 0; i < oc->n_symbols; i++)
2334 oc->symbols[i] = NULL;
2338 COFF_symbol* symtab_i;
2339 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2340 symtab_i = (COFF_symbol*)
2341 myindex ( sizeof_COFF_symbol, symtab, i );
2345 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2346 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2347 /* This symbol is global and defined, viz, exported */
2348 /* for MYIMAGE_SYMCLASS_EXTERNAL
2349 && !MYIMAGE_SYM_UNDEFINED,
2350 the address of the symbol is:
2351 address of relevant section + offset in section
2353 COFF_section* sectabent
2354 = (COFF_section*) myindex ( sizeof_COFF_section,
2356 symtab_i->SectionNumber-1 );
2357 addr = ((UChar*)(oc->image))
2358 + (sectabent->PointerToRawData
2362 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2363 && symtab_i->Value > 0) {
2364 /* This symbol isn't in any section at all, ie, global bss.
2365 Allocate zeroed space for it. */
2366 addr = stgCallocBytes(1, symtab_i->Value,
2367 "ocGetNames_PEi386(non-anonymous bss)");
2368 addSection(oc, SECTIONKIND_RWDATA, addr,
2369 ((UChar*)addr) + symtab_i->Value - 1);
2370 addProddableBlock(oc, addr, symtab_i->Value);
2371 /* debugBelch("BSS section at 0x%x\n", addr); */
2374 if (addr != NULL ) {
2375 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2376 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2377 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2378 ASSERT(i >= 0 && i < oc->n_symbols);
2379 /* cstring_from_COFF_symbol_name always succeeds. */
2380 oc->symbols[i] = sname;
2381 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2385 "IGNORING symbol %d\n"
2389 printName ( symtab_i->Name, strtab );
2398 (Int32)(symtab_i->SectionNumber),
2399 (UInt32)symtab_i->Type,
2400 (UInt32)symtab_i->StorageClass,
2401 (UInt32)symtab_i->NumberOfAuxSymbols
2406 i += symtab_i->NumberOfAuxSymbols;
2415 ocResolve_PEi386 ( ObjectCode* oc )
2418 COFF_section* sectab;
2419 COFF_symbol* symtab;
2429 /* ToDo: should be variable-sized? But is at least safe in the
2430 sense of buffer-overrun-proof. */
2432 /* debugBelch("resolving for %s\n", oc->fileName); */
2434 hdr = (COFF_header*)(oc->image);
2435 sectab = (COFF_section*) (
2436 ((UChar*)(oc->image))
2437 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2439 symtab = (COFF_symbol*) (
2440 ((UChar*)(oc->image))
2441 + hdr->PointerToSymbolTable
2443 strtab = ((UChar*)(oc->image))
2444 + hdr->PointerToSymbolTable
2445 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2447 for (i = 0; i < hdr->NumberOfSections; i++) {
2448 COFF_section* sectab_i
2450 myindex ( sizeof_COFF_section, sectab, i );
2453 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2456 /* Ignore sections called which contain stabs debugging
2458 if (0 == strcmp(".stab", sectab_i->Name)
2459 || 0 == strcmp(".stabstr", sectab_i->Name)
2460 || 0 == strcmp(".ctors", sectab_i->Name))
2463 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2464 /* If the relocation field (a short) has overflowed, the
2465 * real count can be found in the first reloc entry.
2467 * See Section 4.1 (last para) of the PE spec (rev6.0).
2469 * Nov2003 update: the GNU linker still doesn't correctly
2470 * handle the generation of relocatable object files with
2471 * overflown relocations. Hence the output to warn of potential
2474 COFF_reloc* rel = (COFF_reloc*)
2475 myindex ( sizeof_COFF_reloc, reltab, 0 );
2476 noRelocs = rel->VirtualAddress;
2478 /* 10/05: we now assume (and check for) a GNU ld that is capable
2479 * of handling object files with (>2^16) of relocs.
2482 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2487 noRelocs = sectab_i->NumberOfRelocations;
2492 for (; j < noRelocs; j++) {
2494 COFF_reloc* reltab_j
2496 myindex ( sizeof_COFF_reloc, reltab, j );
2498 /* the location to patch */
2500 ((UChar*)(oc->image))
2501 + (sectab_i->PointerToRawData
2502 + reltab_j->VirtualAddress
2503 - sectab_i->VirtualAddress )
2505 /* the existing contents of pP */
2507 /* the symbol to connect to */
2508 sym = (COFF_symbol*)
2509 myindex ( sizeof_COFF_symbol,
2510 symtab, reltab_j->SymbolTableIndex );
2513 "reloc sec %2d num %3d: type 0x%-4x "
2514 "vaddr 0x%-8x name `",
2516 (UInt32)reltab_j->Type,
2517 reltab_j->VirtualAddress );
2518 printName ( sym->Name, strtab );
2519 debugBelch("'\n" ));
2521 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2522 COFF_section* section_sym
2523 = findPEi386SectionCalled ( oc, sym->Name );
2525 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2528 S = ((UInt32)(oc->image))
2529 + (section_sym->PointerToRawData
2532 copyName ( sym->Name, strtab, symbol, 1000-1 );
2533 S = (UInt32) lookupLocalSymbol( oc, symbol );
2534 if ((void*)S != NULL) goto foundit;
2535 S = (UInt32) lookupSymbol( symbol );
2536 if ((void*)S != NULL) goto foundit;
2537 zapTrailingAtSign ( symbol );
2538 S = (UInt32) lookupLocalSymbol( oc, symbol );
2539 if ((void*)S != NULL) goto foundit;
2540 S = (UInt32) lookupSymbol( symbol );
2541 if ((void*)S != NULL) goto foundit;
2542 /* Newline first because the interactive linker has printed "linking..." */
2543 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2547 checkProddableBlock(oc, pP);
2548 switch (reltab_j->Type) {
2549 case MYIMAGE_REL_I386_DIR32:
2552 case MYIMAGE_REL_I386_REL32:
2553 /* Tricky. We have to insert a displacement at
2554 pP which, when added to the PC for the _next_
2555 insn, gives the address of the target (S).
2556 Problem is to know the address of the next insn
2557 when we only know pP. We assume that this
2558 literal field is always the last in the insn,
2559 so that the address of the next insn is pP+4
2560 -- hence the constant 4.
2561 Also I don't know if A should be added, but so
2562 far it has always been zero.
2564 SOF 05/2005: 'A' (old contents of *pP) have been observed
2565 to contain values other than zero (the 'wx' object file
2566 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2567 So, add displacement to old value instead of asserting
2568 A to be zero. Fixes wxhaskell-related crashes, and no other
2569 ill effects have been observed.
2571 Update: the reason why we're seeing these more elaborate
2572 relocations is due to a switch in how the NCG compiles SRTs
2573 and offsets to them from info tables. SRTs live in .(ro)data,
2574 while info tables live in .text, causing GAS to emit REL32/DISP32
2575 relocations with non-zero values. Adding the displacement is
2576 the right thing to do.
2578 *pP = S - ((UInt32)pP) - 4 + A;
2581 debugBelch("%s: unhandled PEi386 relocation type %d",
2582 oc->fileName, reltab_j->Type);
2589 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2593 #endif /* defined(OBJFORMAT_PEi386) */
2596 /* --------------------------------------------------------------------------
2598 * ------------------------------------------------------------------------*/
2600 #if defined(OBJFORMAT_ELF)
2605 #if defined(sparc_HOST_ARCH)
2606 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2607 #elif defined(i386_HOST_ARCH)
2608 # define ELF_TARGET_386 /* Used inside <elf.h> */
2609 #elif defined(x86_64_HOST_ARCH)
2610 # define ELF_TARGET_X64_64
2612 #elif defined (ia64_HOST_ARCH)
2613 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2615 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2616 # define ELF_NEED_GOT /* needs Global Offset Table */
2617 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2620 #if !defined(openbsd_HOST_OS)
2623 /* openbsd elf has things in different places, with diff names */
2624 # include <elf_abi.h>
2625 # include <machine/reloc.h>
2626 # define R_386_32 RELOC_32
2627 # define R_386_PC32 RELOC_PC32
2630 /* If elf.h doesn't define it */
2631 # ifndef R_X86_64_PC64
2632 # define R_X86_64_PC64 24
2636 * Define a set of types which can be used for both ELF32 and ELF64
2640 #define ELFCLASS ELFCLASS64
2641 #define Elf_Addr Elf64_Addr
2642 #define Elf_Word Elf64_Word
2643 #define Elf_Sword Elf64_Sword
2644 #define Elf_Ehdr Elf64_Ehdr
2645 #define Elf_Phdr Elf64_Phdr
2646 #define Elf_Shdr Elf64_Shdr
2647 #define Elf_Sym Elf64_Sym
2648 #define Elf_Rel Elf64_Rel
2649 #define Elf_Rela Elf64_Rela
2650 #define ELF_ST_TYPE ELF64_ST_TYPE
2651 #define ELF_ST_BIND ELF64_ST_BIND
2652 #define ELF_R_TYPE ELF64_R_TYPE
2653 #define ELF_R_SYM ELF64_R_SYM
2655 #define ELFCLASS ELFCLASS32
2656 #define Elf_Addr Elf32_Addr
2657 #define Elf_Word Elf32_Word
2658 #define Elf_Sword Elf32_Sword
2659 #define Elf_Ehdr Elf32_Ehdr
2660 #define Elf_Phdr Elf32_Phdr
2661 #define Elf_Shdr Elf32_Shdr
2662 #define Elf_Sym Elf32_Sym
2663 #define Elf_Rel Elf32_Rel
2664 #define Elf_Rela Elf32_Rela
2666 #define ELF_ST_TYPE ELF32_ST_TYPE
2669 #define ELF_ST_BIND ELF32_ST_BIND
2672 #define ELF_R_TYPE ELF32_R_TYPE
2675 #define ELF_R_SYM ELF32_R_SYM
2681 * Functions to allocate entries in dynamic sections. Currently we simply
2682 * preallocate a large number, and we don't check if a entry for the given
2683 * target already exists (a linear search is too slow). Ideally these
2684 * entries would be associated with symbols.
2687 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2688 #define GOT_SIZE 0x20000
2689 #define FUNCTION_TABLE_SIZE 0x10000
2690 #define PLT_SIZE 0x08000
2693 static Elf_Addr got[GOT_SIZE];
2694 static unsigned int gotIndex;
2695 static Elf_Addr gp_val = (Elf_Addr)got;
2698 allocateGOTEntry(Elf_Addr target)
2702 if (gotIndex >= GOT_SIZE)
2703 barf("Global offset table overflow");
2705 entry = &got[gotIndex++];
2707 return (Elf_Addr)entry;
2711 #ifdef ELF_FUNCTION_DESC
2717 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2718 static unsigned int functionTableIndex;
2721 allocateFunctionDesc(Elf_Addr target)
2723 FunctionDesc *entry;
2725 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2726 barf("Function table overflow");
2728 entry = &functionTable[functionTableIndex++];
2730 entry->gp = (Elf_Addr)gp_val;
2731 return (Elf_Addr)entry;
2735 copyFunctionDesc(Elf_Addr target)
2737 FunctionDesc *olddesc = (FunctionDesc *)target;
2738 FunctionDesc *newdesc;
2740 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2741 newdesc->gp = olddesc->gp;
2742 return (Elf_Addr)newdesc;
2747 #ifdef ia64_HOST_ARCH
2748 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2749 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2751 static unsigned char plt_code[] =
2753 /* taken from binutils bfd/elfxx-ia64.c */
2754 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2755 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2756 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2757 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2758 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2759 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2762 /* If we can't get to the function descriptor via gp, take a local copy of it */
2763 #define PLT_RELOC(code, target) { \
2764 Elf64_Sxword rel_value = target - gp_val; \
2765 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2766 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2768 ia64_reloc_gprel22((Elf_Addr)code, target); \
2773 unsigned char code[sizeof(plt_code)];
2777 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2779 PLTEntry *plt = (PLTEntry *)oc->plt;
2782 if (oc->pltIndex >= PLT_SIZE)
2783 barf("Procedure table overflow");
2785 entry = &plt[oc->pltIndex++];
2786 memcpy(entry->code, plt_code, sizeof(entry->code));
2787 PLT_RELOC(entry->code, target);
2788 return (Elf_Addr)entry;
2794 return (PLT_SIZE * sizeof(PLTEntry));
2800 * Generic ELF functions
2804 findElfSection ( void* objImage, Elf_Word sh_type )
2806 char* ehdrC = (char*)objImage;
2807 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2808 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2809 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2813 for (i = 0; i < ehdr->e_shnum; i++) {
2814 if (shdr[i].sh_type == sh_type
2815 /* Ignore the section header's string table. */
2816 && i != ehdr->e_shstrndx
2817 /* Ignore string tables named .stabstr, as they contain
2819 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2821 ptr = ehdrC + shdr[i].sh_offset;
2828 #if defined(ia64_HOST_ARCH)
2830 findElfSegment ( void* objImage, Elf_Addr vaddr )
2832 char* ehdrC = (char*)objImage;
2833 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2834 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2835 Elf_Addr segaddr = 0;
2838 for (i = 0; i < ehdr->e_phnum; i++) {
2839 segaddr = phdr[i].p_vaddr;
2840 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2848 ocVerifyImage_ELF ( ObjectCode* oc )
2852 int i, j, nent, nstrtab, nsymtabs;
2856 char* ehdrC = (char*)(oc->image);
2857 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2859 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2860 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2861 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2862 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2863 errorBelch("%s: not an ELF object", oc->fileName);
2867 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2868 errorBelch("%s: unsupported ELF format", oc->fileName);
2872 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2873 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2875 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2876 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2878 errorBelch("%s: unknown endiannness", oc->fileName);
2882 if (ehdr->e_type != ET_REL) {
2883 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2886 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2888 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2889 switch (ehdr->e_machine) {
2890 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2891 #ifdef EM_SPARC32PLUS
2892 case EM_SPARC32PLUS:
2894 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2896 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2898 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2900 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2901 #elif defined(EM_AMD64)
2902 case EM_AMD64: IF_DEBUG(linker,debugBelch( "amd64" )); break;
2904 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2905 errorBelch("%s: unknown architecture (e_machine == %d)"
2906 , oc->fileName, ehdr->e_machine);
2910 IF_DEBUG(linker,debugBelch(
2911 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2912 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2914 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2916 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2918 if (ehdr->e_shstrndx == SHN_UNDEF) {
2919 errorBelch("%s: no section header string table", oc->fileName);
2922 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2924 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2927 for (i = 0; i < ehdr->e_shnum; i++) {
2928 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2929 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2930 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2931 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2932 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2933 ehdrC + shdr[i].sh_offset,
2934 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2936 if (shdr[i].sh_type == SHT_REL) {
2937 IF_DEBUG(linker,debugBelch("Rel " ));
2938 } else if (shdr[i].sh_type == SHT_RELA) {
2939 IF_DEBUG(linker,debugBelch("RelA " ));
2941 IF_DEBUG(linker,debugBelch(" "));
2944 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2948 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2951 for (i = 0; i < ehdr->e_shnum; i++) {
2952 if (shdr[i].sh_type == SHT_STRTAB
2953 /* Ignore the section header's string table. */
2954 && i != ehdr->e_shstrndx
2955 /* Ignore string tables named .stabstr, as they contain
2957 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2959 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2960 strtab = ehdrC + shdr[i].sh_offset;
2965 errorBelch("%s: no string tables, or too many", oc->fileName);
2970 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2971 for (i = 0; i < ehdr->e_shnum; i++) {
2972 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2973 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2975 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2976 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2977 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2979 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2981 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2982 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2985 for (j = 0; j < nent; j++) {
2986 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2987 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2988 (int)stab[j].st_shndx,
2989 (int)stab[j].st_size,
2990 (char*)stab[j].st_value ));
2992 IF_DEBUG(linker,debugBelch("type=" ));
2993 switch (ELF_ST_TYPE(stab[j].st_info)) {
2994 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2995 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2996 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2997 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
2998 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
2999 default: IF_DEBUG(linker,debugBelch("? " )); break;
3001 IF_DEBUG(linker,debugBelch(" " ));
3003 IF_DEBUG(linker,debugBelch("bind=" ));
3004 switch (ELF_ST_BIND(stab[j].st_info)) {
3005 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
3006 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
3007 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
3008 default: IF_DEBUG(linker,debugBelch("? " )); break;
3010 IF_DEBUG(linker,debugBelch(" " ));
3012 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
3016 if (nsymtabs == 0) {
3017 errorBelch("%s: didn't find any symbol tables", oc->fileName);
3024 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
3028 if (hdr->sh_type == SHT_PROGBITS
3029 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
3030 /* .text-style section */
3031 return SECTIONKIND_CODE_OR_RODATA;
3034 if (hdr->sh_type == SHT_PROGBITS
3035 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3036 /* .data-style section */
3037 return SECTIONKIND_RWDATA;
3040 if (hdr->sh_type == SHT_PROGBITS
3041 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3042 /* .rodata-style section */
3043 return SECTIONKIND_CODE_OR_RODATA;
3046 if (hdr->sh_type == SHT_NOBITS
3047 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3048 /* .bss-style section */
3050 return SECTIONKIND_RWDATA;
3053 return SECTIONKIND_OTHER;
3058 ocGetNames_ELF ( ObjectCode* oc )
3063 char* ehdrC = (char*)(oc->image);
3064 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3065 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3066 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3068 ASSERT(symhash != NULL);
3071 errorBelch("%s: no strtab", oc->fileName);
3076 for (i = 0; i < ehdr->e_shnum; i++) {
3077 /* Figure out what kind of section it is. Logic derived from
3078 Figure 1.14 ("Special Sections") of the ELF document
3079 ("Portable Formats Specification, Version 1.1"). */
3081 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3083 if (is_bss && shdr[i].sh_size > 0) {
3084 /* This is a non-empty .bss section. Allocate zeroed space for
3085 it, and set its .sh_offset field such that
3086 ehdrC + .sh_offset == addr_of_zeroed_space. */
3087 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3088 "ocGetNames_ELF(BSS)");
3089 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3091 debugBelch("BSS section at 0x%x, size %d\n",
3092 zspace, shdr[i].sh_size);
3096 /* fill in the section info */
3097 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3098 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3099 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3100 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3103 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3105 /* copy stuff into this module's object symbol table */
3106 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3107 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3109 oc->n_symbols = nent;
3110 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3111 "ocGetNames_ELF(oc->symbols)");
3113 for (j = 0; j < nent; j++) {
3115 char isLocal = FALSE; /* avoids uninit-var warning */
3117 char* nm = strtab + stab[j].st_name;
3118 int secno = stab[j].st_shndx;
3120 /* Figure out if we want to add it; if so, set ad to its
3121 address. Otherwise leave ad == NULL. */
3123 if (secno == SHN_COMMON) {
3125 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3127 debugBelch("COMMON symbol, size %d name %s\n",
3128 stab[j].st_size, nm);
3130 /* Pointless to do addProddableBlock() for this area,
3131 since the linker should never poke around in it. */
3134 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3135 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3137 /* and not an undefined symbol */
3138 && stab[j].st_shndx != SHN_UNDEF
3139 /* and not in a "special section" */
3140 && stab[j].st_shndx < SHN_LORESERVE
3142 /* and it's a not a section or string table or anything silly */
3143 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3144 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3145 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3148 /* Section 0 is the undefined section, hence > and not >=. */
3149 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3151 if (shdr[secno].sh_type == SHT_NOBITS) {
3152 debugBelch(" BSS symbol, size %d off %d name %s\n",
3153 stab[j].st_size, stab[j].st_value, nm);
3156 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3157 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3160 #ifdef ELF_FUNCTION_DESC
3161 /* dlsym() and the initialisation table both give us function
3162 * descriptors, so to be consistent we store function descriptors
3163 * in the symbol table */
3164 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3165 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3167 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3168 ad, oc->fileName, nm ));
3173 /* And the decision is ... */
3177 oc->symbols[j] = nm;
3180 /* Ignore entirely. */
3182 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3186 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3187 strtab + stab[j].st_name ));
3190 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3191 (int)ELF_ST_BIND(stab[j].st_info),
3192 (int)ELF_ST_TYPE(stab[j].st_info),
3193 (int)stab[j].st_shndx,
3194 strtab + stab[j].st_name
3197 oc->symbols[j] = NULL;
3206 /* Do ELF relocations which lack an explicit addend. All x86-linux
3207 relocations appear to be of this form. */
3209 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3210 Elf_Shdr* shdr, int shnum,
3211 Elf_Sym* stab, char* strtab )
3216 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3217 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3218 int target_shndx = shdr[shnum].sh_info;
3219 int symtab_shndx = shdr[shnum].sh_link;
3221 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3222 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3223 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3224 target_shndx, symtab_shndx ));
3226 /* Skip sections that we're not interested in. */
3229 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3230 if (kind == SECTIONKIND_OTHER) {
3231 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3236 for (j = 0; j < nent; j++) {
3237 Elf_Addr offset = rtab[j].r_offset;
3238 Elf_Addr info = rtab[j].r_info;
3240 Elf_Addr P = ((Elf_Addr)targ) + offset;
3241 Elf_Word* pP = (Elf_Word*)P;
3246 StgStablePtr stablePtr;
3249 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3250 j, (void*)offset, (void*)info ));
3252 IF_DEBUG(linker,debugBelch( " ZERO" ));
3255 Elf_Sym sym = stab[ELF_R_SYM(info)];
3256 /* First see if it is a local symbol. */
3257 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3258 /* Yes, so we can get the address directly from the ELF symbol
3260 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3262 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3263 + stab[ELF_R_SYM(info)].st_value);
3266 symbol = strtab + sym.st_name;
3267 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3268 if (NULL == stablePtr) {
3269 /* No, so look up the name in our global table. */
3270 S_tmp = lookupSymbol( symbol );
3271 S = (Elf_Addr)S_tmp;
3273 stableVal = deRefStablePtr( stablePtr );
3275 S = (Elf_Addr)S_tmp;
3279 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3282 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3285 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3286 (void*)P, (void*)S, (void*)A ));
3287 checkProddableBlock ( oc, pP );
3291 switch (ELF_R_TYPE(info)) {
3292 # ifdef i386_HOST_ARCH
3293 case R_386_32: *pP = value; break;
3294 case R_386_PC32: *pP = value - P; break;
3297 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3298 oc->fileName, (lnat)ELF_R_TYPE(info));
3306 /* Do ELF relocations for which explicit addends are supplied.
3307 sparc-solaris relocations appear to be of this form. */
3309 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3310 Elf_Shdr* shdr, int shnum,
3311 Elf_Sym* stab, char* strtab )
3314 char *symbol = NULL;
3316 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3317 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3318 int target_shndx = shdr[shnum].sh_info;
3319 int symtab_shndx = shdr[shnum].sh_link;
3321 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3322 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3323 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3324 target_shndx, symtab_shndx ));
3326 for (j = 0; j < nent; j++) {
3327 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3328 /* This #ifdef only serves to avoid unused-var warnings. */
3329 Elf_Addr offset = rtab[j].r_offset;
3330 Elf_Addr P = targ + offset;
3332 Elf_Addr info = rtab[j].r_info;
3333 Elf_Addr A = rtab[j].r_addend;
3337 # if defined(sparc_HOST_ARCH)
3338 Elf_Word* pP = (Elf_Word*)P;
3340 # elif defined(ia64_HOST_ARCH)
3341 Elf64_Xword *pP = (Elf64_Xword *)P;
3343 # elif defined(powerpc_HOST_ARCH)
3347 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3348 j, (void*)offset, (void*)info,
3351 IF_DEBUG(linker,debugBelch( " ZERO" ));
3354 Elf_Sym sym = stab[ELF_R_SYM(info)];
3355 /* First see if it is a local symbol. */
3356 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3357 /* Yes, so we can get the address directly from the ELF symbol
3359 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3361 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3362 + stab[ELF_R_SYM(info)].st_value);
3363 #ifdef ELF_FUNCTION_DESC
3364 /* Make a function descriptor for this function */
3365 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3366 S = allocateFunctionDesc(S + A);
3371 /* No, so look up the name in our global table. */
3372 symbol = strtab + sym.st_name;
3373 S_tmp = lookupSymbol( symbol );
3374 S = (Elf_Addr)S_tmp;
3376 #ifdef ELF_FUNCTION_DESC
3377 /* If a function, already a function descriptor - we would
3378 have to copy it to add an offset. */
3379 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3380 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3384 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3387 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3390 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3391 (void*)P, (void*)S, (void*)A ));
3392 /* checkProddableBlock ( oc, (void*)P ); */
3396 switch (ELF_R_TYPE(info)) {
3397 # if defined(sparc_HOST_ARCH)
3398 case R_SPARC_WDISP30:
3399 w1 = *pP & 0xC0000000;
3400 w2 = (Elf_Word)((value - P) >> 2);
3401 ASSERT((w2 & 0xC0000000) == 0);
3406 w1 = *pP & 0xFFC00000;
3407 w2 = (Elf_Word)(value >> 10);
3408 ASSERT((w2 & 0xFFC00000) == 0);
3414 w2 = (Elf_Word)(value & 0x3FF);
3415 ASSERT((w2 & ~0x3FF) == 0);
3419 /* According to the Sun documentation:
3421 This relocation type resembles R_SPARC_32, except it refers to an
3422 unaligned word. That is, the word to be relocated must be treated
3423 as four separate bytes with arbitrary alignment, not as a word
3424 aligned according to the architecture requirements.
3426 (JRS: which means that freeloading on the R_SPARC_32 case
3427 is probably wrong, but hey ...)
3431 w2 = (Elf_Word)value;
3434 # elif defined(ia64_HOST_ARCH)
3435 case R_IA64_DIR64LSB:
3436 case R_IA64_FPTR64LSB:
3439 case R_IA64_PCREL64LSB:
3442 case R_IA64_SEGREL64LSB:
3443 addr = findElfSegment(ehdrC, value);
3446 case R_IA64_GPREL22:
3447 ia64_reloc_gprel22(P, value);
3449 case R_IA64_LTOFF22:
3450 case R_IA64_LTOFF22X:
3451 case R_IA64_LTOFF_FPTR22:
3452 addr = allocateGOTEntry(value);
3453 ia64_reloc_gprel22(P, addr);
3455 case R_IA64_PCREL21B:
3456 ia64_reloc_pcrel21(P, S, oc);
3459 /* This goes with R_IA64_LTOFF22X and points to the load to
3460 * convert into a move. We don't implement relaxation. */
3462 # elif defined(powerpc_HOST_ARCH)
3463 case R_PPC_ADDR16_LO:
3464 *(Elf32_Half*) P = value;
3467 case R_PPC_ADDR16_HI:
3468 *(Elf32_Half*) P = value >> 16;
3471 case R_PPC_ADDR16_HA:
3472 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3476 *(Elf32_Word *) P = value;
3480 *(Elf32_Word *) P = value - P;
3486 if( delta << 6 >> 6 != delta )
3488 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3492 if( value == 0 || delta << 6 >> 6 != delta )
3494 barf( "Unable to make SymbolExtra for #%d",
3500 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3501 | (delta & 0x3fffffc);
3505 #if x86_64_HOST_ARCH
3507 *(Elf64_Xword *)P = value;
3512 StgInt64 off = value - P;
3513 if (off >= 0x7fffffffL || off < -0x80000000L) {
3514 #if X86_64_ELF_NONPIC_HACK
3515 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3517 off = pltAddress + A - P;
3519 barf("R_X86_64_PC32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3520 symbol, off, oc->fileName );
3523 *(Elf64_Word *)P = (Elf64_Word)off;
3529 StgInt64 off = value - P;
3530 *(Elf64_Word *)P = (Elf64_Word)off;
3535 if (value >= 0x7fffffffL) {
3536 #if X86_64_ELF_NONPIC_HACK
3537 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3539 value = pltAddress + A;
3541 barf("R_X86_64_32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3542 symbol, value, oc->fileName );
3545 *(Elf64_Word *)P = (Elf64_Word)value;
3549 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3550 #if X86_64_ELF_NONPIC_HACK
3551 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3553 value = pltAddress + A;
3555 barf("R_X86_64_32S relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3556 symbol, value, oc->fileName );
3559 *(Elf64_Sword *)P = (Elf64_Sword)value;
3562 case R_X86_64_GOTPCREL:
3564 StgInt64 gotAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)->addr;
3565 StgInt64 off = gotAddress + A - P;
3566 *(Elf64_Word *)P = (Elf64_Word)off;
3570 case R_X86_64_PLT32:
3572 StgInt64 off = value - P;
3573 if (off >= 0x7fffffffL || off < -0x80000000L) {
3574 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3576 off = pltAddress + A - P;
3578 *(Elf64_Word *)P = (Elf64_Word)off;
3584 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3585 oc->fileName, (lnat)ELF_R_TYPE(info));
3594 ocResolve_ELF ( ObjectCode* oc )
3598 Elf_Sym* stab = NULL;
3599 char* ehdrC = (char*)(oc->image);
3600 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3601 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3603 /* first find "the" symbol table */
3604 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3606 /* also go find the string table */
3607 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3609 if (stab == NULL || strtab == NULL) {
3610 errorBelch("%s: can't find string or symbol table", oc->fileName);
3614 /* Process the relocation sections. */
3615 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3616 if (shdr[shnum].sh_type == SHT_REL) {
3617 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3618 shnum, stab, strtab );
3622 if (shdr[shnum].sh_type == SHT_RELA) {
3623 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3624 shnum, stab, strtab );
3629 /* Free the local symbol table; we won't need it again. */
3630 freeHashTable(oc->lochash, NULL);
3633 #if defined(powerpc_HOST_ARCH)
3634 ocFlushInstructionCache( oc );
3642 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3643 * at the front. The following utility functions pack and unpack instructions, and
3644 * take care of the most common relocations.
3647 #ifdef ia64_HOST_ARCH
3650 ia64_extract_instruction(Elf64_Xword *target)
3653 int slot = (Elf_Addr)target & 3;
3654 target = (Elf_Addr)target & ~3;
3662 return ((w1 >> 5) & 0x1ffffffffff);
3664 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3668 barf("ia64_extract_instruction: invalid slot %p", target);
3673 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3675 int slot = (Elf_Addr)target & 3;
3676 target = (Elf_Addr)target & ~3;
3681 *target |= value << 5;
3684 *target |= value << 46;
3685 *(target+1) |= value >> 18;
3688 *(target+1) |= value << 23;
3694 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3696 Elf64_Xword instruction;
3697 Elf64_Sxword rel_value;
3699 rel_value = value - gp_val;
3700 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3701 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3703 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3704 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3705 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3706 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3707 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3708 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3712 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3714 Elf64_Xword instruction;
3715 Elf64_Sxword rel_value;
3718 entry = allocatePLTEntry(value, oc);
3720 rel_value = (entry >> 4) - (target >> 4);
3721 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3722 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3724 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3725 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3726 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3727 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3733 * PowerPC & X86_64 ELF specifics
3736 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3738 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3744 ehdr = (Elf_Ehdr *) oc->image;
3745 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3747 for( i = 0; i < ehdr->e_shnum; i++ )
3748 if( shdr[i].sh_type == SHT_SYMTAB )
3751 if( i == ehdr->e_shnum )
3753 errorBelch( "This ELF file contains no symtab" );
3757 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3759 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3760 (int) shdr[i].sh_entsize, (int) sizeof( Elf_Sym ) );
3765 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3768 #endif /* powerpc */
3772 /* --------------------------------------------------------------------------
3774 * ------------------------------------------------------------------------*/
3776 #if defined(OBJFORMAT_MACHO)
3779 Support for MachO linking on Darwin/MacOS X
3780 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3782 I hereby formally apologize for the hackish nature of this code.
3783 Things that need to be done:
3784 *) implement ocVerifyImage_MachO
3785 *) add still more sanity checks.
3788 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3789 #define mach_header mach_header_64
3790 #define segment_command segment_command_64
3791 #define section section_64
3792 #define nlist nlist_64
3795 #ifdef powerpc_HOST_ARCH
3796 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3798 struct mach_header *header = (struct mach_header *) oc->image;
3799 struct load_command *lc = (struct load_command *) (header + 1);
3802 for( i = 0; i < header->ncmds; i++ )
3804 if( lc->cmd == LC_SYMTAB )
3806 // Find out the first and last undefined external
3807 // symbol, so we don't have to allocate too many
3809 struct symtab_command *symLC = (struct symtab_command *) lc;
3810 unsigned min = symLC->nsyms, max = 0;
3811 struct nlist *nlist =
3812 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3814 for(i=0;i<symLC->nsyms;i++)
3816 if(nlist[i].n_type & N_STAB)
3818 else if(nlist[i].n_type & N_EXT)
3820 if((nlist[i].n_type & N_TYPE) == N_UNDF
3821 && (nlist[i].n_value == 0))
3831 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3836 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3838 return ocAllocateSymbolExtras(oc,0,0);
3841 #ifdef x86_64_HOST_ARCH
3842 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3844 struct mach_header *header = (struct mach_header *) oc->image;
3845 struct load_command *lc = (struct load_command *) (header + 1);
3848 for( i = 0; i < header->ncmds; i++ )
3850 if( lc->cmd == LC_SYMTAB )
3852 // Just allocate one entry for every symbol
3853 struct symtab_command *symLC = (struct symtab_command *) lc;
3855 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3858 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3860 return ocAllocateSymbolExtras(oc,0,0);
3864 static int ocVerifyImage_MachO(ObjectCode* oc)
3866 char *image = (char*) oc->image;
3867 struct mach_header *header = (struct mach_header*) image;
3869 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3870 if(header->magic != MH_MAGIC_64)
3873 if(header->magic != MH_MAGIC)
3876 // FIXME: do some more verifying here
3880 static int resolveImports(
3883 struct symtab_command *symLC,
3884 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3885 unsigned long *indirectSyms,
3886 struct nlist *nlist)
3889 size_t itemSize = 4;
3892 int isJumpTable = 0;
3893 if(!strcmp(sect->sectname,"__jump_table"))
3897 ASSERT(sect->reserved2 == itemSize);
3901 for(i=0; i*itemSize < sect->size;i++)
3903 // according to otool, reserved1 contains the first index into the indirect symbol table
3904 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3905 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3908 if((symbol->n_type & N_TYPE) == N_UNDF
3909 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3910 addr = (void*) (symbol->n_value);
3911 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3914 addr = lookupSymbol(nm);
3917 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3925 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3926 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3927 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3928 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3933 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3934 ((void**)(image + sect->offset))[i] = addr;
3941 static unsigned long relocateAddress(
3944 struct section* sections,
3945 unsigned long address)
3948 for(i = 0; i < nSections; i++)
3950 if(sections[i].addr <= address
3951 && address < sections[i].addr + sections[i].size)
3953 return (unsigned long)oc->image
3954 + sections[i].offset + address - sections[i].addr;
3957 barf("Invalid Mach-O file:"
3958 "Address out of bounds while relocating object file");
3962 static int relocateSection(
3965 struct symtab_command *symLC, struct nlist *nlist,
3966 int nSections, struct section* sections, struct section *sect)
3968 struct relocation_info *relocs;
3971 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3973 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3975 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3977 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3981 relocs = (struct relocation_info*) (image + sect->reloff);
3985 #ifdef x86_64_HOST_ARCH
3986 struct relocation_info *reloc = &relocs[i];
3988 char *thingPtr = image + sect->offset + reloc->r_address;
3992 int type = reloc->r_type;
3994 checkProddableBlock(oc,thingPtr);
3995 switch(reloc->r_length)
3998 thing = *(uint8_t*)thingPtr;
3999 baseValue = (uint64_t)thingPtr + 1;
4002 thing = *(uint16_t*)thingPtr;
4003 baseValue = (uint64_t)thingPtr + 2;
4006 thing = *(uint32_t*)thingPtr;
4007 baseValue = (uint64_t)thingPtr + 4;
4010 thing = *(uint64_t*)thingPtr;
4011 baseValue = (uint64_t)thingPtr + 8;
4014 barf("Unknown size.");
4017 if(type == X86_64_RELOC_GOT
4018 || type == X86_64_RELOC_GOT_LOAD)
4020 ASSERT(reloc->r_extern);
4021 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
4023 type = X86_64_RELOC_SIGNED;
4025 else if(reloc->r_extern)
4027 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4028 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4029 if(symbol->n_value == 0)
4030 value = (uint64_t) lookupSymbol(nm);
4032 value = relocateAddress(oc, nSections, sections,
4037 value = sections[reloc->r_symbolnum-1].offset
4038 - sections[reloc->r_symbolnum-1].addr
4042 if(type == X86_64_RELOC_BRANCH)
4044 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4046 ASSERT(reloc->r_extern);
4047 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4050 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4051 type = X86_64_RELOC_SIGNED;
4056 case X86_64_RELOC_UNSIGNED:
4057 ASSERT(!reloc->r_pcrel);
4060 case X86_64_RELOC_SIGNED:
4061 ASSERT(reloc->r_pcrel);
4062 thing += value - baseValue;
4064 case X86_64_RELOC_SUBTRACTOR:
4065 ASSERT(!reloc->r_pcrel);
4069 barf("unkown relocation");
4072 switch(reloc->r_length)
4075 *(uint8_t*)thingPtr = thing;
4078 *(uint16_t*)thingPtr = thing;
4081 *(uint32_t*)thingPtr = thing;
4084 *(uint64_t*)thingPtr = thing;
4088 if(relocs[i].r_address & R_SCATTERED)
4090 struct scattered_relocation_info *scat =
4091 (struct scattered_relocation_info*) &relocs[i];
4095 if(scat->r_length == 2)
4097 unsigned long word = 0;
4098 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4099 checkProddableBlock(oc,wordPtr);
4101 // Note on relocation types:
4102 // i386 uses the GENERIC_RELOC_* types,
4103 // while ppc uses special PPC_RELOC_* types.
4104 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4105 // in both cases, all others are different.
4106 // Therefore, we use GENERIC_RELOC_VANILLA
4107 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4108 // and use #ifdefs for the other types.
4110 // Step 1: Figure out what the relocated value should be
4111 if(scat->r_type == GENERIC_RELOC_VANILLA)
4113 word = *wordPtr + (unsigned long) relocateAddress(
4120 #ifdef powerpc_HOST_ARCH
4121 else if(scat->r_type == PPC_RELOC_SECTDIFF
4122 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4123 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4124 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4126 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4129 struct scattered_relocation_info *pair =
4130 (struct scattered_relocation_info*) &relocs[i+1];
4132 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4133 barf("Invalid Mach-O file: "
4134 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4136 word = (unsigned long)
4137 (relocateAddress(oc, nSections, sections, scat->r_value)
4138 - relocateAddress(oc, nSections, sections, pair->r_value));
4141 #ifdef powerpc_HOST_ARCH
4142 else if(scat->r_type == PPC_RELOC_HI16
4143 || scat->r_type == PPC_RELOC_LO16
4144 || scat->r_type == PPC_RELOC_HA16
4145 || scat->r_type == PPC_RELOC_LO14)
4146 { // these are generated by label+offset things
4147 struct relocation_info *pair = &relocs[i+1];
4148 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4149 barf("Invalid Mach-O file: "
4150 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4152 if(scat->r_type == PPC_RELOC_LO16)
4154 word = ((unsigned short*) wordPtr)[1];
4155 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4157 else if(scat->r_type == PPC_RELOC_LO14)
4159 barf("Unsupported Relocation: PPC_RELOC_LO14");
4160 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4161 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4163 else if(scat->r_type == PPC_RELOC_HI16)
4165 word = ((unsigned short*) wordPtr)[1] << 16;
4166 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4168 else if(scat->r_type == PPC_RELOC_HA16)
4170 word = ((unsigned short*) wordPtr)[1] << 16;
4171 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4175 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4182 continue; // ignore the others
4184 #ifdef powerpc_HOST_ARCH
4185 if(scat->r_type == GENERIC_RELOC_VANILLA
4186 || scat->r_type == PPC_RELOC_SECTDIFF)
4188 if(scat->r_type == GENERIC_RELOC_VANILLA
4189 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4194 #ifdef powerpc_HOST_ARCH
4195 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4197 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4199 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4201 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4203 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4205 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4206 + ((word & (1<<15)) ? 1 : 0);
4212 continue; // FIXME: I hope it's OK to ignore all the others.
4216 struct relocation_info *reloc = &relocs[i];
4217 if(reloc->r_pcrel && !reloc->r_extern)
4220 if(reloc->r_length == 2)
4222 unsigned long word = 0;
4223 #ifdef powerpc_HOST_ARCH
4224 unsigned long jumpIsland = 0;
4225 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4226 // to avoid warning and to catch
4230 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4231 checkProddableBlock(oc,wordPtr);
4233 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4237 #ifdef powerpc_HOST_ARCH
4238 else if(reloc->r_type == PPC_RELOC_LO16)
4240 word = ((unsigned short*) wordPtr)[1];
4241 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4243 else if(reloc->r_type == PPC_RELOC_HI16)
4245 word = ((unsigned short*) wordPtr)[1] << 16;
4246 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4248 else if(reloc->r_type == PPC_RELOC_HA16)
4250 word = ((unsigned short*) wordPtr)[1] << 16;
4251 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4253 else if(reloc->r_type == PPC_RELOC_BR24)
4256 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4260 if(!reloc->r_extern)
4263 sections[reloc->r_symbolnum-1].offset
4264 - sections[reloc->r_symbolnum-1].addr
4271 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4272 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4273 void *symbolAddress = lookupSymbol(nm);
4276 errorBelch("\nunknown symbol `%s'", nm);
4282 #ifdef powerpc_HOST_ARCH
4283 // In the .o file, this should be a relative jump to NULL
4284 // and we'll change it to a relative jump to the symbol
4285 ASSERT(word + reloc->r_address == 0);
4286 jumpIsland = (unsigned long)
4287 &makeSymbolExtra(oc,
4289 (unsigned long) symbolAddress)
4293 offsetToJumpIsland = word + jumpIsland
4294 - (((long)image) + sect->offset - sect->addr);
4297 word += (unsigned long) symbolAddress
4298 - (((long)image) + sect->offset - sect->addr);
4302 word += (unsigned long) symbolAddress;
4306 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4311 #ifdef powerpc_HOST_ARCH
4312 else if(reloc->r_type == PPC_RELOC_LO16)
4314 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4317 else if(reloc->r_type == PPC_RELOC_HI16)
4319 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4322 else if(reloc->r_type == PPC_RELOC_HA16)
4324 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4325 + ((word & (1<<15)) ? 1 : 0);
4328 else if(reloc->r_type == PPC_RELOC_BR24)
4330 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4332 // The branch offset is too large.
4333 // Therefore, we try to use a jump island.
4336 barf("unconditional relative branch out of range: "
4337 "no jump island available");
4340 word = offsetToJumpIsland;
4341 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4342 barf("unconditional relative branch out of range: "
4343 "jump island out of range");
4345 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4350 barf("\nunknown relocation %d",reloc->r_type);
4358 static int ocGetNames_MachO(ObjectCode* oc)
4360 char *image = (char*) oc->image;
4361 struct mach_header *header = (struct mach_header*) image;
4362 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4363 unsigned i,curSymbol = 0;
4364 struct segment_command *segLC = NULL;
4365 struct section *sections;
4366 struct symtab_command *symLC = NULL;
4367 struct nlist *nlist;
4368 unsigned long commonSize = 0;
4369 char *commonStorage = NULL;
4370 unsigned long commonCounter;
4372 for(i=0;i<header->ncmds;i++)
4374 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4375 segLC = (struct segment_command*) lc;
4376 else if(lc->cmd == LC_SYMTAB)
4377 symLC = (struct symtab_command*) lc;
4378 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4381 sections = (struct section*) (segLC+1);
4382 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4386 barf("ocGetNames_MachO: no segment load command");
4388 for(i=0;i<segLC->nsects;i++)
4390 if(sections[i].size == 0)
4393 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4395 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4396 "ocGetNames_MachO(common symbols)");
4397 sections[i].offset = zeroFillArea - image;
4400 if(!strcmp(sections[i].sectname,"__text"))
4401 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4402 (void*) (image + sections[i].offset),
4403 (void*) (image + sections[i].offset + sections[i].size));
4404 else if(!strcmp(sections[i].sectname,"__const"))
4405 addSection(oc, SECTIONKIND_RWDATA,
4406 (void*) (image + sections[i].offset),
4407 (void*) (image + sections[i].offset + sections[i].size));
4408 else if(!strcmp(sections[i].sectname,"__data"))
4409 addSection(oc, SECTIONKIND_RWDATA,
4410 (void*) (image + sections[i].offset),
4411 (void*) (image + sections[i].offset + sections[i].size));
4412 else if(!strcmp(sections[i].sectname,"__bss")
4413 || !strcmp(sections[i].sectname,"__common"))
4414 addSection(oc, SECTIONKIND_RWDATA,
4415 (void*) (image + sections[i].offset),
4416 (void*) (image + sections[i].offset + sections[i].size));
4418 addProddableBlock(oc, (void*) (image + sections[i].offset),
4422 // count external symbols defined here
4426 for(i=0;i<symLC->nsyms;i++)
4428 if(nlist[i].n_type & N_STAB)
4430 else if(nlist[i].n_type & N_EXT)
4432 if((nlist[i].n_type & N_TYPE) == N_UNDF
4433 && (nlist[i].n_value != 0))
4435 commonSize += nlist[i].n_value;
4438 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4443 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4444 "ocGetNames_MachO(oc->symbols)");
4448 for(i=0;i<symLC->nsyms;i++)
4450 if(nlist[i].n_type & N_STAB)
4452 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4454 if(nlist[i].n_type & N_EXT)
4456 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4457 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4458 ; // weak definition, and we already have a definition
4461 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4463 + sections[nlist[i].n_sect-1].offset
4464 - sections[nlist[i].n_sect-1].addr
4465 + nlist[i].n_value);
4466 oc->symbols[curSymbol++] = nm;
4473 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4474 commonCounter = (unsigned long)commonStorage;
4477 for(i=0;i<symLC->nsyms;i++)
4479 if((nlist[i].n_type & N_TYPE) == N_UNDF
4480 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4482 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4483 unsigned long sz = nlist[i].n_value;
4485 nlist[i].n_value = commonCounter;
4487 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4488 (void*)commonCounter);
4489 oc->symbols[curSymbol++] = nm;
4491 commonCounter += sz;
4498 static int ocResolve_MachO(ObjectCode* oc)
4500 char *image = (char*) oc->image;
4501 struct mach_header *header = (struct mach_header*) image;
4502 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4504 struct segment_command *segLC = NULL;
4505 struct section *sections;
4506 struct symtab_command *symLC = NULL;
4507 struct dysymtab_command *dsymLC = NULL;
4508 struct nlist *nlist;
4510 for(i=0;i<header->ncmds;i++)
4512 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4513 segLC = (struct segment_command*) lc;
4514 else if(lc->cmd == LC_SYMTAB)
4515 symLC = (struct symtab_command*) lc;
4516 else if(lc->cmd == LC_DYSYMTAB)
4517 dsymLC = (struct dysymtab_command*) lc;
4518 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4521 sections = (struct section*) (segLC+1);
4522 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4527 unsigned long *indirectSyms
4528 = (unsigned long*) (image + dsymLC->indirectsymoff);
4530 for(i=0;i<segLC->nsects;i++)
4532 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4533 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4534 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4536 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4539 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4540 || !strcmp(sections[i].sectname,"__pointers"))
4542 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4545 else if(!strcmp(sections[i].sectname,"__jump_table"))
4547 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4553 for(i=0;i<segLC->nsects;i++)
4555 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4559 /* Free the local symbol table; we won't need it again. */
4560 freeHashTable(oc->lochash, NULL);
4563 #if defined (powerpc_HOST_ARCH)
4564 ocFlushInstructionCache( oc );
4570 #ifdef powerpc_HOST_ARCH
4572 * The Mach-O object format uses leading underscores. But not everywhere.
4573 * There is a small number of runtime support functions defined in
4574 * libcc_dynamic.a whose name does not have a leading underscore.
4575 * As a consequence, we can't get their address from C code.
4576 * We have to use inline assembler just to take the address of a function.
4580 static void machoInitSymbolsWithoutUnderscore()
4582 extern void* symbolsWithoutUnderscore[];
4583 void **p = symbolsWithoutUnderscore;
4584 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4588 __asm__ volatile(".long " # x);
4590 RTS_MACHO_NOUNDERLINE_SYMBOLS
4592 __asm__ volatile(".text");
4596 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4598 RTS_MACHO_NOUNDERLINE_SYMBOLS
4605 * Figure out by how much to shift the entire Mach-O file in memory
4606 * when loading so that its single segment ends up 16-byte-aligned
4608 static int machoGetMisalignment( FILE * f )
4610 struct mach_header header;
4613 fread(&header, sizeof(header), 1, f);
4616 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4617 if(header.magic != MH_MAGIC_64)
4620 if(header.magic != MH_MAGIC)
4624 misalignment = (header.sizeofcmds + sizeof(header))
4627 return misalignment ? (16 - misalignment) : 0;