include/llvm/ExecutionEngine/RuntimeDyld.h

   1 //===-- RuntimeDyld.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 runtime dynamic linker facilities of the MC-JIT.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_EXECUTIONENGINE_RUNTIMEDYLD_H
  15 #define LLVM_EXECUTIONENGINE_RUNTIMEDYLD_H
  16
  17 #include "JITSymbolFlags.h"
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/Support/Memory.h"
  20 #include "llvm/DebugInfo/DIContext.h"
  21 #include <memory>
  22
  23 namespace llvm {
  24
  25 namespace object {
  26   class ObjectFile;
  27   template <typename T> class OwningBinary;
  28 }
  29
  30 class RuntimeDyldImpl;
  31 class RuntimeDyldCheckerImpl;
  32
  33 class RuntimeDyld {
  34   friend class RuntimeDyldCheckerImpl;
  35
  36   RuntimeDyld(const RuntimeDyld &) = delete;
  37   void operator=(const RuntimeDyld &) = delete;
  38
  39 protected:
  40   // Change the address associated with a section when resolving relocations.
  41   // Any relocations already associated with the symbol will be re-resolved.
  42   void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
  43 public:
  44
  45   /// \brief Information about a named symbol.
  46   class SymbolInfo : public JITSymbolBase {
  47   public:
  48     SymbolInfo(std::nullptr_t) : JITSymbolBase(JITSymbolFlags::None), Address(0) {}
  49     SymbolInfo(uint64_t Address, JITSymbolFlags Flags)
  50       : JITSymbolBase(Flags), Address(Address) {}
  51     explicit operator bool() const { return Address != 0; }
  52     uint64_t getAddress() const { return Address; }
  53   private:
  54     uint64_t Address;
  55   };
  56
  57   /// \brief Information about the loaded object.
  58   class LoadedObjectInfo : public llvm::LoadedObjectInfo {
  59     friend class RuntimeDyldImpl;
  60   public:
  61     LoadedObjectInfo(RuntimeDyldImpl &RTDyld, unsigned BeginIdx,
  62                      unsigned EndIdx)
  63       : RTDyld(RTDyld), BeginIdx(BeginIdx), EndIdx(EndIdx) { }
  64
  65     virtual object::OwningBinary<object::ObjectFile>
  66     getObjectForDebug(const object::ObjectFile &Obj) const = 0;
  67
  68     uint64_t getSectionLoadAddress(StringRef Name) const;
  69
  70   protected:
  71     virtual void anchor();
  72
  73     RuntimeDyldImpl &RTDyld;
  74     unsigned BeginIdx, EndIdx;
  75   };
  76
  77   template <typename Derived> struct LoadedObjectInfoHelper : LoadedObjectInfo {
  78     LoadedObjectInfoHelper(RuntimeDyldImpl &RTDyld, unsigned BeginIdx,
  79                            unsigned EndIdx)
  80         : LoadedObjectInfo(RTDyld, BeginIdx, EndIdx) {}
  81     llvm::LoadedObjectInfo *clone() const override {
  82       return new Derived(static_cast<const Derived &>(*this));
  83     }
  84   };
  85
  86   /// \brief Memory Management.
  87   class MemoryManager {
  88   public:
  89     virtual ~MemoryManager() {};
  90
  91     /// Allocate a memory block of (at least) the given size suitable for
  92     /// executable code. The SectionID is a unique identifier assigned by the
  93     /// RuntimeDyld instance, and optionally recorded by the memory manager to
  94     /// access a loaded section.
  95     virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
  96                                          unsigned SectionID,
  97                                          StringRef SectionName) = 0;
  98
  99     /// Allocate a memory block of (at least) the given size suitable for data.
 100     /// The SectionID is a unique identifier assigned by the JIT engine, and
 101     /// optionally recorded by the memory manager to access a loaded section.
 102     virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
 103                                          unsigned SectionID,
 104                                          StringRef SectionName,
 105                                          bool IsReadOnly) = 0;
 106
 107     /// Inform the memory manager about the total amount of memory required to
 108     /// allocate all sections to be loaded:
 109     /// \p CodeSize - the total size of all code sections
 110     /// \p DataSizeRO - the total size of all read-only data sections
 111     /// \p DataSizeRW - the total size of all read-write data sections
 112     ///
 113     /// Note that by default the callback is disabled. To enable it
 114     /// redefine the method needsToReserveAllocationSpace to return true.
 115     virtual void reserveAllocationSpace(uintptr_t CodeSize,
 116                                         uintptr_t DataSizeRO,
 117                                         uintptr_t DataSizeRW) {}
 118
 119     /// Override to return true to enable the reserveAllocationSpace callback.
 120     virtual bool needsToReserveAllocationSpace() { return false; }
 121
 122     /// Register the EH frames with the runtime so that c++ exceptions work.
 123     ///
 124     /// \p Addr parameter provides the local address of the EH frame section
 125     /// data, while \p LoadAddr provides the address of the data in the target
 126     /// address space.  If the section has not been remapped (which will usually
 127     /// be the case for local execution) these two values will be the same.
 128     virtual void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
 129                                   size_t Size) = 0;
 130     virtual void deregisterEHFrames(uint8_t *addr, uint64_t LoadAddr,
 131                                     size_t Size) = 0;
 132
 133     /// This method is called when object loading is complete and section page
 134     /// permissions can be applied.  It is up to the memory manager implementation
 135     /// to decide whether or not to act on this method.  The memory manager will
 136     /// typically allocate all sections as read-write and then apply specific
 137     /// permissions when this method is called.  Code sections cannot be executed
 138     /// until this function has been called.  In addition, any cache coherency
 139     /// operations needed to reliably use the memory are also performed.
 140     ///
 141     /// Returns true if an error occurred, false otherwise.
 142     virtual bool finalizeMemory(std::string *ErrMsg = nullptr) = 0;
 143
 144   private:
 145     virtual void anchor();
 146   };
 147
 148   /// \brief Symbol resolution.
 149   class SymbolResolver {
 150   public:
 151     virtual ~SymbolResolver() {};
 152
 153     /// This method returns the address of the specified function or variable.
 154     /// It is used to resolve symbols during module linking.
 155     virtual SymbolInfo findSymbol(const std::string &Name) = 0;
 156
 157     /// This method returns the address of the specified symbol if it exists
 158     /// within the logical dynamic library represented by this
 159     /// RTDyldMemoryManager. Unlike getSymbolAddress, queries through this
 160     /// interface should return addresses for hidden symbols.
 161     ///
 162     /// This is of particular importance for the Orc JIT APIs, which support lazy
 163     /// compilation by breaking up modules: Each of those broken out modules
 164     /// must be able to resolve hidden symbols provided by the others. Clients
 165     /// writing memory managers for MCJIT can usually ignore this method.
 166     ///
 167     /// This method will be queried by RuntimeDyld when checking for previous
 168     /// definitions of common symbols. It will *not* be queried by default when
 169     /// resolving external symbols (this minimises the link-time overhead for
 170     /// MCJIT clients who don't care about Orc features). If you are writing a
 171     /// RTDyldMemoryManager for Orc and want "external" symbol resolution to
 172     /// search the logical dylib, you should override your getSymbolAddress
 173     /// method call this method directly.
 174     virtual SymbolInfo findSymbolInLogicalDylib(const std::string &Name) = 0;
 175   private:
 176     virtual void anchor();
 177   };
 178
 179   /// \brief Construct a RuntimeDyld instance.
 180   RuntimeDyld(MemoryManager &MemMgr, SymbolResolver &Resolver);
 181   ~RuntimeDyld();
 182
 183   /// Add the referenced object file to the list of objects to be loaded and
 184   /// relocated.
 185   std::unique_ptr<LoadedObjectInfo> loadObject(const object::ObjectFile &O);
 186
 187   /// Get the address of our local copy of the symbol. This may or may not
 188   /// be the address used for relocation (clients can copy the data around
 189   /// and resolve relocatons based on where they put it).
 190   void *getSymbolLocalAddress(StringRef Name) const;
 191
 192   /// Get the target address and flags for the named symbol.
 193   /// This address is the one used for relocation.
 194   SymbolInfo getSymbol(StringRef Name) const;
 195
 196   /// Resolve the relocations for all symbols we currently know about.
 197   void resolveRelocations();
 198
 199   /// Map a section to its target address space value.
 200   /// Map the address of a JIT section as returned from the memory manager
 201   /// to the address in the target process as the running code will see it.
 202   /// This is the address which will be used for relocation resolution.
 203   void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
 204
 205   /// Register any EH frame sections that have been loaded but not previously
 206   /// registered with the memory manager.  Note, RuntimeDyld is responsible
 207   /// for identifying the EH frame and calling the memory manager with the
 208   /// EH frame section data.  However, the memory manager itself will handle
 209   /// the actual target-specific EH frame registration.
 210   void registerEHFrames();
 211
 212   void deregisterEHFrames();
 213
 214   bool hasError();
 215   StringRef getErrorString();
 216
 217   /// By default, only sections that are "required for execution" are passed to
 218   /// the RTDyldMemoryManager, and other sections are discarded. Passing 'true'
 219   /// to this method will cause RuntimeDyld to pass all sections to its
 220   /// memory manager regardless of whether they are "required to execute" in the
 221   /// usual sense. This is useful for inspecting metadata sections that may not
 222   /// contain relocations, E.g. Debug info, stackmaps.
 223   ///
 224   /// Must be called before the first object file is loaded.
 225   void setProcessAllSections(bool ProcessAllSections) {
 226     assert(!Dyld && "setProcessAllSections must be called before loadObject.");
 227     this->ProcessAllSections = ProcessAllSections;
 228   }
 229
 230 private:
 231   // RuntimeDyldImpl is the actual class. RuntimeDyld is just the public
 232   // interface.
 233   std::unique_ptr<RuntimeDyldImpl> Dyld;
 234   MemoryManager &MemMgr;
 235   SymbolResolver &Resolver;
 236   bool ProcessAllSections;
 237   RuntimeDyldCheckerImpl *Checker;
 238 };
 239
 240 } // end namespace llvm
 241
 242 #endif