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/ObjectBuffer.h"
  19 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
  20 #include "llvm/Support/Memory.h"
  21
  22 namespace llvm {
  23
  24 namespace object {
  25   class ObjectFile;
  26 }
  27
  28 class RuntimeDyldImpl;
  29 class ObjectImage;
  30
  31 class RuntimeDyld {
  32   RuntimeDyld(const RuntimeDyld &) LLVM_DELETED_FUNCTION;
  33   void operator=(const RuntimeDyld &) LLVM_DELETED_FUNCTION;
  34
  35   // RuntimeDyldImpl is the actual class. RuntimeDyld is just the public
  36   // interface.
  37   RuntimeDyldImpl *Dyld;
  38   RTDyldMemoryManager *MM;
  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   RuntimeDyld(RTDyldMemoryManager *);
  45   ~RuntimeDyld();
  46
  47   /// Prepare the object contained in the input buffer for execution.
  48   /// Ownership of the input buffer is transferred to the ObjectImage
  49   /// instance returned from this function if successful. In the case of load
  50   /// failure, the input buffer will be deleted.
  51   ObjectImage *loadObject(ObjectBuffer *InputBuffer);
  52
  53   /// Prepare the referenced object file for execution.
  54   /// Ownership of the input object is transferred to the ObjectImage
  55   /// instance returned from this function if successful. In the case of load
  56   /// failure, the input object will be deleted.
  57   ObjectImage *loadObject(object::ObjectFile *InputObject);
  58
  59   /// Get the address of our local copy of the symbol. This may or may not
  60   /// be the address used for relocation (clients can copy the data around
  61   /// and resolve relocatons based on where they put it).
  62   void *getSymbolAddress(StringRef Name);
  63
  64   /// Get the address of the target copy of the symbol. This is the address
  65   /// used for relocation.
  66   uint64_t getSymbolLoadAddress(StringRef Name);
  67
  68   /// Resolve the relocations for all symbols we currently know about.
  69   void resolveRelocations();
  70
  71   /// Map a section to its target address space value.
  72   /// Map the address of a JIT section as returned from the memory manager
  73   /// to the address in the target process as the running code will see it.
  74   /// This is the address which will be used for relocation resolution.
  75   void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
  76
  77   /// Register any EH frame sections that have been loaded but not previously
  78   /// registered with the memory manager.  Note, RuntimeDyld is responsible
  79   /// for identifying the EH frame and calling the memory manager with the
  80   /// EH frame section data.  However, the memory manager itself will handle
  81   /// the actual target-specific EH frame registration.
  82   void registerEHFrames();
  83
  84   void deregisterEHFrames();
  85
  86   StringRef getErrorString();
  87 };
  88
  89 } // end namespace llvm
  90
  91 #endif