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 "llvm/ADT/StringRef.h"
  18 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
  19 #include "llvm/Support/Memory.h"
  20 #include <memory>
  21
  22 namespace llvm {
  23
  24 namespace object {
  25   class ObjectFile;
  26   template <typename T> class OwningBinary;
  27 }
  28
  29 class RuntimeDyldImpl;
  30 class RuntimeDyldCheckerImpl;
  31
  32 class RuntimeDyld {
  33   friend class RuntimeDyldCheckerImpl;
  34
  35   RuntimeDyld(const RuntimeDyld &) = delete;
  36   void operator=(const RuntimeDyld &) = delete;
  37
  38   // RuntimeDyldImpl is the actual class. RuntimeDyld is just the public
  39   // interface.
  40   std::unique_ptr<RuntimeDyldImpl> Dyld;
  41   RTDyldMemoryManager *MM;
  42   bool ProcessAllSections;
  43   RuntimeDyldCheckerImpl *Checker;
  44 protected:
  45   // Change the address associated with a section when resolving relocations.
  46   // Any relocations already associated with the symbol will be re-resolved.
  47   void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
  48 public:
  49
  50   /// \brief Information about the loaded object.
  51   class LoadedObjectInfo {
  52     friend class RuntimeDyldImpl;
  53   public:
  54     LoadedObjectInfo(RuntimeDyldImpl &RTDyld, unsigned BeginIdx,
  55                      unsigned EndIdx)
  56       : RTDyld(RTDyld), BeginIdx(BeginIdx), EndIdx(EndIdx) { }
  57
  58     virtual ~LoadedObjectInfo() {}
  59
  60     virtual object::OwningBinary<object::ObjectFile>
  61     getObjectForDebug(const object::ObjectFile &Obj) const = 0;
  62
  63     uint64_t getSectionLoadAddress(StringRef Name) const;
  64
  65   protected:
  66     virtual void anchor();
  67
  68     RuntimeDyldImpl &RTDyld;
  69     unsigned BeginIdx, EndIdx;
  70   };
  71
  72   RuntimeDyld(RTDyldMemoryManager *);
  73   ~RuntimeDyld();
  74
  75   /// Add the referenced object file to the list of objects to be loaded and
  76   /// relocated.
  77   std::unique_ptr<LoadedObjectInfo> loadObject(const object::ObjectFile &O);
  78
  79   /// Get the address of our local copy of the symbol. This may or may not
  80   /// be the address used for relocation (clients can copy the data around
  81   /// and resolve relocatons based on where they put it).
  82   void *getSymbolAddress(StringRef Name) const;
  83
  84   /// Get the address of the target copy of the symbol (works for both exported
  85   /// and non-exported symbols). This is the address used for relocation.
  86   uint64_t getSymbolLoadAddress(StringRef Name) const;
  87
  88   /// Get the address of the target copy of the symbol (works for exported
  89   /// symbols only). This is the address used for relocation.
  90   uint64_t getExportedSymbolLoadAddress(StringRef Name) const;
  91
  92   /// Resolve the relocations for all symbols we currently know about.
  93   void resolveRelocations();
  94
  95   /// Map a section to its target address space value.
  96   /// Map the address of a JIT section as returned from the memory manager
  97   /// to the address in the target process as the running code will see it.
  98   /// This is the address which will be used for relocation resolution.
  99   void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
 100
 101   /// Register any EH frame sections that have been loaded but not previously
 102   /// registered with the memory manager.  Note, RuntimeDyld is responsible
 103   /// for identifying the EH frame and calling the memory manager with the
 104   /// EH frame section data.  However, the memory manager itself will handle
 105   /// the actual target-specific EH frame registration.
 106   void registerEHFrames();
 107
 108   void deregisterEHFrames();
 109
 110   bool hasError();
 111   StringRef getErrorString();
 112
 113   /// By default, only sections that are "required for execution" are passed to
 114   /// the RTDyldMemoryManager, and other sections are discarded. Passing 'true'
 115   /// to this method will cause RuntimeDyld to pass all sections to its
 116   /// memory manager regardless of whether they are "required to execute" in the
 117   /// usual sense. This is useful for inspecting metadata sections that may not
 118   /// contain relocations, E.g. Debug info, stackmaps.
 119   ///
 120   /// Must be called before the first object file is loaded.
 121   void setProcessAllSections(bool ProcessAllSections) {
 122     assert(!Dyld && "setProcessAllSections must be called before loadObject.");
 123     this->ProcessAllSections = ProcessAllSections;
 124   }
 125 };
 126
 127 } // end namespace llvm
 128
 129 #endif