1 //===-- RuntimeDyld.h - Run-time dynamic linker for MC-JIT ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Interface for the runtime dynamic linker facilities of the MC-JIT.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_EXECUTIONENGINE_RUNTIMEDYLD_H
15 #define LLVM_EXECUTIONENGINE_RUNTIMEDYLD_H
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/ExecutionEngine/ObjectBuffer.h"
19 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
20 #include "llvm/Support/Memory.h"
28 class RuntimeDyldImpl;
29 class RuntimeDyldCheckerImpl;
33 friend class RuntimeDyldCheckerImpl;
35 RuntimeDyld(const RuntimeDyld &) LLVM_DELETED_FUNCTION;
36 void operator=(const RuntimeDyld &) LLVM_DELETED_FUNCTION;
38 // RuntimeDyldImpl is the actual class. RuntimeDyld is just the public
40 RuntimeDyldImpl *Dyld;
41 RTDyldMemoryManager *MM;
42 bool ProcessAllSections;
43 RuntimeDyldCheckerImpl *Checker;
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);
49 RuntimeDyld(RTDyldMemoryManager *);
52 /// Prepare the object contained in the input buffer for execution.
53 /// Ownership of the input buffer is transferred to the ObjectImage
54 /// instance returned from this function if successful. In the case of load
55 /// failure, the input buffer will be deleted.
56 ObjectImage *loadObject(ObjectBuffer *InputBuffer);
58 /// Prepare the referenced object file for execution.
59 /// Ownership of the input object is transferred to the ObjectImage
60 /// instance returned from this function if successful. In the case of load
61 /// failure, the input object will be deleted.
62 ObjectImage *loadObject(std::unique_ptr<object::ObjectFile> InputObject);
64 /// Get the address of our local copy of the symbol. This may or may not
65 /// be the address used for relocation (clients can copy the data around
66 /// and resolve relocatons based on where they put it).
67 void *getSymbolAddress(StringRef Name);
69 /// Get the address of the target copy of the symbol. This is the address
70 /// used for relocation.
71 uint64_t getSymbolLoadAddress(StringRef Name);
73 /// Resolve the relocations for all symbols we currently know about.
74 void resolveRelocations();
76 /// Map a section to its target address space value.
77 /// Map the address of a JIT section as returned from the memory manager
78 /// to the address in the target process as the running code will see it.
79 /// This is the address which will be used for relocation resolution.
80 void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
82 /// Register any EH frame sections that have been loaded but not previously
83 /// registered with the memory manager. Note, RuntimeDyld is responsible
84 /// for identifying the EH frame and calling the memory manager with the
85 /// EH frame section data. However, the memory manager itself will handle
86 /// the actual target-specific EH frame registration.
87 void registerEHFrames();
89 void deregisterEHFrames();
92 StringRef getErrorString();
94 /// By default, only sections that are "required for execution" are passed to
95 /// the RTDyldMemoryManager, and other sections are discarded. Passing 'true'
96 /// to this method will cause RuntimeDyld to pass all sections to its
97 /// memory manager regardless of whether they are "required to execute" in the
98 /// usual sense. This is useful for inspecting metadata sections that may not
99 /// contain relocations, E.g. Debug info, stackmaps.
101 /// Must be called before the first object file is loaded.
102 void setProcessAllSections(bool ProcessAllSections) {
103 assert(!Dyld && "setProcessAllSections must be called before loadObject.");
104 this->ProcessAllSections = ProcessAllSections;
108 } // end namespace llvm