LLVM 18.0.0git
Go to the documentation of this file.
1//===-- ObjectLinkingLayer.h - JITLink-based jit linking layer --*- C++ -*-===//
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
9// Contains the definition for an JITLink-based, in-process object linking
10// layer.
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/StringMap.h"
19#include "llvm/ADT/StringRef.h"
24#include "llvm/Support/Error.h"
25#include <algorithm>
26#include <cassert>
27#include <functional>
28#include <list>
29#include <memory>
30#include <utility>
31#include <vector>
33namespace llvm {
35namespace jitlink {
36class EHFrameRegistrar;
37class LinkGraph;
38class Symbol;
39} // namespace jitlink
41namespace orc {
43class ObjectLinkingLayerJITLinkContext;
45/// An ObjectLayer implementation built on JITLink.
47/// Clients can use this class to add relocatable object files to an
48/// ExecutionSession, and it typically serves as the base layer (underneath
49/// a compiling layer like IRCompileLayer) for the rest of the JIT.
50class ObjectLinkingLayer : public RTTIExtends<ObjectLinkingLayer, ObjectLayer>,
51 private ResourceManager {
55 static char ID;
57 /// Plugin instances can be added to the ObjectLinkingLayer to receive
58 /// callbacks when code is loaded or emitted, and when JITLink is being
59 /// configured.
60 class Plugin {
61 public:
66 virtual ~Plugin();
71 // Deprecated. Don't use this in new code. There will be a proper mechanism
72 // for capturing object buffers.
76 MemoryBufferRef InputObject) {}
80 return Error::success();
81 }
85 ResourceKey SrcKey) = 0;
87 /// Return any dependencies that synthetic symbols (e.g. init symbols)
88 /// have on symbols in the LinkGraph.
89 /// This is used by the ObjectLinkingLayer to update the dependencies for
90 /// the synthetic symbols.
94 }
95 };
98 std::function<void(std::unique_ptr<MemoryBuffer>)>;
100 /// Construct an ObjectLinkingLayer using the ExecutorProcessControl
101 /// instance's memory manager.
104 /// Construct an ObjectLinkingLayer using a custom memory manager.
108 /// Construct an ObjectLinkingLayer. Takes ownership of the given
109 /// JITLinkMemoryManager. This method is a temporary hack to simplify
110 /// co-existence with RTDyldObjectLinkingLayer (which also owns its
111 /// allocators).
113 std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr);
115 /// Destruct an ObjectLinkingLayer.
118 /// Set an object buffer return function. By default object buffers are
119 /// deleted once the JIT has linked them. If a return function is set then
120 /// it will be called to transfer ownership of the buffer instead.
122 this->ReturnObjectBuffer = std::move(ReturnObjectBuffer);
123 }
125 /// Add a pass-config modifier.
126 ObjectLinkingLayer &addPlugin(std::unique_ptr<Plugin> P) {
127 std::lock_guard<std::mutex> Lock(LayerMutex);
128 Plugins.push_back(std::move(P));
129 return *this;
130 }
132 /// Add a LinkGraph to the JITDylib targeted by the given tracker.
133 Error add(ResourceTrackerSP, std::unique_ptr<jitlink::LinkGraph> G);
135 /// Add a LinkGraph to the given JITDylib.
136 Error add(JITDylib &JD, std::unique_ptr<jitlink::LinkGraph> G) {
137 return add(JD.getDefaultResourceTracker(), std::move(G));
138 }
140 // Un-hide ObjectLayer add methods.
141 using ObjectLayer::add;
143 /// Emit an object file.
144 void emit(std::unique_ptr<MaterializationResponsibility> R,
145 std::unique_ptr<MemoryBuffer> O) override;
147 /// Emit a LinkGraph.
148 void emit(std::unique_ptr<MaterializationResponsibility> R,
149 std::unique_ptr<jitlink::LinkGraph> G);
151 /// Instructs this ObjectLinkingLayer instance to override the symbol flags
152 /// found in the AtomGraph with the flags supplied by the
153 /// MaterializationResponsibility instance. This is a workaround to support
154 /// symbol visibility in COFF, which does not use the libObject's
155 /// SF_Exported flag. Use only when generating / adding COFF object files.
156 ///
157 /// FIXME: We should be able to remove this if/when COFF properly tracks
158 /// exported symbols.
161 this->OverrideObjectFlags = OverrideObjectFlags;
162 return *this;
163 }
165 /// If set, this ObjectLinkingLayer instance will claim responsibility
166 /// for any symbols provided by a given object file that were not already in
167 /// the MaterializationResponsibility instance. Setting this flag allows
168 /// higher-level program representations (e.g. LLVM IR) to be added based on
169 /// only a subset of the symbols they provide, without having to write
170 /// intervening layers to scan and add the additional symbols. This trades
171 /// diagnostic quality for convenience however: If all symbols are enumerated
172 /// up-front then clashes can be detected and reported early (and usually
173 /// deterministically). If this option is set, clashes for the additional
174 /// symbols may not be detected until late, and detection may depend on
175 /// the flow of control through JIT'd code. Use with care.
177 setAutoClaimResponsibilityForObjectSymbols(bool AutoClaimObjectSymbols) {
178 this->AutoClaimObjectSymbols = AutoClaimObjectSymbols;
179 return *this;
180 }
185 void modifyPassConfig(MaterializationResponsibility &MR,
187 jitlink::PassConfiguration &PassConfig);
188 void notifyLoaded(MaterializationResponsibility &MR);
189 Error notifyEmitted(MaterializationResponsibility &MR, FinalizedAlloc FA);
191 Error handleRemoveResources(JITDylib &JD, ResourceKey K) override;
192 void handleTransferResources(JITDylib &JD, ResourceKey DstKey,
193 ResourceKey SrcKey) override;
195 mutable std::mutex LayerMutex;
197 std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgrOwnership;
198 bool OverrideObjectFlags = false;
199 bool AutoClaimObjectSymbols = false;
200 ReturnObjectBufferFunction ReturnObjectBuffer;
202 std::vector<std::unique_ptr<Plugin>> Plugins;
209 std::unique_ptr<jitlink::EHFrameRegistrar> Registrar);
212 jitlink::PassConfiguration &PassConfig) override;
217 ResourceKey SrcKey) override;
220 std::mutex EHFramePluginMutex;
222 std::unique_ptr<jitlink::EHFrameRegistrar> Registrar;
227} // end namespace orc
228} // end namespace llvm
This file defines the StringMap class.
dxil metadata emit
RelaxConfig Config
Definition: ELF_riscv.cpp:504
#define G(x, y, z)
Definition: MD5.cpp:56
#define P(N)
This file contains some templates that are useful if you are working with the STL at all.
Implements a dense probed hash-table based set.
Definition: DenseSet.h:271
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
static ErrorSuccess success()
Create a success value.
Definition: Error.h:334
Inheritance utility for extensible RTTI.
void notifyTransferringResources(JITDylib &JD, ResourceKey DstKey, ResourceKey SrcKey) override
Error notifyEmitted(MaterializationResponsibility &MR) override
Error notifyFailed(MaterializationResponsibility &MR) override
Error notifyRemovingResources(JITDylib &JD, ResourceKey K) override
void modifyPassConfig(MaterializationResponsibility &MR, jitlink::LinkGraph &G, jitlink::PassConfiguration &PassConfig) override
An ExecutionSession represents a running JIT program.
Definition: Core.h:1389
Represents a JIT'd dynamic library.
Definition: Core.h:958
ResourceTrackerSP getDefaultResourceTracker()
Get the default resource tracker for this JITDylib.
Definition: Core.cpp:674
Tracks responsibility for materialization, and mediates interactions between MaterializationUnits and...
Definition: Core.h:527
virtual Error add(ResourceTrackerSP RT, std::unique_ptr< MemoryBuffer > O, MaterializationUnit::Interface I)
Adds a MaterializationUnit for the object file in the given memory buffer to the JITDylib for the giv...
Definition: Layer.cpp:170
Plugin instances can be added to the ObjectLinkingLayer to receive callbacks when code is loaded or e...
virtual Error notifyRemovingResources(JITDylib &JD, ResourceKey K)=0
virtual void notifyMaterializing(MaterializationResponsibility &MR, jitlink::LinkGraph &G, jitlink::JITLinkContext &Ctx, MemoryBufferRef InputObject)
virtual Error notifyFailed(MaterializationResponsibility &MR)=0
DenseMap< SymbolStringPtr, JITLinkSymbolSet > SyntheticSymbolDependenciesMap
virtual void notifyLoaded(MaterializationResponsibility &MR)
virtual Error notifyEmitted(MaterializationResponsibility &MR)
virtual void modifyPassConfig(MaterializationResponsibility &MR, jitlink::LinkGraph &G, jitlink::PassConfiguration &Config)
virtual SyntheticSymbolDependenciesMap getSyntheticSymbolDependencies(MaterializationResponsibility &MR)
Return any dependencies that synthetic symbols (e.g.
virtual void notifyTransferringResources(JITDylib &JD, ResourceKey DstKey, ResourceKey SrcKey)=0
An ObjectLayer implementation built on JITLink.
ObjectLinkingLayer & setAutoClaimResponsibilityForObjectSymbols(bool AutoClaimObjectSymbols)
If set, this ObjectLinkingLayer instance will claim responsibility for any symbols provided by a give...
ObjectLinkingLayer & setOverrideObjectFlagsWithResponsibilityFlags(bool OverrideObjectFlags)
Instructs this ObjectLinkingLayer instance to override the symbol flags found in the AtomGraph with t...
void setReturnObjectBuffer(ReturnObjectBufferFunction ReturnObjectBuffer)
Set an object buffer return function.
std::function< void(std::unique_ptr< MemoryBuffer >)> ReturnObjectBufferFunction
ObjectLinkingLayer & addPlugin(std::unique_ptr< Plugin > P)
Add a pass-config modifier.
Error add(ResourceTrackerSP, std::unique_ptr< jitlink::LinkGraph > G)
Add a LinkGraph to the JITDylib targeted by the given tracker.
void emit(std::unique_ptr< MaterializationResponsibility > R, std::unique_ptr< jitlink::LinkGraph > G)
Emit a LinkGraph.
Destruct an ObjectLinkingLayer.
ObjectLinkingLayer(ExecutionSession &ES, std::unique_ptr< jitlink::JITLinkMemoryManager > MemMgr)
Construct an ObjectLinkingLayer.
Error add(JITDylib &JD, std::unique_ptr< jitlink::LinkGraph > G)
Add a LinkGraph to the given JITDylib.
Listens for ResourceTracker operations.
Definition: Core.h:104
uintptr_t ResourceKey
Definition: Core.h:53
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18