Bug Summary

File:include/llvm/ExecutionEngine/Orc/ExecutionUtils.h
Warning:line 123, column 11
Called function pointer is null (null dereference)

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name OrcCBindings.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -mframe-pointer=none -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-10/lib/clang/10.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/lib/ExecutionEngine/Orc -I /build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc -I /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/include -I /build/llvm-toolchain-snapshot-10~svn374877/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-10/lib/clang/10.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/lib/ExecutionEngine/Orc -fdebug-prefix-map=/build/llvm-toolchain-snapshot-10~svn374877=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2019-10-15-233810-7101-1 -x c++ /build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindings.cpp

/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindings.cpp

1//===----------- OrcCBindings.cpp - C bindings for the Orc APIs -----------===//
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#include "OrcCBindingsStack.h"
10#include "llvm-c/OrcBindings.h"
11#include "llvm/ExecutionEngine/JITEventListener.h"
12
13using namespace llvm;
14
15LLVMOrcJITStackRef LLVMOrcCreateInstance(LLVMTargetMachineRef TM) {
16 TargetMachine *TM2(unwrap(TM));
17
18 Triple T(TM2->getTargetTriple());
19
20 auto IndirectStubsMgrBuilder =
21 orc::createLocalIndirectStubsManagerBuilder(T);
22
23 OrcCBindingsStack *JITStack =
24 new OrcCBindingsStack(*TM2, std::move(IndirectStubsMgrBuilder));
25
26 return wrap(JITStack);
27}
28
29const char *LLVMOrcGetErrorMsg(LLVMOrcJITStackRef JITStack) {
30 OrcCBindingsStack &J = *unwrap(JITStack);
31 return J.getErrorMessage().c_str();
32}
33
34void LLVMOrcGetMangledSymbol(LLVMOrcJITStackRef JITStack, char **MangledName,
35 const char *SymbolName) {
36 OrcCBindingsStack &J = *unwrap(JITStack);
37 std::string Mangled = J.mangle(SymbolName);
38 *MangledName = new char[Mangled.size() + 1];
39 strcpy(*MangledName, Mangled.c_str());
40}
41
42void LLVMOrcDisposeMangledSymbol(char *MangledName) { delete[] MangledName; }
43
44LLVMErrorRef LLVMOrcCreateLazyCompileCallback(
45 LLVMOrcJITStackRef JITStack, LLVMOrcTargetAddress *RetAddr,
46 LLVMOrcLazyCompileCallbackFn Callback, void *CallbackCtx) {
47 OrcCBindingsStack &J = *unwrap(JITStack);
48 if (auto Addr = J.createLazyCompileCallback(Callback, CallbackCtx)) {
49 *RetAddr = *Addr;
50 return LLVMErrorSuccess0;
51 } else
52 return wrap(Addr.takeError());
53}
54
55LLVMErrorRef LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack,
56 const char *StubName,
57 LLVMOrcTargetAddress InitAddr) {
58 OrcCBindingsStack &J = *unwrap(JITStack);
59 return wrap(J.createIndirectStub(StubName, InitAddr));
60}
61
62LLVMErrorRef LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack,
63 const char *StubName,
64 LLVMOrcTargetAddress NewAddr) {
65 OrcCBindingsStack &J = *unwrap(JITStack);
66 return wrap(J.setIndirectStubPointer(StubName, NewAddr));
67}
68
69LLVMErrorRef LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack,
70 LLVMOrcModuleHandle *RetHandle,
71 LLVMModuleRef Mod,
72 LLVMOrcSymbolResolverFn SymbolResolver,
73 void *SymbolResolverCtx) {
74 OrcCBindingsStack &J = *unwrap(JITStack);
75 std::unique_ptr<Module> M(unwrap(Mod));
76 if (auto Handle =
77 J.addIRModuleEager(std::move(M), SymbolResolver, SymbolResolverCtx)) {
78 *RetHandle = *Handle;
79 return LLVMErrorSuccess0;
80 } else
81 return wrap(Handle.takeError());
82}
83
84LLVMErrorRef LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack,
85 LLVMOrcModuleHandle *RetHandle,
86 LLVMModuleRef Mod,
87 LLVMOrcSymbolResolverFn SymbolResolver,
88 void *SymbolResolverCtx) {
89 OrcCBindingsStack &J = *unwrap(JITStack);
90 std::unique_ptr<Module> M(unwrap(Mod));
91 if (auto Handle =
92 J.addIRModuleLazy(std::move(M), SymbolResolver, SymbolResolverCtx)) {
93 *RetHandle = *Handle;
94 return LLVMErrorSuccess0;
95 } else
96 return wrap(Handle.takeError());
97}
98
99LLVMErrorRef LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack,
100 LLVMOrcModuleHandle *RetHandle,
101 LLVMMemoryBufferRef Obj,
102 LLVMOrcSymbolResolverFn SymbolResolver,
103 void *SymbolResolverCtx) {
104 OrcCBindingsStack &J = *unwrap(JITStack);
105 std::unique_ptr<MemoryBuffer> O(unwrap(Obj));
106 if (auto Handle =
107 J.addObject(std::move(O), SymbolResolver, SymbolResolverCtx)) {
108 *RetHandle = *Handle;
109 return LLVMErrorSuccess0;
110 } else
111 return wrap(Handle.takeError());
112}
113
114LLVMErrorRef LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack,
115 LLVMOrcModuleHandle H) {
116 OrcCBindingsStack &J = *unwrap(JITStack);
117 return wrap(J.removeModule(H));
118}
119
120LLVMErrorRef LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack,
121 LLVMOrcTargetAddress *RetAddr,
122 const char *SymbolName) {
123 OrcCBindingsStack &J = *unwrap(JITStack);
124 if (auto Addr = J.findSymbolAddress(SymbolName, true)) {
125 *RetAddr = *Addr;
126 return LLVMErrorSuccess0;
127 } else
128 return wrap(Addr.takeError());
129}
130
131LLVMErrorRef LLVMOrcGetSymbolAddressIn(LLVMOrcJITStackRef JITStack,
132 LLVMOrcTargetAddress *RetAddr,
133 LLVMOrcModuleHandle H,
134 const char *SymbolName) {
135 OrcCBindingsStack &J = *unwrap(JITStack);
136 if (auto Addr = J.findSymbolAddressIn(H, SymbolName, true)) {
137 *RetAddr = *Addr;
138 return LLVMErrorSuccess0;
139 } else
140 return wrap(Addr.takeError());
141}
142
143LLVMErrorRef LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack) {
144 auto *J = unwrap(JITStack);
145 auto Err = J->shutdown();
1
Calling 'OrcCBindingsStack::shutdown'
146 delete J;
147 return wrap(std::move(Err));
148}
149
150void LLVMOrcRegisterJITEventListener(LLVMOrcJITStackRef JITStack, LLVMJITEventListenerRef L)
151{
152 unwrap(JITStack)->RegisterJITEventListener(unwrap(L));
153}
154
155void LLVMOrcUnregisterJITEventListener(LLVMOrcJITStackRef JITStack, LLVMJITEventListenerRef L)
156{
157 unwrap(JITStack)->UnregisterJITEventListener(unwrap(L));
158}

/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindingsStack.h

