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