LLVM  14.0.0git
CompileUtils.h
Go to the documentation of this file.
1 //===- CompileUtils.h - Utilities for compiling IR in the JIT ---*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Contains utilities for compiling IR to object files.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_EXECUTIONENGINE_ORC_COMPILEUTILS_H
14 #define LLVM_EXECUTIONENGINE_ORC_COMPILEUTILS_H
15 
19 #include <memory>
20 
21 namespace llvm {
22 
23 class MCContext;
24 class MemoryBuffer;
25 class Module;
26 class ObjectCache;
27 class TargetMachine;
28 
29 namespace orc {
30 
31 IRSymbolMapper::ManglingOptions
32 irManglingOptionsFromTargetOptions(const TargetOptions &Opts);
33 
34 /// Simple compile functor: Takes a single IR module and returns an ObjectFile.
35 /// This compiler supports a single compilation thread and LLVMContext only.
36 /// For multithreaded compilation, use ConcurrentIRCompiler below.
38 public:
39  using CompileResult = std::unique_ptr<MemoryBuffer>;
40 
41  /// Construct a simple compile functor with the given target.
42  SimpleCompiler(TargetMachine &TM, ObjectCache *ObjCache = nullptr)
44  ObjCache(ObjCache) {}
45 
46  /// Set an ObjectCache to query before compiling.
47  void setObjectCache(ObjectCache *NewCache) { ObjCache = NewCache; }
48 
49  /// Compile a Module to an ObjectFile.
51 
52 private:
54  manglingOptionsForTargetMachine(const TargetMachine &TM);
55 
56  CompileResult tryToLoadFromObjectCache(const Module &M);
57  void notifyObjectCompiled(const Module &M, const MemoryBuffer &ObjBuffer);
58 
59  TargetMachine &TM;
60  ObjectCache *ObjCache = nullptr;
61 };
62 
63 /// A SimpleCompiler that owns its TargetMachine.
64 ///
65 /// This convenient for clients who don't want to own their TargetMachines,
66 /// e.g. LLJIT.
68 public:
69  TMOwningSimpleCompiler(std::unique_ptr<TargetMachine> TM,
70  ObjectCache *ObjCache = nullptr)
71  : SimpleCompiler(*TM, ObjCache), TM(std::move(TM)) {}
72 
73 private:
74  // FIXME: shared because std::functions (and consequently
75  // IRCompileLayer::CompileFunction) are not moveable.
76  std::shared_ptr<llvm::TargetMachine> TM;
77 };
78 
79 /// A thread-safe version of SimpleCompiler.
80 ///
81 /// This class creates a new TargetMachine and SimpleCompiler instance for each
82 /// compile.
84 public:
86  ObjectCache *ObjCache = nullptr);
87 
88  void setObjectCache(ObjectCache *ObjCache) { this->ObjCache = ObjCache; }
89 
91 
92 private:
94  ObjectCache *ObjCache = nullptr;
95 };
96 
97 } // end namespace orc
98 
99 } // end namespace llvm
100 
101 #endif // LLVM_EXECUTIONENGINE_ORC_COMPILEUTILS_H
llvm::orc::ConcurrentIRCompiler::operator()
Expected< std::unique_ptr< MemoryBuffer > > operator()(Module &M) override
Definition: CompileUtils.cpp:87
llvm::orc::JITTargetMachineBuilder
A utility class for building TargetMachines for JITs.
Definition: JITTargetMachineBuilder.h:34
llvm
This file implements support for optimizing divisions by a constant.
Definition: AllocatorList.h:23
llvm::orc::TMOwningSimpleCompiler
A SimpleCompiler that owns its TargetMachine.
Definition: CompileUtils.h:67
llvm::orc::ConcurrentIRCompiler::ConcurrentIRCompiler
ConcurrentIRCompiler(JITTargetMachineBuilder JTMB, ObjectCache *ObjCache=nullptr)
Definition: CompileUtils.cpp:81
llvm::orc::SimpleCompiler::setObjectCache
void setObjectCache(ObjectCache *NewCache)
Set an ObjectCache to query before compiling.
Definition: CompileUtils.h:47
llvm::ObjectCache
This is the base ObjectCache type which can be provided to an ExecutionEngine for the purpose of avoi...
Definition: ObjectCache.h:23
llvm::orc::SimpleCompiler::CompileResult
std::unique_ptr< MemoryBuffer > CompileResult
Definition: CompileUtils.h:39
llvm::Expected
Tagged union holding either a T or a Error.
Definition: APFloat.h:42
Layer.h
llvm::MemoryBuffer
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Definition: MemoryBuffer.h:50
llvm::orc::SimpleCompiler
Simple compile functor: Takes a single IR module and returns an ObjectFile.
Definition: CompileUtils.h:37
llvm::orc::IRCompileLayer::IRCompiler::IRCompiler
IRCompiler(IRSymbolMapper::ManglingOptions MO)
Definition: IRCompileLayer.h:35
llvm::orc::SimpleCompiler::SimpleCompiler
SimpleCompiler(TargetMachine &TM, ObjectCache *ObjCache=nullptr)
Construct a simple compile functor with the given target.
Definition: CompileUtils.h:42
llvm::orc::IRCompileLayer::IRCompiler
Definition: IRCompileLayer.h:33
Options
const char LLVMTargetMachineRef LLVMPassBuilderOptionsRef Options
Definition: PassBuilderBindings.cpp:48
IRCompileLayer.h
llvm::orc::irManglingOptionsFromTargetOptions
IRSymbolMapper::ManglingOptions irManglingOptionsFromTargetOptions(const TargetOptions &Opts)
Definition: CompileUtils.cpp:28
llvm::TargetMachine
Primary interface to the complete machine description for the target machine.
Definition: TargetMachine.h:79
llvm::move
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1609
llvm::Module
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:67
Module
Machine Check Debug Module
Definition: MachineCheckDebugify.cpp:122
llvm::orc::IRSymbolMapper::ManglingOptions
Definition: Mangling.h:41
std
Definition: BitVector.h:838
llvm::orc::ConcurrentIRCompiler::setObjectCache
void setObjectCache(ObjectCache *ObjCache)
Definition: CompileUtils.h:88
llvm::orc::SimpleCompiler::operator()
Expected< CompileResult > operator()(Module &M) override
Compile a Module to an ObjectFile.
Definition: CompileUtils.cpp:37
llvm::orc::ConcurrentIRCompiler
A thread-safe version of SimpleCompiler.
Definition: CompileUtils.h:83
llvm::orc::TMOwningSimpleCompiler::TMOwningSimpleCompiler
TMOwningSimpleCompiler(std::unique_ptr< TargetMachine > TM, ObjectCache *ObjCache=nullptr)
Definition: CompileUtils.h:69
TM
const char LLVMTargetMachineRef TM
Definition: PassBuilderBindings.cpp:47
JITTargetMachineBuilder.h