1//===- OrcCBindingsStack.h - Orc JIT stack for C bindings -----*- 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#ifndef LLVM_LIB_EXECUTIONENGINE_ORC_ORCCBINDINGSSTACK_H
10#define LLVM_LIB_EXECUTIONENGINE_ORC_ORCCBINDINGSSTACK_H
11
12#include "llvm-c/OrcBindings.h"
13#include "llvm-c/TargetMachine.h"
14#include "llvm/ADT/STLExtras.h"
15#include "llvm/ADT/StringRef.h"
16#include "llvm/ExecutionEngine/JITSymbol.h"
17#include "llvm/ExecutionEngine/JITEventListener.h"
18#include "llvm/ExecutionEngine/Orc/CompileOnDemandLayer.h"
19#include "llvm/ExecutionEngine/Orc/CompileUtils.h"
20#include "llvm/ExecutionEngine/Orc/ExecutionUtils.h"
21#include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
22#include "llvm/ExecutionEngine/Orc/LambdaResolver.h"
23#include "llvm/ExecutionEngine/Orc/RTDyldObjectLinkingLayer.h"
24#include "llvm/ExecutionEngine/RuntimeDyld.h"
25#include "llvm/ExecutionEngine/SectionMemoryManager.h"
26#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/Mangler.h"
28#include "llvm/IR/Module.h"
29#include "llvm/Support/CBindingWrapping.h"
30#include "llvm/Support/Error.h"
31#include "llvm/Support/raw_ostream.h"
32#include "llvm/Target/TargetMachine.h"
33#include <algorithm>
34#include <cstdint>
35#include <functional>
36#include <map>
37#include <memory>
38#include <set>
39#include <string>
40#include <vector>
41
42namespace llvm {
43
44class OrcCBindingsStack;
45
46DEFINE_SIMPLE_CONVERSION_FUNCTIONS(OrcCBindingsStack, LLVMOrcJITStackRef)inline OrcCBindingsStack *unwrap(LLVMOrcJITStackRef P) { return
reinterpret_cast<OrcCBindingsStack*>(P); } inline LLVMOrcJITStackRef
wrap(const OrcCBindingsStack *P) { return reinterpret_cast<
LLVMOrcJITStackRef>(const_cast<OrcCBindingsStack*>(P
)); }
47DEFINE_SIMPLE_CONVERSION_FUNCTIONS(TargetMachine, LLVMTargetMachineRef)inline TargetMachine *unwrap(LLVMTargetMachineRef P) { return
reinterpret_cast<TargetMachine*>(P); } inline LLVMTargetMachineRef
wrap(const TargetMachine *P) { return reinterpret_cast<LLVMTargetMachineRef
>(const_cast<TargetMachine*>(P)); }
48
49namespace detail {
50
51// FIXME: Kill this off once the Layer concept becomes an interface.
52class GenericLayer {
53public:
54 virtual ~GenericLayer() = default;
55
56 virtual JITSymbol findSymbolIn(orc::VModuleKey K, const std::string &Name,
57 bool ExportedSymbolsOnly) = 0;
58 virtual Error removeModule(orc::VModuleKey K) = 0;
59 };
60
61 template <typename LayerT> class GenericLayerImpl : public GenericLayer {
62 public:
63 GenericLayerImpl(LayerT &Layer) : Layer(Layer) {}
64
65 JITSymbol findSymbolIn(orc::VModuleKey K, const std::string &Name,
66 bool ExportedSymbolsOnly) override {
67 return Layer.findSymbolIn(K, Name, ExportedSymbolsOnly);
68 }
69
70 Error removeModule(orc::VModuleKey K) override {
71 return Layer.removeModule(K);
72 }
73
74 private:
75 LayerT &Layer;
76 };
77
78 template <>
79 class GenericLayerImpl<orc::LegacyRTDyldObjectLinkingLayer> : public GenericLayer {
80 private:
81 using LayerT = orc::LegacyRTDyldObjectLinkingLayer;
82 public:
83 GenericLayerImpl(LayerT &Layer) : Layer(Layer) {}
84
85 JITSymbol findSymbolIn(orc::VModuleKey K, const std::string &Name,
86 bool ExportedSymbolsOnly) override {
87 return Layer.findSymbolIn(K, Name, ExportedSymbolsOnly);
88 }
89
90 Error removeModule(orc::VModuleKey K) override {
91 return Layer.removeObject(K);
92 }
93
94 private:
95 LayerT &Layer;
96 };
97
98 template <typename LayerT>
99 std::unique_ptr<GenericLayerImpl<LayerT>> createGenericLayer(LayerT &Layer) {
100 return std::make_unique<GenericLayerImpl<LayerT>>(Layer);
101 }
102
103} // end namespace detail
104
105class OrcCBindingsStack {
106public:
107
108 using CompileCallbackMgr = orc::JITCompileCallbackManager;
109 using ObjLayerT = orc::LegacyRTDyldObjectLinkingLayer;
110 using CompileLayerT = orc::LegacyIRCompileLayer<ObjLayerT, orc::SimpleCompiler>;
111 using CODLayerT =
112 orc::LegacyCompileOnDemandLayer<CompileLayerT, CompileCallbackMgr>;
113
114 using CallbackManagerBuilder =
115 std::function<std::unique_ptr<CompileCallbackMgr>()>;
116
117 using IndirectStubsManagerBuilder = CODLayerT::IndirectStubsManagerBuilderT;
118
119private:
120
121 using OwningObject = object::OwningBinary<object::ObjectFile>;
122
123 class CBindingsResolver : public orc::SymbolResolver {
124 public:
125 CBindingsResolver(OrcCBindingsStack &Stack,
126 LLVMOrcSymbolResolverFn ExternalResolver,
127 void *ExternalResolverCtx)
128 : Stack(Stack), ExternalResolver(std::move(ExternalResolver)),
129 ExternalResolverCtx(std::move(ExternalResolverCtx)) {}
130
131 orc::SymbolNameSet
132 getResponsibilitySet(const orc::SymbolNameSet &Symbols) override {
133 orc::SymbolNameSet Result;
134
135 for (auto &S : Symbols) {
136 if (auto Sym = findSymbol(*S)) {
137 if (!Sym.getFlags().isStrong())
138 Result.insert(S);
139 } else if (auto Err = Sym.takeError()) {
140 Stack.reportError(std::move(Err));
141 return orc::SymbolNameSet();
142 }
143 }
144
145 return Result;
146 }
147
148 orc::SymbolNameSet
149 lookup(std::shared_ptr<orc::AsynchronousSymbolQuery> Query,
150 orc::SymbolNameSet Symbols) override {
151 orc::SymbolNameSet UnresolvedSymbols;
152
153 for (auto &S : Symbols) {
154 if (auto Sym = findSymbol(*S)) {
155 if (auto Addr = Sym.getAddress()) {
156 Query->notifySymbolMetRequiredState(
157 S, JITEvaluatedSymbol(*Addr, Sym.getFlags()));
158 } else {
159 Stack.ES.legacyFailQuery(*Query, Addr.takeError());
160 return orc::SymbolNameSet();
161 }
162 } else if (auto Err = Sym.takeError()) {
163 Stack.ES.legacyFailQuery(*Query, std::move(Err));
164 return orc::SymbolNameSet();
165 } else
166 UnresolvedSymbols.insert(S);
167 }
168
169 if (Query->isComplete())
170 Query->handleComplete();
171
172 return UnresolvedSymbols;
173 }
174
175 private:
176 JITSymbol findSymbol(const std::string &Name) {
177 // Search order:
178 // 1. JIT'd symbols.
179 // 2. Runtime overrides.
180 // 3. External resolver (if present).
181
182 if (Stack.CODLayer) {
183 if (auto Sym = Stack.CODLayer->findSymbol(Name, true))
184 return Sym;
185 else if (auto Err = Sym.takeError())
186 return Sym.takeError();
187 } else {
188 if (auto Sym = Stack.CompileLayer.findSymbol(Name, true))
189 return Sym;
190 else if (auto Err = Sym.takeError())
191 return Sym.takeError();
192 }
193
194 if (auto Sym = Stack.CXXRuntimeOverrides.searchOverrides(Name))
195 return Sym;
196
197 if (ExternalResolver)
198 return JITSymbol(ExternalResolver(Name.c_str(), ExternalResolverCtx),
199 JITSymbolFlags::Exported);
200
201 return JITSymbol(nullptr);
202 }
203
204 OrcCBindingsStack &Stack;
205 LLVMOrcSymbolResolverFn ExternalResolver;
206 void *ExternalResolverCtx = nullptr;
207 };
208
209public:
210 OrcCBindingsStack(TargetMachine &TM,
211 IndirectStubsManagerBuilder IndirectStubsMgrBuilder)
212 : CCMgr(createCompileCallbackManager(TM, ES)), DL(TM.createDataLayout()),
213 IndirectStubsMgr(IndirectStubsMgrBuilder()),
214 ObjectLayer(
215 AcknowledgeORCv1Deprecation, ES,
216 [this](orc::VModuleKey K) {
217 auto ResolverI = Resolvers.find(K);
218 assert(ResolverI != Resolvers.end() &&((ResolverI != Resolvers.end() && "No resolver for module K"
) ? static_cast<void> (0) : __assert_fail ("ResolverI != Resolvers.end() && \"No resolver for module K\""
, "/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindingsStack.h"
, 219, __PRETTY_FUNCTION__))
219 "No resolver for module K")((ResolverI != Resolvers.end() && "No resolver for module K"
) ? static_cast<void> (0) : __assert_fail ("ResolverI != Resolvers.end() && \"No resolver for module K\""
, "/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindingsStack.h"
, 219, __PRETTY_FUNCTION__))
;
220 auto Resolver = std::move(ResolverI->second);
221 Resolvers.erase(ResolverI);
222 return ObjLayerT::Resources{
223 std::make_shared<SectionMemoryManager>(), Resolver};
224 },
225 nullptr,
226 [this](orc::VModuleKey K, const object::ObjectFile &Obj,
227 const RuntimeDyld::LoadedObjectInfo &LoadedObjInfo) {
228 this->notifyFinalized(K, Obj, LoadedObjInfo);
229 },
230 [this](orc::VModuleKey K, const object::ObjectFile &Obj) {
231 this->notifyFreed(K, Obj);
232 }),
233 CompileLayer(AcknowledgeORCv1Deprecation, ObjectLayer,
234 orc::SimpleCompiler(TM)),
235 CODLayer(createCODLayer(ES, CompileLayer, CCMgr.get(),
236 std::move(IndirectStubsMgrBuilder), Resolvers)),
237 CXXRuntimeOverrides(
238 AcknowledgeORCv1Deprecation,
239 [this](const std::string &S) { return mangle(S); }) {}
240
241 Error shutdown() {
242 // Run any destructors registered with __cxa_atexit.
243 CXXRuntimeOverrides.runDestructors();
244 // Run any IR destructors.
245 for (auto &DtorRunner : IRStaticDestructorRunners)
246 if (auto Err = DtorRunner.runViaLayer(*this))
2
Taking false branch
3
Taking false branch
4
Calling 'LegacyCtorDtorRunner::runViaLayer'
247 return Err;
248 return Error::success();
249 }
250
251 std::string mangle(StringRef Name) {
252 std::string MangledName;
253 {
254 raw_string_ostream MangledNameStream(MangledName);
255 Mangler::getNameWithPrefix(MangledNameStream, Name, DL);
256 }
257 return MangledName;
258 }
259
260 template <typename PtrTy>
261 static PtrTy fromTargetAddress(JITTargetAddress Addr) {
262 return reinterpret_cast<PtrTy>(static_cast<uintptr_t>(Addr));
263 }
264
265 Expected<JITTargetAddress>
266 createLazyCompileCallback(LLVMOrcLazyCompileCallbackFn Callback,
267 void *CallbackCtx) {
268 auto WrappedCallback = [=]() -> JITTargetAddress {
269 return Callback(wrap(this), CallbackCtx);
270 };
271
272 return CCMgr->getCompileCallback(std::move(WrappedCallback));
273 }
274
275 Error createIndirectStub(StringRef StubName, JITTargetAddress Addr) {
276 return IndirectStubsMgr->createStub(StubName, Addr,
277 JITSymbolFlags::Exported);
278 }
279
280 Error setIndirectStubPointer(StringRef Name, JITTargetAddress Addr) {
281 return IndirectStubsMgr->updatePointer(Name, Addr);
282 }
283
284 template <typename LayerT>
285 Expected<orc::VModuleKey>
286 addIRModule(LayerT &Layer, std::unique_ptr<Module> M,
287 std::unique_ptr<RuntimeDyld::MemoryManager> MemMgr,
288 LLVMOrcSymbolResolverFn ExternalResolver,
289 void *ExternalResolverCtx) {
290
291 // Attach a data-layout if one isn't already present.
292 if (M->getDataLayout().isDefault())
293 M->setDataLayout(DL);
294
295 // Record the static constructors and destructors. We have to do this before
296 // we hand over ownership of the module to the JIT.
297 std::vector<std::string> CtorNames, DtorNames;
298 for (auto Ctor : orc::getConstructors(*M))
299 CtorNames.push_back(mangle(Ctor.Func->getName()));
300 for (auto Dtor : orc::getDestructors(*M))
301 DtorNames.push_back(mangle(Dtor.Func->getName()));
302
303 // Add the module to the JIT.
304 auto K = ES.allocateVModule();
305 Resolvers[K] = std::make_shared<CBindingsResolver>(*this, ExternalResolver,
306 ExternalResolverCtx);
307 if (auto Err = Layer.addModule(K, std::move(M)))
308 return std::move(Err);
309
310 KeyLayers[K] = detail::createGenericLayer(Layer);
311
312 // Run the static constructors, and save the static destructor runner for
313 // execution when the JIT is torn down.
314 orc::LegacyCtorDtorRunner<OrcCBindingsStack> CtorRunner(
315 AcknowledgeORCv1Deprecation, std::move(CtorNames), K);
316 if (auto Err = CtorRunner.runViaLayer(*this))
317 return std::move(Err);
318
319 IRStaticDestructorRunners.emplace_back(AcknowledgeORCv1Deprecation,
320 std::move(DtorNames), K);
321
322 return K;
323 }
324
325 Expected<orc::VModuleKey>
326 addIRModuleEager(std::unique_ptr<Module> M,
327 LLVMOrcSymbolResolverFn ExternalResolver,
328 void *ExternalResolverCtx) {
329 return addIRModule(CompileLayer, std::move(M),
330 std::make_unique<SectionMemoryManager>(),
331 std::move(ExternalResolver), ExternalResolverCtx);
332 }
333
334 Expected<orc::VModuleKey>
335 addIRModuleLazy(std::unique_ptr<Module> M,
336 LLVMOrcSymbolResolverFn ExternalResolver,
337 void *ExternalResolverCtx) {
338 if (!CODLayer)
339 return make_error<StringError>("Can not add lazy module: No compile "
340 "callback manager available",
341 inconvertibleErrorCode());
342
343 return addIRModule(*CODLayer, std::move(M),
344 std::make_unique<SectionMemoryManager>(),
345 std::move(ExternalResolver), ExternalResolverCtx);
346 }
347
348 Error removeModule(orc::VModuleKey K) {
349 // FIXME: Should error release the module key?
350 if (auto Err = KeyLayers[K]->removeModule(K))
351 return Err;
352 ES.releaseVModule(K);
353 KeyLayers.erase(K);
354 return Error::success();
355 }
356
357 Expected<orc::VModuleKey> addObject(std::unique_ptr<MemoryBuffer> ObjBuffer,
358 LLVMOrcSymbolResolverFn ExternalResolver,
359 void *ExternalResolverCtx) {
360 if (auto Obj = object::ObjectFile::createObjectFile(
361 ObjBuffer->getMemBufferRef())) {
362
363 auto K = ES.allocateVModule();
364 Resolvers[K] = std::make_shared<CBindingsResolver>(
365 *this, ExternalResolver, ExternalResolverCtx);
366
367 if (auto Err = ObjectLayer.addObject(K, std::move(ObjBuffer)))
368 return std::move(Err);
369
370 KeyLayers[K] = detail::createGenericLayer(ObjectLayer);
371
372 return K;
373 } else
374 return Obj.takeError();
375 }
376
377 JITSymbol findSymbol(const std::string &Name,
378 bool ExportedSymbolsOnly) {
379 if (auto Sym = IndirectStubsMgr->findStub(Name, ExportedSymbolsOnly))
380 return Sym;
381 if (CODLayer)
382 return CODLayer->findSymbol(mangle(Name), ExportedSymbolsOnly);
383 return CompileLayer.findSymbol(mangle(Name), ExportedSymbolsOnly);
384 }
385
386 JITSymbol findSymbolIn(orc::VModuleKey K, const std::string &Name,
387 bool ExportedSymbolsOnly) {
388 assert(KeyLayers.count(K) && "looking up symbol in unknown module")((KeyLayers.count(K) && "looking up symbol in unknown module"
) ? static_cast<void> (0) : __assert_fail ("KeyLayers.count(K) && \"looking up symbol in unknown module\""
, "/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindingsStack.h"
, 388, __PRETTY_FUNCTION__))
;
389 return KeyLayers[K]->findSymbolIn(K, mangle(Name), ExportedSymbolsOnly);
390 }
391
392 Expected<JITTargetAddress> findSymbolAddress(const std::string &Name,
393 bool ExportedSymbolsOnly) {
394 if (auto Sym = findSymbol(Name, ExportedSymbolsOnly)) {
395 // Successful lookup, non-null symbol:
396 if (auto AddrOrErr = Sym.getAddress())
397 return *AddrOrErr;
398 else
399 return AddrOrErr.takeError();
400 } else if (auto Err = Sym.takeError()) {
401 // Lookup failure - report error.
402 return std::move(Err);
403 }
404
405 // No symbol not found. Return 0.
406 return 0;
407 }
408
409 Expected<JITTargetAddress> findSymbolAddressIn(orc::VModuleKey K,
410 const std::string &Name,
411 bool ExportedSymbolsOnly) {
412 if (auto Sym = findSymbolIn(K, Name, ExportedSymbolsOnly)) {
413 // Successful lookup, non-null symbol:
414 if (auto AddrOrErr = Sym.getAddress())
415 return *AddrOrErr;
416 else
417 return AddrOrErr.takeError();
418 } else if (auto Err = Sym.takeError()) {
419 // Lookup failure - report error.
420 return std::move(Err);
421 }
422
423 // Symbol not found. Return 0.
424 return 0;
425 }
426
427 const std::string &getErrorMessage() const { return ErrMsg; }
428
429 void RegisterJITEventListener(JITEventListener *L) {
430 if (!L)
431 return;
432 EventListeners.push_back(L);
433 }
434
435 void UnregisterJITEventListener(JITEventListener *L) {
436 if (!L)
437 return;
438
439 auto I = find(reverse(EventListeners), L);
440 if (I != EventListeners.rend()) {
441 std::swap(*I, EventListeners.back());
442 EventListeners.pop_back();
443 }
444 }
445
446private:
447 using ResolverMap =
448 std::map<orc::VModuleKey, std::shared_ptr<orc::SymbolResolver>>;
449
450 static std::unique_ptr<CompileCallbackMgr>
451 createCompileCallbackManager(TargetMachine &TM, orc::ExecutionSession &ES) {
452 auto CCMgr = createLocalCompileCallbackManager(TM.getTargetTriple(), ES, 0);
453 if (!CCMgr) {
454 // FIXME: It would be good if we could report this somewhere, but we do
455 // have an instance yet.
456 logAllUnhandledErrors(CCMgr.takeError(), errs(), "ORC error: ");
457 return nullptr;
458 }
459 return std::move(*CCMgr);
460 }
461
462 static std::unique_ptr<CODLayerT>
463 createCODLayer(orc::ExecutionSession &ES, CompileLayerT &CompileLayer,
464 CompileCallbackMgr *CCMgr,
465 IndirectStubsManagerBuilder IndirectStubsMgrBuilder,
466 ResolverMap &Resolvers) {
467 // If there is no compile callback manager available we can not create a
468 // compile on demand layer.
469 if (!CCMgr)
470 return nullptr;
471
472 return std::make_unique<CODLayerT>(
473 AcknowledgeORCv1Deprecation, ES, CompileLayer,
474 [&Resolvers](orc::VModuleKey K) {
475 auto ResolverI = Resolvers.find(K);
476 assert(ResolverI != Resolvers.end() && "No resolver for module K")((ResolverI != Resolvers.end() && "No resolver for module K"
) ? static_cast<void> (0) : __assert_fail ("ResolverI != Resolvers.end() && \"No resolver for module K\""
, "/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindingsStack.h"
, 476, __PRETTY_FUNCTION__))
;
477 return ResolverI->second;
478 },
479 [&Resolvers](orc::VModuleKey K,
480 std::shared_ptr<orc::SymbolResolver> Resolver) {
481 assert(!Resolvers.count(K) && "Resolver already present")((!Resolvers.count(K) && "Resolver already present") ?
static_cast<void> (0) : __assert_fail ("!Resolvers.count(K) && \"Resolver already present\""
, "/build/llvm-toolchain-snapshot-10~svn374877/lib/ExecutionEngine/Orc/OrcCBindingsStack.h"
, 481, __PRETTY_FUNCTION__))
;
482 Resolvers[K] = std::move(Resolver);
483 },
484 [](Function &F) { return std::set<Function *>({&F}); }, *CCMgr,
485 std::move(IndirectStubsMgrBuilder), false);
486 }
487
488 void reportError(Error Err) {
489 // FIXME: Report errors on the execution session.
490 logAllUnhandledErrors(std::move(Err), errs(), "ORC error: ");
491 };
492
493 void notifyFinalized(orc::VModuleKey K,
494 const object::ObjectFile &Obj,
495 const RuntimeDyld::LoadedObjectInfo &LoadedObjInfo) {
496 uint64_t Key = static_cast<uint64_t>(
497 reinterpret_cast<uintptr_t>(Obj.getData().data()));
498 for (auto &Listener : EventListeners)
499 Listener->notifyObjectLoaded(Key, Obj, LoadedObjInfo);
500 }
501
502 void notifyFreed(orc::VModuleKey K, const object::ObjectFile &Obj) {
503 uint64_t Key = static_cast<uint64_t>(
504 reinterpret_cast<uintptr_t>(Obj.getData().data()));
505 for (auto &Listener : EventListeners)
506 Listener->notifyFreeingObject(Key);
507 }
508
509 orc::ExecutionSession ES;
510 std::unique_ptr<CompileCallbackMgr> CCMgr;
511
512 std::vector<JITEventListener *> EventListeners;
513
514 DataLayout DL;
515 SectionMemoryManager CCMgrMemMgr;
516
517 std::unique_ptr<orc::IndirectStubsManager> IndirectStubsMgr;
518
519 ObjLayerT ObjectLayer;
520 CompileLayerT CompileLayer;
521 std::unique_ptr<CODLayerT> CODLayer;
522
523 std::map<orc::VModuleKey, std::unique_ptr<detail::GenericLayer>> KeyLayers;
524
525 orc::LegacyLocalCXXRuntimeOverrides CXXRuntimeOverrides;
526 std::vector<orc::LegacyCtorDtorRunner<OrcCBindingsStack>> IRStaticDestructorRunners;
527 std::string ErrMsg;
528
529 ResolverMap Resolvers;
530};
531
532} // end namespace llvm
533
534#endif // LLVM_LIB_EXECUTIONENGINE_ORC_ORCCBINDINGSSTACK_H

