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_RUNTIME_DYLD_IMPL_H
  15 #define LLVM_RUNTIME_DYLD_IMPL_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/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/SwapByteOrder.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/Support/system_error.h"
  31 #include <map>
  32
  33 using namespace llvm;
  34 using namespace llvm::object;
  35
  36 namespace llvm {
  37
  38 class ObjectBuffer;
  39 class Twine;
  40
  41
  42 /// SectionEntry - represents a section emitted into memory by the dynamic
  43 /// linker.
  44 class SectionEntry {
  45 public:
  46   /// Name - section name.
  47   StringRef Name;
  48
  49   /// Address - address in the linker's memory where the section resides.
  50   uint8_t *Address;
  51
  52   /// Size - section size.
  53   size_t Size;
  54
  55   /// LoadAddress - the address of the section in the target process's memory.
  56   /// Used for situations in which JIT-ed code is being executed in the address
  57   /// space of a separate process.  If the code executes in the same address
  58   /// space where it was JIT-ed, this just equals Address.
  59   uint64_t LoadAddress;
  60
  61   /// StubOffset - used for architectures with stub functions for far
  62   /// relocations (like ARM).
  63   uintptr_t StubOffset;
  64
  65   /// ObjAddress - address of the section in the in-memory object file.  Used
  66   /// for calculating relocations in some object formats (like MachO).
  67   uintptr_t ObjAddress;
  68
  69   SectionEntry(StringRef name, uint8_t *address, size_t size,
  70                uintptr_t stubOffset, uintptr_t objAddress)
  71     : Name(name), Address(address), Size(size), LoadAddress((uintptr_t)address),
  72       StubOffset(stubOffset), ObjAddress(objAddress) {}
  73 };
  74
  75 /// RelocationEntry - used to represent relocations internally in the dynamic
  76 /// linker.
  77 class RelocationEntry {
  78 public:
  79   /// SectionID - the section this relocation points to.
  80   unsigned SectionID;
  81
  82   /// Offset - offset into the section.
  83   uintptr_t Offset;
  84
  85   /// RelType - relocation type.
  86   uint32_t RelType;
  87
  88   /// Addend - the relocation addend encoded in the instruction itself.  Also
  89   /// used to make a relocation section relative instead of symbol relative.
  90   intptr_t Addend;
  91
  92   /// True if this is a PCRel relocation (MachO specific).
  93   bool IsPCRel;
  94
  95   /// The size of this relocation (MachO specific).
  96   unsigned Size;
  97
  98   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend)
  99     : SectionID(id), Offset(offset), RelType(type), Addend(addend),
 100       IsPCRel(false), Size(0) {}
 101
 102   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
 103                   bool IsPCRel, unsigned Size)
 104     : SectionID(id), Offset(offset), RelType(type), Addend(addend),
 105       IsPCRel(IsPCRel), Size(Size) {}
 106 };
 107
 108 class RelocationValueRef {
 109 public:
 110   unsigned  SectionID;
 111   intptr_t  Addend;
 112   const char *SymbolName;
 113   RelocationValueRef(): SectionID(0), Addend(0), SymbolName(0) {}
 114
 115   inline bool operator==(const RelocationValueRef &Other) const {
 116     return std::memcmp(this, &Other, sizeof(RelocationValueRef)) == 0;
 117   }
 118   inline bool operator <(const RelocationValueRef &Other) const {
 119     return std::memcmp(this, &Other, sizeof(RelocationValueRef)) < 0;
 120   }
 121 };
 122
 123 class RuntimeDyldImpl {
 124 protected:
 125   // The MemoryManager to load objects into.
 126   RTDyldMemoryManager *MemMgr;
 127
 128   // A list of all sections emitted by the dynamic linker.  These sections are
 129   // referenced in the code by means of their index in this list - SectionID.
 130   typedef SmallVector<SectionEntry, 64> SectionList;
 131   SectionList Sections;
 132
 133   // Keep a map of sections from object file to the SectionID which
 134   // references it.
 135   typedef std::map<SectionRef, unsigned> ObjSectionToIDMap;
 136
 137   // A global symbol table for symbols from all loaded modules.  Maps the
 138   // symbol name to a (SectionID, offset in section) pair.
 139   typedef std::pair<unsigned, uintptr_t> SymbolLoc;
 140   typedef StringMap<SymbolLoc> SymbolTableMap;
 141   SymbolTableMap GlobalSymbolTable;
 142
 143   // Pair representing the size and alignment requirement for a common symbol.
 144   typedef std::pair<unsigned, unsigned> CommonSymbolInfo;
 145   // Keep a map of common symbols to their info pairs
 146   typedef std::map<SymbolRef, CommonSymbolInfo> CommonSymbolMap;
 147
 148   // For each symbol, keep a list of relocations based on it. Anytime
 149   // its address is reassigned (the JIT re-compiled the function, e.g.),
 150   // the relocations get re-resolved.
 151   // The symbol (or section) the relocation is sourced from is the Key
 152   // in the relocation list where it's stored.
 153   typedef SmallVector<RelocationEntry, 64> RelocationList;
 154   // Relocations to sections already loaded. Indexed by SectionID which is the
 155   // source of the address. The target where the address will be written is
 156   // SectionID/Offset in the relocation itself.
 157   DenseMap<unsigned, RelocationList> Relocations;
 158
 159   // Relocations to external symbols that are not yet resolved.  Symbols are
 160   // external when they aren't found in the global symbol table of all loaded
 161   // modules.  This map is indexed by symbol name.
 162   StringMap<RelocationList> ExternalSymbolRelocations;
 163
 164   typedef std::map<RelocationValueRef, uintptr_t> StubMap;
 165
 166   Triple::ArchType Arch;
 167
 168   inline unsigned getMaxStubSize() {
 169     if (Arch == Triple::arm || Arch == Triple::thumb)
 170       return 8; // 32-bit instruction and 32-bit address
 171     else if (Arch == Triple::mipsel || Arch == Triple::mips)
 172       return 16;
 173     else if (Arch == Triple::ppc64)
 174       return 44;
 175     else if (Arch == Triple::systemz)
 176       return 16;
 177     else
 178       return 0;
 179   }
 180
 181   inline unsigned getStubAlignment() {
 182     if (Arch == Triple::systemz)
 183       return 8;
 184     else
 185       return 1;
 186   }
 187
 188   bool HasError;
 189   std::string ErrorStr;
 190
 191   // Set the error state and record an error string.
 192   bool Error(const Twine &Msg) {
 193     ErrorStr = Msg.str();
 194     HasError = true;
 195     return true;
 196   }
 197
 198   uint64_t getSectionLoadAddress(unsigned SectionID) {
 199     return Sections[SectionID].LoadAddress;
 200   }
 201
 202   uint8_t *getSectionAddress(unsigned SectionID) {
 203     return (uint8_t*)Sections[SectionID].Address;
 204   }
 205
 206   void writeInt16BE(uint8_t *Addr, uint16_t Value) {
 207     if (sys::IsLittleEndianHost)
 208       Value = sys::SwapByteOrder(Value);
 209     *Addr     = (Value >> 8) & 0xFF;
 210     *(Addr+1) = Value & 0xFF;
 211   }
 212
 213   void writeInt32BE(uint8_t *Addr, uint32_t Value) {
 214     if (sys::IsLittleEndianHost)
 215       Value = sys::SwapByteOrder(Value);
 216     *Addr     = (Value >> 24) & 0xFF;
 217     *(Addr+1) = (Value >> 16) & 0xFF;
 218     *(Addr+2) = (Value >> 8) & 0xFF;
 219     *(Addr+3) = Value & 0xFF;
 220   }
 221
 222   void writeInt64BE(uint8_t *Addr, uint64_t Value) {
 223     if (sys::IsLittleEndianHost)
 224       Value = sys::SwapByteOrder(Value);
 225     *Addr     = (Value >> 56) & 0xFF;
 226     *(Addr+1) = (Value >> 48) & 0xFF;
 227     *(Addr+2) = (Value >> 40) & 0xFF;
 228     *(Addr+3) = (Value >> 32) & 0xFF;
 229     *(Addr+4) = (Value >> 24) & 0xFF;
 230     *(Addr+5) = (Value >> 16) & 0xFF;
 231     *(Addr+6) = (Value >> 8) & 0xFF;
 232     *(Addr+7) = Value & 0xFF;
 233   }
 234
 235   /// \brief Given the common symbols discovered in the object file, emit a
 236   /// new section for them and update the symbol mappings in the object and
 237   /// symbol table.
 238   void emitCommonSymbols(ObjectImage &Obj,
 239                          const CommonSymbolMap &CommonSymbols,
 240                          uint64_t TotalSize,
 241                          SymbolTableMap &SymbolTable);
 242
 243   /// \brief Emits section data from the object file to the MemoryManager.
 244   /// \param IsCode if it's true then allocateCodeSection() will be
 245   ///        used for emits, else allocateDataSection() will be used.
 246   /// \return SectionID.
 247   unsigned emitSection(ObjectImage &Obj,
 248                        const SectionRef &Section,
 249                        bool IsCode);
 250
 251   /// \brief Find Section in LocalSections. If the secton is not found - emit
 252   ///        it and store in LocalSections.
 253   /// \param IsCode if it's true then allocateCodeSection() will be
 254   ///        used for emmits, else allocateDataSection() will be used.
 255   /// \return SectionID.
 256   unsigned findOrEmitSection(ObjectImage &Obj,
 257                              const SectionRef &Section,
 258                              bool IsCode,
 259                              ObjSectionToIDMap &LocalSections);
 260
 261   // \brief Add a relocation entry that uses the given section.
 262   void addRelocationForSection(const RelocationEntry &RE, unsigned SectionID);
 263
 264   // \brief Add a relocation entry that uses the given symbol.  This symbol may
 265   // be found in the global symbol table, or it may be external.
 266   void addRelocationForSymbol(const RelocationEntry &RE, StringRef SymbolName);
 267
 268   /// \brief Emits long jump instruction to Addr.
 269   /// \return Pointer to the memory area for emitting target address.
 270   uint8_t* createStubFunction(uint8_t *Addr);
 271
 272   /// \brief Resolves relocations from Relocs list with address from Value.
 273   void resolveRelocationList(const RelocationList &Relocs, uint64_t Value);
 274
 275   /// \brief A object file specific relocation resolver
 276   /// \param RE The relocation to be resolved
 277   /// \param Value Target symbol address to apply the relocation action
 278   virtual void resolveRelocation(const RelocationEntry &RE, uint64_t Value) = 0;
 279
 280   /// \brief Parses the object file relocation and stores it to Relocations
 281   ///        or SymbolRelocations (this depends on the object file type).
 282   virtual void processRelocationRef(unsigned SectionID,
 283                                     RelocationRef RelI,
 284                                     ObjectImage &Obj,
 285                                     ObjSectionToIDMap &ObjSectionToID,
 286                                     const SymbolTableMap &Symbols,
 287                                     StubMap &Stubs) = 0;
 288
 289   /// \brief Resolve relocations to external symbols.
 290   void resolveExternalSymbols();
 291   virtual ObjectImage *createObjectImage(ObjectBuffer *InputBuffer);
 292 public:
 293   RuntimeDyldImpl(RTDyldMemoryManager *mm) : MemMgr(mm), HasError(false) {}
 294
 295   virtual ~RuntimeDyldImpl();
 296
 297   ObjectImage *loadObject(ObjectBuffer *InputBuffer);
 298
 299   void *getSymbolAddress(StringRef Name) {
 300     // FIXME: Just look up as a function for now. Overly simple of course.
 301     // Work in progress.
 302     if (GlobalSymbolTable.find(Name) == GlobalSymbolTable.end())
 303       return 0;
 304     SymbolLoc Loc = GlobalSymbolTable.lookup(Name);
 305     return getSectionAddress(Loc.first) + Loc.second;
 306   }
 307
 308   uint64_t getSymbolLoadAddress(StringRef Name) {
 309     // FIXME: Just look up as a function for now. Overly simple of course.
 310     // Work in progress.
 311     if (GlobalSymbolTable.find(Name) == GlobalSymbolTable.end())
 312       return 0;
 313     SymbolLoc Loc = GlobalSymbolTable.lookup(Name);
 314     return getSectionLoadAddress(Loc.first) + Loc.second;
 315   }
 316
 317   void resolveRelocations();
 318
 319   void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
 320
 321   void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
 322
 323   // Is the linker in an error state?
 324   bool hasError() { return HasError; }
 325
 326   // Mark the error condition as handled and continue.
 327   void clearError() { HasError = false; }
 328
 329   // Get the error message.
 330   StringRef getErrorString() { return ErrorStr; }
 331
 332   virtual bool isCompatibleFormat(const ObjectBuffer *Buffer) const = 0;
 333 };
 334
 335 } // end namespace llvm
 336
 337
 338 #endif