lib/ExecutionEngine/RuntimeDyld/RuntimeDyldMachO.h

   1 //===-- RuntimeDyldMachO.h - Run-time dynamic linker for MC-JIT ---*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // MachO support for MC-JIT runtime dynamic linker.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_RUNTIME_DYLD_MACHO_H
  15 #define LLVM_RUNTIME_DYLD_MACHO_H
  16
  17 #include "ObjectImageCommon.h"
  18 #include "RuntimeDyldImpl.h"
  19 #include "llvm/ADT/IndexedMap.h"
  20 #include "llvm/Object/MachO.h"
  21 #include "llvm/Support/Format.h"
  22
  23 using namespace llvm;
  24 using namespace llvm::object;
  25
  26 namespace llvm {
  27 class RuntimeDyldMachO : public RuntimeDyldImpl {
  28 private:
  29
  30   /// Write the least significant 'Size' bytes in 'Value' out at the address
  31   /// pointed to by Addr. Check for overflow.
  32   bool applyRelocationValue(uint8_t *Addr, uint64_t Value, unsigned Size) {
  33     for (unsigned i = 0; i < Size; ++i) {
  34       *Addr++ = (uint8_t)Value;
  35       Value >>= 8;
  36     }
  37
  38     if (Value) // Catch overflow
  39       return Error("Relocation out of range.");
  40
  41     return false;
  42   }
  43
  44   bool resolveI386Relocation(const RelocationEntry &RE, uint64_t Value);
  45   bool resolveX86_64Relocation(const RelocationEntry &RE, uint64_t Value);
  46   bool resolveARMRelocation(const RelocationEntry &RE, uint64_t Value);
  47   bool resolveARM64Relocation(const RelocationEntry &RE, uint64_t Value);
  48
  49   // Populate stubs in __jump_table section.
  50   void populateJumpTable(MachOObjectFile &Obj, const SectionRef &JTSection,
  51                          unsigned JTSectionID);
  52
  53   // Populate __pointers section.
  54   void populatePointersSection(MachOObjectFile &Obj, const SectionRef &PTSection,
  55                                unsigned PTSectionID);
  56
  57   unsigned getMaxStubSize() override {
  58     if (Arch == Triple::arm || Arch == Triple::thumb)
  59       return 8; // 32-bit instruction and 32-bit address
  60     else if (Arch == Triple::x86_64)
  61       return 8; // GOT entry
  62     else
  63       return 0;
  64   }
  65
  66   unsigned getStubAlignment() override { return 1; }
  67
  68   relocation_iterator processSECTDIFFRelocation(
  69                                              unsigned SectionID,
  70                                              relocation_iterator RelI,
  71                                              ObjectImage &ObjImg,
  72                                              ObjSectionToIDMap &ObjSectionToID);
  73
  74   relocation_iterator processI386ScatteredVANILLA(
  75                                              unsigned SectionID,
  76                                              relocation_iterator RelI,
  77                                              ObjectImage &ObjImg,
  78                                              ObjSectionToIDMap &ObjSectionToID);
  79
  80   struct EHFrameRelatedSections {
  81     EHFrameRelatedSections()
  82         : EHFrameSID(RTDYLD_INVALID_SECTION_ID),
  83           TextSID(RTDYLD_INVALID_SECTION_ID),
  84           ExceptTabSID(RTDYLD_INVALID_SECTION_ID) {}
  85     EHFrameRelatedSections(SID EH, SID T, SID Ex)
  86         : EHFrameSID(EH), TextSID(T), ExceptTabSID(Ex) {}
  87     SID EHFrameSID;
  88     SID TextSID;
  89     SID ExceptTabSID;
  90   };
  91
  92   // When a module is loaded we save the SectionID of the EH frame section
  93   // in a table until we receive a request to register all unregistered
  94   // EH frame sections with the memory manager.
  95   SmallVector<EHFrameRelatedSections, 2> UnregisteredEHFrameSections;
  96
  97 public:
  98   RuntimeDyldMachO(RTDyldMemoryManager *mm) : RuntimeDyldImpl(mm) {}
  99
 100   void resolveRelocation(const RelocationEntry &RE, uint64_t Value) override;
 101   relocation_iterator
 102   processRelocationRef(unsigned SectionID, relocation_iterator RelI,
 103                        ObjectImage &Obj, ObjSectionToIDMap &ObjSectionToID,
 104                        const SymbolTableMap &Symbols, StubMap &Stubs) override;
 105   bool isCompatibleFormat(const ObjectBuffer *Buffer) const override;
 106   bool isCompatibleFile(const object::ObjectFile *Obj) const override;
 107   void registerEHFrames() override;
 108   void finalizeLoad(ObjectImage &ObjImg,
 109                     ObjSectionToIDMap &SectionMap) override;
 110
 111   static ObjectImage *createObjectImage(ObjectBuffer *InputBuffer) {
 112     return new ObjectImageCommon(InputBuffer);
 113   }
 114
 115   static ObjectImage *
 116   createObjectImageFromFile(std::unique_ptr<object::ObjectFile> InputObject) {
 117     return new ObjectImageCommon(std::move(InputObject));
 118   }
 119 };
 120
 121 } // end namespace llvm
 122
 123 #endif