/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/ExecutionEngine/Orc/ExecutionUtils.h

1//===- ExecutionUtils.h - Utilities for executing code in Orc ---*- 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 executing code in Orc.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_ORC_EXECUTIONUTILS_H
14#define LLVM_EXECUTIONENGINE_ORC_EXECUTIONUTILS_H
15
16#include "llvm/ADT/StringMap.h"
17#include "llvm/ADT/iterator_range.h"
18#include "llvm/ExecutionEngine/JITSymbol.h"
19#include "llvm/ExecutionEngine/Orc/Core.h"
20#include "llvm/ExecutionEngine/Orc/OrcError.h"
21#include "llvm/ExecutionEngine/RuntimeDyld.h"
22#include "llvm/Object/Archive.h"
23#include "llvm/Support/DynamicLibrary.h"
24#include <algorithm>
25#include <cstdint>
26#include <string>
27#include <utility>
28#include <vector>
29
30namespace llvm {
31
32class ConstantArray;
33class GlobalVariable;
34class Function;
35class Module;
36class TargetMachine;
37class Value;
38
39namespace orc {
40
41class ObjectLayer;
42
43/// This iterator provides a convenient way to iterate over the elements
44/// of an llvm.global_ctors/llvm.global_dtors instance.
45///
46/// The easiest way to get hold of instances of this class is to use the
47/// getConstructors/getDestructors functions.
48class CtorDtorIterator {
49public:
50 /// Accessor for an element of the global_ctors/global_dtors array.
51 ///
52 /// This class provides a read-only view of the element with any casts on
53 /// the function stripped away.
54 struct Element {
55 Element(unsigned Priority, Function *Func, Value *Data)
56 : Priority(Priority), Func(Func), Data(Data) {}
57
58 unsigned Priority;
59 Function *Func;
60 Value *Data;
61 };
62
63 /// Construct an iterator instance. If End is true then this iterator
64 /// acts as the end of the range, otherwise it is the beginning.
65 CtorDtorIterator(const GlobalVariable *GV, bool End);
66
67 /// Test iterators for equality.
68 bool operator==(const CtorDtorIterator &Other) const;
69
70 /// Test iterators for inequality.
71 bool operator!=(const CtorDtorIterator &Other) const;
72
73 /// Pre-increment iterator.
74 CtorDtorIterator& operator++();
75
76 /// Post-increment iterator.
77 CtorDtorIterator operator++(int);
78
79 /// Dereference iterator. The resulting value provides a read-only view
80 /// of this element of the global_ctors/global_dtors list.
81 Element operator*() const;
82
83private:
84 const ConstantArray *InitList;
85 unsigned I;
86};
87
88/// Create an iterator range over the entries of the llvm.global_ctors
89/// array.
90iterator_range<CtorDtorIterator> getConstructors(const Module &M);
91
92/// Create an iterator range over the entries of the llvm.global_ctors
93/// array.
94iterator_range<CtorDtorIterator> getDestructors(const Module &M);
95
96/// Convenience class for recording constructor/destructor names for
97/// later execution.
98template <typename JITLayerT>
99class LegacyCtorDtorRunner {
100public:
101 /// Construct a CtorDtorRunner for the given range using the given
102 /// name mangling function.
103 LLVM_ATTRIBUTE_DEPRECATED(LegacyCtorDtorRunner(std::vector<std::string> CtorDtorNames
, VModuleKey K) __attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 CtorDtorRunner utility instead")))
104 LegacyCtorDtorRunner(std::vector<std::string> CtorDtorNames,LegacyCtorDtorRunner(std::vector<std::string> CtorDtorNames
, VModuleKey K) __attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 CtorDtorRunner utility instead")))
105 VModuleKey K),LegacyCtorDtorRunner(std::vector<std::string> CtorDtorNames
, VModuleKey K) __attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 CtorDtorRunner utility instead")))
106 "ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "LegacyCtorDtorRunner(std::vector<std::string> CtorDtorNames
, VModuleKey K) __attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 CtorDtorRunner utility instead")))
107 "Please use the ORCv2 CtorDtorRunner utility instead")LegacyCtorDtorRunner(std::vector<std::string> CtorDtorNames
, VModuleKey K) __attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 CtorDtorRunner utility instead")))
;
108
109 LegacyCtorDtorRunner(ORCv1DeprecationAcknowledgement,
110 std::vector<std::string> CtorDtorNames, VModuleKey K)
111 : CtorDtorNames(std::move(CtorDtorNames)), K(K) {}
112
113 /// Run the recorded constructors/destructors through the given JIT
114 /// layer.
115 Error runViaLayer(JITLayerT &JITLayer) const {
116 using CtorDtorTy = void (*)();
117
118 for (const auto &CtorDtorName : CtorDtorNames) {
119 if (auto CtorDtorSym = JITLayer.findSymbolIn(K, CtorDtorName, false)) {
5
Calling 'JITSymbol::operator bool'
8
Returning from 'JITSymbol::operator bool'
9
Taking true branch
120 if (auto AddrOrErr = CtorDtorSym.getAddress()) {
10
Calling 'JITSymbol::getAddress'
18
Returning from 'JITSymbol::getAddress'
19
Calling 'Expected::operator bool'
21
Returning from 'Expected::operator bool'
22
Taking true branch
121 CtorDtorTy CtorDtor =
26
'CtorDtor' initialized to a null pointer value
122 reinterpret_cast<CtorDtorTy>(static_cast<uintptr_t>(*AddrOrErr));
23
Calling 'Expected::operator*'
25
Returning from 'Expected::operator*'
123 CtorDtor();
27
Called function pointer is null (null dereference)
124 } else
125 return AddrOrErr.takeError();
126 } else {
127 if (auto Err = CtorDtorSym.takeError())
128 return Err;
129 else
130 return make_error<JITSymbolNotFound>(CtorDtorName);
131 }
132 }
133 return Error::success();
134 }
135
136private:
137 std::vector<std::string> CtorDtorNames;
138 orc::VModuleKey K;
139};
140
141template <typename JITLayerT>
142LegacyCtorDtorRunner<JITLayerT>::LegacyCtorDtorRunner(
143 std::vector<std::string> CtorDtorNames, VModuleKey K)
144 : CtorDtorNames(std::move(CtorDtorNames)), K(K) {}
145
146class CtorDtorRunner {
147public:
148 CtorDtorRunner(JITDylib &JD) : JD(JD) {}
149 void add(iterator_range<CtorDtorIterator> CtorDtors);
150 Error run();
151
152private:
153 using CtorDtorList = std::vector<SymbolStringPtr>;
154 using CtorDtorPriorityMap = std::map<unsigned, CtorDtorList>;
155
156 JITDylib &JD;
157 CtorDtorPriorityMap CtorDtorsByPriority;
158};
159
160/// Support class for static dtor execution. For hosted (in-process) JITs
161/// only!
162///
163/// If a __cxa_atexit function isn't found C++ programs that use static
164/// destructors will fail to link. However, we don't want to use the host
165/// process's __cxa_atexit, because it will schedule JIT'd destructors to run
166/// after the JIT has been torn down, which is no good. This class makes it easy
167/// to override __cxa_atexit (and the related __dso_handle).
168///
169/// To use, clients should manually call searchOverrides from their symbol
170/// resolver. This should generally be done after attempting symbol resolution
171/// inside the JIT, but before searching the host process's symbol table. When
172/// the client determines that destructors should be run (generally at JIT
173/// teardown or after a return from main), the runDestructors method should be
174/// called.
175class LocalCXXRuntimeOverridesBase {
176public:
177 /// Run any destructors recorded by the overriden __cxa_atexit function
178 /// (CXAAtExitOverride).
179 void runDestructors();
180
181protected:
182 template <typename PtrTy> JITTargetAddress toTargetAddress(PtrTy *P) {
183 return static_cast<JITTargetAddress>(reinterpret_cast<uintptr_t>(P));
184 }
185
186 using DestructorPtr = void (*)(void *);
187 using CXXDestructorDataPair = std::pair<DestructorPtr, void *>;
188 using CXXDestructorDataPairList = std::vector<CXXDestructorDataPair>;
189 CXXDestructorDataPairList DSOHandleOverride;
190 static int CXAAtExitOverride(DestructorPtr Destructor, void *Arg,
191 void *DSOHandle);
192};
193
194class LegacyLocalCXXRuntimeOverrides : public LocalCXXRuntimeOverridesBase {
195public:
196 /// Create a runtime-overrides class.
197 template <typename MangleFtorT>
198 LLVM_ATTRIBUTE_DEPRECATED(LegacyLocalCXXRuntimeOverrides(const MangleFtorT &Mangle)
__attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 LocalCXXRuntimeOverrides utility instead"
)))
199 LegacyLocalCXXRuntimeOverrides(const MangleFtorT &Mangle),LegacyLocalCXXRuntimeOverrides(const MangleFtorT &Mangle)
__attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 LocalCXXRuntimeOverrides utility instead"
)))
200 "ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "LegacyLocalCXXRuntimeOverrides(const MangleFtorT &Mangle)
__attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 LocalCXXRuntimeOverrides utility instead"
)))
201 "Please use the ORCv2 LocalCXXRuntimeOverrides utility instead")LegacyLocalCXXRuntimeOverrides(const MangleFtorT &Mangle)
__attribute__((deprecated("ORCv1 utilities (utilities with the 'Legacy' prefix) are deprecated. "
"Please use the ORCv2 LocalCXXRuntimeOverrides utility instead"
)))
;
202
203 template <typename MangleFtorT>
204 LegacyLocalCXXRuntimeOverrides(ORCv1DeprecationAcknowledgement,
205 const MangleFtorT &Mangle) {
206 addOverride(Mangle("__dso_handle"), toTargetAddress(&DSOHandleOverride));
207 addOverride(Mangle("__cxa_atexit"), toTargetAddress(&CXAAtExitOverride));
208 }
209
210 /// Search overrided symbols.
211 JITEvaluatedSymbol searchOverrides(const std::string &Name) {
212 auto I = CXXRuntimeOverrides.find(Name);
213 if (I != CXXRuntimeOverrides.end())
214 return JITEvaluatedSymbol(I->second, JITSymbolFlags::Exported);
215 return nullptr;
216 }
217
218private:
219 void addOverride(const std::string &Name, JITTargetAddress Addr) {
220 CXXRuntimeOverrides.insert(std::make_pair(Name, Addr));
221 }
222
223 StringMap<JITTargetAddress> CXXRuntimeOverrides;
224};
225
226template <typename MangleFtorT>
227LegacyLocalCXXRuntimeOverrides::LegacyLocalCXXRuntimeOverrides(
228 const MangleFtorT &Mangle) {
229 addOverride(Mangle("__dso_handle"), toTargetAddress(&DSOHandleOverride));
230 addOverride(Mangle("__cxa_atexit"), toTargetAddress(&CXAAtExitOverride));
231}
232
233class LocalCXXRuntimeOverrides : public LocalCXXRuntimeOverridesBase {
234public:
235 Error enable(JITDylib &JD, MangleAndInterner &Mangler);
236};
237
238/// A utility class to expose symbols found via dlsym to the JIT.
239///
240/// If an instance of this class is attached to a JITDylib as a fallback
241/// definition generator, then any symbol found in the given DynamicLibrary that
242/// passes the 'Allow' predicate will be added to the JITDylib.
243class DynamicLibrarySearchGenerator : public JITDylib::DefinitionGenerator {
244public:
245 using SymbolPredicate = std::function<bool(SymbolStringPtr)>;
246
247 /// Create a DynamicLibrarySearchGenerator that searches for symbols in the
248 /// given sys::DynamicLibrary.
249 ///
250 /// If the Allow predicate is given then only symbols matching the predicate
251 /// will be searched for. If the predicate is not given then all symbols will
252 /// be searched for.
253 DynamicLibrarySearchGenerator(sys::DynamicLibrary Dylib, char GlobalPrefix,
254 SymbolPredicate Allow = SymbolPredicate());
255
256 /// Permanently loads the library at the given path and, on success, returns
257 /// a DynamicLibrarySearchGenerator that will search it for symbol definitions
258 /// in the library. On failure returns the reason the library failed to load.
259 static Expected<std::unique_ptr<DynamicLibrarySearchGenerator>>
260 Load(const char *FileName, char GlobalPrefix,
261 SymbolPredicate Allow = SymbolPredicate());
262
263 /// Creates a DynamicLibrarySearchGenerator that searches for symbols in
264 /// the current process.
265 static Expected<std::unique_ptr<DynamicLibrarySearchGenerator>>
266 GetForCurrentProcess(char GlobalPrefix,
267 SymbolPredicate Allow = SymbolPredicate()) {
268 return Load(nullptr, GlobalPrefix, std::move(Allow));
269 }
270
271 Expected<SymbolNameSet> tryToGenerate(JITDylib &JD,
272 const SymbolNameSet &Names) override;
273
274private:
275 sys::DynamicLibrary Dylib;
276 SymbolPredicate Allow;
277 char GlobalPrefix;
278};
279
280/// A utility class to expose symbols from a static library.
281///
282/// If an instance of this class is attached to a JITDylib as a fallback
283/// definition generator, then any symbol found in the archive will result in
284/// the containing object being added to the JITDylib.
285class StaticLibraryDefinitionGenerator : public JITDylib::DefinitionGenerator {
286public:
287 /// Try to create a StaticLibraryDefinitionGenerator from the given path.
288 ///
289 /// This call will succeed if the file at the given path is a static library
290 /// is a valid archive, otherwise it will return an error.
291 static Expected<std::unique_ptr<StaticLibraryDefinitionGenerator>>
292 Load(ObjectLayer &L, const char *FileName);
293
294 /// Try to create a StaticLibrarySearchGenerator from the given memory buffer.
295 /// Thhis call will succeed if the buffer contains a valid archive, otherwise
296 /// it will return an error.
297 static Expected<std::unique_ptr<StaticLibraryDefinitionGenerator>>
298 Create(ObjectLayer &L, std::unique_ptr<MemoryBuffer> ArchiveBuffer);
299
300 Expected<SymbolNameSet> tryToGenerate(JITDylib &JD,
301 const SymbolNameSet &Names) override;
302
303private:
304 StaticLibraryDefinitionGenerator(ObjectLayer &L,
305 std::unique_ptr<MemoryBuffer> ArchiveBuffer,
306 Error &Err);
307
308 ObjectLayer &L;
309 std::unique_ptr<MemoryBuffer> ArchiveBuffer;
310 object::Archive Archive;
311 size_t UnrealizedObjects = 0;
312};
313
314} // end namespace orc
315} // end namespace llvm
316
317#endif // LLVM_EXECUTIONENGINE_ORC_EXECUTIONUTILS_H

