lib/ExecutionEngine/RuntimeDyld/RuntimeDyldELF.h

   1 //===-- RuntimeDyldELF.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 // ELF support for MC-JIT runtime dynamic linker.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDELF_H
  15 #define LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDELF_H
  16
  17 #include "RuntimeDyldImpl.h"
  18 #include "llvm/ADT/DenseMap.h"
  19
  20 using namespace llvm;
  21
  22 namespace llvm {
  23
  24 class RuntimeDyldELF : public RuntimeDyldImpl {
  25
  26   void resolveRelocation(const SectionEntry &Section, uint64_t Offset,
  27                          uint64_t Value, uint32_t Type, int64_t Addend,
  28                          uint64_t SymOffset = 0);
  29
  30   void resolveX86_64Relocation(const SectionEntry &Section, uint64_t Offset,
  31                                uint64_t Value, uint32_t Type, int64_t Addend,
  32                                uint64_t SymOffset);
  33
  34   void resolveX86Relocation(const SectionEntry &Section, uint64_t Offset,
  35                             uint32_t Value, uint32_t Type, int32_t Addend);
  36
  37   void resolveAArch64Relocation(const SectionEntry &Section, uint64_t Offset,
  38                                 uint64_t Value, uint32_t Type, int64_t Addend);
  39
  40   void resolveARMRelocation(const SectionEntry &Section, uint64_t Offset,
  41                             uint32_t Value, uint32_t Type, int32_t Addend);
  42
  43   void resolveMIPSRelocation(const SectionEntry &Section, uint64_t Offset,
  44                              uint32_t Value, uint32_t Type, int32_t Addend);
  45
  46   void resolvePPC64Relocation(const SectionEntry &Section, uint64_t Offset,
  47                               uint64_t Value, uint32_t Type, int64_t Addend);
  48
  49   void resolveSystemZRelocation(const SectionEntry &Section, uint64_t Offset,
  50                                 uint64_t Value, uint32_t Type, int64_t Addend);
  51
  52   unsigned getMaxStubSize() override {
  53     if (Arch == Triple::aarch64 || Arch == Triple::aarch64_be)
  54       return 20; // movz; movk; movk; movk; br
  55     if (Arch == Triple::arm || Arch == Triple::thumb)
  56       return 8; // 32-bit instruction and 32-bit address
  57     else if (Arch == Triple::mipsel || Arch == Triple::mips)
  58       return 16;
  59     else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le)
  60       return 44;
  61     else if (Arch == Triple::x86_64)
  62       return 6; // 2-byte jmp instruction + 32-bit relative address
  63     else if (Arch == Triple::systemz)
  64       return 16;
  65     else
  66       return 0;
  67   }
  68
  69   unsigned getStubAlignment() override {
  70     if (Arch == Triple::systemz)
  71       return 8;
  72     else
  73       return 1;
  74   }
  75
  76   void findPPC64TOCSection(const ObjectFile &Obj,
  77                            ObjSectionToIDMap &LocalSections,
  78                            RelocationValueRef &Rel);
  79   void findOPDEntrySection(const ObjectFile &Obj,
  80                            ObjSectionToIDMap &LocalSections,
  81                            RelocationValueRef &Rel);
  82
  83   size_t getGOTEntrySize();
  84
  85   SectionEntry &getSection(unsigned SectionID) { return Sections[SectionID]; }
  86
  87   // Allocate no GOT entries for use in the given section.
  88   uint64_t allocateGOTEntries(unsigned SectionID, unsigned no);
  89
  90   // Resolve the relvative address of GOTOffset in Section ID and place
  91   // it at the given Offset
  92   void resolveGOTOffsetRelocation(unsigned SectionID, uint64_t Offset,
  93                                   uint64_t GOTOffset);
  94
  95   // For a GOT entry referenced from SectionID, compute a relocation entry
  96   // that will place the final resolved value in the GOT slot
  97   RelocationEntry computeGOTOffsetRE(unsigned SectionID,
  98                                      uint64_t GOTOffset,
  99                                      uint64_t SymbolOffset,
 100                                      unsigned Type);
 101
 102   // Compute the address in memory where we can find the placeholder
 103   void *computePlaceholderAddress(unsigned SectionID, uint64_t Offset) const;
 104
 105   // Split out common case for createing the RelocationEntry for when the relocation requires
 106   // no particular advanced processing.
 107   void processSimpleRelocation(unsigned SectionID, uint64_t Offset, unsigned RelType, RelocationValueRef Value);
 108
 109   // The tentative ID for the GOT section
 110   unsigned GOTSectionID;
 111
 112   // Records the current number of allocated slots in the GOT
 113   // (This would be equivalent to GOTEntries.size() were it not for relocations
 114   // that consume more than one slot)
 115   unsigned CurrentGOTIndex;
 116
 117   // When a module is loaded we save the SectionID of the EH frame section
 118   // in a table until we receive a request to register all unregistered
 119   // EH frame sections with the memory manager.
 120   SmallVector<SID, 2> UnregisteredEHFrameSections;
 121   SmallVector<SID, 2> RegisteredEHFrameSections;
 122
 123 public:
 124   RuntimeDyldELF(RuntimeDyld::MemoryManager &MemMgr,
 125                  RuntimeDyld::SymbolResolver &Resolver);
 126   ~RuntimeDyldELF() override;
 127
 128   std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
 129   loadObject(const object::ObjectFile &O) override;
 130
 131   void resolveRelocation(const RelocationEntry &RE, uint64_t Value) override;
 132   relocation_iterator
 133   processRelocationRef(unsigned SectionID, relocation_iterator RelI,
 134                        const ObjectFile &Obj,
 135                        ObjSectionToIDMap &ObjSectionToID,
 136                        StubMap &Stubs) override;
 137   bool isCompatibleFile(const object::ObjectFile &Obj) const override;
 138   void registerEHFrames() override;
 139   void deregisterEHFrames() override;
 140   void finalizeLoad(const ObjectFile &Obj,
 141                     ObjSectionToIDMap &SectionMap) override;
 142 };
 143
 144 } // end namespace llvm
 145
 146 #endif