1 //===---- OrcMCJITReplacement.h - Orc based MCJIT replacement ---*- 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 // Orc based MCJIT replacement.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_EXECUTIONENGINE_ORC_ORCMCJITREPLACEMENT_H
15 #define LLVM_LIB_EXECUTIONENGINE_ORC_ORCMCJITREPLACEMENT_H
17 #include "llvm/ExecutionEngine/ExecutionEngine.h"
18 #include "llvm/ExecutionEngine/Orc/CompileUtils.h"
19 #include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
20 #include "llvm/ExecutionEngine/Orc/LazyEmittingLayer.h"
21 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
22 #include "llvm/Object/Archive.h"
26 class OrcMCJITReplacement : public ExecutionEngine {
28 class ForwardingRTDyldMM : public RTDyldMemoryManager {
30 ForwardingRTDyldMM(OrcMCJITReplacement &M) : M(M) {}
32 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
34 StringRef SectionName) override {
36 M.MM->allocateCodeSection(Size, Alignment, SectionID, SectionName);
37 M.SectionsAllocatedSinceLastLoad.insert(Addr);
41 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
42 unsigned SectionID, StringRef SectionName,
43 bool IsReadOnly) override {
44 uint8_t *Addr = M.MM->allocateDataSection(Size, Alignment, SectionID,
45 SectionName, IsReadOnly);
46 M.SectionsAllocatedSinceLastLoad.insert(Addr);
50 void reserveAllocationSpace(uintptr_t CodeSize, uintptr_t DataSizeRO,
51 uintptr_t DataSizeRW) override {
52 return M.MM->reserveAllocationSpace(CodeSize, DataSizeRO, DataSizeRW);
55 bool needsToReserveAllocationSpace() override {
56 return M.MM->needsToReserveAllocationSpace();
59 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
60 size_t Size) override {
61 return M.MM->registerEHFrames(Addr, LoadAddr, Size);
64 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
65 size_t Size) override {
66 return M.MM->deregisterEHFrames(Addr, LoadAddr, Size);
69 uint64_t getSymbolAddress(const std::string &Name) override {
70 return M.getSymbolAddressWithoutMangling(Name);
73 void *getPointerToNamedFunction(const std::string &Name,
74 bool AbortOnFailure = true) override {
75 return M.MM->getPointerToNamedFunction(Name, AbortOnFailure);
78 void notifyObjectLoaded(ExecutionEngine *EE,
79 const object::ObjectFile &O) override {
80 return M.MM->notifyObjectLoaded(EE, O);
83 bool finalizeMemory(std::string *ErrMsg = nullptr) override {
84 // Each set of objects loaded will be finalized exactly once, but since
85 // symbol lookup during relocation may recursively trigger the
86 // loading/relocation of other modules, and since we're forwarding all
87 // finalizeMemory calls to a single underlying memory manager, we need to
88 // defer forwarding the call on until all necessary objects have been
89 // loaded. Otherwise, during the relocation of a leaf object, we will end
90 // up finalizing memory, causing a crash further up the stack when we
91 // attempt to apply relocations to finalized memory.
92 // To avoid finalizing too early, look at how many objects have been
93 // loaded but not yet finalized. This is a bit of a hack that relies on
94 // the fact that we're lazily emitting object files: The only way you can
95 // get more than one set of objects loaded but not yet finalized is if
96 // they were loaded during relocation of another set.
97 if (M.UnfinalizedSections.size() == 1)
98 return M.MM->finalizeMemory(ErrMsg);
103 OrcMCJITReplacement &M;
107 static ExecutionEngine *
108 createOrcMCJITReplacement(std::string *ErrorMsg,
109 std::unique_ptr<RTDyldMemoryManager> OrcJMM,
110 std::unique_ptr<llvm::TargetMachine> TM) {
111 return new llvm::OrcMCJITReplacement(std::move(OrcJMM), std::move(TM));
115 static void Register() {
116 OrcMCJITReplacementCtor = createOrcMCJITReplacement;
119 OrcMCJITReplacement(std::unique_ptr<RTDyldMemoryManager> MM,
120 std::unique_ptr<TargetMachine> TM)
121 : TM(std::move(TM)), MM(std::move(MM)), Mang(this->TM->getDataLayout()),
122 NotifyObjectLoaded(*this), NotifyFinalized(*this),
123 ObjectLayer(ObjectLayerT::CreateRTDyldMMFtor(), NotifyObjectLoaded,
125 CompileLayer(ObjectLayer, SimpleCompiler(*this->TM)),
126 LazyEmitLayer(CompileLayer) {
127 setDataLayout(this->TM->getDataLayout());
130 void addModule(std::unique_ptr<Module> M) override {
132 // If this module doesn't have a DataLayout attached then attach the
134 if (!M->getDataLayout())
135 M->setDataLayout(getDataLayout());
137 Modules.push_back(std::move(M));
138 std::vector<Module *> Ms;
139 Ms.push_back(&*Modules.back());
140 LazyEmitLayer.addModuleSet(std::move(Ms),
141 llvm::make_unique<ForwardingRTDyldMM>(*this));
144 void addObjectFile(std::unique_ptr<object::ObjectFile> O) override {
145 std::vector<std::unique_ptr<object::ObjectFile>> Objs;
146 Objs.push_back(std::move(O));
147 ObjectLayer.addObjectSet(std::move(Objs),
148 llvm::make_unique<ForwardingRTDyldMM>(*this));
151 void addObjectFile(object::OwningBinary<object::ObjectFile> O) override {
152 std::unique_ptr<object::ObjectFile> Obj;
153 std::unique_ptr<MemoryBuffer> Buf;
154 std::tie(Obj, Buf) = O.takeBinary();
155 std::vector<std::unique_ptr<object::ObjectFile>> Objs;
156 Objs.push_back(std::move(Obj));
158 ObjectLayer.addObjectSet(std::move(Objs),
159 llvm::make_unique<ForwardingRTDyldMM>(*this));
161 std::vector<std::unique_ptr<MemoryBuffer>> Bufs;
162 Bufs.push_back(std::move(Buf));
163 ObjectLayer.takeOwnershipOfBuffers(H, std::move(Bufs));
166 void addArchive(object::OwningBinary<object::Archive> A) override {
167 Archives.push_back(std::move(A));
170 uint64_t getSymbolAddress(StringRef Name) {
171 return getSymbolAddressWithoutMangling(Mangle(Name));
174 void finalizeObject() override {
175 // This is deprecated - Aim to remove in ExecutionEngine.
176 // REMOVE IF POSSIBLE - Doesn't make sense for New JIT.
179 void mapSectionAddress(const void *LocalAddress,
180 uint64_t TargetAddress) override {
181 for (auto &P : UnfinalizedSections)
182 if (P.second.count(LocalAddress))
183 ObjectLayer.mapSectionAddress(P.first, LocalAddress, TargetAddress);
186 uint64_t getGlobalValueAddress(const std::string &Name) override {
187 return getSymbolAddress(Name);
190 uint64_t getFunctionAddress(const std::string &Name) override {
191 return getSymbolAddress(Name);
194 void *getPointerToFunction(Function *F) override {
195 uint64_t FAddr = getSymbolAddress(F->getName());
196 return reinterpret_cast<void *>(static_cast<uintptr_t>(FAddr));
199 void *getPointerToNamedFunction(StringRef Name,
200 bool AbortOnFailure = true) override {
201 uint64_t Addr = getSymbolAddress(Name);
202 if (!Addr && AbortOnFailure)
203 llvm_unreachable("Missing symbol!");
204 return reinterpret_cast<void *>(static_cast<uintptr_t>(Addr));
207 GenericValue runFunction(Function *F,
208 const std::vector<GenericValue> &ArgValues) override;
210 void setObjectCache(ObjectCache *NewCache) override {
211 CompileLayer.setObjectCache(NewCache);
215 uint64_t getSymbolAddressWithoutMangling(StringRef Name) {
216 if (uint64_t Addr = LazyEmitLayer.findSymbol(Name, false).getAddress())
218 if (uint64_t Addr = MM->getSymbolAddress(Name))
220 if (uint64_t Addr = scanArchives(Name))
226 uint64_t scanArchives(StringRef Name) {
227 for (object::OwningBinary<object::Archive> &OB : Archives) {
228 object::Archive *A = OB.getBinary();
229 // Look for our symbols in each Archive
230 object::Archive::child_iterator ChildIt = A->findSym(Name);
231 if (ChildIt != A->child_end()) {
232 // FIXME: Support nested archives?
233 ErrorOr<std::unique_ptr<object::Binary>> ChildBinOrErr =
234 ChildIt->getAsBinary();
235 if (ChildBinOrErr.getError())
237 std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
238 if (ChildBin->isObject()) {
239 std::vector<std::unique_ptr<object::ObjectFile>> ObjSet;
240 ObjSet.push_back(std::unique_ptr<object::ObjectFile>(
241 static_cast<object::ObjectFile *>(ChildBin.release())));
242 ObjectLayer.addObjectSet(
243 std::move(ObjSet), llvm::make_unique<ForwardingRTDyldMM>(*this));
244 if (uint64_t Addr = ObjectLayer.findSymbol(Name, true).getAddress())
252 class NotifyObjectLoadedT {
254 typedef std::vector<std::unique_ptr<object::ObjectFile>> ObjListT;
255 typedef std::vector<std::unique_ptr<RuntimeDyld::LoadedObjectInfo>>
258 NotifyObjectLoadedT(OrcMCJITReplacement &M) : M(M) {}
260 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H,
261 const ObjListT &Objects,
262 const LoadedObjInfoListT &Infos) const {
263 M.UnfinalizedSections[H] = std::move(M.SectionsAllocatedSinceLastLoad);
264 M.SectionsAllocatedSinceLastLoad = SectionAddrSet();
265 assert(Objects.size() == Infos.size() &&
266 "Incorrect number of Infos for Objects.");
267 for (unsigned I = 0; I < Objects.size(); ++I)
268 M.MM->notifyObjectLoaded(&M, *Objects[I]);
272 OrcMCJITReplacement &M;
275 class NotifyFinalizedT {
277 NotifyFinalizedT(OrcMCJITReplacement &M) : M(M) {}
278 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H) {
279 M.UnfinalizedSections.erase(H);
283 OrcMCJITReplacement &M;
286 std::string Mangle(StringRef Name) {
287 std::string MangledName;
289 raw_string_ostream MangledNameStream(MangledName);
290 Mang.getNameWithPrefix(MangledNameStream, Name);
295 typedef ObjectLinkingLayer<NotifyObjectLoadedT> ObjectLayerT;
296 typedef IRCompileLayer<ObjectLayerT> CompileLayerT;
297 typedef LazyEmittingLayer<CompileLayerT> LazyEmitLayerT;
299 std::unique_ptr<TargetMachine> TM;
300 std::unique_ptr<RTDyldMemoryManager> MM;
303 NotifyObjectLoadedT NotifyObjectLoaded;
304 NotifyFinalizedT NotifyFinalized;
306 ObjectLayerT ObjectLayer;
307 CompileLayerT CompileLayer;
308 LazyEmitLayerT LazyEmitLayer;
310 // We need to store ObjLayerT::ObjSetHandles for each of the object sets
311 // that have been emitted but not yet finalized so that we can forward the
312 // mapSectionAddress calls appropriately.
313 typedef std::set<const void *> SectionAddrSet;
314 struct ObjSetHandleCompare {
315 bool operator()(ObjectLayerT::ObjSetHandleT H1,
316 ObjectLayerT::ObjSetHandleT H2) const {
320 SectionAddrSet SectionsAllocatedSinceLastLoad;
321 std::map<ObjectLayerT::ObjSetHandleT, SectionAddrSet, ObjSetHandleCompare>
324 std::vector<object::OwningBinary<object::Archive>> Archives;
328 #endif // LLVM_LIB_EXECUTIONENGINE_ORC_MCJITREPLACEMENT_H