/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/ExecutionEngine/JITSymbol.h

1//===- JITSymbol.h - JIT symbol abstraction ---------------------*- 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// Abstraction for target process addresses.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_JITSYMBOL_H
14#define LLVM_EXECUTIONENGINE_JITSYMBOL_H
15
16#include <algorithm>
17#include <cassert>
18#include <cstddef>
19#include <cstdint>
20#include <functional>
21#include <map>
22#include <set>
23#include <string>
24
25#include "llvm/ADT/BitmaskEnum.h"
26#include "llvm/ADT/FunctionExtras.h"
27#include "llvm/ADT/StringRef.h"
28#include "llvm/Support/Error.h"
29
30namespace llvm {
31
32class GlobalValue;
33
34namespace object {
35
36class SymbolRef;
37
38} // end namespace object
39
40/// Represents an address in the target process's address space.
41using JITTargetAddress = uint64_t;
42
43/// Convert a JITTargetAddress to a pointer.
44template <typename T> T jitTargetAddressToPointer(JITTargetAddress Addr) {
45 static_assert(std::is_pointer<T>::value, "T must be a pointer type");
46 uintptr_t IntPtr = static_cast<uintptr_t>(Addr);
47 assert(IntPtr == Addr && "JITTargetAddress value out of range for uintptr_t")((IntPtr == Addr && "JITTargetAddress value out of range for uintptr_t"
) ? static_cast<void> (0) : __assert_fail ("IntPtr == Addr && \"JITTargetAddress value out of range for uintptr_t\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/ExecutionEngine/JITSymbol.h"
, 47, __PRETTY_FUNCTION__))
;
48 return reinterpret_cast<T>(IntPtr);
49}
50
51template <typename T> JITTargetAddress pointerToJITTargetAddress(T *Ptr) {
52 return static_cast<JITTargetAddress>(reinterpret_cast<uintptr_t>(Ptr));
53}
54
55/// Flags for symbols in the JIT.
56class JITSymbolFlags {
57public:
58 using UnderlyingType = uint8_t;
59 using TargetFlagsType = uint8_t;
60
61 enum FlagNames : UnderlyingType {
62 None = 0,
63 HasError = 1U << 0,
64 Weak = 1U << 1,
65 Common = 1U << 2,
66 Absolute = 1U << 3,
67 Exported = 1U << 4,
68 Callable = 1U << 5,
69 LLVM_MARK_AS_BITMASK_ENUM(/* LargestValue = */ Callable)LLVM_BITMASK_LARGEST_ENUMERATOR = Callable
70 };
71
72 /// Default-construct a JITSymbolFlags instance.
73 JITSymbolFlags() = default;
74
75 /// Construct a JITSymbolFlags instance from the given flags.
76 JITSymbolFlags(FlagNames Flags) : Flags(Flags) {}
77
78 /// Construct a JITSymbolFlags instance from the given flags and target
79 /// flags.
80 JITSymbolFlags(FlagNames Flags, TargetFlagsType TargetFlags)
81 : TargetFlags(TargetFlags), Flags(Flags) {}
82
83 /// Implicitly convert to bool. Returs true if any flag is set.
84 explicit operator bool() const { return Flags != None || TargetFlags != 0; }
85
86 /// Compare for equality.
87 bool operator==(const JITSymbolFlags &RHS) const {
88 return Flags == RHS.Flags && TargetFlags == RHS.TargetFlags;
89 }
90
91 /// Bitwise AND-assignment for FlagNames.
92 JITSymbolFlags &operator&=(const FlagNames &RHS) {
93 Flags &= RHS;
94 return *this;
95 }
96
97 /// Bitwise OR-assignment for FlagNames.
98 JITSymbolFlags &operator|=(const FlagNames &RHS) {
99 Flags |= RHS;
100 return *this;
101 }
102
103 /// Return true if there was an error retrieving this symbol.
104 bool hasError() const {
105 return (Flags & HasError) == HasError;
106 }
107
108 /// Returns true if the Weak flag is set.
109 bool isWeak() const {
110 return (Flags & Weak) == Weak;
111 }
112
113 /// Returns true if the Common flag is set.
114 bool isCommon() const {
115 return (Flags & Common) == Common;
116 }
117
118 /// Returns true if the symbol isn't weak or common.
119 bool isStrong() const {
120 return !isWeak() && !isCommon();
121 }
122
123 /// Returns true if the Exported flag is set.
124 bool isExported() const {
125 return (Flags & Exported) == Exported;
126 }
127
128 /// Returns true if the given symbol is known to be callable.
129 bool isCallable() const { return (Flags & Callable) == Callable; }
130
131 /// Get the underlying flags value as an integer.
132 UnderlyingType getRawFlagsValue() const {
133 return static_cast<UnderlyingType>(Flags);
134 }
135
136 /// Return a reference to the target-specific flags.
137 TargetFlagsType& getTargetFlags() { return TargetFlags; }
138
139 /// Return a reference to the target-specific flags.
140 const TargetFlagsType& getTargetFlags() const { return TargetFlags; }
141
142 /// Construct a JITSymbolFlags value based on the flags of the given global
143 /// value.
144 static JITSymbolFlags fromGlobalValue(const GlobalValue &GV);
145
146 /// Construct a JITSymbolFlags value based on the flags of the given libobject
147 /// symbol.
148 static Expected<JITSymbolFlags>
149 fromObjectSymbol(const object::SymbolRef &Symbol);
150
151private:
152 TargetFlagsType TargetFlags = 0;
153 FlagNames Flags = None;
154};
155
156inline JITSymbolFlags operator&(const JITSymbolFlags &LHS,
157 const JITSymbolFlags::FlagNames &RHS) {
158 JITSymbolFlags Tmp = LHS;
159 Tmp &= RHS;
160 return Tmp;
161}
162
163inline JITSymbolFlags operator|(const JITSymbolFlags &LHS,
164 const JITSymbolFlags::FlagNames &RHS) {
165 JITSymbolFlags Tmp = LHS;
166 Tmp |= RHS;
167 return Tmp;
168}
169
170/// ARM-specific JIT symbol flags.
171/// FIXME: This should be moved into a target-specific header.
172class ARMJITSymbolFlags {
173public:
174 ARMJITSymbolFlags() = default;
175
176 enum FlagNames {
177 None = 0,
178 Thumb = 1 << 0
179 };
180
181 operator JITSymbolFlags::TargetFlagsType&() { return Flags; }
182
183 static ARMJITSymbolFlags fromObjectSymbol(const object::SymbolRef &Symbol);
184
185private:
186 JITSymbolFlags::TargetFlagsType Flags = 0;
187};
188
189/// Represents a symbol that has been evaluated to an address already.
190class JITEvaluatedSymbol {
191public:
192 JITEvaluatedSymbol() = default;
193
194 /// Create a 'null' symbol.
195 JITEvaluatedSymbol(std::nullptr_t) {}
196
197 /// Create a symbol for the given address and flags.
198 JITEvaluatedSymbol(JITTargetAddress Address, JITSymbolFlags Flags)
199 : Address(Address), Flags(Flags) {}
200
201 /// An evaluated symbol converts to 'true' if its address is non-zero.
202 explicit operator bool() const { return Address != 0; }
203
204 /// Return the address of this symbol.
205 JITTargetAddress getAddress() const { return Address; }
206
207 /// Return the flags for this symbol.
208 JITSymbolFlags getFlags() const { return Flags; }
209
210 /// Set the flags for this symbol.
211 void setFlags(JITSymbolFlags Flags) { this->Flags = std::move(Flags); }
212
213private:
214 JITTargetAddress Address = 0;
215 JITSymbolFlags Flags;
216};
217
218/// Represents a symbol in the JIT.
219class JITSymbol {
220public:
221 using GetAddressFtor = unique_function<Expected<JITTargetAddress>()>;
222
223 /// Create a 'null' symbol, used to represent a "symbol not found"
224 /// result from a successful (non-erroneous) lookup.
225 JITSymbol(std::nullptr_t)
226 : CachedAddr(0) {}
227
228 /// Create a JITSymbol representing an error in the symbol lookup
229 /// process (e.g. a network failure during a remote lookup).
230 JITSymbol(Error Err)
231 : Err(std::move(Err)), Flags(JITSymbolFlags::HasError) {}
232
233 /// Create a symbol for a definition with a known address.
234 JITSymbol(JITTargetAddress Addr, JITSymbolFlags Flags)
235 : CachedAddr(Addr), Flags(Flags) {}
236
237 /// Construct a JITSymbol from a JITEvaluatedSymbol.
238 JITSymbol(JITEvaluatedSymbol Sym)
239 : CachedAddr(Sym.getAddress()), Flags(Sym.getFlags()) {}
240
241 /// Create a symbol for a definition that doesn't have a known address
242 /// yet.
243 /// @param GetAddress A functor to materialize a definition (fixing the
244 /// address) on demand.
245 ///
246 /// This constructor allows a JIT layer to provide a reference to a symbol
247 /// definition without actually materializing the definition up front. The
248 /// user can materialize the definition at any time by calling the getAddress
249 /// method.
250 JITSymbol(GetAddressFtor GetAddress, JITSymbolFlags Flags)
251 : GetAddress(std::move(GetAddress)), CachedAddr(0), Flags(Flags) {}
252
253 JITSymbol(const JITSymbol&) = delete;
254 JITSymbol& operator=(const JITSymbol&) = delete;
255
256 JITSymbol(JITSymbol &&Other)
257 : GetAddress(std::move(Other.GetAddress)), Flags(std::move(Other.Flags)) {
258 if (Flags.hasError())
259 Err = std::move(Other.Err);
260 else
261 CachedAddr = std::move(Other.CachedAddr);
262 }
263
264 JITSymbol& operator=(JITSymbol &&Other) {
265 GetAddress = std::move(Other.GetAddress);
266 Flags = std::move(Other.Flags);
267 if (Flags.hasError())
268 Err = std::move(Other.Err);
269 else
270 CachedAddr = std::move(Other.CachedAddr);
271 return *this;
272 }
273
274 ~JITSymbol() {
275 if (Flags.hasError())
276 Err.~Error();
277 else
278 CachedAddr.~JITTargetAddress();
279 }
280
281 /// Returns true if the symbol exists, false otherwise.
282 explicit operator bool() const {
283 return !Flags.hasError() && (CachedAddr || GetAddress);
6
Assuming field 'CachedAddr' is 0
7
Returning the value 1, which participates in a condition later
284 }
285
286 /// Move the error field value out of this JITSymbol.
287 Error takeError() {
288 if (Flags.hasError())
289 return std::move(Err);
290 return Error::success();
291 }
292
293 /// Get the address of the symbol in the target address space. Returns
294 /// '0' if the symbol does not exist.
295 Expected<JITTargetAddress> getAddress() {
296 assert(!Flags.hasError() && "getAddress called on error value")((!Flags.hasError() && "getAddress called on error value"
) ? static_cast<void> (0) : __assert_fail ("!Flags.hasError() && \"getAddress called on error value\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/ExecutionEngine/JITSymbol.h"
, 296, __PRETTY_FUNCTION__))
;
11
'?' condition is true
297 if (GetAddress) {
12
Taking false branch
298 if (auto CachedAddrOrErr = GetAddress()) {
299 GetAddress = nullptr;
300 CachedAddr = *CachedAddrOrErr;
301 assert(CachedAddr && "Symbol could not be materialized.")((CachedAddr && "Symbol could not be materialized.") ?
static_cast<void> (0) : __assert_fail ("CachedAddr && \"Symbol could not be materialized.\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/ExecutionEngine/JITSymbol.h"
, 301, __PRETTY_FUNCTION__))
;
302 } else
303 return CachedAddrOrErr.takeError();
304 }
305 return CachedAddr;
13
Calling constructor for 'Expected<unsigned long>'
17
Returning from constructor for 'Expected<unsigned long>'
306 }
307
308 JITSymbolFlags getFlags() const { return Flags; }
309
310private:
311 GetAddressFtor GetAddress;
312 union {
313 JITTargetAddress CachedAddr;
314 Error Err;
315 };
316 JITSymbolFlags Flags;
317};
318
319/// Symbol resolution interface.
320///
321/// Allows symbol flags and addresses to be looked up by name.
322/// Symbol queries are done in bulk (i.e. you request resolution of a set of
323/// symbols, rather than a single one) to reduce IPC overhead in the case of
324/// remote JITing, and expose opportunities for parallel compilation.
325class JITSymbolResolver {
326public:
327 using LookupSet = std::set<StringRef>;
328 using LookupResult = std::map<StringRef, JITEvaluatedSymbol>;
329 using OnResolvedFunction = unique_function<void(Expected<LookupResult>)>;
330
331 virtual ~JITSymbolResolver() = default;
332
333 /// Returns the fully resolved address and flags for each of the given
334 /// symbols.
335 ///
336 /// This method will return an error if any of the given symbols can not be
337 /// resolved, or if the resolution process itself triggers an error.
338 virtual void lookup(const LookupSet &Symbols,
339 OnResolvedFunction OnResolved) = 0;
340
341 /// Returns the subset of the given symbols that should be materialized by
342 /// the caller. Only weak/common symbols should be looked up, as strong
343 /// definitions are implicitly always part of the caller's responsibility.
344 virtual Expected<LookupSet>
345 getResponsibilitySet(const LookupSet &Symbols) = 0;
346
347private:
348 virtual void anchor();
349};
350
351/// Legacy symbol resolution interface.
352class LegacyJITSymbolResolver : public JITSymbolResolver {
353public:
354 /// Performs lookup by, for each symbol, first calling
355 /// findSymbolInLogicalDylib and if that fails calling
356 /// findSymbol.
357 void lookup(const LookupSet &Symbols, OnResolvedFunction OnResolved) final;
358
359 /// Performs flags lookup by calling findSymbolInLogicalDylib and
360 /// returning the flags value for that symbol.
361 Expected<LookupSet> getResponsibilitySet(const LookupSet &Symbols) final;
362
363 /// This method returns the address of the specified symbol if it exists
364 /// within the logical dynamic library represented by this JITSymbolResolver.
365 /// Unlike findSymbol, queries through this interface should return addresses
366 /// for hidden symbols.
367 ///
368 /// This is of particular importance for the Orc JIT APIs, which support lazy
369 /// compilation by breaking up modules: Each of those broken out modules
370 /// must be able to resolve hidden symbols provided by the others. Clients
371 /// writing memory managers for MCJIT can usually ignore this method.
372 ///
373 /// This method will be queried by RuntimeDyld when checking for previous
374 /// definitions of common symbols.
375 virtual JITSymbol findSymbolInLogicalDylib(const std::string &Name) = 0;
376
377 /// This method returns the address of the specified function or variable.
378 /// It is used to resolve symbols during module linking.
379 ///
380 /// If the returned symbol's address is equal to ~0ULL then RuntimeDyld will
381 /// skip all relocations for that symbol, and the client will be responsible
382 /// for handling them manually.
383 virtual JITSymbol findSymbol(const std::string &Name) = 0;
384
385private:
386 virtual void anchor();
387};
388
389} // end namespace llvm
390
391#endif // LLVM_EXECUTIONENGINE_JITSYMBOL_H

