1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2000-2004
7 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
13 /* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14 MREMAP_MAYMOVE from <sys/mman.h>.
25 #include "LinkerInternals.h"
29 #include "RtsTypeable.h"
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
42 #if defined(HAVE_DLFCN_H)
46 #if defined(cygwin32_HOST_OS)
51 #ifdef HAVE_SYS_TIME_H
55 #include <sys/fcntl.h>
56 #include <sys/termios.h>
57 #include <sys/utime.h>
58 #include <sys/utsname.h>
62 #if defined(ia64_HOST_ARCH) || defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
67 #if defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
75 #if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
76 # define OBJFORMAT_ELF
77 #elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
78 # define OBJFORMAT_PEi386
81 #elif defined(darwin_HOST_OS)
82 # define OBJFORMAT_MACHO
83 # include <mach-o/loader.h>
84 # include <mach-o/nlist.h>
85 # include <mach-o/reloc.h>
86 #if !defined(HAVE_DLFCN_H)
87 # include <mach-o/dyld.h>
89 #if defined(powerpc_HOST_ARCH)
90 # include <mach-o/ppc/reloc.h>
92 #if defined(x86_64_HOST_ARCH)
93 # include <mach-o/x86_64/reloc.h>
97 /* Hash table mapping symbol names to Symbol */
98 static /*Str*/HashTable *symhash;
100 /* Hash table mapping symbol names to StgStablePtr */
101 static /*Str*/HashTable *stablehash;
103 /* List of currently loaded objects */
104 ObjectCode *objects = NULL; /* initially empty */
106 #if defined(OBJFORMAT_ELF)
107 static int ocVerifyImage_ELF ( ObjectCode* oc );
108 static int ocGetNames_ELF ( ObjectCode* oc );
109 static int ocResolve_ELF ( ObjectCode* oc );
110 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
111 static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
113 #elif defined(OBJFORMAT_PEi386)
114 static int ocVerifyImage_PEi386 ( ObjectCode* oc );
115 static int ocGetNames_PEi386 ( ObjectCode* oc );
116 static int ocResolve_PEi386 ( ObjectCode* oc );
117 #elif defined(OBJFORMAT_MACHO)
118 static int ocVerifyImage_MachO ( ObjectCode* oc );
119 static int ocGetNames_MachO ( ObjectCode* oc );
120 static int ocResolve_MachO ( ObjectCode* oc );
122 static int machoGetMisalignment( FILE * );
123 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
124 static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
126 #ifdef powerpc_HOST_ARCH
127 static void machoInitSymbolsWithoutUnderscore( void );
131 /* on x86_64 we have a problem with relocating symbol references in
132 * code that was compiled without -fPIC. By default, the small memory
133 * model is used, which assumes that symbol references can fit in a
134 * 32-bit slot. The system dynamic linker makes this work for
135 * references to shared libraries by either (a) allocating a jump
136 * table slot for code references, or (b) moving the symbol at load
137 * time (and copying its contents, if necessary) for data references.
139 * We unfortunately can't tell whether symbol references are to code
140 * or data. So for now we assume they are code (the vast majority
141 * are), and allocate jump-table slots. Unfortunately this will
142 * SILENTLY generate crashing code for data references. This hack is
143 * enabled by X86_64_ELF_NONPIC_HACK.
145 * One workaround is to use shared Haskell libraries. This is
146 * coming. Another workaround is to keep the static libraries but
147 * compile them with -fPIC, because that will generate PIC references
148 * to data which can be relocated. The PIC code is still too green to
149 * do this systematically, though.
152 * See thread http://www.haskell.org/pipermail/cvs-ghc/2007-September/038458.html
154 #define X86_64_ELF_NONPIC_HACK 1
156 /* -----------------------------------------------------------------------------
157 * Built-in symbols from the RTS
160 typedef struct _RtsSymbolVal {
167 #define Maybe_Stable_Names SymX(mkWeakzh_fast) \
168 SymX(makeStableNamezh_fast) \
169 SymX(finalizzeWeakzh_fast)
171 /* These are not available in GUM!!! -- HWL */
172 #define Maybe_Stable_Names
175 #if !defined (mingw32_HOST_OS)
176 #define RTS_POSIX_ONLY_SYMBOLS \
177 SymX(signal_handlers) \
178 SymX(stg_sig_install) \
182 #if defined (cygwin32_HOST_OS)
183 #define RTS_MINGW_ONLY_SYMBOLS /**/
184 /* Don't have the ability to read import libs / archives, so
185 * we have to stupidly list a lot of what libcygwin.a
188 #define RTS_CYGWIN_ONLY_SYMBOLS \
266 #elif !defined(mingw32_HOST_OS)
267 #define RTS_MINGW_ONLY_SYMBOLS /**/
268 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
269 #else /* defined(mingw32_HOST_OS) */
270 #define RTS_POSIX_ONLY_SYMBOLS /**/
271 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
273 /* Extra syms gen'ed by mingw-2's gcc-3.2: */
275 #define RTS_MINGW_EXTRA_SYMS \
276 Sym(_imp____mb_cur_max) \
279 #define RTS_MINGW_EXTRA_SYMS
282 #if HAVE_GETTIMEOFDAY
283 #define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
285 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
288 /* These are statically linked from the mingw libraries into the ghc
289 executable, so we have to employ this hack. */
290 #define RTS_MINGW_ONLY_SYMBOLS \
291 SymX(asyncReadzh_fast) \
292 SymX(asyncWritezh_fast) \
293 SymX(asyncDoProczh_fast) \
305 SymX(getservbyname) \
306 SymX(getservbyport) \
307 SymX(getprotobynumber) \
308 SymX(getprotobyname) \
309 SymX(gethostbyname) \
310 SymX(gethostbyaddr) \
357 SymX(rts_InstallConsoleEvent) \
358 SymX(rts_ConsoleHandlerDone) \
360 Sym(_imp___timezone) \
370 RTS_MINGW_EXTRA_SYMS \
371 RTS_MINGW_GETTIMEOFDAY_SYM \
375 #if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
376 #define RTS_DARWIN_ONLY_SYMBOLS \
377 Sym(asprintf$LDBLStub) \
381 Sym(fprintf$LDBLStub) \
382 Sym(fscanf$LDBLStub) \
383 Sym(fwprintf$LDBLStub) \
384 Sym(fwscanf$LDBLStub) \
385 Sym(printf$LDBLStub) \
386 Sym(scanf$LDBLStub) \
387 Sym(snprintf$LDBLStub) \
388 Sym(sprintf$LDBLStub) \
389 Sym(sscanf$LDBLStub) \
390 Sym(strtold$LDBLStub) \
391 Sym(swprintf$LDBLStub) \
392 Sym(swscanf$LDBLStub) \
393 Sym(syslog$LDBLStub) \
394 Sym(vasprintf$LDBLStub) \
396 Sym(verrc$LDBLStub) \
397 Sym(verrx$LDBLStub) \
398 Sym(vfprintf$LDBLStub) \
399 Sym(vfscanf$LDBLStub) \
400 Sym(vfwprintf$LDBLStub) \
401 Sym(vfwscanf$LDBLStub) \
402 Sym(vprintf$LDBLStub) \
403 Sym(vscanf$LDBLStub) \
404 Sym(vsnprintf$LDBLStub) \
405 Sym(vsprintf$LDBLStub) \
406 Sym(vsscanf$LDBLStub) \
407 Sym(vswprintf$LDBLStub) \
408 Sym(vswscanf$LDBLStub) \
409 Sym(vsyslog$LDBLStub) \
410 Sym(vwarn$LDBLStub) \
411 Sym(vwarnc$LDBLStub) \
412 Sym(vwarnx$LDBLStub) \
413 Sym(vwprintf$LDBLStub) \
414 Sym(vwscanf$LDBLStub) \
416 Sym(warnc$LDBLStub) \
417 Sym(warnx$LDBLStub) \
418 Sym(wcstold$LDBLStub) \
419 Sym(wprintf$LDBLStub) \
422 #define RTS_DARWIN_ONLY_SYMBOLS
426 # define MAIN_CAP_SYM SymX(MainCapability)
428 # define MAIN_CAP_SYM
431 #if !defined(mingw32_HOST_OS)
432 #define RTS_USER_SIGNALS_SYMBOLS \
433 SymX(setIOManagerPipe)
435 #define RTS_USER_SIGNALS_SYMBOLS \
436 SymX(sendIOManagerEvent) \
437 SymX(readIOManagerEvent) \
438 SymX(getIOManagerEvent) \
439 SymX(console_handler)
442 #ifdef TABLES_NEXT_TO_CODE
443 #define RTS_RET_SYMBOLS /* nothing */
445 #define RTS_RET_SYMBOLS \
446 SymX(stg_enter_ret) \
447 SymX(stg_gc_fun_ret) \
454 SymX(stg_ap_pv_ret) \
455 SymX(stg_ap_pp_ret) \
456 SymX(stg_ap_ppv_ret) \
457 SymX(stg_ap_ppp_ret) \
458 SymX(stg_ap_pppv_ret) \
459 SymX(stg_ap_pppp_ret) \
460 SymX(stg_ap_ppppp_ret) \
461 SymX(stg_ap_pppppp_ret)
464 #define RTS_SYMBOLS \
467 SymX(stg_enter_info) \
468 SymX(stg_gc_void_info) \
469 SymX(__stg_gc_enter_1) \
470 SymX(stg_gc_noregs) \
471 SymX(stg_gc_unpt_r1_info) \
472 SymX(stg_gc_unpt_r1) \
473 SymX(stg_gc_unbx_r1_info) \
474 SymX(stg_gc_unbx_r1) \
475 SymX(stg_gc_f1_info) \
477 SymX(stg_gc_d1_info) \
479 SymX(stg_gc_l1_info) \
482 SymX(stg_gc_fun_info) \
484 SymX(stg_gc_gen_info) \
485 SymX(stg_gc_gen_hp) \
487 SymX(stg_gen_yield) \
488 SymX(stg_yield_noregs) \
489 SymX(stg_yield_to_interpreter) \
490 SymX(stg_gen_block) \
491 SymX(stg_block_noregs) \
493 SymX(stg_block_takemvar) \
494 SymX(stg_block_putmvar) \
496 SymX(MallocFailHook) \
498 SymX(OutOfHeapHook) \
499 SymX(StackOverflowHook) \
500 SymX(__encodeDouble) \
501 SymX(__encodeFloat) \
503 SymExtern(__gmpn_gcd_1) \
504 SymExtern(__gmpz_cmp) \
505 SymExtern(__gmpz_cmp_si) \
506 SymExtern(__gmpz_cmp_ui) \
507 SymExtern(__gmpz_get_si) \
508 SymExtern(__gmpz_get_ui) \
509 SymX(__int_encodeDouble) \
510 SymX(__int_encodeFloat) \
511 SymX(andIntegerzh_fast) \
512 SymX(atomicallyzh_fast) \
516 SymX(blockAsyncExceptionszh_fast) \
518 SymX(catchRetryzh_fast) \
519 SymX(catchSTMzh_fast) \
521 SymX(closure_flags) \
523 SymX(cmpIntegerzh_fast) \
524 SymX(cmpIntegerIntzh_fast) \
525 SymX(complementIntegerzh_fast) \
526 SymX(createAdjustor) \
527 SymX(decodeDoublezh_fast) \
528 SymX(decodeFloatzh_fast) \
531 SymX(deRefWeakzh_fast) \
532 SymX(deRefStablePtrzh_fast) \
533 SymX(dirty_MUT_VAR) \
534 SymX(divExactIntegerzh_fast) \
535 SymX(divModIntegerzh_fast) \
537 SymX(forkOnzh_fast) \
539 SymX(forkOS_createThread) \
540 SymX(freeHaskellFunctionPtr) \
541 SymX(freeStablePtr) \
542 SymX(getOrSetTypeableStore) \
543 SymX(gcdIntegerzh_fast) \
544 SymX(gcdIntegerIntzh_fast) \
545 SymX(gcdIntzh_fast) \
549 SymX(getFullProgArgv) \
555 SymX(hs_perform_gc) \
556 SymX(hs_free_stable_ptr) \
557 SymX(hs_free_fun_ptr) \
558 SymX(hs_hpc_rootModule) \
560 SymX(unpackClosurezh_fast) \
561 SymX(getApStackValzh_fast) \
562 SymX(int2Integerzh_fast) \
563 SymX(integer2Intzh_fast) \
564 SymX(integer2Wordzh_fast) \
565 SymX(isCurrentThreadBoundzh_fast) \
566 SymX(isDoubleDenormalized) \
567 SymX(isDoubleInfinite) \
569 SymX(isDoubleNegativeZero) \
570 SymX(isEmptyMVarzh_fast) \
571 SymX(isFloatDenormalized) \
572 SymX(isFloatInfinite) \
574 SymX(isFloatNegativeZero) \
575 SymX(killThreadzh_fast) \
577 SymX(insertStableSymbol) \
580 SymX(makeStablePtrzh_fast) \
581 SymX(minusIntegerzh_fast) \
582 SymX(mkApUpd0zh_fast) \
583 SymX(myThreadIdzh_fast) \
584 SymX(labelThreadzh_fast) \
585 SymX(newArrayzh_fast) \
586 SymX(newBCOzh_fast) \
587 SymX(newByteArrayzh_fast) \
588 SymX_redirect(newCAF, newDynCAF) \
589 SymX(newMVarzh_fast) \
590 SymX(newMutVarzh_fast) \
591 SymX(newTVarzh_fast) \
592 SymX(noDuplicatezh_fast) \
593 SymX(atomicModifyMutVarzh_fast) \
594 SymX(newPinnedByteArrayzh_fast) \
596 SymX(orIntegerzh_fast) \
598 SymX(performMajorGC) \
599 SymX(plusIntegerzh_fast) \
602 SymX(putMVarzh_fast) \
603 SymX(quotIntegerzh_fast) \
604 SymX(quotRemIntegerzh_fast) \
606 SymX(raiseIOzh_fast) \
607 SymX(readTVarzh_fast) \
608 SymX(remIntegerzh_fast) \
609 SymX(resetNonBlockingFd) \
614 SymX(rts_checkSchedStatus) \
617 SymX(rts_evalLazyIO) \
618 SymX(rts_evalStableIO) \
622 SymX(rts_getDouble) \
630 SymX(rts_getFunPtr) \
631 SymX(rts_getStablePtr) \
632 SymX(rts_getThreadId) \
635 SymX(rts_getWord16) \
636 SymX(rts_getWord32) \
637 SymX(rts_getWord64) \
650 SymX(rts_mkStablePtr) \
658 SymX(rtsSupportsBoundThreads) \
659 SymX(__hscore_get_saved_termios) \
660 SymX(__hscore_set_saved_termios) \
662 SymX(startupHaskell) \
663 SymX(shutdownHaskell) \
664 SymX(shutdownHaskellAndExit) \
665 SymX(stable_ptr_table) \
666 SymX(stackOverflow) \
667 SymX(stg_CAF_BLACKHOLE_info) \
668 SymX(awakenBlockedQueue) \
669 SymX(stg_CHARLIKE_closure) \
670 SymX(stg_MVAR_CLEAN_info) \
671 SymX(stg_MVAR_DIRTY_info) \
672 SymX(stg_IND_STATIC_info) \
673 SymX(stg_INTLIKE_closure) \
674 SymX(stg_MUT_ARR_PTRS_DIRTY_info) \
675 SymX(stg_MUT_ARR_PTRS_FROZEN_info) \
676 SymX(stg_MUT_ARR_PTRS_FROZEN0_info) \
677 SymX(stg_WEAK_info) \
678 SymX(stg_ap_v_info) \
679 SymX(stg_ap_f_info) \
680 SymX(stg_ap_d_info) \
681 SymX(stg_ap_l_info) \
682 SymX(stg_ap_n_info) \
683 SymX(stg_ap_p_info) \
684 SymX(stg_ap_pv_info) \
685 SymX(stg_ap_pp_info) \
686 SymX(stg_ap_ppv_info) \
687 SymX(stg_ap_ppp_info) \
688 SymX(stg_ap_pppv_info) \
689 SymX(stg_ap_pppp_info) \
690 SymX(stg_ap_ppppp_info) \
691 SymX(stg_ap_pppppp_info) \
692 SymX(stg_ap_0_fast) \
693 SymX(stg_ap_v_fast) \
694 SymX(stg_ap_f_fast) \
695 SymX(stg_ap_d_fast) \
696 SymX(stg_ap_l_fast) \
697 SymX(stg_ap_n_fast) \
698 SymX(stg_ap_p_fast) \
699 SymX(stg_ap_pv_fast) \
700 SymX(stg_ap_pp_fast) \
701 SymX(stg_ap_ppv_fast) \
702 SymX(stg_ap_ppp_fast) \
703 SymX(stg_ap_pppv_fast) \
704 SymX(stg_ap_pppp_fast) \
705 SymX(stg_ap_ppppp_fast) \
706 SymX(stg_ap_pppppp_fast) \
707 SymX(stg_ap_1_upd_info) \
708 SymX(stg_ap_2_upd_info) \
709 SymX(stg_ap_3_upd_info) \
710 SymX(stg_ap_4_upd_info) \
711 SymX(stg_ap_5_upd_info) \
712 SymX(stg_ap_6_upd_info) \
713 SymX(stg_ap_7_upd_info) \
715 SymX(stg_sel_0_upd_info) \
716 SymX(stg_sel_10_upd_info) \
717 SymX(stg_sel_11_upd_info) \
718 SymX(stg_sel_12_upd_info) \
719 SymX(stg_sel_13_upd_info) \
720 SymX(stg_sel_14_upd_info) \
721 SymX(stg_sel_15_upd_info) \
722 SymX(stg_sel_1_upd_info) \
723 SymX(stg_sel_2_upd_info) \
724 SymX(stg_sel_3_upd_info) \
725 SymX(stg_sel_4_upd_info) \
726 SymX(stg_sel_5_upd_info) \
727 SymX(stg_sel_6_upd_info) \
728 SymX(stg_sel_7_upd_info) \
729 SymX(stg_sel_8_upd_info) \
730 SymX(stg_sel_9_upd_info) \
731 SymX(stg_upd_frame_info) \
732 SymX(suspendThread) \
733 SymX(takeMVarzh_fast) \
734 SymX(timesIntegerzh_fast) \
735 SymX(tryPutMVarzh_fast) \
736 SymX(tryTakeMVarzh_fast) \
737 SymX(unblockAsyncExceptionszh_fast) \
739 SymX(unsafeThawArrayzh_fast) \
740 SymX(waitReadzh_fast) \
741 SymX(waitWritezh_fast) \
742 SymX(word2Integerzh_fast) \
743 SymX(writeTVarzh_fast) \
744 SymX(xorIntegerzh_fast) \
746 SymX(stg_interp_constr_entry) \
749 SymX(getAllocations) \
752 SymX(rts_breakpoint_io_action) \
753 SymX(rts_stop_next_breakpoint) \
754 SymX(rts_stop_on_exception) \
756 SymX(n_capabilities) \
757 RTS_USER_SIGNALS_SYMBOLS
759 #ifdef SUPPORT_LONG_LONGS
760 #define RTS_LONG_LONG_SYMS \
761 SymX(int64ToIntegerzh_fast) \
762 SymX(word64ToIntegerzh_fast)
764 #define RTS_LONG_LONG_SYMS /* nothing */
767 // 64-bit support functions in libgcc.a
768 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
769 #define RTS_LIBGCC_SYMBOLS \
779 #elif defined(ia64_HOST_ARCH)
780 #define RTS_LIBGCC_SYMBOLS \
788 #define RTS_LIBGCC_SYMBOLS
791 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
792 // Symbols that don't have a leading underscore
793 // on Mac OS X. They have to receive special treatment,
794 // see machoInitSymbolsWithoutUnderscore()
795 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
800 /* entirely bogus claims about types of these symbols */
801 #define Sym(vvv) extern void vvv(void);
802 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
803 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
805 #define SymExtern(vvv) SymX(vvv)
807 #define SymX(vvv) /**/
808 #define SymX_redirect(vvv,xxx) /**/
812 RTS_POSIX_ONLY_SYMBOLS
813 RTS_MINGW_ONLY_SYMBOLS
814 RTS_CYGWIN_ONLY_SYMBOLS
815 RTS_DARWIN_ONLY_SYMBOLS
822 #ifdef LEADING_UNDERSCORE
823 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
825 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
828 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
830 #define SymX(vvv) Sym(vvv)
831 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
832 (void*)DLL_IMPORT_DATA_REF(vvv) },
834 // SymX_redirect allows us to redirect references to one symbol to
835 // another symbol. See newCAF/newDynCAF for an example.
836 #define SymX_redirect(vvv,xxx) \
837 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
840 static RtsSymbolVal rtsSyms[] = {
844 RTS_POSIX_ONLY_SYMBOLS
845 RTS_MINGW_ONLY_SYMBOLS
846 RTS_CYGWIN_ONLY_SYMBOLS
847 RTS_DARWIN_ONLY_SYMBOLS
849 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
850 // dyld stub code contains references to this,
851 // but it should never be called because we treat
852 // lazy pointers as nonlazy.
853 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
855 { 0, 0 } /* sentinel */
860 /* -----------------------------------------------------------------------------
861 * Insert symbols into hash tables, checking for duplicates.
864 static void ghciInsertStrHashTable ( char* obj_name,
870 if (lookupHashTable(table, (StgWord)key) == NULL)
872 insertStrHashTable(table, (StgWord)key, data);
877 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
879 "whilst processing object file\n"
881 "This could be caused by:\n"
882 " * Loading two different object files which export the same symbol\n"
883 " * Specifying the same object file twice on the GHCi command line\n"
884 " * An incorrect `package.conf' entry, causing some object to be\n"
886 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
893 /* -----------------------------------------------------------------------------
894 * initialize the object linker
898 static int linker_init_done = 0 ;
900 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
901 static void *dl_prog_handle;
909 /* Make initLinker idempotent, so we can call it
910 before evey relevant operation; that means we
911 don't need to initialise the linker separately */
912 if (linker_init_done == 1) { return; } else {
913 linker_init_done = 1;
916 stablehash = allocStrHashTable();
917 symhash = allocStrHashTable();
919 /* populate the symbol table with stuff from the RTS */
920 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
921 ghciInsertStrHashTable("(GHCi built-in symbols)",
922 symhash, sym->lbl, sym->addr);
924 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
925 machoInitSymbolsWithoutUnderscore();
928 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
929 # if defined(RTLD_DEFAULT)
930 dl_prog_handle = RTLD_DEFAULT;
932 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
933 # endif /* RTLD_DEFAULT */
937 /* -----------------------------------------------------------------------------
938 * Loading DLL or .so dynamic libraries
939 * -----------------------------------------------------------------------------
941 * Add a DLL from which symbols may be found. In the ELF case, just
942 * do RTLD_GLOBAL-style add, so no further messing around needs to
943 * happen in order that symbols in the loaded .so are findable --
944 * lookupSymbol() will subsequently see them by dlsym on the program's
945 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
947 * In the PEi386 case, open the DLLs and put handles to them in a
948 * linked list. When looking for a symbol, try all handles in the
949 * list. This means that we need to load even DLLs that are guaranteed
950 * to be in the ghc.exe image already, just so we can get a handle
951 * to give to loadSymbol, so that we can find the symbols. For such
952 * libraries, the LoadLibrary call should be a no-op except for returning
957 #if defined(OBJFORMAT_PEi386)
958 /* A record for storing handles into DLLs. */
963 struct _OpenedDLL* next;
968 /* A list thereof. */
969 static OpenedDLL* opened_dlls = NULL;
973 addDLL( char *dll_name )
975 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
976 /* ------------------- ELF DLL loader ------------------- */
982 hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
985 /* dlopen failed; return a ptr to the error msg. */
987 if (errmsg == NULL) errmsg = "addDLL: unknown error";
994 # elif defined(OBJFORMAT_PEi386)
995 /* ------------------- Win32 DLL loader ------------------- */
1003 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1005 /* See if we've already got it, and ignore if so. */
1006 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1007 if (0 == strcmp(o_dll->name, dll_name))
1011 /* The file name has no suffix (yet) so that we can try
1012 both foo.dll and foo.drv
1014 The documentation for LoadLibrary says:
1015 If no file name extension is specified in the lpFileName
1016 parameter, the default library extension .dll is
1017 appended. However, the file name string can include a trailing
1018 point character (.) to indicate that the module name has no
1021 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1022 sprintf(buf, "%s.DLL", dll_name);
1023 instance = LoadLibrary(buf);
1024 if (instance == NULL) {
1025 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1026 instance = LoadLibrary(buf);
1027 if (instance == NULL) {
1030 /* LoadLibrary failed; return a ptr to the error msg. */
1031 return "addDLL: unknown error";
1036 /* Add this DLL to the list of DLLs in which to search for symbols. */
1037 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1038 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1039 strcpy(o_dll->name, dll_name);
1040 o_dll->instance = instance;
1041 o_dll->next = opened_dlls;
1042 opened_dlls = o_dll;
1046 barf("addDLL: not implemented on this platform");
1050 /* -----------------------------------------------------------------------------
1051 * insert a stable symbol in the hash table
1055 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1057 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1061 /* -----------------------------------------------------------------------------
1062 * insert a symbol in the hash table
1065 insertSymbol(char* obj_name, char* key, void* data)
1067 ghciInsertStrHashTable(obj_name, symhash, key, data);
1070 /* -----------------------------------------------------------------------------
1071 * lookup a symbol in the hash table
1074 lookupSymbol( char *lbl )
1078 ASSERT(symhash != NULL);
1079 val = lookupStrHashTable(symhash, lbl);
1082 # if defined(OBJFORMAT_ELF)
1083 return dlsym(dl_prog_handle, lbl);
1084 # elif defined(OBJFORMAT_MACHO)
1086 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1089 HACK: On OS X, global symbols are prefixed with an underscore.
1090 However, dlsym wants us to omit the leading underscore from the
1091 symbol name. For now, we simply strip it off here (and ONLY
1094 ASSERT(lbl[0] == '_');
1095 return dlsym(dl_prog_handle, lbl+1);
1097 if(NSIsSymbolNameDefined(lbl)) {
1098 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1099 return NSAddressOfSymbol(symbol);
1103 # endif /* HAVE_DLFCN_H */
1104 # elif defined(OBJFORMAT_PEi386)
1107 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1108 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1109 if (lbl[0] == '_') {
1110 /* HACK: if the name has an initial underscore, try stripping
1111 it off & look that up first. I've yet to verify whether there's
1112 a Rule that governs whether an initial '_' *should always* be
1113 stripped off when mapping from import lib name to the DLL name.
1115 sym = GetProcAddress(o_dll->instance, (lbl+1));
1117 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1121 sym = GetProcAddress(o_dll->instance, lbl);
1123 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1138 __attribute((unused))
1140 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1144 val = lookupStrHashTable(oc->lochash, lbl);
1154 /* -----------------------------------------------------------------------------
1155 * Debugging aid: look in GHCi's object symbol tables for symbols
1156 * within DELTA bytes of the specified address, and show their names.
1159 void ghci_enquire ( char* addr );
1161 void ghci_enquire ( char* addr )
1166 const int DELTA = 64;
1171 for (oc = objects; oc; oc = oc->next) {
1172 for (i = 0; i < oc->n_symbols; i++) {
1173 sym = oc->symbols[i];
1174 if (sym == NULL) continue;
1175 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1177 if (oc->lochash != NULL) {
1178 a = lookupStrHashTable(oc->lochash, sym);
1181 a = lookupStrHashTable(symhash, sym);
1184 // debugBelch("ghci_enquire: can't find %s\n", sym);
1186 else if (addr-DELTA <= a && a <= addr+DELTA) {
1187 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1194 #ifdef ia64_HOST_ARCH
1195 static unsigned int PLTSize(void);
1198 /* -----------------------------------------------------------------------------
1199 * Load an obj (populate the global symbol table, but don't resolve yet)
1201 * Returns: 1 if ok, 0 on error.
1204 loadObj( char *path )
1211 void *map_addr = NULL;
1217 /* debugBelch("loadObj %s\n", path ); */
1219 /* Check that we haven't already loaded this object.
1220 Ignore requests to load multiple times */
1224 for (o = objects; o; o = o->next) {
1225 if (0 == strcmp(o->fileName, path)) {
1227 break; /* don't need to search further */
1231 IF_DEBUG(linker, debugBelch(
1232 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1233 "same object file twice:\n"
1235 "GHCi will ignore this, but be warned.\n"
1237 return 1; /* success */
1241 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1243 # if defined(OBJFORMAT_ELF)
1244 oc->formatName = "ELF";
1245 # elif defined(OBJFORMAT_PEi386)
1246 oc->formatName = "PEi386";
1247 # elif defined(OBJFORMAT_MACHO)
1248 oc->formatName = "Mach-O";
1251 barf("loadObj: not implemented on this platform");
1254 r = stat(path, &st);
1255 if (r == -1) { return 0; }
1257 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1258 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1259 strcpy(oc->fileName, path);
1261 oc->fileSize = st.st_size;
1263 oc->sections = NULL;
1264 oc->lochash = allocStrHashTable();
1265 oc->proddables = NULL;
1267 /* chain it onto the list of objects */
1272 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1274 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1276 #if defined(openbsd_HOST_OS)
1277 fd = open(path, O_RDONLY, S_IRUSR);
1279 fd = open(path, O_RDONLY);
1282 barf("loadObj: can't open `%s'", path);
1284 pagesize = getpagesize();
1286 #ifdef ia64_HOST_ARCH
1287 /* The PLT needs to be right before the object */
1288 n = ROUND_UP(PLTSize(), pagesize);
1289 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1290 if (oc->plt == MAP_FAILED)
1291 barf("loadObj: can't allocate PLT");
1294 map_addr = oc->plt + n;
1297 n = ROUND_UP(oc->fileSize, pagesize);
1299 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1300 * small memory model on this architecture (see gcc docs,
1303 * MAP_32BIT not available on OpenBSD/amd64
1305 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
1306 #define EXTRA_MAP_FLAGS MAP_32BIT
1308 #define EXTRA_MAP_FLAGS 0
1311 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
1312 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
1313 #define MAP_ANONYMOUS MAP_ANON
1316 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1317 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1318 if (oc->image == MAP_FAILED)
1319 barf("loadObj: can't map `%s'", path);
1323 #else /* !USE_MMAP */
1325 /* load the image into memory */
1326 f = fopen(path, "rb");
1328 barf("loadObj: can't read `%s'", path);
1330 # if defined(mingw32_HOST_OS)
1331 // TODO: We would like to use allocateExec here, but allocateExec
1332 // cannot currently allocate blocks large enough.
1333 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1334 PAGE_EXECUTE_READWRITE);
1335 # elif defined(darwin_HOST_OS)
1336 // In a Mach-O .o file, all sections can and will be misaligned
1337 // if the total size of the headers is not a multiple of the
1338 // desired alignment. This is fine for .o files that only serve
1339 // as input for the static linker, but it's not fine for us,
1340 // as SSE (used by gcc for floating point) and Altivec require
1341 // 16-byte alignment.
1342 // We calculate the correct alignment from the header before
1343 // reading the file, and then we misalign oc->image on purpose so
1344 // that the actual sections end up aligned again.
1345 oc->misalignment = machoGetMisalignment(f);
1346 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1347 oc->image += oc->misalignment;
1349 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1352 n = fread ( oc->image, 1, oc->fileSize, f );
1353 if (n != oc->fileSize)
1354 barf("loadObj: error whilst reading `%s'", path);
1357 #endif /* USE_MMAP */
1359 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1360 r = ocAllocateSymbolExtras_MachO ( oc );
1361 if (!r) { return r; }
1362 # elif defined(OBJFORMAT_ELF) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1363 r = ocAllocateSymbolExtras_ELF ( oc );
1364 if (!r) { return r; }
1367 /* verify the in-memory image */
1368 # if defined(OBJFORMAT_ELF)
1369 r = ocVerifyImage_ELF ( oc );
1370 # elif defined(OBJFORMAT_PEi386)
1371 r = ocVerifyImage_PEi386 ( oc );
1372 # elif defined(OBJFORMAT_MACHO)
1373 r = ocVerifyImage_MachO ( oc );
1375 barf("loadObj: no verify method");
1377 if (!r) { return r; }
1379 /* build the symbol list for this image */
1380 # if defined(OBJFORMAT_ELF)
1381 r = ocGetNames_ELF ( oc );
1382 # elif defined(OBJFORMAT_PEi386)
1383 r = ocGetNames_PEi386 ( oc );
1384 # elif defined(OBJFORMAT_MACHO)
1385 r = ocGetNames_MachO ( oc );
1387 barf("loadObj: no getNames method");
1389 if (!r) { return r; }
1391 /* loaded, but not resolved yet */
1392 oc->status = OBJECT_LOADED;
1397 /* -----------------------------------------------------------------------------
1398 * resolve all the currently unlinked objects in memory
1400 * Returns: 1 if ok, 0 on error.
1410 for (oc = objects; oc; oc = oc->next) {
1411 if (oc->status != OBJECT_RESOLVED) {
1412 # if defined(OBJFORMAT_ELF)
1413 r = ocResolve_ELF ( oc );
1414 # elif defined(OBJFORMAT_PEi386)
1415 r = ocResolve_PEi386 ( oc );
1416 # elif defined(OBJFORMAT_MACHO)
1417 r = ocResolve_MachO ( oc );
1419 barf("resolveObjs: not implemented on this platform");
1421 if (!r) { return r; }
1422 oc->status = OBJECT_RESOLVED;
1428 /* -----------------------------------------------------------------------------
1429 * delete an object from the pool
1432 unloadObj( char *path )
1434 ObjectCode *oc, *prev;
1436 ASSERT(symhash != NULL);
1437 ASSERT(objects != NULL);
1442 for (oc = objects; oc; prev = oc, oc = oc->next) {
1443 if (!strcmp(oc->fileName,path)) {
1445 /* Remove all the mappings for the symbols within this
1450 for (i = 0; i < oc->n_symbols; i++) {
1451 if (oc->symbols[i] != NULL) {
1452 removeStrHashTable(symhash, oc->symbols[i], NULL);
1460 prev->next = oc->next;
1463 // We're going to leave this in place, in case there are
1464 // any pointers from the heap into it:
1465 // #ifdef mingw32_HOST_OS
1466 // VirtualFree(oc->image);
1468 // stgFree(oc->image);
1470 stgFree(oc->fileName);
1471 stgFree(oc->symbols);
1472 stgFree(oc->sections);
1473 /* The local hash table should have been freed at the end
1474 of the ocResolve_ call on it. */
1475 ASSERT(oc->lochash == NULL);
1481 errorBelch("unloadObj: can't find `%s' to unload", path);
1485 /* -----------------------------------------------------------------------------
1486 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1487 * which may be prodded during relocation, and abort if we try and write
1488 * outside any of these.
1490 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1493 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1494 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1498 pb->next = oc->proddables;
1499 oc->proddables = pb;
1502 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1505 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1506 char* s = (char*)(pb->start);
1507 char* e = s + pb->size - 1;
1508 char* a = (char*)addr;
1509 /* Assumes that the biggest fixup involves a 4-byte write. This
1510 probably needs to be changed to 8 (ie, +7) on 64-bit
1512 if (a >= s && (a+3) <= e) return;
1514 barf("checkProddableBlock: invalid fixup in runtime linker");
1517 /* -----------------------------------------------------------------------------
1518 * Section management.
1520 static void addSection ( ObjectCode* oc, SectionKind kind,
1521 void* start, void* end )
1523 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1527 s->next = oc->sections;
1530 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1531 start, ((char*)end)-1, end - start + 1, kind );
1536 /* --------------------------------------------------------------------------
1538 * This is about allocating a small chunk of memory for every symbol in the
1539 * object file. We make sure that the SymboLExtras are always "in range" of
1540 * limited-range PC-relative instructions on various platforms by allocating
1541 * them right next to the object code itself.
1544 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
1547 ocAllocateSymbolExtras
1549 Allocate additional space at the end of the object file image to make room
1550 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1552 PowerPC relative branch instructions have a 24 bit displacement field.
1553 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1554 If a particular imported symbol is outside this range, we have to redirect
1555 the jump to a short piece of new code that just loads the 32bit absolute
1556 address and jumps there.
1557 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1560 This function just allocates space for one SymbolExtra for every
1561 undefined symbol in the object file. The code for the jump islands is
1562 filled in by makeSymbolExtra below.
1565 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1572 int misalignment = 0;
1573 #ifdef darwin_HOST_OS
1574 misalignment = oc->misalignment;
1580 // round up to the nearest 4
1581 aligned = (oc->fileSize + 3) & ~3;
1584 #ifndef linux_HOST_OS /* mremap is a linux extension */
1585 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1588 pagesize = getpagesize();
1589 n = ROUND_UP( oc->fileSize, pagesize );
1590 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1592 /* If we have a half-page-size file and map one page of it then
1593 * the part of the page after the size of the file remains accessible.
1594 * If, however, we map in 2 pages, the 2nd page is not accessible
1595 * and will give a "Bus Error" on access. To get around this, we check
1596 * if we need any extra pages for the jump islands and map them in
1597 * anonymously. We must check that we actually require extra pages
1598 * otherwise the attempt to mmap 0 pages of anonymous memory will
1604 /* The effect of this mremap() call is only the ensure that we have
1605 * a sufficient number of virtually contiguous pages. As returned from
1606 * mremap, the pages past the end of the file are not backed. We give
1607 * them a backing by using MAP_FIXED to map in anonymous pages.
1609 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1611 if( oc->image == MAP_FAILED )
1613 errorBelch( "Unable to mremap for Jump Islands\n" );
1617 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1618 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1620 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1626 oc->image -= misalignment;
1627 oc->image = stgReallocBytes( oc->image,
1629 aligned + sizeof (SymbolExtra) * count,
1630 "ocAllocateSymbolExtras" );
1631 oc->image += misalignment;
1632 #endif /* USE_MMAP */
1634 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1635 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1638 oc->symbol_extras = NULL;
1640 oc->first_symbol_extra = first;
1641 oc->n_symbol_extras = count;
1646 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1647 unsigned long symbolNumber,
1648 unsigned long target )
1652 ASSERT( symbolNumber >= oc->first_symbol_extra
1653 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1655 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1657 #ifdef powerpc_HOST_ARCH
1658 // lis r12, hi16(target)
1659 extra->jumpIsland.lis_r12 = 0x3d80;
1660 extra->jumpIsland.hi_addr = target >> 16;
1662 // ori r12, r12, lo16(target)
1663 extra->jumpIsland.ori_r12_r12 = 0x618c;
1664 extra->jumpIsland.lo_addr = target & 0xffff;
1667 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1670 extra->jumpIsland.bctr = 0x4e800420;
1672 #ifdef x86_64_HOST_ARCH
1674 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1675 extra->addr = target;
1676 memcpy(extra->jumpIsland, jmp, 6);
1684 /* --------------------------------------------------------------------------
1685 * PowerPC specifics (instruction cache flushing)
1686 * ------------------------------------------------------------------------*/
1688 #ifdef powerpc_TARGET_ARCH
1690 ocFlushInstructionCache
1692 Flush the data & instruction caches.
1693 Because the PPC has split data/instruction caches, we have to
1694 do that whenever we modify code at runtime.
1697 static void ocFlushInstructionCache( ObjectCode *oc )
1699 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1700 unsigned long *p = (unsigned long *) oc->image;
1704 __asm__ volatile ( "dcbf 0,%0\n\t"
1712 __asm__ volatile ( "sync\n\t"
1718 /* --------------------------------------------------------------------------
1719 * PEi386 specifics (Win32 targets)
1720 * ------------------------------------------------------------------------*/
1722 /* The information for this linker comes from
1723 Microsoft Portable Executable
1724 and Common Object File Format Specification
1725 revision 5.1 January 1998
1726 which SimonM says comes from the MS Developer Network CDs.
1728 It can be found there (on older CDs), but can also be found
1731 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1733 (this is Rev 6.0 from February 1999).
1735 Things move, so if that fails, try searching for it via
1737 http://www.google.com/search?q=PE+COFF+specification
1739 The ultimate reference for the PE format is the Winnt.h
1740 header file that comes with the Platform SDKs; as always,
1741 implementations will drift wrt their documentation.
1743 A good background article on the PE format is Matt Pietrek's
1744 March 1994 article in Microsoft System Journal (MSJ)
1745 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1746 Win32 Portable Executable File Format." The info in there
1747 has recently been updated in a two part article in
1748 MSDN magazine, issues Feb and March 2002,
1749 "Inside Windows: An In-Depth Look into the Win32 Portable
1750 Executable File Format"
1752 John Levine's book "Linkers and Loaders" contains useful
1757 #if defined(OBJFORMAT_PEi386)
1761 typedef unsigned char UChar;
1762 typedef unsigned short UInt16;
1763 typedef unsigned int UInt32;
1770 UInt16 NumberOfSections;
1771 UInt32 TimeDateStamp;
1772 UInt32 PointerToSymbolTable;
1773 UInt32 NumberOfSymbols;
1774 UInt16 SizeOfOptionalHeader;
1775 UInt16 Characteristics;
1779 #define sizeof_COFF_header 20
1786 UInt32 VirtualAddress;
1787 UInt32 SizeOfRawData;
1788 UInt32 PointerToRawData;
1789 UInt32 PointerToRelocations;
1790 UInt32 PointerToLinenumbers;
1791 UInt16 NumberOfRelocations;
1792 UInt16 NumberOfLineNumbers;
1793 UInt32 Characteristics;
1797 #define sizeof_COFF_section 40
1804 UInt16 SectionNumber;
1807 UChar NumberOfAuxSymbols;
1811 #define sizeof_COFF_symbol 18
1816 UInt32 VirtualAddress;
1817 UInt32 SymbolTableIndex;
1822 #define sizeof_COFF_reloc 10
1825 /* From PE spec doc, section 3.3.2 */
1826 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1827 windows.h -- for the same purpose, but I want to know what I'm
1829 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1830 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1831 #define MYIMAGE_FILE_DLL 0x2000
1832 #define MYIMAGE_FILE_SYSTEM 0x1000
1833 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1834 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1835 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1837 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1838 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1839 #define MYIMAGE_SYM_CLASS_STATIC 3
1840 #define MYIMAGE_SYM_UNDEFINED 0
1842 /* From PE spec doc, section 4.1 */
1843 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1844 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1845 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1847 /* From PE spec doc, section 5.2.1 */
1848 #define MYIMAGE_REL_I386_DIR32 0x0006
1849 #define MYIMAGE_REL_I386_REL32 0x0014
1852 /* We use myindex to calculate array addresses, rather than
1853 simply doing the normal subscript thing. That's because
1854 some of the above structs have sizes which are not
1855 a whole number of words. GCC rounds their sizes up to a
1856 whole number of words, which means that the address calcs
1857 arising from using normal C indexing or pointer arithmetic
1858 are just plain wrong. Sigh.
1861 myindex ( int scale, void* base, int index )
1864 ((UChar*)base) + scale * index;
1869 printName ( UChar* name, UChar* strtab )
1871 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1872 UInt32 strtab_offset = * (UInt32*)(name+4);
1873 debugBelch("%s", strtab + strtab_offset );
1876 for (i = 0; i < 8; i++) {
1877 if (name[i] == 0) break;
1878 debugBelch("%c", name[i] );
1885 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1887 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1888 UInt32 strtab_offset = * (UInt32*)(name+4);
1889 strncpy ( dst, strtab+strtab_offset, dstSize );
1895 if (name[i] == 0) break;
1905 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1908 /* If the string is longer than 8 bytes, look in the
1909 string table for it -- this will be correctly zero terminated.
1911 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1912 UInt32 strtab_offset = * (UInt32*)(name+4);
1913 return ((UChar*)strtab) + strtab_offset;
1915 /* Otherwise, if shorter than 8 bytes, return the original,
1916 which by defn is correctly terminated.
1918 if (name[7]==0) return name;
1919 /* The annoying case: 8 bytes. Copy into a temporary
1920 (which is never freed ...)
1922 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1924 strncpy(newstr,name,8);
1930 /* Just compares the short names (first 8 chars) */
1931 static COFF_section *
1932 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1936 = (COFF_header*)(oc->image);
1937 COFF_section* sectab
1939 ((UChar*)(oc->image))
1940 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1942 for (i = 0; i < hdr->NumberOfSections; i++) {
1945 COFF_section* section_i
1947 myindex ( sizeof_COFF_section, sectab, i );
1948 n1 = (UChar*) &(section_i->Name);
1950 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1951 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1952 n1[6]==n2[6] && n1[7]==n2[7])
1961 zapTrailingAtSign ( UChar* sym )
1963 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
1965 if (sym[0] == 0) return;
1967 while (sym[i] != 0) i++;
1970 while (j > 0 && my_isdigit(sym[j])) j--;
1971 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
1977 ocVerifyImage_PEi386 ( ObjectCode* oc )
1982 COFF_section* sectab;
1983 COFF_symbol* symtab;
1985 /* debugBelch("\nLOADING %s\n", oc->fileName); */
1986 hdr = (COFF_header*)(oc->image);
1987 sectab = (COFF_section*) (
1988 ((UChar*)(oc->image))
1989 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1991 symtab = (COFF_symbol*) (
1992 ((UChar*)(oc->image))
1993 + hdr->PointerToSymbolTable
1995 strtab = ((UChar*)symtab)
1996 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
1998 if (hdr->Machine != 0x14c) {
1999 errorBelch("%s: Not x86 PEi386", oc->fileName);
2002 if (hdr->SizeOfOptionalHeader != 0) {
2003 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
2006 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
2007 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
2008 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
2009 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
2010 errorBelch("%s: Not a PEi386 object file", oc->fileName);
2013 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
2014 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
2015 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
2017 (int)(hdr->Characteristics));
2020 /* If the string table size is way crazy, this might indicate that
2021 there are more than 64k relocations, despite claims to the
2022 contrary. Hence this test. */
2023 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2025 if ( (*(UInt32*)strtab) > 600000 ) {
2026 /* Note that 600k has no special significance other than being
2027 big enough to handle the almost-2MB-sized lumps that
2028 constitute HSwin32*.o. */
2029 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2034 /* No further verification after this point; only debug printing. */
2036 IF_DEBUG(linker, i=1);
2037 if (i == 0) return 1;
2039 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2040 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2041 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2044 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2045 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2046 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2047 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2048 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2049 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2050 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2052 /* Print the section table. */
2054 for (i = 0; i < hdr->NumberOfSections; i++) {
2056 COFF_section* sectab_i
2058 myindex ( sizeof_COFF_section, sectab, i );
2065 printName ( sectab_i->Name, strtab );
2075 sectab_i->VirtualSize,
2076 sectab_i->VirtualAddress,
2077 sectab_i->SizeOfRawData,
2078 sectab_i->PointerToRawData,
2079 sectab_i->NumberOfRelocations,
2080 sectab_i->PointerToRelocations,
2081 sectab_i->PointerToRawData
2083 reltab = (COFF_reloc*) (
2084 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2087 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2088 /* If the relocation field (a short) has overflowed, the
2089 * real count can be found in the first reloc entry.
2091 * See Section 4.1 (last para) of the PE spec (rev6.0).
2093 COFF_reloc* rel = (COFF_reloc*)
2094 myindex ( sizeof_COFF_reloc, reltab, 0 );
2095 noRelocs = rel->VirtualAddress;
2098 noRelocs = sectab_i->NumberOfRelocations;
2102 for (; j < noRelocs; j++) {
2104 COFF_reloc* rel = (COFF_reloc*)
2105 myindex ( sizeof_COFF_reloc, reltab, j );
2107 " type 0x%-4x vaddr 0x%-8x name `",
2109 rel->VirtualAddress );
2110 sym = (COFF_symbol*)
2111 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2112 /* Hmm..mysterious looking offset - what's it for? SOF */
2113 printName ( sym->Name, strtab -10 );
2120 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2121 debugBelch("---START of string table---\n");
2122 for (i = 4; i < *(Int32*)strtab; i++) {
2124 debugBelch("\n"); else
2125 debugBelch("%c", strtab[i] );
2127 debugBelch("--- END of string table---\n");
2132 COFF_symbol* symtab_i;
2133 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2134 symtab_i = (COFF_symbol*)
2135 myindex ( sizeof_COFF_symbol, symtab, i );
2141 printName ( symtab_i->Name, strtab );
2150 (Int32)(symtab_i->SectionNumber),
2151 (UInt32)symtab_i->Type,
2152 (UInt32)symtab_i->StorageClass,
2153 (UInt32)symtab_i->NumberOfAuxSymbols
2155 i += symtab_i->NumberOfAuxSymbols;
2165 ocGetNames_PEi386 ( ObjectCode* oc )
2168 COFF_section* sectab;
2169 COFF_symbol* symtab;
2176 hdr = (COFF_header*)(oc->image);
2177 sectab = (COFF_section*) (
2178 ((UChar*)(oc->image))
2179 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2181 symtab = (COFF_symbol*) (
2182 ((UChar*)(oc->image))
2183 + hdr->PointerToSymbolTable
2185 strtab = ((UChar*)(oc->image))
2186 + hdr->PointerToSymbolTable
2187 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2189 /* Allocate space for any (local, anonymous) .bss sections. */
2191 for (i = 0; i < hdr->NumberOfSections; i++) {
2194 COFF_section* sectab_i
2196 myindex ( sizeof_COFF_section, sectab, i );
2197 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2198 /* sof 10/05: the PE spec text isn't too clear regarding what
2199 * the SizeOfRawData field is supposed to hold for object
2200 * file sections containing just uninitialized data -- for executables,
2201 * it is supposed to be zero; unclear what it's supposed to be
2202 * for object files. However, VirtualSize is guaranteed to be
2203 * zero for object files, which definitely suggests that SizeOfRawData
2204 * will be non-zero (where else would the size of this .bss section be
2205 * stored?) Looking at the COFF_section info for incoming object files,
2206 * this certainly appears to be the case.
2208 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2209 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2210 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2211 * variable decls into to the .bss section. (The specific function in Q which
2212 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2214 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2215 /* This is a non-empty .bss section. Allocate zeroed space for
2216 it, and set its PointerToRawData field such that oc->image +
2217 PointerToRawData == addr_of_zeroed_space. */
2218 bss_sz = sectab_i->VirtualSize;
2219 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2220 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2221 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2222 addProddableBlock(oc, zspace, bss_sz);
2223 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2226 /* Copy section information into the ObjectCode. */
2228 for (i = 0; i < hdr->NumberOfSections; i++) {
2234 = SECTIONKIND_OTHER;
2235 COFF_section* sectab_i
2237 myindex ( sizeof_COFF_section, sectab, i );
2238 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2241 /* I'm sure this is the Right Way to do it. However, the
2242 alternative of testing the sectab_i->Name field seems to
2243 work ok with Cygwin.
2245 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2246 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2247 kind = SECTIONKIND_CODE_OR_RODATA;
2250 if (0==strcmp(".text",sectab_i->Name) ||
2251 0==strcmp(".rdata",sectab_i->Name)||
2252 0==strcmp(".rodata",sectab_i->Name))
2253 kind = SECTIONKIND_CODE_OR_RODATA;
2254 if (0==strcmp(".data",sectab_i->Name) ||
2255 0==strcmp(".bss",sectab_i->Name))
2256 kind = SECTIONKIND_RWDATA;
2258 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2259 sz = sectab_i->SizeOfRawData;
2260 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2262 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2263 end = start + sz - 1;
2265 if (kind == SECTIONKIND_OTHER
2266 /* Ignore sections called which contain stabs debugging
2268 && 0 != strcmp(".stab", sectab_i->Name)
2269 && 0 != strcmp(".stabstr", sectab_i->Name)
2270 /* ignore constructor section for now */
2271 && 0 != strcmp(".ctors", sectab_i->Name)
2272 /* ignore section generated from .ident */
2273 && 0!= strcmp("/4", sectab_i->Name)
2275 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2279 if (kind != SECTIONKIND_OTHER && end >= start) {
2280 addSection(oc, kind, start, end);
2281 addProddableBlock(oc, start, end - start + 1);
2285 /* Copy exported symbols into the ObjectCode. */
2287 oc->n_symbols = hdr->NumberOfSymbols;
2288 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2289 "ocGetNames_PEi386(oc->symbols)");
2290 /* Call me paranoid; I don't care. */
2291 for (i = 0; i < oc->n_symbols; i++)
2292 oc->symbols[i] = NULL;
2296 COFF_symbol* symtab_i;
2297 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2298 symtab_i = (COFF_symbol*)
2299 myindex ( sizeof_COFF_symbol, symtab, i );
2303 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2304 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2305 /* This symbol is global and defined, viz, exported */
2306 /* for MYIMAGE_SYMCLASS_EXTERNAL
2307 && !MYIMAGE_SYM_UNDEFINED,
2308 the address of the symbol is:
2309 address of relevant section + offset in section
2311 COFF_section* sectabent
2312 = (COFF_section*) myindex ( sizeof_COFF_section,
2314 symtab_i->SectionNumber-1 );
2315 addr = ((UChar*)(oc->image))
2316 + (sectabent->PointerToRawData
2320 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2321 && symtab_i->Value > 0) {
2322 /* This symbol isn't in any section at all, ie, global bss.
2323 Allocate zeroed space for it. */
2324 addr = stgCallocBytes(1, symtab_i->Value,
2325 "ocGetNames_PEi386(non-anonymous bss)");
2326 addSection(oc, SECTIONKIND_RWDATA, addr,
2327 ((UChar*)addr) + symtab_i->Value - 1);
2328 addProddableBlock(oc, addr, symtab_i->Value);
2329 /* debugBelch("BSS section at 0x%x\n", addr); */
2332 if (addr != NULL ) {
2333 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2334 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2335 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2336 ASSERT(i >= 0 && i < oc->n_symbols);
2337 /* cstring_from_COFF_symbol_name always succeeds. */
2338 oc->symbols[i] = sname;
2339 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2343 "IGNORING symbol %d\n"
2347 printName ( symtab_i->Name, strtab );
2356 (Int32)(symtab_i->SectionNumber),
2357 (UInt32)symtab_i->Type,
2358 (UInt32)symtab_i->StorageClass,
2359 (UInt32)symtab_i->NumberOfAuxSymbols
2364 i += symtab_i->NumberOfAuxSymbols;
2373 ocResolve_PEi386 ( ObjectCode* oc )
2376 COFF_section* sectab;
2377 COFF_symbol* symtab;
2387 /* ToDo: should be variable-sized? But is at least safe in the
2388 sense of buffer-overrun-proof. */
2390 /* debugBelch("resolving for %s\n", oc->fileName); */
2392 hdr = (COFF_header*)(oc->image);
2393 sectab = (COFF_section*) (
2394 ((UChar*)(oc->image))
2395 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2397 symtab = (COFF_symbol*) (
2398 ((UChar*)(oc->image))
2399 + hdr->PointerToSymbolTable
2401 strtab = ((UChar*)(oc->image))
2402 + hdr->PointerToSymbolTable
2403 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2405 for (i = 0; i < hdr->NumberOfSections; i++) {
2406 COFF_section* sectab_i
2408 myindex ( sizeof_COFF_section, sectab, i );
2411 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2414 /* Ignore sections called which contain stabs debugging
2416 if (0 == strcmp(".stab", sectab_i->Name)
2417 || 0 == strcmp(".stabstr", sectab_i->Name)
2418 || 0 == strcmp(".ctors", sectab_i->Name))
2421 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2422 /* If the relocation field (a short) has overflowed, the
2423 * real count can be found in the first reloc entry.
2425 * See Section 4.1 (last para) of the PE spec (rev6.0).
2427 * Nov2003 update: the GNU linker still doesn't correctly
2428 * handle the generation of relocatable object files with
2429 * overflown relocations. Hence the output to warn of potential
2432 COFF_reloc* rel = (COFF_reloc*)
2433 myindex ( sizeof_COFF_reloc, reltab, 0 );
2434 noRelocs = rel->VirtualAddress;
2436 /* 10/05: we now assume (and check for) a GNU ld that is capable
2437 * of handling object files with (>2^16) of relocs.
2440 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2445 noRelocs = sectab_i->NumberOfRelocations;
2450 for (; j < noRelocs; j++) {
2452 COFF_reloc* reltab_j
2454 myindex ( sizeof_COFF_reloc, reltab, j );
2456 /* the location to patch */
2458 ((UChar*)(oc->image))
2459 + (sectab_i->PointerToRawData
2460 + reltab_j->VirtualAddress
2461 - sectab_i->VirtualAddress )
2463 /* the existing contents of pP */
2465 /* the symbol to connect to */
2466 sym = (COFF_symbol*)
2467 myindex ( sizeof_COFF_symbol,
2468 symtab, reltab_j->SymbolTableIndex );
2471 "reloc sec %2d num %3d: type 0x%-4x "
2472 "vaddr 0x%-8x name `",
2474 (UInt32)reltab_j->Type,
2475 reltab_j->VirtualAddress );
2476 printName ( sym->Name, strtab );
2477 debugBelch("'\n" ));
2479 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2480 COFF_section* section_sym
2481 = findPEi386SectionCalled ( oc, sym->Name );
2483 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2486 S = ((UInt32)(oc->image))
2487 + (section_sym->PointerToRawData
2490 copyName ( sym->Name, strtab, symbol, 1000-1 );
2491 S = (UInt32) lookupLocalSymbol( oc, symbol );
2492 if ((void*)S != NULL) goto foundit;
2493 S = (UInt32) lookupSymbol( symbol );
2494 if ((void*)S != NULL) goto foundit;
2495 zapTrailingAtSign ( symbol );
2496 S = (UInt32) lookupLocalSymbol( oc, symbol );
2497 if ((void*)S != NULL) goto foundit;
2498 S = (UInt32) lookupSymbol( symbol );
2499 if ((void*)S != NULL) goto foundit;
2500 /* Newline first because the interactive linker has printed "linking..." */
2501 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2505 checkProddableBlock(oc, pP);
2506 switch (reltab_j->Type) {
2507 case MYIMAGE_REL_I386_DIR32:
2510 case MYIMAGE_REL_I386_REL32:
2511 /* Tricky. We have to insert a displacement at
2512 pP which, when added to the PC for the _next_
2513 insn, gives the address of the target (S).
2514 Problem is to know the address of the next insn
2515 when we only know pP. We assume that this
2516 literal field is always the last in the insn,
2517 so that the address of the next insn is pP+4
2518 -- hence the constant 4.
2519 Also I don't know if A should be added, but so
2520 far it has always been zero.
2522 SOF 05/2005: 'A' (old contents of *pP) have been observed
2523 to contain values other than zero (the 'wx' object file
2524 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2525 So, add displacement to old value instead of asserting
2526 A to be zero. Fixes wxhaskell-related crashes, and no other
2527 ill effects have been observed.
2529 Update: the reason why we're seeing these more elaborate
2530 relocations is due to a switch in how the NCG compiles SRTs
2531 and offsets to them from info tables. SRTs live in .(ro)data,
2532 while info tables live in .text, causing GAS to emit REL32/DISP32
2533 relocations with non-zero values. Adding the displacement is
2534 the right thing to do.
2536 *pP = S - ((UInt32)pP) - 4 + A;
2539 debugBelch("%s: unhandled PEi386 relocation type %d",
2540 oc->fileName, reltab_j->Type);
2547 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2551 #endif /* defined(OBJFORMAT_PEi386) */
2554 /* --------------------------------------------------------------------------
2556 * ------------------------------------------------------------------------*/
2558 #if defined(OBJFORMAT_ELF)
2563 #if defined(sparc_HOST_ARCH)
2564 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2565 #elif defined(i386_HOST_ARCH)
2566 # define ELF_TARGET_386 /* Used inside <elf.h> */
2567 #elif defined(x86_64_HOST_ARCH)
2568 # define ELF_TARGET_X64_64
2570 #elif defined (ia64_HOST_ARCH)
2571 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2573 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2574 # define ELF_NEED_GOT /* needs Global Offset Table */
2575 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2578 #if !defined(openbsd_HOST_OS)
2581 /* openbsd elf has things in different places, with diff names */
2582 # include <elf_abi.h>
2583 # include <machine/reloc.h>
2584 # define R_386_32 RELOC_32
2585 # define R_386_PC32 RELOC_PC32
2588 /* If elf.h doesn't define it */
2589 # ifndef R_X86_64_PC64
2590 # define R_X86_64_PC64 24
2594 * Define a set of types which can be used for both ELF32 and ELF64
2598 #define ELFCLASS ELFCLASS64
2599 #define Elf_Addr Elf64_Addr
2600 #define Elf_Word Elf64_Word
2601 #define Elf_Sword Elf64_Sword
2602 #define Elf_Ehdr Elf64_Ehdr
2603 #define Elf_Phdr Elf64_Phdr
2604 #define Elf_Shdr Elf64_Shdr
2605 #define Elf_Sym Elf64_Sym
2606 #define Elf_Rel Elf64_Rel
2607 #define Elf_Rela Elf64_Rela
2608 #define ELF_ST_TYPE ELF64_ST_TYPE
2609 #define ELF_ST_BIND ELF64_ST_BIND
2610 #define ELF_R_TYPE ELF64_R_TYPE
2611 #define ELF_R_SYM ELF64_R_SYM
2613 #define ELFCLASS ELFCLASS32
2614 #define Elf_Addr Elf32_Addr
2615 #define Elf_Word Elf32_Word
2616 #define Elf_Sword Elf32_Sword
2617 #define Elf_Ehdr Elf32_Ehdr
2618 #define Elf_Phdr Elf32_Phdr
2619 #define Elf_Shdr Elf32_Shdr
2620 #define Elf_Sym Elf32_Sym
2621 #define Elf_Rel Elf32_Rel
2622 #define Elf_Rela Elf32_Rela
2624 #define ELF_ST_TYPE ELF32_ST_TYPE
2627 #define ELF_ST_BIND ELF32_ST_BIND
2630 #define ELF_R_TYPE ELF32_R_TYPE
2633 #define ELF_R_SYM ELF32_R_SYM
2639 * Functions to allocate entries in dynamic sections. Currently we simply
2640 * preallocate a large number, and we don't check if a entry for the given
2641 * target already exists (a linear search is too slow). Ideally these
2642 * entries would be associated with symbols.
2645 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2646 #define GOT_SIZE 0x20000
2647 #define FUNCTION_TABLE_SIZE 0x10000
2648 #define PLT_SIZE 0x08000
2651 static Elf_Addr got[GOT_SIZE];
2652 static unsigned int gotIndex;
2653 static Elf_Addr gp_val = (Elf_Addr)got;
2656 allocateGOTEntry(Elf_Addr target)
2660 if (gotIndex >= GOT_SIZE)
2661 barf("Global offset table overflow");
2663 entry = &got[gotIndex++];
2665 return (Elf_Addr)entry;
2669 #ifdef ELF_FUNCTION_DESC
2675 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2676 static unsigned int functionTableIndex;
2679 allocateFunctionDesc(Elf_Addr target)
2681 FunctionDesc *entry;
2683 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2684 barf("Function table overflow");
2686 entry = &functionTable[functionTableIndex++];
2688 entry->gp = (Elf_Addr)gp_val;
2689 return (Elf_Addr)entry;
2693 copyFunctionDesc(Elf_Addr target)
2695 FunctionDesc *olddesc = (FunctionDesc *)target;
2696 FunctionDesc *newdesc;
2698 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2699 newdesc->gp = olddesc->gp;
2700 return (Elf_Addr)newdesc;
2705 #ifdef ia64_HOST_ARCH
2706 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2707 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2709 static unsigned char plt_code[] =
2711 /* taken from binutils bfd/elfxx-ia64.c */
2712 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2713 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2714 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2715 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2716 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2717 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2720 /* If we can't get to the function descriptor via gp, take a local copy of it */
2721 #define PLT_RELOC(code, target) { \
2722 Elf64_Sxword rel_value = target - gp_val; \
2723 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2724 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2726 ia64_reloc_gprel22((Elf_Addr)code, target); \
2731 unsigned char code[sizeof(plt_code)];
2735 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2737 PLTEntry *plt = (PLTEntry *)oc->plt;
2740 if (oc->pltIndex >= PLT_SIZE)
2741 barf("Procedure table overflow");
2743 entry = &plt[oc->pltIndex++];
2744 memcpy(entry->code, plt_code, sizeof(entry->code));
2745 PLT_RELOC(entry->code, target);
2746 return (Elf_Addr)entry;
2752 return (PLT_SIZE * sizeof(PLTEntry));
2758 * Generic ELF functions
2762 findElfSection ( void* objImage, Elf_Word sh_type )
2764 char* ehdrC = (char*)objImage;
2765 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2766 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2767 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2771 for (i = 0; i < ehdr->e_shnum; i++) {
2772 if (shdr[i].sh_type == sh_type
2773 /* Ignore the section header's string table. */
2774 && i != ehdr->e_shstrndx
2775 /* Ignore string tables named .stabstr, as they contain
2777 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2779 ptr = ehdrC + shdr[i].sh_offset;
2786 #if defined(ia64_HOST_ARCH)
2788 findElfSegment ( void* objImage, Elf_Addr vaddr )
2790 char* ehdrC = (char*)objImage;
2791 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2792 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2793 Elf_Addr segaddr = 0;
2796 for (i = 0; i < ehdr->e_phnum; i++) {
2797 segaddr = phdr[i].p_vaddr;
2798 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2806 ocVerifyImage_ELF ( ObjectCode* oc )
2810 int i, j, nent, nstrtab, nsymtabs;
2814 char* ehdrC = (char*)(oc->image);
2815 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2817 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2818 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2819 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2820 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2821 errorBelch("%s: not an ELF object", oc->fileName);
2825 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2826 errorBelch("%s: unsupported ELF format", oc->fileName);
2830 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2831 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2833 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2834 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2836 errorBelch("%s: unknown endiannness", oc->fileName);
2840 if (ehdr->e_type != ET_REL) {
2841 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2844 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2846 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2847 switch (ehdr->e_machine) {
2848 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2849 #ifdef EM_SPARC32PLUS
2850 case EM_SPARC32PLUS:
2852 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2854 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2856 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2858 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2859 #elif defined(EM_AMD64)
2860 case EM_AMD64: IF_DEBUG(linker,debugBelch( "amd64" )); break;
2862 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2863 errorBelch("%s: unknown architecture (e_machine == %d)"
2864 , oc->fileName, ehdr->e_machine);
2868 IF_DEBUG(linker,debugBelch(
2869 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2870 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2872 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2874 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2876 if (ehdr->e_shstrndx == SHN_UNDEF) {
2877 errorBelch("%s: no section header string table", oc->fileName);
2880 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2882 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2885 for (i = 0; i < ehdr->e_shnum; i++) {
2886 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2887 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2888 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2889 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2890 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2891 ehdrC + shdr[i].sh_offset,
2892 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2894 if (shdr[i].sh_type == SHT_REL) {
2895 IF_DEBUG(linker,debugBelch("Rel " ));
2896 } else if (shdr[i].sh_type == SHT_RELA) {
2897 IF_DEBUG(linker,debugBelch("RelA " ));
2899 IF_DEBUG(linker,debugBelch(" "));
2902 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2906 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2909 for (i = 0; i < ehdr->e_shnum; i++) {
2910 if (shdr[i].sh_type == SHT_STRTAB
2911 /* Ignore the section header's string table. */
2912 && i != ehdr->e_shstrndx
2913 /* Ignore string tables named .stabstr, as they contain
2915 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2917 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2918 strtab = ehdrC + shdr[i].sh_offset;
2923 errorBelch("%s: no string tables, or too many", oc->fileName);
2928 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2929 for (i = 0; i < ehdr->e_shnum; i++) {
2930 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2931 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2933 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2934 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2935 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2937 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2939 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2940 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2943 for (j = 0; j < nent; j++) {
2944 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2945 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2946 (int)stab[j].st_shndx,
2947 (int)stab[j].st_size,
2948 (char*)stab[j].st_value ));
2950 IF_DEBUG(linker,debugBelch("type=" ));
2951 switch (ELF_ST_TYPE(stab[j].st_info)) {
2952 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2953 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2954 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2955 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
2956 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
2957 default: IF_DEBUG(linker,debugBelch("? " )); break;
2959 IF_DEBUG(linker,debugBelch(" " ));
2961 IF_DEBUG(linker,debugBelch("bind=" ));
2962 switch (ELF_ST_BIND(stab[j].st_info)) {
2963 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
2964 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
2965 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
2966 default: IF_DEBUG(linker,debugBelch("? " )); break;
2968 IF_DEBUG(linker,debugBelch(" " ));
2970 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
2974 if (nsymtabs == 0) {
2975 errorBelch("%s: didn't find any symbol tables", oc->fileName);
2982 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
2986 if (hdr->sh_type == SHT_PROGBITS
2987 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
2988 /* .text-style section */
2989 return SECTIONKIND_CODE_OR_RODATA;
2992 if (hdr->sh_type == SHT_PROGBITS
2993 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
2994 /* .data-style section */
2995 return SECTIONKIND_RWDATA;
2998 if (hdr->sh_type == SHT_PROGBITS
2999 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3000 /* .rodata-style section */
3001 return SECTIONKIND_CODE_OR_RODATA;
3004 if (hdr->sh_type == SHT_NOBITS
3005 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3006 /* .bss-style section */
3008 return SECTIONKIND_RWDATA;
3011 return SECTIONKIND_OTHER;
3016 ocGetNames_ELF ( ObjectCode* oc )
3021 char* ehdrC = (char*)(oc->image);
3022 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3023 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3024 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3026 ASSERT(symhash != NULL);
3029 errorBelch("%s: no strtab", oc->fileName);
3034 for (i = 0; i < ehdr->e_shnum; i++) {
3035 /* Figure out what kind of section it is. Logic derived from
3036 Figure 1.14 ("Special Sections") of the ELF document
3037 ("Portable Formats Specification, Version 1.1"). */
3039 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3041 if (is_bss && shdr[i].sh_size > 0) {
3042 /* This is a non-empty .bss section. Allocate zeroed space for
3043 it, and set its .sh_offset field such that
3044 ehdrC + .sh_offset == addr_of_zeroed_space. */
3045 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3046 "ocGetNames_ELF(BSS)");
3047 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3049 debugBelch("BSS section at 0x%x, size %d\n",
3050 zspace, shdr[i].sh_size);
3054 /* fill in the section info */
3055 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3056 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3057 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3058 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3061 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3063 /* copy stuff into this module's object symbol table */
3064 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3065 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3067 oc->n_symbols = nent;
3068 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3069 "ocGetNames_ELF(oc->symbols)");
3071 for (j = 0; j < nent; j++) {
3073 char isLocal = FALSE; /* avoids uninit-var warning */
3075 char* nm = strtab + stab[j].st_name;
3076 int secno = stab[j].st_shndx;
3078 /* Figure out if we want to add it; if so, set ad to its
3079 address. Otherwise leave ad == NULL. */
3081 if (secno == SHN_COMMON) {
3083 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3085 debugBelch("COMMON symbol, size %d name %s\n",
3086 stab[j].st_size, nm);
3088 /* Pointless to do addProddableBlock() for this area,
3089 since the linker should never poke around in it. */
3092 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3093 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3095 /* and not an undefined symbol */
3096 && stab[j].st_shndx != SHN_UNDEF
3097 /* and not in a "special section" */
3098 && stab[j].st_shndx < SHN_LORESERVE
3100 /* and it's a not a section or string table or anything silly */
3101 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3102 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3103 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3106 /* Section 0 is the undefined section, hence > and not >=. */
3107 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3109 if (shdr[secno].sh_type == SHT_NOBITS) {
3110 debugBelch(" BSS symbol, size %d off %d name %s\n",
3111 stab[j].st_size, stab[j].st_value, nm);
3114 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3115 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3118 #ifdef ELF_FUNCTION_DESC
3119 /* dlsym() and the initialisation table both give us function
3120 * descriptors, so to be consistent we store function descriptors
3121 * in the symbol table */
3122 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3123 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3125 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3126 ad, oc->fileName, nm ));
3131 /* And the decision is ... */
3135 oc->symbols[j] = nm;
3138 /* Ignore entirely. */
3140 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3144 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3145 strtab + stab[j].st_name ));
3148 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3149 (int)ELF_ST_BIND(stab[j].st_info),
3150 (int)ELF_ST_TYPE(stab[j].st_info),
3151 (int)stab[j].st_shndx,
3152 strtab + stab[j].st_name
3155 oc->symbols[j] = NULL;
3164 /* Do ELF relocations which lack an explicit addend. All x86-linux
3165 relocations appear to be of this form. */
3167 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3168 Elf_Shdr* shdr, int shnum,
3169 Elf_Sym* stab, char* strtab )
3174 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3175 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3176 int target_shndx = shdr[shnum].sh_info;
3177 int symtab_shndx = shdr[shnum].sh_link;
3179 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3180 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3181 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3182 target_shndx, symtab_shndx ));
3184 /* Skip sections that we're not interested in. */
3187 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3188 if (kind == SECTIONKIND_OTHER) {
3189 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3194 for (j = 0; j < nent; j++) {
3195 Elf_Addr offset = rtab[j].r_offset;
3196 Elf_Addr info = rtab[j].r_info;
3198 Elf_Addr P = ((Elf_Addr)targ) + offset;
3199 Elf_Word* pP = (Elf_Word*)P;
3204 StgStablePtr stablePtr;
3207 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3208 j, (void*)offset, (void*)info ));
3210 IF_DEBUG(linker,debugBelch( " ZERO" ));
3213 Elf_Sym sym = stab[ELF_R_SYM(info)];
3214 /* First see if it is a local symbol. */
3215 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3216 /* Yes, so we can get the address directly from the ELF symbol
3218 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3220 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3221 + stab[ELF_R_SYM(info)].st_value);
3224 symbol = strtab + sym.st_name;
3225 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3226 if (NULL == stablePtr) {
3227 /* No, so look up the name in our global table. */
3228 S_tmp = lookupSymbol( symbol );
3229 S = (Elf_Addr)S_tmp;
3231 stableVal = deRefStablePtr( stablePtr );
3233 S = (Elf_Addr)S_tmp;
3237 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3240 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3243 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3244 (void*)P, (void*)S, (void*)A ));
3245 checkProddableBlock ( oc, pP );
3249 switch (ELF_R_TYPE(info)) {
3250 # ifdef i386_HOST_ARCH
3251 case R_386_32: *pP = value; break;
3252 case R_386_PC32: *pP = value - P; break;
3255 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3256 oc->fileName, (lnat)ELF_R_TYPE(info));
3264 /* Do ELF relocations for which explicit addends are supplied.
3265 sparc-solaris relocations appear to be of this form. */
3267 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3268 Elf_Shdr* shdr, int shnum,
3269 Elf_Sym* stab, char* strtab )
3272 char *symbol = NULL;
3274 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3275 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3276 int target_shndx = shdr[shnum].sh_info;
3277 int symtab_shndx = shdr[shnum].sh_link;
3279 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3280 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3281 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3282 target_shndx, symtab_shndx ));
3284 for (j = 0; j < nent; j++) {
3285 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3286 /* This #ifdef only serves to avoid unused-var warnings. */
3287 Elf_Addr offset = rtab[j].r_offset;
3288 Elf_Addr P = targ + offset;
3290 Elf_Addr info = rtab[j].r_info;
3291 Elf_Addr A = rtab[j].r_addend;
3295 # if defined(sparc_HOST_ARCH)
3296 Elf_Word* pP = (Elf_Word*)P;
3298 # elif defined(ia64_HOST_ARCH)
3299 Elf64_Xword *pP = (Elf64_Xword *)P;
3301 # elif defined(powerpc_HOST_ARCH)
3305 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3306 j, (void*)offset, (void*)info,
3309 IF_DEBUG(linker,debugBelch( " ZERO" ));
3312 Elf_Sym sym = stab[ELF_R_SYM(info)];
3313 /* First see if it is a local symbol. */
3314 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3315 /* Yes, so we can get the address directly from the ELF symbol
3317 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3319 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3320 + stab[ELF_R_SYM(info)].st_value);
3321 #ifdef ELF_FUNCTION_DESC
3322 /* Make a function descriptor for this function */
3323 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3324 S = allocateFunctionDesc(S + A);
3329 /* No, so look up the name in our global table. */
3330 symbol = strtab + sym.st_name;
3331 S_tmp = lookupSymbol( symbol );
3332 S = (Elf_Addr)S_tmp;
3334 #ifdef ELF_FUNCTION_DESC
3335 /* If a function, already a function descriptor - we would
3336 have to copy it to add an offset. */
3337 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3338 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3342 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3345 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3348 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3349 (void*)P, (void*)S, (void*)A ));
3350 /* checkProddableBlock ( oc, (void*)P ); */
3354 switch (ELF_R_TYPE(info)) {
3355 # if defined(sparc_HOST_ARCH)
3356 case R_SPARC_WDISP30:
3357 w1 = *pP & 0xC0000000;
3358 w2 = (Elf_Word)((value - P) >> 2);
3359 ASSERT((w2 & 0xC0000000) == 0);
3364 w1 = *pP & 0xFFC00000;
3365 w2 = (Elf_Word)(value >> 10);
3366 ASSERT((w2 & 0xFFC00000) == 0);
3372 w2 = (Elf_Word)(value & 0x3FF);
3373 ASSERT((w2 & ~0x3FF) == 0);
3377 /* According to the Sun documentation:
3379 This relocation type resembles R_SPARC_32, except it refers to an
3380 unaligned word. That is, the word to be relocated must be treated
3381 as four separate bytes with arbitrary alignment, not as a word
3382 aligned according to the architecture requirements.
3384 (JRS: which means that freeloading on the R_SPARC_32 case
3385 is probably wrong, but hey ...)
3389 w2 = (Elf_Word)value;
3392 # elif defined(ia64_HOST_ARCH)
3393 case R_IA64_DIR64LSB:
3394 case R_IA64_FPTR64LSB:
3397 case R_IA64_PCREL64LSB:
3400 case R_IA64_SEGREL64LSB:
3401 addr = findElfSegment(ehdrC, value);
3404 case R_IA64_GPREL22:
3405 ia64_reloc_gprel22(P, value);
3407 case R_IA64_LTOFF22:
3408 case R_IA64_LTOFF22X:
3409 case R_IA64_LTOFF_FPTR22:
3410 addr = allocateGOTEntry(value);
3411 ia64_reloc_gprel22(P, addr);
3413 case R_IA64_PCREL21B:
3414 ia64_reloc_pcrel21(P, S, oc);
3417 /* This goes with R_IA64_LTOFF22X and points to the load to
3418 * convert into a move. We don't implement relaxation. */
3420 # elif defined(powerpc_HOST_ARCH)
3421 case R_PPC_ADDR16_LO:
3422 *(Elf32_Half*) P = value;
3425 case R_PPC_ADDR16_HI:
3426 *(Elf32_Half*) P = value >> 16;
3429 case R_PPC_ADDR16_HA:
3430 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3434 *(Elf32_Word *) P = value;
3438 *(Elf32_Word *) P = value - P;
3444 if( delta << 6 >> 6 != delta )
3446 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3450 if( value == 0 || delta << 6 >> 6 != delta )
3452 barf( "Unable to make SymbolExtra for #%d",
3458 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3459 | (delta & 0x3fffffc);
3463 #if x86_64_HOST_ARCH
3465 *(Elf64_Xword *)P = value;
3470 StgInt64 off = value - P;
3471 if (off >= 0x7fffffffL || off < -0x80000000L) {
3472 #if X86_64_ELF_NONPIC_HACK
3473 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3475 off = pltAddress + A - P;
3477 barf("R_X86_64_PC32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3478 symbol, off, oc->fileName );
3481 *(Elf64_Word *)P = (Elf64_Word)off;
3487 StgInt64 off = value - P;
3488 *(Elf64_Word *)P = (Elf64_Word)off;
3493 if (value >= 0x7fffffffL) {
3494 #if X86_64_ELF_NONPIC_HACK
3495 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3497 value = pltAddress + A;
3499 barf("R_X86_64_32 relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3500 symbol, value, oc->fileName );
3503 *(Elf64_Word *)P = (Elf64_Word)value;
3507 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3508 #if X86_64_ELF_NONPIC_HACK
3509 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3511 value = pltAddress + A;
3513 barf("R_X86_64_32S relocation out of range: %s = %p\nRecompile %s with -fPIC.",
3514 symbol, value, oc->fileName );
3517 *(Elf64_Sword *)P = (Elf64_Sword)value;
3520 case R_X86_64_GOTPCREL:
3522 StgInt64 gotAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)->addr;
3523 StgInt64 off = gotAddress + A - P;
3524 *(Elf64_Word *)P = (Elf64_Word)off;
3528 case R_X86_64_PLT32:
3530 StgInt64 off = value - P;
3531 if (off >= 0x7fffffffL || off < -0x80000000L) {
3532 StgInt64 pltAddress = (StgInt64) &makeSymbolExtra(oc, ELF_R_SYM(info), S)
3534 off = pltAddress + A - P;
3536 *(Elf64_Word *)P = (Elf64_Word)off;
3542 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3543 oc->fileName, (lnat)ELF_R_TYPE(info));
3552 ocResolve_ELF ( ObjectCode* oc )
3556 Elf_Sym* stab = NULL;
3557 char* ehdrC = (char*)(oc->image);
3558 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3559 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3561 /* first find "the" symbol table */
3562 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3564 /* also go find the string table */
3565 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3567 if (stab == NULL || strtab == NULL) {
3568 errorBelch("%s: can't find string or symbol table", oc->fileName);
3572 /* Process the relocation sections. */
3573 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3574 if (shdr[shnum].sh_type == SHT_REL) {
3575 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3576 shnum, stab, strtab );
3580 if (shdr[shnum].sh_type == SHT_RELA) {
3581 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3582 shnum, stab, strtab );
3587 /* Free the local symbol table; we won't need it again. */
3588 freeHashTable(oc->lochash, NULL);
3591 #if defined(powerpc_HOST_ARCH)
3592 ocFlushInstructionCache( oc );
3600 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3601 * at the front. The following utility functions pack and unpack instructions, and
3602 * take care of the most common relocations.
3605 #ifdef ia64_HOST_ARCH
3608 ia64_extract_instruction(Elf64_Xword *target)
3611 int slot = (Elf_Addr)target & 3;
3612 target = (Elf_Addr)target & ~3;
3620 return ((w1 >> 5) & 0x1ffffffffff);
3622 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3626 barf("ia64_extract_instruction: invalid slot %p", target);
3631 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3633 int slot = (Elf_Addr)target & 3;
3634 target = (Elf_Addr)target & ~3;
3639 *target |= value << 5;
3642 *target |= value << 46;
3643 *(target+1) |= value >> 18;
3646 *(target+1) |= value << 23;
3652 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3654 Elf64_Xword instruction;
3655 Elf64_Sxword rel_value;
3657 rel_value = value - gp_val;
3658 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3659 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3661 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3662 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3663 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3664 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3665 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3666 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3670 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3672 Elf64_Xword instruction;
3673 Elf64_Sxword rel_value;
3676 entry = allocatePLTEntry(value, oc);
3678 rel_value = (entry >> 4) - (target >> 4);
3679 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3680 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3682 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3683 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3684 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3685 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3691 * PowerPC & X86_64 ELF specifics
3694 #if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3696 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3702 ehdr = (Elf_Ehdr *) oc->image;
3703 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3705 for( i = 0; i < ehdr->e_shnum; i++ )
3706 if( shdr[i].sh_type == SHT_SYMTAB )
3709 if( i == ehdr->e_shnum )
3711 errorBelch( "This ELF file contains no symtab" );
3715 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3717 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3718 (int) shdr[i].sh_entsize, (int) sizeof( Elf_Sym ) );
3723 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3726 #endif /* powerpc */
3730 /* --------------------------------------------------------------------------
3732 * ------------------------------------------------------------------------*/
3734 #if defined(OBJFORMAT_MACHO)
3737 Support for MachO linking on Darwin/MacOS X
3738 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3740 I hereby formally apologize for the hackish nature of this code.
3741 Things that need to be done:
3742 *) implement ocVerifyImage_MachO
3743 *) add still more sanity checks.
3746 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3747 #define mach_header mach_header_64
3748 #define segment_command segment_command_64
3749 #define section section_64
3750 #define nlist nlist_64
3753 #ifdef powerpc_HOST_ARCH
3754 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3756 struct mach_header *header = (struct mach_header *) oc->image;
3757 struct load_command *lc = (struct load_command *) (header + 1);
3760 for( i = 0; i < header->ncmds; i++ )
3762 if( lc->cmd == LC_SYMTAB )
3764 // Find out the first and last undefined external
3765 // symbol, so we don't have to allocate too many
3767 struct symtab_command *symLC = (struct symtab_command *) lc;
3768 unsigned min = symLC->nsyms, max = 0;
3769 struct nlist *nlist =
3770 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3772 for(i=0;i<symLC->nsyms;i++)
3774 if(nlist[i].n_type & N_STAB)
3776 else if(nlist[i].n_type & N_EXT)
3778 if((nlist[i].n_type & N_TYPE) == N_UNDF
3779 && (nlist[i].n_value == 0))
3789 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3794 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3796 return ocAllocateSymbolExtras(oc,0,0);
3799 #ifdef x86_64_HOST_ARCH
3800 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3802 struct mach_header *header = (struct mach_header *) oc->image;
3803 struct load_command *lc = (struct load_command *) (header + 1);
3806 for( i = 0; i < header->ncmds; i++ )
3808 if( lc->cmd == LC_SYMTAB )
3810 // Just allocate one entry for every symbol
3811 struct symtab_command *symLC = (struct symtab_command *) lc;
3813 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3816 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3818 return ocAllocateSymbolExtras(oc,0,0);
3822 static int ocVerifyImage_MachO(ObjectCode* oc)
3824 char *image = (char*) oc->image;
3825 struct mach_header *header = (struct mach_header*) image;
3827 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3828 if(header->magic != MH_MAGIC_64)
3831 if(header->magic != MH_MAGIC)
3834 // FIXME: do some more verifying here
3838 static int resolveImports(
3841 struct symtab_command *symLC,
3842 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3843 unsigned long *indirectSyms,
3844 struct nlist *nlist)
3847 size_t itemSize = 4;
3850 int isJumpTable = 0;
3851 if(!strcmp(sect->sectname,"__jump_table"))
3855 ASSERT(sect->reserved2 == itemSize);
3859 for(i=0; i*itemSize < sect->size;i++)
3861 // according to otool, reserved1 contains the first index into the indirect symbol table
3862 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3863 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3866 if((symbol->n_type & N_TYPE) == N_UNDF
3867 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3868 addr = (void*) (symbol->n_value);
3869 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3872 addr = lookupSymbol(nm);
3875 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3883 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3884 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3885 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3886 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3891 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3892 ((void**)(image + sect->offset))[i] = addr;
3899 static unsigned long relocateAddress(
3902 struct section* sections,
3903 unsigned long address)
3906 for(i = 0; i < nSections; i++)
3908 if(sections[i].addr <= address
3909 && address < sections[i].addr + sections[i].size)
3911 return (unsigned long)oc->image
3912 + sections[i].offset + address - sections[i].addr;
3915 barf("Invalid Mach-O file:"
3916 "Address out of bounds while relocating object file");
3920 static int relocateSection(
3923 struct symtab_command *symLC, struct nlist *nlist,
3924 int nSections, struct section* sections, struct section *sect)
3926 struct relocation_info *relocs;
3929 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3931 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3933 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3935 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3939 relocs = (struct relocation_info*) (image + sect->reloff);
3943 #ifdef x86_64_HOST_ARCH
3944 struct relocation_info *reloc = &relocs[i];
3946 char *thingPtr = image + sect->offset + reloc->r_address;
3950 int type = reloc->r_type;
3952 checkProddableBlock(oc,thingPtr);
3953 switch(reloc->r_length)
3956 thing = *(uint8_t*)thingPtr;
3957 baseValue = (uint64_t)thingPtr + 1;
3960 thing = *(uint16_t*)thingPtr;
3961 baseValue = (uint64_t)thingPtr + 2;
3964 thing = *(uint32_t*)thingPtr;
3965 baseValue = (uint64_t)thingPtr + 4;
3968 thing = *(uint64_t*)thingPtr;
3969 baseValue = (uint64_t)thingPtr + 8;
3972 barf("Unknown size.");
3975 if(type == X86_64_RELOC_GOT
3976 || type == X86_64_RELOC_GOT_LOAD)
3978 ASSERT(reloc->r_extern);
3979 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
3981 type = X86_64_RELOC_SIGNED;
3983 else if(reloc->r_extern)
3985 struct nlist *symbol = &nlist[reloc->r_symbolnum];
3986 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3987 if(symbol->n_value == 0)
3988 value = (uint64_t) lookupSymbol(nm);
3990 value = relocateAddress(oc, nSections, sections,
3995 value = sections[reloc->r_symbolnum-1].offset
3996 - sections[reloc->r_symbolnum-1].addr
4000 if(type == X86_64_RELOC_BRANCH)
4002 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4004 ASSERT(reloc->r_extern);
4005 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4008 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4009 type = X86_64_RELOC_SIGNED;
4014 case X86_64_RELOC_UNSIGNED:
4015 ASSERT(!reloc->r_pcrel);
4018 case X86_64_RELOC_SIGNED:
4019 ASSERT(reloc->r_pcrel);
4020 thing += value - baseValue;
4022 case X86_64_RELOC_SUBTRACTOR:
4023 ASSERT(!reloc->r_pcrel);
4027 barf("unkown relocation");
4030 switch(reloc->r_length)
4033 *(uint8_t*)thingPtr = thing;
4036 *(uint16_t*)thingPtr = thing;
4039 *(uint32_t*)thingPtr = thing;
4042 *(uint64_t*)thingPtr = thing;
4046 if(relocs[i].r_address & R_SCATTERED)
4048 struct scattered_relocation_info *scat =
4049 (struct scattered_relocation_info*) &relocs[i];
4053 if(scat->r_length == 2)
4055 unsigned long word = 0;
4056 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4057 checkProddableBlock(oc,wordPtr);
4059 // Note on relocation types:
4060 // i386 uses the GENERIC_RELOC_* types,
4061 // while ppc uses special PPC_RELOC_* types.
4062 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4063 // in both cases, all others are different.
4064 // Therefore, we use GENERIC_RELOC_VANILLA
4065 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4066 // and use #ifdefs for the other types.
4068 // Step 1: Figure out what the relocated value should be
4069 if(scat->r_type == GENERIC_RELOC_VANILLA)
4071 word = *wordPtr + (unsigned long) relocateAddress(
4078 #ifdef powerpc_HOST_ARCH
4079 else if(scat->r_type == PPC_RELOC_SECTDIFF
4080 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4081 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4082 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4084 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4087 struct scattered_relocation_info *pair =
4088 (struct scattered_relocation_info*) &relocs[i+1];
4090 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4091 barf("Invalid Mach-O file: "
4092 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4094 word = (unsigned long)
4095 (relocateAddress(oc, nSections, sections, scat->r_value)
4096 - relocateAddress(oc, nSections, sections, pair->r_value));
4099 #ifdef powerpc_HOST_ARCH
4100 else if(scat->r_type == PPC_RELOC_HI16
4101 || scat->r_type == PPC_RELOC_LO16
4102 || scat->r_type == PPC_RELOC_HA16
4103 || scat->r_type == PPC_RELOC_LO14)
4104 { // these are generated by label+offset things
4105 struct relocation_info *pair = &relocs[i+1];
4106 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4107 barf("Invalid Mach-O file: "
4108 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4110 if(scat->r_type == PPC_RELOC_LO16)
4112 word = ((unsigned short*) wordPtr)[1];
4113 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4115 else if(scat->r_type == PPC_RELOC_LO14)
4117 barf("Unsupported Relocation: PPC_RELOC_LO14");
4118 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4119 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4121 else if(scat->r_type == PPC_RELOC_HI16)
4123 word = ((unsigned short*) wordPtr)[1] << 16;
4124 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4126 else if(scat->r_type == PPC_RELOC_HA16)
4128 word = ((unsigned short*) wordPtr)[1] << 16;
4129 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4133 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4140 continue; // ignore the others
4142 #ifdef powerpc_HOST_ARCH
4143 if(scat->r_type == GENERIC_RELOC_VANILLA
4144 || scat->r_type == PPC_RELOC_SECTDIFF)
4146 if(scat->r_type == GENERIC_RELOC_VANILLA
4147 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4152 #ifdef powerpc_HOST_ARCH
4153 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4155 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4157 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4159 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4161 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4163 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4164 + ((word & (1<<15)) ? 1 : 0);
4170 continue; // FIXME: I hope it's OK to ignore all the others.
4174 struct relocation_info *reloc = &relocs[i];
4175 if(reloc->r_pcrel && !reloc->r_extern)
4178 if(reloc->r_length == 2)
4180 unsigned long word = 0;
4181 #ifdef powerpc_HOST_ARCH
4182 unsigned long jumpIsland = 0;
4183 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4184 // to avoid warning and to catch
4188 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4189 checkProddableBlock(oc,wordPtr);
4191 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4195 #ifdef powerpc_HOST_ARCH
4196 else if(reloc->r_type == PPC_RELOC_LO16)
4198 word = ((unsigned short*) wordPtr)[1];
4199 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4201 else if(reloc->r_type == PPC_RELOC_HI16)
4203 word = ((unsigned short*) wordPtr)[1] << 16;
4204 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4206 else if(reloc->r_type == PPC_RELOC_HA16)
4208 word = ((unsigned short*) wordPtr)[1] << 16;
4209 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4211 else if(reloc->r_type == PPC_RELOC_BR24)
4214 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4218 if(!reloc->r_extern)
4221 sections[reloc->r_symbolnum-1].offset
4222 - sections[reloc->r_symbolnum-1].addr
4229 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4230 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4231 void *symbolAddress = lookupSymbol(nm);
4234 errorBelch("\nunknown symbol `%s'", nm);
4240 #ifdef powerpc_HOST_ARCH
4241 // In the .o file, this should be a relative jump to NULL
4242 // and we'll change it to a relative jump to the symbol
4243 ASSERT(word + reloc->r_address == 0);
4244 jumpIsland = (unsigned long)
4245 &makeSymbolExtra(oc,
4247 (unsigned long) symbolAddress)
4251 offsetToJumpIsland = word + jumpIsland
4252 - (((long)image) + sect->offset - sect->addr);
4255 word += (unsigned long) symbolAddress
4256 - (((long)image) + sect->offset - sect->addr);
4260 word += (unsigned long) symbolAddress;
4264 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4269 #ifdef powerpc_HOST_ARCH
4270 else if(reloc->r_type == PPC_RELOC_LO16)
4272 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4275 else if(reloc->r_type == PPC_RELOC_HI16)
4277 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4280 else if(reloc->r_type == PPC_RELOC_HA16)
4282 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4283 + ((word & (1<<15)) ? 1 : 0);
4286 else if(reloc->r_type == PPC_RELOC_BR24)
4288 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4290 // The branch offset is too large.
4291 // Therefore, we try to use a jump island.
4294 barf("unconditional relative branch out of range: "
4295 "no jump island available");
4298 word = offsetToJumpIsland;
4299 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4300 barf("unconditional relative branch out of range: "
4301 "jump island out of range");
4303 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4308 barf("\nunknown relocation %d",reloc->r_type);
4316 static int ocGetNames_MachO(ObjectCode* oc)
4318 char *image = (char*) oc->image;
4319 struct mach_header *header = (struct mach_header*) image;
4320 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4321 unsigned i,curSymbol = 0;
4322 struct segment_command *segLC = NULL;
4323 struct section *sections;
4324 struct symtab_command *symLC = NULL;
4325 struct nlist *nlist;
4326 unsigned long commonSize = 0;
4327 char *commonStorage = NULL;
4328 unsigned long commonCounter;
4330 for(i=0;i<header->ncmds;i++)
4332 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4333 segLC = (struct segment_command*) lc;
4334 else if(lc->cmd == LC_SYMTAB)
4335 symLC = (struct symtab_command*) lc;
4336 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4339 sections = (struct section*) (segLC+1);
4340 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4344 barf("ocGetNames_MachO: no segment load command");
4346 for(i=0;i<segLC->nsects;i++)
4348 if(sections[i].size == 0)
4351 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4353 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4354 "ocGetNames_MachO(common symbols)");
4355 sections[i].offset = zeroFillArea - image;
4358 if(!strcmp(sections[i].sectname,"__text"))
4359 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4360 (void*) (image + sections[i].offset),
4361 (void*) (image + sections[i].offset + sections[i].size));
4362 else if(!strcmp(sections[i].sectname,"__const"))
4363 addSection(oc, SECTIONKIND_RWDATA,
4364 (void*) (image + sections[i].offset),
4365 (void*) (image + sections[i].offset + sections[i].size));
4366 else if(!strcmp(sections[i].sectname,"__data"))
4367 addSection(oc, SECTIONKIND_RWDATA,
4368 (void*) (image + sections[i].offset),
4369 (void*) (image + sections[i].offset + sections[i].size));
4370 else if(!strcmp(sections[i].sectname,"__bss")
4371 || !strcmp(sections[i].sectname,"__common"))
4372 addSection(oc, SECTIONKIND_RWDATA,
4373 (void*) (image + sections[i].offset),
4374 (void*) (image + sections[i].offset + sections[i].size));
4376 addProddableBlock(oc, (void*) (image + sections[i].offset),
4380 // count external symbols defined here
4384 for(i=0;i<symLC->nsyms;i++)
4386 if(nlist[i].n_type & N_STAB)
4388 else if(nlist[i].n_type & N_EXT)
4390 if((nlist[i].n_type & N_TYPE) == N_UNDF
4391 && (nlist[i].n_value != 0))
4393 commonSize += nlist[i].n_value;
4396 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4401 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4402 "ocGetNames_MachO(oc->symbols)");
4406 for(i=0;i<symLC->nsyms;i++)
4408 if(nlist[i].n_type & N_STAB)
4410 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4412 if(nlist[i].n_type & N_EXT)
4414 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4415 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4416 ; // weak definition, and we already have a definition
4419 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4421 + sections[nlist[i].n_sect-1].offset
4422 - sections[nlist[i].n_sect-1].addr
4423 + nlist[i].n_value);
4424 oc->symbols[curSymbol++] = nm;
4431 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4432 commonCounter = (unsigned long)commonStorage;
4435 for(i=0;i<symLC->nsyms;i++)
4437 if((nlist[i].n_type & N_TYPE) == N_UNDF
4438 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4440 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4441 unsigned long sz = nlist[i].n_value;
4443 nlist[i].n_value = commonCounter;
4445 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4446 (void*)commonCounter);
4447 oc->symbols[curSymbol++] = nm;
4449 commonCounter += sz;
4456 static int ocResolve_MachO(ObjectCode* oc)
4458 char *image = (char*) oc->image;
4459 struct mach_header *header = (struct mach_header*) image;
4460 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4462 struct segment_command *segLC = NULL;
4463 struct section *sections;
4464 struct symtab_command *symLC = NULL;
4465 struct dysymtab_command *dsymLC = NULL;
4466 struct nlist *nlist;
4468 for(i=0;i<header->ncmds;i++)
4470 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4471 segLC = (struct segment_command*) lc;
4472 else if(lc->cmd == LC_SYMTAB)
4473 symLC = (struct symtab_command*) lc;
4474 else if(lc->cmd == LC_DYSYMTAB)
4475 dsymLC = (struct dysymtab_command*) lc;
4476 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4479 sections = (struct section*) (segLC+1);
4480 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4485 unsigned long *indirectSyms
4486 = (unsigned long*) (image + dsymLC->indirectsymoff);
4488 for(i=0;i<segLC->nsects;i++)
4490 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4491 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4492 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4494 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4497 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4498 || !strcmp(sections[i].sectname,"__pointers"))
4500 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4503 else if(!strcmp(sections[i].sectname,"__jump_table"))
4505 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4511 for(i=0;i<segLC->nsects;i++)
4513 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4517 /* Free the local symbol table; we won't need it again. */
4518 freeHashTable(oc->lochash, NULL);
4521 #if defined (powerpc_HOST_ARCH)
4522 ocFlushInstructionCache( oc );
4528 #ifdef powerpc_HOST_ARCH
4530 * The Mach-O object format uses leading underscores. But not everywhere.
4531 * There is a small number of runtime support functions defined in
4532 * libcc_dynamic.a whose name does not have a leading underscore.
4533 * As a consequence, we can't get their address from C code.
4534 * We have to use inline assembler just to take the address of a function.
4538 static void machoInitSymbolsWithoutUnderscore()
4540 extern void* symbolsWithoutUnderscore[];
4541 void **p = symbolsWithoutUnderscore;
4542 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4546 __asm__ volatile(".long " # x);
4548 RTS_MACHO_NOUNDERLINE_SYMBOLS
4550 __asm__ volatile(".text");
4554 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4556 RTS_MACHO_NOUNDERLINE_SYMBOLS
4563 * Figure out by how much to shift the entire Mach-O file in memory
4564 * when loading so that its single segment ends up 16-byte-aligned
4566 static int machoGetMisalignment( FILE * f )
4568 struct mach_header header;
4571 fread(&header, sizeof(header), 1, f);
4574 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4575 if(header.magic != MH_MAGIC_64)
4578 if(header.magic != MH_MAGIC)
4582 misalignment = (header.sizeofcmds + sizeof(header))
4585 return misalignment ? (16 - misalignment) : 0;