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)
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 #if defined(x86_64_HOST_ARCH) && defined(OBJFORMAT_ELF)
132 static void*x86_64_high_symbol( char *lbl, void *addr );
135 /* -----------------------------------------------------------------------------
136 * Built-in symbols from the RTS
139 typedef struct _RtsSymbolVal {
146 #define Maybe_Stable_Names SymX(mkWeakzh_fast) \
147 SymX(makeStableNamezh_fast) \
148 SymX(finalizzeWeakzh_fast)
150 /* These are not available in GUM!!! -- HWL */
151 #define Maybe_Stable_Names
154 #if !defined (mingw32_HOST_OS)
155 #define RTS_POSIX_ONLY_SYMBOLS \
156 SymX(signal_handlers) \
157 SymX(stg_sig_install) \
161 #if defined (cygwin32_HOST_OS)
162 #define RTS_MINGW_ONLY_SYMBOLS /**/
163 /* Don't have the ability to read import libs / archives, so
164 * we have to stupidly list a lot of what libcygwin.a
167 #define RTS_CYGWIN_ONLY_SYMBOLS \
245 #elif !defined(mingw32_HOST_OS)
246 #define RTS_MINGW_ONLY_SYMBOLS /**/
247 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
248 #else /* defined(mingw32_HOST_OS) */
249 #define RTS_POSIX_ONLY_SYMBOLS /**/
250 #define RTS_CYGWIN_ONLY_SYMBOLS /**/
252 /* Extra syms gen'ed by mingw-2's gcc-3.2: */
254 #define RTS_MINGW_EXTRA_SYMS \
255 Sym(_imp____mb_cur_max) \
258 #define RTS_MINGW_EXTRA_SYMS
261 #if HAVE_GETTIMEOFDAY
262 #define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
264 #define RTS_MINGW_GETTIMEOFDAY_SYM /**/
267 /* These are statically linked from the mingw libraries into the ghc
268 executable, so we have to employ this hack. */
269 #define RTS_MINGW_ONLY_SYMBOLS \
270 SymX(asyncReadzh_fast) \
271 SymX(asyncWritezh_fast) \
272 SymX(asyncDoProczh_fast) \
284 SymX(getservbyname) \
285 SymX(getservbyport) \
286 SymX(getprotobynumber) \
287 SymX(getprotobyname) \
288 SymX(gethostbyname) \
289 SymX(gethostbyaddr) \
336 SymX(rts_InstallConsoleEvent) \
337 SymX(rts_ConsoleHandlerDone) \
339 Sym(_imp___timezone) \
349 RTS_MINGW_EXTRA_SYMS \
350 RTS_MINGW_GETTIMEOFDAY_SYM \
354 #if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
355 #define RTS_DARWIN_ONLY_SYMBOLS \
356 Sym(asprintf$LDBLStub) \
360 Sym(fprintf$LDBLStub) \
361 Sym(fscanf$LDBLStub) \
362 Sym(fwprintf$LDBLStub) \
363 Sym(fwscanf$LDBLStub) \
364 Sym(printf$LDBLStub) \
365 Sym(scanf$LDBLStub) \
366 Sym(snprintf$LDBLStub) \
367 Sym(sprintf$LDBLStub) \
368 Sym(sscanf$LDBLStub) \
369 Sym(strtold$LDBLStub) \
370 Sym(swprintf$LDBLStub) \
371 Sym(swscanf$LDBLStub) \
372 Sym(syslog$LDBLStub) \
373 Sym(vasprintf$LDBLStub) \
375 Sym(verrc$LDBLStub) \
376 Sym(verrx$LDBLStub) \
377 Sym(vfprintf$LDBLStub) \
378 Sym(vfscanf$LDBLStub) \
379 Sym(vfwprintf$LDBLStub) \
380 Sym(vfwscanf$LDBLStub) \
381 Sym(vprintf$LDBLStub) \
382 Sym(vscanf$LDBLStub) \
383 Sym(vsnprintf$LDBLStub) \
384 Sym(vsprintf$LDBLStub) \
385 Sym(vsscanf$LDBLStub) \
386 Sym(vswprintf$LDBLStub) \
387 Sym(vswscanf$LDBLStub) \
388 Sym(vsyslog$LDBLStub) \
389 Sym(vwarn$LDBLStub) \
390 Sym(vwarnc$LDBLStub) \
391 Sym(vwarnx$LDBLStub) \
392 Sym(vwprintf$LDBLStub) \
393 Sym(vwscanf$LDBLStub) \
395 Sym(warnc$LDBLStub) \
396 Sym(warnx$LDBLStub) \
397 Sym(wcstold$LDBLStub) \
398 Sym(wprintf$LDBLStub) \
401 #define RTS_DARWIN_ONLY_SYMBOLS
405 # define MAIN_CAP_SYM SymX(MainCapability)
407 # define MAIN_CAP_SYM
410 #if !defined(mingw32_HOST_OS)
411 #define RTS_USER_SIGNALS_SYMBOLS \
412 SymX(setIOManagerPipe)
414 #define RTS_USER_SIGNALS_SYMBOLS \
415 SymX(sendIOManagerEvent) \
416 SymX(readIOManagerEvent) \
417 SymX(getIOManagerEvent) \
418 SymX(console_handler)
421 #ifdef TABLES_NEXT_TO_CODE
422 #define RTS_RET_SYMBOLS /* nothing */
424 #define RTS_RET_SYMBOLS \
425 SymX(stg_enter_ret) \
426 SymX(stg_gc_fun_ret) \
433 SymX(stg_ap_pv_ret) \
434 SymX(stg_ap_pp_ret) \
435 SymX(stg_ap_ppv_ret) \
436 SymX(stg_ap_ppp_ret) \
437 SymX(stg_ap_pppv_ret) \
438 SymX(stg_ap_pppp_ret) \
439 SymX(stg_ap_ppppp_ret) \
440 SymX(stg_ap_pppppp_ret)
443 #define RTS_SYMBOLS \
446 SymX(stg_enter_info) \
447 SymX(stg_gc_void_info) \
448 SymX(__stg_gc_enter_1) \
449 SymX(stg_gc_noregs) \
450 SymX(stg_gc_unpt_r1_info) \
451 SymX(stg_gc_unpt_r1) \
452 SymX(stg_gc_unbx_r1_info) \
453 SymX(stg_gc_unbx_r1) \
454 SymX(stg_gc_f1_info) \
456 SymX(stg_gc_d1_info) \
458 SymX(stg_gc_l1_info) \
461 SymX(stg_gc_fun_info) \
463 SymX(stg_gc_gen_info) \
464 SymX(stg_gc_gen_hp) \
466 SymX(stg_gen_yield) \
467 SymX(stg_yield_noregs) \
468 SymX(stg_yield_to_interpreter) \
469 SymX(stg_gen_block) \
470 SymX(stg_block_noregs) \
472 SymX(stg_block_takemvar) \
473 SymX(stg_block_putmvar) \
475 SymX(MallocFailHook) \
477 SymX(OutOfHeapHook) \
478 SymX(StackOverflowHook) \
479 SymX(__encodeDouble) \
480 SymX(__encodeFloat) \
482 SymExtern(__gmpn_gcd_1) \
483 SymExtern(__gmpz_cmp) \
484 SymExtern(__gmpz_cmp_si) \
485 SymExtern(__gmpz_cmp_ui) \
486 SymExtern(__gmpz_get_si) \
487 SymExtern(__gmpz_get_ui) \
488 SymX(__int_encodeDouble) \
489 SymX(__int_encodeFloat) \
490 SymX(andIntegerzh_fast) \
491 SymX(atomicallyzh_fast) \
495 SymX(blockAsyncExceptionszh_fast) \
497 SymX(catchRetryzh_fast) \
498 SymX(catchSTMzh_fast) \
500 SymX(closure_flags) \
502 SymX(cmpIntegerzh_fast) \
503 SymX(cmpIntegerIntzh_fast) \
504 SymX(complementIntegerzh_fast) \
505 SymX(createAdjustor) \
506 SymX(decodeDoublezh_fast) \
507 SymX(decodeFloatzh_fast) \
510 SymX(deRefWeakzh_fast) \
511 SymX(deRefStablePtrzh_fast) \
512 SymX(dirty_MUT_VAR) \
513 SymX(divExactIntegerzh_fast) \
514 SymX(divModIntegerzh_fast) \
516 SymX(forkOnzh_fast) \
518 SymX(forkOS_createThread) \
519 SymX(freeHaskellFunctionPtr) \
520 SymX(freeStablePtr) \
521 SymX(getOrSetTypeableStore) \
522 SymX(gcdIntegerzh_fast) \
523 SymX(gcdIntegerIntzh_fast) \
524 SymX(gcdIntzh_fast) \
528 SymX(getFullProgArgv) \
534 SymX(hs_perform_gc) \
535 SymX(hs_free_stable_ptr) \
536 SymX(hs_free_fun_ptr) \
537 SymX(hs_hpc_rootModule) \
539 SymX(unpackClosurezh_fast) \
540 SymX(getApStackValzh_fast) \
541 SymX(int2Integerzh_fast) \
542 SymX(integer2Intzh_fast) \
543 SymX(integer2Wordzh_fast) \
544 SymX(isCurrentThreadBoundzh_fast) \
545 SymX(isDoubleDenormalized) \
546 SymX(isDoubleInfinite) \
548 SymX(isDoubleNegativeZero) \
549 SymX(isEmptyMVarzh_fast) \
550 SymX(isFloatDenormalized) \
551 SymX(isFloatInfinite) \
553 SymX(isFloatNegativeZero) \
554 SymX(killThreadzh_fast) \
556 SymX(insertStableSymbol) \
559 SymX(makeStablePtrzh_fast) \
560 SymX(minusIntegerzh_fast) \
561 SymX(mkApUpd0zh_fast) \
562 SymX(myThreadIdzh_fast) \
563 SymX(labelThreadzh_fast) \
564 SymX(newArrayzh_fast) \
565 SymX(newBCOzh_fast) \
566 SymX(newByteArrayzh_fast) \
567 SymX_redirect(newCAF, newDynCAF) \
568 SymX(newMVarzh_fast) \
569 SymX(newMutVarzh_fast) \
570 SymX(newTVarzh_fast) \
571 SymX(noDuplicatezh_fast) \
572 SymX(atomicModifyMutVarzh_fast) \
573 SymX(newPinnedByteArrayzh_fast) \
575 SymX(orIntegerzh_fast) \
577 SymX(performMajorGC) \
578 SymX(plusIntegerzh_fast) \
581 SymX(putMVarzh_fast) \
582 SymX(quotIntegerzh_fast) \
583 SymX(quotRemIntegerzh_fast) \
585 SymX(raiseIOzh_fast) \
586 SymX(readTVarzh_fast) \
587 SymX(remIntegerzh_fast) \
588 SymX(resetNonBlockingFd) \
593 SymX(rts_checkSchedStatus) \
596 SymX(rts_evalLazyIO) \
597 SymX(rts_evalStableIO) \
601 SymX(rts_getDouble) \
609 SymX(rts_getFunPtr) \
610 SymX(rts_getStablePtr) \
611 SymX(rts_getThreadId) \
614 SymX(rts_getWord16) \
615 SymX(rts_getWord32) \
616 SymX(rts_getWord64) \
629 SymX(rts_mkStablePtr) \
637 SymX(rtsSupportsBoundThreads) \
638 SymX(__hscore_get_saved_termios) \
639 SymX(__hscore_set_saved_termios) \
641 SymX(startupHaskell) \
642 SymX(shutdownHaskell) \
643 SymX(shutdownHaskellAndExit) \
644 SymX(stable_ptr_table) \
645 SymX(stackOverflow) \
646 SymX(stg_CAF_BLACKHOLE_info) \
647 SymX(awakenBlockedQueue) \
648 SymX(stg_CHARLIKE_closure) \
649 SymX(stg_EMPTY_MVAR_info) \
650 SymX(stg_IND_STATIC_info) \
651 SymX(stg_INTLIKE_closure) \
652 SymX(stg_MUT_ARR_PTRS_DIRTY_info) \
653 SymX(stg_MUT_ARR_PTRS_FROZEN_info) \
654 SymX(stg_MUT_ARR_PTRS_FROZEN0_info) \
655 SymX(stg_WEAK_info) \
656 SymX(stg_ap_v_info) \
657 SymX(stg_ap_f_info) \
658 SymX(stg_ap_d_info) \
659 SymX(stg_ap_l_info) \
660 SymX(stg_ap_n_info) \
661 SymX(stg_ap_p_info) \
662 SymX(stg_ap_pv_info) \
663 SymX(stg_ap_pp_info) \
664 SymX(stg_ap_ppv_info) \
665 SymX(stg_ap_ppp_info) \
666 SymX(stg_ap_pppv_info) \
667 SymX(stg_ap_pppp_info) \
668 SymX(stg_ap_ppppp_info) \
669 SymX(stg_ap_pppppp_info) \
670 SymX(stg_ap_0_fast) \
671 SymX(stg_ap_v_fast) \
672 SymX(stg_ap_f_fast) \
673 SymX(stg_ap_d_fast) \
674 SymX(stg_ap_l_fast) \
675 SymX(stg_ap_n_fast) \
676 SymX(stg_ap_p_fast) \
677 SymX(stg_ap_pv_fast) \
678 SymX(stg_ap_pp_fast) \
679 SymX(stg_ap_ppv_fast) \
680 SymX(stg_ap_ppp_fast) \
681 SymX(stg_ap_pppv_fast) \
682 SymX(stg_ap_pppp_fast) \
683 SymX(stg_ap_ppppp_fast) \
684 SymX(stg_ap_pppppp_fast) \
685 SymX(stg_ap_1_upd_info) \
686 SymX(stg_ap_2_upd_info) \
687 SymX(stg_ap_3_upd_info) \
688 SymX(stg_ap_4_upd_info) \
689 SymX(stg_ap_5_upd_info) \
690 SymX(stg_ap_6_upd_info) \
691 SymX(stg_ap_7_upd_info) \
693 SymX(stg_sel_0_upd_info) \
694 SymX(stg_sel_10_upd_info) \
695 SymX(stg_sel_11_upd_info) \
696 SymX(stg_sel_12_upd_info) \
697 SymX(stg_sel_13_upd_info) \
698 SymX(stg_sel_14_upd_info) \
699 SymX(stg_sel_15_upd_info) \
700 SymX(stg_sel_1_upd_info) \
701 SymX(stg_sel_2_upd_info) \
702 SymX(stg_sel_3_upd_info) \
703 SymX(stg_sel_4_upd_info) \
704 SymX(stg_sel_5_upd_info) \
705 SymX(stg_sel_6_upd_info) \
706 SymX(stg_sel_7_upd_info) \
707 SymX(stg_sel_8_upd_info) \
708 SymX(stg_sel_9_upd_info) \
709 SymX(stg_upd_frame_info) \
710 SymX(suspendThread) \
711 SymX(takeMVarzh_fast) \
712 SymX(timesIntegerzh_fast) \
713 SymX(tryPutMVarzh_fast) \
714 SymX(tryTakeMVarzh_fast) \
715 SymX(unblockAsyncExceptionszh_fast) \
717 SymX(unsafeThawArrayzh_fast) \
718 SymX(waitReadzh_fast) \
719 SymX(waitWritezh_fast) \
720 SymX(word2Integerzh_fast) \
721 SymX(writeTVarzh_fast) \
722 SymX(xorIntegerzh_fast) \
724 SymX(stg_interp_constr_entry) \
727 SymX(getAllocations) \
730 SymX(rts_breakpoint_io_action) \
731 SymX(rts_stop_next_breakpoint) \
732 SymX(rts_stop_on_exception) \
733 RTS_USER_SIGNALS_SYMBOLS
735 #ifdef SUPPORT_LONG_LONGS
736 #define RTS_LONG_LONG_SYMS \
737 SymX(int64ToIntegerzh_fast) \
738 SymX(word64ToIntegerzh_fast)
740 #define RTS_LONG_LONG_SYMS /* nothing */
743 // 64-bit support functions in libgcc.a
744 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
745 #define RTS_LIBGCC_SYMBOLS \
755 #elif defined(ia64_HOST_ARCH)
756 #define RTS_LIBGCC_SYMBOLS \
764 #define RTS_LIBGCC_SYMBOLS
767 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
768 // Symbols that don't have a leading underscore
769 // on Mac OS X. They have to receive special treatment,
770 // see machoInitSymbolsWithoutUnderscore()
771 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
776 /* entirely bogus claims about types of these symbols */
777 #define Sym(vvv) extern void vvv(void);
778 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
779 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
781 #define SymExtern(vvv) SymX(vvv)
783 #define SymX(vvv) /**/
784 #define SymX_redirect(vvv,xxx) /**/
788 RTS_POSIX_ONLY_SYMBOLS
789 RTS_MINGW_ONLY_SYMBOLS
790 RTS_CYGWIN_ONLY_SYMBOLS
791 RTS_DARWIN_ONLY_SYMBOLS
798 #ifdef LEADING_UNDERSCORE
799 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
801 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
804 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
806 #define SymX(vvv) Sym(vvv)
807 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
808 (void*)DLL_IMPORT_DATA_REF(vvv) },
810 // SymX_redirect allows us to redirect references to one symbol to
811 // another symbol. See newCAF/newDynCAF for an example.
812 #define SymX_redirect(vvv,xxx) \
813 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
816 static RtsSymbolVal rtsSyms[] = {
820 RTS_POSIX_ONLY_SYMBOLS
821 RTS_MINGW_ONLY_SYMBOLS
822 RTS_CYGWIN_ONLY_SYMBOLS
823 RTS_DARWIN_ONLY_SYMBOLS
825 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
826 // dyld stub code contains references to this,
827 // but it should never be called because we treat
828 // lazy pointers as nonlazy.
829 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
831 { 0, 0 } /* sentinel */
836 /* -----------------------------------------------------------------------------
837 * Insert symbols into hash tables, checking for duplicates.
840 static void ghciInsertStrHashTable ( char* obj_name,
846 if (lookupHashTable(table, (StgWord)key) == NULL)
848 insertStrHashTable(table, (StgWord)key, data);
853 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
855 "whilst processing object file\n"
857 "This could be caused by:\n"
858 " * Loading two different object files which export the same symbol\n"
859 " * Specifying the same object file twice on the GHCi command line\n"
860 " * An incorrect `package.conf' entry, causing some object to be\n"
862 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
869 /* -----------------------------------------------------------------------------
870 * initialize the object linker
874 static int linker_init_done = 0 ;
876 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
877 static void *dl_prog_handle;
885 /* Make initLinker idempotent, so we can call it
886 before evey relevant operation; that means we
887 don't need to initialise the linker separately */
888 if (linker_init_done == 1) { return; } else {
889 linker_init_done = 1;
892 stablehash = allocStrHashTable();
893 symhash = allocStrHashTable();
895 /* populate the symbol table with stuff from the RTS */
896 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
897 ghciInsertStrHashTable("(GHCi built-in symbols)",
898 symhash, sym->lbl, sym->addr);
900 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
901 machoInitSymbolsWithoutUnderscore();
904 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
905 # if defined(RTLD_DEFAULT)
906 dl_prog_handle = RTLD_DEFAULT;
908 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
909 # endif /* RTLD_DEFAULT */
913 /* -----------------------------------------------------------------------------
914 * Loading DLL or .so dynamic libraries
915 * -----------------------------------------------------------------------------
917 * Add a DLL from which symbols may be found. In the ELF case, just
918 * do RTLD_GLOBAL-style add, so no further messing around needs to
919 * happen in order that symbols in the loaded .so are findable --
920 * lookupSymbol() will subsequently see them by dlsym on the program's
921 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
923 * In the PEi386 case, open the DLLs and put handles to them in a
924 * linked list. When looking for a symbol, try all handles in the
925 * list. This means that we need to load even DLLs that are guaranteed
926 * to be in the ghc.exe image already, just so we can get a handle
927 * to give to loadSymbol, so that we can find the symbols. For such
928 * libraries, the LoadLibrary call should be a no-op except for returning
933 #if defined(OBJFORMAT_PEi386)
934 /* A record for storing handles into DLLs. */
939 struct _OpenedDLL* next;
944 /* A list thereof. */
945 static OpenedDLL* opened_dlls = NULL;
949 addDLL( char *dll_name )
951 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
952 /* ------------------- ELF DLL loader ------------------- */
958 hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
961 /* dlopen failed; return a ptr to the error msg. */
963 if (errmsg == NULL) errmsg = "addDLL: unknown error";
970 # elif defined(OBJFORMAT_PEi386)
971 /* ------------------- Win32 DLL loader ------------------- */
979 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
981 /* See if we've already got it, and ignore if so. */
982 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
983 if (0 == strcmp(o_dll->name, dll_name))
987 /* The file name has no suffix (yet) so that we can try
988 both foo.dll and foo.drv
990 The documentation for LoadLibrary says:
991 If no file name extension is specified in the lpFileName
992 parameter, the default library extension .dll is
993 appended. However, the file name string can include a trailing
994 point character (.) to indicate that the module name has no
997 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
998 sprintf(buf, "%s.DLL", dll_name);
999 instance = LoadLibrary(buf);
1000 if (instance == NULL) {
1001 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1002 instance = LoadLibrary(buf);
1003 if (instance == NULL) {
1006 /* LoadLibrary failed; return a ptr to the error msg. */
1007 return "addDLL: unknown error";
1012 /* Add this DLL to the list of DLLs in which to search for symbols. */
1013 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1014 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1015 strcpy(o_dll->name, dll_name);
1016 o_dll->instance = instance;
1017 o_dll->next = opened_dlls;
1018 opened_dlls = o_dll;
1022 barf("addDLL: not implemented on this platform");
1026 /* -----------------------------------------------------------------------------
1027 * insert a stable symbol in the hash table
1031 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1033 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1037 /* -----------------------------------------------------------------------------
1038 * insert a symbol in the hash table
1041 insertSymbol(char* obj_name, char* key, void* data)
1043 ghciInsertStrHashTable(obj_name, symhash, key, data);
1046 /* -----------------------------------------------------------------------------
1047 * lookup a symbol in the hash table
1050 lookupSymbol( char *lbl )
1054 ASSERT(symhash != NULL);
1055 val = lookupStrHashTable(symhash, lbl);
1058 # if defined(OBJFORMAT_ELF)
1059 # if defined(x86_64_HOST_ARCH)
1060 val = dlsym(dl_prog_handle, lbl);
1061 if (val >= (void *)0x80000000) {
1063 new_val = x86_64_high_symbol(lbl, val);
1064 IF_DEBUG(linker,debugBelch("lookupSymbol: relocating out of range symbol: %s = %p, now %p\n", lbl, val, new_val));
1070 return dlsym(dl_prog_handle, lbl);
1072 # elif defined(OBJFORMAT_MACHO)
1074 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1077 HACK: On OS X, global symbols are prefixed with an underscore.
1078 However, dlsym wants us to omit the leading underscore from the
1079 symbol name. For now, we simply strip it off here (and ONLY
1082 ASSERT(lbl[0] == '_');
1083 return dlsym(dl_prog_handle, lbl+1);
1085 if(NSIsSymbolNameDefined(lbl)) {
1086 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1087 return NSAddressOfSymbol(symbol);
1091 # endif /* HAVE_DLFCN_H */
1092 # elif defined(OBJFORMAT_PEi386)
1095 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1096 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1097 if (lbl[0] == '_') {
1098 /* HACK: if the name has an initial underscore, try stripping
1099 it off & look that up first. I've yet to verify whether there's
1100 a Rule that governs whether an initial '_' *should always* be
1101 stripped off when mapping from import lib name to the DLL name.
1103 sym = GetProcAddress(o_dll->instance, (lbl+1));
1105 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1109 sym = GetProcAddress(o_dll->instance, lbl);
1111 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1126 __attribute((unused))
1128 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1132 val = lookupStrHashTable(oc->lochash, lbl);
1142 /* -----------------------------------------------------------------------------
1143 * Debugging aid: look in GHCi's object symbol tables for symbols
1144 * within DELTA bytes of the specified address, and show their names.
1147 void ghci_enquire ( char* addr );
1149 void ghci_enquire ( char* addr )
1154 const int DELTA = 64;
1159 for (oc = objects; oc; oc = oc->next) {
1160 for (i = 0; i < oc->n_symbols; i++) {
1161 sym = oc->symbols[i];
1162 if (sym == NULL) continue;
1163 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1165 if (oc->lochash != NULL) {
1166 a = lookupStrHashTable(oc->lochash, sym);
1169 a = lookupStrHashTable(symhash, sym);
1172 // debugBelch("ghci_enquire: can't find %s\n", sym);
1174 else if (addr-DELTA <= a && a <= addr+DELTA) {
1175 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1182 #ifdef ia64_HOST_ARCH
1183 static unsigned int PLTSize(void);
1186 /* -----------------------------------------------------------------------------
1187 * Load an obj (populate the global symbol table, but don't resolve yet)
1189 * Returns: 1 if ok, 0 on error.
1192 loadObj( char *path )
1199 void *map_addr = NULL;
1205 /* debugBelch("loadObj %s\n", path ); */
1207 /* Check that we haven't already loaded this object.
1208 Ignore requests to load multiple times */
1212 for (o = objects; o; o = o->next) {
1213 if (0 == strcmp(o->fileName, path)) {
1215 break; /* don't need to search further */
1219 IF_DEBUG(linker, debugBelch(
1220 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1221 "same object file twice:\n"
1223 "GHCi will ignore this, but be warned.\n"
1225 return 1; /* success */
1229 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1231 # if defined(OBJFORMAT_ELF)
1232 oc->formatName = "ELF";
1233 # elif defined(OBJFORMAT_PEi386)
1234 oc->formatName = "PEi386";
1235 # elif defined(OBJFORMAT_MACHO)
1236 oc->formatName = "Mach-O";
1239 barf("loadObj: not implemented on this platform");
1242 r = stat(path, &st);
1243 if (r == -1) { return 0; }
1245 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1246 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1247 strcpy(oc->fileName, path);
1249 oc->fileSize = st.st_size;
1251 oc->sections = NULL;
1252 oc->lochash = allocStrHashTable();
1253 oc->proddables = NULL;
1255 /* chain it onto the list of objects */
1260 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1262 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1264 #if defined(openbsd_HOST_OS)
1265 fd = open(path, O_RDONLY, S_IRUSR);
1267 fd = open(path, O_RDONLY);
1270 barf("loadObj: can't open `%s'", path);
1272 pagesize = getpagesize();
1274 #ifdef ia64_HOST_ARCH
1275 /* The PLT needs to be right before the object */
1276 n = ROUND_UP(PLTSize(), pagesize);
1277 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1278 if (oc->plt == MAP_FAILED)
1279 barf("loadObj: can't allocate PLT");
1282 map_addr = oc->plt + n;
1285 n = ROUND_UP(oc->fileSize, pagesize);
1287 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1288 * small memory model on this architecture (see gcc docs,
1291 #ifdef x86_64_HOST_ARCH
1292 #define EXTRA_MAP_FLAGS MAP_32BIT
1294 #define EXTRA_MAP_FLAGS 0
1297 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1298 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1299 if (oc->image == MAP_FAILED)
1300 barf("loadObj: can't map `%s'", path);
1304 #else /* !USE_MMAP */
1306 /* load the image into memory */
1307 f = fopen(path, "rb");
1309 barf("loadObj: can't read `%s'", path);
1311 # if defined(mingw32_HOST_OS)
1312 // TODO: We would like to use allocateExec here, but allocateExec
1313 // cannot currently allocate blocks large enough.
1314 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1315 PAGE_EXECUTE_READWRITE);
1316 # elif defined(darwin_HOST_OS)
1317 // In a Mach-O .o file, all sections can and will be misaligned
1318 // if the total size of the headers is not a multiple of the
1319 // desired alignment. This is fine for .o files that only serve
1320 // as input for the static linker, but it's not fine for us,
1321 // as SSE (used by gcc for floating point) and Altivec require
1322 // 16-byte alignment.
1323 // We calculate the correct alignment from the header before
1324 // reading the file, and then we misalign oc->image on purpose so
1325 // that the actual sections end up aligned again.
1326 oc->misalignment = machoGetMisalignment(f);
1327 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1328 oc->image += oc->misalignment;
1330 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1333 n = fread ( oc->image, 1, oc->fileSize, f );
1334 if (n != oc->fileSize)
1335 barf("loadObj: error whilst reading `%s'", path);
1338 #endif /* USE_MMAP */
1340 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1341 r = ocAllocateSymbolExtras_MachO ( oc );
1342 if (!r) { return r; }
1343 # elif defined(OBJFORMAT_ELF) && defined(powerpc_HOST_ARCH)
1344 r = ocAllocateSymbolExtras_ELF ( oc );
1345 if (!r) { return r; }
1348 /* verify the in-memory image */
1349 # if defined(OBJFORMAT_ELF)
1350 r = ocVerifyImage_ELF ( oc );
1351 # elif defined(OBJFORMAT_PEi386)
1352 r = ocVerifyImage_PEi386 ( oc );
1353 # elif defined(OBJFORMAT_MACHO)
1354 r = ocVerifyImage_MachO ( oc );
1356 barf("loadObj: no verify method");
1358 if (!r) { return r; }
1360 /* build the symbol list for this image */
1361 # if defined(OBJFORMAT_ELF)
1362 r = ocGetNames_ELF ( oc );
1363 # elif defined(OBJFORMAT_PEi386)
1364 r = ocGetNames_PEi386 ( oc );
1365 # elif defined(OBJFORMAT_MACHO)
1366 r = ocGetNames_MachO ( oc );
1368 barf("loadObj: no getNames method");
1370 if (!r) { return r; }
1372 /* loaded, but not resolved yet */
1373 oc->status = OBJECT_LOADED;
1378 /* -----------------------------------------------------------------------------
1379 * resolve all the currently unlinked objects in memory
1381 * Returns: 1 if ok, 0 on error.
1391 for (oc = objects; oc; oc = oc->next) {
1392 if (oc->status != OBJECT_RESOLVED) {
1393 # if defined(OBJFORMAT_ELF)
1394 r = ocResolve_ELF ( oc );
1395 # elif defined(OBJFORMAT_PEi386)
1396 r = ocResolve_PEi386 ( oc );
1397 # elif defined(OBJFORMAT_MACHO)
1398 r = ocResolve_MachO ( oc );
1400 barf("resolveObjs: not implemented on this platform");
1402 if (!r) { return r; }
1403 oc->status = OBJECT_RESOLVED;
1409 /* -----------------------------------------------------------------------------
1410 * delete an object from the pool
1413 unloadObj( char *path )
1415 ObjectCode *oc, *prev;
1417 ASSERT(symhash != NULL);
1418 ASSERT(objects != NULL);
1423 for (oc = objects; oc; prev = oc, oc = oc->next) {
1424 if (!strcmp(oc->fileName,path)) {
1426 /* Remove all the mappings for the symbols within this
1431 for (i = 0; i < oc->n_symbols; i++) {
1432 if (oc->symbols[i] != NULL) {
1433 removeStrHashTable(symhash, oc->symbols[i], NULL);
1441 prev->next = oc->next;
1444 // We're going to leave this in place, in case there are
1445 // any pointers from the heap into it:
1446 // #ifdef mingw32_HOST_OS
1447 // VirtualFree(oc->image);
1449 // stgFree(oc->image);
1451 stgFree(oc->fileName);
1452 stgFree(oc->symbols);
1453 stgFree(oc->sections);
1454 /* The local hash table should have been freed at the end
1455 of the ocResolve_ call on it. */
1456 ASSERT(oc->lochash == NULL);
1462 errorBelch("unloadObj: can't find `%s' to unload", path);
1466 /* -----------------------------------------------------------------------------
1467 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1468 * which may be prodded during relocation, and abort if we try and write
1469 * outside any of these.
1471 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1474 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1475 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1479 pb->next = oc->proddables;
1480 oc->proddables = pb;
1483 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1486 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1487 char* s = (char*)(pb->start);
1488 char* e = s + pb->size - 1;
1489 char* a = (char*)addr;
1490 /* Assumes that the biggest fixup involves a 4-byte write. This
1491 probably needs to be changed to 8 (ie, +7) on 64-bit
1493 if (a >= s && (a+3) <= e) return;
1495 barf("checkProddableBlock: invalid fixup in runtime linker");
1498 /* -----------------------------------------------------------------------------
1499 * Section management.
1501 static void addSection ( ObjectCode* oc, SectionKind kind,
1502 void* start, void* end )
1504 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1508 s->next = oc->sections;
1511 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1512 start, ((char*)end)-1, end - start + 1, kind );
1517 /* --------------------------------------------------------------------------
1519 * This is about allocating a small chunk of memory for every symbol in the
1520 * object file. We make sure that the SymboLExtras are always "in range" of
1521 * limited-range PC-relative instructions on various platforms by allocating
1522 * them right next to the object code itself.
1525 #if defined(powerpc_HOST_ARCH) || (defined(x86_64_HOST_ARCH) \
1526 && defined(darwin_TARGET_OS))
1529 ocAllocateSymbolExtras
1531 Allocate additional space at the end of the object file image to make room
1532 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1534 PowerPC relative branch instructions have a 24 bit displacement field.
1535 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1536 If a particular imported symbol is outside this range, we have to redirect
1537 the jump to a short piece of new code that just loads the 32bit absolute
1538 address and jumps there.
1539 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1542 This function just allocates space for one SymbolExtra for every
1543 undefined symbol in the object file. The code for the jump islands is
1544 filled in by makeSymbolExtra below.
1547 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1553 int misalignment = 0;
1555 misalignment = oc->misalignment;
1560 // round up to the nearest 4
1561 aligned = (oc->fileSize + 3) & ~3;
1564 #ifndef linux_HOST_OS /* mremap is a linux extension */
1565 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1568 pagesize = getpagesize();
1569 n = ROUND_UP( oc->fileSize, pagesize );
1570 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1572 /* If we have a half-page-size file and map one page of it then
1573 * the part of the page after the size of the file remains accessible.
1574 * If, however, we map in 2 pages, the 2nd page is not accessible
1575 * and will give a "Bus Error" on access. To get around this, we check
1576 * if we need any extra pages for the jump islands and map them in
1577 * anonymously. We must check that we actually require extra pages
1578 * otherwise the attempt to mmap 0 pages of anonymous memory will
1584 /* The effect of this mremap() call is only the ensure that we have
1585 * a sufficient number of virtually contiguous pages. As returned from
1586 * mremap, the pages past the end of the file are not backed. We give
1587 * them a backing by using MAP_FIXED to map in anonymous pages.
1589 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1591 if( oc->image == MAP_FAILED )
1593 errorBelch( "Unable to mremap for Jump Islands\n" );
1597 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1598 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1600 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1606 oc->image -= misalignment;
1607 oc->image = stgReallocBytes( oc->image,
1609 aligned + sizeof (SymbolExtra) * count,
1610 "ocAllocateSymbolExtras" );
1611 oc->image += misalignment;
1612 #endif /* USE_MMAP */
1614 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1615 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1618 oc->symbol_extras = NULL;
1620 oc->first_symbol_extra = first;
1621 oc->n_symbol_extras = count;
1626 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1627 unsigned long symbolNumber,
1628 unsigned long target )
1632 ASSERT( symbolNumber >= oc->first_symbol_extra
1633 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1635 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1637 #ifdef powerpc_HOST_ARCH
1638 // lis r12, hi16(target)
1639 extra->jumpIsland.lis_r12 = 0x3d80;
1640 extra->jumpIsland.hi_addr = target >> 16;
1642 // ori r12, r12, lo16(target)
1643 extra->jumpIsland.ori_r12_r12 = 0x618c;
1644 extra->jumpIsland.lo_addr = target & 0xffff;
1647 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1650 extra->jumpIsland.bctr = 0x4e800420;
1652 #ifdef x86_64_HOST_ARCH
1654 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1655 extra->addr = target;
1656 memcpy(extra->jumpIsland, jmp, 6);
1664 /* --------------------------------------------------------------------------
1665 * PowerPC specifics (instruction cache flushing)
1666 * ------------------------------------------------------------------------*/
1668 #ifdef powerpc_TARGET_ARCH
1670 ocFlushInstructionCache
1672 Flush the data & instruction caches.
1673 Because the PPC has split data/instruction caches, we have to
1674 do that whenever we modify code at runtime.
1677 static void ocFlushInstructionCache( ObjectCode *oc )
1679 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1680 unsigned long *p = (unsigned long *) oc->image;
1684 __asm__ volatile ( "dcbf 0,%0\n\t"
1692 __asm__ volatile ( "sync\n\t"
1698 /* --------------------------------------------------------------------------
1699 * PEi386 specifics (Win32 targets)
1700 * ------------------------------------------------------------------------*/
1702 /* The information for this linker comes from
1703 Microsoft Portable Executable
1704 and Common Object File Format Specification
1705 revision 5.1 January 1998
1706 which SimonM says comes from the MS Developer Network CDs.
1708 It can be found there (on older CDs), but can also be found
1711 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1713 (this is Rev 6.0 from February 1999).
1715 Things move, so if that fails, try searching for it via
1717 http://www.google.com/search?q=PE+COFF+specification
1719 The ultimate reference for the PE format is the Winnt.h
1720 header file that comes with the Platform SDKs; as always,
1721 implementations will drift wrt their documentation.
1723 A good background article on the PE format is Matt Pietrek's
1724 March 1994 article in Microsoft System Journal (MSJ)
1725 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1726 Win32 Portable Executable File Format." The info in there
1727 has recently been updated in a two part article in
1728 MSDN magazine, issues Feb and March 2002,
1729 "Inside Windows: An In-Depth Look into the Win32 Portable
1730 Executable File Format"
1732 John Levine's book "Linkers and Loaders" contains useful
1737 #if defined(OBJFORMAT_PEi386)
1741 typedef unsigned char UChar;
1742 typedef unsigned short UInt16;
1743 typedef unsigned int UInt32;
1750 UInt16 NumberOfSections;
1751 UInt32 TimeDateStamp;
1752 UInt32 PointerToSymbolTable;
1753 UInt32 NumberOfSymbols;
1754 UInt16 SizeOfOptionalHeader;
1755 UInt16 Characteristics;
1759 #define sizeof_COFF_header 20
1766 UInt32 VirtualAddress;
1767 UInt32 SizeOfRawData;
1768 UInt32 PointerToRawData;
1769 UInt32 PointerToRelocations;
1770 UInt32 PointerToLinenumbers;
1771 UInt16 NumberOfRelocations;
1772 UInt16 NumberOfLineNumbers;
1773 UInt32 Characteristics;
1777 #define sizeof_COFF_section 40
1784 UInt16 SectionNumber;
1787 UChar NumberOfAuxSymbols;
1791 #define sizeof_COFF_symbol 18
1796 UInt32 VirtualAddress;
1797 UInt32 SymbolTableIndex;
1802 #define sizeof_COFF_reloc 10
1805 /* From PE spec doc, section 3.3.2 */
1806 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1807 windows.h -- for the same purpose, but I want to know what I'm
1809 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1810 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1811 #define MYIMAGE_FILE_DLL 0x2000
1812 #define MYIMAGE_FILE_SYSTEM 0x1000
1813 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1814 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1815 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1817 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1818 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1819 #define MYIMAGE_SYM_CLASS_STATIC 3
1820 #define MYIMAGE_SYM_UNDEFINED 0
1822 /* From PE spec doc, section 4.1 */
1823 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1824 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1825 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1827 /* From PE spec doc, section 5.2.1 */
1828 #define MYIMAGE_REL_I386_DIR32 0x0006
1829 #define MYIMAGE_REL_I386_REL32 0x0014
1832 /* We use myindex to calculate array addresses, rather than
1833 simply doing the normal subscript thing. That's because
1834 some of the above structs have sizes which are not
1835 a whole number of words. GCC rounds their sizes up to a
1836 whole number of words, which means that the address calcs
1837 arising from using normal C indexing or pointer arithmetic
1838 are just plain wrong. Sigh.
1841 myindex ( int scale, void* base, int index )
1844 ((UChar*)base) + scale * index;
1849 printName ( UChar* name, UChar* strtab )
1851 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1852 UInt32 strtab_offset = * (UInt32*)(name+4);
1853 debugBelch("%s", strtab + strtab_offset );
1856 for (i = 0; i < 8; i++) {
1857 if (name[i] == 0) break;
1858 debugBelch("%c", name[i] );
1865 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1867 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1868 UInt32 strtab_offset = * (UInt32*)(name+4);
1869 strncpy ( dst, strtab+strtab_offset, dstSize );
1875 if (name[i] == 0) break;
1885 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1888 /* If the string is longer than 8 bytes, look in the
1889 string table for it -- this will be correctly zero terminated.
1891 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1892 UInt32 strtab_offset = * (UInt32*)(name+4);
1893 return ((UChar*)strtab) + strtab_offset;
1895 /* Otherwise, if shorter than 8 bytes, return the original,
1896 which by defn is correctly terminated.
1898 if (name[7]==0) return name;
1899 /* The annoying case: 8 bytes. Copy into a temporary
1900 (which is never freed ...)
1902 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1904 strncpy(newstr,name,8);
1910 /* Just compares the short names (first 8 chars) */
1911 static COFF_section *
1912 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1916 = (COFF_header*)(oc->image);
1917 COFF_section* sectab
1919 ((UChar*)(oc->image))
1920 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1922 for (i = 0; i < hdr->NumberOfSections; i++) {
1925 COFF_section* section_i
1927 myindex ( sizeof_COFF_section, sectab, i );
1928 n1 = (UChar*) &(section_i->Name);
1930 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1931 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1932 n1[6]==n2[6] && n1[7]==n2[7])
1941 zapTrailingAtSign ( UChar* sym )
1943 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
1945 if (sym[0] == 0) return;
1947 while (sym[i] != 0) i++;
1950 while (j > 0 && my_isdigit(sym[j])) j--;
1951 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
1957 ocVerifyImage_PEi386 ( ObjectCode* oc )
1962 COFF_section* sectab;
1963 COFF_symbol* symtab;
1965 /* debugBelch("\nLOADING %s\n", oc->fileName); */
1966 hdr = (COFF_header*)(oc->image);
1967 sectab = (COFF_section*) (
1968 ((UChar*)(oc->image))
1969 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1971 symtab = (COFF_symbol*) (
1972 ((UChar*)(oc->image))
1973 + hdr->PointerToSymbolTable
1975 strtab = ((UChar*)symtab)
1976 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
1978 if (hdr->Machine != 0x14c) {
1979 errorBelch("%s: Not x86 PEi386", oc->fileName);
1982 if (hdr->SizeOfOptionalHeader != 0) {
1983 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
1986 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
1987 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
1988 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
1989 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
1990 errorBelch("%s: Not a PEi386 object file", oc->fileName);
1993 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
1994 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
1995 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
1997 (int)(hdr->Characteristics));
2000 /* If the string table size is way crazy, this might indicate that
2001 there are more than 64k relocations, despite claims to the
2002 contrary. Hence this test. */
2003 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2005 if ( (*(UInt32*)strtab) > 600000 ) {
2006 /* Note that 600k has no special significance other than being
2007 big enough to handle the almost-2MB-sized lumps that
2008 constitute HSwin32*.o. */
2009 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2014 /* No further verification after this point; only debug printing. */
2016 IF_DEBUG(linker, i=1);
2017 if (i == 0) return 1;
2019 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2020 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2021 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2024 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2025 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2026 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2027 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2028 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2029 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2030 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2032 /* Print the section table. */
2034 for (i = 0; i < hdr->NumberOfSections; i++) {
2036 COFF_section* sectab_i
2038 myindex ( sizeof_COFF_section, sectab, i );
2045 printName ( sectab_i->Name, strtab );
2055 sectab_i->VirtualSize,
2056 sectab_i->VirtualAddress,
2057 sectab_i->SizeOfRawData,
2058 sectab_i->PointerToRawData,
2059 sectab_i->NumberOfRelocations,
2060 sectab_i->PointerToRelocations,
2061 sectab_i->PointerToRawData
2063 reltab = (COFF_reloc*) (
2064 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2067 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2068 /* If the relocation field (a short) has overflowed, the
2069 * real count can be found in the first reloc entry.
2071 * See Section 4.1 (last para) of the PE spec (rev6.0).
2073 COFF_reloc* rel = (COFF_reloc*)
2074 myindex ( sizeof_COFF_reloc, reltab, 0 );
2075 noRelocs = rel->VirtualAddress;
2078 noRelocs = sectab_i->NumberOfRelocations;
2082 for (; j < noRelocs; j++) {
2084 COFF_reloc* rel = (COFF_reloc*)
2085 myindex ( sizeof_COFF_reloc, reltab, j );
2087 " type 0x%-4x vaddr 0x%-8x name `",
2089 rel->VirtualAddress );
2090 sym = (COFF_symbol*)
2091 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2092 /* Hmm..mysterious looking offset - what's it for? SOF */
2093 printName ( sym->Name, strtab -10 );
2100 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2101 debugBelch("---START of string table---\n");
2102 for (i = 4; i < *(Int32*)strtab; i++) {
2104 debugBelch("\n"); else
2105 debugBelch("%c", strtab[i] );
2107 debugBelch("--- END of string table---\n");
2112 COFF_symbol* symtab_i;
2113 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2114 symtab_i = (COFF_symbol*)
2115 myindex ( sizeof_COFF_symbol, symtab, i );
2121 printName ( symtab_i->Name, strtab );
2130 (Int32)(symtab_i->SectionNumber),
2131 (UInt32)symtab_i->Type,
2132 (UInt32)symtab_i->StorageClass,
2133 (UInt32)symtab_i->NumberOfAuxSymbols
2135 i += symtab_i->NumberOfAuxSymbols;
2145 ocGetNames_PEi386 ( ObjectCode* oc )
2148 COFF_section* sectab;
2149 COFF_symbol* symtab;
2156 hdr = (COFF_header*)(oc->image);
2157 sectab = (COFF_section*) (
2158 ((UChar*)(oc->image))
2159 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2161 symtab = (COFF_symbol*) (
2162 ((UChar*)(oc->image))
2163 + hdr->PointerToSymbolTable
2165 strtab = ((UChar*)(oc->image))
2166 + hdr->PointerToSymbolTable
2167 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2169 /* Allocate space for any (local, anonymous) .bss sections. */
2171 for (i = 0; i < hdr->NumberOfSections; i++) {
2174 COFF_section* sectab_i
2176 myindex ( sizeof_COFF_section, sectab, i );
2177 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2178 /* sof 10/05: the PE spec text isn't too clear regarding what
2179 * the SizeOfRawData field is supposed to hold for object
2180 * file sections containing just uninitialized data -- for executables,
2181 * it is supposed to be zero; unclear what it's supposed to be
2182 * for object files. However, VirtualSize is guaranteed to be
2183 * zero for object files, which definitely suggests that SizeOfRawData
2184 * will be non-zero (where else would the size of this .bss section be
2185 * stored?) Looking at the COFF_section info for incoming object files,
2186 * this certainly appears to be the case.
2188 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2189 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2190 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2191 * variable decls into to the .bss section. (The specific function in Q which
2192 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2194 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2195 /* This is a non-empty .bss section. Allocate zeroed space for
2196 it, and set its PointerToRawData field such that oc->image +
2197 PointerToRawData == addr_of_zeroed_space. */
2198 bss_sz = sectab_i->VirtualSize;
2199 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2200 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2201 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2202 addProddableBlock(oc, zspace, bss_sz);
2203 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2206 /* Copy section information into the ObjectCode. */
2208 for (i = 0; i < hdr->NumberOfSections; i++) {
2214 = SECTIONKIND_OTHER;
2215 COFF_section* sectab_i
2217 myindex ( sizeof_COFF_section, sectab, i );
2218 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2221 /* I'm sure this is the Right Way to do it. However, the
2222 alternative of testing the sectab_i->Name field seems to
2223 work ok with Cygwin.
2225 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2226 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2227 kind = SECTIONKIND_CODE_OR_RODATA;
2230 if (0==strcmp(".text",sectab_i->Name) ||
2231 0==strcmp(".rdata",sectab_i->Name)||
2232 0==strcmp(".rodata",sectab_i->Name))
2233 kind = SECTIONKIND_CODE_OR_RODATA;
2234 if (0==strcmp(".data",sectab_i->Name) ||
2235 0==strcmp(".bss",sectab_i->Name))
2236 kind = SECTIONKIND_RWDATA;
2238 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2239 sz = sectab_i->SizeOfRawData;
2240 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2242 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2243 end = start + sz - 1;
2245 if (kind == SECTIONKIND_OTHER
2246 /* Ignore sections called which contain stabs debugging
2248 && 0 != strcmp(".stab", sectab_i->Name)
2249 && 0 != strcmp(".stabstr", sectab_i->Name)
2250 /* ignore constructor section for now */
2251 && 0 != strcmp(".ctors", sectab_i->Name)
2252 /* ignore section generated from .ident */
2253 && 0!= strcmp("/4", sectab_i->Name)
2255 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2259 if (kind != SECTIONKIND_OTHER && end >= start) {
2260 addSection(oc, kind, start, end);
2261 addProddableBlock(oc, start, end - start + 1);
2265 /* Copy exported symbols into the ObjectCode. */
2267 oc->n_symbols = hdr->NumberOfSymbols;
2268 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2269 "ocGetNames_PEi386(oc->symbols)");
2270 /* Call me paranoid; I don't care. */
2271 for (i = 0; i < oc->n_symbols; i++)
2272 oc->symbols[i] = NULL;
2276 COFF_symbol* symtab_i;
2277 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2278 symtab_i = (COFF_symbol*)
2279 myindex ( sizeof_COFF_symbol, symtab, i );
2283 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2284 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2285 /* This symbol is global and defined, viz, exported */
2286 /* for MYIMAGE_SYMCLASS_EXTERNAL
2287 && !MYIMAGE_SYM_UNDEFINED,
2288 the address of the symbol is:
2289 address of relevant section + offset in section
2291 COFF_section* sectabent
2292 = (COFF_section*) myindex ( sizeof_COFF_section,
2294 symtab_i->SectionNumber-1 );
2295 addr = ((UChar*)(oc->image))
2296 + (sectabent->PointerToRawData
2300 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2301 && symtab_i->Value > 0) {
2302 /* This symbol isn't in any section at all, ie, global bss.
2303 Allocate zeroed space for it. */
2304 addr = stgCallocBytes(1, symtab_i->Value,
2305 "ocGetNames_PEi386(non-anonymous bss)");
2306 addSection(oc, SECTIONKIND_RWDATA, addr,
2307 ((UChar*)addr) + symtab_i->Value - 1);
2308 addProddableBlock(oc, addr, symtab_i->Value);
2309 /* debugBelch("BSS section at 0x%x\n", addr); */
2312 if (addr != NULL ) {
2313 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2314 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2315 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2316 ASSERT(i >= 0 && i < oc->n_symbols);
2317 /* cstring_from_COFF_symbol_name always succeeds. */
2318 oc->symbols[i] = sname;
2319 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2323 "IGNORING symbol %d\n"
2327 printName ( symtab_i->Name, strtab );
2336 (Int32)(symtab_i->SectionNumber),
2337 (UInt32)symtab_i->Type,
2338 (UInt32)symtab_i->StorageClass,
2339 (UInt32)symtab_i->NumberOfAuxSymbols
2344 i += symtab_i->NumberOfAuxSymbols;
2353 ocResolve_PEi386 ( ObjectCode* oc )
2356 COFF_section* sectab;
2357 COFF_symbol* symtab;
2367 /* ToDo: should be variable-sized? But is at least safe in the
2368 sense of buffer-overrun-proof. */
2370 /* debugBelch("resolving for %s\n", oc->fileName); */
2372 hdr = (COFF_header*)(oc->image);
2373 sectab = (COFF_section*) (
2374 ((UChar*)(oc->image))
2375 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2377 symtab = (COFF_symbol*) (
2378 ((UChar*)(oc->image))
2379 + hdr->PointerToSymbolTable
2381 strtab = ((UChar*)(oc->image))
2382 + hdr->PointerToSymbolTable
2383 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2385 for (i = 0; i < hdr->NumberOfSections; i++) {
2386 COFF_section* sectab_i
2388 myindex ( sizeof_COFF_section, sectab, i );
2391 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2394 /* Ignore sections called which contain stabs debugging
2396 if (0 == strcmp(".stab", sectab_i->Name)
2397 || 0 == strcmp(".stabstr", sectab_i->Name)
2398 || 0 == strcmp(".ctors", sectab_i->Name))
2401 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2402 /* If the relocation field (a short) has overflowed, the
2403 * real count can be found in the first reloc entry.
2405 * See Section 4.1 (last para) of the PE spec (rev6.0).
2407 * Nov2003 update: the GNU linker still doesn't correctly
2408 * handle the generation of relocatable object files with
2409 * overflown relocations. Hence the output to warn of potential
2412 COFF_reloc* rel = (COFF_reloc*)
2413 myindex ( sizeof_COFF_reloc, reltab, 0 );
2414 noRelocs = rel->VirtualAddress;
2416 /* 10/05: we now assume (and check for) a GNU ld that is capable
2417 * of handling object files with (>2^16) of relocs.
2420 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2425 noRelocs = sectab_i->NumberOfRelocations;
2430 for (; j < noRelocs; j++) {
2432 COFF_reloc* reltab_j
2434 myindex ( sizeof_COFF_reloc, reltab, j );
2436 /* the location to patch */
2438 ((UChar*)(oc->image))
2439 + (sectab_i->PointerToRawData
2440 + reltab_j->VirtualAddress
2441 - sectab_i->VirtualAddress )
2443 /* the existing contents of pP */
2445 /* the symbol to connect to */
2446 sym = (COFF_symbol*)
2447 myindex ( sizeof_COFF_symbol,
2448 symtab, reltab_j->SymbolTableIndex );
2451 "reloc sec %2d num %3d: type 0x%-4x "
2452 "vaddr 0x%-8x name `",
2454 (UInt32)reltab_j->Type,
2455 reltab_j->VirtualAddress );
2456 printName ( sym->Name, strtab );
2457 debugBelch("'\n" ));
2459 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2460 COFF_section* section_sym
2461 = findPEi386SectionCalled ( oc, sym->Name );
2463 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2466 S = ((UInt32)(oc->image))
2467 + (section_sym->PointerToRawData
2470 copyName ( sym->Name, strtab, symbol, 1000-1 );
2471 S = (UInt32) lookupLocalSymbol( oc, symbol );
2472 if ((void*)S != NULL) goto foundit;
2473 S = (UInt32) lookupSymbol( symbol );
2474 if ((void*)S != NULL) goto foundit;
2475 zapTrailingAtSign ( symbol );
2476 S = (UInt32) lookupLocalSymbol( oc, symbol );
2477 if ((void*)S != NULL) goto foundit;
2478 S = (UInt32) lookupSymbol( symbol );
2479 if ((void*)S != NULL) goto foundit;
2480 /* Newline first because the interactive linker has printed "linking..." */
2481 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2485 checkProddableBlock(oc, pP);
2486 switch (reltab_j->Type) {
2487 case MYIMAGE_REL_I386_DIR32:
2490 case MYIMAGE_REL_I386_REL32:
2491 /* Tricky. We have to insert a displacement at
2492 pP which, when added to the PC for the _next_
2493 insn, gives the address of the target (S).
2494 Problem is to know the address of the next insn
2495 when we only know pP. We assume that this
2496 literal field is always the last in the insn,
2497 so that the address of the next insn is pP+4
2498 -- hence the constant 4.
2499 Also I don't know if A should be added, but so
2500 far it has always been zero.
2502 SOF 05/2005: 'A' (old contents of *pP) have been observed
2503 to contain values other than zero (the 'wx' object file
2504 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2505 So, add displacement to old value instead of asserting
2506 A to be zero. Fixes wxhaskell-related crashes, and no other
2507 ill effects have been observed.
2509 Update: the reason why we're seeing these more elaborate
2510 relocations is due to a switch in how the NCG compiles SRTs
2511 and offsets to them from info tables. SRTs live in .(ro)data,
2512 while info tables live in .text, causing GAS to emit REL32/DISP32
2513 relocations with non-zero values. Adding the displacement is
2514 the right thing to do.
2516 *pP = S - ((UInt32)pP) - 4 + A;
2519 debugBelch("%s: unhandled PEi386 relocation type %d",
2520 oc->fileName, reltab_j->Type);
2527 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2531 #endif /* defined(OBJFORMAT_PEi386) */
2534 /* --------------------------------------------------------------------------
2536 * ------------------------------------------------------------------------*/
2538 #if defined(OBJFORMAT_ELF)
2543 #if defined(sparc_HOST_ARCH)
2544 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2545 #elif defined(i386_HOST_ARCH)
2546 # define ELF_TARGET_386 /* Used inside <elf.h> */
2547 #elif defined(x86_64_HOST_ARCH)
2548 # define ELF_TARGET_X64_64
2550 #elif defined (ia64_HOST_ARCH)
2551 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2553 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2554 # define ELF_NEED_GOT /* needs Global Offset Table */
2555 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2558 #if !defined(openbsd_HOST_OS)
2560 # ifndef R_X86_64_PC64 /* If elf.h doesn't define it */
2561 # define R_X86_64_PC64 24
2564 /* openbsd elf has things in different places, with diff names */
2565 # include <elf_abi.h>
2566 # include <machine/reloc.h>
2567 # define R_386_32 RELOC_32
2568 # define R_386_PC32 RELOC_PC32
2572 * Define a set of types which can be used for both ELF32 and ELF64
2576 #define ELFCLASS ELFCLASS64
2577 #define Elf_Addr Elf64_Addr
2578 #define Elf_Word Elf64_Word
2579 #define Elf_Sword Elf64_Sword
2580 #define Elf_Ehdr Elf64_Ehdr
2581 #define Elf_Phdr Elf64_Phdr
2582 #define Elf_Shdr Elf64_Shdr
2583 #define Elf_Sym Elf64_Sym
2584 #define Elf_Rel Elf64_Rel
2585 #define Elf_Rela Elf64_Rela
2586 #define ELF_ST_TYPE ELF64_ST_TYPE
2587 #define ELF_ST_BIND ELF64_ST_BIND
2588 #define ELF_R_TYPE ELF64_R_TYPE
2589 #define ELF_R_SYM ELF64_R_SYM
2591 #define ELFCLASS ELFCLASS32
2592 #define Elf_Addr Elf32_Addr
2593 #define Elf_Word Elf32_Word
2594 #define Elf_Sword Elf32_Sword
2595 #define Elf_Ehdr Elf32_Ehdr
2596 #define Elf_Phdr Elf32_Phdr
2597 #define Elf_Shdr Elf32_Shdr
2598 #define Elf_Sym Elf32_Sym
2599 #define Elf_Rel Elf32_Rel
2600 #define Elf_Rela Elf32_Rela
2602 #define ELF_ST_TYPE ELF32_ST_TYPE
2605 #define ELF_ST_BIND ELF32_ST_BIND
2608 #define ELF_R_TYPE ELF32_R_TYPE
2611 #define ELF_R_SYM ELF32_R_SYM
2617 * Functions to allocate entries in dynamic sections. Currently we simply
2618 * preallocate a large number, and we don't check if a entry for the given
2619 * target already exists (a linear search is too slow). Ideally these
2620 * entries would be associated with symbols.
2623 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2624 #define GOT_SIZE 0x20000
2625 #define FUNCTION_TABLE_SIZE 0x10000
2626 #define PLT_SIZE 0x08000
2629 static Elf_Addr got[GOT_SIZE];
2630 static unsigned int gotIndex;
2631 static Elf_Addr gp_val = (Elf_Addr)got;
2634 allocateGOTEntry(Elf_Addr target)
2638 if (gotIndex >= GOT_SIZE)
2639 barf("Global offset table overflow");
2641 entry = &got[gotIndex++];
2643 return (Elf_Addr)entry;
2647 #ifdef ELF_FUNCTION_DESC
2653 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2654 static unsigned int functionTableIndex;
2657 allocateFunctionDesc(Elf_Addr target)
2659 FunctionDesc *entry;
2661 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2662 barf("Function table overflow");
2664 entry = &functionTable[functionTableIndex++];
2666 entry->gp = (Elf_Addr)gp_val;
2667 return (Elf_Addr)entry;
2671 copyFunctionDesc(Elf_Addr target)
2673 FunctionDesc *olddesc = (FunctionDesc *)target;
2674 FunctionDesc *newdesc;
2676 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2677 newdesc->gp = olddesc->gp;
2678 return (Elf_Addr)newdesc;
2683 #ifdef ia64_HOST_ARCH
2684 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2685 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2687 static unsigned char plt_code[] =
2689 /* taken from binutils bfd/elfxx-ia64.c */
2690 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2691 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2692 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2693 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2694 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2695 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2698 /* If we can't get to the function descriptor via gp, take a local copy of it */
2699 #define PLT_RELOC(code, target) { \
2700 Elf64_Sxword rel_value = target - gp_val; \
2701 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2702 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2704 ia64_reloc_gprel22((Elf_Addr)code, target); \
2709 unsigned char code[sizeof(plt_code)];
2713 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2715 PLTEntry *plt = (PLTEntry *)oc->plt;
2718 if (oc->pltIndex >= PLT_SIZE)
2719 barf("Procedure table overflow");
2721 entry = &plt[oc->pltIndex++];
2722 memcpy(entry->code, plt_code, sizeof(entry->code));
2723 PLT_RELOC(entry->code, target);
2724 return (Elf_Addr)entry;
2730 return (PLT_SIZE * sizeof(PLTEntry));
2735 #if x86_64_HOST_ARCH
2736 // On x86_64, 32-bit relocations are often used, which requires that
2737 // we can resolve a symbol to a 32-bit offset. However, shared
2738 // libraries are placed outside the 2Gb area, which leaves us with a
2739 // problem when we need to give a 32-bit offset to a symbol in a
2742 // For a function symbol, we can allocate a bounce sequence inside the
2743 // 2Gb area and resolve the symbol to this. The bounce sequence is
2744 // simply a long jump instruction to the real location of the symbol.
2746 // For data references, we're screwed.
2749 unsigned char jmp[8]; /* 6 byte instruction: jmpq *0x00000002(%rip) */
2753 #define X86_64_BB_SIZE 1024
2755 static x86_64_bounce *x86_64_bounce_buffer = NULL;
2756 static nat x86_64_bb_next_off;
2759 x86_64_high_symbol( char *lbl, void *addr )
2761 x86_64_bounce *bounce;
2763 if ( x86_64_bounce_buffer == NULL ||
2764 x86_64_bb_next_off >= X86_64_BB_SIZE ) {
2765 x86_64_bounce_buffer =
2766 mmap(NULL, X86_64_BB_SIZE * sizeof(x86_64_bounce),
2767 PROT_EXEC|PROT_READ|PROT_WRITE,
2768 MAP_PRIVATE|MAP_32BIT|MAP_ANONYMOUS, -1, 0);
2769 if (x86_64_bounce_buffer == MAP_FAILED) {
2770 barf("x86_64_high_symbol: mmap failed");
2772 x86_64_bb_next_off = 0;
2774 bounce = &x86_64_bounce_buffer[x86_64_bb_next_off];
2775 bounce->jmp[0] = 0xff;
2776 bounce->jmp[1] = 0x25;
2777 bounce->jmp[2] = 0x02;
2778 bounce->jmp[3] = 0x00;
2779 bounce->jmp[4] = 0x00;
2780 bounce->jmp[5] = 0x00;
2781 bounce->addr = addr;
2782 x86_64_bb_next_off++;
2784 IF_DEBUG(linker, debugBelch("x86_64: allocated bounce entry for %s->%p at %p\n",
2785 lbl, addr, bounce));
2787 insertStrHashTable(symhash, lbl, bounce);
2794 * Generic ELF functions
2798 findElfSection ( void* objImage, Elf_Word sh_type )
2800 char* ehdrC = (char*)objImage;
2801 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2802 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2803 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2807 for (i = 0; i < ehdr->e_shnum; i++) {
2808 if (shdr[i].sh_type == sh_type
2809 /* Ignore the section header's string table. */
2810 && i != ehdr->e_shstrndx
2811 /* Ignore string tables named .stabstr, as they contain
2813 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2815 ptr = ehdrC + shdr[i].sh_offset;
2822 #if defined(ia64_HOST_ARCH)
2824 findElfSegment ( void* objImage, Elf_Addr vaddr )
2826 char* ehdrC = (char*)objImage;
2827 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2828 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2829 Elf_Addr segaddr = 0;
2832 for (i = 0; i < ehdr->e_phnum; i++) {
2833 segaddr = phdr[i].p_vaddr;
2834 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2842 ocVerifyImage_ELF ( ObjectCode* oc )
2846 int i, j, nent, nstrtab, nsymtabs;
2850 char* ehdrC = (char*)(oc->image);
2851 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2853 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2854 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2855 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2856 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2857 errorBelch("%s: not an ELF object", oc->fileName);
2861 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2862 errorBelch("%s: unsupported ELF format", oc->fileName);
2866 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2867 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2869 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2870 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2872 errorBelch("%s: unknown endiannness", oc->fileName);
2876 if (ehdr->e_type != ET_REL) {
2877 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2880 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2882 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2883 switch (ehdr->e_machine) {
2884 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2885 #ifdef EM_SPARC32PLUS
2886 case EM_SPARC32PLUS:
2888 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2890 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2892 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2894 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2896 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2897 errorBelch("%s: unknown architecture", oc->fileName);
2901 IF_DEBUG(linker,debugBelch(
2902 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2903 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2905 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2907 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2909 if (ehdr->e_shstrndx == SHN_UNDEF) {
2910 errorBelch("%s: no section header string table", oc->fileName);
2913 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2915 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2918 for (i = 0; i < ehdr->e_shnum; i++) {
2919 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2920 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2921 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2922 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2923 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2924 ehdrC + shdr[i].sh_offset,
2925 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2927 if (shdr[i].sh_type == SHT_REL) {
2928 IF_DEBUG(linker,debugBelch("Rel " ));
2929 } else if (shdr[i].sh_type == SHT_RELA) {
2930 IF_DEBUG(linker,debugBelch("RelA " ));
2932 IF_DEBUG(linker,debugBelch(" "));
2935 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2939 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2942 for (i = 0; i < ehdr->e_shnum; i++) {
2943 if (shdr[i].sh_type == SHT_STRTAB
2944 /* Ignore the section header's string table. */
2945 && i != ehdr->e_shstrndx
2946 /* Ignore string tables named .stabstr, as they contain
2948 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2950 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2951 strtab = ehdrC + shdr[i].sh_offset;
2956 errorBelch("%s: no string tables, or too many", oc->fileName);
2961 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2962 for (i = 0; i < ehdr->e_shnum; i++) {
2963 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2964 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2966 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2967 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2968 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2970 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2972 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2973 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2976 for (j = 0; j < nent; j++) {
2977 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2978 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2979 (int)stab[j].st_shndx,
2980 (int)stab[j].st_size,
2981 (char*)stab[j].st_value ));
2983 IF_DEBUG(linker,debugBelch("type=" ));
2984 switch (ELF_ST_TYPE(stab[j].st_info)) {
2985 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2986 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2987 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2988 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
2989 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
2990 default: IF_DEBUG(linker,debugBelch("? " )); break;
2992 IF_DEBUG(linker,debugBelch(" " ));
2994 IF_DEBUG(linker,debugBelch("bind=" ));
2995 switch (ELF_ST_BIND(stab[j].st_info)) {
2996 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
2997 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
2998 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
2999 default: IF_DEBUG(linker,debugBelch("? " )); break;
3001 IF_DEBUG(linker,debugBelch(" " ));
3003 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
3007 if (nsymtabs == 0) {
3008 errorBelch("%s: didn't find any symbol tables", oc->fileName);
3015 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
3019 if (hdr->sh_type == SHT_PROGBITS
3020 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
3021 /* .text-style section */
3022 return SECTIONKIND_CODE_OR_RODATA;
3025 if (hdr->sh_type == SHT_PROGBITS
3026 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3027 /* .data-style section */
3028 return SECTIONKIND_RWDATA;
3031 if (hdr->sh_type == SHT_PROGBITS
3032 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3033 /* .rodata-style section */
3034 return SECTIONKIND_CODE_OR_RODATA;
3037 if (hdr->sh_type == SHT_NOBITS
3038 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3039 /* .bss-style section */
3041 return SECTIONKIND_RWDATA;
3044 return SECTIONKIND_OTHER;
3049 ocGetNames_ELF ( ObjectCode* oc )
3054 char* ehdrC = (char*)(oc->image);
3055 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3056 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3057 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3059 ASSERT(symhash != NULL);
3062 errorBelch("%s: no strtab", oc->fileName);
3067 for (i = 0; i < ehdr->e_shnum; i++) {
3068 /* Figure out what kind of section it is. Logic derived from
3069 Figure 1.14 ("Special Sections") of the ELF document
3070 ("Portable Formats Specification, Version 1.1"). */
3072 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3074 if (is_bss && shdr[i].sh_size > 0) {
3075 /* This is a non-empty .bss section. Allocate zeroed space for
3076 it, and set its .sh_offset field such that
3077 ehdrC + .sh_offset == addr_of_zeroed_space. */
3078 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3079 "ocGetNames_ELF(BSS)");
3080 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3082 debugBelch("BSS section at 0x%x, size %d\n",
3083 zspace, shdr[i].sh_size);
3087 /* fill in the section info */
3088 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3089 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3090 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3091 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3094 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3096 /* copy stuff into this module's object symbol table */
3097 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3098 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3100 oc->n_symbols = nent;
3101 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3102 "ocGetNames_ELF(oc->symbols)");
3104 for (j = 0; j < nent; j++) {
3106 char isLocal = FALSE; /* avoids uninit-var warning */
3108 char* nm = strtab + stab[j].st_name;
3109 int secno = stab[j].st_shndx;
3111 /* Figure out if we want to add it; if so, set ad to its
3112 address. Otherwise leave ad == NULL. */
3114 if (secno == SHN_COMMON) {
3116 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3118 debugBelch("COMMON symbol, size %d name %s\n",
3119 stab[j].st_size, nm);
3121 /* Pointless to do addProddableBlock() for this area,
3122 since the linker should never poke around in it. */
3125 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3126 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3128 /* and not an undefined symbol */
3129 && stab[j].st_shndx != SHN_UNDEF
3130 /* and not in a "special section" */
3131 && stab[j].st_shndx < SHN_LORESERVE
3133 /* and it's a not a section or string table or anything silly */
3134 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3135 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3136 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3139 /* Section 0 is the undefined section, hence > and not >=. */
3140 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3142 if (shdr[secno].sh_type == SHT_NOBITS) {
3143 debugBelch(" BSS symbol, size %d off %d name %s\n",
3144 stab[j].st_size, stab[j].st_value, nm);
3147 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3148 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3151 #ifdef ELF_FUNCTION_DESC
3152 /* dlsym() and the initialisation table both give us function
3153 * descriptors, so to be consistent we store function descriptors
3154 * in the symbol table */
3155 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3156 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3158 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3159 ad, oc->fileName, nm ));
3164 /* And the decision is ... */
3168 oc->symbols[j] = nm;
3171 /* Ignore entirely. */
3173 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3177 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3178 strtab + stab[j].st_name ));
3181 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3182 (int)ELF_ST_BIND(stab[j].st_info),
3183 (int)ELF_ST_TYPE(stab[j].st_info),
3184 (int)stab[j].st_shndx,
3185 strtab + stab[j].st_name
3188 oc->symbols[j] = NULL;
3197 /* Do ELF relocations which lack an explicit addend. All x86-linux
3198 relocations appear to be of this form. */
3200 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3201 Elf_Shdr* shdr, int shnum,
3202 Elf_Sym* stab, char* strtab )
3207 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3208 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3209 int target_shndx = shdr[shnum].sh_info;
3210 int symtab_shndx = shdr[shnum].sh_link;
3212 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3213 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3214 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3215 target_shndx, symtab_shndx ));
3217 /* Skip sections that we're not interested in. */
3220 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3221 if (kind == SECTIONKIND_OTHER) {
3222 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3227 for (j = 0; j < nent; j++) {
3228 Elf_Addr offset = rtab[j].r_offset;
3229 Elf_Addr info = rtab[j].r_info;
3231 Elf_Addr P = ((Elf_Addr)targ) + offset;
3232 Elf_Word* pP = (Elf_Word*)P;
3237 StgStablePtr stablePtr;
3240 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3241 j, (void*)offset, (void*)info ));
3243 IF_DEBUG(linker,debugBelch( " ZERO" ));
3246 Elf_Sym sym = stab[ELF_R_SYM(info)];
3247 /* First see if it is a local symbol. */
3248 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3249 /* Yes, so we can get the address directly from the ELF symbol
3251 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3253 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3254 + stab[ELF_R_SYM(info)].st_value);
3257 symbol = strtab + sym.st_name;
3258 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3259 if (NULL == stablePtr) {
3260 /* No, so look up the name in our global table. */
3261 S_tmp = lookupSymbol( symbol );
3262 S = (Elf_Addr)S_tmp;
3264 stableVal = deRefStablePtr( stablePtr );
3266 S = (Elf_Addr)S_tmp;
3270 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3273 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3276 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3277 (void*)P, (void*)S, (void*)A ));
3278 checkProddableBlock ( oc, pP );
3282 switch (ELF_R_TYPE(info)) {
3283 # ifdef i386_HOST_ARCH
3284 case R_386_32: *pP = value; break;
3285 case R_386_PC32: *pP = value - P; break;
3288 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3289 oc->fileName, (lnat)ELF_R_TYPE(info));
3297 /* Do ELF relocations for which explicit addends are supplied.
3298 sparc-solaris relocations appear to be of this form. */
3300 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3301 Elf_Shdr* shdr, int shnum,
3302 Elf_Sym* stab, char* strtab )
3305 char *symbol = NULL;
3307 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3308 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3309 int target_shndx = shdr[shnum].sh_info;
3310 int symtab_shndx = shdr[shnum].sh_link;
3312 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3313 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3314 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3315 target_shndx, symtab_shndx ));
3317 for (j = 0; j < nent; j++) {
3318 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3319 /* This #ifdef only serves to avoid unused-var warnings. */
3320 Elf_Addr offset = rtab[j].r_offset;
3321 Elf_Addr P = targ + offset;
3323 Elf_Addr info = rtab[j].r_info;
3324 Elf_Addr A = rtab[j].r_addend;
3328 # if defined(sparc_HOST_ARCH)
3329 Elf_Word* pP = (Elf_Word*)P;
3331 # elif defined(ia64_HOST_ARCH)
3332 Elf64_Xword *pP = (Elf64_Xword *)P;
3334 # elif defined(powerpc_HOST_ARCH)
3338 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3339 j, (void*)offset, (void*)info,
3342 IF_DEBUG(linker,debugBelch( " ZERO" ));
3345 Elf_Sym sym = stab[ELF_R_SYM(info)];
3346 /* First see if it is a local symbol. */
3347 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3348 /* Yes, so we can get the address directly from the ELF symbol
3350 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3352 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3353 + stab[ELF_R_SYM(info)].st_value);
3354 #ifdef ELF_FUNCTION_DESC
3355 /* Make a function descriptor for this function */
3356 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3357 S = allocateFunctionDesc(S + A);
3362 /* No, so look up the name in our global table. */
3363 symbol = strtab + sym.st_name;
3364 S_tmp = lookupSymbol( symbol );
3365 S = (Elf_Addr)S_tmp;
3367 #ifdef ELF_FUNCTION_DESC
3368 /* If a function, already a function descriptor - we would
3369 have to copy it to add an offset. */
3370 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3371 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3375 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3378 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3381 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3382 (void*)P, (void*)S, (void*)A ));
3383 /* checkProddableBlock ( oc, (void*)P ); */
3387 switch (ELF_R_TYPE(info)) {
3388 # if defined(sparc_HOST_ARCH)
3389 case R_SPARC_WDISP30:
3390 w1 = *pP & 0xC0000000;
3391 w2 = (Elf_Word)((value - P) >> 2);
3392 ASSERT((w2 & 0xC0000000) == 0);
3397 w1 = *pP & 0xFFC00000;
3398 w2 = (Elf_Word)(value >> 10);
3399 ASSERT((w2 & 0xFFC00000) == 0);
3405 w2 = (Elf_Word)(value & 0x3FF);
3406 ASSERT((w2 & ~0x3FF) == 0);
3410 /* According to the Sun documentation:
3412 This relocation type resembles R_SPARC_32, except it refers to an
3413 unaligned word. That is, the word to be relocated must be treated
3414 as four separate bytes with arbitrary alignment, not as a word
3415 aligned according to the architecture requirements.
3417 (JRS: which means that freeloading on the R_SPARC_32 case
3418 is probably wrong, but hey ...)
3422 w2 = (Elf_Word)value;
3425 # elif defined(ia64_HOST_ARCH)
3426 case R_IA64_DIR64LSB:
3427 case R_IA64_FPTR64LSB:
3430 case R_IA64_PCREL64LSB:
3433 case R_IA64_SEGREL64LSB:
3434 addr = findElfSegment(ehdrC, value);
3437 case R_IA64_GPREL22:
3438 ia64_reloc_gprel22(P, value);
3440 case R_IA64_LTOFF22:
3441 case R_IA64_LTOFF22X:
3442 case R_IA64_LTOFF_FPTR22:
3443 addr = allocateGOTEntry(value);
3444 ia64_reloc_gprel22(P, addr);
3446 case R_IA64_PCREL21B:
3447 ia64_reloc_pcrel21(P, S, oc);
3450 /* This goes with R_IA64_LTOFF22X and points to the load to
3451 * convert into a move. We don't implement relaxation. */
3453 # elif defined(powerpc_HOST_ARCH)
3454 case R_PPC_ADDR16_LO:
3455 *(Elf32_Half*) P = value;
3458 case R_PPC_ADDR16_HI:
3459 *(Elf32_Half*) P = value >> 16;
3462 case R_PPC_ADDR16_HA:
3463 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3467 *(Elf32_Word *) P = value;
3471 *(Elf32_Word *) P = value - P;
3477 if( delta << 6 >> 6 != delta )
3479 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3483 if( value == 0 || delta << 6 >> 6 != delta )
3485 barf( "Unable to make SymbolExtra for #%d",
3491 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3492 | (delta & 0x3fffffc);
3496 #if x86_64_HOST_ARCH
3498 *(Elf64_Xword *)P = value;
3503 StgInt64 off = value - P;
3504 if (off >= 0x7fffffffL || off < -0x80000000L) {
3505 barf("R_X86_64_PC32 relocation out of range: %s = %p",
3508 *(Elf64_Word *)P = (Elf64_Word)off;
3514 StgInt64 off = value - P;
3515 *(Elf64_Word *)P = (Elf64_Word)off;
3520 if (value >= 0x7fffffffL) {
3521 barf("R_X86_64_32 relocation out of range: %s = %p\n",
3524 *(Elf64_Word *)P = (Elf64_Word)value;
3528 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3529 barf("R_X86_64_32S relocation out of range: %s = %p\n",
3532 *(Elf64_Sword *)P = (Elf64_Sword)value;
3537 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3538 oc->fileName, (lnat)ELF_R_TYPE(info));
3547 ocResolve_ELF ( ObjectCode* oc )
3551 Elf_Sym* stab = NULL;
3552 char* ehdrC = (char*)(oc->image);
3553 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3554 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3556 /* first find "the" symbol table */
3557 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3559 /* also go find the string table */
3560 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3562 if (stab == NULL || strtab == NULL) {
3563 errorBelch("%s: can't find string or symbol table", oc->fileName);
3567 /* Process the relocation sections. */
3568 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3569 if (shdr[shnum].sh_type == SHT_REL) {
3570 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3571 shnum, stab, strtab );
3575 if (shdr[shnum].sh_type == SHT_RELA) {
3576 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3577 shnum, stab, strtab );
3582 /* Free the local symbol table; we won't need it again. */
3583 freeHashTable(oc->lochash, NULL);
3586 #if defined(powerpc_HOST_ARCH)
3587 ocFlushInstructionCache( oc );
3595 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3596 * at the front. The following utility functions pack and unpack instructions, and
3597 * take care of the most common relocations.
3600 #ifdef ia64_HOST_ARCH
3603 ia64_extract_instruction(Elf64_Xword *target)
3606 int slot = (Elf_Addr)target & 3;
3607 target = (Elf_Addr)target & ~3;
3615 return ((w1 >> 5) & 0x1ffffffffff);
3617 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3621 barf("ia64_extract_instruction: invalid slot %p", target);
3626 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3628 int slot = (Elf_Addr)target & 3;
3629 target = (Elf_Addr)target & ~3;
3634 *target |= value << 5;
3637 *target |= value << 46;
3638 *(target+1) |= value >> 18;
3641 *(target+1) |= value << 23;
3647 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3649 Elf64_Xword instruction;
3650 Elf64_Sxword rel_value;
3652 rel_value = value - gp_val;
3653 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3654 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3656 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3657 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3658 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3659 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3660 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3661 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3665 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3667 Elf64_Xword instruction;
3668 Elf64_Sxword rel_value;
3671 entry = allocatePLTEntry(value, oc);
3673 rel_value = (entry >> 4) - (target >> 4);
3674 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3675 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3677 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3678 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3679 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3680 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3686 * PowerPC ELF specifics
3689 #ifdef powerpc_HOST_ARCH
3691 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3697 ehdr = (Elf_Ehdr *) oc->image;
3698 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3700 for( i = 0; i < ehdr->e_shnum; i++ )
3701 if( shdr[i].sh_type == SHT_SYMTAB )
3704 if( i == ehdr->e_shnum )
3706 errorBelch( "This ELF file contains no symtab" );
3710 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3712 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3713 shdr[i].sh_entsize, sizeof( Elf_Sym ) );
3718 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3721 #endif /* powerpc */
3725 /* --------------------------------------------------------------------------
3727 * ------------------------------------------------------------------------*/
3729 #if defined(OBJFORMAT_MACHO)
3732 Support for MachO linking on Darwin/MacOS X
3733 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3735 I hereby formally apologize for the hackish nature of this code.
3736 Things that need to be done:
3737 *) implement ocVerifyImage_MachO
3738 *) add still more sanity checks.
3741 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3742 #define mach_header mach_header_64
3743 #define segment_command segment_command_64
3744 #define section section_64
3745 #define nlist nlist_64
3748 #ifdef powerpc_HOST_ARCH
3749 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3751 struct mach_header *header = (struct mach_header *) oc->image;
3752 struct load_command *lc = (struct load_command *) (header + 1);
3755 for( i = 0; i < header->ncmds; i++ )
3757 if( lc->cmd == LC_SYMTAB )
3759 // Find out the first and last undefined external
3760 // symbol, so we don't have to allocate too many
3762 struct symtab_command *symLC = (struct symtab_command *) lc;
3763 unsigned min = symLC->nsyms, max = 0;
3764 struct nlist *nlist =
3765 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3767 for(i=0;i<symLC->nsyms;i++)
3769 if(nlist[i].n_type & N_STAB)
3771 else if(nlist[i].n_type & N_EXT)
3773 if((nlist[i].n_type & N_TYPE) == N_UNDF
3774 && (nlist[i].n_value == 0))
3784 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3789 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3791 return ocAllocateSymbolExtras(oc,0,0);
3794 #ifdef x86_64_HOST_ARCH
3795 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3797 struct mach_header *header = (struct mach_header *) oc->image;
3798 struct load_command *lc = (struct load_command *) (header + 1);
3801 for( i = 0; i < header->ncmds; i++ )
3803 if( lc->cmd == LC_SYMTAB )
3805 // Just allocate one entry for every symbol
3806 struct symtab_command *symLC = (struct symtab_command *) lc;
3808 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3811 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3813 return ocAllocateSymbolExtras(oc,0,0);
3817 static int ocVerifyImage_MachO(ObjectCode* oc)
3819 char *image = (char*) oc->image;
3820 struct mach_header *header = (struct mach_header*) image;
3822 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3823 if(header->magic != MH_MAGIC_64)
3826 if(header->magic != MH_MAGIC)
3829 // FIXME: do some more verifying here
3833 static int resolveImports(
3836 struct symtab_command *symLC,
3837 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3838 unsigned long *indirectSyms,
3839 struct nlist *nlist)
3842 size_t itemSize = 4;
3845 int isJumpTable = 0;
3846 if(!strcmp(sect->sectname,"__jump_table"))
3850 ASSERT(sect->reserved2 == itemSize);
3854 for(i=0; i*itemSize < sect->size;i++)
3856 // according to otool, reserved1 contains the first index into the indirect symbol table
3857 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3858 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3861 if((symbol->n_type & N_TYPE) == N_UNDF
3862 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3863 addr = (void*) (symbol->n_value);
3864 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3867 addr = lookupSymbol(nm);
3870 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3878 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3879 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3880 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3881 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3886 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3887 ((void**)(image + sect->offset))[i] = addr;
3894 static unsigned long relocateAddress(
3897 struct section* sections,
3898 unsigned long address)
3901 for(i = 0; i < nSections; i++)
3903 if(sections[i].addr <= address
3904 && address < sections[i].addr + sections[i].size)
3906 return (unsigned long)oc->image
3907 + sections[i].offset + address - sections[i].addr;
3910 barf("Invalid Mach-O file:"
3911 "Address out of bounds while relocating object file");
3915 static int relocateSection(
3918 struct symtab_command *symLC, struct nlist *nlist,
3919 int nSections, struct section* sections, struct section *sect)
3921 struct relocation_info *relocs;
3924 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3926 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3928 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3930 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3934 relocs = (struct relocation_info*) (image + sect->reloff);
3938 #ifdef x86_64_HOST_ARCH
3939 struct relocation_info *reloc = &relocs[i];
3941 char *thingPtr = image + sect->offset + reloc->r_address;
3945 int type = reloc->r_type;
3947 checkProddableBlock(oc,thingPtr);
3948 switch(reloc->r_length)
3951 thing = *(uint8_t*)thingPtr;
3952 baseValue = (uint64_t)thingPtr + 1;
3955 thing = *(uint16_t*)thingPtr;
3956 baseValue = (uint64_t)thingPtr + 2;
3959 thing = *(uint32_t*)thingPtr;
3960 baseValue = (uint64_t)thingPtr + 4;
3963 thing = *(uint64_t*)thingPtr;
3964 baseValue = (uint64_t)thingPtr + 8;
3967 barf("Unknown size.");
3970 if(type == X86_64_RELOC_GOT
3971 || type == X86_64_RELOC_GOT_LOAD)
3973 ASSERT(reloc->r_extern);
3974 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
3976 type = X86_64_RELOC_SIGNED;
3978 else if(reloc->r_extern)
3980 struct nlist *symbol = &nlist[reloc->r_symbolnum];
3981 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3982 if(symbol->n_value == 0)
3983 value = (uint64_t) lookupSymbol(nm);
3985 value = relocateAddress(oc, nSections, sections,
3990 value = sections[reloc->r_symbolnum-1].offset
3991 - sections[reloc->r_symbolnum-1].addr
3995 if(type == X86_64_RELOC_BRANCH)
3997 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
3999 ASSERT(reloc->r_extern);
4000 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4003 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4004 type = X86_64_RELOC_SIGNED;
4009 case X86_64_RELOC_UNSIGNED:
4010 ASSERT(!reloc->r_pcrel);
4013 case X86_64_RELOC_SIGNED:
4014 ASSERT(reloc->r_pcrel);
4015 thing += value - baseValue;
4017 case X86_64_RELOC_SUBTRACTOR:
4018 ASSERT(!reloc->r_pcrel);
4022 barf("unkown relocation");
4025 switch(reloc->r_length)
4028 *(uint8_t*)thingPtr = thing;
4031 *(uint16_t*)thingPtr = thing;
4034 *(uint32_t*)thingPtr = thing;
4037 *(uint64_t*)thingPtr = thing;
4041 if(relocs[i].r_address & R_SCATTERED)
4043 struct scattered_relocation_info *scat =
4044 (struct scattered_relocation_info*) &relocs[i];
4048 if(scat->r_length == 2)
4050 unsigned long word = 0;
4051 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4052 checkProddableBlock(oc,wordPtr);
4054 // Note on relocation types:
4055 // i386 uses the GENERIC_RELOC_* types,
4056 // while ppc uses special PPC_RELOC_* types.
4057 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4058 // in both cases, all others are different.
4059 // Therefore, we use GENERIC_RELOC_VANILLA
4060 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4061 // and use #ifdefs for the other types.
4063 // Step 1: Figure out what the relocated value should be
4064 if(scat->r_type == GENERIC_RELOC_VANILLA)
4066 word = *wordPtr + (unsigned long) relocateAddress(
4073 #ifdef powerpc_HOST_ARCH
4074 else if(scat->r_type == PPC_RELOC_SECTDIFF
4075 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4076 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4077 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4079 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4082 struct scattered_relocation_info *pair =
4083 (struct scattered_relocation_info*) &relocs[i+1];
4085 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4086 barf("Invalid Mach-O file: "
4087 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4089 word = (unsigned long)
4090 (relocateAddress(oc, nSections, sections, scat->r_value)
4091 - relocateAddress(oc, nSections, sections, pair->r_value));
4094 #ifdef powerpc_HOST_ARCH
4095 else if(scat->r_type == PPC_RELOC_HI16
4096 || scat->r_type == PPC_RELOC_LO16
4097 || scat->r_type == PPC_RELOC_HA16
4098 || scat->r_type == PPC_RELOC_LO14)
4099 { // these are generated by label+offset things
4100 struct relocation_info *pair = &relocs[i+1];
4101 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4102 barf("Invalid Mach-O file: "
4103 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4105 if(scat->r_type == PPC_RELOC_LO16)
4107 word = ((unsigned short*) wordPtr)[1];
4108 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4110 else if(scat->r_type == PPC_RELOC_LO14)
4112 barf("Unsupported Relocation: PPC_RELOC_LO14");
4113 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4114 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4116 else if(scat->r_type == PPC_RELOC_HI16)
4118 word = ((unsigned short*) wordPtr)[1] << 16;
4119 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4121 else if(scat->r_type == PPC_RELOC_HA16)
4123 word = ((unsigned short*) wordPtr)[1] << 16;
4124 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4128 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4135 continue; // ignore the others
4137 #ifdef powerpc_HOST_ARCH
4138 if(scat->r_type == GENERIC_RELOC_VANILLA
4139 || scat->r_type == PPC_RELOC_SECTDIFF)
4141 if(scat->r_type == GENERIC_RELOC_VANILLA
4142 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4147 #ifdef powerpc_HOST_ARCH
4148 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4150 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4152 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4154 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4156 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4158 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4159 + ((word & (1<<15)) ? 1 : 0);
4165 continue; // FIXME: I hope it's OK to ignore all the others.
4169 struct relocation_info *reloc = &relocs[i];
4170 if(reloc->r_pcrel && !reloc->r_extern)
4173 if(reloc->r_length == 2)
4175 unsigned long word = 0;
4176 #ifdef powerpc_HOST_ARCH
4177 unsigned long jumpIsland = 0;
4178 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4179 // to avoid warning and to catch
4183 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4184 checkProddableBlock(oc,wordPtr);
4186 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4190 #ifdef powerpc_HOST_ARCH
4191 else if(reloc->r_type == PPC_RELOC_LO16)
4193 word = ((unsigned short*) wordPtr)[1];
4194 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4196 else if(reloc->r_type == PPC_RELOC_HI16)
4198 word = ((unsigned short*) wordPtr)[1] << 16;
4199 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4201 else if(reloc->r_type == PPC_RELOC_HA16)
4203 word = ((unsigned short*) wordPtr)[1] << 16;
4204 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4206 else if(reloc->r_type == PPC_RELOC_BR24)
4209 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4213 if(!reloc->r_extern)
4216 sections[reloc->r_symbolnum-1].offset
4217 - sections[reloc->r_symbolnum-1].addr
4224 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4225 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4226 void *symbolAddress = lookupSymbol(nm);
4229 errorBelch("\nunknown symbol `%s'", nm);
4235 #ifdef powerpc_HOST_ARCH
4236 // In the .o file, this should be a relative jump to NULL
4237 // and we'll change it to a relative jump to the symbol
4238 ASSERT(-word == reloc->r_address);
4239 jumpIsland = (unsigned long)
4240 &makeSymbolExtra(oc,
4242 (unsigned long) symbolAddress)
4246 offsetToJumpIsland = word + jumpIsland
4247 - (((long)image) + sect->offset - sect->addr);
4250 word += (unsigned long) symbolAddress
4251 - (((long)image) + sect->offset - sect->addr);
4255 word += (unsigned long) symbolAddress;
4259 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4264 #ifdef powerpc_HOST_ARCH
4265 else if(reloc->r_type == PPC_RELOC_LO16)
4267 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4270 else if(reloc->r_type == PPC_RELOC_HI16)
4272 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4275 else if(reloc->r_type == PPC_RELOC_HA16)
4277 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4278 + ((word & (1<<15)) ? 1 : 0);
4281 else if(reloc->r_type == PPC_RELOC_BR24)
4283 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4285 // The branch offset is too large.
4286 // Therefore, we try to use a jump island.
4289 barf("unconditional relative branch out of range: "
4290 "no jump island available");
4293 word = offsetToJumpIsland;
4294 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4295 barf("unconditional relative branch out of range: "
4296 "jump island out of range");
4298 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4303 barf("\nunknown relocation %d",reloc->r_type);
4311 static int ocGetNames_MachO(ObjectCode* oc)
4313 char *image = (char*) oc->image;
4314 struct mach_header *header = (struct mach_header*) image;
4315 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4316 unsigned i,curSymbol = 0;
4317 struct segment_command *segLC = NULL;
4318 struct section *sections;
4319 struct symtab_command *symLC = NULL;
4320 struct nlist *nlist;
4321 unsigned long commonSize = 0;
4322 char *commonStorage = NULL;
4323 unsigned long commonCounter;
4325 for(i=0;i<header->ncmds;i++)
4327 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4328 segLC = (struct segment_command*) lc;
4329 else if(lc->cmd == LC_SYMTAB)
4330 symLC = (struct symtab_command*) lc;
4331 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4334 sections = (struct section*) (segLC+1);
4335 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4339 barf("ocGetNames_MachO: no segment load command");
4341 for(i=0;i<segLC->nsects;i++)
4343 if(sections[i].size == 0)
4346 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4348 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4349 "ocGetNames_MachO(common symbols)");
4350 sections[i].offset = zeroFillArea - image;
4353 if(!strcmp(sections[i].sectname,"__text"))
4354 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4355 (void*) (image + sections[i].offset),
4356 (void*) (image + sections[i].offset + sections[i].size));
4357 else if(!strcmp(sections[i].sectname,"__const"))
4358 addSection(oc, SECTIONKIND_RWDATA,
4359 (void*) (image + sections[i].offset),
4360 (void*) (image + sections[i].offset + sections[i].size));
4361 else if(!strcmp(sections[i].sectname,"__data"))
4362 addSection(oc, SECTIONKIND_RWDATA,
4363 (void*) (image + sections[i].offset),
4364 (void*) (image + sections[i].offset + sections[i].size));
4365 else if(!strcmp(sections[i].sectname,"__bss")
4366 || !strcmp(sections[i].sectname,"__common"))
4367 addSection(oc, SECTIONKIND_RWDATA,
4368 (void*) (image + sections[i].offset),
4369 (void*) (image + sections[i].offset + sections[i].size));
4371 addProddableBlock(oc, (void*) (image + sections[i].offset),
4375 // count external symbols defined here
4379 for(i=0;i<symLC->nsyms;i++)
4381 if(nlist[i].n_type & N_STAB)
4383 else if(nlist[i].n_type & N_EXT)
4385 if((nlist[i].n_type & N_TYPE) == N_UNDF
4386 && (nlist[i].n_value != 0))
4388 commonSize += nlist[i].n_value;
4391 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4396 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4397 "ocGetNames_MachO(oc->symbols)");
4401 for(i=0;i<symLC->nsyms;i++)
4403 if(nlist[i].n_type & N_STAB)
4405 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4407 if(nlist[i].n_type & N_EXT)
4409 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4410 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4411 ; // weak definition, and we already have a definition
4414 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4416 + sections[nlist[i].n_sect-1].offset
4417 - sections[nlist[i].n_sect-1].addr
4418 + nlist[i].n_value);
4419 oc->symbols[curSymbol++] = nm;
4426 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4427 commonCounter = (unsigned long)commonStorage;
4430 for(i=0;i<symLC->nsyms;i++)
4432 if((nlist[i].n_type & N_TYPE) == N_UNDF
4433 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4435 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4436 unsigned long sz = nlist[i].n_value;
4438 nlist[i].n_value = commonCounter;
4440 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4441 (void*)commonCounter);
4442 oc->symbols[curSymbol++] = nm;
4444 commonCounter += sz;
4451 static int ocResolve_MachO(ObjectCode* oc)
4453 char *image = (char*) oc->image;
4454 struct mach_header *header = (struct mach_header*) image;
4455 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4457 struct segment_command *segLC = NULL;
4458 struct section *sections;
4459 struct symtab_command *symLC = NULL;
4460 struct dysymtab_command *dsymLC = NULL;
4461 struct nlist *nlist;
4463 for(i=0;i<header->ncmds;i++)
4465 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4466 segLC = (struct segment_command*) lc;
4467 else if(lc->cmd == LC_SYMTAB)
4468 symLC = (struct symtab_command*) lc;
4469 else if(lc->cmd == LC_DYSYMTAB)
4470 dsymLC = (struct dysymtab_command*) lc;
4471 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4474 sections = (struct section*) (segLC+1);
4475 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4480 unsigned long *indirectSyms
4481 = (unsigned long*) (image + dsymLC->indirectsymoff);
4483 for(i=0;i<segLC->nsects;i++)
4485 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4486 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4487 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4489 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4492 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4493 || !strcmp(sections[i].sectname,"__pointers"))
4495 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4498 else if(!strcmp(sections[i].sectname,"__jump_table"))
4500 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4506 for(i=0;i<segLC->nsects;i++)
4508 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4512 /* Free the local symbol table; we won't need it again. */
4513 freeHashTable(oc->lochash, NULL);
4516 #if defined (powerpc_HOST_ARCH)
4517 ocFlushInstructionCache( oc );
4523 #ifdef powerpc_HOST_ARCH
4525 * The Mach-O object format uses leading underscores. But not everywhere.
4526 * There is a small number of runtime support functions defined in
4527 * libcc_dynamic.a whose name does not have a leading underscore.
4528 * As a consequence, we can't get their address from C code.
4529 * We have to use inline assembler just to take the address of a function.
4533 static void machoInitSymbolsWithoutUnderscore()
4535 extern void* symbolsWithoutUnderscore[];
4536 void **p = symbolsWithoutUnderscore;
4537 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4541 __asm__ volatile(".long " # x);
4543 RTS_MACHO_NOUNDERLINE_SYMBOLS
4545 __asm__ volatile(".text");
4549 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4551 RTS_MACHO_NOUNDERLINE_SYMBOLS
4558 * Figure out by how much to shift the entire Mach-O file in memory
4559 * when loading so that its single segment ends up 16-byte-aligned
4561 static int machoGetMisalignment( FILE * f )
4563 struct mach_header header;
4566 fread(&header, sizeof(header), 1, f);
4569 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4570 if(header.magic != MH_MAGIC_64)
4573 if(header.magic != MH_MAGIC)
4577 misalignment = (header.sizeofcmds + sizeof(header))
4580 return misalignment ? (16 - misalignment) : 0;