LLVM 19.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
21namespace llvm {
22
23class MemoryBuffer;
24class Module;
25class ObjectCache;
26class TargetMachine;
27
28namespace orc {
29
30IRSymbolMapper::ManglingOptions
31irManglingOptionsFromTargetOptions(const TargetOptions &Opts);
32
33/// Simple compile functor: Takes a single IR module and returns an ObjectFile.
34/// This compiler supports a single compilation thread and LLVMContext only.
35/// For multithreaded compilation, use ConcurrentIRCompiler below.
37public:
38 using CompileResult = std::unique_ptr<MemoryBuffer>;
39
40 /// Construct a simple compile functor with the given target.
41 SimpleCompiler(TargetMachine &TM, ObjectCache *ObjCache = nullptr)
43 ObjCache(ObjCache) {}
44
45 /// Set an ObjectCache to query before compiling.
46 void setObjectCache(ObjectCache *NewCache) { ObjCache = NewCache; }
47
48 /// Compile a Module to an ObjectFile.
50
51private:
53 manglingOptionsForTargetMachine(const TargetMachine &TM);
54
55 CompileResult tryToLoadFromObjectCache(const Module &M);
56 void notifyObjectCompiled(const Module &M, const MemoryBuffer &ObjBuffer);
57
58 TargetMachine &TM;
59 ObjectCache *ObjCache = nullptr;
60};
61
62/// A SimpleCompiler that owns its TargetMachine.
63///
64/// This is convenient for clients who don't want to own their TargetMachines,
65/// e.g. LLJIT.
67public:
68 TMOwningSimpleCompiler(std::unique_ptr<TargetMachine> TM,
69 ObjectCache *ObjCache = nullptr)
70 : SimpleCompiler(*TM, ObjCache), TM(std::move(TM)) {}
71
72private:
73 // FIXME: shared because std::functions (and consequently
74 // IRCompileLayer::CompileFunction) are not moveable.
75 std::shared_ptr<llvm::TargetMachine> TM;
76};
77
78/// A thread-safe version of SimpleCompiler.
79///
80/// This class creates a new TargetMachine and SimpleCompiler instance for each
81/// compile.
83public:
85 ObjectCache *ObjCache = nullptr);
86
87 void setObjectCache(ObjectCache *ObjCache) { this->ObjCache = ObjCache; }
88
90
91private:
93 ObjectCache *ObjCache = nullptr;
94};
95
96} // end namespace orc
97
98} // end namespace llvm
99
100#endif // LLVM_EXECUTIONENGINE_ORC_COMPILEUTILS_H
static LVOptions Options
Definition: LVOptions.cpp:25
Machine Check Debug Module
const char LLVMTargetMachineRef TM
Tagged union holding either a T or a Error.
Definition: Error.h:481
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Definition: MemoryBuffer.h:51
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
This is the base ObjectCache type which can be provided to an ExecutionEngine for the purpose of avoi...
Definition: ObjectCache.h:23
Primary interface to the complete machine description for the target machine.
Definition: TargetMachine.h:76
A thread-safe version of SimpleCompiler.
Definition: CompileUtils.h:82
void setObjectCache(ObjectCache *ObjCache)
Definition: CompileUtils.h:87
Expected< std::unique_ptr< MemoryBuffer > > operator()(Module &M) override
IRCompiler(IRSymbolMapper::ManglingOptions MO)
A utility class for building TargetMachines for JITs.
Simple compile functor: Takes a single IR module and returns an ObjectFile.
Definition: CompileUtils.h:36
std::unique_ptr< MemoryBuffer > CompileResult
Definition: CompileUtils.h:38
Expected< CompileResult > operator()(Module &M) override
Compile a Module to an ObjectFile.
SimpleCompiler(TargetMachine &TM, ObjectCache *ObjCache=nullptr)
Construct a simple compile functor with the given target.
Definition: CompileUtils.h:41
void setObjectCache(ObjectCache *NewCache)
Set an ObjectCache to query before compiling.
Definition: CompileUtils.h:46
A SimpleCompiler that owns its TargetMachine.
Definition: CompileUtils.h:66
TMOwningSimpleCompiler(std::unique_ptr< TargetMachine > TM, ObjectCache *ObjCache=nullptr)
Definition: CompileUtils.h:68
IRSymbolMapper::ManglingOptions irManglingOptionsFromTargetOptions(const TargetOptions &Opts)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
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:1849
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858