1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2000-2004
7 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
13 /* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14 MREMAP_MAYMOVE from <sys/mman.h>.
25 #include "LinkerInternals.h"
29 #include "RtsTypeable.h"
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
42 #if defined(HAVE_DLFCN_H)
46 #if defined(cygwin32_HOST_OS)
51 #ifdef HAVE_SYS_TIME_H
55 #include <sys/fcntl.h>
56 #include <sys/termios.h>
57 #include <sys/utime.h>
58 #include <sys/utsname.h>
62 #if defined(ia64_HOST_ARCH) || defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
67 #if defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
75 #if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
76 # define OBJFORMAT_ELF
77 #elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
78 # define OBJFORMAT_PEi386
81 #elif defined(darwin_HOST_OS)
82 # define OBJFORMAT_MACHO
83 # include <mach-o/loader.h>
84 # include <mach-o/nlist.h>
85 # include <mach-o/reloc.h>
86 #if !defined(HAVE_DLFCN_H)
87 # include <mach-o/dyld.h>
89 #if defined(powerpc_HOST_ARCH)
90 # include <mach-o/ppc/reloc.h>
92 #if defined(x86_64_HOST_ARCH)
93 # include <mach-o/x86_64/reloc.h>
97 /* Hash table mapping symbol names to Symbol */
98 static /*Str*/HashTable *symhash;
100 /* Hash table mapping symbol names to StgStablePtr */
101 static /*Str*/HashTable *stablehash;
103 /* List of currently loaded objects */
104 ObjectCode *objects = NULL; /* initially empty */
106 #if defined(OBJFORMAT_ELF)
107 static int ocVerifyImage_ELF ( ObjectCode* oc );
108 static int ocGetNames_ELF ( ObjectCode* oc );
109 static int ocResolve_ELF ( ObjectCode* oc );
110 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
111 static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
113 #elif defined(OBJFORMAT_PEi386)
114 static int ocVerifyImage_PEi386 ( ObjectCode* oc );
115 static int ocGetNames_PEi386 ( ObjectCode* oc );
116 static int ocResolve_PEi386 ( ObjectCode* oc );
117 #elif defined(OBJFORMAT_MACHO)
118 static int ocVerifyImage_MachO ( ObjectCode* oc );
119 static int ocGetNames_MachO ( ObjectCode* oc );
120 static int ocResolve_MachO ( ObjectCode* oc );
122 static int machoGetMisalignment( FILE * );
123 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
124 static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
126 #ifdef powerpc_HOST_ARCH
127 static void machoInitSymbolsWithoutUnderscore( void );
131 /* on x86_64 we have a problem with relocating symbol references in
132 * code that was compiled without -fPIC. By default, the small memory
133 * model is used, which assumes that symbol references can fit in a
134 * 32-bit slot. The system dynamic linker makes this work for
135 * references to shared libraries by either (a) allocating a jump
136 * table slot for code references, or (b) moving the symbol at load
137 * time (and copying its contents, if necessary) for data references.
139 * We unfortunately can't tell whether symbol references are to code
140 * or data. So for now we assume they are code (the vast majority
141 * are), and allocate jump-table slots. Unfortunately this will
142 * SILENTLY generate crashing code for data references. This hack is
143 * enabled by X86_64_ELF_NONPIC_HACK.
145 * One workaround is to use shared Haskell libraries. This is
146 * coming. Another workaround is to keep the static libraries but
147 * compile them with -fPIC, because that will generate PIC references
148 * to data which can be relocated. The PIC code is still too green to
149 * do this systematically, though.
152 * See thread http://www.haskell.org/pipermail/cvs-ghc/2007-September/038458.html
154 #define X86_64_ELF_NONPIC_HACK 1
156 /* -----------------------------------------------------------------------------
157 * Built-in symbols from the RTS
160 typedef struct _RtsSymbolVal {
167 #define Maybe_Stable_Names SymX(mkWeakzh_fast) \
168 SymX(makeStableNamezh_fast) \
169 SymX(finalizzeWeakzh_fast)
171 /* These are not available in GUM!!! -- HWL */
172 #define Maybe_Stable_Names
175 #if !defined (mingw32_HOST_OS)
176 #define RTS_POSIX_ONLY_SYMBOLS \
179 SymX(signal_handlers) \
180 SymX(stg_sig_install) \
184 #if defined (cygwin32_HOST_OS)
185 #define RTS_MINGW_ONLY_SYMBOLS /**/
186 /* Don't have the ability to read import libs / archives, so
187 * we have to stupidly list a lot of what libcygwin.a
190 #define RTS_CYGWIN_ONLY_SYMBOLS \
268 #elif !defined(mingw32_HOST_OS)
269 #define RTS_MINGW_ONLY_SYMBOLS /**/
270 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
271 #else /* defined(mingw32_HOST_OS) */
272 #define RTS_POSIX_ONLY_SYMBOLS /**/
273 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
275 /* Extra syms gen'ed by mingw-2's gcc-3.2: */
277 #define RTS_MINGW_EXTRA_SYMS \
278 Sym(_imp____mb_cur_max) \
281 #define RTS_MINGW_EXTRA_SYMS
284 #if HAVE_GETTIMEOFDAY
285 #define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
287 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
290 /* These are statically linked from the mingw libraries into the ghc
291 executable, so we have to employ this hack. */
292 #define RTS_MINGW_ONLY_SYMBOLS \
293 SymX(asyncReadzh_fast) \
294 SymX(asyncWritezh_fast) \
295 SymX(asyncDoProczh_fast) \
307 SymX(getservbyname) \
308 SymX(getservbyport) \
309 SymX(getprotobynumber) \
310 SymX(getprotobyname) \
311 SymX(gethostbyname) \
312 SymX(gethostbyaddr) \
359 SymX(rts_InstallConsoleEvent) \
360 SymX(rts_ConsoleHandlerDone) \
362 Sym(_imp___timezone) \
372 RTS_MINGW_EXTRA_SYMS \
373 RTS_MINGW_GETTIMEOFDAY_SYM \
377 #if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
378 #define RTS_DARWIN_ONLY_SYMBOLS \
379 Sym(asprintf$LDBLStub) \
383 Sym(fprintf$LDBLStub) \
384 Sym(fscanf$LDBLStub) \
385 Sym(fwprintf$LDBLStub) \
386 Sym(fwscanf$LDBLStub) \
387 Sym(printf$LDBLStub) \
388 Sym(scanf$LDBLStub) \
389 Sym(snprintf$LDBLStub) \
390 Sym(sprintf$LDBLStub) \
391 Sym(sscanf$LDBLStub) \
392 Sym(strtold$LDBLStub) \
393 Sym(swprintf$LDBLStub) \
394 Sym(swscanf$LDBLStub) \
395 Sym(syslog$LDBLStub) \
396 Sym(vasprintf$LDBLStub) \
398 Sym(verrc$LDBLStub) \
399 Sym(verrx$LDBLStub) \
400 Sym(vfprintf$LDBLStub) \
401 Sym(vfscanf$LDBLStub) \
402 Sym(vfwprintf$LDBLStub) \
403 Sym(vfwscanf$LDBLStub) \
404 Sym(vprintf$LDBLStub) \
405 Sym(vscanf$LDBLStub) \
406 Sym(vsnprintf$LDBLStub) \
407 Sym(vsprintf$LDBLStub) \
408 Sym(vsscanf$LDBLStub) \
409 Sym(vswprintf$LDBLStub) \
410 Sym(vswscanf$LDBLStub) \
411 Sym(vsyslog$LDBLStub) \
412 Sym(vwarn$LDBLStub) \
413 Sym(vwarnc$LDBLStub) \
414 Sym(vwarnx$LDBLStub) \
415 Sym(vwprintf$LDBLStub) \
416 Sym(vwscanf$LDBLStub) \
418 Sym(warnc$LDBLStub) \
419 Sym(warnx$LDBLStub) \
420 Sym(wcstold$LDBLStub) \
421 Sym(wprintf$LDBLStub) \
424 #define RTS_DARWIN_ONLY_SYMBOLS
428 # define MAIN_CAP_SYM SymX(MainCapability)
430 # define MAIN_CAP_SYM
433 #if !defined(mingw32_HOST_OS)
434 #define RTS_USER_SIGNALS_SYMBOLS \
435 SymX(setIOManagerPipe)
437 #define RTS_USER_SIGNALS_SYMBOLS \
438 SymX(sendIOManagerEvent) \
439 SymX(readIOManagerEvent) \
440 SymX(getIOManagerEvent) \
441 SymX(console_handler)
444 #ifdef TABLES_NEXT_TO_CODE
445 #define RTS_RET_SYMBOLS /* nothing */
447 #define RTS_RET_SYMBOLS \
448 SymX(stg_enter_ret) \
449 SymX(stg_gc_fun_ret) \
456 SymX(stg_ap_pv_ret) \
457 SymX(stg_ap_pp_ret) \
458 SymX(stg_ap_ppv_ret) \
459 SymX(stg_ap_ppp_ret) \
460 SymX(stg_ap_pppv_ret) \
461 SymX(stg_ap_pppp_ret) \
462 SymX(stg_ap_ppppp_ret) \
463 SymX(stg_ap_pppppp_ret)
466 #define RTS_SYMBOLS \
469 SymX(stg_enter_info) \
470 SymX(stg_gc_void_info) \
471 SymX(__stg_gc_enter_1) \
472 SymX(stg_gc_noregs) \
473 SymX(stg_gc_unpt_r1_info) \
474 SymX(stg_gc_unpt_r1) \
475 SymX(stg_gc_unbx_r1_info) \
476 SymX(stg_gc_unbx_r1) \
477 SymX(stg_gc_f1_info) \
479 SymX(stg_gc_d1_info) \
481 SymX(stg_gc_l1_info) \
484 SymX(stg_gc_fun_info) \
486 SymX(stg_gc_gen_info) \
487 SymX(stg_gc_gen_hp) \
489 SymX(stg_gen_yield) \
490 SymX(stg_yield_noregs) \
491 SymX(stg_yield_to_interpreter) \
492 SymX(stg_gen_block) \
493 SymX(stg_block_noregs) \
495 SymX(stg_block_takemvar) \
496 SymX(stg_block_putmvar) \
498 SymX(MallocFailHook) \
500 SymX(OutOfHeapHook) \
501 SymX(StackOverflowHook) \
502 SymX(__encodeDouble) \
503 SymX(__encodeFloat) \
505 SymExtern(__gmpn_gcd_1) \
506 SymExtern(__gmpz_cmp) \
507 SymExtern(__gmpz_cmp_si) \
508 SymExtern(__gmpz_cmp_ui) \
509 SymExtern(__gmpz_get_si) \
510 SymExtern(__gmpz_get_ui) \
511 SymX(__int_encodeDouble) \
512 SymX(__int_encodeFloat) \
513 SymX(andIntegerzh_fast) \
514 SymX(atomicallyzh_fast) \
518 SymX(blockAsyncExceptionszh_fast) \
520 SymX(catchRetryzh_fast) \
521 SymX(catchSTMzh_fast) \
523 SymX(closure_flags) \
525 SymX(cmpIntegerzh_fast) \
526 SymX(cmpIntegerIntzh_fast) \
527 SymX(complementIntegerzh_fast) \
528 SymX(createAdjustor) \
529 SymX(decodeDoublezh_fast) \
530 SymX(decodeFloatzh_fast) \
533 SymX(deRefWeakzh_fast) \
534 SymX(deRefStablePtrzh_fast) \
535 SymX(dirty_MUT_VAR) \
536 SymX(divExactIntegerzh_fast) \
537 SymX(divModIntegerzh_fast) \
539 SymX(forkOnzh_fast) \
541 SymX(forkOS_createThread) \
542 SymX(freeHaskellFunctionPtr) \
543 SymX(freeStablePtr) \
544 SymX(getOrSetTypeableStore) \
545 SymX(gcdIntegerzh_fast) \
546 SymX(gcdIntegerIntzh_fast) \
547 SymX(gcdIntzh_fast) \
551 SymX(getFullProgArgv) \
557 SymX(hs_perform_gc) \
558 SymX(hs_free_stable_ptr) \
559 SymX(hs_free_fun_ptr) \
560 SymX(hs_hpc_rootModule) \
562 SymX(unpackClosurezh_fast) \
563 SymX(getApStackValzh_fast) \
564 SymX(int2Integerzh_fast) \
565 SymX(integer2Intzh_fast) \
566 SymX(integer2Wordzh_fast) \
567 SymX(isCurrentThreadBoundzh_fast) \
568 SymX(isDoubleDenormalized) \
569 SymX(isDoubleInfinite) \
571 SymX(isDoubleNegativeZero) \
572 SymX(isEmptyMVarzh_fast) \
573 SymX(isFloatDenormalized) \
574 SymX(isFloatInfinite) \
576 SymX(isFloatNegativeZero) \
577 SymX(killThreadzh_fast) \
579 SymX(insertStableSymbol) \
582 SymX(makeStablePtrzh_fast) \
583 SymX(minusIntegerzh_fast) \
584 SymX(mkApUpd0zh_fast) \
585 SymX(myThreadIdzh_fast) \
586 SymX(labelThreadzh_fast) \
587 SymX(newArrayzh_fast) \
588 SymX(newBCOzh_fast) \
589 SymX(newByteArrayzh_fast) \
590 SymX_redirect(newCAF, newDynCAF) \
591 SymX(newMVarzh_fast) \
592 SymX(newMutVarzh_fast) \
593 SymX(newTVarzh_fast) \
594 SymX(noDuplicatezh_fast) \
595 SymX(atomicModifyMutVarzh_fast) \
596 SymX(newPinnedByteArrayzh_fast) \
598 SymX(orIntegerzh_fast) \
600 SymX(performMajorGC) \
601 SymX(plusIntegerzh_fast) \
604 SymX(putMVarzh_fast) \
605 SymX(quotIntegerzh_fast) \
606 SymX(quotRemIntegerzh_fast) \
608 SymX(raiseIOzh_fast) \
609 SymX(readTVarzh_fast) \
610 SymX(remIntegerzh_fast) \
611 SymX(resetNonBlockingFd) \
616 SymX(rts_checkSchedStatus) \
619 SymX(rts_evalLazyIO) \
620 SymX(rts_evalStableIO) \
624 SymX(rts_getDouble) \
632 SymX(rts_getFunPtr) \
633 SymX(rts_getStablePtr) \
634 SymX(rts_getThreadId) \
637 SymX(rts_getWord16) \
638 SymX(rts_getWord32) \
639 SymX(rts_getWord64) \
652 SymX(rts_mkStablePtr) \
660 SymX(rtsSupportsBoundThreads) \
661 SymX(__hscore_get_saved_termios) \
662 SymX(__hscore_set_saved_termios) \
664 SymX(startupHaskell) \
665 SymX(shutdownHaskell) \
666 SymX(shutdownHaskellAndExit) \
667 SymX(stable_ptr_table) \
668 SymX(stackOverflow) \
669 SymX(stg_CAF_BLACKHOLE_info) \
670 SymX(awakenBlockedQueue) \
671 SymX(stg_CHARLIKE_closure) \
672 SymX(stg_MVAR_CLEAN_info) \
673 SymX(stg_MVAR_DIRTY_info) \
674 SymX(stg_IND_STATIC_info) \
675 SymX(stg_INTLIKE_closure) \
676 SymX(stg_MUT_ARR_PTRS_DIRTY_info) \
677 SymX(stg_MUT_ARR_PTRS_FROZEN_info) \
678 SymX(stg_MUT_ARR_PTRS_FROZEN0_info) \
679 SymX(stg_WEAK_info) \
680 SymX(stg_ap_v_info) \
681 SymX(stg_ap_f_info) \
682 SymX(stg_ap_d_info) \
683 SymX(stg_ap_l_info) \
684 SymX(stg_ap_n_info) \
685 SymX(stg_ap_p_info) \
686 SymX(stg_ap_pv_info) \
687 SymX(stg_ap_pp_info) \
688 SymX(stg_ap_ppv_info) \
689 SymX(stg_ap_ppp_info) \
690 SymX(stg_ap_pppv_info) \
691 SymX(stg_ap_pppp_info) \
692 SymX(stg_ap_ppppp_info) \
693 SymX(stg_ap_pppppp_info) \
694 SymX(stg_ap_0_fast) \
695 SymX(stg_ap_v_fast) \
696 SymX(stg_ap_f_fast) \
697 SymX(stg_ap_d_fast) \
698 SymX(stg_ap_l_fast) \
699 SymX(stg_ap_n_fast) \
700 SymX(stg_ap_p_fast) \
701 SymX(stg_ap_pv_fast) \
702 SymX(stg_ap_pp_fast) \
703 SymX(stg_ap_ppv_fast) \
704 SymX(stg_ap_ppp_fast) \
705 SymX(stg_ap_pppv_fast) \
706 SymX(stg_ap_pppp_fast) \
707 SymX(stg_ap_ppppp_fast) \
708 SymX(stg_ap_pppppp_fast) \
709 SymX(stg_ap_1_upd_info) \
710 SymX(stg_ap_2_upd_info) \
711 SymX(stg_ap_3_upd_info) \
712 SymX(stg_ap_4_upd_info) \
713 SymX(stg_ap_5_upd_info) \
714 SymX(stg_ap_6_upd_info) \
715 SymX(stg_ap_7_upd_info) \
717 SymX(stg_sel_0_upd_info) \
718 SymX(stg_sel_10_upd_info) \
719 SymX(stg_sel_11_upd_info) \
720 SymX(stg_sel_12_upd_info) \
721 SymX(stg_sel_13_upd_info) \
722 SymX(stg_sel_14_upd_info) \
723 SymX(stg_sel_15_upd_info) \
724 SymX(stg_sel_1_upd_info) \
725 SymX(stg_sel_2_upd_info) \
726 SymX(stg_sel_3_upd_info) \
727 SymX(stg_sel_4_upd_info) \
728 SymX(stg_sel_5_upd_info) \
729 SymX(stg_sel_6_upd_info) \
730 SymX(stg_sel_7_upd_info) \
731 SymX(stg_sel_8_upd_info) \
732 SymX(stg_sel_9_upd_info) \
733 SymX(stg_upd_frame_info) \
734 SymX(suspendThread) \
735 SymX(takeMVarzh_fast) \
736 SymX(timesIntegerzh_fast) \
737 SymX(tryPutMVarzh_fast) \
738 SymX(tryTakeMVarzh_fast) \
739 SymX(unblockAsyncExceptionszh_fast) \
741 SymX(unsafeThawArrayzh_fast) \
742 SymX(waitReadzh_fast) \
743 SymX(waitWritezh_fast) \
744 SymX(word2Integerzh_fast) \
745 SymX(writeTVarzh_fast) \
746 SymX(xorIntegerzh_fast) \
748 SymX(stg_interp_constr_entry) \
751 SymX(getAllocations) \
754 SymX(rts_breakpoint_io_action) \
755 SymX(rts_stop_next_breakpoint) \
756 SymX(rts_stop_on_exception) \
758 SymX(n_capabilities) \
759 RTS_USER_SIGNALS_SYMBOLS
761 #ifdef SUPPORT_LONG_LONGS
762 #define RTS_LONG_LONG_SYMS \
763 SymX(int64ToIntegerzh_fast) \
764 SymX(word64ToIntegerzh_fast)
766 #define RTS_LONG_LONG_SYMS /* nothing */
769 // 64-bit support functions in libgcc.a
770 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
771 #define RTS_LIBGCC_SYMBOLS \
781 #elif defined(ia64_HOST_ARCH)
782 #define RTS_LIBGCC_SYMBOLS \
790 #define RTS_LIBGCC_SYMBOLS
793 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
794 // Symbols that don't have a leading underscore
795 // on Mac OS X. They have to receive special treatment,
796 // see machoInitSymbolsWithoutUnderscore()
797 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
802 /* entirely bogus claims about types of these symbols */
803 #define Sym(vvv) extern void vvv(void);
804 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
805 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
807 #define SymExtern(vvv) SymX(vvv)
809 #define SymX(vvv) /**/
810 #define SymX_redirect(vvv,xxx) /**/
814 RTS_POSIX_ONLY_SYMBOLS
815 RTS_MINGW_ONLY_SYMBOLS
816 RTS_CYGWIN_ONLY_SYMBOLS
817 RTS_DARWIN_ONLY_SYMBOLS
824 #ifdef LEADING_UNDERSCORE
825 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
827 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
830 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
832 #define SymX(vvv) Sym(vvv)
833 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
834 (void*)DLL_IMPORT_DATA_REF(vvv) },
836 // SymX_redirect allows us to redirect references to one symbol to
837 // another symbol. See newCAF/newDynCAF for an example.
838 #define SymX_redirect(vvv,xxx) \
839 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
842 static RtsSymbolVal rtsSyms[] = {
846 RTS_POSIX_ONLY_SYMBOLS
847 RTS_MINGW_ONLY_SYMBOLS
848 RTS_CYGWIN_ONLY_SYMBOLS
849 RTS_DARWIN_ONLY_SYMBOLS
851 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
852 // dyld stub code contains references to this,
853 // but it should never be called because we treat
854 // lazy pointers as nonlazy.
855 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
857 { 0, 0 } /* sentinel */
862 /* -----------------------------------------------------------------------------
863 * Insert symbols into hash tables, checking for duplicates.
866 static void ghciInsertStrHashTable ( char* obj_name,
872 if (lookupHashTable(table, (StgWord)key) == NULL)
874 insertStrHashTable(table, (StgWord)key, data);
879 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
881 "whilst processing object file\n"
883 "This could be caused by:\n"
884 " * Loading two different object files which export the same symbol\n"
885 " * Specifying the same object file twice on the GHCi command line\n"
886 " * An incorrect `package.conf' entry, causing some object to be\n"
888 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
895 /* -----------------------------------------------------------------------------
896 * initialize the object linker
900 static int linker_init_done = 0 ;
902 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
903 static void *dl_prog_handle;
911 /* Make initLinker idempotent, so we can call it
912 before evey relevant operation; that means we
913 don't need to initialise the linker separately */
914 if (linker_init_done == 1) { return; } else {
915 linker_init_done = 1;
918 stablehash = allocStrHashTable();
919 symhash = allocStrHashTable();
921 /* populate the symbol table with stuff from the RTS */
922 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
923 ghciInsertStrHashTable("(GHCi built-in symbols)",
924 symhash, sym->lbl, sym->addr);
926 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
927 machoInitSymbolsWithoutUnderscore();
930 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
931 # if defined(RTLD_DEFAULT)
932 dl_prog_handle = RTLD_DEFAULT;
934 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
935 # endif /* RTLD_DEFAULT */
939 /* -----------------------------------------------------------------------------
940 * Loading DLL or .so dynamic libraries
941 * -----------------------------------------------------------------------------
943 * Add a DLL from which symbols may be found. In the ELF case, just
944 * do RTLD_GLOBAL-style add, so no further messing around needs to
945 * happen in order that symbols in the loaded .so are findable --
946 * lookupSymbol() will subsequently see them by dlsym on the program's
947 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
949 * In the PEi386 case, open the DLLs and put handles to them in a
950 * linked list. When looking for a symbol, try all handles in the
951 * list. This means that we need to load even DLLs that are guaranteed
952 * to be in the ghc.exe image already, just so we can get a handle
953 * to give to loadSymbol, so that we can find the symbols. For such
954 * libraries, the LoadLibrary call should be a no-op except for returning
959 #if defined(OBJFORMAT_PEi386)
960 /* A record for storing handles into DLLs. */
965 struct _OpenedDLL* next;
970 /* A list thereof. */
971 static OpenedDLL* opened_dlls = NULL;
975 addDLL( char *dll_name )
977 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
978 /* ------------------- ELF DLL loader ------------------- */
984 hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
987 /* dlopen failed; return a ptr to the error msg. */
989 if (errmsg == NULL) errmsg = "addDLL: unknown error";
996 # elif defined(OBJFORMAT_PEi386)
997 /* ------------------- Win32 DLL loader ------------------- */
1005 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1007 /* See if we've already got it, and ignore if so. */
1008 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1009 if (0 == strcmp(o_dll->name, dll_name))
1013 /* The file name has no suffix (yet) so that we can try
1014 both foo.dll and foo.drv
1016 The documentation for LoadLibrary says:
1017 If no file name extension is specified in the lpFileName
1018 parameter, the default library extension .dll is
1019 appended. However, the file name string can include a trailing
1020 point character (.) to indicate that the module name has no
1023 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1024 sprintf(buf, "%s.DLL", dll_name);
1025 instance = LoadLibrary(buf);
1026 if (instance == NULL) {
1027 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1028 instance = LoadLibrary(buf);
1029 if (instance == NULL) {
1032 /* LoadLibrary failed; return a ptr to the error msg. */
1033 return "addDLL: unknown error";
1038 /* Add this DLL to the list of DLLs in which to search for symbols. */
1039 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1040 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1041 strcpy(o_dll->name, dll_name);
1042 o_dll->instance = instance;
1043 o_dll->next = opened_dlls;
1044 opened_dlls = o_dll;
1048 barf("addDLL: not implemented on this platform");
1052 /* -----------------------------------------------------------------------------
1053 * insert a stable symbol in the hash table
1057 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1059 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1063 /* -----------------------------------------------------------------------------
1064 * insert a symbol in the hash table
1067 insertSymbol(char* obj_name, char* key, void* data)
1069 ghciInsertStrHashTable(obj_name, symhash, key, data);
1072 /* -----------------------------------------------------------------------------
1073 * lookup a symbol in the hash table
1076 lookupSymbol( char *lbl )
1080 ASSERT(symhash != NULL);
1081 val = lookupStrHashTable(symhash, lbl);
1084 # if defined(OBJFORMAT_ELF)
1085 return dlsym(dl_prog_handle, lbl);
1086 # elif defined(OBJFORMAT_MACHO)
1088 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1091 HACK: On OS X, global symbols are prefixed with an underscore.
1092 However, dlsym wants us to omit the leading underscore from the
1093 symbol name. For now, we simply strip it off here (and ONLY
1096 ASSERT(lbl[0] == '_');
1097 return dlsym(dl_prog_handle, lbl+1);
1099 if(NSIsSymbolNameDefined(lbl)) {
1100 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1101 return NSAddressOfSymbol(symbol);
1105 # endif /* HAVE_DLFCN_H */
1106 # elif defined(OBJFORMAT_PEi386)
1109 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1110 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1111 if (lbl[0] == '_') {
1112 /* HACK: if the name has an initial underscore, try stripping
1113 it off & look that up first. I've yet to verify whether there's
1114 a Rule that governs whether an initial '_' *should always* be
1115 stripped off when mapping from import lib name to the DLL name.
1117 sym = GetProcAddress(o_dll->instance, (lbl+1));
1119 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1123 sym = GetProcAddress(o_dll->instance, lbl);
1125 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1140 __attribute((unused))
1142 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1146 val = lookupStrHashTable(oc->lochash, lbl);
1156 /* -----------------------------------------------------------------------------
1157 * Debugging aid: look in GHCi's object symbol tables for symbols
1158 * within DELTA bytes of the specified address, and show their names.
1161 void ghci_enquire ( char* addr );
1163 void ghci_enquire ( char* addr )
1168 const int DELTA = 64;
1173 for (oc = objects; oc; oc = oc->next) {
1174 for (i = 0; i < oc->n_symbols; i++) {
1175 sym = oc->symbols[i];
1176 if (sym == NULL) continue;
1177 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1179 if (oc->lochash != NULL) {
1180 a = lookupStrHashTable(oc->lochash, sym);
1183 a = lookupStrHashTable(symhash, sym);
1186 // debugBelch("ghci_enquire: can't find %s\n", sym);
1188 else if (addr-DELTA <= a && a <= addr+DELTA) {
1189 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1196 #ifdef ia64_HOST_ARCH
1197 static unsigned int PLTSize(void);
1200 /* -----------------------------------------------------------------------------
1201 * Load an obj (populate the global symbol table, but don't resolve yet)
1203 * Returns: 1 if ok, 0 on error.
1206 loadObj( char *path )
1213 void *map_addr = NULL;
1219 /* debugBelch("loadObj %s\n", path ); */
1221 /* Check that we haven't already loaded this object.
1222 Ignore requests to load multiple times */
1226 for (o = objects; o; o = o->next) {
1227 if (0 == strcmp(o->fileName, path)) {
1229 break; /* don't need to search further */
1233 IF_DEBUG(linker, debugBelch(
1234 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1235 "same object file twice:\n"
1237 "GHCi will ignore this, but be warned.\n"
1239 return 1; /* success */
1243 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1245 # if defined(OBJFORMAT_ELF)
1246 oc->formatName = "ELF";
1247 # elif defined(OBJFORMAT_PEi386)
1248 oc->formatName = "PEi386";
1249 # elif defined(OBJFORMAT_MACHO)
1250 oc->formatName = "Mach-O";
1253 barf("loadObj: not implemented on this platform");
1256 r = stat(path, &st);
1257 if (r == -1) { return 0; }
1259 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1260 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1261 strcpy(oc->fileName, path);
1263 oc->fileSize = st.st_size;
1265 oc->sections = NULL;
1266 oc->lochash = allocStrHashTable();
1267 oc->proddables = NULL;
1269 /* chain it onto the list of objects */
1274 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1276 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1278 #if defined(openbsd_HOST_OS)
1279 fd = open(path, O_RDONLY, S_IRUSR);
1281 fd = open(path, O_RDONLY);
1284 barf("loadObj: can't open `%s'", path);
1286 pagesize = getpagesize();
1288 #ifdef ia64_HOST_ARCH
1289 /* The PLT needs to be right before the object */
1290 n = ROUND_UP(PLTSize(), pagesize);
1291 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1292 if (oc->plt == MAP_FAILED)
1293 barf("loadObj: can't allocate PLT");
1296 map_addr = oc->plt + n;
1299 n = ROUND_UP(oc->fileSize, pagesize);
1301 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1302 * small memory model on this architecture (see gcc docs,
1305 * MAP_32BIT not available on OpenBSD/amd64
1307 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
1308 #define EXTRA_MAP_FLAGS MAP_32BIT
1310 #define EXTRA_MAP_FLAGS 0
1313 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
1314 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
1315 #define MAP_ANONYMOUS MAP_ANON
1318 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1319 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1320 if (oc->image == MAP_FAILED)
1321 barf("loadObj: can't map `%s'", path);
1325 #else /* !USE_MMAP */
1327 /* load the image into memory */
1328 f = fopen(path, "rb");
1330 barf("loadObj: can't read `%s'", path);
1332 # if defined(mingw32_HOST_OS)
1333 // TODO: We would like to use allocateExec here, but allocateExec
1334 // cannot currently allocate blocks large enough.
1335 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1336 PAGE_EXECUTE_READWRITE);
1337 # elif defined(darwin_HOST_OS)
1338 // In a Mach-O .o file, all sections can and will be misaligned
1339 // if the total size of the headers is not a multiple of the
1340 // desired alignment. This is fine for .o files that only serve
1341 // as input for the static linker, but it's not fine for us,
1342 // as SSE (used by gcc for floating point) and Altivec require
1343 // 16-byte alignment.
1344 // We calculate the correct alignment from the header before
1345 // reading the file, and then we misalign oc->image on purpose so
1346 // that the actual sections end up aligned again.
1347 oc->misalignment = machoGetMisalignment(f);
1348 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1349 oc->image += oc->misalignment;
1351 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1354 n = fread ( oc->image, 1, oc->fileSize, f );
1355 if (n != oc->fileSize)
1356 barf("loadObj: error whilst reading `%s'", path);
1359 #endif /* USE_MMAP */
1361 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1362 r = ocAllocateSymbolExtras_MachO ( oc );
1363 if (!r) { return r; }
1364 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1365 r = ocAllocateSymbolExtras_ELF ( oc );
1366 if (!r) { return r; }
1369 /* verify the in-memory image */
1370 # if defined(OBJFORMAT_ELF)
1371 r = ocVerifyImage_ELF ( oc );
1372 # elif defined(OBJFORMAT_PEi386)
1373 r = ocVerifyImage_PEi386 ( oc );
1374 # elif defined(OBJFORMAT_MACHO)
1375 r = ocVerifyImage_MachO ( oc );
1377 barf("loadObj: no verify method");
1379 if (!r) { return r; }
1381 /* build the symbol list for this image */
1382 # if defined(OBJFORMAT_ELF)
1383 r = ocGetNames_ELF ( oc );
1384 # elif defined(OBJFORMAT_PEi386)
1385 r = ocGetNames_PEi386 ( oc );
1386 # elif defined(OBJFORMAT_MACHO)
1387 r = ocGetNames_MachO ( oc );
1389 barf("loadObj: no getNames method");
1391 if (!r) { return r; }
1393 /* loaded, but not resolved yet */
1394 oc->status = OBJECT_LOADED;
1399 /* -----------------------------------------------------------------------------
1400 * resolve all the currently unlinked objects in memory
1402 * Returns: 1 if ok, 0 on error.
1412 for (oc = objects; oc; oc = oc->next) {
1413 if (oc->status != OBJECT_RESOLVED) {
1414 # if defined(OBJFORMAT_ELF)
1415 r = ocResolve_ELF ( oc );
1416 # elif defined(OBJFORMAT_PEi386)
1417 r = ocResolve_PEi386 ( oc );
1418 # elif defined(OBJFORMAT_MACHO)
1419 r = ocResolve_MachO ( oc );
1421 barf("resolveObjs: not implemented on this platform");
1423 if (!r) { return r; }
1424 oc->status = OBJECT_RESOLVED;
1430 /* -----------------------------------------------------------------------------
1431 * delete an object from the pool
1434 unloadObj( char *path )
1436 ObjectCode *oc, *prev;
1438 ASSERT(symhash != NULL);
1439 ASSERT(objects != NULL);
1444 for (oc = objects; oc; prev = oc, oc = oc->next) {
1445 if (!strcmp(oc->fileName,path)) {
1447 /* Remove all the mappings for the symbols within this
1452 for (i = 0; i < oc->n_symbols; i++) {
1453 if (oc->symbols[i] != NULL) {
1454 removeStrHashTable(symhash, oc->symbols[i], NULL);
1462 prev->next = oc->next;
1465 // We're going to leave this in place, in case there are
1466 // any pointers from the heap into it:
1467 // #ifdef mingw32_HOST_OS
1468 // VirtualFree(oc->image);
1470 // stgFree(oc->image);
1472 stgFree(oc->fileName);
1473 stgFree(oc->symbols);
1474 stgFree(oc->sections);
1475 /* The local hash table should have been freed at the end
1476 of the ocResolve_ call on it. */
1477 ASSERT(oc->lochash == NULL);
1483 errorBelch("unloadObj: can't find `%s' to unload", path);
1487 /* -----------------------------------------------------------------------------
1488 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1489 * which may be prodded during relocation, and abort if we try and write
1490 * outside any of these.
1492 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1495 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1496 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1500 pb->next = oc->proddables;
1501 oc->proddables = pb;
1504 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1507 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1508 char* s = (char*)(pb->start);
1509 char* e = s + pb->size - 1;
1510 char* a = (char*)addr;
1511 /* Assumes that the biggest fixup involves a 4-byte write. This
1512 probably needs to be changed to 8 (ie, +7) on 64-bit
1514 if (a >= s && (a+3) <= e) return;
1516 barf("checkProddableBlock: invalid fixup in runtime linker");
1519 /* -----------------------------------------------------------------------------
1520 * Section management.
1522 static void addSection ( ObjectCode* oc, SectionKind kind,
1523 void* start, void* end )
1525 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1529 s->next = oc->sections;
1532 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1533 start, ((char*)end)-1, end - start + 1, kind );
1538 /* --------------------------------------------------------------------------
1540 * This is about allocating a small chunk of memory for every symbol in the
1541 * object file. We make sure that the SymboLExtras are always "in range" of
1542 * limited-range PC-relative instructions on various platforms by allocating
1543 * them right next to the object code itself.
1546 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
1549 ocAllocateSymbolExtras
1551 Allocate additional space at the end of the object file image to make room
1552 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1554 PowerPC relative branch instructions have a 24 bit displacement field.
1555 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1556 If a particular imported symbol is outside this range, we have to redirect
1557 the jump to a short piece of new code that just loads the 32bit absolute
1558 address and jumps there.
1559 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1562 This function just allocates space for one SymbolExtra for every
1563 undefined symbol in the object file. The code for the jump islands is
1564 filled in by makeSymbolExtra below.
1567 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1574 int misalignment = 0;
1575 #ifdef darwin_HOST_OS
1576 misalignment = oc->misalignment;
1582 // round up to the nearest 4
1583 aligned = (oc->fileSize + 3) & ~3;
1586 #ifndef linux_HOST_OS /* mremap is a linux extension */
1587 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1590 pagesize = getpagesize();
1591 n = ROUND_UP( oc->fileSize, pagesize );
1592 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1594 /* If we have a half-page-size file and map one page of it then
1595 * the part of the page after the size of the file remains accessible.
1596 * If, however, we map in 2 pages, the 2nd page is not accessible
1597 * and will give a "Bus Error" on access. To get around this, we check
1598 * if we need any extra pages for the jump islands and map them in
1599 * anonymously. We must check that we actually require extra pages
1600 * otherwise the attempt to mmap 0 pages of anonymous memory will
1606 /* The effect of this mremap() call is only the ensure that we have
1607 * a sufficient number of virtually contiguous pages. As returned from
1608 * mremap, the pages past the end of the file are not backed. We give
1609 * them a backing by using MAP_FIXED to map in anonymous pages.
1611 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1613 if( oc->image == MAP_FAILED )
1615 errorBelch( "Unable to mremap for Jump Islands\n" );
1619 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1620 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1622 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1628 oc->image -= misalignment;
1629 oc->image = stgReallocBytes( oc->image,
1631 aligned + sizeof (SymbolExtra) * count,
1632 "ocAllocateSymbolExtras" );
1633 oc->image += misalignment;
1634 #endif /* USE_MMAP */
1636 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1637 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1640 oc->symbol_extras = NULL;
1642 oc->first_symbol_extra = first;
1643 oc->n_symbol_extras = count;
1648 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1649 unsigned long symbolNumber,
1650 unsigned long target )
1654 ASSERT( symbolNumber >= oc->first_symbol_extra
1655 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1657 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1659 #ifdef powerpc_HOST_ARCH
1660 // lis r12, hi16(target)
1661 extra->jumpIsland.lis_r12 = 0x3d80;
1662 extra->jumpIsland.hi_addr = target >> 16;
1664 // ori r12, r12, lo16(target)
1665 extra->jumpIsland.ori_r12_r12 = 0x618c;
1666 extra->jumpIsland.lo_addr = target & 0xffff;
1669 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1672 extra->jumpIsland.bctr = 0x4e800420;
1674 #ifdef x86_64_HOST_ARCH
1676 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1677 extra->addr = target;
1678 memcpy(extra->jumpIsland, jmp, 6);
1686 /* --------------------------------------------------------------------------
1687 * PowerPC specifics (instruction cache flushing)
1688 * ------------------------------------------------------------------------*/
1690 #ifdef powerpc_TARGET_ARCH
1692 ocFlushInstructionCache
1694 Flush the data & instruction caches.
1695 Because the PPC has split data/instruction caches, we have to
1696 do that whenever we modify code at runtime.
1699 static void ocFlushInstructionCache( ObjectCode *oc )
1701 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1702 unsigned long *p = (unsigned long *) oc->image;
1706 __asm__ volatile ( "dcbf 0,%0\n\t"
1714 __asm__ volatile ( "sync\n\t"
1720 /* --------------------------------------------------------------------------
1721 * PEi386 specifics (Win32 targets)
1722 * ------------------------------------------------------------------------*/
1724 /* The information for this linker comes from
1725 Microsoft Portable Executable
1726 and Common Object File Format Specification
1727 revision 5.1 January 1998
1728 which SimonM says comes from the MS Developer Network CDs.
1730 It can be found there (on older CDs), but can also be found
1733 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1735 (this is Rev 6.0 from February 1999).
1737 Things move, so if that fails, try searching for it via
1739 http://www.google.com/search?q=PE+COFF+specification
1741 The ultimate reference for the PE format is the Winnt.h
1742 header file that comes with the Platform SDKs; as always,
1743 implementations will drift wrt their documentation.
1745 A good background article on the PE format is Matt Pietrek's
1746 March 1994 article in Microsoft System Journal (MSJ)
1747 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1748 Win32 Portable Executable File Format." The info in there
1749 has recently been updated in a two part article in
1750 MSDN magazine, issues Feb and March 2002,
1751 "Inside Windows: An In-Depth Look into the Win32 Portable
1752 Executable File Format"
1754 John Levine's book "Linkers and Loaders" contains useful
1759 #if defined(OBJFORMAT_PEi386)
1763 typedef unsigned char UChar;
1764 typedef unsigned short UInt16;
1765 typedef unsigned int UInt32;
1772 UInt16 NumberOfSections;
1773 UInt32 TimeDateStamp;
1774 UInt32 PointerToSymbolTable;
1775 UInt32 NumberOfSymbols;
1776 UInt16 SizeOfOptionalHeader;
1777 UInt16 Characteristics;
1781 #define sizeof_COFF_header 20
1788 UInt32 VirtualAddress;
1789 UInt32 SizeOfRawData;
1790 UInt32 PointerToRawData;
1791 UInt32 PointerToRelocations;
1792 UInt32 PointerToLinenumbers;
1793 UInt16 NumberOfRelocations;
1794 UInt16 NumberOfLineNumbers;
1795 UInt32 Characteristics;
1799 #define sizeof_COFF_section 40
1806 UInt16 SectionNumber;
1809 UChar NumberOfAuxSymbols;
1813 #define sizeof_COFF_symbol 18
1818 UInt32 VirtualAddress;
1819 UInt32 SymbolTableIndex;
1824 #define sizeof_COFF_reloc 10
1827 /* From PE spec doc, section 3.3.2 */
1828 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1829 windows.h -- for the same purpose, but I want to know what I'm
1831 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1832 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1833 #define MYIMAGE_FILE_DLL 0x2000
1834 #define MYIMAGE_FILE_SYSTEM 0x1000
1835 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1836 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1837 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1839 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1840 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1841 #define MYIMAGE_SYM_CLASS_STATIC 3
1842 #define MYIMAGE_SYM_UNDEFINED 0
1844 /* From PE spec doc, section 4.1 */
1845 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1846 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1847 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1849 /* From PE spec doc, section 5.2.1 */
1850 #define MYIMAGE_REL_I386_DIR32 0x0006
1851 #define MYIMAGE_REL_I386_REL32 0x0014
1854 /* We use myindex to calculate array addresses, rather than
1855 simply doing the normal subscript thing. That's because
1856 some of the above structs have sizes which are not
1857 a whole number of words. GCC rounds their sizes up to a
1858 whole number of words, which means that the address calcs
1859 arising from using normal C indexing or pointer arithmetic
1860 are just plain wrong. Sigh.
1863 myindex ( int scale, void* base, int index )
1866 ((UChar*)base) + scale * index;
1871 printName ( UChar* name, UChar* strtab )
1873 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1874 UInt32 strtab_offset = * (UInt32*)(name+4);
1875 debugBelch("%s", strtab + strtab_offset );
1878 for (i = 0; i < 8; i++) {
1879 if (name[i] == 0) break;
1880 debugBelch("%c", name[i] );
1887 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1889 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1890 UInt32 strtab_offset = * (UInt32*)(name+4);
1891 strncpy ( dst, strtab+strtab_offset, dstSize );
1897 if (name[i] == 0) break;
1907 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1910 /* If the string is longer than 8 bytes, look in the
1911 string table for it -- this will be correctly zero terminated.
1913 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1914 UInt32 strtab_offset = * (UInt32*)(name+4);
1915 return ((UChar*)strtab) + strtab_offset;
1917 /* Otherwise, if shorter than 8 bytes, return the original,
1918 which by defn is correctly terminated.
1920 if (name[7]==0) return name;
1921 /* The annoying case: 8 bytes. Copy into a temporary
1922 (which is never freed ...)
1924 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1926 strncpy(newstr,name,8);
1932 /* Just compares the short names (first 8 chars) */
1933 static COFF_section *
1934 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1938 = (COFF_header*)(oc->image);
1939 COFF_section* sectab
1941 ((UChar*)(oc->image))
1942 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1944 for (i = 0; i < hdr->NumberOfSections; i++) {
1947 COFF_section* section_i
1949 myindex ( sizeof_COFF_section, sectab, i );
1950 n1 = (UChar*) &(section_i->Name);
1952 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1953 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1954 n1[6]==n2[6] && n1[7]==n2[7])
1963 zapTrailingAtSign ( UChar* sym )
1965 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
1967 if (sym[0] == 0) return;
1969 while (sym[i] != 0) i++;
1972 while (j > 0 && my_isdigit(sym[j])) j--;
1973 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
1979 ocVerifyImage_PEi386 ( ObjectCode* oc )
1984 COFF_section* sectab;
1985 COFF_symbol* symtab;
1987 /* debugBelch("\nLOADING %s\n", oc->fileName); */
1988 hdr = (COFF_header*)(oc->image);
1989 sectab = (COFF_section*) (
1990 ((UChar*)(oc->image))
1991 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1993 symtab = (COFF_symbol*) (
1994 ((UChar*)(oc->image))
1995 + hdr->PointerToSymbolTable
1997 strtab = ((UChar*)symtab)
1998 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2000 if (hdr->Machine != 0x14c) {
2001 errorBelch("%s: Not x86 PEi386", oc->fileName);
2004 if (hdr->SizeOfOptionalHeader != 0) {
2005 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
2008 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
2009 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
2010 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
2011 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
2012 errorBelch("%s: Not a PEi386 object file", oc->fileName);
2015 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
2016 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
2017 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
2019 (int)(hdr->Characteristics));
2022 /* If the string table size is way crazy, this might indicate that
2023 there are more than 64k relocations, despite claims to the
2024 contrary. Hence this test. */
2025 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2027 if ( (*(UInt32*)strtab) > 600000 ) {
2028 /* Note that 600k has no special significance other than being
2029 big enough to handle the almost-2MB-sized lumps that
2030 constitute HSwin32*.o. */
2031 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2036 /* No further verification after this point; only debug printing. */
2038 IF_DEBUG(linker, i=1);
2039 if (i == 0) return 1;
2041 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2042 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2043 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2046 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2047 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2048 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2049 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2050 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2051 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2052 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2054 /* Print the section table. */
2056 for (i = 0; i < hdr->NumberOfSections; i++) {
2058 COFF_section* sectab_i
2060 myindex ( sizeof_COFF_section, sectab, i );
2067 printName ( sectab_i->Name, strtab );
2077 sectab_i->VirtualSize,
2078 sectab_i->VirtualAddress,
2079 sectab_i->SizeOfRawData,
2080 sectab_i->PointerToRawData,
2081 sectab_i->NumberOfRelocations,
2082 sectab_i->PointerToRelocations,
2083 sectab_i->PointerToRawData
2085 reltab = (COFF_reloc*) (
2086 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2089 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2090 /* If the relocation field (a short) has overflowed, the
2091 * real count can be found in the first reloc entry.
2093 * See Section 4.1 (last para) of the PE spec (rev6.0).
2095 COFF_reloc* rel = (COFF_reloc*)
2096 myindex ( sizeof_COFF_reloc, reltab, 0 );
2097 noRelocs = rel->VirtualAddress;
2100 noRelocs = sectab_i->NumberOfRelocations;
2104 for (; j < noRelocs; j++) {
2106 COFF_reloc* rel = (COFF_reloc*)
2107 myindex ( sizeof_COFF_reloc, reltab, j );
2109 " type 0x%-4x vaddr 0x%-8x name `",
2111 rel->VirtualAddress );
2112 sym = (COFF_symbol*)
2113 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2114 /* Hmm..mysterious looking offset - what's it for? SOF */
2115 printName ( sym->Name, strtab -10 );
2122 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2123 debugBelch("---START of string table---\n");
2124 for (i = 4; i < *(Int32*)strtab; i++) {
2126 debugBelch("\n"); else
2127 debugBelch("%c", strtab[i] );
2129 debugBelch("--- END of string table---\n");
2134 COFF_symbol* symtab_i;
2135 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2136 symtab_i = (COFF_symbol*)
2137 myindex ( sizeof_COFF_symbol, symtab, i );
2143 printName ( symtab_i->Name, strtab );
2152 (Int32)(symtab_i->SectionNumber),
2153 (UInt32)symtab_i->Type,
2154 (UInt32)symtab_i->StorageClass,
2155 (UInt32)symtab_i->NumberOfAuxSymbols
2157 i += symtab_i->NumberOfAuxSymbols;
2167 ocGetNames_PEi386 ( ObjectCode* oc )
2170 COFF_section* sectab;
2171 COFF_symbol* symtab;
2178 hdr = (COFF_header*)(oc->image);
2179 sectab = (COFF_section*) (
2180 ((UChar*)(oc->image))
2181 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2183 symtab = (COFF_symbol*) (
2184 ((UChar*)(oc->image))
2185 + hdr->PointerToSymbolTable
2187 strtab = ((UChar*)(oc->image))
2188 + hdr->PointerToSymbolTable
2189 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2191 /* Allocate space for any (local, anonymous) .bss sections. */
2193 for (i = 0; i < hdr->NumberOfSections; i++) {
2196 COFF_section* sectab_i
2198 myindex ( sizeof_COFF_section, sectab, i );
2199 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2200 /* sof 10/05: the PE spec text isn't too clear regarding what
2201 * the SizeOfRawData field is supposed to hold for object
2202 * file sections containing just uninitialized data -- for executables,
2203 * it is supposed to be zero; unclear what it's supposed to be
2204 * for object files. However, VirtualSize is guaranteed to be
2205 * zero for object files, which definitely suggests that SizeOfRawData
2206 * will be non-zero (where else would the size of this .bss section be
2207 * stored?) Looking at the COFF_section info for incoming object files,
2208 * this certainly appears to be the case.
2210 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2211 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2212 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2213 * variable decls into to the .bss section. (The specific function in Q which
2214 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2216 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2217 /* This is a non-empty .bss section. Allocate zeroed space for
2218 it, and set its PointerToRawData field such that oc->image +
2219 PointerToRawData == addr_of_zeroed_space. */
2220 bss_sz = sectab_i->VirtualSize;
2221 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2222 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2223 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2224 addProddableBlock(oc, zspace, bss_sz);
2225 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2228 /* Copy section information into the ObjectCode. */
2230 for (i = 0; i < hdr->NumberOfSections; i++) {
2236 = SECTIONKIND_OTHER;
2237 COFF_section* sectab_i
2239 myindex ( sizeof_COFF_section, sectab, i );
2240 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2243 /* I'm sure this is the Right Way to do it. However, the
2244 alternative of testing the sectab_i->Name field seems to
2245 work ok with Cygwin.
2247 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2248 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2249 kind = SECTIONKIND_CODE_OR_RODATA;
2252 if (0==strcmp(".text",sectab_i->Name) ||
2253 0==strcmp(".rdata",sectab_i->Name)||
2254 0==strcmp(".rodata",sectab_i->Name))
2255 kind = SECTIONKIND_CODE_OR_RODATA;
2256 if (0==strcmp(".data",sectab_i->Name) ||
2257 0==strcmp(".bss",sectab_i->Name))
2258 kind = SECTIONKIND_RWDATA;
2260 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2261 sz = sectab_i->SizeOfRawData;
2262 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2264 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2265 end = start + sz - 1;
2267 if (kind == SECTIONKIND_OTHER
2268 /* Ignore sections called which contain stabs debugging
2270 && 0 != strcmp(".stab", sectab_i->Name)
2271 && 0 != strcmp(".stabstr", sectab_i->Name)
2272 /* ignore constructor section for now */
2273 && 0 != strcmp(".ctors", sectab_i->Name)
2274 /* ignore section generated from .ident */
2275 && 0!= strcmp("/4", sectab_i->Name)
2277 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2281 if (kind != SECTIONKIND_OTHER && end >= start) {
2282 addSection(oc, kind, start, end);
2283 addProddableBlock(oc, start, end - start + 1);
2287 /* Copy exported symbols into the ObjectCode. */
2289 oc->n_symbols = hdr->NumberOfSymbols;
2290 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2291 "ocGetNames_PEi386(oc->symbols)");
2292 /* Call me paranoid; I don't care. */
2293 for (i = 0; i < oc->n_symbols; i++)
2294 oc->symbols[i] = NULL;
2298 COFF_symbol* symtab_i;
2299 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2300 symtab_i = (COFF_symbol*)
2301 myindex ( sizeof_COFF_symbol, symtab, i );
2305 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2306 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2307 /* This symbol is global and defined, viz, exported */
2308 /* for MYIMAGE_SYMCLASS_EXTERNAL
2309 && !MYIMAGE_SYM_UNDEFINED,
2310 the address of the symbol is:
2311 address of relevant section + offset in section
2313 COFF_section* sectabent
2314 = (COFF_section*) myindex ( sizeof_COFF_section,
2316 symtab_i->SectionNumber-1 );
2317 addr = ((UChar*)(oc->image))
2318 + (sectabent->PointerToRawData
2322 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2323 && symtab_i->Value > 0) {
2324 /* This symbol isn't in any section at all, ie, global bss.
2325 Allocate zeroed space for it. */
2326 addr = stgCallocBytes(1, symtab_i->Value,
2327 "ocGetNames_PEi386(non-anonymous bss)");
2328 addSection(oc, SECTIONKIND_RWDATA, addr,
2329 ((UChar*)addr) + symtab_i->Value - 1);
2330 addProddableBlock(oc, addr, symtab_i->Value);
2331 /* debugBelch("BSS section at 0x%x\n", addr); */
2334 if (addr != NULL ) {
2335 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2336 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2337 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2338 ASSERT(i >= 0 && i < oc->n_symbols);
2339 /* cstring_from_COFF_symbol_name always succeeds. */
2340 oc->symbols[i] = sname;
2341 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2345 "IGNORING symbol %d\n"
2349 printName ( symtab_i->Name, strtab );
2358 (Int32)(symtab_i->SectionNumber),
2359 (UInt32)symtab_i->Type,
2360 (UInt32)symtab_i->StorageClass,
2361 (UInt32)symtab_i->NumberOfAuxSymbols
2366 i += symtab_i->NumberOfAuxSymbols;
2375 ocResolve_PEi386 ( ObjectCode* oc )
2378 COFF_section* sectab;
2379 COFF_symbol* symtab;
2389 /* ToDo: should be variable-sized? But is at least safe in the
2390 sense of buffer-overrun-proof. */
2392 /* debugBelch("resolving for %s\n", oc->fileName); */
2394 hdr = (COFF_header*)(oc->image);
2395 sectab = (COFF_section*) (
2396 ((UChar*)(oc->image))
2397 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2399 symtab = (COFF_symbol*) (
2400 ((UChar*)(oc->image))
2401 + hdr->PointerToSymbolTable
2403 strtab = ((UChar*)(oc->image))
2404 + hdr->PointerToSymbolTable
2405 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2407 for (i = 0; i < hdr->NumberOfSections; i++) {
2408 COFF_section* sectab_i
2410 myindex ( sizeof_COFF_section, sectab, i );
2413 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2416 /* Ignore sections called which contain stabs debugging
2418 if (0 == strcmp(".stab", sectab_i->Name)
2419 || 0 == strcmp(".stabstr", sectab_i->Name)
2420 || 0 == strcmp(".ctors", sectab_i->Name))
2423 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2424 /* If the relocation field (a short) has overflowed, the
2425 * real count can be found in the first reloc entry.
2427 * See Section 4.1 (last para) of the PE spec (rev6.0).
2429 * Nov2003 update: the GNU linker still doesn't correctly
2430 * handle the generation of relocatable object files with
2431 * overflown relocations. Hence the output to warn of potential
2434 COFF_reloc* rel = (COFF_reloc*)
2435 myindex ( sizeof_COFF_reloc, reltab, 0 );
2436 noRelocs = rel->VirtualAddress;
2438 /* 10/05: we now assume (and check for) a GNU ld that is capable
2439 * of handling object files with (>2^16) of relocs.
2442 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2447 noRelocs = sectab_i->NumberOfRelocations;
2452 for (; j < noRelocs; j++) {
2454 COFF_reloc* reltab_j
2456 myindex ( sizeof_COFF_reloc, reltab, j );
2458 /* the location to patch */
2460 ((UChar*)(oc->image))
2461 + (sectab_i->PointerToRawData
2462 + reltab_j->VirtualAddress
2463 - sectab_i->VirtualAddress )
2465 /* the existing contents of pP */
2467 /* the symbol to connect to */
2468 sym = (COFF_symbol*)
2469 myindex ( sizeof_COFF_symbol,
2470 symtab, reltab_j->SymbolTableIndex );
2473 "reloc sec %2d num %3d: type 0x%-4x "
2474 "vaddr 0x%-8x name `",
2476 (UInt32)reltab_j->Type,
2477 reltab_j->VirtualAddress );
2478 printName ( sym->Name, strtab );
2479 debugBelch("'\n" ));
2481 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2482 COFF_section* section_sym
2483 = findPEi386SectionCalled ( oc, sym->Name );
2485 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2488 S = ((UInt32)(oc->image))
2489 + (section_sym->PointerToRawData
2492 copyName ( sym->Name, strtab, symbol, 1000-1 );
2493 S = (UInt32) lookupLocalSymbol( oc, symbol );
2494 if ((void*)S != NULL) goto foundit;
2495 S = (UInt32) lookupSymbol( symbol );
2496 if ((void*)S != NULL) goto foundit;
2497 zapTrailingAtSign ( symbol );
2498 S = (UInt32) lookupLocalSymbol( oc, symbol );
2499 if ((void*)S != NULL) goto foundit;
2500 S = (UInt32) lookupSymbol( symbol );
2501 if ((void*)S != NULL) goto foundit;
2502 /* Newline first because the interactive linker has printed "linking..." */
2503 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2507 checkProddableBlock(oc, pP);
2508 switch (reltab_j->Type) {
2509 case MYIMAGE_REL_I386_DIR32:
2512 case MYIMAGE_REL_I386_REL32:
2513 /* Tricky. We have to insert a displacement at
2514 pP which, when added to the PC for the _next_
2515 insn, gives the address of the target (S).
2516 Problem is to know the address of the next insn
2517 when we only know pP. We assume that this
2518 literal field is always the last in the insn,
2519 so that the address of the next insn is pP+4
2520 -- hence the constant 4.
2521 Also I don't know if A should be added, but so
2522 far it has always been zero.
2524 SOF 05/2005: 'A' (old contents of *pP) have been observed
2525 to contain values other than zero (the 'wx' object file
2526 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2527 So, add displacement to old value instead of asserting
2528 A to be zero. Fixes wxhaskell-related crashes, and no other
2529 ill effects have been observed.
2531 Update: the reason why we're seeing these more elaborate
2532 relocations is due to a switch in how the NCG compiles SRTs
2533 and offsets to them from info tables. SRTs live in .(ro)data,
2534 while info tables live in .text, causing GAS to emit REL32/DISP32
2535 relocations with non-zero values. Adding the displacement is
2536 the right thing to do.
2538 *pP = S - ((UInt32)pP) - 4 + A;
2541 debugBelch("%s: unhandled PEi386 relocation type %d",
2542 oc->fileName, reltab_j->Type);
2549 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2553 #endif /* defined(OBJFORMAT_PEi386) */
2556 /* --------------------------------------------------------------------------
2558 * ------------------------------------------------------------------------*/
2560 #if defined(OBJFORMAT_ELF)
2565 #if defined(sparc_HOST_ARCH)
2566 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2567 #elif defined(i386_HOST_ARCH)
2568 # define ELF_TARGET_386 /* Used inside <elf.h> */
2569 #elif defined(x86_64_HOST_ARCH)
2570 # define ELF_TARGET_X64_64
2572 #elif defined (ia64_HOST_ARCH)
2573 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2575 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2576 # define ELF_NEED_GOT /* needs Global Offset Table */
2577 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2580 #if !defined(openbsd_HOST_OS)
2583 /* openbsd elf has things in different places, with diff names */
2584 # include <elf_abi.h>
2585 # include <machine/reloc.h>
2586 # define R_386_32 RELOC_32
2587 # define R_386_PC32 RELOC_PC32
2590 /* If elf.h doesn't define it */
2591 # ifndef R_X86_64_PC64
2592 # define R_X86_64_PC64 24
2596 * Define a set of types which can be used for both ELF32 and ELF64
2600 #define ELFCLASS ELFCLASS64
2601 #define Elf_Addr Elf64_Addr
2602 #define Elf_Word Elf64_Word
2603 #define Elf_Sword Elf64_Sword
2604 #define Elf_Ehdr Elf64_Ehdr
2605 #define Elf_Phdr Elf64_Phdr
2606 #define Elf_Shdr Elf64_Shdr
2607 #define Elf_Sym Elf64_Sym
2608 #define Elf_Rel Elf64_Rel
2609 #define Elf_Rela Elf64_Rela
2610 #define ELF_ST_TYPE ELF64_ST_TYPE
2611 #define ELF_ST_BIND ELF64_ST_BIND
2612 #define ELF_R_TYPE ELF64_R_TYPE
2613 #define ELF_R_SYM ELF64_R_SYM
2615 #define ELFCLASS ELFCLASS32
2616 #define Elf_Addr Elf32_Addr
2617 #define Elf_Word Elf32_Word
2618 #define Elf_Sword Elf32_Sword
2619 #define Elf_Ehdr Elf32_Ehdr
2620 #define Elf_Phdr Elf32_Phdr
2621 #define Elf_Shdr Elf32_Shdr
2622 #define Elf_Sym Elf32_Sym
2623 #define Elf_Rel Elf32_Rel
2624 #define Elf_Rela Elf32_Rela
2626 #define ELF_ST_TYPE ELF32_ST_TYPE
2629 #define ELF_ST_BIND ELF32_ST_BIND
2632 #define ELF_R_TYPE ELF32_R_TYPE
2635 #define ELF_R_SYM ELF32_R_SYM
2641 * Functions to allocate entries in dynamic sections. Currently we simply
2642 * preallocate a large number, and we don't check if a entry for the given
2643 * target already exists (a linear search is too slow). Ideally these
2644 * entries would be associated with symbols.
2647 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2648 #define GOT_SIZE 0x20000
2649 #define FUNCTION_TABLE_SIZE 0x10000
2650 #define PLT_SIZE 0x08000
2653 static Elf_Addr got[GOT_SIZE];
2654 static unsigned int gotIndex;
2655 static Elf_Addr gp_val = (Elf_Addr)got;
2658 allocateGOTEntry(Elf_Addr target)
2662 if (gotIndex >= GOT_SIZE)
2663 barf("Global offset table overflow");
2665 entry = &got[gotIndex++];
2667 return (Elf_Addr)entry;
2671 #ifdef ELF_FUNCTION_DESC
2677 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2678 static unsigned int functionTableIndex;
2681 allocateFunctionDesc(Elf_Addr target)
2683 FunctionDesc *entry;
2685 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2686 barf("Function table overflow");
2688 entry = &functionTable[functionTableIndex++];
2690 entry->gp = (Elf_Addr)gp_val;
2691 return (Elf_Addr)entry;
2695 copyFunctionDesc(Elf_Addr target)
2697 FunctionDesc *olddesc = (FunctionDesc *)target;
2698 FunctionDesc *newdesc;
2700 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2701 newdesc->gp = olddesc->gp;
2702 return (Elf_Addr)newdesc;
2707 #ifdef ia64_HOST_ARCH
2708 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2709 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2711 static unsigned char plt_code[] =
2713 /* taken from binutils bfd/elfxx-ia64.c */
2714 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2715 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2716 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2717 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2718 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2719 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2722 /* If we can't get to the function descriptor via gp, take a local copy of it */
2723 #define PLT_RELOC(code, target) { \
2724 Elf64_Sxword rel_value = target - gp_val; \
2725 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2726 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2728 ia64_reloc_gprel22((Elf_Addr)code, target); \
2733 unsigned char code[sizeof(plt_code)];
2737 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2739 PLTEntry *plt = (PLTEntry *)oc->plt;
2742 if (oc->pltIndex >= PLT_SIZE)
2743 barf("Procedure table overflow");
2745 entry = &plt[oc->pltIndex++];
2746 memcpy(entry->code, plt_code, sizeof(entry->code));
2747 PLT_RELOC(entry->code, target);
2748 return (Elf_Addr)entry;
2754 return (PLT_SIZE * sizeof(PLTEntry));
2760 * Generic ELF functions
2764 findElfSection ( void* objImage, Elf_Word sh_type )
2766 char* ehdrC = (char*)objImage;
2767 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2768 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2769 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2773 for (i = 0; i < ehdr->e_shnum; i++) {
2774 if (shdr[i].sh_type == sh_type
2775 /* Ignore the section header's string table. */
2776 && i != ehdr->e_shstrndx
2777 /* Ignore string tables named .stabstr, as they contain
2779 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2781 ptr = ehdrC + shdr[i].sh_offset;
2788 #if defined(ia64_HOST_ARCH)
2790 findElfSegment ( void* objImage, Elf_Addr vaddr )
2792 char* ehdrC = (char*)objImage;
2793 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2794 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2795 Elf_Addr segaddr = 0;
2798 for (i = 0; i < ehdr->e_phnum; i++) {
2799 segaddr = phdr[i].p_vaddr;
2800 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2808 ocVerifyImage_ELF ( ObjectCode* oc )
2812 int i, j, nent, nstrtab, nsymtabs;
2816 char* ehdrC = (char*)(oc->image);
2817 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2819 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2820 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2821 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2822 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2823 errorBelch("%s: not an ELF object", oc->fileName);
2827 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2828 errorBelch("%s: unsupported ELF format", oc->fileName);
2832 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2833 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2835 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2836 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2838 errorBelch("%s: unknown endiannness", oc->fileName);
2842 if (ehdr->e_type != ET_REL) {
2843 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2846 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2848 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2849 switch (ehdr->e_machine) {
2850 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2851 #ifdef EM_SPARC32PLUS
2852 case EM_SPARC32PLUS:
2854 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2856 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2858 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2860 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2861 #elif defined(EM_AMD64)
2862 case EM_AMD64: IF_DEBUG(linker,debugBelch( "amd64" )); break;
2864 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2865 errorBelch("%s: unknown architecture (e_machine == %d)"
2866 , oc->fileName, ehdr->e_machine);
2870 IF_DEBUG(linker,debugBelch(
2871 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2872 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2874 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2876 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2878 if (ehdr->e_shstrndx == SHN_UNDEF) {
2879 errorBelch("%s: no section header string table", oc->fileName);
2882 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2884 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2887 for (i = 0; i < ehdr->e_shnum; i++) {
2888 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2889 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2890 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2891 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2892 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2893 ehdrC + shdr[i].sh_offset,
2894 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2896 if (shdr[i].sh_type == SHT_REL) {
2897 IF_DEBUG(linker,debugBelch("Rel " ));
2898 } else if (shdr[i].sh_type == SHT_RELA) {
2899 IF_DEBUG(linker,debugBelch("RelA " ));
2901 IF_DEBUG(linker,debugBelch(" "));
2904 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2908 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2911 for (i = 0; i < ehdr->e_shnum; i++) {
2912 if (shdr[i].sh_type == SHT_STRTAB
2913 /* Ignore the section header's string table. */
2914 && i != ehdr->e_shstrndx
2915 /* Ignore string tables named .stabstr, as they contain
2917 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2919 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2920 strtab = ehdrC + shdr[i].sh_offset;
2925 errorBelch("%s: no string tables, or too many", oc->fileName);
2930 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2931 for (i = 0; i < ehdr->e_shnum; i++) {
2932 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2933 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2935 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2936 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2937 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2939 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2941 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2942 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2945 for (j = 0; j < nent; j++) {
2946 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2947 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2948 (int)stab[j].st_shndx,
2949 (int)stab[j].st_size,
2950 (char*)stab[j].st_value ));
2952 IF_DEBUG(linker,debugBelch("type=" ));
2953 switch (ELF_ST_TYPE(stab[j].st_info)) {
2954 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2955 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2956 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2957 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
2958 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
2959 default: IF_DEBUG(linker,debugBelch("? " )); break;
2961 IF_DEBUG(linker,debugBelch(" " ));
2963 IF_DEBUG(linker,debugBelch("bind=" ));
2964 switch (ELF_ST_BIND(stab[j].st_info)) {
2965 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
2966 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
2967 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
2968 default: IF_DEBUG(linker,debugBelch("? " )); break;
2970 IF_DEBUG(linker,debugBelch(" " ));
2972 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
2976 if (nsymtabs == 0) {
2977 errorBelch("%s: didn't find any symbol tables", oc->fileName);
2984 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
2988 if (hdr->sh_type == SHT_PROGBITS
2989 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
2990 /* .text-style section */
2991 return SECTIONKIND_CODE_OR_RODATA;
2994 if (hdr->sh_type == SHT_PROGBITS
2995 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
2996 /* .data-style section */
2997 return SECTIONKIND_RWDATA;
3000 if (hdr->sh_type == SHT_PROGBITS
3001 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3002 /* .rodata-style section */
3003 return SECTIONKIND_CODE_OR_RODATA;
3006 if (hdr->sh_type == SHT_NOBITS
3007 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3008 /* .bss-style section */
3010 return SECTIONKIND_RWDATA;
3013 return SECTIONKIND_OTHER;
3018 ocGetNames_ELF ( ObjectCode* oc )
3023 char* ehdrC = (char*)(oc->image);
3024 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3025 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3026 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3028 ASSERT(symhash != NULL);
3031 errorBelch("%s: no strtab", oc->fileName);
3036 for (i = 0; i < ehdr->e_shnum; i++) {
3037 /* Figure out what kind of section it is. Logic derived from
3038 Figure 1.14 ("Special Sections") of the ELF document
3039 ("Portable Formats Specification, Version 1.1"). */
3041 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3043 if (is_bss && shdr[i].sh_size > 0) {
3044 /* This is a non-empty .bss section. Allocate zeroed space for
3045 it, and set its .sh_offset field such that
3046 ehdrC + .sh_offset == addr_of_zeroed_space. */
3047 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3048 "ocGetNames_ELF(BSS)");
3049 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3051 debugBelch("BSS section at 0x%x, size %d\n",
3052 zspace, shdr[i].sh_size);
3056 /* fill in the section info */
3057 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3058 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3059 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3060 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3063 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3065 /* copy stuff into this module's object symbol table */
3066 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3067 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3069 oc->n_symbols = nent;
3070 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3071 "ocGetNames_ELF(oc->symbols)");
3073 for (j = 0; j < nent; j++) {
3075 char isLocal = FALSE; /* avoids uninit-var warning */
3077 char* nm = strtab + stab[j].st_name;
3078 int secno = stab[j].st_shndx;
3080 /* Figure out if we want to add it; if so, set ad to its
3081 address. Otherwise leave ad == NULL. */
3083 if (secno == SHN_COMMON) {
3085 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3087 debugBelch("COMMON symbol, size %d name %s\n",
3088 stab[j].st_size, nm);
3090 /* Pointless to do addProddableBlock() for this area,
3091 since the linker should never poke around in it. */
3094 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3095 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3097 /* and not an undefined symbol */
3098 && stab[j].st_shndx != SHN_UNDEF
3099 /* and not in a "special section" */
3100 && stab[j].st_shndx < SHN_LORESERVE
3102 /* and it's a not a section or string table or anything silly */
3103 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3104 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3105 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3108 /* Section 0 is the undefined section, hence > and not >=. */
3109 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3111 if (shdr[secno].sh_type == SHT_NOBITS) {
3112 debugBelch(" BSS symbol, size %d off %d name %s\n",
3113 stab[j].st_size, stab[j].st_value, nm);
3116 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3117 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3120 #ifdef ELF_FUNCTION_DESC
3121 /* dlsym() and the initialisation table both give us function
3122 * descriptors, so to be consistent we store function descriptors
3123 * in the symbol table */
3124 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3125 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3127 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3128 ad, oc->fileName, nm ));
3133 /* And the decision is ... */
3137 oc->symbols[j] = nm;
3140 /* Ignore entirely. */
3142 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3146 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3147 strtab + stab[j].st_name ));
3150 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3151 (int)ELF_ST_BIND(stab[j].st_info),
3152 (int)ELF_ST_TYPE(stab[j].st_info),
3153 (int)stab[j].st_shndx,
3154 strtab + stab[j].st_name
3157 oc->symbols[j] = NULL;
3166 /* Do ELF relocations which lack an explicit addend. All x86-linux
3167 relocations appear to be of this form. */
3169 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3170 Elf_Shdr* shdr, int shnum,
3171 Elf_Sym* stab, char* strtab )
3176 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3177 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3178 int target_shndx = shdr[shnum].sh_info;
3179 int symtab_shndx = shdr[shnum].sh_link;
3181 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3182 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3183 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3184 target_shndx, symtab_shndx ));
3186 /* Skip sections that we're not interested in. */
3189 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3190 if (kind == SECTIONKIND_OTHER) {
3191 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3196 for (j = 0; j < nent; j++) {
3197 Elf_Addr offset = rtab[j].r_offset;
3198 Elf_Addr info = rtab[j].r_info;
3200 Elf_Addr P = ((Elf_Addr)targ) + offset;
3201 Elf_Word* pP = (Elf_Word*)P;
3206 StgStablePtr stablePtr;
3209 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3210 j, (void*)offset, (void*)info ));
3212 IF_DEBUG(linker,debugBelch( " ZERO" ));
3215 Elf_Sym sym = stab[ELF_R_SYM(info)];
3216 /* First see if it is a local symbol. */
3217 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3218 /* Yes, so we can get the address directly from the ELF symbol
3220 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3222 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3223 + stab[ELF_R_SYM(info)].st_value);
3226 symbol = strtab + sym.st_name;
3227 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3228 if (NULL == stablePtr) {
3229 /* No, so look up the name in our global table. */
3230 S_tmp = lookupSymbol( symbol );
3231 S = (Elf_Addr)S_tmp;
3233 stableVal = deRefStablePtr( stablePtr );
3235 S = (Elf_Addr)S_tmp;
3239 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3242 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3245 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3246 (void*)P, (void*)S, (void*)A ));
3247 checkProddableBlock ( oc, pP );
3251 switch (ELF_R_TYPE(info)) {
3252 # ifdef i386_HOST_ARCH
3253 case R_386_32: *pP = value; break;
3254 case R_386_PC32: *pP = value - P; break;
3257 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3258 oc->fileName, (lnat)ELF_R_TYPE(info));
3266 /* Do ELF relocations for which explicit addends are supplied.
3267 sparc-solaris relocations appear to be of this form. */
3269 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3270 Elf_Shdr* shdr, int shnum,
3271 Elf_Sym* stab, char* strtab )
3274 char *symbol = NULL;
3276 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3277 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3278 int target_shndx = shdr[shnum].sh_info;
3279 int symtab_shndx = shdr[shnum].sh_link;
3281 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3282 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3283 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3284 target_shndx, symtab_shndx ));
3286 for (j = 0; j < nent; j++) {
3287 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3288 /* This #ifdef only serves to avoid unused-var warnings. */
3289 Elf_Addr offset = rtab[j].r_offset;
3290 Elf_Addr P = targ + offset;
3292 Elf_Addr info = rtab[j].r_info;
3293 Elf_Addr A = rtab[j].r_addend;
3297 # if defined(sparc_HOST_ARCH)
3298 Elf_Word* pP = (Elf_Word*)P;
3300 # elif defined(ia64_HOST_ARCH)
3301 Elf64_Xword *pP = (Elf64_Xword *)P;
3303 # elif defined(powerpc_HOST_ARCH)
3307 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3308 j, (void*)offset, (void*)info,
3311 IF_DEBUG(linker,debugBelch( " ZERO" ));
3314 Elf_Sym sym = stab[ELF_R_SYM(info)];
3315 /* First see if it is a local symbol. */
3316 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3317 /* Yes, so we can get the address directly from the ELF symbol
3319 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3321 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3322 + stab[ELF_R_SYM(info)].st_value);
3323 #ifdef ELF_FUNCTION_DESC
3324 /* Make a function descriptor for this function */
3325 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3326 S = allocateFunctionDesc(S + A);
3331 /* No, so look up the name in our global table. */
3332 symbol = strtab + sym.st_name;
3333 S_tmp = lookupSymbol( symbol );
3334 S = (Elf_Addr)S_tmp;
3336 #ifdef ELF_FUNCTION_DESC
3337 /* If a function, already a function descriptor - we would
3338 have to copy it to add an offset. */
3339 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3340 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3344 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3347 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3350 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3351 (void*)P, (void*)S, (void*)A ));
3352 /* checkProddableBlock ( oc, (void*)P ); */
3356 switch (ELF_R_TYPE(info)) {
3357 # if defined(sparc_HOST_ARCH)
3358 case R_SPARC_WDISP30:
3359 w1 = *pP & 0xC0000000;
3360 w2 = (Elf_Word)((value - P) >> 2);
3361 ASSERT((w2 & 0xC0000000) == 0);
3366 w1 = *pP & 0xFFC00000;
3367 w2 = (Elf_Word)(value >> 10);
3368 ASSERT((w2 & 0xFFC00000) == 0);
3374 w2 = (Elf_Word)(value & 0x3FF);
3375 ASSERT((w2 & ~0x3FF) == 0);
3379 /* According to the Sun documentation:
3381 This relocation type resembles R_SPARC_32, except it refers to an
3382 unaligned word. That is, the word to be relocated must be treated
3383 as four separate bytes with arbitrary alignment, not as a word
3384 aligned according to the architecture requirements.
3386 (JRS: which means that freeloading on the R_SPARC_32 case
3387 is probably wrong, but hey ...)
3391 w2 = (Elf_Word)value;
3394 # elif defined(ia64_HOST_ARCH)
3395 case R_IA64_DIR64LSB:
3396 case R_IA64_FPTR64LSB:
3399 case R_IA64_PCREL64LSB:
3402 case R_IA64_SEGREL64LSB:
3403 addr = findElfSegment(ehdrC, value);
3406 case R_IA64_GPREL22:
3407 ia64_reloc_gprel22(P, value);
3409 case R_IA64_LTOFF22:
3410 case R_IA64_LTOFF22X:
3411 case R_IA64_LTOFF_FPTR22:
3412 addr = allocateGOTEntry(value);
3413 ia64_reloc_gprel22(P, addr);
3415 case R_IA64_PCREL21B:
3416 ia64_reloc_pcrel21(P, S, oc);
3419 /* This goes with R_IA64_LTOFF22X and points to the load to
3420 * convert into a move. We don't implement relaxation. */
3422 # elif defined(powerpc_HOST_ARCH)
3423 case R_PPC_ADDR16_LO:
3424 *(Elf32_Half*) P = value;
3427 case R_PPC_ADDR16_HI:
3428 *(Elf32_Half*) P = value >> 16;
3431 case R_PPC_ADDR16_HA:
3432 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3436 *(Elf32_Word *) P = value;
3440 *(Elf32_Word *) P = value - P;
3446 if( delta << 6 >> 6 != delta )
3448 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3452 if( value == 0 || delta << 6 >> 6 != delta )
3454 barf( "Unable to make SymbolExtra for #%d",
3460 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3461 | (delta & 0x3fffffc);
3465 #if x86_64_HOST_ARCH
3467 *(Elf64_Xword *)P = value;
3472 StgInt64 off = value - P;
3473 if (off >= 0x7fffffffL || off < -0x80000000L) {
3474 #if X86_64_ELF_NONPIC_HACK
3475 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3477 off = pltAddress + A - P;
3479 barf("R_X86_64_PC32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3480 symbol, off, oc->fileName );
3483 *(Elf64_Word *)P = (Elf64_Word)off;
3489 StgInt64 off = value - P;
3490 *(Elf64_Word *)P = (Elf64_Word)off;
3495 if (value >= 0x7fffffffL) {
3496 #if X86_64_ELF_NONPIC_HACK
3497 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3499 value = pltAddress + A;
3501 barf("R_X86_64_32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3502 symbol, value, oc->fileName );
3505 *(Elf64_Word *)P = (Elf64_Word)value;
3509 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3510 #if X86_64_ELF_NONPIC_HACK
3511 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3513 value = pltAddress + A;
3515 barf("R_X86_64_32S relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3516 symbol, value, oc->fileName );
3519 *(Elf64_Sword *)P = (Elf64_Sword)value;
3522 case R_X86_64_GOTPCREL:
3524 StgInt64 gotAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)->addr;
3525 StgInt64 off = gotAddress + A - P;
3526 *(Elf64_Word *)P = (Elf64_Word)off;
3530 case R_X86_64_PLT32:
3532 StgInt64 off = value - P;
3533 if (off >= 0x7fffffffL || off < -0x80000000L) {
3534 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3536 off = pltAddress + A - P;
3538 *(Elf64_Word *)P = (Elf64_Word)off;
3544 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3545 oc->fileName, (lnat)ELF_R_TYPE(info));
3554 ocResolve_ELF ( ObjectCode* oc )
3558 Elf_Sym* stab = NULL;
3559 char* ehdrC = (char*)(oc->image);
3560 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3561 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3563 /* first find "the" symbol table */
3564 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3566 /* also go find the string table */
3567 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3569 if (stab == NULL || strtab == NULL) {
3570 errorBelch("%s: can't find string or symbol table", oc->fileName);
3574 /* Process the relocation sections. */
3575 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3576 if (shdr[shnum].sh_type == SHT_REL) {
3577 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3578 shnum, stab, strtab );
3582 if (shdr[shnum].sh_type == SHT_RELA) {
3583 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3584 shnum, stab, strtab );
3589 /* Free the local symbol table; we won't need it again. */
3590 freeHashTable(oc->lochash, NULL);
3593 #if defined(powerpc_HOST_ARCH)
3594 ocFlushInstructionCache( oc );
3602 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3603 * at the front. The following utility functions pack and unpack instructions, and
3604 * take care of the most common relocations.
3607 #ifdef ia64_HOST_ARCH
3610 ia64_extract_instruction(Elf64_Xword *target)
3613 int slot = (Elf_Addr)target & 3;
3614 target = (Elf_Addr)target & ~3;
3622 return ((w1 >> 5) & 0x1ffffffffff);
3624 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3628 barf("ia64_extract_instruction: invalid slot %p", target);
3633 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3635 int slot = (Elf_Addr)target & 3;
3636 target = (Elf_Addr)target & ~3;
3641 *target |= value << 5;
3644 *target |= value << 46;
3645 *(target+1) |= value >> 18;
3648 *(target+1) |= value << 23;
3654 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3656 Elf64_Xword instruction;
3657 Elf64_Sxword rel_value;
3659 rel_value = value - gp_val;
3660 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3661 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3663 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3664 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3665 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3666 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3667 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3668 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3672 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3674 Elf64_Xword instruction;
3675 Elf64_Sxword rel_value;
3678 entry = allocatePLTEntry(value, oc);
3680 rel_value = (entry >> 4) - (target >> 4);
3681 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3682 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3684 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3685 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3686 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3687 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3693 * PowerPC & X86_64 ELF specifics
3696 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3698 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3704 ehdr = (Elf_Ehdr *) oc->image;
3705 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3707 for( i = 0; i < ehdr->e_shnum; i++ )
3708 if( shdr[i].sh_type == SHT_SYMTAB )
3711 if( i == ehdr->e_shnum )
3713 errorBelch( "This ELF file contains no symtab" );
3717 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3719 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3720 (int) shdr[i].sh_entsize, (int) sizeof( Elf_Sym ) );
3725 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3728 #endif /* powerpc */
3732 /* --------------------------------------------------------------------------
3734 * ------------------------------------------------------------------------*/
3736 #if defined(OBJFORMAT_MACHO)
3739 Support for MachO linking on Darwin/MacOS X
3740 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3742 I hereby formally apologize for the hackish nature of this code.
3743 Things that need to be done:
3744 *) implement ocVerifyImage_MachO
3745 *) add still more sanity checks.
3748 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3749 #define mach_header mach_header_64
3750 #define segment_command segment_command_64
3751 #define section section_64
3752 #define nlist nlist_64
3755 #ifdef powerpc_HOST_ARCH
3756 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3758 struct mach_header *header = (struct mach_header *) oc->image;
3759 struct load_command *lc = (struct load_command *) (header + 1);
3762 for( i = 0; i < header->ncmds; i++ )
3764 if( lc->cmd == LC_SYMTAB )
3766 // Find out the first and last undefined external
3767 // symbol, so we don't have to allocate too many
3769 struct symtab_command *symLC = (struct symtab_command *) lc;
3770 unsigned min = symLC->nsyms, max = 0;
3771 struct nlist *nlist =
3772 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3774 for(i=0;i<symLC->nsyms;i++)
3776 if(nlist[i].n_type & N_STAB)
3778 else if(nlist[i].n_type & N_EXT)
3780 if((nlist[i].n_type & N_TYPE) == N_UNDF
3781 && (nlist[i].n_value == 0))
3791 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3796 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3798 return ocAllocateSymbolExtras(oc,0,0);
3801 #ifdef x86_64_HOST_ARCH
3802 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3804 struct mach_header *header = (struct mach_header *) oc->image;
3805 struct load_command *lc = (struct load_command *) (header + 1);
3808 for( i = 0; i < header->ncmds; i++ )
3810 if( lc->cmd == LC_SYMTAB )
3812 // Just allocate one entry for every symbol
3813 struct symtab_command *symLC = (struct symtab_command *) lc;
3815 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3818 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3820 return ocAllocateSymbolExtras(oc,0,0);
3824 static int ocVerifyImage_MachO(ObjectCode* oc)
3826 char *image = (char*) oc->image;
3827 struct mach_header *header = (struct mach_header*) image;
3829 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3830 if(header->magic != MH_MAGIC_64)
3833 if(header->magic != MH_MAGIC)
3836 // FIXME: do some more verifying here
3840 static int resolveImports(
3843 struct symtab_command *symLC,
3844 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3845 unsigned long *indirectSyms,
3846 struct nlist *nlist)
3849 size_t itemSize = 4;
3852 int isJumpTable = 0;
3853 if(!strcmp(sect->sectname,"__jump_table"))
3857 ASSERT(sect->reserved2 == itemSize);
3861 for(i=0; i*itemSize < sect->size;i++)
3863 // according to otool, reserved1 contains the first index into the indirect symbol table
3864 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3865 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3868 if((symbol->n_type & N_TYPE) == N_UNDF
3869 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3870 addr = (void*) (symbol->n_value);
3871 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3874 addr = lookupSymbol(nm);
3877 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3885 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3886 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3887 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3888 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3893 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3894 ((void**)(image + sect->offset))[i] = addr;
3901 static unsigned long relocateAddress(
3904 struct section* sections,
3905 unsigned long address)
3908 for(i = 0; i < nSections; i++)
3910 if(sections[i].addr <= address
3911 && address < sections[i].addr + sections[i].size)
3913 return (unsigned long)oc->image
3914 + sections[i].offset + address - sections[i].addr;
3917 barf("Invalid Mach-O file:"
3918 "Address out of bounds while relocating object file");
3922 static int relocateSection(
3925 struct symtab_command *symLC, struct nlist *nlist,
3926 int nSections, struct section* sections, struct section *sect)
3928 struct relocation_info *relocs;
3931 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3933 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3935 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3937 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3941 relocs = (struct relocation_info*) (image + sect->reloff);
3945 #ifdef x86_64_HOST_ARCH
3946 struct relocation_info *reloc = &relocs[i];
3948 char *thingPtr = image + sect->offset + reloc->r_address;
3952 int type = reloc->r_type;
3954 checkProddableBlock(oc,thingPtr);
3955 switch(reloc->r_length)
3958 thing = *(uint8_t*)thingPtr;
3959 baseValue = (uint64_t)thingPtr + 1;
3962 thing = *(uint16_t*)thingPtr;
3963 baseValue = (uint64_t)thingPtr + 2;
3966 thing = *(uint32_t*)thingPtr;
3967 baseValue = (uint64_t)thingPtr + 4;
3970 thing = *(uint64_t*)thingPtr;
3971 baseValue = (uint64_t)thingPtr + 8;
3974 barf("Unknown size.");
3977 if(type == X86_64_RELOC_GOT
3978 || type == X86_64_RELOC_GOT_LOAD)
3980 ASSERT(reloc->r_extern);
3981 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
3983 type = X86_64_RELOC_SIGNED;
3985 else if(reloc->r_extern)
3987 struct nlist *symbol = &nlist[reloc->r_symbolnum];
3988 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3989 if(symbol->n_value == 0)
3990 value = (uint64_t) lookupSymbol(nm);
3992 value = relocateAddress(oc, nSections, sections,
3997 value = sections[reloc->r_symbolnum-1].offset
3998 - sections[reloc->r_symbolnum-1].addr
4002 if(type == X86_64_RELOC_BRANCH)
4004 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4006 ASSERT(reloc->r_extern);
4007 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4010 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4011 type = X86_64_RELOC_SIGNED;
4016 case X86_64_RELOC_UNSIGNED:
4017 ASSERT(!reloc->r_pcrel);
4020 case X86_64_RELOC_SIGNED:
4021 ASSERT(reloc->r_pcrel);
4022 thing += value - baseValue;
4024 case X86_64_RELOC_SUBTRACTOR:
4025 ASSERT(!reloc->r_pcrel);
4029 barf("unkown relocation");
4032 switch(reloc->r_length)
4035 *(uint8_t*)thingPtr = thing;
4038 *(uint16_t*)thingPtr = thing;
4041 *(uint32_t*)thingPtr = thing;
4044 *(uint64_t*)thingPtr = thing;
4048 if(relocs[i].r_address & R_SCATTERED)
4050 struct scattered_relocation_info *scat =
4051 (struct scattered_relocation_info*) &relocs[i];
4055 if(scat->r_length == 2)
4057 unsigned long word = 0;
4058 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4059 checkProddableBlock(oc,wordPtr);
4061 // Note on relocation types:
4062 // i386 uses the GENERIC_RELOC_* types,
4063 // while ppc uses special PPC_RELOC_* types.
4064 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4065 // in both cases, all others are different.
4066 // Therefore, we use GENERIC_RELOC_VANILLA
4067 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4068 // and use #ifdefs for the other types.
4070 // Step 1: Figure out what the relocated value should be
4071 if(scat->r_type == GENERIC_RELOC_VANILLA)
4073 word = *wordPtr + (unsigned long) relocateAddress(
4080 #ifdef powerpc_HOST_ARCH
4081 else if(scat->r_type == PPC_RELOC_SECTDIFF
4082 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4083 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4084 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4086 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4089 struct scattered_relocation_info *pair =
4090 (struct scattered_relocation_info*) &relocs[i+1];
4092 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4093 barf("Invalid Mach-O file: "
4094 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4096 word = (unsigned long)
4097 (relocateAddress(oc, nSections, sections, scat->r_value)
4098 - relocateAddress(oc, nSections, sections, pair->r_value));
4101 #ifdef powerpc_HOST_ARCH
4102 else if(scat->r_type == PPC_RELOC_HI16
4103 || scat->r_type == PPC_RELOC_LO16
4104 || scat->r_type == PPC_RELOC_HA16
4105 || scat->r_type == PPC_RELOC_LO14)
4106 { // these are generated by label+offset things
4107 struct relocation_info *pair = &relocs[i+1];
4108 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4109 barf("Invalid Mach-O file: "
4110 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4112 if(scat->r_type == PPC_RELOC_LO16)
4114 word = ((unsigned short*) wordPtr)[1];
4115 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4117 else if(scat->r_type == PPC_RELOC_LO14)
4119 barf("Unsupported Relocation: PPC_RELOC_LO14");
4120 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4121 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4123 else if(scat->r_type == PPC_RELOC_HI16)
4125 word = ((unsigned short*) wordPtr)[1] << 16;
4126 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4128 else if(scat->r_type == PPC_RELOC_HA16)
4130 word = ((unsigned short*) wordPtr)[1] << 16;
4131 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4135 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4142 continue; // ignore the others
4144 #ifdef powerpc_HOST_ARCH
4145 if(scat->r_type == GENERIC_RELOC_VANILLA
4146 || scat->r_type == PPC_RELOC_SECTDIFF)
4148 if(scat->r_type == GENERIC_RELOC_VANILLA
4149 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4154 #ifdef powerpc_HOST_ARCH
4155 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4157 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4159 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4161 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4163 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4165 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4166 + ((word & (1<<15)) ? 1 : 0);
4172 continue; // FIXME: I hope it's OK to ignore all the others.
4176 struct relocation_info *reloc = &relocs[i];
4177 if(reloc->r_pcrel && !reloc->r_extern)
4180 if(reloc->r_length == 2)
4182 unsigned long word = 0;
4183 #ifdef powerpc_HOST_ARCH
4184 unsigned long jumpIsland = 0;
4185 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4186 // to avoid warning and to catch
4190 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4191 checkProddableBlock(oc,wordPtr);
4193 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4197 #ifdef powerpc_HOST_ARCH
4198 else if(reloc->r_type == PPC_RELOC_LO16)
4200 word = ((unsigned short*) wordPtr)[1];
4201 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4203 else if(reloc->r_type == PPC_RELOC_HI16)
4205 word = ((unsigned short*) wordPtr)[1] << 16;
4206 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4208 else if(reloc->r_type == PPC_RELOC_HA16)
4210 word = ((unsigned short*) wordPtr)[1] << 16;
4211 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4213 else if(reloc->r_type == PPC_RELOC_BR24)
4216 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4220 if(!reloc->r_extern)
4223 sections[reloc->r_symbolnum-1].offset
4224 - sections[reloc->r_symbolnum-1].addr
4231 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4232 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4233 void *symbolAddress = lookupSymbol(nm);
4236 errorBelch("\nunknown symbol `%s'", nm);
4242 #ifdef powerpc_HOST_ARCH
4243 // In the .o file, this should be a relative jump to NULL
4244 // and we'll change it to a relative jump to the symbol
4245 ASSERT(word + reloc->r_address == 0);
4246 jumpIsland = (unsigned long)
4247 &makeSymbolExtra(oc,
4249 (unsigned long) symbolAddress)
4253 offsetToJumpIsland = word + jumpIsland
4254 - (((long)image) + sect->offset - sect->addr);
4257 word += (unsigned long) symbolAddress
4258 - (((long)image) + sect->offset - sect->addr);
4262 word += (unsigned long) symbolAddress;
4266 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4271 #ifdef powerpc_HOST_ARCH
4272 else if(reloc->r_type == PPC_RELOC_LO16)
4274 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4277 else if(reloc->r_type == PPC_RELOC_HI16)
4279 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4282 else if(reloc->r_type == PPC_RELOC_HA16)
4284 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4285 + ((word & (1<<15)) ? 1 : 0);
4288 else if(reloc->r_type == PPC_RELOC_BR24)
4290 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4292 // The branch offset is too large.
4293 // Therefore, we try to use a jump island.
4296 barf("unconditional relative branch out of range: "
4297 "no jump island available");
4300 word = offsetToJumpIsland;
4301 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4302 barf("unconditional relative branch out of range: "
4303 "jump island out of range");
4305 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4310 barf("\nunknown relocation %d",reloc->r_type);
4318 static int ocGetNames_MachO(ObjectCode* oc)
4320 char *image = (char*) oc->image;
4321 struct mach_header *header = (struct mach_header*) image;
4322 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4323 unsigned i,curSymbol = 0;
4324 struct segment_command *segLC = NULL;
4325 struct section *sections;
4326 struct symtab_command *symLC = NULL;
4327 struct nlist *nlist;
4328 unsigned long commonSize = 0;
4329 char *commonStorage = NULL;
4330 unsigned long commonCounter;
4332 for(i=0;i<header->ncmds;i++)
4334 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4335 segLC = (struct segment_command*) lc;
4336 else if(lc->cmd == LC_SYMTAB)
4337 symLC = (struct symtab_command*) lc;
4338 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4341 sections = (struct section*) (segLC+1);
4342 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4346 barf("ocGetNames_MachO: no segment load command");
4348 for(i=0;i<segLC->nsects;i++)
4350 if(sections[i].size == 0)
4353 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4355 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4356 "ocGetNames_MachO(common symbols)");
4357 sections[i].offset = zeroFillArea - image;
4360 if(!strcmp(sections[i].sectname,"__text"))
4361 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4362 (void*) (image + sections[i].offset),
4363 (void*) (image + sections[i].offset + sections[i].size));
4364 else if(!strcmp(sections[i].sectname,"__const"))
4365 addSection(oc, SECTIONKIND_RWDATA,
4366 (void*) (image + sections[i].offset),
4367 (void*) (image + sections[i].offset + sections[i].size));
4368 else if(!strcmp(sections[i].sectname,"__data"))
4369 addSection(oc, SECTIONKIND_RWDATA,
4370 (void*) (image + sections[i].offset),
4371 (void*) (image + sections[i].offset + sections[i].size));
4372 else if(!strcmp(sections[i].sectname,"__bss")
4373 || !strcmp(sections[i].sectname,"__common"))
4374 addSection(oc, SECTIONKIND_RWDATA,
4375 (void*) (image + sections[i].offset),
4376 (void*) (image + sections[i].offset + sections[i].size));
4378 addProddableBlock(oc, (void*) (image + sections[i].offset),
4382 // count external symbols defined here
4386 for(i=0;i<symLC->nsyms;i++)
4388 if(nlist[i].n_type & N_STAB)
4390 else if(nlist[i].n_type & N_EXT)
4392 if((nlist[i].n_type & N_TYPE) == N_UNDF
4393 && (nlist[i].n_value != 0))
4395 commonSize += nlist[i].n_value;
4398 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4403 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4404 "ocGetNames_MachO(oc->symbols)");
4408 for(i=0;i<symLC->nsyms;i++)
4410 if(nlist[i].n_type & N_STAB)
4412 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4414 if(nlist[i].n_type & N_EXT)
4416 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4417 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4418 ; // weak definition, and we already have a definition
4421 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4423 + sections[nlist[i].n_sect-1].offset
4424 - sections[nlist[i].n_sect-1].addr
4425 + nlist[i].n_value);
4426 oc->symbols[curSymbol++] = nm;
4433 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4434 commonCounter = (unsigned long)commonStorage;
4437 for(i=0;i<symLC->nsyms;i++)
4439 if((nlist[i].n_type & N_TYPE) == N_UNDF
4440 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4442 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4443 unsigned long sz = nlist[i].n_value;
4445 nlist[i].n_value = commonCounter;
4447 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4448 (void*)commonCounter);
4449 oc->symbols[curSymbol++] = nm;
4451 commonCounter += sz;
4458 static int ocResolve_MachO(ObjectCode* oc)
4460 char *image = (char*) oc->image;
4461 struct mach_header *header = (struct mach_header*) image;
4462 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4464 struct segment_command *segLC = NULL;
4465 struct section *sections;
4466 struct symtab_command *symLC = NULL;
4467 struct dysymtab_command *dsymLC = NULL;
4468 struct nlist *nlist;
4470 for(i=0;i<header->ncmds;i++)
4472 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4473 segLC = (struct segment_command*) lc;
4474 else if(lc->cmd == LC_SYMTAB)
4475 symLC = (struct symtab_command*) lc;
4476 else if(lc->cmd == LC_DYSYMTAB)
4477 dsymLC = (struct dysymtab_command*) lc;
4478 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4481 sections = (struct section*) (segLC+1);
4482 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4487 unsigned long *indirectSyms
4488 = (unsigned long*) (image + dsymLC->indirectsymoff);
4490 for(i=0;i<segLC->nsects;i++)
4492 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4493 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4494 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4496 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4499 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4500 || !strcmp(sections[i].sectname,"__pointers"))
4502 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4505 else if(!strcmp(sections[i].sectname,"__jump_table"))
4507 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4513 for(i=0;i<segLC->nsects;i++)
4515 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4519 /* Free the local symbol table; we won't need it again. */
4520 freeHashTable(oc->lochash, NULL);
4523 #if defined (powerpc_HOST_ARCH)
4524 ocFlushInstructionCache( oc );
4530 #ifdef powerpc_HOST_ARCH
4532 * The Mach-O object format uses leading underscores. But not everywhere.
4533 * There is a small number of runtime support functions defined in
4534 * libcc_dynamic.a whose name does not have a leading underscore.
4535 * As a consequence, we can't get their address from C code.
4536 * We have to use inline assembler just to take the address of a function.
4540 static void machoInitSymbolsWithoutUnderscore()
4542 extern void* symbolsWithoutUnderscore[];
4543 void **p = symbolsWithoutUnderscore;
4544 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4548 __asm__ volatile(".long " # x);
4550 RTS_MACHO_NOUNDERLINE_SYMBOLS
4552 __asm__ volatile(".text");
4556 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4558 RTS_MACHO_NOUNDERLINE_SYMBOLS
4565 * Figure out by how much to shift the entire Mach-O file in memory
4566 * when loading so that its single segment ends up 16-byte-aligned
4568 static int machoGetMisalignment( FILE * f )
4570 struct mach_header header;
4573 fread(&header, sizeof(header), 1, f);
4576 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4577 if(header.magic != MH_MAGIC_64)
4580 if(header.magic != MH_MAGIC)
4584 misalignment = (header.sizeofcmds + sizeof(header))
4587 return misalignment ? (16 - misalignment) : 0;