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) \
734 RTS_USER_SIGNALS_SYMBOLS
736 #ifdef SUPPORT_LONG_LONGS
737 #define RTS_LONG_LONG_SYMS \
738 SymX(int64ToIntegerzh_fast) \
739 SymX(word64ToIntegerzh_fast)
741 #define RTS_LONG_LONG_SYMS /* nothing */
744 // 64-bit support functions in libgcc.a
745 #if defined(__GNUC__) && SIZEOF_VOID_P <= 4
746 #define RTS_LIBGCC_SYMBOLS \
756 #elif defined(ia64_HOST_ARCH)
757 #define RTS_LIBGCC_SYMBOLS \
765 #define RTS_LIBGCC_SYMBOLS
768 #if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
769 // Symbols that don't have a leading underscore
770 // on Mac OS X. They have to receive special treatment,
771 // see machoInitSymbolsWithoutUnderscore()
772 #define RTS_MACHO_NOUNDERLINE_SYMBOLS \
777 /* entirely bogus claims about types of these symbols */
778 #define Sym(vvv) extern void vvv(void);
779 #if defined(__PIC__) && defined(mingw32_TARGET_OS)
780 #define SymExtern(vvv) extern void _imp__ ## vvv (void);
782 #define SymExtern(vvv) SymX(vvv)
784 #define SymX(vvv) /**/
785 #define SymX_redirect(vvv,xxx) /**/
789 RTS_POSIX_ONLY_SYMBOLS
790 RTS_MINGW_ONLY_SYMBOLS
791 RTS_CYGWIN_ONLY_SYMBOLS
792 RTS_DARWIN_ONLY_SYMBOLS
799 #ifdef LEADING_UNDERSCORE
800 #define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
802 #define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
805 #define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
807 #define SymX(vvv) Sym(vvv)
808 #define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
809 (void*)DLL_IMPORT_DATA_REF(vvv) },
811 // SymX_redirect allows us to redirect references to one symbol to
812 // another symbol. See newCAF/newDynCAF for an example.
813 #define SymX_redirect(vvv,xxx) \
814 { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
817 static RtsSymbolVal rtsSyms[] = {
821 RTS_POSIX_ONLY_SYMBOLS
822 RTS_MINGW_ONLY_SYMBOLS
823 RTS_CYGWIN_ONLY_SYMBOLS
824 RTS_DARWIN_ONLY_SYMBOLS
826 #if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
827 // dyld stub code contains references to this,
828 // but it should never be called because we treat
829 // lazy pointers as nonlazy.
830 { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
832 { 0, 0 } /* sentinel */
837 /* -----------------------------------------------------------------------------
838 * Insert symbols into hash tables, checking for duplicates.
841 static void ghciInsertStrHashTable ( char* obj_name,
847 if (lookupHashTable(table, (StgWord)key) == NULL)
849 insertStrHashTable(table, (StgWord)key, data);
854 "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
856 "whilst processing object file\n"
858 "This could be caused by:\n"
859 " * Loading two different object files which export the same symbol\n"
860 " * Specifying the same object file twice on the GHCi command line\n"
861 " * An incorrect `package.conf' entry, causing some object to be\n"
863 "GHCi cannot safely continue in this situation. Exiting now. Sorry.\n"
870 /* -----------------------------------------------------------------------------
871 * initialize the object linker
875 static int linker_init_done = 0 ;
877 #if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
878 static void *dl_prog_handle;
886 /* Make initLinker idempotent, so we can call it
887 before evey relevant operation; that means we
888 don't need to initialise the linker separately */
889 if (linker_init_done == 1) { return; } else {
890 linker_init_done = 1;
893 stablehash = allocStrHashTable();
894 symhash = allocStrHashTable();
896 /* populate the symbol table with stuff from the RTS */
897 for (sym = rtsSyms; sym->lbl != NULL; sym++) {
898 ghciInsertStrHashTable("(GHCi built-in symbols)",
899 symhash, sym->lbl, sym->addr);
901 # if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
902 machoInitSymbolsWithoutUnderscore();
905 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
906 # if defined(RTLD_DEFAULT)
907 dl_prog_handle = RTLD_DEFAULT;
909 dl_prog_handle = dlopen(NULL, RTLD_LAZY);
910 # endif /* RTLD_DEFAULT */
914 /* -----------------------------------------------------------------------------
915 * Loading DLL or .so dynamic libraries
916 * -----------------------------------------------------------------------------
918 * Add a DLL from which symbols may be found. In the ELF case, just
919 * do RTLD_GLOBAL-style add, so no further messing around needs to
920 * happen in order that symbols in the loaded .so are findable --
921 * lookupSymbol() will subsequently see them by dlsym on the program's
922 * dl-handle. Returns NULL if success, otherwise ptr to an err msg.
924 * In the PEi386 case, open the DLLs and put handles to them in a
925 * linked list. When looking for a symbol, try all handles in the
926 * list. This means that we need to load even DLLs that are guaranteed
927 * to be in the ghc.exe image already, just so we can get a handle
928 * to give to loadSymbol, so that we can find the symbols. For such
929 * libraries, the LoadLibrary call should be a no-op except for returning
934 #if defined(OBJFORMAT_PEi386)
935 /* A record for storing handles into DLLs. */
940 struct _OpenedDLL* next;
945 /* A list thereof. */
946 static OpenedDLL* opened_dlls = NULL;
950 addDLL( char *dll_name )
952 # if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
953 /* ------------------- ELF DLL loader ------------------- */
959 hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
962 /* dlopen failed; return a ptr to the error msg. */
964 if (errmsg == NULL) errmsg = "addDLL: unknown error";
971 # elif defined(OBJFORMAT_PEi386)
972 /* ------------------- Win32 DLL loader ------------------- */
980 /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
982 /* See if we've already got it, and ignore if so. */
983 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
984 if (0 == strcmp(o_dll->name, dll_name))
988 /* The file name has no suffix (yet) so that we can try
989 both foo.dll and foo.drv
991 The documentation for LoadLibrary says:
992 If no file name extension is specified in the lpFileName
993 parameter, the default library extension .dll is
994 appended. However, the file name string can include a trailing
995 point character (.) to indicate that the module name has no
998 buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
999 sprintf(buf, "%s.DLL", dll_name);
1000 instance = LoadLibrary(buf);
1001 if (instance == NULL) {
1002 sprintf(buf, "%s.DRV", dll_name); // KAA: allow loading of drivers (like winspool.drv)
1003 instance = LoadLibrary(buf);
1004 if (instance == NULL) {
1007 /* LoadLibrary failed; return a ptr to the error msg. */
1008 return "addDLL: unknown error";
1013 /* Add this DLL to the list of DLLs in which to search for symbols. */
1014 o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1015 o_dll->name = stgMallocBytes(1+strlen(dll_name), "addDLL");
1016 strcpy(o_dll->name, dll_name);
1017 o_dll->instance = instance;
1018 o_dll->next = opened_dlls;
1019 opened_dlls = o_dll;
1023 barf("addDLL: not implemented on this platform");
1027 /* -----------------------------------------------------------------------------
1028 * insert a stable symbol in the hash table
1032 insertStableSymbol(char* obj_name, char* key, StgPtr p)
1034 ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
1038 /* -----------------------------------------------------------------------------
1039 * insert a symbol in the hash table
1042 insertSymbol(char* obj_name, char* key, void* data)
1044 ghciInsertStrHashTable(obj_name, symhash, key, data);
1047 /* -----------------------------------------------------------------------------
1048 * lookup a symbol in the hash table
1051 lookupSymbol( char *lbl )
1055 ASSERT(symhash != NULL);
1056 val = lookupStrHashTable(symhash, lbl);
1059 # if defined(OBJFORMAT_ELF)
1060 # if defined(x86_64_HOST_ARCH)
1061 val = dlsym(dl_prog_handle, lbl);
1062 if (val >= (void *)0x80000000) {
1064 new_val = x86_64_high_symbol(lbl, val);
1065 IF_DEBUG(linker,debugBelch("lookupSymbol: relocating out of range symbol: %s = %p, now %p\n", lbl, val, new_val));
1071 return dlsym(dl_prog_handle, lbl);
1073 # elif defined(OBJFORMAT_MACHO)
1075 /* On OS X 10.3 and later, we use dlsym instead of the old legacy
1078 HACK: On OS X, global symbols are prefixed with an underscore.
1079 However, dlsym wants us to omit the leading underscore from the
1080 symbol name. For now, we simply strip it off here (and ONLY
1083 ASSERT(lbl[0] == '_');
1084 return dlsym(dl_prog_handle, lbl+1);
1086 if(NSIsSymbolNameDefined(lbl)) {
1087 NSSymbol symbol = NSLookupAndBindSymbol(lbl);
1088 return NSAddressOfSymbol(symbol);
1092 # endif /* HAVE_DLFCN_H */
1093 # elif defined(OBJFORMAT_PEi386)
1096 for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1097 /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1098 if (lbl[0] == '_') {
1099 /* HACK: if the name has an initial underscore, try stripping
1100 it off & look that up first. I've yet to verify whether there's
1101 a Rule that governs whether an initial '_' *should always* be
1102 stripped off when mapping from import lib name to the DLL name.
1104 sym = GetProcAddress(o_dll->instance, (lbl+1));
1106 /*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
1110 sym = GetProcAddress(o_dll->instance, lbl);
1112 /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
1127 __attribute((unused))
1129 lookupLocalSymbol( ObjectCode* oc, char *lbl )
1133 val = lookupStrHashTable(oc->lochash, lbl);
1143 /* -----------------------------------------------------------------------------
1144 * Debugging aid: look in GHCi's object symbol tables for symbols
1145 * within DELTA bytes of the specified address, and show their names.
1148 void ghci_enquire ( char* addr );
1150 void ghci_enquire ( char* addr )
1155 const int DELTA = 64;
1160 for (oc = objects; oc; oc = oc->next) {
1161 for (i = 0; i < oc->n_symbols; i++) {
1162 sym = oc->symbols[i];
1163 if (sym == NULL) continue;
1164 // debugBelch("enquire %p %p\n", sym, oc->lochash);
1166 if (oc->lochash != NULL) {
1167 a = lookupStrHashTable(oc->lochash, sym);
1170 a = lookupStrHashTable(symhash, sym);
1173 // debugBelch("ghci_enquire: can't find %s\n", sym);
1175 else if (addr-DELTA <= a && a <= addr+DELTA) {
1176 debugBelch("%p + %3d == `%s'\n", addr, (int)(a - addr), sym);
1183 #ifdef ia64_HOST_ARCH
1184 static unsigned int PLTSize(void);
1187 /* -----------------------------------------------------------------------------
1188 * Load an obj (populate the global symbol table, but don't resolve yet)
1190 * Returns: 1 if ok, 0 on error.
1193 loadObj( char *path )
1200 void *map_addr = NULL;
1206 /* debugBelch("loadObj %s\n", path ); */
1208 /* Check that we haven't already loaded this object.
1209 Ignore requests to load multiple times */
1213 for (o = objects; o; o = o->next) {
1214 if (0 == strcmp(o->fileName, path)) {
1216 break; /* don't need to search further */
1220 IF_DEBUG(linker, debugBelch(
1221 "GHCi runtime linker: warning: looks like you're trying to load the\n"
1222 "same object file twice:\n"
1224 "GHCi will ignore this, but be warned.\n"
1226 return 1; /* success */
1230 oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");
1232 # if defined(OBJFORMAT_ELF)
1233 oc->formatName = "ELF";
1234 # elif defined(OBJFORMAT_PEi386)
1235 oc->formatName = "PEi386";
1236 # elif defined(OBJFORMAT_MACHO)
1237 oc->formatName = "Mach-O";
1240 barf("loadObj: not implemented on this platform");
1243 r = stat(path, &st);
1244 if (r == -1) { return 0; }
1246 /* sigh, strdup() isn't a POSIX function, so do it the long way */
1247 oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
1248 strcpy(oc->fileName, path);
1250 oc->fileSize = st.st_size;
1252 oc->sections = NULL;
1253 oc->lochash = allocStrHashTable();
1254 oc->proddables = NULL;
1256 /* chain it onto the list of objects */
1261 #define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))
1263 /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */
1265 #if defined(openbsd_HOST_OS)
1266 fd = open(path, O_RDONLY, S_IRUSR);
1268 fd = open(path, O_RDONLY);
1271 barf("loadObj: can't open `%s'", path);
1273 pagesize = getpagesize();
1275 #ifdef ia64_HOST_ARCH
1276 /* The PLT needs to be right before the object */
1277 n = ROUND_UP(PLTSize(), pagesize);
1278 oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
1279 if (oc->plt == MAP_FAILED)
1280 barf("loadObj: can't allocate PLT");
1283 map_addr = oc->plt + n;
1286 n = ROUND_UP(oc->fileSize, pagesize);
1288 /* Link objects into the lower 2Gb on x86_64. GHC assumes the
1289 * small memory model on this architecture (see gcc docs,
1292 #ifdef x86_64_HOST_ARCH
1293 #define EXTRA_MAP_FLAGS MAP_32BIT
1295 #define EXTRA_MAP_FLAGS 0
1298 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1299 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1300 if (oc->image == MAP_FAILED)
1301 barf("loadObj: can't map `%s'", path);
1305 #else /* !USE_MMAP */
1307 /* load the image into memory */
1308 f = fopen(path, "rb");
1310 barf("loadObj: can't read `%s'", path);
1312 # if defined(mingw32_HOST_OS)
1313 // TODO: We would like to use allocateExec here, but allocateExec
1314 // cannot currently allocate blocks large enough.
1315 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1316 PAGE_EXECUTE_READWRITE);
1317 # elif defined(darwin_HOST_OS)
1318 // In a Mach-O .o file, all sections can and will be misaligned
1319 // if the total size of the headers is not a multiple of the
1320 // desired alignment. This is fine for .o files that only serve
1321 // as input for the static linker, but it's not fine for us,
1322 // as SSE (used by gcc for floating point) and Altivec require
1323 // 16-byte alignment.
1324 // We calculate the correct alignment from the header before
1325 // reading the file, and then we misalign oc->image on purpose so
1326 // that the actual sections end up aligned again.
1327 oc->misalignment = machoGetMisalignment(f);
1328 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1329 oc->image += oc->misalignment;
1331 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1334 n = fread ( oc->image, 1, oc->fileSize, f );
1335 if (n != oc->fileSize)
1336 barf("loadObj: error whilst reading `%s'", path);
1339 #endif /* USE_MMAP */
1341 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1342 r = ocAllocateSymbolExtras_MachO ( oc );
1343 if (!r) { return r; }
1344 # elif defined(OBJFORMAT_ELF) && defined(powerpc_HOST_ARCH)
1345 r = ocAllocateSymbolExtras_ELF ( oc );
1346 if (!r) { return r; }
1349 /* verify the in-memory image */
1350 # if defined(OBJFORMAT_ELF)
1351 r = ocVerifyImage_ELF ( oc );
1352 # elif defined(OBJFORMAT_PEi386)
1353 r = ocVerifyImage_PEi386 ( oc );
1354 # elif defined(OBJFORMAT_MACHO)
1355 r = ocVerifyImage_MachO ( oc );
1357 barf("loadObj: no verify method");
1359 if (!r) { return r; }
1361 /* build the symbol list for this image */
1362 # if defined(OBJFORMAT_ELF)
1363 r = ocGetNames_ELF ( oc );
1364 # elif defined(OBJFORMAT_PEi386)
1365 r = ocGetNames_PEi386 ( oc );
1366 # elif defined(OBJFORMAT_MACHO)
1367 r = ocGetNames_MachO ( oc );
1369 barf("loadObj: no getNames method");
1371 if (!r) { return r; }
1373 /* loaded, but not resolved yet */
1374 oc->status = OBJECT_LOADED;
1379 /* -----------------------------------------------------------------------------
1380 * resolve all the currently unlinked objects in memory
1382 * Returns: 1 if ok, 0 on error.
1392 for (oc = objects; oc; oc = oc->next) {
1393 if (oc->status != OBJECT_RESOLVED) {
1394 # if defined(OBJFORMAT_ELF)
1395 r = ocResolve_ELF ( oc );
1396 # elif defined(OBJFORMAT_PEi386)
1397 r = ocResolve_PEi386 ( oc );
1398 # elif defined(OBJFORMAT_MACHO)
1399 r = ocResolve_MachO ( oc );
1401 barf("resolveObjs: not implemented on this platform");
1403 if (!r) { return r; }
1404 oc->status = OBJECT_RESOLVED;
1410 /* -----------------------------------------------------------------------------
1411 * delete an object from the pool
1414 unloadObj( char *path )
1416 ObjectCode *oc, *prev;
1418 ASSERT(symhash != NULL);
1419 ASSERT(objects != NULL);
1424 for (oc = objects; oc; prev = oc, oc = oc->next) {
1425 if (!strcmp(oc->fileName,path)) {
1427 /* Remove all the mappings for the symbols within this
1432 for (i = 0; i < oc->n_symbols; i++) {
1433 if (oc->symbols[i] != NULL) {
1434 removeStrHashTable(symhash, oc->symbols[i], NULL);
1442 prev->next = oc->next;
1445 // We're going to leave this in place, in case there are
1446 // any pointers from the heap into it:
1447 // #ifdef mingw32_HOST_OS
1448 // VirtualFree(oc->image);
1450 // stgFree(oc->image);
1452 stgFree(oc->fileName);
1453 stgFree(oc->symbols);
1454 stgFree(oc->sections);
1455 /* The local hash table should have been freed at the end
1456 of the ocResolve_ call on it. */
1457 ASSERT(oc->lochash == NULL);
1463 errorBelch("unloadObj: can't find `%s' to unload", path);
1467 /* -----------------------------------------------------------------------------
1468 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1469 * which may be prodded during relocation, and abort if we try and write
1470 * outside any of these.
1472 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1475 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1476 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1480 pb->next = oc->proddables;
1481 oc->proddables = pb;
1484 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1487 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1488 char* s = (char*)(pb->start);
1489 char* e = s + pb->size - 1;
1490 char* a = (char*)addr;
1491 /* Assumes that the biggest fixup involves a 4-byte write. This
1492 probably needs to be changed to 8 (ie, +7) on 64-bit
1494 if (a >= s && (a+3) <= e) return;
1496 barf("checkProddableBlock: invalid fixup in runtime linker");
1499 /* -----------------------------------------------------------------------------
1500 * Section management.
1502 static void addSection ( ObjectCode* oc, SectionKind kind,
1503 void* start, void* end )
1505 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1509 s->next = oc->sections;
1512 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1513 start, ((char*)end)-1, end - start + 1, kind );
1518 /* --------------------------------------------------------------------------
1520 * This is about allocating a small chunk of memory for every symbol in the
1521 * object file. We make sure that the SymboLExtras are always "in range" of
1522 * limited-range PC-relative instructions on various platforms by allocating
1523 * them right next to the object code itself.
1526 #if defined(powerpc_HOST_ARCH) || (defined(x86_64_HOST_ARCH) \
1527 && defined(darwin_TARGET_OS))
1530 ocAllocateSymbolExtras
1532 Allocate additional space at the end of the object file image to make room
1533 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1535 PowerPC relative branch instructions have a 24 bit displacement field.
1536 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1537 If a particular imported symbol is outside this range, we have to redirect
1538 the jump to a short piece of new code that just loads the 32bit absolute
1539 address and jumps there.
1540 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1543 This function just allocates space for one SymbolExtra for every
1544 undefined symbol in the object file. The code for the jump islands is
1545 filled in by makeSymbolExtra below.
1548 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1554 int misalignment = 0;
1556 misalignment = oc->misalignment;
1561 // round up to the nearest 4
1562 aligned = (oc->fileSize + 3) & ~3;
1565 #ifndef linux_HOST_OS /* mremap is a linux extension */
1566 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1569 pagesize = getpagesize();
1570 n = ROUND_UP( oc->fileSize, pagesize );
1571 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1573 /* If we have a half-page-size file and map one page of it then
1574 * the part of the page after the size of the file remains accessible.
1575 * If, however, we map in 2 pages, the 2nd page is not accessible
1576 * and will give a "Bus Error" on access. To get around this, we check
1577 * if we need any extra pages for the jump islands and map them in
1578 * anonymously. We must check that we actually require extra pages
1579 * otherwise the attempt to mmap 0 pages of anonymous memory will
1585 /* The effect of this mremap() call is only the ensure that we have
1586 * a sufficient number of virtually contiguous pages. As returned from
1587 * mremap, the pages past the end of the file are not backed. We give
1588 * them a backing by using MAP_FIXED to map in anonymous pages.
1590 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1592 if( oc->image == MAP_FAILED )
1594 errorBelch( "Unable to mremap for Jump Islands\n" );
1598 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1599 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1601 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1607 oc->image -= misalignment;
1608 oc->image = stgReallocBytes( oc->image,
1610 aligned + sizeof (SymbolExtra) * count,
1611 "ocAllocateSymbolExtras" );
1612 oc->image += misalignment;
1613 #endif /* USE_MMAP */
1615 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1616 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1619 oc->symbol_extras = NULL;
1621 oc->first_symbol_extra = first;
1622 oc->n_symbol_extras = count;
1627 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1628 unsigned long symbolNumber,
1629 unsigned long target )
1633 ASSERT( symbolNumber >= oc->first_symbol_extra
1634 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1636 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1638 #ifdef powerpc_HOST_ARCH
1639 // lis r12, hi16(target)
1640 extra->jumpIsland.lis_r12 = 0x3d80;
1641 extra->jumpIsland.hi_addr = target >> 16;
1643 // ori r12, r12, lo16(target)
1644 extra->jumpIsland.ori_r12_r12 = 0x618c;
1645 extra->jumpIsland.lo_addr = target & 0xffff;
1648 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1651 extra->jumpIsland.bctr = 0x4e800420;
1653 #ifdef x86_64_HOST_ARCH
1655 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1656 extra->addr = target;
1657 memcpy(extra->jumpIsland, jmp, 6);
1665 /* --------------------------------------------------------------------------
1666 * PowerPC specifics (instruction cache flushing)
1667 * ------------------------------------------------------------------------*/
1669 #ifdef powerpc_TARGET_ARCH
1671 ocFlushInstructionCache
1673 Flush the data & instruction caches.
1674 Because the PPC has split data/instruction caches, we have to
1675 do that whenever we modify code at runtime.
1678 static void ocFlushInstructionCache( ObjectCode *oc )
1680 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1681 unsigned long *p = (unsigned long *) oc->image;
1685 __asm__ volatile ( "dcbf 0,%0\n\t"
1693 __asm__ volatile ( "sync\n\t"
1699 /* --------------------------------------------------------------------------
1700 * PEi386 specifics (Win32 targets)
1701 * ------------------------------------------------------------------------*/
1703 /* The information for this linker comes from
1704 Microsoft Portable Executable
1705 and Common Object File Format Specification
1706 revision 5.1 January 1998
1707 which SimonM says comes from the MS Developer Network CDs.
1709 It can be found there (on older CDs), but can also be found
1712 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1714 (this is Rev 6.0 from February 1999).
1716 Things move, so if that fails, try searching for it via
1718 http://www.google.com/search?q=PE+COFF+specification
1720 The ultimate reference for the PE format is the Winnt.h
1721 header file that comes with the Platform SDKs; as always,
1722 implementations will drift wrt their documentation.
1724 A good background article on the PE format is Matt Pietrek's
1725 March 1994 article in Microsoft System Journal (MSJ)
1726 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1727 Win32 Portable Executable File Format." The info in there
1728 has recently been updated in a two part article in
1729 MSDN magazine, issues Feb and March 2002,
1730 "Inside Windows: An In-Depth Look into the Win32 Portable
1731 Executable File Format"
1733 John Levine's book "Linkers and Loaders" contains useful
1738 #if defined(OBJFORMAT_PEi386)
1742 typedef unsigned char UChar;
1743 typedef unsigned short UInt16;
1744 typedef unsigned int UInt32;
1751 UInt16 NumberOfSections;
1752 UInt32 TimeDateStamp;
1753 UInt32 PointerToSymbolTable;
1754 UInt32 NumberOfSymbols;
1755 UInt16 SizeOfOptionalHeader;
1756 UInt16 Characteristics;
1760 #define sizeof_COFF_header 20
1767 UInt32 VirtualAddress;
1768 UInt32 SizeOfRawData;
1769 UInt32 PointerToRawData;
1770 UInt32 PointerToRelocations;
1771 UInt32 PointerToLinenumbers;
1772 UInt16 NumberOfRelocations;
1773 UInt16 NumberOfLineNumbers;
1774 UInt32 Characteristics;
1778 #define sizeof_COFF_section 40
1785 UInt16 SectionNumber;
1788 UChar NumberOfAuxSymbols;
1792 #define sizeof_COFF_symbol 18
1797 UInt32 VirtualAddress;
1798 UInt32 SymbolTableIndex;
1803 #define sizeof_COFF_reloc 10
1806 /* From PE spec doc, section 3.3.2 */
1807 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1808 windows.h -- for the same purpose, but I want to know what I'm
1810 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1811 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1812 #define MYIMAGE_FILE_DLL 0x2000
1813 #define MYIMAGE_FILE_SYSTEM 0x1000
1814 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1815 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1816 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1818 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1819 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1820 #define MYIMAGE_SYM_CLASS_STATIC 3
1821 #define MYIMAGE_SYM_UNDEFINED 0
1823 /* From PE spec doc, section 4.1 */
1824 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1825 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1826 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1828 /* From PE spec doc, section 5.2.1 */
1829 #define MYIMAGE_REL_I386_DIR32 0x0006
1830 #define MYIMAGE_REL_I386_REL32 0x0014
1833 /* We use myindex to calculate array addresses, rather than
1834 simply doing the normal subscript thing. That's because
1835 some of the above structs have sizes which are not
1836 a whole number of words. GCC rounds their sizes up to a
1837 whole number of words, which means that the address calcs
1838 arising from using normal C indexing or pointer arithmetic
1839 are just plain wrong. Sigh.
1842 myindex ( int scale, void* base, int index )
1845 ((UChar*)base) + scale * index;
1850 printName ( UChar* name, UChar* strtab )
1852 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1853 UInt32 strtab_offset = * (UInt32*)(name+4);
1854 debugBelch("%s", strtab + strtab_offset );
1857 for (i = 0; i < 8; i++) {
1858 if (name[i] == 0) break;
1859 debugBelch("%c", name[i] );
1866 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1868 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1869 UInt32 strtab_offset = * (UInt32*)(name+4);
1870 strncpy ( dst, strtab+strtab_offset, dstSize );
1876 if (name[i] == 0) break;
1886 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1889 /* If the string is longer than 8 bytes, look in the
1890 string table for it -- this will be correctly zero terminated.
1892 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1893 UInt32 strtab_offset = * (UInt32*)(name+4);
1894 return ((UChar*)strtab) + strtab_offset;
1896 /* Otherwise, if shorter than 8 bytes, return the original,
1897 which by defn is correctly terminated.
1899 if (name[7]==0) return name;
1900 /* The annoying case: 8 bytes. Copy into a temporary
1901 (which is never freed ...)
1903 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1905 strncpy(newstr,name,8);
1911 /* Just compares the short names (first 8 chars) */
1912 static COFF_section *
1913 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1917 = (COFF_header*)(oc->image);
1918 COFF_section* sectab
1920 ((UChar*)(oc->image))
1921 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1923 for (i = 0; i < hdr->NumberOfSections; i++) {
1926 COFF_section* section_i
1928 myindex ( sizeof_COFF_section, sectab, i );
1929 n1 = (UChar*) &(section_i->Name);
1931 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1932 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1933 n1[6]==n2[6] && n1[7]==n2[7])
1942 zapTrailingAtSign ( UChar* sym )
1944 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
1946 if (sym[0] == 0) return;
1948 while (sym[i] != 0) i++;
1951 while (j > 0 && my_isdigit(sym[j])) j--;
1952 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
1958 ocVerifyImage_PEi386 ( ObjectCode* oc )
1963 COFF_section* sectab;
1964 COFF_symbol* symtab;
1966 /* debugBelch("\nLOADING %s\n", oc->fileName); */
1967 hdr = (COFF_header*)(oc->image);
1968 sectab = (COFF_section*) (
1969 ((UChar*)(oc->image))
1970 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1972 symtab = (COFF_symbol*) (
1973 ((UChar*)(oc->image))
1974 + hdr->PointerToSymbolTable
1976 strtab = ((UChar*)symtab)
1977 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
1979 if (hdr->Machine != 0x14c) {
1980 errorBelch("%s: Not x86 PEi386", oc->fileName);
1983 if (hdr->SizeOfOptionalHeader != 0) {
1984 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
1987 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
1988 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
1989 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
1990 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
1991 errorBelch("%s: Not a PEi386 object file", oc->fileName);
1994 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
1995 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
1996 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
1998 (int)(hdr->Characteristics));
2001 /* If the string table size is way crazy, this might indicate that
2002 there are more than 64k relocations, despite claims to the
2003 contrary. Hence this test. */
2004 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2006 if ( (*(UInt32*)strtab) > 600000 ) {
2007 /* Note that 600k has no special significance other than being
2008 big enough to handle the almost-2MB-sized lumps that
2009 constitute HSwin32*.o. */
2010 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2015 /* No further verification after this point; only debug printing. */
2017 IF_DEBUG(linker, i=1);
2018 if (i == 0) return 1;
2020 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2021 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2022 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2025 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2026 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2027 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2028 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2029 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2030 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2031 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2033 /* Print the section table. */
2035 for (i = 0; i < hdr->NumberOfSections; i++) {
2037 COFF_section* sectab_i
2039 myindex ( sizeof_COFF_section, sectab, i );
2046 printName ( sectab_i->Name, strtab );
2056 sectab_i->VirtualSize,
2057 sectab_i->VirtualAddress,
2058 sectab_i->SizeOfRawData,
2059 sectab_i->PointerToRawData,
2060 sectab_i->NumberOfRelocations,
2061 sectab_i->PointerToRelocations,
2062 sectab_i->PointerToRawData
2064 reltab = (COFF_reloc*) (
2065 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2068 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2069 /* If the relocation field (a short) has overflowed, the
2070 * real count can be found in the first reloc entry.
2072 * See Section 4.1 (last para) of the PE spec (rev6.0).
2074 COFF_reloc* rel = (COFF_reloc*)
2075 myindex ( sizeof_COFF_reloc, reltab, 0 );
2076 noRelocs = rel->VirtualAddress;
2079 noRelocs = sectab_i->NumberOfRelocations;
2083 for (; j < noRelocs; j++) {
2085 COFF_reloc* rel = (COFF_reloc*)
2086 myindex ( sizeof_COFF_reloc, reltab, j );
2088 " type 0x%-4x vaddr 0x%-8x name `",
2090 rel->VirtualAddress );
2091 sym = (COFF_symbol*)
2092 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2093 /* Hmm..mysterious looking offset - what's it for? SOF */
2094 printName ( sym->Name, strtab -10 );
2101 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2102 debugBelch("---START of string table---\n");
2103 for (i = 4; i < *(Int32*)strtab; i++) {
2105 debugBelch("\n"); else
2106 debugBelch("%c", strtab[i] );
2108 debugBelch("--- END of string table---\n");
2113 COFF_symbol* symtab_i;
2114 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2115 symtab_i = (COFF_symbol*)
2116 myindex ( sizeof_COFF_symbol, symtab, i );
2122 printName ( symtab_i->Name, strtab );
2131 (Int32)(symtab_i->SectionNumber),
2132 (UInt32)symtab_i->Type,
2133 (UInt32)symtab_i->StorageClass,
2134 (UInt32)symtab_i->NumberOfAuxSymbols
2136 i += symtab_i->NumberOfAuxSymbols;
2146 ocGetNames_PEi386 ( ObjectCode* oc )
2149 COFF_section* sectab;
2150 COFF_symbol* symtab;
2157 hdr = (COFF_header*)(oc->image);
2158 sectab = (COFF_section*) (
2159 ((UChar*)(oc->image))
2160 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2162 symtab = (COFF_symbol*) (
2163 ((UChar*)(oc->image))
2164 + hdr->PointerToSymbolTable
2166 strtab = ((UChar*)(oc->image))
2167 + hdr->PointerToSymbolTable
2168 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2170 /* Allocate space for any (local, anonymous) .bss sections. */
2172 for (i = 0; i < hdr->NumberOfSections; i++) {
2175 COFF_section* sectab_i
2177 myindex ( sizeof_COFF_section, sectab, i );
2178 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2179 /* sof 10/05: the PE spec text isn't too clear regarding what
2180 * the SizeOfRawData field is supposed to hold for object
2181 * file sections containing just uninitialized data -- for executables,
2182 * it is supposed to be zero; unclear what it's supposed to be
2183 * for object files. However, VirtualSize is guaranteed to be
2184 * zero for object files, which definitely suggests that SizeOfRawData
2185 * will be non-zero (where else would the size of this .bss section be
2186 * stored?) Looking at the COFF_section info for incoming object files,
2187 * this certainly appears to be the case.
2189 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2190 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2191 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2192 * variable decls into to the .bss section. (The specific function in Q which
2193 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2195 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2196 /* This is a non-empty .bss section. Allocate zeroed space for
2197 it, and set its PointerToRawData field such that oc->image +
2198 PointerToRawData == addr_of_zeroed_space. */
2199 bss_sz = sectab_i->VirtualSize;
2200 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2201 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2202 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2203 addProddableBlock(oc, zspace, bss_sz);
2204 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2207 /* Copy section information into the ObjectCode. */
2209 for (i = 0; i < hdr->NumberOfSections; i++) {
2215 = SECTIONKIND_OTHER;
2216 COFF_section* sectab_i
2218 myindex ( sizeof_COFF_section, sectab, i );
2219 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2222 /* I'm sure this is the Right Way to do it. However, the
2223 alternative of testing the sectab_i->Name field seems to
2224 work ok with Cygwin.
2226 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2227 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2228 kind = SECTIONKIND_CODE_OR_RODATA;
2231 if (0==strcmp(".text",sectab_i->Name) ||
2232 0==strcmp(".rdata",sectab_i->Name)||
2233 0==strcmp(".rodata",sectab_i->Name))
2234 kind = SECTIONKIND_CODE_OR_RODATA;
2235 if (0==strcmp(".data",sectab_i->Name) ||
2236 0==strcmp(".bss",sectab_i->Name))
2237 kind = SECTIONKIND_RWDATA;
2239 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2240 sz = sectab_i->SizeOfRawData;
2241 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2243 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2244 end = start + sz - 1;
2246 if (kind == SECTIONKIND_OTHER
2247 /* Ignore sections called which contain stabs debugging
2249 && 0 != strcmp(".stab", sectab_i->Name)
2250 && 0 != strcmp(".stabstr", sectab_i->Name)
2251 /* ignore constructor section for now */
2252 && 0 != strcmp(".ctors", sectab_i->Name)
2253 /* ignore section generated from .ident */
2254 && 0!= strcmp("/4", sectab_i->Name)
2256 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2260 if (kind != SECTIONKIND_OTHER && end >= start) {
2261 addSection(oc, kind, start, end);
2262 addProddableBlock(oc, start, end - start + 1);
2266 /* Copy exported symbols into the ObjectCode. */
2268 oc->n_symbols = hdr->NumberOfSymbols;
2269 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2270 "ocGetNames_PEi386(oc->symbols)");
2271 /* Call me paranoid; I don't care. */
2272 for (i = 0; i < oc->n_symbols; i++)
2273 oc->symbols[i] = NULL;
2277 COFF_symbol* symtab_i;
2278 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2279 symtab_i = (COFF_symbol*)
2280 myindex ( sizeof_COFF_symbol, symtab, i );
2284 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2285 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2286 /* This symbol is global and defined, viz, exported */
2287 /* for MYIMAGE_SYMCLASS_EXTERNAL
2288 && !MYIMAGE_SYM_UNDEFINED,
2289 the address of the symbol is:
2290 address of relevant section + offset in section
2292 COFF_section* sectabent
2293 = (COFF_section*) myindex ( sizeof_COFF_section,
2295 symtab_i->SectionNumber-1 );
2296 addr = ((UChar*)(oc->image))
2297 + (sectabent->PointerToRawData
2301 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2302 && symtab_i->Value > 0) {
2303 /* This symbol isn't in any section at all, ie, global bss.
2304 Allocate zeroed space for it. */
2305 addr = stgCallocBytes(1, symtab_i->Value,
2306 "ocGetNames_PEi386(non-anonymous bss)");
2307 addSection(oc, SECTIONKIND_RWDATA, addr,
2308 ((UChar*)addr) + symtab_i->Value - 1);
2309 addProddableBlock(oc, addr, symtab_i->Value);
2310 /* debugBelch("BSS section at 0x%x\n", addr); */
2313 if (addr != NULL ) {
2314 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2315 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2316 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2317 ASSERT(i >= 0 && i < oc->n_symbols);
2318 /* cstring_from_COFF_symbol_name always succeeds. */
2319 oc->symbols[i] = sname;
2320 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2324 "IGNORING symbol %d\n"
2328 printName ( symtab_i->Name, strtab );
2337 (Int32)(symtab_i->SectionNumber),
2338 (UInt32)symtab_i->Type,
2339 (UInt32)symtab_i->StorageClass,
2340 (UInt32)symtab_i->NumberOfAuxSymbols
2345 i += symtab_i->NumberOfAuxSymbols;
2354 ocResolve_PEi386 ( ObjectCode* oc )
2357 COFF_section* sectab;
2358 COFF_symbol* symtab;
2368 /* ToDo: should be variable-sized? But is at least safe in the
2369 sense of buffer-overrun-proof. */
2371 /* debugBelch("resolving for %s\n", oc->fileName); */
2373 hdr = (COFF_header*)(oc->image);
2374 sectab = (COFF_section*) (
2375 ((UChar*)(oc->image))
2376 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2378 symtab = (COFF_symbol*) (
2379 ((UChar*)(oc->image))
2380 + hdr->PointerToSymbolTable
2382 strtab = ((UChar*)(oc->image))
2383 + hdr->PointerToSymbolTable
2384 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2386 for (i = 0; i < hdr->NumberOfSections; i++) {
2387 COFF_section* sectab_i
2389 myindex ( sizeof_COFF_section, sectab, i );
2392 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2395 /* Ignore sections called which contain stabs debugging
2397 if (0 == strcmp(".stab", sectab_i->Name)
2398 || 0 == strcmp(".stabstr", sectab_i->Name)
2399 || 0 == strcmp(".ctors", sectab_i->Name))
2402 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2403 /* If the relocation field (a short) has overflowed, the
2404 * real count can be found in the first reloc entry.
2406 * See Section 4.1 (last para) of the PE spec (rev6.0).
2408 * Nov2003 update: the GNU linker still doesn't correctly
2409 * handle the generation of relocatable object files with
2410 * overflown relocations. Hence the output to warn of potential
2413 COFF_reloc* rel = (COFF_reloc*)
2414 myindex ( sizeof_COFF_reloc, reltab, 0 );
2415 noRelocs = rel->VirtualAddress;
2417 /* 10/05: we now assume (and check for) a GNU ld that is capable
2418 * of handling object files with (>2^16) of relocs.
2421 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2426 noRelocs = sectab_i->NumberOfRelocations;
2431 for (; j < noRelocs; j++) {
2433 COFF_reloc* reltab_j
2435 myindex ( sizeof_COFF_reloc, reltab, j );
2437 /* the location to patch */
2439 ((UChar*)(oc->image))
2440 + (sectab_i->PointerToRawData
2441 + reltab_j->VirtualAddress
2442 - sectab_i->VirtualAddress )
2444 /* the existing contents of pP */
2446 /* the symbol to connect to */
2447 sym = (COFF_symbol*)
2448 myindex ( sizeof_COFF_symbol,
2449 symtab, reltab_j->SymbolTableIndex );
2452 "reloc sec %2d num %3d: type 0x%-4x "
2453 "vaddr 0x%-8x name `",
2455 (UInt32)reltab_j->Type,
2456 reltab_j->VirtualAddress );
2457 printName ( sym->Name, strtab );
2458 debugBelch("'\n" ));
2460 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2461 COFF_section* section_sym
2462 = findPEi386SectionCalled ( oc, sym->Name );
2464 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2467 S = ((UInt32)(oc->image))
2468 + (section_sym->PointerToRawData
2471 copyName ( sym->Name, strtab, symbol, 1000-1 );
2472 S = (UInt32) lookupLocalSymbol( oc, symbol );
2473 if ((void*)S != NULL) goto foundit;
2474 S = (UInt32) lookupSymbol( symbol );
2475 if ((void*)S != NULL) goto foundit;
2476 zapTrailingAtSign ( symbol );
2477 S = (UInt32) lookupLocalSymbol( oc, symbol );
2478 if ((void*)S != NULL) goto foundit;
2479 S = (UInt32) lookupSymbol( symbol );
2480 if ((void*)S != NULL) goto foundit;
2481 /* Newline first because the interactive linker has printed "linking..." */
2482 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2486 checkProddableBlock(oc, pP);
2487 switch (reltab_j->Type) {
2488 case MYIMAGE_REL_I386_DIR32:
2491 case MYIMAGE_REL_I386_REL32:
2492 /* Tricky. We have to insert a displacement at
2493 pP which, when added to the PC for the _next_
2494 insn, gives the address of the target (S).
2495 Problem is to know the address of the next insn
2496 when we only know pP. We assume that this
2497 literal field is always the last in the insn,
2498 so that the address of the next insn is pP+4
2499 -- hence the constant 4.
2500 Also I don't know if A should be added, but so
2501 far it has always been zero.
2503 SOF 05/2005: 'A' (old contents of *pP) have been observed
2504 to contain values other than zero (the 'wx' object file
2505 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2506 So, add displacement to old value instead of asserting
2507 A to be zero. Fixes wxhaskell-related crashes, and no other
2508 ill effects have been observed.
2510 Update: the reason why we're seeing these more elaborate
2511 relocations is due to a switch in how the NCG compiles SRTs
2512 and offsets to them from info tables. SRTs live in .(ro)data,
2513 while info tables live in .text, causing GAS to emit REL32/DISP32
2514 relocations with non-zero values. Adding the displacement is
2515 the right thing to do.
2517 *pP = S - ((UInt32)pP) - 4 + A;
2520 debugBelch("%s: unhandled PEi386 relocation type %d",
2521 oc->fileName, reltab_j->Type);
2528 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2532 #endif /* defined(OBJFORMAT_PEi386) */
2535 /* --------------------------------------------------------------------------
2537 * ------------------------------------------------------------------------*/
2539 #if defined(OBJFORMAT_ELF)
2544 #if defined(sparc_HOST_ARCH)
2545 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2546 #elif defined(i386_HOST_ARCH)
2547 # define ELF_TARGET_386 /* Used inside <elf.h> */
2548 #elif defined(x86_64_HOST_ARCH)
2549 # define ELF_TARGET_X64_64
2551 #elif defined (ia64_HOST_ARCH)
2552 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2554 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2555 # define ELF_NEED_GOT /* needs Global Offset Table */
2556 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2559 #if !defined(openbsd_HOST_OS)
2561 # ifndef R_X86_64_PC64 /* If elf.h doesn't define it */
2562 # define R_X86_64_PC64 24
2565 /* openbsd elf has things in different places, with diff names */
2566 # include <elf_abi.h>
2567 # include <machine/reloc.h>
2568 # define R_386_32 RELOC_32
2569 # define R_386_PC32 RELOC_PC32
2573 * Define a set of types which can be used for both ELF32 and ELF64
2577 #define ELFCLASS ELFCLASS64
2578 #define Elf_Addr Elf64_Addr
2579 #define Elf_Word Elf64_Word
2580 #define Elf_Sword Elf64_Sword
2581 #define Elf_Ehdr Elf64_Ehdr
2582 #define Elf_Phdr Elf64_Phdr
2583 #define Elf_Shdr Elf64_Shdr
2584 #define Elf_Sym Elf64_Sym
2585 #define Elf_Rel Elf64_Rel
2586 #define Elf_Rela Elf64_Rela
2587 #define ELF_ST_TYPE ELF64_ST_TYPE
2588 #define ELF_ST_BIND ELF64_ST_BIND
2589 #define ELF_R_TYPE ELF64_R_TYPE
2590 #define ELF_R_SYM ELF64_R_SYM
2592 #define ELFCLASS ELFCLASS32
2593 #define Elf_Addr Elf32_Addr
2594 #define Elf_Word Elf32_Word
2595 #define Elf_Sword Elf32_Sword
2596 #define Elf_Ehdr Elf32_Ehdr
2597 #define Elf_Phdr Elf32_Phdr
2598 #define Elf_Shdr Elf32_Shdr
2599 #define Elf_Sym Elf32_Sym
2600 #define Elf_Rel Elf32_Rel
2601 #define Elf_Rela Elf32_Rela
2603 #define ELF_ST_TYPE ELF32_ST_TYPE
2606 #define ELF_ST_BIND ELF32_ST_BIND
2609 #define ELF_R_TYPE ELF32_R_TYPE
2612 #define ELF_R_SYM ELF32_R_SYM
2618 * Functions to allocate entries in dynamic sections. Currently we simply
2619 * preallocate a large number, and we don't check if a entry for the given
2620 * target already exists (a linear search is too slow). Ideally these
2621 * entries would be associated with symbols.
2624 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2625 #define GOT_SIZE 0x20000
2626 #define FUNCTION_TABLE_SIZE 0x10000
2627 #define PLT_SIZE 0x08000
2630 static Elf_Addr got[GOT_SIZE];
2631 static unsigned int gotIndex;
2632 static Elf_Addr gp_val = (Elf_Addr)got;
2635 allocateGOTEntry(Elf_Addr target)
2639 if (gotIndex >= GOT_SIZE)
2640 barf("Global offset table overflow");
2642 entry = &got[gotIndex++];
2644 return (Elf_Addr)entry;
2648 #ifdef ELF_FUNCTION_DESC
2654 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2655 static unsigned int functionTableIndex;
2658 allocateFunctionDesc(Elf_Addr target)
2660 FunctionDesc *entry;
2662 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2663 barf("Function table overflow");
2665 entry = &functionTable[functionTableIndex++];
2667 entry->gp = (Elf_Addr)gp_val;
2668 return (Elf_Addr)entry;
2672 copyFunctionDesc(Elf_Addr target)
2674 FunctionDesc *olddesc = (FunctionDesc *)target;
2675 FunctionDesc *newdesc;
2677 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2678 newdesc->gp = olddesc->gp;
2679 return (Elf_Addr)newdesc;
2684 #ifdef ia64_HOST_ARCH
2685 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2686 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2688 static unsigned char plt_code[] =
2690 /* taken from binutils bfd/elfxx-ia64.c */
2691 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2692 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2693 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2694 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2695 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2696 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2699 /* If we can't get to the function descriptor via gp, take a local copy of it */
2700 #define PLT_RELOC(code, target) { \
2701 Elf64_Sxword rel_value = target - gp_val; \
2702 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2703 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2705 ia64_reloc_gprel22((Elf_Addr)code, target); \
2710 unsigned char code[sizeof(plt_code)];
2714 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2716 PLTEntry *plt = (PLTEntry *)oc->plt;
2719 if (oc->pltIndex >= PLT_SIZE)
2720 barf("Procedure table overflow");
2722 entry = &plt[oc->pltIndex++];
2723 memcpy(entry->code, plt_code, sizeof(entry->code));
2724 PLT_RELOC(entry->code, target);
2725 return (Elf_Addr)entry;
2731 return (PLT_SIZE * sizeof(PLTEntry));
2736 #if x86_64_HOST_ARCH
2737 // On x86_64, 32-bit relocations are often used, which requires that
2738 // we can resolve a symbol to a 32-bit offset. However, shared
2739 // libraries are placed outside the 2Gb area, which leaves us with a
2740 // problem when we need to give a 32-bit offset to a symbol in a
2743 // For a function symbol, we can allocate a bounce sequence inside the
2744 // 2Gb area and resolve the symbol to this. The bounce sequence is
2745 // simply a long jump instruction to the real location of the symbol.
2747 // For data references, we're screwed.
2750 unsigned char jmp[8]; /* 6 byte instruction: jmpq *0x00000002(%rip) */
2754 #define X86_64_BB_SIZE 1024
2756 static x86_64_bounce *x86_64_bounce_buffer = NULL;
2757 static nat x86_64_bb_next_off;
2760 x86_64_high_symbol( char *lbl, void *addr )
2762 x86_64_bounce *bounce;
2764 if ( x86_64_bounce_buffer == NULL ||
2765 x86_64_bb_next_off >= X86_64_BB_SIZE ) {
2766 x86_64_bounce_buffer =
2767 mmap(NULL, X86_64_BB_SIZE * sizeof(x86_64_bounce),
2768 PROT_EXEC|PROT_READ|PROT_WRITE,
2769 MAP_PRIVATE|MAP_32BIT|MAP_ANONYMOUS, -1, 0);
2770 if (x86_64_bounce_buffer == MAP_FAILED) {
2771 barf("x86_64_high_symbol: mmap failed");
2773 x86_64_bb_next_off = 0;
2775 bounce = &x86_64_bounce_buffer[x86_64_bb_next_off];
2776 bounce->jmp[0] = 0xff;
2777 bounce->jmp[1] = 0x25;
2778 bounce->jmp[2] = 0x02;
2779 bounce->jmp[3] = 0x00;
2780 bounce->jmp[4] = 0x00;
2781 bounce->jmp[5] = 0x00;
2782 bounce->addr = addr;
2783 x86_64_bb_next_off++;
2785 IF_DEBUG(linker, debugBelch("x86_64: allocated bounce entry for %s->%p at %p\n",
2786 lbl, addr, bounce));
2788 insertStrHashTable(symhash, lbl, bounce);
2795 * Generic ELF functions
2799 findElfSection ( void* objImage, Elf_Word sh_type )
2801 char* ehdrC = (char*)objImage;
2802 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2803 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2804 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2808 for (i = 0; i < ehdr->e_shnum; i++) {
2809 if (shdr[i].sh_type == sh_type
2810 /* Ignore the section header's string table. */
2811 && i != ehdr->e_shstrndx
2812 /* Ignore string tables named .stabstr, as they contain
2814 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2816 ptr = ehdrC + shdr[i].sh_offset;
2823 #if defined(ia64_HOST_ARCH)
2825 findElfSegment ( void* objImage, Elf_Addr vaddr )
2827 char* ehdrC = (char*)objImage;
2828 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2829 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2830 Elf_Addr segaddr = 0;
2833 for (i = 0; i < ehdr->e_phnum; i++) {
2834 segaddr = phdr[i].p_vaddr;
2835 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2843 ocVerifyImage_ELF ( ObjectCode* oc )
2847 int i, j, nent, nstrtab, nsymtabs;
2851 char* ehdrC = (char*)(oc->image);
2852 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2854 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2855 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2856 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2857 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2858 errorBelch("%s: not an ELF object", oc->fileName);
2862 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2863 errorBelch("%s: unsupported ELF format", oc->fileName);
2867 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2868 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2870 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2871 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2873 errorBelch("%s: unknown endiannness", oc->fileName);
2877 if (ehdr->e_type != ET_REL) {
2878 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2881 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2883 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2884 switch (ehdr->e_machine) {
2885 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2886 #ifdef EM_SPARC32PLUS
2887 case EM_SPARC32PLUS:
2889 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2891 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2893 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2895 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2897 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2898 errorBelch("%s: unknown architecture", oc->fileName);
2902 IF_DEBUG(linker,debugBelch(
2903 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2904 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2906 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2908 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2910 if (ehdr->e_shstrndx == SHN_UNDEF) {
2911 errorBelch("%s: no section header string table", oc->fileName);
2914 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2916 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2919 for (i = 0; i < ehdr->e_shnum; i++) {
2920 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2921 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2922 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2923 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2924 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2925 ehdrC + shdr[i].sh_offset,
2926 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2928 if (shdr[i].sh_type == SHT_REL) {
2929 IF_DEBUG(linker,debugBelch("Rel " ));
2930 } else if (shdr[i].sh_type == SHT_RELA) {
2931 IF_DEBUG(linker,debugBelch("RelA " ));
2933 IF_DEBUG(linker,debugBelch(" "));
2936 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2940 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2943 for (i = 0; i < ehdr->e_shnum; i++) {
2944 if (shdr[i].sh_type == SHT_STRTAB
2945 /* Ignore the section header's string table. */
2946 && i != ehdr->e_shstrndx
2947 /* Ignore string tables named .stabstr, as they contain
2949 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2951 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2952 strtab = ehdrC + shdr[i].sh_offset;
2957 errorBelch("%s: no string tables, or too many", oc->fileName);
2962 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2963 for (i = 0; i < ehdr->e_shnum; i++) {
2964 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2965 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2967 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2968 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2969 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2971 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2973 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2974 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2977 for (j = 0; j < nent; j++) {
2978 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2979 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2980 (int)stab[j].st_shndx,
2981 (int)stab[j].st_size,
2982 (char*)stab[j].st_value ));
2984 IF_DEBUG(linker,debugBelch("type=" ));
2985 switch (ELF_ST_TYPE(stab[j].st_info)) {
2986 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
2987 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
2988 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
2989 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
2990 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
2991 default: IF_DEBUG(linker,debugBelch("? " )); break;
2993 IF_DEBUG(linker,debugBelch(" " ));
2995 IF_DEBUG(linker,debugBelch("bind=" ));
2996 switch (ELF_ST_BIND(stab[j].st_info)) {
2997 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
2998 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
2999 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
3000 default: IF_DEBUG(linker,debugBelch("? " )); break;
3002 IF_DEBUG(linker,debugBelch(" " ));
3004 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
3008 if (nsymtabs == 0) {
3009 errorBelch("%s: didn't find any symbol tables", oc->fileName);
3016 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
3020 if (hdr->sh_type == SHT_PROGBITS
3021 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
3022 /* .text-style section */
3023 return SECTIONKIND_CODE_OR_RODATA;
3026 if (hdr->sh_type == SHT_PROGBITS
3027 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3028 /* .data-style section */
3029 return SECTIONKIND_RWDATA;
3032 if (hdr->sh_type == SHT_PROGBITS
3033 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3034 /* .rodata-style section */
3035 return SECTIONKIND_CODE_OR_RODATA;
3038 if (hdr->sh_type == SHT_NOBITS
3039 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3040 /* .bss-style section */
3042 return SECTIONKIND_RWDATA;
3045 return SECTIONKIND_OTHER;
3050 ocGetNames_ELF ( ObjectCode* oc )
3055 char* ehdrC = (char*)(oc->image);
3056 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3057 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3058 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3060 ASSERT(symhash != NULL);
3063 errorBelch("%s: no strtab", oc->fileName);
3068 for (i = 0; i < ehdr->e_shnum; i++) {
3069 /* Figure out what kind of section it is. Logic derived from
3070 Figure 1.14 ("Special Sections") of the ELF document
3071 ("Portable Formats Specification, Version 1.1"). */
3073 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3075 if (is_bss && shdr[i].sh_size > 0) {
3076 /* This is a non-empty .bss section. Allocate zeroed space for
3077 it, and set its .sh_offset field such that
3078 ehdrC + .sh_offset == addr_of_zeroed_space. */
3079 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3080 "ocGetNames_ELF(BSS)");
3081 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3083 debugBelch("BSS section at 0x%x, size %d\n",
3084 zspace, shdr[i].sh_size);
3088 /* fill in the section info */
3089 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3090 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3091 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3092 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3095 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3097 /* copy stuff into this module's object symbol table */
3098 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3099 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3101 oc->n_symbols = nent;
3102 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3103 "ocGetNames_ELF(oc->symbols)");
3105 for (j = 0; j < nent; j++) {
3107 char isLocal = FALSE; /* avoids uninit-var warning */
3109 char* nm = strtab + stab[j].st_name;
3110 int secno = stab[j].st_shndx;
3112 /* Figure out if we want to add it; if so, set ad to its
3113 address. Otherwise leave ad == NULL. */
3115 if (secno == SHN_COMMON) {
3117 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3119 debugBelch("COMMON symbol, size %d name %s\n",
3120 stab[j].st_size, nm);
3122 /* Pointless to do addProddableBlock() for this area,
3123 since the linker should never poke around in it. */
3126 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3127 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3129 /* and not an undefined symbol */
3130 && stab[j].st_shndx != SHN_UNDEF
3131 /* and not in a "special section" */
3132 && stab[j].st_shndx < SHN_LORESERVE
3134 /* and it's a not a section or string table or anything silly */
3135 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3136 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3137 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3140 /* Section 0 is the undefined section, hence > and not >=. */
3141 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3143 if (shdr[secno].sh_type == SHT_NOBITS) {
3144 debugBelch(" BSS symbol, size %d off %d name %s\n",
3145 stab[j].st_size, stab[j].st_value, nm);
3148 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3149 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3152 #ifdef ELF_FUNCTION_DESC
3153 /* dlsym() and the initialisation table both give us function
3154 * descriptors, so to be consistent we store function descriptors
3155 * in the symbol table */
3156 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3157 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3159 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3160 ad, oc->fileName, nm ));
3165 /* And the decision is ... */
3169 oc->symbols[j] = nm;
3172 /* Ignore entirely. */
3174 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3178 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3179 strtab + stab[j].st_name ));
3182 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3183 (int)ELF_ST_BIND(stab[j].st_info),
3184 (int)ELF_ST_TYPE(stab[j].st_info),
3185 (int)stab[j].st_shndx,
3186 strtab + stab[j].st_name
3189 oc->symbols[j] = NULL;
3198 /* Do ELF relocations which lack an explicit addend. All x86-linux
3199 relocations appear to be of this form. */
3201 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3202 Elf_Shdr* shdr, int shnum,
3203 Elf_Sym* stab, char* strtab )
3208 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3209 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3210 int target_shndx = shdr[shnum].sh_info;
3211 int symtab_shndx = shdr[shnum].sh_link;
3213 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3214 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3215 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3216 target_shndx, symtab_shndx ));
3218 /* Skip sections that we're not interested in. */
3221 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3222 if (kind == SECTIONKIND_OTHER) {
3223 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3228 for (j = 0; j < nent; j++) {
3229 Elf_Addr offset = rtab[j].r_offset;
3230 Elf_Addr info = rtab[j].r_info;
3232 Elf_Addr P = ((Elf_Addr)targ) + offset;
3233 Elf_Word* pP = (Elf_Word*)P;
3238 StgStablePtr stablePtr;
3241 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3242 j, (void*)offset, (void*)info ));
3244 IF_DEBUG(linker,debugBelch( " ZERO" ));
3247 Elf_Sym sym = stab[ELF_R_SYM(info)];
3248 /* First see if it is a local symbol. */
3249 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3250 /* Yes, so we can get the address directly from the ELF symbol
3252 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3254 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3255 + stab[ELF_R_SYM(info)].st_value);
3258 symbol = strtab + sym.st_name;
3259 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3260 if (NULL == stablePtr) {
3261 /* No, so look up the name in our global table. */
3262 S_tmp = lookupSymbol( symbol );
3263 S = (Elf_Addr)S_tmp;
3265 stableVal = deRefStablePtr( stablePtr );
3267 S = (Elf_Addr)S_tmp;
3271 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3274 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3277 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3278 (void*)P, (void*)S, (void*)A ));
3279 checkProddableBlock ( oc, pP );
3283 switch (ELF_R_TYPE(info)) {
3284 # ifdef i386_HOST_ARCH
3285 case R_386_32: *pP = value; break;
3286 case R_386_PC32: *pP = value - P; break;
3289 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3290 oc->fileName, (lnat)ELF_R_TYPE(info));
3298 /* Do ELF relocations for which explicit addends are supplied.
3299 sparc-solaris relocations appear to be of this form. */
3301 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3302 Elf_Shdr* shdr, int shnum,
3303 Elf_Sym* stab, char* strtab )
3306 char *symbol = NULL;
3308 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3309 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3310 int target_shndx = shdr[shnum].sh_info;
3311 int symtab_shndx = shdr[shnum].sh_link;
3313 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3314 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3315 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3316 target_shndx, symtab_shndx ));
3318 for (j = 0; j < nent; j++) {
3319 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3320 /* This #ifdef only serves to avoid unused-var warnings. */
3321 Elf_Addr offset = rtab[j].r_offset;
3322 Elf_Addr P = targ + offset;
3324 Elf_Addr info = rtab[j].r_info;
3325 Elf_Addr A = rtab[j].r_addend;
3329 # if defined(sparc_HOST_ARCH)
3330 Elf_Word* pP = (Elf_Word*)P;
3332 # elif defined(ia64_HOST_ARCH)
3333 Elf64_Xword *pP = (Elf64_Xword *)P;
3335 # elif defined(powerpc_HOST_ARCH)
3339 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3340 j, (void*)offset, (void*)info,
3343 IF_DEBUG(linker,debugBelch( " ZERO" ));
3346 Elf_Sym sym = stab[ELF_R_SYM(info)];
3347 /* First see if it is a local symbol. */
3348 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3349 /* Yes, so we can get the address directly from the ELF symbol
3351 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3353 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3354 + stab[ELF_R_SYM(info)].st_value);
3355 #ifdef ELF_FUNCTION_DESC
3356 /* Make a function descriptor for this function */
3357 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3358 S = allocateFunctionDesc(S + A);
3363 /* No, so look up the name in our global table. */
3364 symbol = strtab + sym.st_name;
3365 S_tmp = lookupSymbol( symbol );
3366 S = (Elf_Addr)S_tmp;
3368 #ifdef ELF_FUNCTION_DESC
3369 /* If a function, already a function descriptor - we would
3370 have to copy it to add an offset. */
3371 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3372 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3376 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3379 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3382 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3383 (void*)P, (void*)S, (void*)A ));
3384 /* checkProddableBlock ( oc, (void*)P ); */
3388 switch (ELF_R_TYPE(info)) {
3389 # if defined(sparc_HOST_ARCH)
3390 case R_SPARC_WDISP30:
3391 w1 = *pP & 0xC0000000;
3392 w2 = (Elf_Word)((value - P) >> 2);
3393 ASSERT((w2 & 0xC0000000) == 0);
3398 w1 = *pP & 0xFFC00000;
3399 w2 = (Elf_Word)(value >> 10);
3400 ASSERT((w2 & 0xFFC00000) == 0);
3406 w2 = (Elf_Word)(value & 0x3FF);
3407 ASSERT((w2 & ~0x3FF) == 0);
3411 /* According to the Sun documentation:
3413 This relocation type resembles R_SPARC_32, except it refers to an
3414 unaligned word. That is, the word to be relocated must be treated
3415 as four separate bytes with arbitrary alignment, not as a word
3416 aligned according to the architecture requirements.
3418 (JRS: which means that freeloading on the R_SPARC_32 case
3419 is probably wrong, but hey ...)
3423 w2 = (Elf_Word)value;
3426 # elif defined(ia64_HOST_ARCH)
3427 case R_IA64_DIR64LSB:
3428 case R_IA64_FPTR64LSB:
3431 case R_IA64_PCREL64LSB:
3434 case R_IA64_SEGREL64LSB:
3435 addr = findElfSegment(ehdrC, value);
3438 case R_IA64_GPREL22:
3439 ia64_reloc_gprel22(P, value);
3441 case R_IA64_LTOFF22:
3442 case R_IA64_LTOFF22X:
3443 case R_IA64_LTOFF_FPTR22:
3444 addr = allocateGOTEntry(value);
3445 ia64_reloc_gprel22(P, addr);
3447 case R_IA64_PCREL21B:
3448 ia64_reloc_pcrel21(P, S, oc);
3451 /* This goes with R_IA64_LTOFF22X and points to the load to
3452 * convert into a move. We don't implement relaxation. */
3454 # elif defined(powerpc_HOST_ARCH)
3455 case R_PPC_ADDR16_LO:
3456 *(Elf32_Half*) P = value;
3459 case R_PPC_ADDR16_HI:
3460 *(Elf32_Half*) P = value >> 16;
3463 case R_PPC_ADDR16_HA:
3464 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3468 *(Elf32_Word *) P = value;
3472 *(Elf32_Word *) P = value - P;
3478 if( delta << 6 >> 6 != delta )
3480 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3484 if( value == 0 || delta << 6 >> 6 != delta )
3486 barf( "Unable to make SymbolExtra for #%d",
3492 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3493 | (delta & 0x3fffffc);
3497 #if x86_64_HOST_ARCH
3499 *(Elf64_Xword *)P = value;
3504 StgInt64 off = value - P;
3505 if (off >= 0x7fffffffL || off < -0x80000000L) {
3506 barf("R_X86_64_PC32 relocation out of range: %s = %p",
3509 *(Elf64_Word *)P = (Elf64_Word)off;
3515 StgInt64 off = value - P;
3516 *(Elf64_Word *)P = (Elf64_Word)off;
3521 if (value >= 0x7fffffffL) {
3522 barf("R_X86_64_32 relocation out of range: %s = %p\n",
3525 *(Elf64_Word *)P = (Elf64_Word)value;
3529 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3530 barf("R_X86_64_32S relocation out of range: %s = %p\n",
3533 *(Elf64_Sword *)P = (Elf64_Sword)value;
3538 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3539 oc->fileName, (lnat)ELF_R_TYPE(info));
3548 ocResolve_ELF ( ObjectCode* oc )
3552 Elf_Sym* stab = NULL;
3553 char* ehdrC = (char*)(oc->image);
3554 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3555 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3557 /* first find "the" symbol table */
3558 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3560 /* also go find the string table */
3561 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3563 if (stab == NULL || strtab == NULL) {
3564 errorBelch("%s: can't find string or symbol table", oc->fileName);
3568 /* Process the relocation sections. */
3569 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3570 if (shdr[shnum].sh_type == SHT_REL) {
3571 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3572 shnum, stab, strtab );
3576 if (shdr[shnum].sh_type == SHT_RELA) {
3577 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3578 shnum, stab, strtab );
3583 /* Free the local symbol table; we won't need it again. */
3584 freeHashTable(oc->lochash, NULL);
3587 #if defined(powerpc_HOST_ARCH)
3588 ocFlushInstructionCache( oc );
3596 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3597 * at the front. The following utility functions pack and unpack instructions, and
3598 * take care of the most common relocations.
3601 #ifdef ia64_HOST_ARCH
3604 ia64_extract_instruction(Elf64_Xword *target)
3607 int slot = (Elf_Addr)target & 3;
3608 target = (Elf_Addr)target & ~3;
3616 return ((w1 >> 5) & 0x1ffffffffff);
3618 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3622 barf("ia64_extract_instruction: invalid slot %p", target);
3627 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3629 int slot = (Elf_Addr)target & 3;
3630 target = (Elf_Addr)target & ~3;
3635 *target |= value << 5;
3638 *target |= value << 46;
3639 *(target+1) |= value >> 18;
3642 *(target+1) |= value << 23;
3648 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3650 Elf64_Xword instruction;
3651 Elf64_Sxword rel_value;
3653 rel_value = value - gp_val;
3654 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3655 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3657 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3658 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3659 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3660 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3661 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3662 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3666 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3668 Elf64_Xword instruction;
3669 Elf64_Sxword rel_value;
3672 entry = allocatePLTEntry(value, oc);
3674 rel_value = (entry >> 4) - (target >> 4);
3675 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3676 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3678 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3679 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3680 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3681 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3687 * PowerPC ELF specifics
3690 #ifdef powerpc_HOST_ARCH
3692 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3698 ehdr = (Elf_Ehdr *) oc->image;
3699 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3701 for( i = 0; i < ehdr->e_shnum; i++ )
3702 if( shdr[i].sh_type == SHT_SYMTAB )
3705 if( i == ehdr->e_shnum )
3707 errorBelch( "This ELF file contains no symtab" );
3711 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3713 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3714 shdr[i].sh_entsize, sizeof( Elf_Sym ) );
3719 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3722 #endif /* powerpc */
3726 /* --------------------------------------------------------------------------
3728 * ------------------------------------------------------------------------*/
3730 #if defined(OBJFORMAT_MACHO)
3733 Support for MachO linking on Darwin/MacOS X
3734 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3736 I hereby formally apologize for the hackish nature of this code.
3737 Things that need to be done:
3738 *) implement ocVerifyImage_MachO
3739 *) add still more sanity checks.
3742 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3743 #define mach_header mach_header_64
3744 #define segment_command segment_command_64
3745 #define section section_64
3746 #define nlist nlist_64
3749 #ifdef powerpc_HOST_ARCH
3750 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3752 struct mach_header *header = (struct mach_header *) oc->image;
3753 struct load_command *lc = (struct load_command *) (header + 1);
3756 for( i = 0; i < header->ncmds; i++ )
3758 if( lc->cmd == LC_SYMTAB )
3760 // Find out the first and last undefined external
3761 // symbol, so we don't have to allocate too many
3763 struct symtab_command *symLC = (struct symtab_command *) lc;
3764 unsigned min = symLC->nsyms, max = 0;
3765 struct nlist *nlist =
3766 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3768 for(i=0;i<symLC->nsyms;i++)
3770 if(nlist[i].n_type & N_STAB)
3772 else if(nlist[i].n_type & N_EXT)
3774 if((nlist[i].n_type & N_TYPE) == N_UNDF
3775 && (nlist[i].n_value == 0))
3785 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3790 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3792 return ocAllocateSymbolExtras(oc,0,0);
3795 #ifdef x86_64_HOST_ARCH
3796 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3798 struct mach_header *header = (struct mach_header *) oc->image;
3799 struct load_command *lc = (struct load_command *) (header + 1);
3802 for( i = 0; i < header->ncmds; i++ )
3804 if( lc->cmd == LC_SYMTAB )
3806 // Just allocate one entry for every symbol
3807 struct symtab_command *symLC = (struct symtab_command *) lc;
3809 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3812 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3814 return ocAllocateSymbolExtras(oc,0,0);
3818 static int ocVerifyImage_MachO(ObjectCode* oc)
3820 char *image = (char*) oc->image;
3821 struct mach_header *header = (struct mach_header*) image;
3823 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3824 if(header->magic != MH_MAGIC_64)
3827 if(header->magic != MH_MAGIC)
3830 // FIXME: do some more verifying here
3834 static int resolveImports(
3837 struct symtab_command *symLC,
3838 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3839 unsigned long *indirectSyms,
3840 struct nlist *nlist)
3843 size_t itemSize = 4;
3846 int isJumpTable = 0;
3847 if(!strcmp(sect->sectname,"__jump_table"))
3851 ASSERT(sect->reserved2 == itemSize);
3855 for(i=0; i*itemSize < sect->size;i++)
3857 // according to otool, reserved1 contains the first index into the indirect symbol table
3858 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3859 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3862 if((symbol->n_type & N_TYPE) == N_UNDF
3863 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3864 addr = (void*) (symbol->n_value);
3865 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3868 addr = lookupSymbol(nm);
3871 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3879 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3880 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3881 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3882 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3887 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3888 ((void**)(image + sect->offset))[i] = addr;
3895 static unsigned long relocateAddress(
3898 struct section* sections,
3899 unsigned long address)
3902 for(i = 0; i < nSections; i++)
3904 if(sections[i].addr <= address
3905 && address < sections[i].addr + sections[i].size)
3907 return (unsigned long)oc->image
3908 + sections[i].offset + address - sections[i].addr;
3911 barf("Invalid Mach-O file:"
3912 "Address out of bounds while relocating object file");
3916 static int relocateSection(
3919 struct symtab_command *symLC, struct nlist *nlist,
3920 int nSections, struct section* sections, struct section *sect)
3922 struct relocation_info *relocs;
3925 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3927 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3929 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3931 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3935 relocs = (struct relocation_info*) (image + sect->reloff);
3939 #ifdef x86_64_HOST_ARCH
3940 struct relocation_info *reloc = &relocs[i];
3942 char *thingPtr = image + sect->offset + reloc->r_address;
3946 int type = reloc->r_type;
3948 checkProddableBlock(oc,thingPtr);
3949 switch(reloc->r_length)
3952 thing = *(uint8_t*)thingPtr;
3953 baseValue = (uint64_t)thingPtr + 1;
3956 thing = *(uint16_t*)thingPtr;
3957 baseValue = (uint64_t)thingPtr + 2;
3960 thing = *(uint32_t*)thingPtr;
3961 baseValue = (uint64_t)thingPtr + 4;
3964 thing = *(uint64_t*)thingPtr;
3965 baseValue = (uint64_t)thingPtr + 8;
3968 barf("Unknown size.");
3971 if(type == X86_64_RELOC_GOT
3972 || type == X86_64_RELOC_GOT_LOAD)
3974 ASSERT(reloc->r_extern);
3975 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
3977 type = X86_64_RELOC_SIGNED;
3979 else if(reloc->r_extern)
3981 struct nlist *symbol = &nlist[reloc->r_symbolnum];
3982 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3983 if(symbol->n_value == 0)
3984 value = (uint64_t) lookupSymbol(nm);
3986 value = relocateAddress(oc, nSections, sections,
3991 value = sections[reloc->r_symbolnum-1].offset
3992 - sections[reloc->r_symbolnum-1].addr
3996 if(type == X86_64_RELOC_BRANCH)
3998 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4000 ASSERT(reloc->r_extern);
4001 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4004 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4005 type = X86_64_RELOC_SIGNED;
4010 case X86_64_RELOC_UNSIGNED:
4011 ASSERT(!reloc->r_pcrel);
4014 case X86_64_RELOC_SIGNED:
4015 ASSERT(reloc->r_pcrel);
4016 thing += value - baseValue;
4018 case X86_64_RELOC_SUBTRACTOR:
4019 ASSERT(!reloc->r_pcrel);
4023 barf("unkown relocation");
4026 switch(reloc->r_length)
4029 *(uint8_t*)thingPtr = thing;
4032 *(uint16_t*)thingPtr = thing;
4035 *(uint32_t*)thingPtr = thing;
4038 *(uint64_t*)thingPtr = thing;
4042 if(relocs[i].r_address & R_SCATTERED)
4044 struct scattered_relocation_info *scat =
4045 (struct scattered_relocation_info*) &relocs[i];
4049 if(scat->r_length == 2)
4051 unsigned long word = 0;
4052 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4053 checkProddableBlock(oc,wordPtr);
4055 // Note on relocation types:
4056 // i386 uses the GENERIC_RELOC_* types,
4057 // while ppc uses special PPC_RELOC_* types.
4058 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4059 // in both cases, all others are different.
4060 // Therefore, we use GENERIC_RELOC_VANILLA
4061 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4062 // and use #ifdefs for the other types.
4064 // Step 1: Figure out what the relocated value should be
4065 if(scat->r_type == GENERIC_RELOC_VANILLA)
4067 word = *wordPtr + (unsigned long) relocateAddress(
4074 #ifdef powerpc_HOST_ARCH
4075 else if(scat->r_type == PPC_RELOC_SECTDIFF
4076 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4077 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4078 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4080 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4083 struct scattered_relocation_info *pair =
4084 (struct scattered_relocation_info*) &relocs[i+1];
4086 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4087 barf("Invalid Mach-O file: "
4088 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4090 word = (unsigned long)
4091 (relocateAddress(oc, nSections, sections, scat->r_value)
4092 - relocateAddress(oc, nSections, sections, pair->r_value));
4095 #ifdef powerpc_HOST_ARCH
4096 else if(scat->r_type == PPC_RELOC_HI16
4097 || scat->r_type == PPC_RELOC_LO16
4098 || scat->r_type == PPC_RELOC_HA16
4099 || scat->r_type == PPC_RELOC_LO14)
4100 { // these are generated by label+offset things
4101 struct relocation_info *pair = &relocs[i+1];
4102 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4103 barf("Invalid Mach-O file: "
4104 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4106 if(scat->r_type == PPC_RELOC_LO16)
4108 word = ((unsigned short*) wordPtr)[1];
4109 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4111 else if(scat->r_type == PPC_RELOC_LO14)
4113 barf("Unsupported Relocation: PPC_RELOC_LO14");
4114 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4115 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4117 else if(scat->r_type == PPC_RELOC_HI16)
4119 word = ((unsigned short*) wordPtr)[1] << 16;
4120 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4122 else if(scat->r_type == PPC_RELOC_HA16)
4124 word = ((unsigned short*) wordPtr)[1] << 16;
4125 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4129 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4136 continue; // ignore the others
4138 #ifdef powerpc_HOST_ARCH
4139 if(scat->r_type == GENERIC_RELOC_VANILLA
4140 || scat->r_type == PPC_RELOC_SECTDIFF)
4142 if(scat->r_type == GENERIC_RELOC_VANILLA
4143 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4148 #ifdef powerpc_HOST_ARCH
4149 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4151 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4153 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4155 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4157 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4159 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4160 + ((word & (1<<15)) ? 1 : 0);
4166 continue; // FIXME: I hope it's OK to ignore all the others.
4170 struct relocation_info *reloc = &relocs[i];
4171 if(reloc->r_pcrel && !reloc->r_extern)
4174 if(reloc->r_length == 2)
4176 unsigned long word = 0;
4177 #ifdef powerpc_HOST_ARCH
4178 unsigned long jumpIsland = 0;
4179 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4180 // to avoid warning and to catch
4184 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4185 checkProddableBlock(oc,wordPtr);
4187 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4191 #ifdef powerpc_HOST_ARCH
4192 else if(reloc->r_type == PPC_RELOC_LO16)
4194 word = ((unsigned short*) wordPtr)[1];
4195 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4197 else if(reloc->r_type == PPC_RELOC_HI16)
4199 word = ((unsigned short*) wordPtr)[1] << 16;
4200 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4202 else if(reloc->r_type == PPC_RELOC_HA16)
4204 word = ((unsigned short*) wordPtr)[1] << 16;
4205 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4207 else if(reloc->r_type == PPC_RELOC_BR24)
4210 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4214 if(!reloc->r_extern)
4217 sections[reloc->r_symbolnum-1].offset
4218 - sections[reloc->r_symbolnum-1].addr
4225 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4226 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4227 void *symbolAddress = lookupSymbol(nm);
4230 errorBelch("\nunknown symbol `%s'", nm);
4236 #ifdef powerpc_HOST_ARCH
4237 // In the .o file, this should be a relative jump to NULL
4238 // and we'll change it to a relative jump to the symbol
4239 ASSERT(-word == reloc->r_address);
4240 jumpIsland = (unsigned long)
4241 &makeSymbolExtra(oc,
4243 (unsigned long) symbolAddress)
4247 offsetToJumpIsland = word + jumpIsland
4248 - (((long)image) + sect->offset - sect->addr);
4251 word += (unsigned long) symbolAddress
4252 - (((long)image) + sect->offset - sect->addr);
4256 word += (unsigned long) symbolAddress;
4260 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4265 #ifdef powerpc_HOST_ARCH
4266 else if(reloc->r_type == PPC_RELOC_LO16)
4268 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4271 else if(reloc->r_type == PPC_RELOC_HI16)
4273 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4276 else if(reloc->r_type == PPC_RELOC_HA16)
4278 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4279 + ((word & (1<<15)) ? 1 : 0);
4282 else if(reloc->r_type == PPC_RELOC_BR24)
4284 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4286 // The branch offset is too large.
4287 // Therefore, we try to use a jump island.
4290 barf("unconditional relative branch out of range: "
4291 "no jump island available");
4294 word = offsetToJumpIsland;
4295 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4296 barf("unconditional relative branch out of range: "
4297 "jump island out of range");
4299 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4304 barf("\nunknown relocation %d",reloc->r_type);
4312 static int ocGetNames_MachO(ObjectCode* oc)
4314 char *image = (char*) oc->image;
4315 struct mach_header *header = (struct mach_header*) image;
4316 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4317 unsigned i,curSymbol = 0;
4318 struct segment_command *segLC = NULL;
4319 struct section *sections;
4320 struct symtab_command *symLC = NULL;
4321 struct nlist *nlist;
4322 unsigned long commonSize = 0;
4323 char *commonStorage = NULL;
4324 unsigned long commonCounter;
4326 for(i=0;i<header->ncmds;i++)
4328 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4329 segLC = (struct segment_command*) lc;
4330 else if(lc->cmd == LC_SYMTAB)
4331 symLC = (struct symtab_command*) lc;
4332 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4335 sections = (struct section*) (segLC+1);
4336 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4340 barf("ocGetNames_MachO: no segment load command");
4342 for(i=0;i<segLC->nsects;i++)
4344 if(sections[i].size == 0)
4347 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4349 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4350 "ocGetNames_MachO(common symbols)");
4351 sections[i].offset = zeroFillArea - image;
4354 if(!strcmp(sections[i].sectname,"__text"))
4355 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4356 (void*) (image + sections[i].offset),
4357 (void*) (image + sections[i].offset + sections[i].size));
4358 else if(!strcmp(sections[i].sectname,"__const"))
4359 addSection(oc, SECTIONKIND_RWDATA,
4360 (void*) (image + sections[i].offset),
4361 (void*) (image + sections[i].offset + sections[i].size));
4362 else if(!strcmp(sections[i].sectname,"__data"))
4363 addSection(oc, SECTIONKIND_RWDATA,
4364 (void*) (image + sections[i].offset),
4365 (void*) (image + sections[i].offset + sections[i].size));
4366 else if(!strcmp(sections[i].sectname,"__bss")
4367 || !strcmp(sections[i].sectname,"__common"))
4368 addSection(oc, SECTIONKIND_RWDATA,
4369 (void*) (image + sections[i].offset),
4370 (void*) (image + sections[i].offset + sections[i].size));
4372 addProddableBlock(oc, (void*) (image + sections[i].offset),
4376 // count external symbols defined here
4380 for(i=0;i<symLC->nsyms;i++)
4382 if(nlist[i].n_type & N_STAB)
4384 else if(nlist[i].n_type & N_EXT)
4386 if((nlist[i].n_type & N_TYPE) == N_UNDF
4387 && (nlist[i].n_value != 0))
4389 commonSize += nlist[i].n_value;
4392 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4397 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4398 "ocGetNames_MachO(oc->symbols)");
4402 for(i=0;i<symLC->nsyms;i++)
4404 if(nlist[i].n_type & N_STAB)
4406 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4408 if(nlist[i].n_type & N_EXT)
4410 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4411 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4412 ; // weak definition, and we already have a definition
4415 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4417 + sections[nlist[i].n_sect-1].offset
4418 - sections[nlist[i].n_sect-1].addr
4419 + nlist[i].n_value);
4420 oc->symbols[curSymbol++] = nm;
4427 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4428 commonCounter = (unsigned long)commonStorage;
4431 for(i=0;i<symLC->nsyms;i++)
4433 if((nlist[i].n_type & N_TYPE) == N_UNDF
4434 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4436 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4437 unsigned long sz = nlist[i].n_value;
4439 nlist[i].n_value = commonCounter;
4441 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4442 (void*)commonCounter);
4443 oc->symbols[curSymbol++] = nm;
4445 commonCounter += sz;
4452 static int ocResolve_MachO(ObjectCode* oc)
4454 char *image = (char*) oc->image;
4455 struct mach_header *header = (struct mach_header*) image;
4456 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4458 struct segment_command *segLC = NULL;
4459 struct section *sections;
4460 struct symtab_command *symLC = NULL;
4461 struct dysymtab_command *dsymLC = NULL;
4462 struct nlist *nlist;
4464 for(i=0;i<header->ncmds;i++)
4466 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4467 segLC = (struct segment_command*) lc;
4468 else if(lc->cmd == LC_SYMTAB)
4469 symLC = (struct symtab_command*) lc;
4470 else if(lc->cmd == LC_DYSYMTAB)
4471 dsymLC = (struct dysymtab_command*) lc;
4472 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4475 sections = (struct section*) (segLC+1);
4476 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4481 unsigned long *indirectSyms
4482 = (unsigned long*) (image + dsymLC->indirectsymoff);
4484 for(i=0;i<segLC->nsects;i++)
4486 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4487 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4488 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4490 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4493 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4494 || !strcmp(sections[i].sectname,"__pointers"))
4496 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4499 else if(!strcmp(sections[i].sectname,"__jump_table"))
4501 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4507 for(i=0;i<segLC->nsects;i++)
4509 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4513 /* Free the local symbol table; we won't need it again. */
4514 freeHashTable(oc->lochash, NULL);
4517 #if defined (powerpc_HOST_ARCH)
4518 ocFlushInstructionCache( oc );
4524 #ifdef powerpc_HOST_ARCH
4526 * The Mach-O object format uses leading underscores. But not everywhere.
4527 * There is a small number of runtime support functions defined in
4528 * libcc_dynamic.a whose name does not have a leading underscore.
4529 * As a consequence, we can't get their address from C code.
4530 * We have to use inline assembler just to take the address of a function.
4534 static void machoInitSymbolsWithoutUnderscore()
4536 extern void* symbolsWithoutUnderscore[];
4537 void **p = symbolsWithoutUnderscore;
4538 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4542 __asm__ volatile(".long " # x);
4544 RTS_MACHO_NOUNDERLINE_SYMBOLS
4546 __asm__ volatile(".text");
4550 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4552 RTS_MACHO_NOUNDERLINE_SYMBOLS
4559 * Figure out by how much to shift the entire Mach-O file in memory
4560 * when loading so that its single segment ends up 16-byte-aligned
4562 static int machoGetMisalignment( FILE * f )
4564 struct mach_header header;
4567 fread(&header, sizeof(header), 1, f);
4570 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4571 if(header.magic != MH_MAGIC_64)
4574 if(header.magic != MH_MAGIC)
4578 misalignment = (header.sizeofcmds + sizeof(header))
4581 return misalignment ? (16 - misalignment) : 0;