lib/ExecutionEngine/RuntimeDyld/RuntimeDyldImpl.h

   1 //===-- RuntimeDyldImpl.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 // Interface for the implementations of runtime dynamic linker facilities.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDIMPL_H
  15 #define LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDIMPL_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/StringMap.h"
  20 #include "llvm/ADT/Triple.h"
  21 #include "llvm/ExecutionEngine/ObjectImage.h"
  22 #include "llvm/ExecutionEngine/RuntimeDyld.h"
  23 #include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
  24 #include "llvm/Object/ObjectFile.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/ErrorHandling.h"
  27 #include "llvm/Support/Format.h"
  28 #include "llvm/Support/Host.h"
  29 #include "llvm/Support/Mutex.h"
  30 #include "llvm/Support/SwapByteOrder.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include <map>
  33 #include <system_error>
  34
  35 using namespace llvm;
  36 using namespace llvm::object;
  37
  38 namespace llvm {
  39
  40 class ObjectBuffer;
  41 class Twine;
  42
  43 /// SectionEntry - represents a section emitted into memory by the dynamic
  44 /// linker.
  45 class SectionEntry {
  46 public:
  47   /// Name - section name.
  48   StringRef Name;
  49
  50   /// Address - address in the linker's memory where the section resides.
  51   uint8_t *Address;
  52
  53   /// Size - section size. Doesn't include the stubs.
  54   size_t Size;
  55
  56   /// LoadAddress - the address of the section in the target process's memory.
  57   /// Used for situations in which JIT-ed code is being executed in the address
  58   /// space of a separate process.  If the code executes in the same address
  59   /// space where it was JIT-ed, this just equals Address.
  60   uint64_t LoadAddress;
  61
  62   /// StubOffset - used for architectures with stub functions for far
  63   /// relocations (like ARM).
  64   uintptr_t StubOffset;
  65
  66   /// ObjAddress - address of the section in the in-memory object file.  Used
  67   /// for calculating relocations in some object formats (like MachO).
  68   uintptr_t ObjAddress;
  69
  70   SectionEntry(StringRef name, uint8_t *address, size_t size,
  71                uintptr_t objAddress)
  72       : Name(name), Address(address), Size(size),
  73         LoadAddress(reinterpret_cast<uintptr_t>(address)), StubOffset(size),
  74         ObjAddress(objAddress) {}
  75 };
  76
  77 /// RelocationEntry - used to represent relocations internally in the dynamic
  78 /// linker.
  79 class RelocationEntry {
  80 public:
  81   /// SectionID - the section this relocation points to.
  82   unsigned SectionID;
  83
  84   /// Offset - offset into the section.
  85   uint64_t Offset;
  86
  87   /// RelType - relocation type.
  88   uint32_t RelType;
  89
  90   /// Addend - the relocation addend encoded in the instruction itself.  Also
  91   /// used to make a relocation section relative instead of symbol relative.
  92   int64_t Addend;
  93
  94   struct SectionPair {
  95       uint32_t SectionA;
  96       uint32_t SectionB;
  97   };
  98
  99   /// SymOffset - Section offset of the relocation entry's symbol (used for GOT
 100   /// lookup).
 101   union {
 102     uint64_t SymOffset;
 103     SectionPair Sections;
 104   };
 105
 106   /// True if this is a PCRel relocation (MachO specific).
 107   bool IsPCRel;
 108
 109   /// The size of this relocation (MachO specific).
 110   unsigned Size;
 111
 112   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend)
 113       : SectionID(id), Offset(offset), RelType(type), Addend(addend),
 114         SymOffset(0), IsPCRel(false), Size(0) {}
 115
 116   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
 117                   uint64_t symoffset)
 118       : SectionID(id), Offset(offset), RelType(type), Addend(addend),
 119         SymOffset(symoffset), IsPCRel(false), Size(0) {}
 120
 121   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
 122                   bool IsPCRel, unsigned Size)
 123       : SectionID(id), Offset(offset), RelType(type), Addend(addend),
 124         SymOffset(0), IsPCRel(IsPCRel), Size(Size) {}
 125
 126   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
 127                   unsigned SectionA, uint64_t SectionAOffset, unsigned SectionB,
 128                   uint64_t SectionBOffset, bool IsPCRel, unsigned Size)
 129       : SectionID(id), Offset(offset), RelType(type),
 130         Addend(SectionAOffset - SectionBOffset + addend), IsPCRel(IsPCRel),
 131         Size(Size) {
 132     Sections.SectionA = SectionA;
 133     Sections.SectionB = SectionB;
 134   }
 135 };
 136
 137 class RelocationValueRef {
 138 public:
 139   unsigned SectionID;
 140   uint64_t Offset;
 141   int64_t Addend;
 142   const char *SymbolName;
 143   RelocationValueRef() : SectionID(0), Offset(0), Addend(0),
 144                          SymbolName(nullptr) {}
 145
 146   inline bool operator==(const RelocationValueRef &Other) const {
 147     return SectionID == Other.SectionID && Offset == Other.Offset &&
 148            Addend == Other.Addend && SymbolName == Other.SymbolName;
 149   }
 150   inline bool operator<(const RelocationValueRef &Other) const {
 151     if (SectionID != Other.SectionID)
 152       return SectionID < Other.SectionID;
 153     if (Offset != Other.Offset)
 154       return Offset < Other.Offset;
 155     if (Addend != Other.Addend)
 156       return Addend < Other.Addend;
 157     return SymbolName < Other.SymbolName;
 158   }
 159 };
 160
 161 class RuntimeDyldImpl {
 162   friend class RuntimeDyldCheckerImpl;
 163 private:
 164
 165   uint64_t getAnySymbolRemoteAddress(StringRef Symbol) {
 166     if (uint64_t InternalSymbolAddr = getSymbolLoadAddress(Symbol))
 167       return InternalSymbolAddr;
 168     return MemMgr->getSymbolAddress(Symbol);
 169   }
 170
 171 protected:
 172   // The MemoryManager to load objects into.
 173   RTDyldMemoryManager *MemMgr;
 174
 175   // Attached RuntimeDyldChecker instance. Null if no instance attached.
 176   RuntimeDyldCheckerImpl *Checker;
 177
 178   // A list of all sections emitted by the dynamic linker.  These sections are
 179   // referenced in the code by means of their index in this list - SectionID.
 180   typedef SmallVector<SectionEntry, 64> SectionList;
 181   SectionList Sections;
 182
 183   typedef unsigned SID; // Type for SectionIDs
 184 #define RTDYLD_INVALID_SECTION_ID ((SID)(-1))
 185
 186   // Keep a map of sections from object file to the SectionID which
 187   // references it.
 188   typedef std::map<SectionRef, unsigned> ObjSectionToIDMap;
 189
 190   // A global symbol table for symbols from all loaded modules.  Maps the
 191   // symbol name to a (SectionID, offset in section) pair.
 192   typedef std::pair<unsigned, uintptr_t> SymbolLoc;
 193   typedef StringMap<SymbolLoc> SymbolTableMap;
 194   SymbolTableMap GlobalSymbolTable;
 195
 196   // Pair representing the size and alignment requirement for a common symbol.
 197   typedef std::pair<unsigned, unsigned> CommonSymbolInfo;
 198   // Keep a map of common symbols to their info pairs
 199   typedef std::map<SymbolRef, CommonSymbolInfo> CommonSymbolMap;
 200
 201   // For each symbol, keep a list of relocations based on it. Anytime
 202   // its address is reassigned (the JIT re-compiled the function, e.g.),
 203   // the relocations get re-resolved.
 204   // The symbol (or section) the relocation is sourced from is the Key
 205   // in the relocation list where it's stored.
 206   typedef SmallVector<RelocationEntry, 64> RelocationList;
 207   // Relocations to sections already loaded. Indexed by SectionID which is the
 208   // source of the address. The target where the address will be written is
 209   // SectionID/Offset in the relocation itself.
 210   DenseMap<unsigned, RelocationList> Relocations;
 211
 212   // Relocations to external symbols that are not yet resolved.  Symbols are
 213   // external when they aren't found in the global symbol table of all loaded
 214   // modules.  This map is indexed by symbol name.
 215   StringMap<RelocationList> ExternalSymbolRelocations;
 216
 217
 218   typedef std::map<RelocationValueRef, uintptr_t> StubMap;
 219
 220   Triple::ArchType Arch;
 221   bool IsTargetLittleEndian;
 222
 223   // True if all sections should be passed to the memory manager, false if only
 224   // sections containing relocations should be. Defaults to 'false'.
 225   bool ProcessAllSections;
 226
 227   // This mutex prevents simultaneously loading objects from two different
 228   // threads.  This keeps us from having to protect individual data structures
 229   // and guarantees that section allocation requests to the memory manager
 230   // won't be interleaved between modules.  It is also used in mapSectionAddress
 231   // and resolveRelocations to protect write access to internal data structures.
 232   //
 233   // loadObject may be called on the same thread during the handling of of
 234   // processRelocations, and that's OK.  The handling of the relocation lists
 235   // is written in such a way as to work correctly if new elements are added to
 236   // the end of the list while the list is being processed.
 237   sys::Mutex lock;
 238
 239   virtual unsigned getMaxStubSize() = 0;
 240   virtual unsigned getStubAlignment() = 0;
 241
 242   bool HasError;
 243   std::string ErrorStr;
 244
 245   // Set the error state and record an error string.
 246   bool Error(const Twine &Msg) {
 247     ErrorStr = Msg.str();
 248     HasError = true;
 249     return true;
 250   }
 251
 252   uint64_t getSectionLoadAddress(unsigned SectionID) {
 253     return Sections[SectionID].LoadAddress;
 254   }
 255
 256   uint8_t *getSectionAddress(unsigned SectionID) {
 257     return (uint8_t *)Sections[SectionID].Address;
 258   }
 259
 260   void writeInt16BE(uint8_t *Addr, uint16_t Value) {
 261     if (IsTargetLittleEndian)
 262       sys::swapByteOrder(Value);
 263     *Addr       = (Value >> 8) & 0xFF;
 264     *(Addr + 1) = Value & 0xFF;
 265   }
 266
 267   void writeInt32BE(uint8_t *Addr, uint32_t Value) {
 268     if (IsTargetLittleEndian)
 269       sys::swapByteOrder(Value);
 270     *Addr       = (Value >> 24) & 0xFF;
 271     *(Addr + 1) = (Value >> 16) & 0xFF;
 272     *(Addr + 2) = (Value >> 8) & 0xFF;
 273     *(Addr + 3) = Value & 0xFF;
 274   }
 275
 276   void writeInt64BE(uint8_t *Addr, uint64_t Value) {
 277     if (IsTargetLittleEndian)
 278       sys::swapByteOrder(Value);
 279     *Addr       = (Value >> 56) & 0xFF;
 280     *(Addr + 1) = (Value >> 48) & 0xFF;
 281     *(Addr + 2) = (Value >> 40) & 0xFF;
 282     *(Addr + 3) = (Value >> 32) & 0xFF;
 283     *(Addr + 4) = (Value >> 24) & 0xFF;
 284     *(Addr + 5) = (Value >> 16) & 0xFF;
 285     *(Addr + 6) = (Value >> 8) & 0xFF;
 286     *(Addr + 7) = Value & 0xFF;
 287   }
 288
 289   /// \brief Given the common symbols discovered in the object file, emit a
 290   /// new section for them and update the symbol mappings in the object and
 291   /// symbol table.
 292   void emitCommonSymbols(ObjectImage &Obj, const CommonSymbolMap &CommonSymbols,
 293                          uint64_t TotalSize, SymbolTableMap &SymbolTable);
 294
 295   /// \brief Emits section data from the object file to the MemoryManager.
 296   /// \param IsCode if it's true then allocateCodeSection() will be
 297   ///        used for emits, else allocateDataSection() will be used.
 298   /// \return SectionID.
 299   unsigned emitSection(ObjectImage &Obj, const SectionRef &Section,
 300                        bool IsCode);
 301
 302   /// \brief Find Section in LocalSections. If the secton is not found - emit
 303   ///        it and store in LocalSections.
 304   /// \param IsCode if it's true then allocateCodeSection() will be
 305   ///        used for emmits, else allocateDataSection() will be used.
 306   /// \return SectionID.
 307   unsigned findOrEmitSection(ObjectImage &Obj, const SectionRef &Section,
 308                              bool IsCode, ObjSectionToIDMap &LocalSections);
 309
 310   // \brief Add a relocation entry that uses the given section.
 311   void addRelocationForSection(const RelocationEntry &RE, unsigned SectionID);
 312
 313   // \brief Add a relocation entry that uses the given symbol.  This symbol may
 314   // be found in the global symbol table, or it may be external.
 315   void addRelocationForSymbol(const RelocationEntry &RE, StringRef SymbolName);
 316
 317   /// \brief Emits long jump instruction to Addr.
 318   /// \return Pointer to the memory area for emitting target address.
 319   uint8_t *createStubFunction(uint8_t *Addr, unsigned AbiVariant = 0);
 320
 321   /// \brief Resolves relocations from Relocs list with address from Value.
 322   void resolveRelocationList(const RelocationList &Relocs, uint64_t Value);
 323
 324   /// \brief A object file specific relocation resolver
 325   /// \param RE The relocation to be resolved
 326   /// \param Value Target symbol address to apply the relocation action
 327   virtual void resolveRelocation(const RelocationEntry &RE, uint64_t Value) = 0;
 328
 329   /// \brief Parses one or more object file relocations (some object files use
 330   ///        relocation pairs) and stores it to Relocations or SymbolRelocations
 331   ///        (this depends on the object file type).
 332   /// \return Iterator to the next relocation that needs to be parsed.
 333   virtual relocation_iterator
 334   processRelocationRef(unsigned SectionID, relocation_iterator RelI,
 335                        ObjectImage &Obj, ObjSectionToIDMap &ObjSectionToID,
 336                        const SymbolTableMap &Symbols, StubMap &Stubs) = 0;
 337
 338   /// \brief Resolve relocations to external symbols.
 339   void resolveExternalSymbols();
 340
 341   /// \brief Update GOT entries for external symbols.
 342   // The base class does nothing.  ELF overrides this.
 343   virtual void updateGOTEntries(StringRef Name, uint64_t Addr) {}
 344
 345   // \brief Compute an upper bound of the memory that is required to load all
 346   // sections
 347   void computeTotalAllocSize(ObjectImage &Obj, uint64_t &CodeSize,
 348                              uint64_t &DataSizeRO, uint64_t &DataSizeRW);
 349
 350   // \brief Compute the stub buffer size required for a section
 351   unsigned computeSectionStubBufSize(ObjectImage &Obj,
 352                                      const SectionRef &Section);
 353
 354 public:
 355   RuntimeDyldImpl(RTDyldMemoryManager *mm)
 356     : MemMgr(mm), Checker(nullptr), ProcessAllSections(false), HasError(false) {
 357   }
 358
 359   virtual ~RuntimeDyldImpl();
 360
 361   void setProcessAllSections(bool ProcessAllSections) {
 362     this->ProcessAllSections = ProcessAllSections;
 363   }
 364
 365   void setRuntimeDyldChecker(RuntimeDyldCheckerImpl *Checker) {
 366     this->Checker = Checker;
 367   }
 368
 369   ObjectImage *loadObject(ObjectImage *InputObject);
 370
 371   uint8_t* getSymbolAddress(StringRef Name) {
 372     // FIXME: Just look up as a function for now. Overly simple of course.
 373     // Work in progress.
 374     SymbolTableMap::const_iterator pos = GlobalSymbolTable.find(Name);
 375     if (pos == GlobalSymbolTable.end())
 376       return nullptr;
 377     SymbolLoc Loc = pos->second;
 378     return getSectionAddress(Loc.first) + Loc.second;
 379   }
 380
 381   uint64_t getSymbolLoadAddress(StringRef Name) {
 382     // FIXME: Just look up as a function for now. Overly simple of course.
 383     // Work in progress.
 384     SymbolTableMap::const_iterator pos = GlobalSymbolTable.find(Name);
 385     if (pos == GlobalSymbolTable.end())
 386       return 0;
 387     SymbolLoc Loc = pos->second;
 388     return getSectionLoadAddress(Loc.first) + Loc.second;
 389   }
 390
 391   void resolveRelocations();
 392
 393   void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
 394
 395   void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
 396
 397   // Is the linker in an error state?
 398   bool hasError() { return HasError; }
 399
 400   // Mark the error condition as handled and continue.
 401   void clearError() { HasError = false; }
 402
 403   // Get the error message.
 404   StringRef getErrorString() { return ErrorStr; }
 405
 406   virtual bool isCompatibleFormat(const ObjectBuffer *Buffer) const = 0;
 407   virtual bool isCompatibleFile(const ObjectFile *Obj) const = 0;
 408
 409   virtual void registerEHFrames();
 410
 411   virtual void deregisterEHFrames();
 412
 413   virtual void finalizeLoad(ObjectImage &ObjImg, ObjSectionToIDMap &SectionMap) {}
 414 };
 415
 416 } // end namespace llvm
 417
 418 #endif