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