/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h

1//===- llvm/Support/Error.h - Recoverable error handling --------*- 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// This file defines an API used to report recoverable errors.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_SUPPORT_ERROR_H
14#define LLVM_SUPPORT_ERROR_H
15
16#include "llvm-c/Error.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/StringExtras.h"
20#include "llvm/ADT/Twine.h"
21#include "llvm/Config/abi-breaking.h"
22#include "llvm/Support/AlignOf.h"
23#include "llvm/Support/Compiler.h"
24#include "llvm/Support/Debug.h"
25#include "llvm/Support/ErrorHandling.h"
26#include "llvm/Support/ErrorOr.h"
27#include "llvm/Support/Format.h"
28#include "llvm/Support/raw_ostream.h"
29#include <algorithm>
30#include <cassert>
31#include <cstdint>
32#include <cstdlib>
33#include <functional>
34#include <memory>
35#include <new>
36#include <string>
37#include <system_error>
38#include <type_traits>
39#include <utility>
40#include <vector>
41
42namespace llvm {
43
44class ErrorSuccess;
45
46/// Base class for error info classes. Do not extend this directly: Extend
47/// the ErrorInfo template subclass instead.
48class ErrorInfoBase {
49public:
50 virtual ~ErrorInfoBase() = default;
51
52 /// Print an error message to an output stream.
53 virtual void log(raw_ostream &OS) const = 0;
54
55 /// Return the error message as a string.
56 virtual std::string message() const {
57 std::string Msg;
58 raw_string_ostream OS(Msg);
59 log(OS);
60 return OS.str();
61 }
62
63 /// Convert this error to a std::error_code.
64 ///
65 /// This is a temporary crutch to enable interaction with code still
66 /// using std::error_code. It will be removed in the future.
67 virtual std::error_code convertToErrorCode() const = 0;
68
69 // Returns the class ID for this type.
70 static const void *classID() { return &ID; }
71
72 // Returns the class ID for the dynamic type of this ErrorInfoBase instance.
73 virtual const void *dynamicClassID() const = 0;
74
75 // Check whether this instance is a subclass of the class identified by
76 // ClassID.
77 virtual bool isA(const void *const ClassID) const {
78 return ClassID == classID();
79 }
80
81 // Check whether this instance is a subclass of ErrorInfoT.
82 template <typename ErrorInfoT> bool isA() const {
83 return isA(ErrorInfoT::classID());
84 }
85
86private:
87 virtual void anchor();
88
89 static char ID;
90};
91
92/// Lightweight error class with error context and mandatory checking.
93///
94/// Instances of this class wrap a ErrorInfoBase pointer. Failure states
95/// are represented by setting the pointer to a ErrorInfoBase subclass
96/// instance containing information describing the failure. Success is
97/// represented by a null pointer value.
98///
99/// Instances of Error also contains a 'Checked' flag, which must be set
100/// before the destructor is called, otherwise the destructor will trigger a
101/// runtime error. This enforces at runtime the requirement that all Error
102/// instances be checked or returned to the caller.
103///
104/// There are two ways to set the checked flag, depending on what state the
105/// Error instance is in. For Error instances indicating success, it
106/// is sufficient to invoke the boolean conversion operator. E.g.:
107///
108/// @code{.cpp}
109/// Error foo(<...>);
110///
111/// if (auto E = foo(<...>))
112/// return E; // <- Return E if it is in the error state.
113/// // We have verified that E was in the success state. It can now be safely
114/// // destroyed.
115/// @endcode
116///
117/// A success value *can not* be dropped. For example, just calling 'foo(<...>)'
118/// without testing the return value will raise a runtime error, even if foo
119/// returns success.
120///
121/// For Error instances representing failure, you must use either the
122/// handleErrors or handleAllErrors function with a typed handler. E.g.:
123///
124/// @code{.cpp}
125/// class MyErrorInfo : public ErrorInfo<MyErrorInfo> {
126/// // Custom error info.
127/// };
128///
129/// Error foo(<...>) { return make_error<MyErrorInfo>(...); }
130///
131/// auto E = foo(<...>); // <- foo returns failure with MyErrorInfo.
132/// auto NewE =
133/// handleErrors(E,
134/// [](const MyErrorInfo &M) {
135/// // Deal with the error.
136/// },
137/// [](std::unique_ptr<OtherError> M) -> Error {
138/// if (canHandle(*M)) {
139/// // handle error.
140/// return Error::success();
141/// }
142/// // Couldn't handle this error instance. Pass it up the stack.
143/// return Error(std::move(M));
144/// );
145/// // Note - we must check or return NewE in case any of the handlers
146/// // returned a new error.
147/// @endcode
148///
149/// The handleAllErrors function is identical to handleErrors, except
150/// that it has a void return type, and requires all errors to be handled and
151/// no new errors be returned. It prevents errors (assuming they can all be
152/// handled) from having to be bubbled all the way to the top-level.
153///
154/// *All* Error instances must be checked before destruction, even if
155/// they're moved-assigned or constructed from Success values that have already
156/// been checked. This enforces checking through all levels of the call stack.
157class LLVM_NODISCARD[[clang::warn_unused_result]] Error {
158 // Both ErrorList and FileError need to be able to yank ErrorInfoBase
159 // pointers out of this class to add to the error list.
160 friend class ErrorList;
161 friend class FileError;
162
163 // handleErrors needs to be able to set the Checked flag.
164 template <typename... HandlerTs>
165 friend Error handleErrors(Error E, HandlerTs &&... Handlers);
166
167 // Expected<T> needs to be able to steal the payload when constructed from an
168 // error.
169 template <typename T> friend class Expected;
170
171 // wrap needs to be able to steal the payload.
172 friend LLVMErrorRef wrap(Error);
173
174protected:
175 /// Create a success value. Prefer using 'Error::success()' for readability
176 Error() {
177 setPtr(nullptr);
178 setChecked(false);
179 }
180
181public:
182 /// Create a success value.
183 static ErrorSuccess success();
184
185 // Errors are not copy-constructable.
186 Error(const Error &Other) = delete;
187
188 /// Move-construct an error value. The newly constructed error is considered
189 /// unchecked, even if the source error had been checked. The original error
190 /// becomes a checked Success value, regardless of its original state.
191 Error(Error &&Other) {
192 setChecked(true);
193 *this = std::move(Other);
194 }
195
196 /// Create an error value. Prefer using the 'make_error' function, but
197 /// this constructor can be useful when "re-throwing" errors from handlers.
198 Error(std::unique_ptr<ErrorInfoBase> Payload) {
199 setPtr(Payload.release());
200 setChecked(false);
201 }
202
203 // Errors are not copy-assignable.
204 Error &operator=(const Error &Other) = delete;
205
206 /// Move-assign an error value. The current error must represent success, you
207 /// you cannot overwrite an unhandled error. The current error is then
208 /// considered unchecked. The source error becomes a checked success value,
209 /// regardless of its original state.
210 Error &operator=(Error &&Other) {
211 // Don't allow overwriting of unchecked values.
212 assertIsChecked();
213 setPtr(Other.getPtr());
214
215 // This Error is unchecked, even if the source error was checked.
216 setChecked(false);
217
218 // Null out Other's payload and set its checked bit.
219 Other.setPtr(nullptr);
220 Other.setChecked(true);
221
222 return *this;
223 }
224
225 /// Destroy a Error. Fails with a call to abort() if the error is
226 /// unchecked.
227 ~Error() {
228 assertIsChecked();
229 delete getPtr();
230 }
231
232 /// Bool conversion. Returns true if this Error is in a failure state,
233 /// and false if it is in an accept state. If the error is in a Success state
234 /// it will be considered checked.
235 explicit operator bool() {
236 setChecked(getPtr() == nullptr);
237 return getPtr() != nullptr;
238 }
239
240 /// Check whether one error is a subclass of another.
241 template <typename ErrT> bool isA() const {
242 return getPtr() && getPtr()->isA(ErrT::classID());
243 }
244
245 /// Returns the dynamic class id of this error, or null if this is a success
246 /// value.
247 const void* dynamicClassID() const {
248 if (!getPtr())
249 return nullptr;
250 return getPtr()->dynamicClassID();
251 }
252
253private:
254#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
255 // assertIsChecked() happens very frequently, but under normal circumstances
256 // is supposed to be a no-op. So we want it to be inlined, but having a bunch
257 // of debug prints can cause the function to be too large for inlining. So
258 // it's important that we define this function out of line so that it can't be
259 // inlined.
260 LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
261 void fatalUncheckedError() const;
262#endif
263
264 void assertIsChecked() {
265#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
266 if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false))
267 fatalUncheckedError();
268#endif
269 }
270
271 ErrorInfoBase *getPtr() const {
272 return reinterpret_cast<ErrorInfoBase*>(
273 reinterpret_cast<uintptr_t>(Payload) &
274 ~static_cast<uintptr_t>(0x1));
275 }
276
277 void setPtr(ErrorInfoBase *EI) {
278#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
279 Payload = reinterpret_cast<ErrorInfoBase*>(
280 (reinterpret_cast<uintptr_t>(EI) &
281 ~static_cast<uintptr_t>(0x1)) |
282 (reinterpret_cast<uintptr_t>(Payload) & 0x1));
283#else
284 Payload = EI;
285#endif
286 }
287
288 bool getChecked() const {
289#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
290 return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0;
291#else
292 return true;
293#endif
294 }
295
296 void setChecked(bool V) {
297 Payload = reinterpret_cast<ErrorInfoBase*>(
298 (reinterpret_cast<uintptr_t>(Payload) &
299 ~static_cast<uintptr_t>(0x1)) |
300 (V ? 0 : 1));
301 }
302
303 std::unique_ptr<ErrorInfoBase> takePayload() {
304 std::unique_ptr<ErrorInfoBase> Tmp(getPtr());
305 setPtr(nullptr);
306 setChecked(true);
307 return Tmp;
308 }
309
310 friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) {
311 if (auto P = E.getPtr())
312 P->log(OS);
313 else
314 OS << "success";
315 return OS;
316 }
317
318 ErrorInfoBase *Payload = nullptr;
319};
320
321/// Subclass of Error for the sole purpose of identifying the success path in
322/// the type system. This allows to catch invalid conversion to Expected<T> at
323/// compile time.
324class ErrorSuccess final : public Error {};
325
326inline ErrorSuccess Error::success() { return ErrorSuccess(); }
327
328/// Make a Error instance representing failure using the given error info
329/// type.
330template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
331 return Error(std::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
332}
333
334/// Base class for user error types. Users should declare their error types
335/// like:
336///
337/// class MyError : public ErrorInfo<MyError> {
338/// ....
339/// };
340///
341/// This class provides an implementation of the ErrorInfoBase::kind
342/// method, which is used by the Error RTTI system.
343template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
344class ErrorInfo : public ParentErrT {
345public:
346 using ParentErrT::ParentErrT; // inherit constructors
347
348 static const void *classID() { return &ThisErrT::ID; }
349
350 const void *dynamicClassID() const override { return &ThisErrT::ID; }
351
352 bool isA(const void *const ClassID) const override {
353 return ClassID == classID() || ParentErrT::isA(ClassID);
354 }
355};
356
357/// Special ErrorInfo subclass representing a list of ErrorInfos.
358/// Instances of this class are constructed by joinError.
359class ErrorList final : public ErrorInfo<ErrorList> {
360 // handleErrors needs to be able to iterate the payload list of an
361 // ErrorList.
362 template <typename... HandlerTs>
363 friend Error handleErrors(Error E, HandlerTs &&... Handlers);
364
365 // joinErrors is implemented in terms of join.
366 friend Error joinErrors(Error, Error);
367
368public:
369 void log(raw_ostream &OS) const override {
370 OS << "Multiple errors:\n";
371 for (auto &ErrPayload : Payloads) {
372 ErrPayload->log(OS);
373 OS << "\n";
374 }
375 }
376
377 std::error_code convertToErrorCode() const override;
378
379 // Used by ErrorInfo::classID.
380 static char ID;
381
382private:
383 ErrorList(std::unique_ptr<ErrorInfoBase> Payload1,
384 std::unique_ptr<ErrorInfoBase> Payload2) {
385 assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 386, __PRETTY_FUNCTION__))
386 "ErrorList constructor payloads should be singleton errors")((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 386, __PRETTY_FUNCTION__))
;
387 Payloads.push_back(std::move(Payload1));
388 Payloads.push_back(std::move(Payload2));
389 }
390
391 static Error join(Error E1, Error E2) {
392 if (!E1)
393 return E2;
394 if (!E2)
395 return E1;
396 if (E1.isA<ErrorList>()) {
397 auto &E1List = static_cast<ErrorList &>(*E1.getPtr());
398 if (E2.isA<ErrorList>()) {
399 auto E2Payload = E2.takePayload();
400 auto &E2List = static_cast<ErrorList &>(*E2Payload);
401 for (auto &Payload : E2List.Payloads)
402 E1List.Payloads.push_back(std::move(Payload));
403 } else
404 E1List.Payloads.push_back(E2.takePayload());
405
406 return E1;
407 }
408 if (E2.isA<ErrorList>()) {
409 auto &E2List = static_cast<ErrorList &>(*E2.getPtr());
410 E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload());
411 return E2;
412 }
413 return Error(std::unique_ptr<ErrorList>(
414 new ErrorList(E1.takePayload(), E2.takePayload())));
415 }
416
417 std::vector<std::unique_ptr<ErrorInfoBase>> Payloads;
418};
419
420/// Concatenate errors. The resulting Error is unchecked, and contains the
421/// ErrorInfo(s), if any, contained in E1, followed by the
422/// ErrorInfo(s), if any, contained in E2.
423inline Error joinErrors(Error E1, Error E2) {
424 return ErrorList::join(std::move(E1), std::move(E2));
425}
426
427/// Tagged union holding either a T or a Error.
428///
429/// This class parallels ErrorOr, but replaces error_code with Error. Since
430/// Error cannot be copied, this class replaces getError() with
431/// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the
432/// error class type.
433template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected {
434 template <class T1> friend class ExpectedAsOutParameter;
435 template <class OtherT> friend class Expected;
436
437 static const bool isRef = std::is_reference<T>::value;
438
439 using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>;
440
441 using error_type = std::unique_ptr<ErrorInfoBase>;
442
443public:
444 using storage_type = typename std::conditional<isRef, wrap, T>::type;
445 using value_type = T;
446
447private:
448 using reference = typename std::remove_reference<T>::type &;
449 using const_reference = const typename std::remove_reference<T>::type &;
450 using pointer = typename std::remove_reference<T>::type *;
451 using const_pointer = const typename std::remove_reference<T>::type *;
452
453public:
454 /// Create an Expected<T> error value from the given Error.
455 Expected(Error Err)
456 : HasError(true)
457#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
458 // Expected is unchecked upon construction in Debug builds.
459 , Unchecked(true)
460#endif
461 {
462 assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value."
) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 462, __PRETTY_FUNCTION__))
;
463 new (getErrorStorage()) error_type(Err.takePayload());
464 }
465
466 /// Forbid to convert from Error::success() implicitly, this avoids having
467 /// Expected<T> foo() { return Error::success(); } which compiles otherwise
468 /// but triggers the assertion above.
469 Expected(ErrorSuccess) = delete;
470
471 /// Create an Expected<T> success value from the given OtherT value, which
472 /// must be convertible to T.
473 template <typename OtherT>
474 Expected(OtherT &&Val,
475 typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
476 * = nullptr)
477 : HasError(false)
478#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
479 // Expected is unchecked upon construction in Debug builds.
480 , Unchecked(true)
481#endif
482 {
483 new (getStorage()) storage_type(std::forward<OtherT>(Val));
14
Calling 'operator new'
15
Returning from 'operator new'
16
Assigning 0
484 }
485
486 /// Move construct an Expected<T> value.
487 Expected(Expected &&Other) { moveConstruct(std::move(Other)); }
488
489 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
490 /// must be convertible to T.
491 template <class OtherT>
492 Expected(Expected<OtherT> &&Other,
493 typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
494 * = nullptr) {
495 moveConstruct(std::move(Other));
496 }
497
498 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
499 /// isn't convertible to T.
500 template <class OtherT>
501 explicit Expected(
502 Expected<OtherT> &&Other,
503 typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * =
504 nullptr) {
505 moveConstruct(std::move(Other));
506 }
507
508 /// Move-assign from another Expected<T>.
509 Expected &operator=(Expected &&Other) {
510 moveAssign(std::move(Other));
511 return *this;
512 }
513
514 /// Destroy an Expected<T>.
515 ~Expected() {
516 assertIsChecked();
517 if (!HasError)
518 getStorage()->~storage_type();
519 else
520 getErrorStorage()->~error_type();
521 }
522
523 /// Return false if there is an error.
524 explicit operator bool() {
525#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
526 Unchecked = HasError;
527#endif
528 return !HasError;
20
Returning the value 1, which participates in a condition later
529 }
530
531 /// Returns a reference to the stored T value.
532 reference get() {
533 assertIsChecked();
534 return *getStorage();
535 }
536
537 /// Returns a const reference to the stored T value.
538 const_reference get() const {
539 assertIsChecked();
540 return const_cast<Expected<T> *>(this)->get();
541 }
542
543 /// Check that this Expected<T> is an error of type ErrT.
544 template <typename ErrT> bool errorIsA() const {
545 return HasError && (*getErrorStorage())->template isA<ErrT>();
546 }
547
548 /// Take ownership of the stored error.
549 /// After calling this the Expected<T> is in an indeterminate state that can
550 /// only be safely destructed. No further calls (beside the destructor) should
551 /// be made on the Expected<T> value.
552 Error takeError() {
553#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
554 Unchecked = false;
555#endif
556 return HasError ? Error(std::move(*getErrorStorage())) : Error::success();
557 }
558
559 /// Returns a pointer to the stored T value.
560 pointer operator->() {
561 assertIsChecked();
562 return toPointer(getStorage());
563 }
564
565 /// Returns a const pointer to the stored T value.
566 const_pointer operator->() const {
567 assertIsChecked();
568 return toPointer(getStorage());
569 }
570
571 /// Returns a reference to the stored T value.
572 reference operator*() {
573 assertIsChecked();
574 return *getStorage();
24
Returning zero
575 }
576
577 /// Returns a const reference to the stored T value.
578 const_reference operator*() const {
579 assertIsChecked();
580 return *getStorage();
581 }
582
583private:
584 template <class T1>
585 static bool compareThisIfSameType(const T1 &a, const T1 &b) {
586 return &a == &b;
587 }
588
589 template <class T1, class T2>
590 static bool compareThisIfSameType(const T1 &a, const T2 &b) {
591 return false;
592 }
593
594 template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) {
595 HasError = Other.HasError;
596#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
597 Unchecked = true;
598 Other.Unchecked = false;
599#endif
600
601 if (!HasError)
602 new (getStorage()) storage_type(std::move(*Other.getStorage()));
603 else
604 new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage()));
605 }
606
607 template <class OtherT> void moveAssign(Expected<OtherT> &&Other) {
608 assertIsChecked();
609
610 if (compareThisIfSameType(*this, Other))
611 return;
612
613 this->~Expected();
614 new (this) Expected(std::move(Other));
615 }
616
617 pointer toPointer(pointer Val) { return Val; }
618
619 const_pointer toPointer(const_pointer Val) const { return Val; }
620
621 pointer toPointer(wrap *Val) { return &Val->get(); }
622
623 const_pointer toPointer(const wrap *Val) const { return &Val->get(); }
624
625 storage_type *getStorage() {
626 assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 626, __PRETTY_FUNCTION__))
;
627 return reinterpret_cast<storage_type *>(TStorage.buffer);
628 }
629
630 const storage_type *getStorage() const {
631 assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 631, __PRETTY_FUNCTION__))
;
632 return reinterpret_cast<const storage_type *>(TStorage.buffer);
633 }
634
635 error_type *getErrorStorage() {
636 assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 636, __PRETTY_FUNCTION__))
;
637 return reinterpret_cast<error_type *>(ErrorStorage.buffer);
638 }
639
640 const error_type *getErrorStorage() const {
641 assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 641, __PRETTY_FUNCTION__))
;
642 return reinterpret_cast<const error_type *>(ErrorStorage.buffer);
643 }
644
645 // Used by ExpectedAsOutParameter to reset the checked flag.
646 void setUnchecked() {
647#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
648 Unchecked = true;
649#endif
650 }
651
652#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
653 LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
654 LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline))
655 void fatalUncheckedExpected() const {
656 dbgs() << "Expected<T> must be checked before access or destruction.\n";
657 if (HasError) {
658 dbgs() << "Unchecked Expected<T> contained error:\n";
659 (*getErrorStorage())->log(dbgs());
660 } else
661 dbgs() << "Expected<T> value was in success state. (Note: Expected<T> "
662 "values in success mode must still be checked prior to being "
663 "destroyed).\n";
664 abort();
665 }
666#endif
667
668 void assertIsChecked() {
669#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
670 if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false))
671 fatalUncheckedExpected();
672#endif
673 }
674
675 union {
676 AlignedCharArrayUnion<storage_type> TStorage;
677 AlignedCharArrayUnion<error_type> ErrorStorage;
678 };
679 bool HasError : 1;
680#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
681 bool Unchecked : 1;
682#endif
683};
684
685/// Report a serious error, calling any installed error handler. See
686/// ErrorHandling.h.
687LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err,
688 bool gen_crash_diag = true);
689
690/// Report a fatal error if Err is a failure value.
691///
692/// This function can be used to wrap calls to fallible functions ONLY when it
693/// is known that the Error will always be a success value. E.g.
694///
695/// @code{.cpp}
696/// // foo only attempts the fallible operation if DoFallibleOperation is
697/// // true. If DoFallibleOperation is false then foo always returns
698/// // Error::success().
699/// Error foo(bool DoFallibleOperation);
700///
701/// cantFail(foo(false));
702/// @endcode
703inline void cantFail(Error Err, const char *Msg = nullptr) {
704 if (Err) {
705 if (!Msg)
706 Msg = "Failure value returned from cantFail wrapped call";
707 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 707)
;
708 }
709}
710
711/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
712/// returns the contained value.
713///
714/// This function can be used to wrap calls to fallible functions ONLY when it
715/// is known that the Error will always be a success value. E.g.
716///
717/// @code{.cpp}
718/// // foo only attempts the fallible operation if DoFallibleOperation is
719/// // true. If DoFallibleOperation is false then foo always returns an int.
720/// Expected<int> foo(bool DoFallibleOperation);
721///
722/// int X = cantFail(foo(false));
723/// @endcode
724template <typename T>
725T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) {
726 if (ValOrErr)
727 return std::move(*ValOrErr);
728 else {
729 if (!Msg)
730 Msg = "Failure value returned from cantFail wrapped call";
731 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 731)
;
732 }
733}
734
735/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
736/// returns the contained reference.
737///
738/// This function can be used to wrap calls to fallible functions ONLY when it
739/// is known that the Error will always be a success value. E.g.
740///
741/// @code{.cpp}
742/// // foo only attempts the fallible operation if DoFallibleOperation is
743/// // true. If DoFallibleOperation is false then foo always returns a Bar&.
744/// Expected<Bar&> foo(bool DoFallibleOperation);
745///
746/// Bar &X = cantFail(foo(false));
747/// @endcode
748template <typename T>
749T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) {
750 if (ValOrErr)
751 return *ValOrErr;
752 else {
753 if (!Msg)
754 Msg = "Failure value returned from cantFail wrapped call";
755 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 755)
;
756 }
757}
758
759/// Helper for testing applicability of, and applying, handlers for
760/// ErrorInfo types.
761template <typename HandlerT>
762class ErrorHandlerTraits
763 : public ErrorHandlerTraits<decltype(
764 &std::remove_reference<HandlerT>::type::operator())> {};
765
766// Specialization functions of the form 'Error (const ErrT&)'.
767template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
768public:
769 static bool appliesTo(const ErrorInfoBase &E) {
770 return E.template isA<ErrT>();
771 }
772
773 template <typename HandlerT>
774 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
775 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 775, __PRETTY_FUNCTION__))
;
776 return H(static_cast<ErrT &>(*E));
777 }
778};
779
780// Specialization functions of the form 'void (const ErrT&)'.
781template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
782public:
783 static bool appliesTo(const ErrorInfoBase &E) {
784 return E.template isA<ErrT>();
785 }
786
787 template <typename HandlerT>
788 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
789 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 789, __PRETTY_FUNCTION__))
;
790 H(static_cast<ErrT &>(*E));
791 return Error::success();
792 }
793};
794
795/// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'.
796template <typename ErrT>
797class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
798public:
799 static bool appliesTo(const ErrorInfoBase &E) {
800 return E.template isA<ErrT>();
801 }
802
803 template <typename HandlerT>
804 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
805 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 805, __PRETTY_FUNCTION__))
;
806 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
807 return H(std::move(SubE));
808 }
809};
810
811/// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'.
812template <typename ErrT>
813class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
814public:
815 static bool appliesTo(const ErrorInfoBase &E) {
816 return E.template isA<ErrT>();
817 }
818
819 template <typename HandlerT>
820 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
821 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 821, __PRETTY_FUNCTION__))
;
822 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
823 H(std::move(SubE));
824 return Error::success();
825 }
826};
827
828// Specialization for member functions of the form 'RetT (const ErrT&)'.
829template <typename C, typename RetT, typename ErrT>
830class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
831 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
832
833// Specialization for member functions of the form 'RetT (const ErrT&) const'.
834template <typename C, typename RetT, typename ErrT>
835class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
836 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
837
838// Specialization for member functions of the form 'RetT (const ErrT&)'.
839template <typename C, typename RetT, typename ErrT>
840class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
841 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
842
843// Specialization for member functions of the form 'RetT (const ErrT&) const'.
844template <typename C, typename RetT, typename ErrT>
845class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const>
846 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
847
848/// Specialization for member functions of the form
849/// 'RetT (std::unique_ptr<ErrT>)'.
850template <typename C, typename RetT, typename ErrT>
851class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)>
852 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
853
854/// Specialization for member functions of the form
855/// 'RetT (std::unique_ptr<ErrT>) const'.
856template <typename C, typename RetT, typename ErrT>
857class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
858 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
859
860inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
861 return Error(std::move(Payload));
862}
863
864template <typename HandlerT, typename... HandlerTs>
865Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload,
866 HandlerT &&Handler, HandlerTs &&... Handlers) {
867 if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload))
868 return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler),
869 std::move(Payload));
870 return handleErrorImpl(std::move(Payload),
871 std::forward<HandlerTs>(Handlers)...);
872}
873
874/// Pass the ErrorInfo(s) contained in E to their respective handlers. Any
875/// unhandled errors (or Errors returned by handlers) are re-concatenated and
876/// returned.
877/// Because this function returns an error, its result must also be checked
878/// or returned. If you intend to handle all errors use handleAllErrors
879/// (which returns void, and will abort() on unhandled errors) instead.
880template <typename... HandlerTs>
881Error handleErrors(Error E, HandlerTs &&... Hs) {
882 if (!E)
883 return Error::success();
884
885 std::unique_ptr<ErrorInfoBase> Payload = E.takePayload();
886
887 if (Payload->isA<ErrorList>()) {
888 ErrorList &List = static_cast<ErrorList &>(*Payload);
889 Error R;
890 for (auto &P : List.Payloads)
891 R = ErrorList::join(
892 std::move(R),
893 handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...));
894 return R;
895 }
896
897 return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...);
898}
899
900/// Behaves the same as handleErrors, except that by contract all errors
901/// *must* be handled by the given handlers (i.e. there must be no remaining
902/// errors after running the handlers, or llvm_unreachable is called).
903template <typename... HandlerTs>
904void handleAllErrors(Error E, HandlerTs &&... Handlers) {
905 cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...));
906}
907
908/// Check that E is a non-error, then drop it.
909/// If E is an error, llvm_unreachable will be called.
910inline void handleAllErrors(Error E) {
911 cantFail(std::move(E));
912}
913
914/// Handle any errors (if present) in an Expected<T>, then try a recovery path.
915///
916/// If the incoming value is a success value it is returned unmodified. If it
917/// is a failure value then it the contained error is passed to handleErrors.
918/// If handleErrors is able to handle the error then the RecoveryPath functor
919/// is called to supply the final result. If handleErrors is not able to
920/// handle all errors then the unhandled errors are returned.
921///
922/// This utility enables the follow pattern:
923///
924/// @code{.cpp}
925/// enum FooStrategy { Aggressive, Conservative };
926/// Expected<Foo> foo(FooStrategy S);
927///
928/// auto ResultOrErr =
929/// handleExpected(
930/// foo(Aggressive),
931/// []() { return foo(Conservative); },
932/// [](AggressiveStrategyError&) {
933/// // Implicitly conusme this - we'll recover by using a conservative
934/// // strategy.
935/// });
936///
937/// @endcode
938template <typename T, typename RecoveryFtor, typename... HandlerTs>
939Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath,
940 HandlerTs &&... Handlers) {
941 if (ValOrErr)
942 return ValOrErr;
943
944 if (auto Err = handleErrors(ValOrErr.takeError(),
945 std::forward<HandlerTs>(Handlers)...))
946 return std::move(Err);
947
948 return RecoveryPath();
949}
950
951/// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner
952/// will be printed before the first one is logged. A newline will be printed
953/// after each error.
954///
955/// This function is compatible with the helpers from Support/WithColor.h. You
956/// can pass any of them as the OS. Please consider using them instead of
957/// including 'error: ' in the ErrorBanner.
958///
959/// This is useful in the base level of your program to allow clean termination
960/// (allowing clean deallocation of resources, etc.), while reporting error
961/// information to the user.
962void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {});
963
964/// Write all error messages (if any) in E to a string. The newline character
965/// is used to separate error messages.
966inline std::string toString(Error E) {
967 SmallVector<std::string, 2> Errors;
968 handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) {
969 Errors.push_back(EI.message());
970 });
971 return join(Errors.begin(), Errors.end(), "\n");
972}
973
974/// Consume a Error without doing anything. This method should be used
975/// only where an error can be considered a reasonable and expected return
976/// value.
977///
978/// Uses of this method are potentially indicative of design problems: If it's
979/// legitimate to do nothing while processing an "error", the error-producer
980/// might be more clearly refactored to return an Optional<T>.
981inline void consumeError(Error Err) {
982 handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {});
983}
984
985/// Convert an Expected to an Optional without doing anything. This method
986/// should be used only where an error can be considered a reasonable and
987/// expected return value.
988///
989/// Uses of this method are potentially indicative of problems: perhaps the
990/// error should be propagated further, or the error-producer should just
991/// return an Optional in the first place.
992template <typename T> Optional<T> expectedToOptional(Expected<T> &&E) {
993 if (E)
994 return std::move(*E);
995 consumeError(E.takeError());
996 return None;
997}
998
999/// Helper for converting an Error to a bool.
1000///
1001/// This method returns true if Err is in an error state, or false if it is
1002/// in a success state. Puts Err in a checked state in both cases (unlike
1003/// Error::operator bool(), which only does this for success states).
1004inline bool errorToBool(Error Err) {
1005 bool IsError = static_cast<bool>(Err);
1006 if (IsError)
1007 consumeError(std::move(Err));
1008 return IsError;
1009}
1010
1011/// Helper for Errors used as out-parameters.
1012///
1013/// This helper is for use with the Error-as-out-parameter idiom, where an error
1014/// is passed to a function or method by reference, rather than being returned.
1015/// In such cases it is helpful to set the checked bit on entry to the function
1016/// so that the error can be written to (unchecked Errors abort on assignment)
1017/// and clear the checked bit on exit so that clients cannot accidentally forget
1018/// to check the result. This helper performs these actions automatically using
1019/// RAII:
1020///
1021/// @code{.cpp}
1022/// Result foo(Error &Err) {
1023/// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set
1024/// // <body of foo>
1025/// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed.
1026/// }
1027/// @endcode
1028///
1029/// ErrorAsOutParameter takes an Error* rather than Error& so that it can be
1030/// used with optional Errors (Error pointers that are allowed to be null). If
1031/// ErrorAsOutParameter took an Error reference, an instance would have to be
1032/// created inside every condition that verified that Error was non-null. By
1033/// taking an Error pointer we can just create one instance at the top of the
1034/// function.
1035class ErrorAsOutParameter {
1036public:
1037 ErrorAsOutParameter(Error *Err) : Err(Err) {
1038 // Raise the checked bit if Err is success.
1039 if (Err)
1040 (void)!!*Err;
1041 }
1042
1043 ~ErrorAsOutParameter() {
1044 // Clear the checked bit.
1045 if (Err && !*Err)
1046 *Err = Error::success();
1047 }
1048
1049private:
1050 Error *Err;
1051};
1052
1053/// Helper for Expected<T>s used as out-parameters.
1054///
1055/// See ErrorAsOutParameter.
1056template <typename T>
1057class ExpectedAsOutParameter {
1058public:
1059 ExpectedAsOutParameter(Expected<T> *ValOrErr)
1060 : ValOrErr(ValOrErr) {
1061 if (ValOrErr)
1062 (void)!!*ValOrErr;
1063 }
1064
1065 ~ExpectedAsOutParameter() {
1066 if (ValOrErr)
1067 ValOrErr->setUnchecked();
1068 }
1069
1070private:
1071 Expected<T> *ValOrErr;
1072};
1073
1074/// This class wraps a std::error_code in a Error.
1075///
1076/// This is useful if you're writing an interface that returns a Error
1077/// (or Expected) and you want to call code that still returns
1078/// std::error_codes.
1079class ECError : public ErrorInfo<ECError> {
1080 friend Error errorCodeToError(std::error_code);
1081
1082 virtual void anchor() override;
1083
1084public:
1085 void setErrorCode(std::error_code EC) { this->EC = EC; }
1086 std::error_code convertToErrorCode() const override { return EC; }
1087 void log(raw_ostream &OS) const override { OS << EC.message(); }
1088
1089 // Used by ErrorInfo::classID.
1090 static char ID;
1091
1092protected:
1093 ECError() = default;
1094 ECError(std::error_code EC) : EC(EC) {}
1095
1096 std::error_code EC;
1097};
1098
1099/// The value returned by this function can be returned from convertToErrorCode
1100/// for Error values where no sensible translation to std::error_code exists.
1101/// It should only be used in this situation, and should never be used where a
1102/// sensible conversion to std::error_code is available, as attempts to convert
1103/// to/from this error will result in a fatal error. (i.e. it is a programmatic
1104///error to try to convert such a value).
1105std::error_code inconvertibleErrorCode();
1106
1107/// Helper for converting an std::error_code to a Error.
1108Error errorCodeToError(std::error_code EC);
1109
1110/// Helper for converting an ECError to a std::error_code.
1111///
1112/// This method requires that Err be Error() or an ECError, otherwise it
1113/// will trigger a call to abort().
1114std::error_code errorToErrorCode(Error Err);
1115
1116/// Convert an ErrorOr<T> to an Expected<T>.
1117template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) {
1118 if (auto EC = EO.getError())
1119 return errorCodeToError(EC);
1120 return std::move(*EO);
1121}
1122
1123/// Convert an Expected<T> to an ErrorOr<T>.
1124template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) {
1125 if (auto Err = E.takeError())
1126 return errorToErrorCode(std::move(Err));
1127 return std::move(*E);
1128}
1129
1130/// This class wraps a string in an Error.
1131///
1132/// StringError is useful in cases where the client is not expected to be able
1133/// to consume the specific error message programmatically (for example, if the
1134/// error message is to be presented to the user).
1135///
1136/// StringError can also be used when additional information is to be printed
1137/// along with a error_code message. Depending on the constructor called, this
1138/// class can either display:
1139/// 1. the error_code message (ECError behavior)
1140/// 2. a string
1141/// 3. the error_code message and a string
1142///
1143/// These behaviors are useful when subtyping is required; for example, when a
1144/// specific library needs an explicit error type. In the example below,
1145/// PDBError is derived from StringError:
1146///
1147/// @code{.cpp}
1148/// Expected<int> foo() {
1149/// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading,
1150/// "Additional information");
1151/// }
1152/// @endcode
1153///
1154class StringError : public ErrorInfo<StringError> {
1155public:
1156 static char ID;
1157
1158 // Prints EC + S and converts to EC
1159 StringError(std::error_code EC, const Twine &S = Twine());
1160
1161 // Prints S and converts to EC
1162 StringError(const Twine &S, std::error_code EC);
1163
1164 void log(raw_ostream &OS) const override;
1165 std::error_code convertToErrorCode() const override;
1166
1167 const std::string &getMessage() const { return Msg; }
1168
1169private:
1170 std::string Msg;
1171 std::error_code EC;
1172 const bool PrintMsgOnly = false;
1173};
1174
1175/// Create formatted StringError object.
1176template <typename... Ts>
1177inline Error createStringError(std::error_code EC, char const *Fmt,
1178 const Ts &... Vals) {
1179 std::string Buffer;
1180 raw_string_ostream Stream(Buffer);
1181 Stream << format(Fmt, Vals...);
1182 return make_error<StringError>(Stream.str(), EC);
1183}
1184
1185Error createStringError(std::error_code EC, char const *Msg);
1186
1187inline Error createStringError(std::error_code EC, const Twine &S) {
1188 return createStringError(EC, S.str().c_str());
1189}
1190
1191template <typename... Ts>
1192inline Error createStringError(std::errc EC, char const *Fmt,
1193 const Ts &... Vals) {
1194 return createStringError(std::make_error_code(EC), Fmt, Vals...);
1195}
1196
1197/// This class wraps a filename and another Error.
1198///
1199/// In some cases, an error needs to live along a 'source' name, in order to
1200/// show more detailed information to the user.
1201class FileError final : public ErrorInfo<FileError> {
1202
1203 friend Error createFileError(const Twine &, Error);
1204 friend Error createFileError(const Twine &, size_t, Error);
1205
1206public:
1207 void log(raw_ostream &OS) const override {
1208 assert(Err && !FileName.empty() && "Trying to log after takeError().")((Err && !FileName.empty() && "Trying to log after takeError()."
) ? static_cast<void> (0) : __assert_fail ("Err && !FileName.empty() && \"Trying to log after takeError().\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 1208, __PRETTY_FUNCTION__))
;
1209 OS << "'" << FileName << "': ";
1210 if (Line.hasValue())
1211 OS << "line " << Line.getValue() << ": ";
1212 Err->log(OS);
1213 }
1214
1215 Error takeError() { return Error(std::move(Err)); }
1216
1217 std::error_code convertToErrorCode() const override;
1218
1219 // Used by ErrorInfo::classID.
1220 static char ID;
1221
1222private:
1223 FileError(const Twine &F, Optional<size_t> LineNum,
1224 std::unique_ptr<ErrorInfoBase> E) {
1225 assert(E && "Cannot create FileError from Error success value.")((E && "Cannot create FileError from Error success value."
) ? static_cast<void> (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 1225, __PRETTY_FUNCTION__))
;
1226 assert(!F.isTriviallyEmpty() &&((!F.isTriviallyEmpty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.isTriviallyEmpty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 1227, __PRETTY_FUNCTION__))
1227 "The file name provided to FileError must not be empty.")((!F.isTriviallyEmpty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.isTriviallyEmpty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-10~svn374877/include/llvm/Support/Error.h"
, 1227, __PRETTY_FUNCTION__))
;
1228 FileName = F.str();
1229 Err = std::move(E);
1230 Line = std::move(LineNum);
1231 }
1232
1233 static Error build(const Twine &F, Optional<size_t> Line, Error E) {
1234 return Error(
1235 std::unique_ptr<FileError>(new FileError(F, Line, E.takePayload())));
1236 }
1237
1238 std::string FileName;
1239 Optional<size_t> Line;
1240 std::unique_ptr<ErrorInfoBase> Err;
1241};
1242
1243/// Concatenate a source file path and/or name with an Error. The resulting
1244/// Error is unchecked.
1245inline Error createFileError(const Twine &F, Error E) {
1246 return FileError::build(F, Optional<size_t>(), std::move(E));
1247}
1248
1249/// Concatenate a source file path and/or name with line number and an Error.
1250/// The resulting Error is unchecked.
1251inline Error createFileError(const Twine &F, size_t Line, Error E) {
1252 return FileError::build(F, Optional<size_t>(Line), std::move(E));
1253}
1254
1255/// Concatenate a source file path and/or name with a std::error_code
1256/// to form an Error object.
1257inline Error createFileError(const Twine &F, std::error_code EC) {
1258 return createFileError(F, errorCodeToError(EC));
1259}
1260
1261/// Concatenate a source file path and/or name with line number and
1262/// std::error_code to form an Error object.
1263inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) {
1264 return createFileError(F, Line, errorCodeToError(EC));
1265}
1266
1267Error createFileError(const Twine &F, ErrorSuccess) = delete;
1268
1269/// Helper for check-and-exit error handling.
1270///
1271/// For tool use only. NOT FOR USE IN LIBRARY CODE.
1272///
1273class ExitOnError {
1274public:
1275 /// Create an error on exit helper.
1276 ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1)
1277 : Banner(std::move(Banner)),
1278 GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {}
1279
1280 /// Set the banner string for any errors caught by operator().
1281 void setBanner(std::string Banner) { this->Banner = std::move(Banner); }
1282
1283 /// Set the exit-code mapper function.
1284 void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) {
1285 this->GetExitCode = std::move(GetExitCode);
1286 }
1287
1288 /// Check Err. If it's in a failure state log the error(s) and exit.
1289 void operator()(Error Err) const { checkError(std::move(Err)); }
1290
1291 /// Check E. If it's in a success state then return the contained value. If
1292 /// it's in a failure state log the error(s) and exit.
1293 template <typename T> T operator()(Expected<T> &&E) const {
1294 checkError(E.takeError());
1295 return std::move(*E);
1296 }
1297
1298 /// Check E. If it's in a success state then return the contained reference. If
1299 /// it's in a failure state log the error(s) and exit.
1300 template <typename T> T& operator()(Expected<T&> &&E) const {
1301 checkError(E.takeError());
1302 return *E;
1303 }
1304
1305private:
1306 void checkError(Error Err) const {
1307 if (Err) {
1308 int ExitCode = GetExitCode(Err);
1309 logAllUnhandledErrors(std::move(Err), errs(), Banner);
1310 exit(ExitCode);
1311 }
1312 }
1313
1314 std::string Banner;
1315 std::function<int(const Error &)> GetExitCode;
1316};
1317
1318/// Conversion from Error to LLVMErrorRef for C error bindings.
1319inline LLVMErrorRef wrap(Error Err) {
1320 return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1321}
1322
1323/// Conversion from LLVMErrorRef to Error for C error bindings.
1324inline Error unwrap(LLVMErrorRef ErrRef) {
1325 return Error(std::unique_ptr<ErrorInfoBase>(
1326 reinterpret_cast<ErrorInfoBase *>(ErrRef)));
1327}
1328
1329} // end namespace llvm
1330
1331#endif // LLVM_SUPPORT_ERROR_H