tools/lli/OrcLazyJIT.h

   1 //===--- OrcLazyJIT.h - Basic Orc-based JIT for lazy execution --*- 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 // Simple Orc-based JIT. Uses the compile-on-demand layer to break up and
  11 // lazily compile modules.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TOOLS_LLI_ORCLAZYJIT_H
  16 #define LLVM_TOOLS_LLI_ORCLAZYJIT_H
  17
  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"
  27
  28 namespace llvm {
  29
  30 class OrcLazyJIT {
  31 public:
  32
  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>)>
  37     TransformFtor;
  38   typedef orc::IRTransformLayer<CompileLayerT, TransformFtor> IRDumpLayerT;
  39   typedef orc::CompileOnDemandLayer<IRDumpLayerT, CompileCallbackMgr> CODLayerT;
  40   typedef CODLayerT::ModuleSetHandleT ModuleHandleT;
  41
  42   typedef std::function<
  43             std::unique_ptr<CompileCallbackMgr>(IRDumpLayerT&,
  44                                                 RuntimeDyld::MemoryManager&,
  45                                                 LLVMContext&)>
  46     CallbackManagerBuilder;
  47
  48   static CallbackManagerBuilder createCallbackManagerBuilder(Triple T);
  49
  50   OrcLazyJIT(std::unique_ptr<TargetMachine> TM, LLVMContext &Context,
  51              CallbackManagerBuilder &BuildCallbackMgr)
  52     : TM(std::move(TM)),
  53       Mang(this->TM->getDataLayout()),
  54       ObjectLayer(),
  55       CompileLayer(ObjectLayer, orc::SimpleCompiler(*this->TM)),
  56       IRDumpLayer(CompileLayer, createDebugDumper()),
  57       CCMgr(BuildCallbackMgr(IRDumpLayer, CCMgrMemMgr, Context)),
  58       CODLayer(IRDumpLayer, *CCMgr),
  59       CXXRuntimeOverrides([this](const std::string &S) { return mangle(S); }) {}
  60
  61   ~OrcLazyJIT() {
  62     // Run any destructors registered with __cxa_atexit.
  63     CXXRuntimeOverrides.runDestructors();
  64     // Run any IR destructors.
  65     for (auto &DtorRunner : IRStaticDestructorRunners)
  66       DtorRunner.runViaLayer(CODLayer);
  67   }
  68
  69   template <typename PtrTy>
  70   static PtrTy fromTargetAddress(orc::TargetAddress Addr) {
  71     return reinterpret_cast<PtrTy>(static_cast<uintptr_t>(Addr));
  72   }
  73
  74   ModuleHandleT addModule(std::unique_ptr<Module> M) {
  75     // Attach a data-layout if one isn't already present.
  76     if (M->getDataLayout().isDefault())
  77       M->setDataLayout(*TM->getDataLayout());
  78
  79     // Record the static constructors and destructors. We have to do this before
  80     // we hand over ownership of the module to the JIT.
  81     std::vector<std::string> CtorNames, DtorNames;
  82     for (auto Ctor : orc::getConstructors(*M))
  83       CtorNames.push_back(mangle(Ctor.Func->getName()));
  84     for (auto Dtor : orc::getDestructors(*M))
  85       DtorNames.push_back(mangle(Dtor.Func->getName()));
  86
  87     // Symbol resolution order:
  88     //   1) Search the JIT symbols.
  89     //   2) Check for C++ runtime overrides.
  90     //   3) Search the host process (LLI)'s symbol table.
  91     auto Resolver =
  92       orc::createLambdaResolver(
  93         [this](const std::string &Name) {
  94
  95           if (auto Sym = CODLayer.findSymbol(Name, true))
  96             return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
  97
  98           if (auto Sym = CXXRuntimeOverrides.searchOverrides(Name))
  99             return Sym;
 100
 101           if (auto Addr = RTDyldMemoryManager::getSymbolAddressInProcess(Name))
 102             return RuntimeDyld::SymbolInfo(Addr, JITSymbolFlags::Exported);
 103
 104           return RuntimeDyld::SymbolInfo(nullptr);
 105         },
 106         [](const std::string &Name) { return RuntimeDyld::SymbolInfo(nullptr); }
 107       );
 108
 109     // Add the module to the JIT.
 110     std::vector<std::unique_ptr<Module>> S;
 111     S.push_back(std::move(M));
 112     auto H = CODLayer.addModuleSet(std::move(S), nullptr, std::move(Resolver));
 113
 114     // Run the static constructors, and save the static destructor runner for
 115     // execution when the JIT is torn down.
 116     orc::CtorDtorRunner<CODLayerT> CtorRunner(std::move(CtorNames), H);
 117     CtorRunner.runViaLayer(CODLayer);
 118
 119     IRStaticDestructorRunners.push_back(
 120         orc::CtorDtorRunner<CODLayerT>(std::move(DtorNames), H));
 121
 122     return H;
 123   }
 124
 125   orc::JITSymbol findSymbol(const std::string &Name) {
 126     return CODLayer.findSymbol(mangle(Name), true);
 127   }
 128
 129   orc::JITSymbol findSymbolIn(ModuleHandleT H, const std::string &Name) {
 130     return CODLayer.findSymbolIn(H, mangle(Name), true);
 131   }
 132
 133 private:
 134
 135   std::string mangle(const std::string &Name) {
 136     std::string MangledName;
 137     {
 138       raw_string_ostream MangledNameStream(MangledName);
 139       Mang.getNameWithPrefix(MangledNameStream, Name);
 140     }
 141     return MangledName;
 142   }
 143
 144   static TransformFtor createDebugDumper();
 145
 146   std::unique_ptr<TargetMachine> TM;
 147   Mangler Mang;
 148   SectionMemoryManager CCMgrMemMgr;
 149
 150   ObjLayerT ObjectLayer;
 151   CompileLayerT CompileLayer;
 152   IRDumpLayerT IRDumpLayer;
 153   std::unique_ptr<CompileCallbackMgr> CCMgr;
 154   CODLayerT CODLayer;
 155
 156   orc::LocalCXXRuntimeOverrides CXXRuntimeOverrides;
 157   std::vector<orc::CtorDtorRunner<CODLayerT>> IRStaticDestructorRunners;
 158 };
 159
 160 int runOrcLazyJIT(std::unique_ptr<Module> M, int ArgC, char* ArgV[]);
 161
 162 } // end namespace llvm
 163
 164 #endif