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/ADT/ArrayRef.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ExecutionEngine/ExecutionEngine.h"
21 #include "llvm/ExecutionEngine/GenericValue.h"
22 #include "llvm/ExecutionEngine/JITSymbol.h"
23 #include "llvm/ExecutionEngine/RuntimeDyld.h"
24 #include "llvm/ExecutionEngine/Orc/CompileUtils.h"
25 #include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
26 #include "llvm/ExecutionEngine/Orc/LazyEmittingLayer.h"
27 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/IR/Mangler.h"
30 #include "llvm/Object/Archive.h"
31 #include "llvm/Object/Binary.h"
32 #include "llvm/Object/ObjectFile.h"
33 #include "llvm/Support/Error.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/raw_ostream.h"
36 #include "llvm/Target/TargetMachine.h"
50 class OrcMCJITReplacement : public ExecutionEngine {
51 // OrcMCJITReplacement needs to do a little extra book-keeping to ensure that
52 // Orc's automatic finalization doesn't kick in earlier than MCJIT clients are
53 // expecting - see finalizeMemory.
54 class MCJITReplacementMemMgr : public MCJITMemoryManager {
56 MCJITReplacementMemMgr(OrcMCJITReplacement &M,
57 std::shared_ptr<MCJITMemoryManager> ClientMM)
58 : M(M), ClientMM(std::move(ClientMM)) {}
60 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
62 StringRef SectionName) override {
64 ClientMM->allocateCodeSection(Size, Alignment, SectionID,
66 M.SectionsAllocatedSinceLastLoad.insert(Addr);
70 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
71 unsigned SectionID, StringRef SectionName,
72 bool IsReadOnly) override {
73 uint8_t *Addr = ClientMM->allocateDataSection(Size, Alignment, SectionID,
74 SectionName, IsReadOnly);
75 M.SectionsAllocatedSinceLastLoad.insert(Addr);
79 void reserveAllocationSpace(uintptr_t CodeSize, uint32_t CodeAlign,
80 uintptr_t RODataSize, uint32_t RODataAlign,
82 uint32_t RWDataAlign) override {
83 return ClientMM->reserveAllocationSpace(CodeSize, CodeAlign,
84 RODataSize, RODataAlign,
85 RWDataSize, RWDataAlign);
88 bool needsToReserveAllocationSpace() override {
89 return ClientMM->needsToReserveAllocationSpace();
92 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
93 size_t Size) override {
94 return ClientMM->registerEHFrames(Addr, LoadAddr, Size);
97 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
98 size_t Size) override {
99 return ClientMM->deregisterEHFrames(Addr, LoadAddr, Size);
102 void notifyObjectLoaded(RuntimeDyld &RTDyld,
103 const object::ObjectFile &O) override {
104 return ClientMM->notifyObjectLoaded(RTDyld, O);
107 void notifyObjectLoaded(ExecutionEngine *EE,
108 const object::ObjectFile &O) override {
109 return ClientMM->notifyObjectLoaded(EE, O);
112 bool finalizeMemory(std::string *ErrMsg = nullptr) override {
113 // Each set of objects loaded will be finalized exactly once, but since
114 // symbol lookup during relocation may recursively trigger the
115 // loading/relocation of other modules, and since we're forwarding all
116 // finalizeMemory calls to a single underlying memory manager, we need to
117 // defer forwarding the call on until all necessary objects have been
118 // loaded. Otherwise, during the relocation of a leaf object, we will end
119 // up finalizing memory, causing a crash further up the stack when we
120 // attempt to apply relocations to finalized memory.
121 // To avoid finalizing too early, look at how many objects have been
122 // loaded but not yet finalized. This is a bit of a hack that relies on
123 // the fact that we're lazily emitting object files: The only way you can
124 // get more than one set of objects loaded but not yet finalized is if
125 // they were loaded during relocation of another set.
126 if (M.UnfinalizedSections.size() == 1)
127 return ClientMM->finalizeMemory(ErrMsg);
132 OrcMCJITReplacement &M;
133 std::shared_ptr<MCJITMemoryManager> ClientMM;
136 class LinkingResolver : public JITSymbolResolver {
138 LinkingResolver(OrcMCJITReplacement &M) : M(M) {}
140 JITSymbol findSymbol(const std::string &Name) override {
141 return M.ClientResolver->findSymbol(Name);
144 JITSymbol findSymbolInLogicalDylib(const std::string &Name) override {
145 if (auto Sym = M.findMangledSymbol(Name))
147 return M.ClientResolver->findSymbolInLogicalDylib(Name);
151 OrcMCJITReplacement &M;
156 static ExecutionEngine *
157 createOrcMCJITReplacement(std::string *ErrorMsg,
158 std::shared_ptr<MCJITMemoryManager> MemMgr,
159 std::shared_ptr<JITSymbolResolver> Resolver,
160 std::unique_ptr<TargetMachine> TM) {
161 return new OrcMCJITReplacement(std::move(MemMgr), std::move(Resolver),
166 static void Register() {
167 OrcMCJITReplacementCtor = createOrcMCJITReplacement;
171 std::shared_ptr<MCJITMemoryManager> MemMgr,
172 std::shared_ptr<JITSymbolResolver> ClientResolver,
173 std::unique_ptr<TargetMachine> TM)
174 : ExecutionEngine(TM->createDataLayout()), TM(std::move(TM)),
175 MemMgr(*this, std::move(MemMgr)), Resolver(*this),
176 ClientResolver(std::move(ClientResolver)), NotifyObjectLoaded(*this),
177 NotifyFinalized(*this),
178 ObjectLayer(NotifyObjectLoaded, NotifyFinalized),
179 CompileLayer(ObjectLayer, SimpleCompiler(*this->TM)),
180 LazyEmitLayer(CompileLayer) {}
182 void addModule(std::unique_ptr<Module> M) override {
184 // If this module doesn't have a DataLayout attached then attach the
186 if (M->getDataLayout().isDefault()) {
187 M->setDataLayout(getDataLayout());
189 assert(M->getDataLayout() == getDataLayout() && "DataLayout Mismatch");
191 Modules.push_back(std::move(M));
192 std::vector<Module *> Ms;
193 Ms.push_back(&*Modules.back());
194 LazyEmitLayer.addModuleSet(std::move(Ms), &MemMgr, &Resolver);
197 void addObjectFile(std::unique_ptr<object::ObjectFile> O) override {
198 std::vector<std::unique_ptr<object::ObjectFile>> Objs;
199 Objs.push_back(std::move(O));
200 ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
203 void addObjectFile(object::OwningBinary<object::ObjectFile> O) override {
204 std::vector<std::unique_ptr<object::OwningBinary<object::ObjectFile>>> Objs;
206 llvm::make_unique<object::OwningBinary<object::ObjectFile>>(
208 ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
211 void addArchive(object::OwningBinary<object::Archive> A) override {
212 Archives.push_back(std::move(A));
215 uint64_t getSymbolAddress(StringRef Name) {
216 return findSymbol(Name).getAddress();
219 JITSymbol findSymbol(StringRef Name) {
220 return findMangledSymbol(Mangle(Name));
223 void finalizeObject() override {
224 // This is deprecated - Aim to remove in ExecutionEngine.
225 // REMOVE IF POSSIBLE - Doesn't make sense for New JIT.
228 void mapSectionAddress(const void *LocalAddress,
229 uint64_t TargetAddress) override {
230 for (auto &P : UnfinalizedSections)
231 if (P.second.count(LocalAddress))
232 ObjectLayer.mapSectionAddress(P.first, LocalAddress, TargetAddress);
235 uint64_t getGlobalValueAddress(const std::string &Name) override {
236 return getSymbolAddress(Name);
239 uint64_t getFunctionAddress(const std::string &Name) override {
240 return getSymbolAddress(Name);
243 void *getPointerToFunction(Function *F) override {
244 uint64_t FAddr = getSymbolAddress(F->getName());
245 return reinterpret_cast<void *>(static_cast<uintptr_t>(FAddr));
248 void *getPointerToNamedFunction(StringRef Name,
249 bool AbortOnFailure = true) override {
250 uint64_t Addr = getSymbolAddress(Name);
251 if (!Addr && AbortOnFailure)
252 llvm_unreachable("Missing symbol!");
253 return reinterpret_cast<void *>(static_cast<uintptr_t>(Addr));
256 GenericValue runFunction(Function *F,
257 ArrayRef<GenericValue> ArgValues) override;
259 void setObjectCache(ObjectCache *NewCache) override {
260 CompileLayer.setObjectCache(NewCache);
263 void setProcessAllSections(bool ProcessAllSections) override {
264 ObjectLayer.setProcessAllSections(ProcessAllSections);
268 JITSymbol findMangledSymbol(StringRef Name) {
269 if (auto Sym = LazyEmitLayer.findSymbol(Name, false))
271 if (auto Sym = ClientResolver->findSymbol(Name))
273 if (auto Sym = scanArchives(Name))
279 JITSymbol scanArchives(StringRef Name) {
280 for (object::OwningBinary<object::Archive> &OB : Archives) {
281 object::Archive *A = OB.getBinary();
282 // Look for our symbols in each Archive
283 auto OptionalChildOrErr = A->findSym(Name);
284 if (!OptionalChildOrErr)
285 report_fatal_error(OptionalChildOrErr.takeError());
286 auto &OptionalChild = *OptionalChildOrErr;
288 // FIXME: Support nested archives?
289 Expected<std::unique_ptr<object::Binary>> ChildBinOrErr =
290 OptionalChild->getAsBinary();
291 if (!ChildBinOrErr) {
292 // TODO: Actually report errors helpfully.
293 consumeError(ChildBinOrErr.takeError());
296 std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
297 if (ChildBin->isObject()) {
298 std::vector<std::unique_ptr<object::ObjectFile>> ObjSet;
299 ObjSet.push_back(std::unique_ptr<object::ObjectFile>(
300 static_cast<object::ObjectFile *>(ChildBin.release())));
301 ObjectLayer.addObjectSet(std::move(ObjSet), &MemMgr, &Resolver);
302 if (auto Sym = ObjectLayer.findSymbol(Name, true))
310 class NotifyObjectLoadedT {
312 typedef std::vector<std::unique_ptr<RuntimeDyld::LoadedObjectInfo>>
315 NotifyObjectLoadedT(OrcMCJITReplacement &M) : M(M) {}
317 template <typename ObjListT>
318 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H,
319 const ObjListT &Objects,
320 const LoadedObjInfoListT &Infos) const {
321 M.UnfinalizedSections[H] = std::move(M.SectionsAllocatedSinceLastLoad);
322 M.SectionsAllocatedSinceLastLoad = SectionAddrSet();
323 assert(Objects.size() == Infos.size() &&
324 "Incorrect number of Infos for Objects.");
325 for (unsigned I = 0; I < Objects.size(); ++I)
326 M.MemMgr.notifyObjectLoaded(&M, getObject(*Objects[I]));
330 static const object::ObjectFile& getObject(const object::ObjectFile &Obj) {
334 template <typename ObjT>
335 static const object::ObjectFile&
336 getObject(const object::OwningBinary<ObjT> &Obj) {
337 return *Obj.getBinary();
340 OrcMCJITReplacement &M;
343 class NotifyFinalizedT {
345 NotifyFinalizedT(OrcMCJITReplacement &M) : M(M) {}
347 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H) {
348 M.UnfinalizedSections.erase(H);
352 OrcMCJITReplacement &M;
355 std::string Mangle(StringRef Name) {
356 std::string MangledName;
358 raw_string_ostream MangledNameStream(MangledName);
359 Mang.getNameWithPrefix(MangledNameStream, Name, getDataLayout());
364 typedef ObjectLinkingLayer<NotifyObjectLoadedT> ObjectLayerT;
365 typedef IRCompileLayer<ObjectLayerT> CompileLayerT;
366 typedef LazyEmittingLayer<CompileLayerT> LazyEmitLayerT;
368 std::unique_ptr<TargetMachine> TM;
369 MCJITReplacementMemMgr MemMgr;
370 LinkingResolver Resolver;
371 std::shared_ptr<JITSymbolResolver> ClientResolver;
374 NotifyObjectLoadedT NotifyObjectLoaded;
375 NotifyFinalizedT NotifyFinalized;
377 ObjectLayerT ObjectLayer;
378 CompileLayerT CompileLayer;
379 LazyEmitLayerT LazyEmitLayer;
381 // We need to store ObjLayerT::ObjSetHandles for each of the object sets
382 // that have been emitted but not yet finalized so that we can forward the
383 // mapSectionAddress calls appropriately.
384 typedef std::set<const void *> SectionAddrSet;
385 struct ObjSetHandleCompare {
386 bool operator()(ObjectLayerT::ObjSetHandleT H1,
387 ObjectLayerT::ObjSetHandleT H2) const {
391 SectionAddrSet SectionsAllocatedSinceLastLoad;
392 std::map<ObjectLayerT::ObjSetHandleT, SectionAddrSet, ObjSetHandleCompare>
395 std::vector<object::OwningBinary<object::Archive>> Archives;
398 } // end namespace orc
399 } // end namespace llvm
401 #endif // LLVM_LIB_EXECUTIONENGINE_ORC_MCJITREPLACEMENT_H