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 * MAP_32BIT not available on OpenBSD/amd64
1294 #if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
1295 #define EXTRA_MAP_FLAGS MAP_32BIT
1297 #define EXTRA_MAP_FLAGS 0
1300 /* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
1301 #if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
1302 #define MAP_ANONYMOUS MAP_ANON
1305 oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE,
1306 MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1307 if (oc->image == MAP_FAILED)
1308 barf("loadObj: can't map `%s'", path);
1312 #else /* !USE_MMAP */
1314 /* load the image into memory */
1315 f = fopen(path, "rb");
1317 barf("loadObj: can't read `%s'", path);
1319 # if defined(mingw32_HOST_OS)
1320 // TODO: We would like to use allocateExec here, but allocateExec
1321 // cannot currently allocate blocks large enough.
1322 oc->image = VirtualAlloc(NULL, oc->fileSize, MEM_RESERVE | MEM_COMMIT,
1323 PAGE_EXECUTE_READWRITE);
1324 # elif defined(darwin_HOST_OS)
1325 // In a Mach-O .o file, all sections can and will be misaligned
1326 // if the total size of the headers is not a multiple of the
1327 // desired alignment. This is fine for .o files that only serve
1328 // as input for the static linker, but it's not fine for us,
1329 // as SSE (used by gcc for floating point) and Altivec require
1330 // 16-byte alignment.
1331 // We calculate the correct alignment from the header before
1332 // reading the file, and then we misalign oc->image on purpose so
1333 // that the actual sections end up aligned again.
1334 oc->misalignment = machoGetMisalignment(f);
1335 oc->image = stgMallocBytes(oc->fileSize + oc->misalignment, "loadObj(image)");
1336 oc->image += oc->misalignment;
1338 oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");
1341 n = fread ( oc->image, 1, oc->fileSize, f );
1342 if (n != oc->fileSize)
1343 barf("loadObj: error whilst reading `%s'", path);
1346 #endif /* USE_MMAP */
1348 # if defined(OBJFORMAT_MACHO) && (defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH))
1349 r = ocAllocateSymbolExtras_MachO ( oc );
1350 if (!r) { return r; }
1351 # elif defined(OBJFORMAT_ELF) && defined(powerpc_HOST_ARCH)
1352 r = ocAllocateSymbolExtras_ELF ( oc );
1353 if (!r) { return r; }
1356 /* verify the in-memory image */
1357 # if defined(OBJFORMAT_ELF)
1358 r = ocVerifyImage_ELF ( oc );
1359 # elif defined(OBJFORMAT_PEi386)
1360 r = ocVerifyImage_PEi386 ( oc );
1361 # elif defined(OBJFORMAT_MACHO)
1362 r = ocVerifyImage_MachO ( oc );
1364 barf("loadObj: no verify method");
1366 if (!r) { return r; }
1368 /* build the symbol list for this image */
1369 # if defined(OBJFORMAT_ELF)
1370 r = ocGetNames_ELF ( oc );
1371 # elif defined(OBJFORMAT_PEi386)
1372 r = ocGetNames_PEi386 ( oc );
1373 # elif defined(OBJFORMAT_MACHO)
1374 r = ocGetNames_MachO ( oc );
1376 barf("loadObj: no getNames method");
1378 if (!r) { return r; }
1380 /* loaded, but not resolved yet */
1381 oc->status = OBJECT_LOADED;
1386 /* -----------------------------------------------------------------------------
1387 * resolve all the currently unlinked objects in memory
1389 * Returns: 1 if ok, 0 on error.
1399 for (oc = objects; oc; oc = oc->next) {
1400 if (oc->status != OBJECT_RESOLVED) {
1401 # if defined(OBJFORMAT_ELF)
1402 r = ocResolve_ELF ( oc );
1403 # elif defined(OBJFORMAT_PEi386)
1404 r = ocResolve_PEi386 ( oc );
1405 # elif defined(OBJFORMAT_MACHO)
1406 r = ocResolve_MachO ( oc );
1408 barf("resolveObjs: not implemented on this platform");
1410 if (!r) { return r; }
1411 oc->status = OBJECT_RESOLVED;
1417 /* -----------------------------------------------------------------------------
1418 * delete an object from the pool
1421 unloadObj( char *path )
1423 ObjectCode *oc, *prev;
1425 ASSERT(symhash != NULL);
1426 ASSERT(objects != NULL);
1431 for (oc = objects; oc; prev = oc, oc = oc->next) {
1432 if (!strcmp(oc->fileName,path)) {
1434 /* Remove all the mappings for the symbols within this
1439 for (i = 0; i < oc->n_symbols; i++) {
1440 if (oc->symbols[i] != NULL) {
1441 removeStrHashTable(symhash, oc->symbols[i], NULL);
1449 prev->next = oc->next;
1452 // We're going to leave this in place, in case there are
1453 // any pointers from the heap into it:
1454 // #ifdef mingw32_HOST_OS
1455 // VirtualFree(oc->image);
1457 // stgFree(oc->image);
1459 stgFree(oc->fileName);
1460 stgFree(oc->symbols);
1461 stgFree(oc->sections);
1462 /* The local hash table should have been freed at the end
1463 of the ocResolve_ call on it. */
1464 ASSERT(oc->lochash == NULL);
1470 errorBelch("unloadObj: can't find `%s' to unload", path);
1474 /* -----------------------------------------------------------------------------
1475 * Sanity checking. For each ObjectCode, maintain a list of address ranges
1476 * which may be prodded during relocation, and abort if we try and write
1477 * outside any of these.
1479 static void addProddableBlock ( ObjectCode* oc, void* start, int size )
1482 = stgMallocBytes(sizeof(ProddableBlock), "addProddableBlock");
1483 /* debugBelch("aPB %p %p %d\n", oc, start, size); */
1487 pb->next = oc->proddables;
1488 oc->proddables = pb;
1491 static void checkProddableBlock ( ObjectCode* oc, void* addr )
1494 for (pb = oc->proddables; pb != NULL; pb = pb->next) {
1495 char* s = (char*)(pb->start);
1496 char* e = s + pb->size - 1;
1497 char* a = (char*)addr;
1498 /* Assumes that the biggest fixup involves a 4-byte write. This
1499 probably needs to be changed to 8 (ie, +7) on 64-bit
1501 if (a >= s && (a+3) <= e) return;
1503 barf("checkProddableBlock: invalid fixup in runtime linker");
1506 /* -----------------------------------------------------------------------------
1507 * Section management.
1509 static void addSection ( ObjectCode* oc, SectionKind kind,
1510 void* start, void* end )
1512 Section* s = stgMallocBytes(sizeof(Section), "addSection");
1516 s->next = oc->sections;
1519 debugBelch("addSection: %p-%p (size %d), kind %d\n",
1520 start, ((char*)end)-1, end - start + 1, kind );
1525 /* --------------------------------------------------------------------------
1527 * This is about allocating a small chunk of memory for every symbol in the
1528 * object file. We make sure that the SymboLExtras are always "in range" of
1529 * limited-range PC-relative instructions on various platforms by allocating
1530 * them right next to the object code itself.
1533 #if defined(powerpc_HOST_ARCH) || (defined(x86_64_HOST_ARCH) \
1534 && defined(darwin_TARGET_OS))
1537 ocAllocateSymbolExtras
1539 Allocate additional space at the end of the object file image to make room
1540 for jump islands (powerpc, x86_64) and GOT entries (x86_64).
1542 PowerPC relative branch instructions have a 24 bit displacement field.
1543 As PPC code is always 4-byte-aligned, this yields a +-32MB range.
1544 If a particular imported symbol is outside this range, we have to redirect
1545 the jump to a short piece of new code that just loads the 32bit absolute
1546 address and jumps there.
1547 On x86_64, PC-relative jumps and PC-relative accesses to the GOT are limited
1550 This function just allocates space for one SymbolExtra for every
1551 undefined symbol in the object file. The code for the jump islands is
1552 filled in by makeSymbolExtra below.
1555 static int ocAllocateSymbolExtras( ObjectCode* oc, int count, int first )
1561 int misalignment = 0;
1563 misalignment = oc->misalignment;
1568 // round up to the nearest 4
1569 aligned = (oc->fileSize + 3) & ~3;
1572 #ifndef linux_HOST_OS /* mremap is a linux extension */
1573 #error ocAllocateSymbolExtras doesnt want USE_MMAP to be defined
1576 pagesize = getpagesize();
1577 n = ROUND_UP( oc->fileSize, pagesize );
1578 m = ROUND_UP( aligned + sizeof (SymbolExtra) * count, pagesize );
1580 /* If we have a half-page-size file and map one page of it then
1581 * the part of the page after the size of the file remains accessible.
1582 * If, however, we map in 2 pages, the 2nd page is not accessible
1583 * and will give a "Bus Error" on access. To get around this, we check
1584 * if we need any extra pages for the jump islands and map them in
1585 * anonymously. We must check that we actually require extra pages
1586 * otherwise the attempt to mmap 0 pages of anonymous memory will
1592 /* The effect of this mremap() call is only the ensure that we have
1593 * a sufficient number of virtually contiguous pages. As returned from
1594 * mremap, the pages past the end of the file are not backed. We give
1595 * them a backing by using MAP_FIXED to map in anonymous pages.
1597 oc->image = mremap( oc->image, n, m, MREMAP_MAYMOVE );
1599 if( oc->image == MAP_FAILED )
1601 errorBelch( "Unable to mremap for Jump Islands\n" );
1605 if( mmap( oc->image + n, m - n, PROT_READ | PROT_WRITE | PROT_EXEC,
1606 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, 0, 0 ) == MAP_FAILED )
1608 errorBelch( "Unable to mmap( MAP_FIXED ) for Jump Islands\n" );
1614 oc->image -= misalignment;
1615 oc->image = stgReallocBytes( oc->image,
1617 aligned + sizeof (SymbolExtra) * count,
1618 "ocAllocateSymbolExtras" );
1619 oc->image += misalignment;
1620 #endif /* USE_MMAP */
1622 oc->symbol_extras = (SymbolExtra *) (oc->image + aligned);
1623 memset( oc->symbol_extras, 0, sizeof (SymbolExtra) * count );
1626 oc->symbol_extras = NULL;
1628 oc->first_symbol_extra = first;
1629 oc->n_symbol_extras = count;
1634 static SymbolExtra* makeSymbolExtra( ObjectCode* oc,
1635 unsigned long symbolNumber,
1636 unsigned long target )
1640 ASSERT( symbolNumber >= oc->first_symbol_extra
1641 && symbolNumber - oc->first_symbol_extra < oc->n_symbol_extras);
1643 extra = &oc->symbol_extras[symbolNumber - oc->first_symbol_extra];
1645 #ifdef powerpc_HOST_ARCH
1646 // lis r12, hi16(target)
1647 extra->jumpIsland.lis_r12 = 0x3d80;
1648 extra->jumpIsland.hi_addr = target >> 16;
1650 // ori r12, r12, lo16(target)
1651 extra->jumpIsland.ori_r12_r12 = 0x618c;
1652 extra->jumpIsland.lo_addr = target & 0xffff;
1655 extra->jumpIsland.mtctr_r12 = 0x7d8903a6;
1658 extra->jumpIsland.bctr = 0x4e800420;
1660 #ifdef x86_64_HOST_ARCH
1662 static uint8_t jmp[] = { 0xFF, 0x25, 0xF2, 0xFF, 0xFF, 0xFF };
1663 extra->addr = target;
1664 memcpy(extra->jumpIsland, jmp, 6);
1672 /* --------------------------------------------------------------------------
1673 * PowerPC specifics (instruction cache flushing)
1674 * ------------------------------------------------------------------------*/
1676 #ifdef powerpc_TARGET_ARCH
1678 ocFlushInstructionCache
1680 Flush the data & instruction caches.
1681 Because the PPC has split data/instruction caches, we have to
1682 do that whenever we modify code at runtime.
1685 static void ocFlushInstructionCache( ObjectCode *oc )
1687 int n = (oc->fileSize + sizeof( SymbolExtra ) * oc->n_symbol_extras + 3) / 4;
1688 unsigned long *p = (unsigned long *) oc->image;
1692 __asm__ volatile ( "dcbf 0,%0\n\t"
1700 __asm__ volatile ( "sync\n\t"
1706 /* --------------------------------------------------------------------------
1707 * PEi386 specifics (Win32 targets)
1708 * ------------------------------------------------------------------------*/
1710 /* The information for this linker comes from
1711 Microsoft Portable Executable
1712 and Common Object File Format Specification
1713 revision 5.1 January 1998
1714 which SimonM says comes from the MS Developer Network CDs.
1716 It can be found there (on older CDs), but can also be found
1719 http://www.microsoft.com/hwdev/hardware/PECOFF.asp
1721 (this is Rev 6.0 from February 1999).
1723 Things move, so if that fails, try searching for it via
1725 http://www.google.com/search?q=PE+COFF+specification
1727 The ultimate reference for the PE format is the Winnt.h
1728 header file that comes with the Platform SDKs; as always,
1729 implementations will drift wrt their documentation.
1731 A good background article on the PE format is Matt Pietrek's
1732 March 1994 article in Microsoft System Journal (MSJ)
1733 (Vol.9, No. 3): "Peering Inside the PE: A Tour of the
1734 Win32 Portable Executable File Format." The info in there
1735 has recently been updated in a two part article in
1736 MSDN magazine, issues Feb and March 2002,
1737 "Inside Windows: An In-Depth Look into the Win32 Portable
1738 Executable File Format"
1740 John Levine's book "Linkers and Loaders" contains useful
1745 #if defined(OBJFORMAT_PEi386)
1749 typedef unsigned char UChar;
1750 typedef unsigned short UInt16;
1751 typedef unsigned int UInt32;
1758 UInt16 NumberOfSections;
1759 UInt32 TimeDateStamp;
1760 UInt32 PointerToSymbolTable;
1761 UInt32 NumberOfSymbols;
1762 UInt16 SizeOfOptionalHeader;
1763 UInt16 Characteristics;
1767 #define sizeof_COFF_header 20
1774 UInt32 VirtualAddress;
1775 UInt32 SizeOfRawData;
1776 UInt32 PointerToRawData;
1777 UInt32 PointerToRelocations;
1778 UInt32 PointerToLinenumbers;
1779 UInt16 NumberOfRelocations;
1780 UInt16 NumberOfLineNumbers;
1781 UInt32 Characteristics;
1785 #define sizeof_COFF_section 40
1792 UInt16 SectionNumber;
1795 UChar NumberOfAuxSymbols;
1799 #define sizeof_COFF_symbol 18
1804 UInt32 VirtualAddress;
1805 UInt32 SymbolTableIndex;
1810 #define sizeof_COFF_reloc 10
1813 /* From PE spec doc, section 3.3.2 */
1814 /* Note use of MYIMAGE_* since IMAGE_* are already defined in
1815 windows.h -- for the same purpose, but I want to know what I'm
1817 #define MYIMAGE_FILE_RELOCS_STRIPPED 0x0001
1818 #define MYIMAGE_FILE_EXECUTABLE_IMAGE 0x0002
1819 #define MYIMAGE_FILE_DLL 0x2000
1820 #define MYIMAGE_FILE_SYSTEM 0x1000
1821 #define MYIMAGE_FILE_BYTES_REVERSED_HI 0x8000
1822 #define MYIMAGE_FILE_BYTES_REVERSED_LO 0x0080
1823 #define MYIMAGE_FILE_32BIT_MACHINE 0x0100
1825 /* From PE spec doc, section 5.4.2 and 5.4.4 */
1826 #define MYIMAGE_SYM_CLASS_EXTERNAL 2
1827 #define MYIMAGE_SYM_CLASS_STATIC 3
1828 #define MYIMAGE_SYM_UNDEFINED 0
1830 /* From PE spec doc, section 4.1 */
1831 #define MYIMAGE_SCN_CNT_CODE 0x00000020
1832 #define MYIMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
1833 #define MYIMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
1835 /* From PE spec doc, section 5.2.1 */
1836 #define MYIMAGE_REL_I386_DIR32 0x0006
1837 #define MYIMAGE_REL_I386_REL32 0x0014
1840 /* We use myindex to calculate array addresses, rather than
1841 simply doing the normal subscript thing. That's because
1842 some of the above structs have sizes which are not
1843 a whole number of words. GCC rounds their sizes up to a
1844 whole number of words, which means that the address calcs
1845 arising from using normal C indexing or pointer arithmetic
1846 are just plain wrong. Sigh.
1849 myindex ( int scale, void* base, int index )
1852 ((UChar*)base) + scale * index;
1857 printName ( UChar* name, UChar* strtab )
1859 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1860 UInt32 strtab_offset = * (UInt32*)(name+4);
1861 debugBelch("%s", strtab + strtab_offset );
1864 for (i = 0; i < 8; i++) {
1865 if (name[i] == 0) break;
1866 debugBelch("%c", name[i] );
1873 copyName ( UChar* name, UChar* strtab, UChar* dst, int dstSize )
1875 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1876 UInt32 strtab_offset = * (UInt32*)(name+4);
1877 strncpy ( dst, strtab+strtab_offset, dstSize );
1883 if (name[i] == 0) break;
1893 cstring_from_COFF_symbol_name ( UChar* name, UChar* strtab )
1896 /* If the string is longer than 8 bytes, look in the
1897 string table for it -- this will be correctly zero terminated.
1899 if (name[0]==0 && name[1]==0 && name[2]==0 && name[3]==0) {
1900 UInt32 strtab_offset = * (UInt32*)(name+4);
1901 return ((UChar*)strtab) + strtab_offset;
1903 /* Otherwise, if shorter than 8 bytes, return the original,
1904 which by defn is correctly terminated.
1906 if (name[7]==0) return name;
1907 /* The annoying case: 8 bytes. Copy into a temporary
1908 (which is never freed ...)
1910 newstr = stgMallocBytes(9, "cstring_from_COFF_symbol_name");
1912 strncpy(newstr,name,8);
1918 /* Just compares the short names (first 8 chars) */
1919 static COFF_section *
1920 findPEi386SectionCalled ( ObjectCode* oc, char* name )
1924 = (COFF_header*)(oc->image);
1925 COFF_section* sectab
1927 ((UChar*)(oc->image))
1928 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1930 for (i = 0; i < hdr->NumberOfSections; i++) {
1933 COFF_section* section_i
1935 myindex ( sizeof_COFF_section, sectab, i );
1936 n1 = (UChar*) &(section_i->Name);
1938 if (n1[0]==n2[0] && n1[1]==n2[1] && n1[2]==n2[2] &&
1939 n1[3]==n2[3] && n1[4]==n2[4] && n1[5]==n2[5] &&
1940 n1[6]==n2[6] && n1[7]==n2[7])
1949 zapTrailingAtSign ( UChar* sym )
1951 # define my_isdigit(c) ((c) >= '0' && (c) <= '9')
1953 if (sym[0] == 0) return;
1955 while (sym[i] != 0) i++;
1958 while (j > 0 && my_isdigit(sym[j])) j--;
1959 if (j > 0 && sym[j] == '@' && j != i) sym[j] = 0;
1965 ocVerifyImage_PEi386 ( ObjectCode* oc )
1970 COFF_section* sectab;
1971 COFF_symbol* symtab;
1973 /* debugBelch("\nLOADING %s\n", oc->fileName); */
1974 hdr = (COFF_header*)(oc->image);
1975 sectab = (COFF_section*) (
1976 ((UChar*)(oc->image))
1977 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
1979 symtab = (COFF_symbol*) (
1980 ((UChar*)(oc->image))
1981 + hdr->PointerToSymbolTable
1983 strtab = ((UChar*)symtab)
1984 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
1986 if (hdr->Machine != 0x14c) {
1987 errorBelch("%s: Not x86 PEi386", oc->fileName);
1990 if (hdr->SizeOfOptionalHeader != 0) {
1991 errorBelch("%s: PEi386 with nonempty optional header", oc->fileName);
1994 if ( /* (hdr->Characteristics & MYIMAGE_FILE_RELOCS_STRIPPED) || */
1995 (hdr->Characteristics & MYIMAGE_FILE_EXECUTABLE_IMAGE) ||
1996 (hdr->Characteristics & MYIMAGE_FILE_DLL) ||
1997 (hdr->Characteristics & MYIMAGE_FILE_SYSTEM) ) {
1998 errorBelch("%s: Not a PEi386 object file", oc->fileName);
2001 if ( (hdr->Characteristics & MYIMAGE_FILE_BYTES_REVERSED_HI)
2002 /* || !(hdr->Characteristics & MYIMAGE_FILE_32BIT_MACHINE) */ ) {
2003 errorBelch("%s: Invalid PEi386 word size or endiannness: %d",
2005 (int)(hdr->Characteristics));
2008 /* If the string table size is way crazy, this might indicate that
2009 there are more than 64k relocations, despite claims to the
2010 contrary. Hence this test. */
2011 /* debugBelch("strtab size %d\n", * (UInt32*)strtab); */
2013 if ( (*(UInt32*)strtab) > 600000 ) {
2014 /* Note that 600k has no special significance other than being
2015 big enough to handle the almost-2MB-sized lumps that
2016 constitute HSwin32*.o. */
2017 debugBelch("PEi386 object has suspiciously large string table; > 64k relocs?");
2022 /* No further verification after this point; only debug printing. */
2024 IF_DEBUG(linker, i=1);
2025 if (i == 0) return 1;
2027 debugBelch( "sectab offset = %d\n", ((UChar*)sectab) - ((UChar*)hdr) );
2028 debugBelch( "symtab offset = %d\n", ((UChar*)symtab) - ((UChar*)hdr) );
2029 debugBelch( "strtab offset = %d\n", ((UChar*)strtab) - ((UChar*)hdr) );
2032 debugBelch( "Machine: 0x%x\n", (UInt32)(hdr->Machine) );
2033 debugBelch( "# sections: %d\n", (UInt32)(hdr->NumberOfSections) );
2034 debugBelch( "time/date: 0x%x\n", (UInt32)(hdr->TimeDateStamp) );
2035 debugBelch( "symtab offset: %d\n", (UInt32)(hdr->PointerToSymbolTable) );
2036 debugBelch( "# symbols: %d\n", (UInt32)(hdr->NumberOfSymbols) );
2037 debugBelch( "sz of opt hdr: %d\n", (UInt32)(hdr->SizeOfOptionalHeader) );
2038 debugBelch( "characteristics: 0x%x\n", (UInt32)(hdr->Characteristics) );
2040 /* Print the section table. */
2042 for (i = 0; i < hdr->NumberOfSections; i++) {
2044 COFF_section* sectab_i
2046 myindex ( sizeof_COFF_section, sectab, i );
2053 printName ( sectab_i->Name, strtab );
2063 sectab_i->VirtualSize,
2064 sectab_i->VirtualAddress,
2065 sectab_i->SizeOfRawData,
2066 sectab_i->PointerToRawData,
2067 sectab_i->NumberOfRelocations,
2068 sectab_i->PointerToRelocations,
2069 sectab_i->PointerToRawData
2071 reltab = (COFF_reloc*) (
2072 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2075 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2076 /* If the relocation field (a short) has overflowed, the
2077 * real count can be found in the first reloc entry.
2079 * See Section 4.1 (last para) of the PE spec (rev6.0).
2081 COFF_reloc* rel = (COFF_reloc*)
2082 myindex ( sizeof_COFF_reloc, reltab, 0 );
2083 noRelocs = rel->VirtualAddress;
2086 noRelocs = sectab_i->NumberOfRelocations;
2090 for (; j < noRelocs; j++) {
2092 COFF_reloc* rel = (COFF_reloc*)
2093 myindex ( sizeof_COFF_reloc, reltab, j );
2095 " type 0x%-4x vaddr 0x%-8x name `",
2097 rel->VirtualAddress );
2098 sym = (COFF_symbol*)
2099 myindex ( sizeof_COFF_symbol, symtab, rel->SymbolTableIndex );
2100 /* Hmm..mysterious looking offset - what's it for? SOF */
2101 printName ( sym->Name, strtab -10 );
2108 debugBelch("string table has size 0x%x\n", * (UInt32*)strtab );
2109 debugBelch("---START of string table---\n");
2110 for (i = 4; i < *(Int32*)strtab; i++) {
2112 debugBelch("\n"); else
2113 debugBelch("%c", strtab[i] );
2115 debugBelch("--- END of string table---\n");
2120 COFF_symbol* symtab_i;
2121 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2122 symtab_i = (COFF_symbol*)
2123 myindex ( sizeof_COFF_symbol, symtab, i );
2129 printName ( symtab_i->Name, strtab );
2138 (Int32)(symtab_i->SectionNumber),
2139 (UInt32)symtab_i->Type,
2140 (UInt32)symtab_i->StorageClass,
2141 (UInt32)symtab_i->NumberOfAuxSymbols
2143 i += symtab_i->NumberOfAuxSymbols;
2153 ocGetNames_PEi386 ( ObjectCode* oc )
2156 COFF_section* sectab;
2157 COFF_symbol* symtab;
2164 hdr = (COFF_header*)(oc->image);
2165 sectab = (COFF_section*) (
2166 ((UChar*)(oc->image))
2167 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2169 symtab = (COFF_symbol*) (
2170 ((UChar*)(oc->image))
2171 + hdr->PointerToSymbolTable
2173 strtab = ((UChar*)(oc->image))
2174 + hdr->PointerToSymbolTable
2175 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2177 /* Allocate space for any (local, anonymous) .bss sections. */
2179 for (i = 0; i < hdr->NumberOfSections; i++) {
2182 COFF_section* sectab_i
2184 myindex ( sizeof_COFF_section, sectab, i );
2185 if (0 != strcmp(sectab_i->Name, ".bss")) continue;
2186 /* sof 10/05: the PE spec text isn't too clear regarding what
2187 * the SizeOfRawData field is supposed to hold for object
2188 * file sections containing just uninitialized data -- for executables,
2189 * it is supposed to be zero; unclear what it's supposed to be
2190 * for object files. However, VirtualSize is guaranteed to be
2191 * zero for object files, which definitely suggests that SizeOfRawData
2192 * will be non-zero (where else would the size of this .bss section be
2193 * stored?) Looking at the COFF_section info for incoming object files,
2194 * this certainly appears to be the case.
2196 * => I suspect we've been incorrectly handling .bss sections in (relocatable)
2197 * object files up until now. This turned out to bite us with ghc-6.4.1's use
2198 * of gcc-3.4.x, which has started to emit initially-zeroed-out local 'static'
2199 * variable decls into to the .bss section. (The specific function in Q which
2200 * triggered this is libraries/base/cbits/dirUtils.c:__hscore_getFolderPath())
2202 if (sectab_i->VirtualSize == 0 && sectab_i->SizeOfRawData == 0) continue;
2203 /* This is a non-empty .bss section. Allocate zeroed space for
2204 it, and set its PointerToRawData field such that oc->image +
2205 PointerToRawData == addr_of_zeroed_space. */
2206 bss_sz = sectab_i->VirtualSize;
2207 if ( bss_sz < sectab_i->SizeOfRawData) { bss_sz = sectab_i->SizeOfRawData; }
2208 zspace = stgCallocBytes(1, bss_sz, "ocGetNames_PEi386(anonymous bss)");
2209 sectab_i->PointerToRawData = ((UChar*)zspace) - ((UChar*)(oc->image));
2210 addProddableBlock(oc, zspace, bss_sz);
2211 /* debugBelch("BSS anon section at 0x%x\n", zspace); */
2214 /* Copy section information into the ObjectCode. */
2216 for (i = 0; i < hdr->NumberOfSections; i++) {
2222 = SECTIONKIND_OTHER;
2223 COFF_section* sectab_i
2225 myindex ( sizeof_COFF_section, sectab, i );
2226 IF_DEBUG(linker, debugBelch("section name = %s\n", sectab_i->Name ));
2229 /* I'm sure this is the Right Way to do it. However, the
2230 alternative of testing the sectab_i->Name field seems to
2231 work ok with Cygwin.
2233 if (sectab_i->Characteristics & MYIMAGE_SCN_CNT_CODE ||
2234 sectab_i->Characteristics & MYIMAGE_SCN_CNT_INITIALIZED_DATA)
2235 kind = SECTIONKIND_CODE_OR_RODATA;
2238 if (0==strcmp(".text",sectab_i->Name) ||
2239 0==strcmp(".rdata",sectab_i->Name)||
2240 0==strcmp(".rodata",sectab_i->Name))
2241 kind = SECTIONKIND_CODE_OR_RODATA;
2242 if (0==strcmp(".data",sectab_i->Name) ||
2243 0==strcmp(".bss",sectab_i->Name))
2244 kind = SECTIONKIND_RWDATA;
2246 ASSERT(sectab_i->SizeOfRawData == 0 || sectab_i->VirtualSize == 0);
2247 sz = sectab_i->SizeOfRawData;
2248 if (sz < sectab_i->VirtualSize) sz = sectab_i->VirtualSize;
2250 start = ((UChar*)(oc->image)) + sectab_i->PointerToRawData;
2251 end = start + sz - 1;
2253 if (kind == SECTIONKIND_OTHER
2254 /* Ignore sections called which contain stabs debugging
2256 && 0 != strcmp(".stab", sectab_i->Name)
2257 && 0 != strcmp(".stabstr", sectab_i->Name)
2258 /* ignore constructor section for now */
2259 && 0 != strcmp(".ctors", sectab_i->Name)
2260 /* ignore section generated from .ident */
2261 && 0!= strcmp("/4", sectab_i->Name)
2263 errorBelch("Unknown PEi386 section name `%s' (while processing: %s)", sectab_i->Name, oc->fileName);
2267 if (kind != SECTIONKIND_OTHER && end >= start) {
2268 addSection(oc, kind, start, end);
2269 addProddableBlock(oc, start, end - start + 1);
2273 /* Copy exported symbols into the ObjectCode. */
2275 oc->n_symbols = hdr->NumberOfSymbols;
2276 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
2277 "ocGetNames_PEi386(oc->symbols)");
2278 /* Call me paranoid; I don't care. */
2279 for (i = 0; i < oc->n_symbols; i++)
2280 oc->symbols[i] = NULL;
2284 COFF_symbol* symtab_i;
2285 if (i >= (Int32)(hdr->NumberOfSymbols)) break;
2286 symtab_i = (COFF_symbol*)
2287 myindex ( sizeof_COFF_symbol, symtab, i );
2291 if (symtab_i->StorageClass == MYIMAGE_SYM_CLASS_EXTERNAL
2292 && symtab_i->SectionNumber != MYIMAGE_SYM_UNDEFINED) {
2293 /* This symbol is global and defined, viz, exported */
2294 /* for MYIMAGE_SYMCLASS_EXTERNAL
2295 && !MYIMAGE_SYM_UNDEFINED,
2296 the address of the symbol is:
2297 address of relevant section + offset in section
2299 COFF_section* sectabent
2300 = (COFF_section*) myindex ( sizeof_COFF_section,
2302 symtab_i->SectionNumber-1 );
2303 addr = ((UChar*)(oc->image))
2304 + (sectabent->PointerToRawData
2308 if (symtab_i->SectionNumber == MYIMAGE_SYM_UNDEFINED
2309 && symtab_i->Value > 0) {
2310 /* This symbol isn't in any section at all, ie, global bss.
2311 Allocate zeroed space for it. */
2312 addr = stgCallocBytes(1, symtab_i->Value,
2313 "ocGetNames_PEi386(non-anonymous bss)");
2314 addSection(oc, SECTIONKIND_RWDATA, addr,
2315 ((UChar*)addr) + symtab_i->Value - 1);
2316 addProddableBlock(oc, addr, symtab_i->Value);
2317 /* debugBelch("BSS section at 0x%x\n", addr); */
2320 if (addr != NULL ) {
2321 sname = cstring_from_COFF_symbol_name ( symtab_i->Name, strtab );
2322 /* debugBelch("addSymbol %p `%s \n", addr,sname); */
2323 IF_DEBUG(linker, debugBelch("addSymbol %p `%s'\n", addr,sname);)
2324 ASSERT(i >= 0 && i < oc->n_symbols);
2325 /* cstring_from_COFF_symbol_name always succeeds. */
2326 oc->symbols[i] = sname;
2327 ghciInsertStrHashTable(oc->fileName, symhash, sname, addr);
2331 "IGNORING symbol %d\n"
2335 printName ( symtab_i->Name, strtab );
2344 (Int32)(symtab_i->SectionNumber),
2345 (UInt32)symtab_i->Type,
2346 (UInt32)symtab_i->StorageClass,
2347 (UInt32)symtab_i->NumberOfAuxSymbols
2352 i += symtab_i->NumberOfAuxSymbols;
2361 ocResolve_PEi386 ( ObjectCode* oc )
2364 COFF_section* sectab;
2365 COFF_symbol* symtab;
2375 /* ToDo: should be variable-sized? But is at least safe in the
2376 sense of buffer-overrun-proof. */
2378 /* debugBelch("resolving for %s\n", oc->fileName); */
2380 hdr = (COFF_header*)(oc->image);
2381 sectab = (COFF_section*) (
2382 ((UChar*)(oc->image))
2383 + sizeof_COFF_header + hdr->SizeOfOptionalHeader
2385 symtab = (COFF_symbol*) (
2386 ((UChar*)(oc->image))
2387 + hdr->PointerToSymbolTable
2389 strtab = ((UChar*)(oc->image))
2390 + hdr->PointerToSymbolTable
2391 + hdr->NumberOfSymbols * sizeof_COFF_symbol;
2393 for (i = 0; i < hdr->NumberOfSections; i++) {
2394 COFF_section* sectab_i
2396 myindex ( sizeof_COFF_section, sectab, i );
2399 ((UChar*)(oc->image)) + sectab_i->PointerToRelocations
2402 /* Ignore sections called which contain stabs debugging
2404 if (0 == strcmp(".stab", sectab_i->Name)
2405 || 0 == strcmp(".stabstr", sectab_i->Name)
2406 || 0 == strcmp(".ctors", sectab_i->Name))
2409 if ( sectab_i->Characteristics & MYIMAGE_SCN_LNK_NRELOC_OVFL ) {
2410 /* If the relocation field (a short) has overflowed, the
2411 * real count can be found in the first reloc entry.
2413 * See Section 4.1 (last para) of the PE spec (rev6.0).
2415 * Nov2003 update: the GNU linker still doesn't correctly
2416 * handle the generation of relocatable object files with
2417 * overflown relocations. Hence the output to warn of potential
2420 COFF_reloc* rel = (COFF_reloc*)
2421 myindex ( sizeof_COFF_reloc, reltab, 0 );
2422 noRelocs = rel->VirtualAddress;
2424 /* 10/05: we now assume (and check for) a GNU ld that is capable
2425 * of handling object files with (>2^16) of relocs.
2428 debugBelch("WARNING: Overflown relocation field (# relocs found: %u)\n",
2433 noRelocs = sectab_i->NumberOfRelocations;
2438 for (; j < noRelocs; j++) {
2440 COFF_reloc* reltab_j
2442 myindex ( sizeof_COFF_reloc, reltab, j );
2444 /* the location to patch */
2446 ((UChar*)(oc->image))
2447 + (sectab_i->PointerToRawData
2448 + reltab_j->VirtualAddress
2449 - sectab_i->VirtualAddress )
2451 /* the existing contents of pP */
2453 /* the symbol to connect to */
2454 sym = (COFF_symbol*)
2455 myindex ( sizeof_COFF_symbol,
2456 symtab, reltab_j->SymbolTableIndex );
2459 "reloc sec %2d num %3d: type 0x%-4x "
2460 "vaddr 0x%-8x name `",
2462 (UInt32)reltab_j->Type,
2463 reltab_j->VirtualAddress );
2464 printName ( sym->Name, strtab );
2465 debugBelch("'\n" ));
2467 if (sym->StorageClass == MYIMAGE_SYM_CLASS_STATIC) {
2468 COFF_section* section_sym
2469 = findPEi386SectionCalled ( oc, sym->Name );
2471 errorBelch("%s: can't find section `%s'", oc->fileName, sym->Name);
2474 S = ((UInt32)(oc->image))
2475 + (section_sym->PointerToRawData
2478 copyName ( sym->Name, strtab, symbol, 1000-1 );
2479 S = (UInt32) lookupLocalSymbol( oc, symbol );
2480 if ((void*)S != NULL) goto foundit;
2481 S = (UInt32) lookupSymbol( symbol );
2482 if ((void*)S != NULL) goto foundit;
2483 zapTrailingAtSign ( symbol );
2484 S = (UInt32) lookupLocalSymbol( oc, symbol );
2485 if ((void*)S != NULL) goto foundit;
2486 S = (UInt32) lookupSymbol( symbol );
2487 if ((void*)S != NULL) goto foundit;
2488 /* Newline first because the interactive linker has printed "linking..." */
2489 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, symbol);
2493 checkProddableBlock(oc, pP);
2494 switch (reltab_j->Type) {
2495 case MYIMAGE_REL_I386_DIR32:
2498 case MYIMAGE_REL_I386_REL32:
2499 /* Tricky. We have to insert a displacement at
2500 pP which, when added to the PC for the _next_
2501 insn, gives the address of the target (S).
2502 Problem is to know the address of the next insn
2503 when we only know pP. We assume that this
2504 literal field is always the last in the insn,
2505 so that the address of the next insn is pP+4
2506 -- hence the constant 4.
2507 Also I don't know if A should be added, but so
2508 far it has always been zero.
2510 SOF 05/2005: 'A' (old contents of *pP) have been observed
2511 to contain values other than zero (the 'wx' object file
2512 that came with wxhaskell-0.9.4; dunno how it was compiled..).
2513 So, add displacement to old value instead of asserting
2514 A to be zero. Fixes wxhaskell-related crashes, and no other
2515 ill effects have been observed.
2517 Update: the reason why we're seeing these more elaborate
2518 relocations is due to a switch in how the NCG compiles SRTs
2519 and offsets to them from info tables. SRTs live in .(ro)data,
2520 while info tables live in .text, causing GAS to emit REL32/DISP32
2521 relocations with non-zero values. Adding the displacement is
2522 the right thing to do.
2524 *pP = S - ((UInt32)pP) - 4 + A;
2527 debugBelch("%s: unhandled PEi386 relocation type %d",
2528 oc->fileName, reltab_j->Type);
2535 IF_DEBUG(linker, debugBelch("completed %s", oc->fileName));
2539 #endif /* defined(OBJFORMAT_PEi386) */
2542 /* --------------------------------------------------------------------------
2544 * ------------------------------------------------------------------------*/
2546 #if defined(OBJFORMAT_ELF)
2551 #if defined(sparc_HOST_ARCH)
2552 # define ELF_TARGET_SPARC /* Used inside <elf.h> */
2553 #elif defined(i386_HOST_ARCH)
2554 # define ELF_TARGET_386 /* Used inside <elf.h> */
2555 #elif defined(x86_64_HOST_ARCH)
2556 # define ELF_TARGET_X64_64
2558 #elif defined (ia64_HOST_ARCH)
2559 # define ELF_TARGET_IA64 /* Used inside <elf.h> */
2561 # define ELF_FUNCTION_DESC /* calling convention uses function descriptors */
2562 # define ELF_NEED_GOT /* needs Global Offset Table */
2563 # define ELF_NEED_PLT /* needs Procedure Linkage Tables */
2566 #if !defined(openbsd_HOST_OS)
2569 /* openbsd elf has things in different places, with diff names */
2570 # include <elf_abi.h>
2571 # include <machine/reloc.h>
2572 # define R_386_32 RELOC_32
2573 # define R_386_PC32 RELOC_PC32
2576 /* If elf.h doesn't define it */
2577 # ifndef R_X86_64_PC64
2578 # define R_X86_64_PC64 24
2582 * Define a set of types which can be used for both ELF32 and ELF64
2586 #define ELFCLASS ELFCLASS64
2587 #define Elf_Addr Elf64_Addr
2588 #define Elf_Word Elf64_Word
2589 #define Elf_Sword Elf64_Sword
2590 #define Elf_Ehdr Elf64_Ehdr
2591 #define Elf_Phdr Elf64_Phdr
2592 #define Elf_Shdr Elf64_Shdr
2593 #define Elf_Sym Elf64_Sym
2594 #define Elf_Rel Elf64_Rel
2595 #define Elf_Rela Elf64_Rela
2596 #define ELF_ST_TYPE ELF64_ST_TYPE
2597 #define ELF_ST_BIND ELF64_ST_BIND
2598 #define ELF_R_TYPE ELF64_R_TYPE
2599 #define ELF_R_SYM ELF64_R_SYM
2601 #define ELFCLASS ELFCLASS32
2602 #define Elf_Addr Elf32_Addr
2603 #define Elf_Word Elf32_Word
2604 #define Elf_Sword Elf32_Sword
2605 #define Elf_Ehdr Elf32_Ehdr
2606 #define Elf_Phdr Elf32_Phdr
2607 #define Elf_Shdr Elf32_Shdr
2608 #define Elf_Sym Elf32_Sym
2609 #define Elf_Rel Elf32_Rel
2610 #define Elf_Rela Elf32_Rela
2612 #define ELF_ST_TYPE ELF32_ST_TYPE
2615 #define ELF_ST_BIND ELF32_ST_BIND
2618 #define ELF_R_TYPE ELF32_R_TYPE
2621 #define ELF_R_SYM ELF32_R_SYM
2627 * Functions to allocate entries in dynamic sections. Currently we simply
2628 * preallocate a large number, and we don't check if a entry for the given
2629 * target already exists (a linear search is too slow). Ideally these
2630 * entries would be associated with symbols.
2633 /* These sizes sufficient to load HSbase + HShaskell98 + a few modules */
2634 #define GOT_SIZE 0x20000
2635 #define FUNCTION_TABLE_SIZE 0x10000
2636 #define PLT_SIZE 0x08000
2639 static Elf_Addr got[GOT_SIZE];
2640 static unsigned int gotIndex;
2641 static Elf_Addr gp_val = (Elf_Addr)got;
2644 allocateGOTEntry(Elf_Addr target)
2648 if (gotIndex >= GOT_SIZE)
2649 barf("Global offset table overflow");
2651 entry = &got[gotIndex++];
2653 return (Elf_Addr)entry;
2657 #ifdef ELF_FUNCTION_DESC
2663 static FunctionDesc functionTable[FUNCTION_TABLE_SIZE];
2664 static unsigned int functionTableIndex;
2667 allocateFunctionDesc(Elf_Addr target)
2669 FunctionDesc *entry;
2671 if (functionTableIndex >= FUNCTION_TABLE_SIZE)
2672 barf("Function table overflow");
2674 entry = &functionTable[functionTableIndex++];
2676 entry->gp = (Elf_Addr)gp_val;
2677 return (Elf_Addr)entry;
2681 copyFunctionDesc(Elf_Addr target)
2683 FunctionDesc *olddesc = (FunctionDesc *)target;
2684 FunctionDesc *newdesc;
2686 newdesc = (FunctionDesc *)allocateFunctionDesc(olddesc->ip);
2687 newdesc->gp = olddesc->gp;
2688 return (Elf_Addr)newdesc;
2693 #ifdef ia64_HOST_ARCH
2694 static void ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value);
2695 static void ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc);
2697 static unsigned char plt_code[] =
2699 /* taken from binutils bfd/elfxx-ia64.c */
2700 0x0b, 0x78, 0x00, 0x02, 0x00, 0x24, /* [MMI] addl r15=0,r1;; */
2701 0x00, 0x41, 0x3c, 0x30, 0x28, 0xc0, /* ld8 r16=[r15],8 */
2702 0x01, 0x08, 0x00, 0x84, /* mov r14=r1;; */
2703 0x11, 0x08, 0x00, 0x1e, 0x18, 0x10, /* [MIB] ld8 r1=[r15] */
2704 0x60, 0x80, 0x04, 0x80, 0x03, 0x00, /* mov b6=r16 */
2705 0x60, 0x00, 0x80, 0x00 /* br.few b6;; */
2708 /* If we can't get to the function descriptor via gp, take a local copy of it */
2709 #define PLT_RELOC(code, target) { \
2710 Elf64_Sxword rel_value = target - gp_val; \
2711 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff)) \
2712 ia64_reloc_gprel22((Elf_Addr)code, copyFunctionDesc(target)); \
2714 ia64_reloc_gprel22((Elf_Addr)code, target); \
2719 unsigned char code[sizeof(plt_code)];
2723 allocatePLTEntry(Elf_Addr target, ObjectCode *oc)
2725 PLTEntry *plt = (PLTEntry *)oc->plt;
2728 if (oc->pltIndex >= PLT_SIZE)
2729 barf("Procedure table overflow");
2731 entry = &plt[oc->pltIndex++];
2732 memcpy(entry->code, plt_code, sizeof(entry->code));
2733 PLT_RELOC(entry->code, target);
2734 return (Elf_Addr)entry;
2740 return (PLT_SIZE * sizeof(PLTEntry));
2745 #if x86_64_HOST_ARCH
2746 // On x86_64, 32-bit relocations are often used, which requires that
2747 // we can resolve a symbol to a 32-bit offset. However, shared
2748 // libraries are placed outside the 2Gb area, which leaves us with a
2749 // problem when we need to give a 32-bit offset to a symbol in a
2752 // For a function symbol, we can allocate a bounce sequence inside the
2753 // 2Gb area and resolve the symbol to this. The bounce sequence is
2754 // simply a long jump instruction to the real location of the symbol.
2756 // For data references, we're screwed.
2759 unsigned char jmp[8]; /* 6 byte instruction: jmpq *0x00000002(%rip) */
2763 #define X86_64_BB_SIZE 1024
2765 static x86_64_bounce *x86_64_bounce_buffer = NULL;
2766 static nat x86_64_bb_next_off;
2769 x86_64_high_symbol( char *lbl, void *addr )
2771 x86_64_bounce *bounce;
2773 if ( x86_64_bounce_buffer == NULL ||
2774 x86_64_bb_next_off >= X86_64_BB_SIZE ) {
2775 x86_64_bounce_buffer =
2776 mmap(NULL, X86_64_BB_SIZE * sizeof(x86_64_bounce),
2777 PROT_EXEC|PROT_READ|PROT_WRITE,
2778 MAP_PRIVATE|EXTRA_MAP_FLAGS|MAP_ANONYMOUS, -1, 0);
2779 if (x86_64_bounce_buffer == MAP_FAILED) {
2780 barf("x86_64_high_symbol: mmap failed");
2782 x86_64_bb_next_off = 0;
2784 bounce = &x86_64_bounce_buffer[x86_64_bb_next_off];
2785 bounce->jmp[0] = 0xff;
2786 bounce->jmp[1] = 0x25;
2787 bounce->jmp[2] = 0x02;
2788 bounce->jmp[3] = 0x00;
2789 bounce->jmp[4] = 0x00;
2790 bounce->jmp[5] = 0x00;
2791 bounce->addr = addr;
2792 x86_64_bb_next_off++;
2794 IF_DEBUG(linker, debugBelch("x86_64: allocated bounce entry for %s->%p at %p\n",
2795 lbl, addr, bounce));
2797 insertStrHashTable(symhash, lbl, bounce);
2804 * Generic ELF functions
2808 findElfSection ( void* objImage, Elf_Word sh_type )
2810 char* ehdrC = (char*)objImage;
2811 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2812 Elf_Shdr* shdr = (Elf_Shdr*)(ehdrC + ehdr->e_shoff);
2813 char* sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2817 for (i = 0; i < ehdr->e_shnum; i++) {
2818 if (shdr[i].sh_type == sh_type
2819 /* Ignore the section header's string table. */
2820 && i != ehdr->e_shstrndx
2821 /* Ignore string tables named .stabstr, as they contain
2823 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2825 ptr = ehdrC + shdr[i].sh_offset;
2832 #if defined(ia64_HOST_ARCH)
2834 findElfSegment ( void* objImage, Elf_Addr vaddr )
2836 char* ehdrC = (char*)objImage;
2837 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2838 Elf_Phdr* phdr = (Elf_Phdr*)(ehdrC + ehdr->e_phoff);
2839 Elf_Addr segaddr = 0;
2842 for (i = 0; i < ehdr->e_phnum; i++) {
2843 segaddr = phdr[i].p_vaddr;
2844 if ((vaddr >= segaddr) && (vaddr < segaddr + phdr[i].p_memsz))
2852 ocVerifyImage_ELF ( ObjectCode* oc )
2856 int i, j, nent, nstrtab, nsymtabs;
2860 char* ehdrC = (char*)(oc->image);
2861 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
2863 if (ehdr->e_ident[EI_MAG0] != ELFMAG0 ||
2864 ehdr->e_ident[EI_MAG1] != ELFMAG1 ||
2865 ehdr->e_ident[EI_MAG2] != ELFMAG2 ||
2866 ehdr->e_ident[EI_MAG3] != ELFMAG3) {
2867 errorBelch("%s: not an ELF object", oc->fileName);
2871 if (ehdr->e_ident[EI_CLASS] != ELFCLASS) {
2872 errorBelch("%s: unsupported ELF format", oc->fileName);
2876 if (ehdr->e_ident[EI_DATA] == ELFDATA2LSB) {
2877 IF_DEBUG(linker,debugBelch( "Is little-endian\n" ));
2879 if (ehdr->e_ident[EI_DATA] == ELFDATA2MSB) {
2880 IF_DEBUG(linker,debugBelch( "Is big-endian\n" ));
2882 errorBelch("%s: unknown endiannness", oc->fileName);
2886 if (ehdr->e_type != ET_REL) {
2887 errorBelch("%s: not a relocatable object (.o) file", oc->fileName);
2890 IF_DEBUG(linker, debugBelch( "Is a relocatable object (.o) file\n" ));
2892 IF_DEBUG(linker,debugBelch( "Architecture is " ));
2893 switch (ehdr->e_machine) {
2894 case EM_386: IF_DEBUG(linker,debugBelch( "x86" )); break;
2895 #ifdef EM_SPARC32PLUS
2896 case EM_SPARC32PLUS:
2898 case EM_SPARC: IF_DEBUG(linker,debugBelch( "sparc" )); break;
2900 case EM_IA_64: IF_DEBUG(linker,debugBelch( "ia64" )); break;
2902 case EM_PPC: IF_DEBUG(linker,debugBelch( "powerpc32" )); break;
2904 case EM_X86_64: IF_DEBUG(linker,debugBelch( "x86_64" )); break;
2907 case EM_AMD64: IF_DEBUG(linker,debugBelch( "amd64" )); break;
2909 default: IF_DEBUG(linker,debugBelch( "unknown" ));
2910 errorBelch("%s: unknown architecture (e_machine == %d)"
2911 , oc->fileName, ehdr->e_machine);
2915 IF_DEBUG(linker,debugBelch(
2916 "\nSection header table: start %ld, n_entries %d, ent_size %d\n",
2917 (long)ehdr->e_shoff, ehdr->e_shnum, ehdr->e_shentsize ));
2919 ASSERT (ehdr->e_shentsize == sizeof(Elf_Shdr));
2921 shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
2923 if (ehdr->e_shstrndx == SHN_UNDEF) {
2924 errorBelch("%s: no section header string table", oc->fileName);
2927 IF_DEBUG(linker,debugBelch( "Section header string table is section %d\n",
2929 sh_strtab = ehdrC + shdr[ehdr->e_shstrndx].sh_offset;
2932 for (i = 0; i < ehdr->e_shnum; i++) {
2933 IF_DEBUG(linker,debugBelch("%2d: ", i ));
2934 IF_DEBUG(linker,debugBelch("type=%2d ", (int)shdr[i].sh_type ));
2935 IF_DEBUG(linker,debugBelch("size=%4d ", (int)shdr[i].sh_size ));
2936 IF_DEBUG(linker,debugBelch("offs=%4d ", (int)shdr[i].sh_offset ));
2937 IF_DEBUG(linker,debugBelch(" (%p .. %p) ",
2938 ehdrC + shdr[i].sh_offset,
2939 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1));
2941 if (shdr[i].sh_type == SHT_REL) {
2942 IF_DEBUG(linker,debugBelch("Rel " ));
2943 } else if (shdr[i].sh_type == SHT_RELA) {
2944 IF_DEBUG(linker,debugBelch("RelA " ));
2946 IF_DEBUG(linker,debugBelch(" "));
2949 IF_DEBUG(linker,debugBelch("sname=%s\n", sh_strtab + shdr[i].sh_name ));
2953 IF_DEBUG(linker,debugBelch( "\nString tables" ));
2956 for (i = 0; i < ehdr->e_shnum; i++) {
2957 if (shdr[i].sh_type == SHT_STRTAB
2958 /* Ignore the section header's string table. */
2959 && i != ehdr->e_shstrndx
2960 /* Ignore string tables named .stabstr, as they contain
2962 && 0 != memcmp(".stabstr", sh_strtab + shdr[i].sh_name, 8)
2964 IF_DEBUG(linker,debugBelch(" section %d is a normal string table", i ));
2965 strtab = ehdrC + shdr[i].sh_offset;
2970 errorBelch("%s: no string tables, or too many", oc->fileName);
2975 IF_DEBUG(linker,debugBelch( "\nSymbol tables" ));
2976 for (i = 0; i < ehdr->e_shnum; i++) {
2977 if (shdr[i].sh_type != SHT_SYMTAB) continue;
2978 IF_DEBUG(linker,debugBelch( "section %d is a symbol table\n", i ));
2980 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
2981 nent = shdr[i].sh_size / sizeof(Elf_Sym);
2982 IF_DEBUG(linker,debugBelch( " number of entries is apparently %d (%ld rem)\n",
2984 (long)shdr[i].sh_size % sizeof(Elf_Sym)
2986 if (0 != shdr[i].sh_size % sizeof(Elf_Sym)) {
2987 errorBelch("%s: non-integral number of symbol table entries", oc->fileName);
2990 for (j = 0; j < nent; j++) {
2991 IF_DEBUG(linker,debugBelch(" %2d ", j ));
2992 IF_DEBUG(linker,debugBelch(" sec=%-5d size=%-3d val=%5p ",
2993 (int)stab[j].st_shndx,
2994 (int)stab[j].st_size,
2995 (char*)stab[j].st_value ));
2997 IF_DEBUG(linker,debugBelch("type=" ));
2998 switch (ELF_ST_TYPE(stab[j].st_info)) {
2999 case STT_NOTYPE: IF_DEBUG(linker,debugBelch("notype " )); break;
3000 case STT_OBJECT: IF_DEBUG(linker,debugBelch("object " )); break;
3001 case STT_FUNC : IF_DEBUG(linker,debugBelch("func " )); break;
3002 case STT_SECTION: IF_DEBUG(linker,debugBelch("section" )); break;
3003 case STT_FILE: IF_DEBUG(linker,debugBelch("file " )); break;
3004 default: IF_DEBUG(linker,debugBelch("? " )); break;
3006 IF_DEBUG(linker,debugBelch(" " ));
3008 IF_DEBUG(linker,debugBelch("bind=" ));
3009 switch (ELF_ST_BIND(stab[j].st_info)) {
3010 case STB_LOCAL : IF_DEBUG(linker,debugBelch("local " )); break;
3011 case STB_GLOBAL: IF_DEBUG(linker,debugBelch("global" )); break;
3012 case STB_WEAK : IF_DEBUG(linker,debugBelch("weak " )); break;
3013 default: IF_DEBUG(linker,debugBelch("? " )); break;
3015 IF_DEBUG(linker,debugBelch(" " ));
3017 IF_DEBUG(linker,debugBelch("name=%s\n", strtab + stab[j].st_name ));
3021 if (nsymtabs == 0) {
3022 errorBelch("%s: didn't find any symbol tables", oc->fileName);
3029 static int getSectionKind_ELF( Elf_Shdr *hdr, int *is_bss )
3033 if (hdr->sh_type == SHT_PROGBITS
3034 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_EXECINSTR)) {
3035 /* .text-style section */
3036 return SECTIONKIND_CODE_OR_RODATA;
3039 if (hdr->sh_type == SHT_PROGBITS
3040 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3041 /* .data-style section */
3042 return SECTIONKIND_RWDATA;
3045 if (hdr->sh_type == SHT_PROGBITS
3046 && (hdr->sh_flags & SHF_ALLOC) && !(hdr->sh_flags & SHF_WRITE)) {
3047 /* .rodata-style section */
3048 return SECTIONKIND_CODE_OR_RODATA;
3051 if (hdr->sh_type == SHT_NOBITS
3052 && (hdr->sh_flags & SHF_ALLOC) && (hdr->sh_flags & SHF_WRITE)) {
3053 /* .bss-style section */
3055 return SECTIONKIND_RWDATA;
3058 return SECTIONKIND_OTHER;
3063 ocGetNames_ELF ( ObjectCode* oc )
3068 char* ehdrC = (char*)(oc->image);
3069 Elf_Ehdr* ehdr = (Elf_Ehdr*)ehdrC;
3070 char* strtab = findElfSection ( ehdrC, SHT_STRTAB );
3071 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3073 ASSERT(symhash != NULL);
3076 errorBelch("%s: no strtab", oc->fileName);
3081 for (i = 0; i < ehdr->e_shnum; i++) {
3082 /* Figure out what kind of section it is. Logic derived from
3083 Figure 1.14 ("Special Sections") of the ELF document
3084 ("Portable Formats Specification, Version 1.1"). */
3086 SectionKind kind = getSectionKind_ELF(&shdr[i], &is_bss);
3088 if (is_bss && shdr[i].sh_size > 0) {
3089 /* This is a non-empty .bss section. Allocate zeroed space for
3090 it, and set its .sh_offset field such that
3091 ehdrC + .sh_offset == addr_of_zeroed_space. */
3092 char* zspace = stgCallocBytes(1, shdr[i].sh_size,
3093 "ocGetNames_ELF(BSS)");
3094 shdr[i].sh_offset = ((char*)zspace) - ((char*)ehdrC);
3096 debugBelch("BSS section at 0x%x, size %d\n",
3097 zspace, shdr[i].sh_size);
3101 /* fill in the section info */
3102 if (kind != SECTIONKIND_OTHER && shdr[i].sh_size > 0) {
3103 addProddableBlock(oc, ehdrC + shdr[i].sh_offset, shdr[i].sh_size);
3104 addSection(oc, kind, ehdrC + shdr[i].sh_offset,
3105 ehdrC + shdr[i].sh_offset + shdr[i].sh_size - 1);
3108 if (shdr[i].sh_type != SHT_SYMTAB) continue;
3110 /* copy stuff into this module's object symbol table */
3111 stab = (Elf_Sym*) (ehdrC + shdr[i].sh_offset);
3112 nent = shdr[i].sh_size / sizeof(Elf_Sym);
3114 oc->n_symbols = nent;
3115 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
3116 "ocGetNames_ELF(oc->symbols)");
3118 for (j = 0; j < nent; j++) {
3120 char isLocal = FALSE; /* avoids uninit-var warning */
3122 char* nm = strtab + stab[j].st_name;
3123 int secno = stab[j].st_shndx;
3125 /* Figure out if we want to add it; if so, set ad to its
3126 address. Otherwise leave ad == NULL. */
3128 if (secno == SHN_COMMON) {
3130 ad = stgCallocBytes(1, stab[j].st_size, "ocGetNames_ELF(COMMON)");
3132 debugBelch("COMMON symbol, size %d name %s\n",
3133 stab[j].st_size, nm);
3135 /* Pointless to do addProddableBlock() for this area,
3136 since the linker should never poke around in it. */
3139 if ( ( ELF_ST_BIND(stab[j].st_info)==STB_GLOBAL
3140 || ELF_ST_BIND(stab[j].st_info)==STB_LOCAL
3142 /* and not an undefined symbol */
3143 && stab[j].st_shndx != SHN_UNDEF
3144 /* and not in a "special section" */
3145 && stab[j].st_shndx < SHN_LORESERVE
3147 /* and it's a not a section or string table or anything silly */
3148 ( ELF_ST_TYPE(stab[j].st_info)==STT_FUNC ||
3149 ELF_ST_TYPE(stab[j].st_info)==STT_OBJECT ||
3150 ELF_ST_TYPE(stab[j].st_info)==STT_NOTYPE
3153 /* Section 0 is the undefined section, hence > and not >=. */
3154 ASSERT(secno > 0 && secno < ehdr->e_shnum);
3156 if (shdr[secno].sh_type == SHT_NOBITS) {
3157 debugBelch(" BSS symbol, size %d off %d name %s\n",
3158 stab[j].st_size, stab[j].st_value, nm);
3161 ad = ehdrC + shdr[ secno ].sh_offset + stab[j].st_value;
3162 if (ELF_ST_BIND(stab[j].st_info)==STB_LOCAL) {
3165 #ifdef ELF_FUNCTION_DESC
3166 /* dlsym() and the initialisation table both give us function
3167 * descriptors, so to be consistent we store function descriptors
3168 * in the symbol table */
3169 if (ELF_ST_TYPE(stab[j].st_info) == STT_FUNC)
3170 ad = (char *)allocateFunctionDesc((Elf_Addr)ad);
3172 IF_DEBUG(linker,debugBelch( "addOTabName(GLOB): %10p %s %s",
3173 ad, oc->fileName, nm ));
3178 /* And the decision is ... */
3182 oc->symbols[j] = nm;
3185 /* Ignore entirely. */
3187 ghciInsertStrHashTable(oc->fileName, symhash, nm, ad);
3191 IF_DEBUG(linker,debugBelch( "skipping `%s'\n",
3192 strtab + stab[j].st_name ));
3195 "skipping bind = %d, type = %d, shndx = %d `%s'\n",
3196 (int)ELF_ST_BIND(stab[j].st_info),
3197 (int)ELF_ST_TYPE(stab[j].st_info),
3198 (int)stab[j].st_shndx,
3199 strtab + stab[j].st_name
3202 oc->symbols[j] = NULL;
3211 /* Do ELF relocations which lack an explicit addend. All x86-linux
3212 relocations appear to be of this form. */
3214 do_Elf_Rel_relocations ( ObjectCode* oc, char* ehdrC,
3215 Elf_Shdr* shdr, int shnum,
3216 Elf_Sym* stab, char* strtab )
3221 Elf_Rel* rtab = (Elf_Rel*) (ehdrC + shdr[shnum].sh_offset);
3222 int nent = shdr[shnum].sh_size / sizeof(Elf_Rel);
3223 int target_shndx = shdr[shnum].sh_info;
3224 int symtab_shndx = shdr[shnum].sh_link;
3226 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3227 targ = (Elf_Word*)(ehdrC + shdr[ target_shndx ].sh_offset);
3228 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3229 target_shndx, symtab_shndx ));
3231 /* Skip sections that we're not interested in. */
3234 SectionKind kind = getSectionKind_ELF(&shdr[target_shndx], &is_bss);
3235 if (kind == SECTIONKIND_OTHER) {
3236 IF_DEBUG(linker,debugBelch( "skipping (target section not loaded)"));
3241 for (j = 0; j < nent; j++) {
3242 Elf_Addr offset = rtab[j].r_offset;
3243 Elf_Addr info = rtab[j].r_info;
3245 Elf_Addr P = ((Elf_Addr)targ) + offset;
3246 Elf_Word* pP = (Elf_Word*)P;
3251 StgStablePtr stablePtr;
3254 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p)",
3255 j, (void*)offset, (void*)info ));
3257 IF_DEBUG(linker,debugBelch( " ZERO" ));
3260 Elf_Sym sym = stab[ELF_R_SYM(info)];
3261 /* First see if it is a local symbol. */
3262 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3263 /* Yes, so we can get the address directly from the ELF symbol
3265 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3267 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3268 + stab[ELF_R_SYM(info)].st_value);
3271 symbol = strtab + sym.st_name;
3272 stablePtr = (StgStablePtr)lookupHashTable(stablehash, (StgWord)symbol);
3273 if (NULL == stablePtr) {
3274 /* No, so look up the name in our global table. */
3275 S_tmp = lookupSymbol( symbol );
3276 S = (Elf_Addr)S_tmp;
3278 stableVal = deRefStablePtr( stablePtr );
3280 S = (Elf_Addr)S_tmp;
3284 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3287 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p\n", symbol, (void*)S ));
3290 IF_DEBUG(linker,debugBelch( "Reloc: P = %p S = %p A = %p\n",
3291 (void*)P, (void*)S, (void*)A ));
3292 checkProddableBlock ( oc, pP );
3296 switch (ELF_R_TYPE(info)) {
3297 # ifdef i386_HOST_ARCH
3298 case R_386_32: *pP = value; break;
3299 case R_386_PC32: *pP = value - P; break;
3302 errorBelch("%s: unhandled ELF relocation(Rel) type %lu\n",
3303 oc->fileName, (lnat)ELF_R_TYPE(info));
3311 /* Do ELF relocations for which explicit addends are supplied.
3312 sparc-solaris relocations appear to be of this form. */
3314 do_Elf_Rela_relocations ( ObjectCode* oc, char* ehdrC,
3315 Elf_Shdr* shdr, int shnum,
3316 Elf_Sym* stab, char* strtab )
3319 char *symbol = NULL;
3321 Elf_Rela* rtab = (Elf_Rela*) (ehdrC + shdr[shnum].sh_offset);
3322 int nent = shdr[shnum].sh_size / sizeof(Elf_Rela);
3323 int target_shndx = shdr[shnum].sh_info;
3324 int symtab_shndx = shdr[shnum].sh_link;
3326 stab = (Elf_Sym*) (ehdrC + shdr[ symtab_shndx ].sh_offset);
3327 targ = (Elf_Addr) (ehdrC + shdr[ target_shndx ].sh_offset);
3328 IF_DEBUG(linker,debugBelch( "relocations for section %d using symtab %d\n",
3329 target_shndx, symtab_shndx ));
3331 for (j = 0; j < nent; j++) {
3332 #if defined(DEBUG) || defined(sparc_HOST_ARCH) || defined(ia64_HOST_ARCH) || defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
3333 /* This #ifdef only serves to avoid unused-var warnings. */
3334 Elf_Addr offset = rtab[j].r_offset;
3335 Elf_Addr P = targ + offset;
3337 Elf_Addr info = rtab[j].r_info;
3338 Elf_Addr A = rtab[j].r_addend;
3342 # if defined(sparc_HOST_ARCH)
3343 Elf_Word* pP = (Elf_Word*)P;
3345 # elif defined(ia64_HOST_ARCH)
3346 Elf64_Xword *pP = (Elf64_Xword *)P;
3348 # elif defined(powerpc_HOST_ARCH)
3352 IF_DEBUG(linker,debugBelch( "Rel entry %3d is raw(%6p %6p %6p) ",
3353 j, (void*)offset, (void*)info,
3356 IF_DEBUG(linker,debugBelch( " ZERO" ));
3359 Elf_Sym sym = stab[ELF_R_SYM(info)];
3360 /* First see if it is a local symbol. */
3361 if (ELF_ST_BIND(sym.st_info) == STB_LOCAL) {
3362 /* Yes, so we can get the address directly from the ELF symbol
3364 symbol = sym.st_name==0 ? "(noname)" : strtab+sym.st_name;
3366 (ehdrC + shdr[ sym.st_shndx ].sh_offset
3367 + stab[ELF_R_SYM(info)].st_value);
3368 #ifdef ELF_FUNCTION_DESC
3369 /* Make a function descriptor for this function */
3370 if (S && ELF_ST_TYPE(sym.st_info) == STT_FUNC) {
3371 S = allocateFunctionDesc(S + A);
3376 /* No, so look up the name in our global table. */
3377 symbol = strtab + sym.st_name;
3378 S_tmp = lookupSymbol( symbol );
3379 S = (Elf_Addr)S_tmp;
3381 #ifdef ELF_FUNCTION_DESC
3382 /* If a function, already a function descriptor - we would
3383 have to copy it to add an offset. */
3384 if (S && (ELF_ST_TYPE(sym.st_info) == STT_FUNC) && (A != 0))
3385 errorBelch("%s: function %s with addend %p", oc->fileName, symbol, (void *)A);
3389 errorBelch("%s: unknown symbol `%s'", oc->fileName, symbol);
3392 IF_DEBUG(linker,debugBelch( "`%s' resolves to %p", symbol, (void*)S ));
3395 IF_DEBUG(linker,debugBelch("Reloc: P = %p S = %p A = %p\n",
3396 (void*)P, (void*)S, (void*)A ));
3397 /* checkProddableBlock ( oc, (void*)P ); */
3401 switch (ELF_R_TYPE(info)) {
3402 # if defined(sparc_HOST_ARCH)
3403 case R_SPARC_WDISP30:
3404 w1 = *pP & 0xC0000000;
3405 w2 = (Elf_Word)((value - P) >> 2);
3406 ASSERT((w2 & 0xC0000000) == 0);
3411 w1 = *pP & 0xFFC00000;
3412 w2 = (Elf_Word)(value >> 10);
3413 ASSERT((w2 & 0xFFC00000) == 0);
3419 w2 = (Elf_Word)(value & 0x3FF);
3420 ASSERT((w2 & ~0x3FF) == 0);
3424 /* According to the Sun documentation:
3426 This relocation type resembles R_SPARC_32, except it refers to an
3427 unaligned word. That is, the word to be relocated must be treated
3428 as four separate bytes with arbitrary alignment, not as a word
3429 aligned according to the architecture requirements.
3431 (JRS: which means that freeloading on the R_SPARC_32 case
3432 is probably wrong, but hey ...)
3436 w2 = (Elf_Word)value;
3439 # elif defined(ia64_HOST_ARCH)
3440 case R_IA64_DIR64LSB:
3441 case R_IA64_FPTR64LSB:
3444 case R_IA64_PCREL64LSB:
3447 case R_IA64_SEGREL64LSB:
3448 addr = findElfSegment(ehdrC, value);
3451 case R_IA64_GPREL22:
3452 ia64_reloc_gprel22(P, value);
3454 case R_IA64_LTOFF22:
3455 case R_IA64_LTOFF22X:
3456 case R_IA64_LTOFF_FPTR22:
3457 addr = allocateGOTEntry(value);
3458 ia64_reloc_gprel22(P, addr);
3460 case R_IA64_PCREL21B:
3461 ia64_reloc_pcrel21(P, S, oc);
3464 /* This goes with R_IA64_LTOFF22X and points to the load to
3465 * convert into a move. We don't implement relaxation. */
3467 # elif defined(powerpc_HOST_ARCH)
3468 case R_PPC_ADDR16_LO:
3469 *(Elf32_Half*) P = value;
3472 case R_PPC_ADDR16_HI:
3473 *(Elf32_Half*) P = value >> 16;
3476 case R_PPC_ADDR16_HA:
3477 *(Elf32_Half*) P = (value + 0x8000) >> 16;
3481 *(Elf32_Word *) P = value;
3485 *(Elf32_Word *) P = value - P;
3491 if( delta << 6 >> 6 != delta )
3493 value = (Elf_Addr) (&makeSymbolExtra( oc, ELF_R_SYM(info), value )
3497 if( value == 0 || delta << 6 >> 6 != delta )
3499 barf( "Unable to make SymbolExtra for #%d",
3505 *(Elf_Word *) P = (*(Elf_Word *) P & 0xfc000003)
3506 | (delta & 0x3fffffc);
3510 #if x86_64_HOST_ARCH
3512 *(Elf64_Xword *)P = value;
3517 StgInt64 off = value - P;
3518 if (off >= 0x7fffffffL || off < -0x80000000L) {
3519 barf("R_X86_64_PC32 relocation out of range: %s = %p",
3522 *(Elf64_Word *)P = (Elf64_Word)off;
3528 StgInt64 off = value - P;
3529 *(Elf64_Word *)P = (Elf64_Word)off;
3534 if (value >= 0x7fffffffL) {
3535 barf("R_X86_64_32 relocation out of range: %s = %p\n",
3538 *(Elf64_Word *)P = (Elf64_Word)value;
3542 if ((StgInt64)value > 0x7fffffffL || (StgInt64)value < -0x80000000L) {
3543 barf("R_X86_64_32S relocation out of range: %s = %p\n",
3546 *(Elf64_Sword *)P = (Elf64_Sword)value;
3551 errorBelch("%s: unhandled ELF relocation(RelA) type %lu\n",
3552 oc->fileName, (lnat)ELF_R_TYPE(info));
3561 ocResolve_ELF ( ObjectCode* oc )
3565 Elf_Sym* stab = NULL;
3566 char* ehdrC = (char*)(oc->image);
3567 Elf_Ehdr* ehdr = (Elf_Ehdr*) ehdrC;
3568 Elf_Shdr* shdr = (Elf_Shdr*) (ehdrC + ehdr->e_shoff);
3570 /* first find "the" symbol table */
3571 stab = (Elf_Sym*) findElfSection ( ehdrC, SHT_SYMTAB );
3573 /* also go find the string table */
3574 strtab = findElfSection ( ehdrC, SHT_STRTAB );
3576 if (stab == NULL || strtab == NULL) {
3577 errorBelch("%s: can't find string or symbol table", oc->fileName);
3581 /* Process the relocation sections. */
3582 for (shnum = 0; shnum < ehdr->e_shnum; shnum++) {
3583 if (shdr[shnum].sh_type == SHT_REL) {
3584 ok = do_Elf_Rel_relocations ( oc, ehdrC, shdr,
3585 shnum, stab, strtab );
3589 if (shdr[shnum].sh_type == SHT_RELA) {
3590 ok = do_Elf_Rela_relocations ( oc, ehdrC, shdr,
3591 shnum, stab, strtab );
3596 /* Free the local symbol table; we won't need it again. */
3597 freeHashTable(oc->lochash, NULL);
3600 #if defined(powerpc_HOST_ARCH)
3601 ocFlushInstructionCache( oc );
3609 * Instructions are 41 bits long, packed into 128 bit bundles with a 5-bit template
3610 * at the front. The following utility functions pack and unpack instructions, and
3611 * take care of the most common relocations.
3614 #ifdef ia64_HOST_ARCH
3617 ia64_extract_instruction(Elf64_Xword *target)
3620 int slot = (Elf_Addr)target & 3;
3621 target = (Elf_Addr)target & ~3;
3629 return ((w1 >> 5) & 0x1ffffffffff);
3631 return (w1 >> 46) | ((w2 & 0x7fffff) << 18);
3635 barf("ia64_extract_instruction: invalid slot %p", target);
3640 ia64_deposit_instruction(Elf64_Xword *target, Elf64_Xword value)
3642 int slot = (Elf_Addr)target & 3;
3643 target = (Elf_Addr)target & ~3;
3648 *target |= value << 5;
3651 *target |= value << 46;
3652 *(target+1) |= value >> 18;
3655 *(target+1) |= value << 23;
3661 ia64_reloc_gprel22(Elf_Addr target, Elf_Addr value)
3663 Elf64_Xword instruction;
3664 Elf64_Sxword rel_value;
3666 rel_value = value - gp_val;
3667 if ((rel_value > 0x1fffff) || (rel_value < -0x1fffff))
3668 barf("GP-relative data out of range (address = 0x%lx, gp = 0x%lx)", value, gp_val);
3670 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3671 instruction |= (((rel_value >> 0) & 0x07f) << 13) /* imm7b */
3672 | (((rel_value >> 7) & 0x1ff) << 27) /* imm9d */
3673 | (((rel_value >> 16) & 0x01f) << 22) /* imm5c */
3674 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3675 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3679 ia64_reloc_pcrel21(Elf_Addr target, Elf_Addr value, ObjectCode *oc)
3681 Elf64_Xword instruction;
3682 Elf64_Sxword rel_value;
3685 entry = allocatePLTEntry(value, oc);
3687 rel_value = (entry >> 4) - (target >> 4);
3688 if ((rel_value > 0xfffff) || (rel_value < -0xfffff))
3689 barf("PLT entry too far away (entry = 0x%lx, target = 0x%lx)", entry, target);
3691 instruction = ia64_extract_instruction((Elf64_Xword *)target);
3692 instruction |= ((rel_value & 0xfffff) << 13) /* imm20b */
3693 | ((Elf64_Xword)(rel_value < 0) << 36); /* s */
3694 ia64_deposit_instruction((Elf64_Xword *)target, instruction);
3700 * PowerPC ELF specifics
3703 #ifdef powerpc_HOST_ARCH
3705 static int ocAllocateSymbolExtras_ELF( ObjectCode *oc )
3711 ehdr = (Elf_Ehdr *) oc->image;
3712 shdr = (Elf_Shdr *) ( ((char *)oc->image) + ehdr->e_shoff );
3714 for( i = 0; i < ehdr->e_shnum; i++ )
3715 if( shdr[i].sh_type == SHT_SYMTAB )
3718 if( i == ehdr->e_shnum )
3720 errorBelch( "This ELF file contains no symtab" );
3724 if( shdr[i].sh_entsize != sizeof( Elf_Sym ) )
3726 errorBelch( "The entry size (%d) of the symtab isn't %d\n",
3727 shdr[i].sh_entsize, sizeof( Elf_Sym ) );
3732 return ocAllocateSymbolExtras( oc, shdr[i].sh_size / sizeof( Elf_Sym ), 0 );
3735 #endif /* powerpc */
3739 /* --------------------------------------------------------------------------
3741 * ------------------------------------------------------------------------*/
3743 #if defined(OBJFORMAT_MACHO)
3746 Support for MachO linking on Darwin/MacOS X
3747 by Wolfgang Thaller (wolfgang.thaller@gmx.net)
3749 I hereby formally apologize for the hackish nature of this code.
3750 Things that need to be done:
3751 *) implement ocVerifyImage_MachO
3752 *) add still more sanity checks.
3755 #if x86_64_HOST_ARCH || powerpc64_HOST_ARCH
3756 #define mach_header mach_header_64
3757 #define segment_command segment_command_64
3758 #define section section_64
3759 #define nlist nlist_64
3762 #ifdef powerpc_HOST_ARCH
3763 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3765 struct mach_header *header = (struct mach_header *) oc->image;
3766 struct load_command *lc = (struct load_command *) (header + 1);
3769 for( i = 0; i < header->ncmds; i++ )
3771 if( lc->cmd == LC_SYMTAB )
3773 // Find out the first and last undefined external
3774 // symbol, so we don't have to allocate too many
3776 struct symtab_command *symLC = (struct symtab_command *) lc;
3777 unsigned min = symLC->nsyms, max = 0;
3778 struct nlist *nlist =
3779 symLC ? (struct nlist*) ((char*) oc->image + symLC->symoff)
3781 for(i=0;i<symLC->nsyms;i++)
3783 if(nlist[i].n_type & N_STAB)
3785 else if(nlist[i].n_type & N_EXT)
3787 if((nlist[i].n_type & N_TYPE) == N_UNDF
3788 && (nlist[i].n_value == 0))
3798 return ocAllocateSymbolExtras(oc, max - min + 1, min);
3803 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3805 return ocAllocateSymbolExtras(oc,0,0);
3808 #ifdef x86_64_HOST_ARCH
3809 static int ocAllocateSymbolExtras_MachO(ObjectCode* oc)
3811 struct mach_header *header = (struct mach_header *) oc->image;
3812 struct load_command *lc = (struct load_command *) (header + 1);
3815 for( i = 0; i < header->ncmds; i++ )
3817 if( lc->cmd == LC_SYMTAB )
3819 // Just allocate one entry for every symbol
3820 struct symtab_command *symLC = (struct symtab_command *) lc;
3822 return ocAllocateSymbolExtras(oc, symLC->nsyms, 0);
3825 lc = (struct load_command *) ( ((char *)lc) + lc->cmdsize );
3827 return ocAllocateSymbolExtras(oc,0,0);
3831 static int ocVerifyImage_MachO(ObjectCode* oc)
3833 char *image = (char*) oc->image;
3834 struct mach_header *header = (struct mach_header*) image;
3836 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
3837 if(header->magic != MH_MAGIC_64)
3840 if(header->magic != MH_MAGIC)
3843 // FIXME: do some more verifying here
3847 static int resolveImports(
3850 struct symtab_command *symLC,
3851 struct section *sect, // ptr to lazy or non-lazy symbol pointer section
3852 unsigned long *indirectSyms,
3853 struct nlist *nlist)
3856 size_t itemSize = 4;
3859 int isJumpTable = 0;
3860 if(!strcmp(sect->sectname,"__jump_table"))
3864 ASSERT(sect->reserved2 == itemSize);
3868 for(i=0; i*itemSize < sect->size;i++)
3870 // according to otool, reserved1 contains the first index into the indirect symbol table
3871 struct nlist *symbol = &nlist[indirectSyms[sect->reserved1+i]];
3872 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3875 if((symbol->n_type & N_TYPE) == N_UNDF
3876 && (symbol->n_type & N_EXT) && (symbol->n_value != 0))
3877 addr = (void*) (symbol->n_value);
3878 else if((addr = lookupLocalSymbol(oc,nm)) != NULL)
3881 addr = lookupSymbol(nm);
3884 errorBelch("\n%s: unknown symbol `%s'", oc->fileName, nm);
3892 checkProddableBlock(oc,image + sect->offset + i*itemSize);
3893 *(image + sect->offset + i*itemSize) = 0xe9; // jmp
3894 *(unsigned*)(image + sect->offset + i*itemSize + 1)
3895 = (char*)addr - (image + sect->offset + i*itemSize + 5);
3900 checkProddableBlock(oc,((void**)(image + sect->offset)) + i);
3901 ((void**)(image + sect->offset))[i] = addr;
3908 static unsigned long relocateAddress(
3911 struct section* sections,
3912 unsigned long address)
3915 for(i = 0; i < nSections; i++)
3917 if(sections[i].addr <= address
3918 && address < sections[i].addr + sections[i].size)
3920 return (unsigned long)oc->image
3921 + sections[i].offset + address - sections[i].addr;
3924 barf("Invalid Mach-O file:"
3925 "Address out of bounds while relocating object file");
3929 static int relocateSection(
3932 struct symtab_command *symLC, struct nlist *nlist,
3933 int nSections, struct section* sections, struct section *sect)
3935 struct relocation_info *relocs;
3938 if(!strcmp(sect->sectname,"__la_symbol_ptr"))
3940 else if(!strcmp(sect->sectname,"__nl_symbol_ptr"))
3942 else if(!strcmp(sect->sectname,"__la_sym_ptr2"))
3944 else if(!strcmp(sect->sectname,"__la_sym_ptr3"))
3948 relocs = (struct relocation_info*) (image + sect->reloff);
3952 #ifdef x86_64_HOST_ARCH
3953 struct relocation_info *reloc = &relocs[i];
3955 char *thingPtr = image + sect->offset + reloc->r_address;
3959 int type = reloc->r_type;
3961 checkProddableBlock(oc,thingPtr);
3962 switch(reloc->r_length)
3965 thing = *(uint8_t*)thingPtr;
3966 baseValue = (uint64_t)thingPtr + 1;
3969 thing = *(uint16_t*)thingPtr;
3970 baseValue = (uint64_t)thingPtr + 2;
3973 thing = *(uint32_t*)thingPtr;
3974 baseValue = (uint64_t)thingPtr + 4;
3977 thing = *(uint64_t*)thingPtr;
3978 baseValue = (uint64_t)thingPtr + 8;
3981 barf("Unknown size.");
3984 if(type == X86_64_RELOC_GOT
3985 || type == X86_64_RELOC_GOT_LOAD)
3987 ASSERT(reloc->r_extern);
3988 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)->addr;
3990 type = X86_64_RELOC_SIGNED;
3992 else if(reloc->r_extern)
3994 struct nlist *symbol = &nlist[reloc->r_symbolnum];
3995 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
3996 if(symbol->n_value == 0)
3997 value = (uint64_t) lookupSymbol(nm);
3999 value = relocateAddress(oc, nSections, sections,
4004 value = sections[reloc->r_symbolnum-1].offset
4005 - sections[reloc->r_symbolnum-1].addr
4009 if(type == X86_64_RELOC_BRANCH)
4011 if((int32_t)(value - baseValue) != (int64_t)(value - baseValue))
4013 ASSERT(reloc->r_extern);
4014 value = (uint64_t) &makeSymbolExtra(oc, reloc->r_symbolnum, value)
4017 ASSERT((int32_t)(value - baseValue) == (int64_t)(value - baseValue));
4018 type = X86_64_RELOC_SIGNED;
4023 case X86_64_RELOC_UNSIGNED:
4024 ASSERT(!reloc->r_pcrel);
4027 case X86_64_RELOC_SIGNED:
4028 ASSERT(reloc->r_pcrel);
4029 thing += value - baseValue;
4031 case X86_64_RELOC_SUBTRACTOR:
4032 ASSERT(!reloc->r_pcrel);
4036 barf("unkown relocation");
4039 switch(reloc->r_length)
4042 *(uint8_t*)thingPtr = thing;
4045 *(uint16_t*)thingPtr = thing;
4048 *(uint32_t*)thingPtr = thing;
4051 *(uint64_t*)thingPtr = thing;
4055 if(relocs[i].r_address & R_SCATTERED)
4057 struct scattered_relocation_info *scat =
4058 (struct scattered_relocation_info*) &relocs[i];
4062 if(scat->r_length == 2)
4064 unsigned long word = 0;
4065 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + scat->r_address);
4066 checkProddableBlock(oc,wordPtr);
4068 // Note on relocation types:
4069 // i386 uses the GENERIC_RELOC_* types,
4070 // while ppc uses special PPC_RELOC_* types.
4071 // *_RELOC_VANILLA and *_RELOC_PAIR have the same value
4072 // in both cases, all others are different.
4073 // Therefore, we use GENERIC_RELOC_VANILLA
4074 // and GENERIC_RELOC_PAIR instead of the PPC variants,
4075 // and use #ifdefs for the other types.
4077 // Step 1: Figure out what the relocated value should be
4078 if(scat->r_type == GENERIC_RELOC_VANILLA)
4080 word = *wordPtr + (unsigned long) relocateAddress(
4087 #ifdef powerpc_HOST_ARCH
4088 else if(scat->r_type == PPC_RELOC_SECTDIFF
4089 || scat->r_type == PPC_RELOC_LO16_SECTDIFF
4090 || scat->r_type == PPC_RELOC_HI16_SECTDIFF
4091 || scat->r_type == PPC_RELOC_HA16_SECTDIFF)
4093 else if(scat->r_type == GENERIC_RELOC_SECTDIFF)
4096 struct scattered_relocation_info *pair =
4097 (struct scattered_relocation_info*) &relocs[i+1];
4099 if(!pair->r_scattered || pair->r_type != GENERIC_RELOC_PAIR)
4100 barf("Invalid Mach-O file: "
4101 "RELOC_*_SECTDIFF not followed by RELOC_PAIR");
4103 word = (unsigned long)
4104 (relocateAddress(oc, nSections, sections, scat->r_value)
4105 - relocateAddress(oc, nSections, sections, pair->r_value));
4108 #ifdef powerpc_HOST_ARCH
4109 else if(scat->r_type == PPC_RELOC_HI16
4110 || scat->r_type == PPC_RELOC_LO16
4111 || scat->r_type == PPC_RELOC_HA16
4112 || scat->r_type == PPC_RELOC_LO14)
4113 { // these are generated by label+offset things
4114 struct relocation_info *pair = &relocs[i+1];
4115 if((pair->r_address & R_SCATTERED) || pair->r_type != PPC_RELOC_PAIR)
4116 barf("Invalid Mach-O file: "
4117 "PPC_RELOC_* not followed by PPC_RELOC_PAIR");
4119 if(scat->r_type == PPC_RELOC_LO16)
4121 word = ((unsigned short*) wordPtr)[1];
4122 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4124 else if(scat->r_type == PPC_RELOC_LO14)
4126 barf("Unsupported Relocation: PPC_RELOC_LO14");
4127 word = ((unsigned short*) wordPtr)[1] & 0xFFFC;
4128 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4130 else if(scat->r_type == PPC_RELOC_HI16)
4132 word = ((unsigned short*) wordPtr)[1] << 16;
4133 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4135 else if(scat->r_type == PPC_RELOC_HA16)
4137 word = ((unsigned short*) wordPtr)[1] << 16;
4138 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4142 word += (unsigned long) relocateAddress(oc, nSections, sections, scat->r_value)
4149 continue; // ignore the others
4151 #ifdef powerpc_HOST_ARCH
4152 if(scat->r_type == GENERIC_RELOC_VANILLA
4153 || scat->r_type == PPC_RELOC_SECTDIFF)
4155 if(scat->r_type == GENERIC_RELOC_VANILLA
4156 || scat->r_type == GENERIC_RELOC_SECTDIFF)
4161 #ifdef powerpc_HOST_ARCH
4162 else if(scat->r_type == PPC_RELOC_LO16_SECTDIFF || scat->r_type == PPC_RELOC_LO16)
4164 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4166 else if(scat->r_type == PPC_RELOC_HI16_SECTDIFF || scat->r_type == PPC_RELOC_HI16)
4168 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4170 else if(scat->r_type == PPC_RELOC_HA16_SECTDIFF || scat->r_type == PPC_RELOC_HA16)
4172 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4173 + ((word & (1<<15)) ? 1 : 0);
4179 continue; // FIXME: I hope it's OK to ignore all the others.
4183 struct relocation_info *reloc = &relocs[i];
4184 if(reloc->r_pcrel && !reloc->r_extern)
4187 if(reloc->r_length == 2)
4189 unsigned long word = 0;
4190 #ifdef powerpc_HOST_ARCH
4191 unsigned long jumpIsland = 0;
4192 long offsetToJumpIsland = 0xBADBAD42; // initialise to bad value
4193 // to avoid warning and to catch
4197 unsigned long* wordPtr = (unsigned long*) (image + sect->offset + reloc->r_address);
4198 checkProddableBlock(oc,wordPtr);
4200 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4204 #ifdef powerpc_HOST_ARCH
4205 else if(reloc->r_type == PPC_RELOC_LO16)
4207 word = ((unsigned short*) wordPtr)[1];
4208 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF) << 16;
4210 else if(reloc->r_type == PPC_RELOC_HI16)
4212 word = ((unsigned short*) wordPtr)[1] << 16;
4213 word |= ((unsigned long) relocs[i+1].r_address & 0xFFFF);
4215 else if(reloc->r_type == PPC_RELOC_HA16)
4217 word = ((unsigned short*) wordPtr)[1] << 16;
4218 word += ((short)relocs[i+1].r_address & (short)0xFFFF);
4220 else if(reloc->r_type == PPC_RELOC_BR24)
4223 word = (word & 0x03FFFFFC) | ((word & 0x02000000) ? 0xFC000000 : 0);
4227 if(!reloc->r_extern)
4230 sections[reloc->r_symbolnum-1].offset
4231 - sections[reloc->r_symbolnum-1].addr
4238 struct nlist *symbol = &nlist[reloc->r_symbolnum];
4239 char *nm = image + symLC->stroff + symbol->n_un.n_strx;
4240 void *symbolAddress = lookupSymbol(nm);
4243 errorBelch("\nunknown symbol `%s'", nm);
4249 #ifdef powerpc_HOST_ARCH
4250 // In the .o file, this should be a relative jump to NULL
4251 // and we'll change it to a relative jump to the symbol
4252 ASSERT(-word == reloc->r_address);
4253 jumpIsland = (unsigned long)
4254 &makeSymbolExtra(oc,
4256 (unsigned long) symbolAddress)
4260 offsetToJumpIsland = word + jumpIsland
4261 - (((long)image) + sect->offset - sect->addr);
4264 word += (unsigned long) symbolAddress
4265 - (((long)image) + sect->offset - sect->addr);
4269 word += (unsigned long) symbolAddress;
4273 if(reloc->r_type == GENERIC_RELOC_VANILLA)
4278 #ifdef powerpc_HOST_ARCH
4279 else if(reloc->r_type == PPC_RELOC_LO16)
4281 ((unsigned short*) wordPtr)[1] = word & 0xFFFF;
4284 else if(reloc->r_type == PPC_RELOC_HI16)
4286 ((unsigned short*) wordPtr)[1] = (word >> 16) & 0xFFFF;
4289 else if(reloc->r_type == PPC_RELOC_HA16)
4291 ((unsigned short*) wordPtr)[1] = ((word >> 16) & 0xFFFF)
4292 + ((word & (1<<15)) ? 1 : 0);
4295 else if(reloc->r_type == PPC_RELOC_BR24)
4297 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4299 // The branch offset is too large.
4300 // Therefore, we try to use a jump island.
4303 barf("unconditional relative branch out of range: "
4304 "no jump island available");
4307 word = offsetToJumpIsland;
4308 if((long)word > (long)0x01FFFFFF || (long)word < (long)0xFFE00000)
4309 barf("unconditional relative branch out of range: "
4310 "jump island out of range");
4312 *wordPtr = (*wordPtr & 0xFC000003) | (word & 0x03FFFFFC);
4317 barf("\nunknown relocation %d",reloc->r_type);
4325 static int ocGetNames_MachO(ObjectCode* oc)
4327 char *image = (char*) oc->image;
4328 struct mach_header *header = (struct mach_header*) image;
4329 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4330 unsigned i,curSymbol = 0;
4331 struct segment_command *segLC = NULL;
4332 struct section *sections;
4333 struct symtab_command *symLC = NULL;
4334 struct nlist *nlist;
4335 unsigned long commonSize = 0;
4336 char *commonStorage = NULL;
4337 unsigned long commonCounter;
4339 for(i=0;i<header->ncmds;i++)
4341 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4342 segLC = (struct segment_command*) lc;
4343 else if(lc->cmd == LC_SYMTAB)
4344 symLC = (struct symtab_command*) lc;
4345 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4348 sections = (struct section*) (segLC+1);
4349 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4353 barf("ocGetNames_MachO: no segment load command");
4355 for(i=0;i<segLC->nsects;i++)
4357 if(sections[i].size == 0)
4360 if((sections[i].flags & SECTION_TYPE) == S_ZEROFILL)
4362 char * zeroFillArea = stgCallocBytes(1,sections[i].size,
4363 "ocGetNames_MachO(common symbols)");
4364 sections[i].offset = zeroFillArea - image;
4367 if(!strcmp(sections[i].sectname,"__text"))
4368 addSection(oc, SECTIONKIND_CODE_OR_RODATA,
4369 (void*) (image + sections[i].offset),
4370 (void*) (image + sections[i].offset + sections[i].size));
4371 else if(!strcmp(sections[i].sectname,"__const"))
4372 addSection(oc, SECTIONKIND_RWDATA,
4373 (void*) (image + sections[i].offset),
4374 (void*) (image + sections[i].offset + sections[i].size));
4375 else if(!strcmp(sections[i].sectname,"__data"))
4376 addSection(oc, SECTIONKIND_RWDATA,
4377 (void*) (image + sections[i].offset),
4378 (void*) (image + sections[i].offset + sections[i].size));
4379 else if(!strcmp(sections[i].sectname,"__bss")
4380 || !strcmp(sections[i].sectname,"__common"))
4381 addSection(oc, SECTIONKIND_RWDATA,
4382 (void*) (image + sections[i].offset),
4383 (void*) (image + sections[i].offset + sections[i].size));
4385 addProddableBlock(oc, (void*) (image + sections[i].offset),
4389 // count external symbols defined here
4393 for(i=0;i<symLC->nsyms;i++)
4395 if(nlist[i].n_type & N_STAB)
4397 else if(nlist[i].n_type & N_EXT)
4399 if((nlist[i].n_type & N_TYPE) == N_UNDF
4400 && (nlist[i].n_value != 0))
4402 commonSize += nlist[i].n_value;
4405 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4410 oc->symbols = stgMallocBytes(oc->n_symbols * sizeof(char*),
4411 "ocGetNames_MachO(oc->symbols)");
4415 for(i=0;i<symLC->nsyms;i++)
4417 if(nlist[i].n_type & N_STAB)
4419 else if((nlist[i].n_type & N_TYPE) == N_SECT)
4421 if(nlist[i].n_type & N_EXT)
4423 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4424 if((nlist[i].n_desc & N_WEAK_DEF) && lookupSymbol(nm))
4425 ; // weak definition, and we already have a definition
4428 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4430 + sections[nlist[i].n_sect-1].offset
4431 - sections[nlist[i].n_sect-1].addr
4432 + nlist[i].n_value);
4433 oc->symbols[curSymbol++] = nm;
4440 commonStorage = stgCallocBytes(1,commonSize,"ocGetNames_MachO(common symbols)");
4441 commonCounter = (unsigned long)commonStorage;
4444 for(i=0;i<symLC->nsyms;i++)
4446 if((nlist[i].n_type & N_TYPE) == N_UNDF
4447 && (nlist[i].n_type & N_EXT) && (nlist[i].n_value != 0))
4449 char *nm = image + symLC->stroff + nlist[i].n_un.n_strx;
4450 unsigned long sz = nlist[i].n_value;
4452 nlist[i].n_value = commonCounter;
4454 ghciInsertStrHashTable(oc->fileName, symhash, nm,
4455 (void*)commonCounter);
4456 oc->symbols[curSymbol++] = nm;
4458 commonCounter += sz;
4465 static int ocResolve_MachO(ObjectCode* oc)
4467 char *image = (char*) oc->image;
4468 struct mach_header *header = (struct mach_header*) image;
4469 struct load_command *lc = (struct load_command*) (image + sizeof(struct mach_header));
4471 struct segment_command *segLC = NULL;
4472 struct section *sections;
4473 struct symtab_command *symLC = NULL;
4474 struct dysymtab_command *dsymLC = NULL;
4475 struct nlist *nlist;
4477 for(i=0;i<header->ncmds;i++)
4479 if(lc->cmd == LC_SEGMENT || lc->cmd == LC_SEGMENT_64)
4480 segLC = (struct segment_command*) lc;
4481 else if(lc->cmd == LC_SYMTAB)
4482 symLC = (struct symtab_command*) lc;
4483 else if(lc->cmd == LC_DYSYMTAB)
4484 dsymLC = (struct dysymtab_command*) lc;
4485 lc = (struct load_command *) ( ((char*)lc) + lc->cmdsize );
4488 sections = (struct section*) (segLC+1);
4489 nlist = symLC ? (struct nlist*) (image + symLC->symoff)
4494 unsigned long *indirectSyms
4495 = (unsigned long*) (image + dsymLC->indirectsymoff);
4497 for(i=0;i<segLC->nsects;i++)
4499 if( !strcmp(sections[i].sectname,"__la_symbol_ptr")
4500 || !strcmp(sections[i].sectname,"__la_sym_ptr2")
4501 || !strcmp(sections[i].sectname,"__la_sym_ptr3"))
4503 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4506 else if(!strcmp(sections[i].sectname,"__nl_symbol_ptr")
4507 || !strcmp(sections[i].sectname,"__pointers"))
4509 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4512 else if(!strcmp(sections[i].sectname,"__jump_table"))
4514 if(!resolveImports(oc,image,symLC,§ions[i],indirectSyms,nlist))
4520 for(i=0;i<segLC->nsects;i++)
4522 if(!relocateSection(oc,image,symLC,nlist,segLC->nsects,sections,§ions[i]))
4526 /* Free the local symbol table; we won't need it again. */
4527 freeHashTable(oc->lochash, NULL);
4530 #if defined (powerpc_HOST_ARCH)
4531 ocFlushInstructionCache( oc );
4537 #ifdef powerpc_HOST_ARCH
4539 * The Mach-O object format uses leading underscores. But not everywhere.
4540 * There is a small number of runtime support functions defined in
4541 * libcc_dynamic.a whose name does not have a leading underscore.
4542 * As a consequence, we can't get their address from C code.
4543 * We have to use inline assembler just to take the address of a function.
4547 static void machoInitSymbolsWithoutUnderscore()
4549 extern void* symbolsWithoutUnderscore[];
4550 void **p = symbolsWithoutUnderscore;
4551 __asm__ volatile(".globl _symbolsWithoutUnderscore\n.data\n_symbolsWithoutUnderscore:");
4555 __asm__ volatile(".long " # x);
4557 RTS_MACHO_NOUNDERLINE_SYMBOLS
4559 __asm__ volatile(".text");
4563 ghciInsertStrHashTable("(GHCi built-in symbols)", symhash, #x, *p++);
4565 RTS_MACHO_NOUNDERLINE_SYMBOLS
4572 * Figure out by how much to shift the entire Mach-O file in memory
4573 * when loading so that its single segment ends up 16-byte-aligned
4575 static int machoGetMisalignment( FILE * f )
4577 struct mach_header header;
4580 fread(&header, sizeof(header), 1, f);
4583 #if x86_64_TARGET_ARCH || powerpc64_TARGET_ARCH
4584 if(header.magic != MH_MAGIC_64)
4587 if(header.magic != MH_MAGIC)
4591 misalignment = (header.sizeofcmds + sizeof(header))
4594 return misalignment ? (16 - misalignment) : 0;