1 //===--- OrcLazyJIT.h - Basic Orc-based JIT for lazy execution --*- 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 // Simple Orc-based JIT. Uses the compile-on-demand layer to break up and
11 // lazily compile modules.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_TOOLS_LLI_ORCLAZYJIT_H
16 #define LLVM_TOOLS_LLI_ORCLAZYJIT_H
18 #include "llvm/ADT/Triple.h"
19 #include "llvm/ExecutionEngine/Orc/CompileOnDemandLayer.h"
20 #include "llvm/ExecutionEngine/Orc/CompileUtils.h"
21 #include "llvm/ExecutionEngine/Orc/ExecutionUtils.h"
22 #include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
23 #include "llvm/ExecutionEngine/Orc/IRTransformLayer.h"
24 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
25 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
26 #include "llvm/IR/LLVMContext.h"
33 typedef orc::JITCompileCallbackManagerBase CompileCallbackMgr;
34 typedef orc::ObjectLinkingLayer<> ObjLayerT;
35 typedef orc::IRCompileLayer<ObjLayerT> CompileLayerT;
36 typedef std::function<std::unique_ptr<Module>(std::unique_ptr<Module>)>
38 typedef orc::IRTransformLayer<CompileLayerT, TransformFtor> IRDumpLayerT;
39 typedef orc::CompileOnDemandLayer<IRDumpLayerT, CompileCallbackMgr> CODLayerT;
40 typedef CODLayerT::IndirectStubsManagerBuilderT
41 IndirectStubsManagerBuilder;
42 typedef CODLayerT::ModuleSetHandleT ModuleHandleT;
44 typedef std::function<
45 std::unique_ptr<CompileCallbackMgr>(IRDumpLayerT&,
46 RuntimeDyld::MemoryManager&,
48 CallbackManagerBuilder;
50 OrcLazyJIT(std::unique_ptr<TargetMachine> TM, LLVMContext &Context,
51 CallbackManagerBuilder &BuildCallbackMgr,
52 IndirectStubsManagerBuilder IndirectStubsMgrBuilder,
54 : TM(std::move(TM)), DL(this->TM->createDataLayout()), ObjectLayer(),
55 CompileLayer(ObjectLayer, orc::SimpleCompiler(*this->TM)),
56 IRDumpLayer(CompileLayer, createDebugDumper()),
57 CCMgr(BuildCallbackMgr(IRDumpLayer, CCMgrMemMgr, Context)),
58 CODLayer(IRDumpLayer, extractSingleFunction, *CCMgr,
59 std::move(IndirectStubsMgrBuilder), InlineStubs),
61 [this](const std::string &S) { return mangle(S); }) {}
64 // Run any destructors registered with __cxa_atexit.
65 CXXRuntimeOverrides.runDestructors();
66 // Run any IR destructors.
67 for (auto &DtorRunner : IRStaticDestructorRunners)
68 DtorRunner.runViaLayer(CODLayer);
71 static CallbackManagerBuilder createCallbackMgrBuilder(Triple T);
73 static IndirectStubsManagerBuilder createIndirectStubsMgrBuilder(Triple T);
75 ModuleHandleT addModule(std::unique_ptr<Module> M) {
76 // Attach a data-layout if one isn't already present.
77 if (M->getDataLayout().isDefault())
80 // Record the static constructors and destructors. We have to do this before
81 // we hand over ownership of the module to the JIT.
82 std::vector<std::string> CtorNames, DtorNames;
83 for (auto Ctor : orc::getConstructors(*M))
84 CtorNames.push_back(mangle(Ctor.Func->getName()));
85 for (auto Dtor : orc::getDestructors(*M))
86 DtorNames.push_back(mangle(Dtor.Func->getName()));
88 // Symbol resolution order:
89 // 1) Search the JIT symbols.
90 // 2) Check for C++ runtime overrides.
91 // 3) Search the host process (LLI)'s symbol table.
92 std::shared_ptr<RuntimeDyld::SymbolResolver> Resolver =
93 orc::createLambdaResolver(
94 [this](const std::string &Name) {
95 if (auto Sym = CODLayer.findSymbol(Name, true))
96 return RuntimeDyld::SymbolInfo(Sym.getAddress(),
98 if (auto Sym = CXXRuntimeOverrides.searchOverrides(Name))
102 RTDyldMemoryManager::getSymbolAddressInProcess(Name))
103 return RuntimeDyld::SymbolInfo(Addr, JITSymbolFlags::Exported);
105 return RuntimeDyld::SymbolInfo(nullptr);
107 [](const std::string &Name) {
108 return RuntimeDyld::SymbolInfo(nullptr);
112 // Add the module to the JIT.
113 std::vector<std::unique_ptr<Module>> S;
114 S.push_back(std::move(M));
115 auto H = CODLayer.addModuleSet(std::move(S), nullptr, std::move(Resolver));
117 // Run the static constructors, and save the static destructor runner for
118 // execution when the JIT is torn down.
119 orc::CtorDtorRunner<CODLayerT> CtorRunner(std::move(CtorNames), H);
120 CtorRunner.runViaLayer(CODLayer);
122 IRStaticDestructorRunners.emplace_back(std::move(DtorNames), H);
127 orc::JITSymbol findSymbol(const std::string &Name) {
128 return CODLayer.findSymbol(mangle(Name), true);
131 orc::JITSymbol findSymbolIn(ModuleHandleT H, const std::string &Name) {
132 return CODLayer.findSymbolIn(H, mangle(Name), true);
137 std::string mangle(const std::string &Name) {
138 std::string MangledName;
140 raw_string_ostream MangledNameStream(MangledName);
141 Mangler::getNameWithPrefix(MangledNameStream, Name, DL);
146 static std::set<Function*> extractSingleFunction(Function &F) {
147 std::set<Function*> Partition;
148 Partition.insert(&F);
152 static TransformFtor createDebugDumper();
154 std::unique_ptr<TargetMachine> TM;
156 SectionMemoryManager CCMgrMemMgr;
158 ObjLayerT ObjectLayer;
159 CompileLayerT CompileLayer;
160 IRDumpLayerT IRDumpLayer;
161 std::unique_ptr<CompileCallbackMgr> CCMgr;
164 orc::LocalCXXRuntimeOverrides CXXRuntimeOverrides;
165 std::vector<orc::CtorDtorRunner<CODLayerT>> IRStaticDestructorRunners;
168 int runOrcLazyJIT(std::unique_ptr<Module> M, int ArgC, char* ArgV[]);
170 } // end namespace llvm