Bug Summary

File:llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp
Warning:line 80, column 12
Moved-from object 'Err' is moved

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name EPCGenericJITLinkMemoryManager.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 -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -fmath-errno -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/build-llvm -resource-dir /usr/lib/llvm-14/lib/clang/14.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I lib/ExecutionEngine/Orc -I /build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc -I include -I /build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-14/lib/clang/14.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-command-line-argument -Wno-unknown-warning-option -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/build-llvm -ferror-limit 19 -fvisibility-inlines-hidden -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2021-10-08-160937-45717-1 -x c++ /build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp

/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp

→
1//===---- EPCGenericJITLinkMemoryManager.cpp -- Mem management via EPC ----===//
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 "llvm/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.h"
10#include "llvm/ExecutionEngine/Orc/LookupAndRecordAddrs.h"
11#include "llvm/ExecutionEngine/Orc/Shared/OrcRTBridge.h"
12
13#include <limits>
14
15namespace llvm {
16namespace orc {
17
18class EPCGenericJITLinkMemoryManager::Alloc
19 : public jitlink::JITLinkMemoryManager::Allocation {
20public:
21 struct SegInfo {
22 char *WorkingMem = nullptr;
23 ExecutorAddr TargetAddr;
24 uint64_t ContentSize = 0;
25 uint64_t ZeroFillSize = 0;
26 };
27 using SegInfoMap = DenseMap<unsigned, SegInfo>;
28
29 Alloc(EPCGenericJITLinkMemoryManager &Parent, ExecutorAddr TargetAddr,
30 std::unique_ptr<char[]> WorkingBuffer, SegInfoMap Segs)
31 : Parent(Parent), TargetAddr(TargetAddr),
32 WorkingBuffer(std::move(WorkingBuffer)), Segs(std::move(Segs)) {}
33
34 MutableArrayRef<char> getWorkingMemory(ProtectionFlags Seg) override {
35 auto I = Segs.find(Seg);
36 assert(I != Segs.end() && "No allocation for seg")(static_cast <bool> (I != Segs.end() && "No allocation for seg"
) ? void (0) : __assert_fail ("I != Segs.end() && \"No allocation for seg\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp"
, 36, __extension__ __PRETTY_FUNCTION__));
37 assert(I->second.ContentSize <= std::numeric_limits<size_t>::max())(static_cast <bool> (I->second.ContentSize <= std
::numeric_limits<size_t>::max()) ? void (0) : __assert_fail
("I->second.ContentSize <= std::numeric_limits<size_t>::max()"
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp"
, 37, __extension__ __PRETTY_FUNCTION__));
38 return {I->second.WorkingMem, static_cast<size_t>(I->second.ContentSize)};
39 }
40
41 JITTargetAddress getTargetMemory(ProtectionFlags Seg) override {
42 auto I = Segs.find(Seg);
43 assert(I != Segs.end() && "No allocation for seg")(static_cast <bool> (I != Segs.end() && "No allocation for seg"
) ? void (0) : __assert_fail ("I != Segs.end() && \"No allocation for seg\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp"
, 43, __extension__ __PRETTY_FUNCTION__));
44 return I->second.TargetAddr.getValue();
45 }
46
47 void finalizeAsync(FinalizeContinuation OnFinalize) override {
48 char *WorkingMem = WorkingBuffer.get();
49 tpctypes::FinalizeRequest FR;
50 for (auto &KV : Segs) {
51 assert(KV.second.ContentSize <= std::numeric_limits<size_t>::max())(static_cast <bool> (KV.second.ContentSize <= std::numeric_limits
<size_t>::max()) ? void (0) : __assert_fail ("KV.second.ContentSize <= std::numeric_limits<size_t>::max()"
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/lib/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.cpp"
, 51, __extension__ __PRETTY_FUNCTION__));
52 FR.Segments.push_back(tpctypes::SegFinalizeRequest{
53 tpctypes::toWireProtectionFlags(
54 static_cast<sys::Memory::ProtectionFlags>(KV.first)),
55 KV.second.TargetAddr,
56 alignTo(KV.second.ContentSize + KV.second.ZeroFillSize,
57 Parent.EPC.getPageSize()),
58 {WorkingMem, static_cast<size_t>(KV.second.ContentSize)}});
59 WorkingMem += KV.second.ContentSize;
60 }
61 Parent.EPC.callSPSWrapperAsync<
62 rt::SPSSimpleExecutorMemoryManagerFinalizeSignature>(
63 [OnFinalize = std::move(OnFinalize)](Error SerializationErr,
64 Error FinalizeErr) {
65 if (SerializationErr)
66 OnFinalize(std::move(SerializationErr));
67 else
68 OnFinalize(std::move(FinalizeErr));
69 },
70 Parent.SAs.Finalize, Parent.SAs.Allocator, std::move(FR));
71 }
72
73 Error deallocate() override {
74 Error Err = Error::success();
75 if (auto E2 = Parent.EPC.callSPSWrapper<
1
Calling 'ExecutorProcessControl::callSPSWrapper'
→
10
←
Returning from 'ExecutorProcessControl::callSPSWrapper'
→
11
←
Assuming the condition is false
→
12
←
Taking false branch
→
76 rt::SPSSimpleExecutorMemoryManagerDeallocateSignature>(
77 Parent.SAs.Deallocate, Err, Parent.SAs.Allocator,
78 ArrayRef<ExecutorAddr>(TargetAddr)))
79 return E2;
80 return Err;
13
←
Moved-from object 'Err' is moved
81 }
82
83private:
84 EPCGenericJITLinkMemoryManager &Parent;
85 ExecutorAddr TargetAddr;
86 std::unique_ptr<char[]> WorkingBuffer;
87 SegInfoMap Segs;
88};
89
90Expected<std::unique_ptr<jitlink::JITLinkMemoryManager::Allocation>>
91EPCGenericJITLinkMemoryManager::allocate(const jitlink::JITLinkDylib *JD,
92 const SegmentsRequestMap &Request) {
93 Alloc::SegInfoMap Segs;
94 uint64_t AllocSize = 0;
95 size_t WorkingSize = 0;
96 for (auto &KV : Request) {
97 if (!isPowerOf2_64(KV.second.getAlignment()))
98 return make_error<StringError>("Alignment is not a power of two",
99 inconvertibleErrorCode());
100 if (KV.second.getAlignment() > EPC.getPageSize())
101 return make_error<StringError>("Alignment exceeds page size",
102 inconvertibleErrorCode());
103
104 auto &Seg = Segs[KV.first];
105 Seg.ContentSize = KV.second.getContentSize();
106 Seg.ZeroFillSize = KV.second.getZeroFillSize();
107 AllocSize += alignTo(Seg.ContentSize + Seg.ZeroFillSize, EPC.getPageSize());
108 WorkingSize += Seg.ContentSize;
109 }
110
111 std::unique_ptr<char[]> WorkingBuffer;
112 if (WorkingSize > 0)
113 WorkingBuffer = std::make_unique<char[]>(WorkingSize);
114 Expected<ExecutorAddr> TargetAllocAddr((ExecutorAddr()));
115 if (auto Err = EPC.callSPSWrapper<
116 rt::SPSSimpleExecutorMemoryManagerReserveSignature>(
117 SAs.Reserve, TargetAllocAddr, SAs.Allocator, AllocSize))
118 return std::move(Err);
119 if (!TargetAllocAddr)
120 return TargetAllocAddr.takeError();
121
122 char *WorkingMem = WorkingBuffer.get();
123 JITTargetAddress SegAddr = TargetAllocAddr->getValue();
124 for (auto &KV : Segs) {
125 auto &Seg = KV.second;
126 Seg.TargetAddr.setValue(SegAddr);
127 SegAddr += alignTo(Seg.ContentSize + Seg.ZeroFillSize, EPC.getPageSize());
128 Seg.WorkingMem = WorkingMem;
129 WorkingMem += Seg.ContentSize;
130 }
131
132 return std::make_unique<Alloc>(*this, *TargetAllocAddr,
133 std::move(WorkingBuffer), std::move(Segs));
134}
135
136} // end namespace orc
137} // end namespace llvm
←

/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h

→
1//===- ExecutorProcessControl.h - Executor process control APIs -*- 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// Utilities for interacting with the executor processes.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_ORC_EXECUTORPROCESSCONTROL_H
14#define LLVM_EXECUTIONENGINE_ORC_EXECUTORPROCESSCONTROL_H
15
16#include "llvm/ADT/StringRef.h"
17#include "llvm/ADT/Triple.h"
18#include "llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h"
19#include "llvm/ExecutionEngine/Orc/Shared/ExecutorAddress.h"
20#include "llvm/ExecutionEngine/Orc/Shared/TargetProcessControlTypes.h"
21#include "llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
22#include "llvm/ExecutionEngine/Orc/SymbolStringPool.h"
23#include "llvm/Support/DynamicLibrary.h"
24#include "llvm/Support/MSVCErrorWorkarounds.h"
25
26#include <future>
27#include <mutex>
28#include <vector>
29
30namespace llvm {
31namespace orc {
32
33class ExecutionSession;
34class SymbolLookupSet;
35
36/// ExecutorProcessControl supports interaction with a JIT target process.
37class ExecutorProcessControl {
38 friend class ExecutionSession;
39
40public:
41 /// Sender to return the result of a WrapperFunction executed in the JIT.
42 using SendResultFunction =
43 unique_function<void(shared::WrapperFunctionResult)>;
44
45 /// APIs for manipulating memory in the target process.
46 class MemoryAccess {
47 public:
48 /// Callback function for asynchronous writes.
49 using WriteResultFn = unique_function<void(Error)>;
50
51 virtual ~MemoryAccess();
52
53 virtual void writeUInt8sAsync(ArrayRef<tpctypes::UInt8Write> Ws,
54 WriteResultFn OnWriteComplete) = 0;
55
56 virtual void writeUInt16sAsync(ArrayRef<tpctypes::UInt16Write> Ws,
57 WriteResultFn OnWriteComplete) = 0;
58
59 virtual void writeUInt32sAsync(ArrayRef<tpctypes::UInt32Write> Ws,
60 WriteResultFn OnWriteComplete) = 0;
61
62 virtual void writeUInt64sAsync(ArrayRef<tpctypes::UInt64Write> Ws,
63 WriteResultFn OnWriteComplete) = 0;
64
65 virtual void writeBuffersAsync(ArrayRef<tpctypes::BufferWrite> Ws,
66 WriteResultFn OnWriteComplete) = 0;
67
68 Error writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws) {
69 std::promise<MSVCPError> ResultP;
70 auto ResultF = ResultP.get_future();
71 writeUInt8sAsync(Ws,
72 [&](Error Err) { ResultP.set_value(std::move(Err)); });
73 return ResultF.get();
74 }
75
76 Error writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws) {
77 std::promise<MSVCPError> ResultP;
78 auto ResultF = ResultP.get_future();
79 writeUInt16sAsync(Ws,
80 [&](Error Err) { ResultP.set_value(std::move(Err)); });
81 return ResultF.get();
82 }
83
84 Error writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws) {
85 std::promise<MSVCPError> ResultP;
86 auto ResultF = ResultP.get_future();
87 writeUInt32sAsync(Ws,
88 [&](Error Err) { ResultP.set_value(std::move(Err)); });
89 return ResultF.get();
90 }
91
92 Error writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws) {
93 std::promise<MSVCPError> ResultP;
94 auto ResultF = ResultP.get_future();
95 writeUInt64sAsync(Ws,
96 [&](Error Err) { ResultP.set_value(std::move(Err)); });
97 return ResultF.get();
98 }
99
100 Error writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws) {
101 std::promise<MSVCPError> ResultP;
102 auto ResultF = ResultP.get_future();
103 writeBuffersAsync(Ws,
104 [&](Error Err) { ResultP.set_value(std::move(Err)); });
105 return ResultF.get();
106 }
107 };
108
109 /// A pair of a dylib and a set of symbols to be looked up.
110 struct LookupRequest {
111 LookupRequest(tpctypes::DylibHandle Handle, const SymbolLookupSet &Symbols)
112 : Handle(Handle), Symbols(Symbols) {}
113 tpctypes::DylibHandle Handle;
114 const SymbolLookupSet &Symbols;
115 };
116
117 /// Contains the address of the dispatch function and context that the ORC
118 /// runtime can use to call functions in the JIT.
119 struct JITDispatchInfo {
120 ExecutorAddr JITDispatchFunction;
121 ExecutorAddr JITDispatchContext;
122 };
123
124 virtual ~ExecutorProcessControl();
125
126 /// Return the ExecutionSession associated with this instance.
127 /// Not callable until the ExecutionSession has been associated.
128 ExecutionSession &getExecutionSession() {
129 assert(ES && "No ExecutionSession associated yet")(static_cast <bool> (ES && "No ExecutionSession associated yet"
) ? void (0) : __assert_fail ("ES && \"No ExecutionSession associated yet\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 129, __extension__ __PRETTY_FUNCTION__));
130 return *ES;
131 }
132
133 /// Intern a symbol name in the SymbolStringPool.
134 SymbolStringPtr intern(StringRef SymName) { return SSP->intern(SymName); }
135
136 /// Return a shared pointer to the SymbolStringPool for this instance.
137 std::shared_ptr<SymbolStringPool> getSymbolStringPool() const { return SSP; }
138
139 /// Return the Triple for the target process.
140 const Triple &getTargetTriple() const { return TargetTriple; }
141
142 /// Get the page size for the target process.
143 unsigned getPageSize() const { return PageSize; }
144
145 /// Get the JIT dispatch function and context address for the executor.
146 const JITDispatchInfo &getJITDispatchInfo() const { return JDI; }
147
148 /// Return a MemoryAccess object for the target process.
149 MemoryAccess &getMemoryAccess() const {
150 assert(MemAccess && "No MemAccess object set.")(static_cast <bool> (MemAccess && "No MemAccess object set."
) ? void (0) : __assert_fail ("MemAccess && \"No MemAccess object set.\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 150, __extension__ __PRETTY_FUNCTION__));
151 return *MemAccess;
152 }
153
154 /// Return a JITLinkMemoryManager for the target process.
155 jitlink::JITLinkMemoryManager &getMemMgr() const {
156 assert(MemMgr && "No MemMgr object set")(static_cast <bool> (MemMgr && "No MemMgr object set"
) ? void (0) : __assert_fail ("MemMgr && \"No MemMgr object set\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 156, __extension__ __PRETTY_FUNCTION__));
157 return *MemMgr;
158 }
159
160 /// Returns the bootstrap symbol map.
161 const StringMap<ExecutorAddr> &getBootstrapSymbolsMap() const {
162 return BootstrapSymbols;
163 }
164
165 /// For each (ExecutorAddr&, StringRef) pair, looks up the string in the
166 /// bootstrap symbols map and writes its address to the ExecutorAddr if
167 /// found. If any symbol is not found then the function returns an error.
168 Error getBootstrapSymbols(
169 ArrayRef<std::pair<ExecutorAddr &, StringRef>> Pairs) const {
170 for (auto &KV : Pairs) {
171 auto I = BootstrapSymbols.find(KV.second);
172 if (I == BootstrapSymbols.end())
173 return make_error<StringError>("Symbol \"" + KV.second +
174 "\" not found "
175 "in bootstrap symbols map",
176 inconvertibleErrorCode());
177
178 KV.first = I->second;
179 }
180 return Error::success();
181 }
182
183 /// Load the dynamic library at the given path and return a handle to it.
184 /// If LibraryPath is null this function will return the global handle for
185 /// the target process.
186 virtual Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) = 0;
187
188 /// Search for symbols in the target process.
189 ///
190 /// The result of the lookup is a 2-dimentional array of target addresses
191 /// that correspond to the lookup order. If a required symbol is not
192 /// found then this method will return an error. If a weakly referenced
193 /// symbol is not found then it be assigned a '0' value.
194 virtual Expected<std::vector<tpctypes::LookupResult>>
195 lookupSymbols(ArrayRef<LookupRequest> Request) = 0;
196
197 /// Run function with a main-like signature.
198 virtual Expected<int32_t> runAsMain(ExecutorAddr MainFnAddr,
199 ArrayRef<std::string> Args) = 0;
200
201 /// Run a wrapper function in the executor.
202 ///
203 /// The wrapper function should be callable as:
204 ///
205 /// \code{.cpp}
206 /// CWrapperFunctionResult fn(uint8_t *Data, uint64_t Size);
207 /// \endcode{.cpp}
208 ///
209 /// The given OnComplete function will be called to return the result.
210 virtual void callWrapperAsync(SendResultFunction OnComplete,
211 ExecutorAddr WrapperFnAddr,
212 ArrayRef<char> ArgBuffer) = 0;
213
214 /// Run a wrapper function in the executor. The wrapper function should be
215 /// callable as:
216 ///
217 /// \code{.cpp}
218 /// CWrapperFunctionResult fn(uint8_t *Data, uint64_t Size);
219 /// \endcode{.cpp}
220 shared::WrapperFunctionResult callWrapper(ExecutorAddr WrapperFnAddr,
221 ArrayRef<char> ArgBuffer) {
222 std::promise<shared::WrapperFunctionResult> RP;
223 auto RF = RP.get_future();
224 callWrapperAsync(
225 [&](shared::WrapperFunctionResult R) { RP.set_value(std::move(R)); },
226 WrapperFnAddr, ArgBuffer);
227 return RF.get();
228 }
229
230 /// Run a wrapper function using SPS to serialize the arguments and
231 /// deserialize the results.
232 template <typename SPSSignature, typename SendResultT, typename... ArgTs>
233 void callSPSWrapperAsync(SendResultT &&SendResult, ExecutorAddr WrapperFnAddr,
234 const ArgTs &...Args) {
235 shared::WrapperFunction<SPSSignature>::callAsync(
236 [this,
237 WrapperFnAddr](ExecutorProcessControl::SendResultFunction SendResult,
238 const char *ArgData, size_t ArgSize) {
239 callWrapperAsync(std::move(SendResult), WrapperFnAddr,
240 ArrayRef<char>(ArgData, ArgSize));
241 },
242 std::move(SendResult), Args...);
243 }
244
245 /// Run a wrapper function using SPS to serialize the arguments and
246 /// deserialize the results.
247 ///
248 /// If SPSSignature is a non-void function signature then the second argument
249 /// (the first in the Args list) should be a reference to a return value.
250 template <typename SPSSignature, typename... WrapperCallArgTs>
251 Error callSPSWrapper(ExecutorAddr WrapperFnAddr,
252 WrapperCallArgTs &&...WrapperCallArgs) {
253 return shared::WrapperFunction<SPSSignature>::call(
2
←
Calling 'WrapperFunction::call'
→
9
←
Returning from 'WrapperFunction::call'
→
254 [this, WrapperFnAddr](const char *ArgData, size_t ArgSize) {
255 return callWrapper(WrapperFnAddr, ArrayRef<char>(ArgData, ArgSize));
256 },
257 std::forward<WrapperCallArgTs>(WrapperCallArgs)...);
258 }
259
260 /// Disconnect from the target process.
261 ///
262 /// This should be called after the JIT session is shut down.
263 virtual Error disconnect() = 0;
264
265protected:
266 ExecutorProcessControl(std::shared_ptr<SymbolStringPool> SSP)
267 : SSP(std::move(SSP)) {}
268
269 std::shared_ptr<SymbolStringPool> SSP;
270 ExecutionSession *ES = nullptr;
271 Triple TargetTriple;
272 unsigned PageSize = 0;
273 JITDispatchInfo JDI;
274 MemoryAccess *MemAccess = nullptr;
275 jitlink::JITLinkMemoryManager *MemMgr = nullptr;
276 StringMap<ExecutorAddr> BootstrapSymbols;
277};
278
279/// A ExecutorProcessControl instance that asserts if any of its methods are
280/// used. Suitable for use is unit tests, and by ORC clients who haven't moved
281/// to ExecutorProcessControl-based APIs yet.
282class UnsupportedExecutorProcessControl : public ExecutorProcessControl {
283public:
284 UnsupportedExecutorProcessControl(
285 std::shared_ptr<SymbolStringPool> SSP = nullptr,
286 const std::string &TT = "", unsigned PageSize = 0)
287 : ExecutorProcessControl(SSP ? std::move(SSP)
288 : std::make_shared<SymbolStringPool>()) {
289 this->TargetTriple = Triple(TT);
290 this->PageSize = PageSize;
291 }
292
293 Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) override {
294 llvm_unreachable("Unsupported")::llvm::llvm_unreachable_internal("Unsupported", "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 294);
295 }
296
297 Expected<std::vector<tpctypes::LookupResult>>
298 lookupSymbols(ArrayRef<LookupRequest> Request) override {
299 llvm_unreachable("Unsupported")::llvm::llvm_unreachable_internal("Unsupported", "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 299);
300 }
301
302 Expected<int32_t> runAsMain(ExecutorAddr MainFnAddr,
303 ArrayRef<std::string> Args) override {
304 llvm_unreachable("Unsupported")::llvm::llvm_unreachable_internal("Unsupported", "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 304);
305 }
306
307 void callWrapperAsync(SendResultFunction OnComplete,
308 ExecutorAddr WrapperFnAddr,
309 ArrayRef<char> ArgBuffer) override {
310 llvm_unreachable("Unsupported")::llvm::llvm_unreachable_internal("Unsupported", "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
, 310);
311 }
312
313 Error disconnect() override { return Error::success(); }
314};
315
316/// A ExecutorProcessControl implementation targeting the current process.
317class SelfExecutorProcessControl
318 : public ExecutorProcessControl,
319 private ExecutorProcessControl::MemoryAccess {
320public:
321 SelfExecutorProcessControl(
322 std::shared_ptr<SymbolStringPool> SSP, Triple TargetTriple,
323 unsigned PageSize, std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr);
324
325 /// Create a SelfExecutorProcessControl with the given symbol string pool and
326 /// memory manager.
327 /// If no symbol string pool is given then one will be created.
328 /// If no memory manager is given a jitlink::InProcessMemoryManager will
329 /// be created and used by default.
330 static Expected<std::unique_ptr<SelfExecutorProcessControl>>
331 Create(std::shared_ptr<SymbolStringPool> SSP = nullptr,
332 std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr = nullptr);
333
334 Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) override;
335
336 Expected<std::vector<tpctypes::LookupResult>>
337 lookupSymbols(ArrayRef<LookupRequest> Request) override;
338
339 Expected<int32_t> runAsMain(ExecutorAddr MainFnAddr,
340 ArrayRef<std::string> Args) override;
341
342 void callWrapperAsync(SendResultFunction OnComplete,
343 ExecutorAddr WrapperFnAddr,
344 ArrayRef<char> ArgBuffer) override;
345
346 Error disconnect() override;
347
348private:
349 void writeUInt8sAsync(ArrayRef<tpctypes::UInt8Write> Ws,
350 WriteResultFn OnWriteComplete) override;
351
352 void writeUInt16sAsync(ArrayRef<tpctypes::UInt16Write> Ws,
353 WriteResultFn OnWriteComplete) override;
354
355 void writeUInt32sAsync(ArrayRef<tpctypes::UInt32Write> Ws,
356 WriteResultFn OnWriteComplete) override;
357
358 void writeUInt64sAsync(ArrayRef<tpctypes::UInt64Write> Ws,
359 WriteResultFn OnWriteComplete) override;
360
361 void writeBuffersAsync(ArrayRef<tpctypes::BufferWrite> Ws,
362 WriteResultFn OnWriteComplete) override;
363
364 static shared::detail::CWrapperFunctionResult
365 jitDispatchViaWrapperFunctionManager(void *Ctx, const void *FnTag,
366 const char *Data, size_t Size);
367
368 std::unique_ptr<jitlink::JITLinkMemoryManager> OwnedMemMgr;
369 char GlobalManglingPrefix = 0;
370 std::vector<std::unique_ptr<sys::DynamicLibrary>> DynamicLibraries;
371};
372
373} // end namespace orc
374} // end namespace llvm
375
376#endif // LLVM_EXECUTIONENGINE_ORC_EXECUTORPROCESSCONTROL_H
←

/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h

→
1//===- WrapperFunctionUtils.h - Utilities for wrapper functions -*- 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// A buffer for serialized results.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_ORC_SHARED_WRAPPERFUNCTIONUTILS_H
14#define LLVM_EXECUTIONENGINE_ORC_SHARED_WRAPPERFUNCTIONUTILS_H
15
16#include "llvm/ExecutionEngine/Orc/Shared/ExecutorAddress.h"
17#include "llvm/ExecutionEngine/Orc/Shared/SimplePackedSerialization.h"
18#include "llvm/Support/Error.h"
19
20#include <type_traits>
21
22namespace llvm {
23namespace orc {
24namespace shared {
25
26namespace detail {
27
28// DO NOT USE DIRECTLY.
29// Must be kept in-sync with compiler-rt/lib/orc/c-api.h.
30union CWrapperFunctionResultDataUnion {
31 char *ValuePtr;
32 char Value[sizeof(ValuePtr)];
33};
34
35// DO NOT USE DIRECTLY.
36// Must be kept in-sync with compiler-rt/lib/orc/c-api.h.
37typedef struct {
38 CWrapperFunctionResultDataUnion Data;
39 size_t Size;
40} CWrapperFunctionResult;
41
42} // end namespace detail
43
44/// C++ wrapper function result: Same as CWrapperFunctionResult but
45/// auto-releases memory.
46class WrapperFunctionResult {
47public:
48 /// Create a default WrapperFunctionResult.
49 WrapperFunctionResult() { init(R); }
50
51 /// Create a WrapperFunctionResult by taking ownership of a
52 /// detail::CWrapperFunctionResult.
53 ///
54 /// Warning: This should only be used by clients writing wrapper-function
55 /// caller utilities (like TargetProcessControl).
56 WrapperFunctionResult(detail::CWrapperFunctionResult R) : R(R) {
57 // Reset R.
58 init(R);
59 }
60
61 WrapperFunctionResult(const WrapperFunctionResult &) = delete;
62 WrapperFunctionResult &operator=(const WrapperFunctionResult &) = delete;
63
64 WrapperFunctionResult(WrapperFunctionResult &&Other) {
65 init(R);
66 std::swap(R, Other.R);
67 }
68
69 WrapperFunctionResult &operator=(WrapperFunctionResult &&Other) {
70 WrapperFunctionResult Tmp(std::move(Other));
71 std::swap(R, Tmp.R);
72 return *this;
73 }
74
75 ~WrapperFunctionResult() {
76 if ((R.Size > sizeof(R.Data.Value)) ||
77 (R.Size == 0 && R.Data.ValuePtr != nullptr))
78 free(R.Data.ValuePtr);
79 }
80
81 /// Release ownership of the contained detail::CWrapperFunctionResult.
82 /// Warning: Do not use -- this method will be removed in the future. It only
83 /// exists to temporarily support some code that will eventually be moved to
84 /// the ORC runtime.
85 detail::CWrapperFunctionResult release() {
86 detail::CWrapperFunctionResult Tmp;
87 init(Tmp);
88 std::swap(R, Tmp);
89 return Tmp;
90 }
91
92 /// Get a pointer to the data contained in this instance.
93 char *data() {
94 assert((R.Size != 0 || R.Data.ValuePtr == nullptr) &&(static_cast <bool> ((R.Size != 0 || R.Data.ValuePtr ==
nullptr) && "Cannot get data for out-of-band error value"
) ? void (0) : __assert_fail ("(R.Size != 0 || R.Data.ValuePtr == nullptr) && \"Cannot get data for out-of-band error value\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
, 95, __extension__ __PRETTY_FUNCTION__))
95 "Cannot get data for out-of-band error value")(static_cast <bool> ((R.Size != 0 || R.Data.ValuePtr ==
nullptr) && "Cannot get data for out-of-band error value"
) ? void (0) : __assert_fail ("(R.Size != 0 || R.Data.ValuePtr == nullptr) && \"Cannot get data for out-of-band error value\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
, 95, __extension__ __PRETTY_FUNCTION__));
96 return R.Size > sizeof(R.Data.Value) ? R.Data.ValuePtr : R.Data.Value;
97 }
98
99 /// Get a const pointer to the data contained in this instance.
100 const char *data() const {
101 assert((R.Size != 0 || R.Data.ValuePtr == nullptr) &&(static_cast <bool> ((R.Size != 0 || R.Data.ValuePtr ==
nullptr) && "Cannot get data for out-of-band error value"
) ? void (0) : __assert_fail ("(R.Size != 0 || R.Data.ValuePtr == nullptr) && \"Cannot get data for out-of-band error value\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
, 102, __extension__ __PRETTY_FUNCTION__))
102 "Cannot get data for out-of-band error value")(static_cast <bool> ((R.Size != 0 || R.Data.ValuePtr ==
nullptr) && "Cannot get data for out-of-band error value"
) ? void (0) : __assert_fail ("(R.Size != 0 || R.Data.ValuePtr == nullptr) && \"Cannot get data for out-of-band error value\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
, 102, __extension__ __PRETTY_FUNCTION__));
103 return R.Size > sizeof(R.Data.Value) ? R.Data.ValuePtr : R.Data.Value;
104 }
105
106 /// Returns the size of the data contained in this instance.
107 size_t size() const {
108 assert((R.Size != 0 || R.Data.ValuePtr == nullptr) &&(static_cast <bool> ((R.Size != 0 || R.Data.ValuePtr ==
nullptr) && "Cannot get data for out-of-band error value"
) ? void (0) : __assert_fail ("(R.Size != 0 || R.Data.ValuePtr == nullptr) && \"Cannot get data for out-of-band error value\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
, 109, __extension__ __PRETTY_FUNCTION__))
109 "Cannot get data for out-of-band error value")(static_cast <bool> ((R.Size != 0 || R.Data.ValuePtr ==
nullptr) && "Cannot get data for out-of-band error value"
) ? void (0) : __assert_fail ("(R.Size != 0 || R.Data.ValuePtr == nullptr) && \"Cannot get data for out-of-band error value\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h"
, 109, __extension__ __PRETTY_FUNCTION__));
110 return R.Size;
111 }
112
113 /// Returns true if this value is equivalent to a default-constructed
114 /// WrapperFunctionResult.
115 bool empty() const { return R.Size == 0 && R.Data.ValuePtr == nullptr; }
116
117 /// Create a WrapperFunctionResult with the given size and return a pointer
118 /// to the underlying memory.
119 static WrapperFunctionResult allocate(size_t Size) {
120 // Reset.
121 WrapperFunctionResult WFR;
122 WFR.R.Size = Size;
123 if (WFR.R.Size > sizeof(WFR.R.Data.Value))
124 WFR.R.Data.ValuePtr = (char *)malloc(WFR.R.Size);
125 return WFR;
126 }
127
128 /// Copy from the given char range.
129 static WrapperFunctionResult copyFrom(const char *Source, size_t Size) {
130 auto WFR = allocate(Size);
131 memcpy(WFR.data(), Source, Size);
132 return WFR;
133 }
134
135 /// Copy from the given null-terminated string (includes the null-terminator).
136 static WrapperFunctionResult copyFrom(const char *Source) {
137 return copyFrom(Source, strlen(Source) + 1);
138 }
139
140 /// Copy from the given std::string (includes the null terminator).
141 static WrapperFunctionResult copyFrom(const std::string &Source) {
142 return copyFrom(Source.c_str());
143 }
144
145 /// Create an out-of-band error by copying the given string.
146 static WrapperFunctionResult createOutOfBandError(const char *Msg) {
147 // Reset.
148 WrapperFunctionResult WFR;
149 char *Tmp = (char *)malloc(strlen(Msg) + 1);
150 strcpy(Tmp, Msg);
151 WFR.R.Data.ValuePtr = Tmp;
152 return WFR;
153 }
154
155 /// Create an out-of-band error by copying the given string.
156 static WrapperFunctionResult createOutOfBandError(const std::string &Msg) {
157 return createOutOfBandError(Msg.c_str());
158 }
159
160 /// If this value is an out-of-band error then this returns the error message,
161 /// otherwise returns nullptr.
162 const char *getOutOfBandError() const {
163 return R.Size == 0 ? R.Data.ValuePtr : nullptr;
164 }
165
166private:
167 static void init(detail::CWrapperFunctionResult &R) {
168 R.Data.ValuePtr = nullptr;
169 R.Size = 0;
170 }
171
172 detail::CWrapperFunctionResult R;
173};
174
175namespace detail {
176
177template <typename SPSArgListT, typename... ArgTs>
178WrapperFunctionResult
179serializeViaSPSToWrapperFunctionResult(const ArgTs &...Args) {
180 auto Result = WrapperFunctionResult::allocate(SPSArgListT::size(Args...));
181 SPSOutputBuffer OB(Result.data(), Result.size());
182 if (!SPSArgListT::serialize(OB, Args...))
183 return WrapperFunctionResult::createOutOfBandError(
184 "Error serializing arguments to blob in call");
185 return Result;
186}
187
188template <typename RetT> class WrapperFunctionHandlerCaller {
189public:
190 template <typename HandlerT, typename ArgTupleT, std::size_t... I>
191 static decltype(auto) call(HandlerT &&H, ArgTupleT &Args,
192 std::index_sequence<I...>) {
193 return std::forward<HandlerT>(H)(std::get<I>(Args)...);
194 }
195};
196
197template <> class WrapperFunctionHandlerCaller<void> {
198public:
199 template <typename HandlerT, typename ArgTupleT, std::size_t... I>
200 static SPSEmpty call(HandlerT &&H, ArgTupleT &Args,
201 std::index_sequence<I...>) {
202 std::forward<HandlerT>(H)(std::get<I>(Args)...);
203 return SPSEmpty();
204 }
205};
206
207template <typename WrapperFunctionImplT,
208 template <typename> class ResultSerializer, typename... SPSTagTs>
209class WrapperFunctionHandlerHelper
210 : public WrapperFunctionHandlerHelper<
211 decltype(&std::remove_reference_t<WrapperFunctionImplT>::operator()),
212 ResultSerializer, SPSTagTs...> {};
213
214template <typename RetT, typename... ArgTs,
215 template <typename> class ResultSerializer, typename... SPSTagTs>
216class WrapperFunctionHandlerHelper<RetT(ArgTs...), ResultSerializer,
217 SPSTagTs...> {
218public:
219 using ArgTuple = std::tuple<std::decay_t<ArgTs>...>;
220 using ArgIndices = std::make_index_sequence<std::tuple_size<ArgTuple>::value>;
221
222 template <typename HandlerT>
223 static WrapperFunctionResult apply(HandlerT &&H, const char *ArgData,
224 size_t ArgSize) {
225 ArgTuple Args;
226 if (!deserialize(ArgData, ArgSize, Args, ArgIndices{}))
227 return WrapperFunctionResult::createOutOfBandError(
228 "Could not deserialize arguments for wrapper function call");
229
230 auto HandlerResult = WrapperFunctionHandlerCaller<RetT>::call(
231 std::forward<HandlerT>(H), Args, ArgIndices{});
232
233 return ResultSerializer<decltype(HandlerResult)>::serialize(
234 std::move(HandlerResult));
235 }
236
237private:
238 template <std::size_t... I>
239 static bool deserialize(const char *ArgData, size_t ArgSize, ArgTuple &Args,
240 std::index_sequence<I...>) {
241 SPSInputBuffer IB(ArgData, ArgSize);
242 return SPSArgList<SPSTagTs...>::deserialize(IB, std::get<I>(Args)...);
243 }
244};
245
246// Map function pointers to function types.
247template <typename RetT, typename... ArgTs,
248 template <typename> class ResultSerializer, typename... SPSTagTs>
249class WrapperFunctionHandlerHelper<RetT (*)(ArgTs...), ResultSerializer,
250 SPSTagTs...>
251 : public WrapperFunctionHandlerHelper<RetT(ArgTs...), ResultSerializer,
252 SPSTagTs...> {};
253
254// Map non-const member function types to function types.
255template <typename ClassT, typename RetT, typename... ArgTs,
256 template <typename> class ResultSerializer, typename... SPSTagTs>
257class WrapperFunctionHandlerHelper<RetT (ClassT::*)(ArgTs...), ResultSerializer,
258 SPSTagTs...>
259 : public WrapperFunctionHandlerHelper<RetT(ArgTs...), ResultSerializer,
260 SPSTagTs...> {};
261
262// Map const member function types to function types.
263template <typename ClassT, typename RetT, typename... ArgTs,
264 template <typename> class ResultSerializer, typename... SPSTagTs>
265class WrapperFunctionHandlerHelper<RetT (ClassT::*)(ArgTs...) const,
266 ResultSerializer, SPSTagTs...>
267 : public WrapperFunctionHandlerHelper<RetT(ArgTs...), ResultSerializer,
268 SPSTagTs...> {};
269
270template <typename WrapperFunctionImplT,
271 template <typename> class ResultSerializer, typename... SPSTagTs>
272class WrapperFunctionAsyncHandlerHelper
273 : public WrapperFunctionAsyncHandlerHelper<
274 decltype(&std::remove_reference_t<WrapperFunctionImplT>::operator()),
275 ResultSerializer, SPSTagTs...> {};
276
277template <typename RetT, typename SendResultT, typename... ArgTs,
278 template <typename> class ResultSerializer, typename... SPSTagTs>
279class WrapperFunctionAsyncHandlerHelper<RetT(SendResultT, ArgTs...),
280 ResultSerializer, SPSTagTs...> {
281public:
282 using ArgTuple = std::tuple<std::decay_t<ArgTs>...>;
283 using ArgIndices = std::make_index_sequence<std::tuple_size<ArgTuple>::value>;
284
285 template <typename HandlerT, typename SendWrapperFunctionResultT>
286 static void applyAsync(HandlerT &&H,
287 SendWrapperFunctionResultT &&SendWrapperFunctionResult,
288 const char *ArgData, size_t ArgSize) {
289 ArgTuple Args;
290 if (!deserialize(ArgData, ArgSize, Args, ArgIndices{})) {
291 SendWrapperFunctionResult(WrapperFunctionResult::createOutOfBandError(
292 "Could not deserialize arguments for wrapper function call"));
293 return;
294 }
295
296 auto SendResult =
297 [SendWFR = std::move(SendWrapperFunctionResult)](auto Result) mutable {
298 using ResultT = decltype(Result);
299 SendWFR(ResultSerializer<ResultT>::serialize(std::move(Result)));
300 };
301
302 callAsync(std::forward<HandlerT>(H), std::move(SendResult), std::move(Args),
303 ArgIndices{});
304 }
305
306private:
307 template <std::size_t... I>
308 static bool deserialize(const char *ArgData, size_t ArgSize, ArgTuple &Args,
309 std::index_sequence<I...>) {
310 SPSInputBuffer IB(ArgData, ArgSize);
311 return SPSArgList<SPSTagTs...>::deserialize(IB, std::get<I>(Args)...);
312 }
313
314 template <typename HandlerT, typename SerializeAndSendResultT,
315 typename ArgTupleT, std::size_t... I>
316 static void callAsync(HandlerT &&H,
317 SerializeAndSendResultT &&SerializeAndSendResult,
318 ArgTupleT Args, std::index_sequence<I...>) {
319 (void)Args; // Silence a buggy GCC warning.
320 return std::forward<HandlerT>(H)(std::move(SerializeAndSendResult),
321 std::move(std::get<I>(Args))...);
322 }
323};
324
325// Map function pointers to function types.
326template <typename RetT, typename... ArgTs,
327 template <typename> class ResultSerializer, typename... SPSTagTs>
328class WrapperFunctionAsyncHandlerHelper<RetT (*)(ArgTs...), ResultSerializer,
329 SPSTagTs...>
330 : public WrapperFunctionAsyncHandlerHelper<RetT(ArgTs...), ResultSerializer,
331 SPSTagTs...> {};
332
333// Map non-const member function types to function types.
334template <typename ClassT, typename RetT, typename... ArgTs,
335 template <typename> class ResultSerializer, typename... SPSTagTs>
336class WrapperFunctionAsyncHandlerHelper<RetT (ClassT::*)(ArgTs...),
337 ResultSerializer, SPSTagTs...>
338 : public WrapperFunctionAsyncHandlerHelper<RetT(ArgTs...), ResultSerializer,
339 SPSTagTs...> {};
340
341// Map const member function types to function types.
342template <typename ClassT, typename RetT, typename... ArgTs,
343 template <typename> class ResultSerializer, typename... SPSTagTs>
344class WrapperFunctionAsyncHandlerHelper<RetT (ClassT::*)(ArgTs...) const,
345 ResultSerializer, SPSTagTs...>
346 : public WrapperFunctionAsyncHandlerHelper<RetT(ArgTs...), ResultSerializer,
347 SPSTagTs...> {};
348
349template <typename SPSRetTagT, typename RetT> class ResultSerializer {
350public:
351 static WrapperFunctionResult serialize(RetT Result) {
352 return serializeViaSPSToWrapperFunctionResult<SPSArgList<SPSRetTagT>>(
353 Result);
354 }
355};
356
357template <typename SPSRetTagT> class ResultSerializer<SPSRetTagT, Error> {
358public:
359 static WrapperFunctionResult serialize(Error Err) {
360 return serializeViaSPSToWrapperFunctionResult<SPSArgList<SPSRetTagT>>(
361 toSPSSerializable(std::move(Err)));
362 }
363};
364
365template <typename SPSRetTagT, typename T>
366class ResultSerializer<SPSRetTagT, Expected<T>> {
367public:
368 static WrapperFunctionResult serialize(Expected<T> E) {
369 return serializeViaSPSToWrapperFunctionResult<SPSArgList<SPSRetTagT>>(
370 toSPSSerializable(std::move(E)));
371 }
372};
373
374template <typename SPSRetTagT, typename RetT> class ResultDeserializer {
375public:
376 static RetT makeValue() { return RetT(); }
377 static void makeSafe(RetT &Result) {}
378
379 static Error deserialize(RetT &Result, const char *ArgData, size_t ArgSize) {
380 SPSInputBuffer IB(ArgData, ArgSize);
381 if (!SPSArgList<SPSRetTagT>::deserialize(IB, Result))
382 return make_error<StringError>(
383 "Error deserializing return value from blob in call",
384 inconvertibleErrorCode());
385 return Error::success();
386 }
387};
388
389template <> class ResultDeserializer<SPSError, Error> {
390public:
391 static Error makeValue() { return Error::success(); }
392 static void makeSafe(Error &Err) { cantFail(std::move(Err)); }
4
←
Calling move constructor for 'Error'
→
6
←
Returning from move constructor for 'Error'
→
393
394 static Error deserialize(Error &Err, const char *ArgData, size_t ArgSize) {
395 SPSInputBuffer IB(ArgData, ArgSize);
396 SPSSerializableError BSE;
397 if (!SPSArgList<SPSError>::deserialize(IB, BSE))
398 return make_error<StringError>(
399 "Error deserializing return value from blob in call",
400 inconvertibleErrorCode());
401 Err = fromSPSSerializable(std::move(BSE));
402 return Error::success();
403 }
404};
405
406template <typename SPSTagT, typename T>
407class ResultDeserializer<SPSExpected<SPSTagT>, Expected<T>> {
408public:
409 static Expected<T> makeValue() { return T(); }
410 static void makeSafe(Expected<T> &E) { cantFail(E.takeError()); }
411
412 static Error deserialize(Expected<T> &E, const char *ArgData,
413 size_t ArgSize) {
414 SPSInputBuffer IB(ArgData, ArgSize);
415 SPSSerializableExpected<T> BSE;
416 if (!SPSArgList<SPSExpected<SPSTagT>>::deserialize(IB, BSE))
417 return make_error<StringError>(
418 "Error deserializing return value from blob in call",
419 inconvertibleErrorCode());
420 E = fromSPSSerializable(std::move(BSE));
421 return Error::success();
422 }
423};
424
425template <typename SPSRetTagT, typename RetT> class AsyncCallResultHelper {
426 // Did you forget to use Error / Expected in your handler?
427};
428
429} // end namespace detail
430
431template <typename SPSSignature> class WrapperFunction;
432
433template <typename SPSRetTagT, typename... SPSTagTs>
434class WrapperFunction<SPSRetTagT(SPSTagTs...)> {
435private:
436 template <typename RetT>
437 using ResultSerializer = detail::ResultSerializer<SPSRetTagT, RetT>;
438
439public:
440 /// Call a wrapper function. Caller should be callable as
441 /// WrapperFunctionResult Fn(const char *ArgData, size_t ArgSize);
442 template <typename CallerFn, typename RetT, typename... ArgTs>
443 static Error call(const CallerFn &Caller, RetT &Result,
444 const ArgTs &...Args) {
445
446 // RetT might be an Error or Expected value. Set the checked flag now:
447 // we don't want the user to have to check the unused result if this
448 // operation fails.
449 detail::ResultDeserializer<SPSRetTagT, RetT>::makeSafe(Result);
3
←
Calling 'ResultDeserializer::makeSafe'
→
7
←
Returning from 'ResultDeserializer::makeSafe'
→
450
451 auto ArgBuffer =
452 detail::serializeViaSPSToWrapperFunctionResult<SPSArgList<SPSTagTs...>>(
453 Args...);
454 if (const char *ErrMsg
7.1
'ErrMsg' is non-null
7.1
'ErrMsg' is non-null
7.1
'ErrMsg' is non-null
7.1
'ErrMsg' is non-null
 = ArgBuffer.getOutOfBandError())
8
←
Taking true branch
→
455 return make_error<StringError>(ErrMsg, inconvertibleErrorCode());
456
457 WrapperFunctionResult ResultBuffer =
458 Caller(ArgBuffer.data(), ArgBuffer.size());
459 if (auto ErrMsg = ResultBuffer.getOutOfBandError())
460 return make_error<StringError>(ErrMsg, inconvertibleErrorCode());
461
462 return detail::ResultDeserializer<SPSRetTagT, RetT>::deserialize(
463 Result, ResultBuffer.data(), ResultBuffer.size());
464 }
465
466 /// Call an async wrapper function.
467 /// Caller should be callable as
468 /// void Fn(unique_function<void(WrapperFunctionResult)> SendResult,
469 /// WrapperFunctionResult ArgBuffer);
470 template <typename AsyncCallerFn, typename SendDeserializedResultFn,
471 typename... ArgTs>
472 static void callAsync(AsyncCallerFn &&Caller,
473 SendDeserializedResultFn &&SendDeserializedResult,
474 const ArgTs &...Args) {
475 using RetT = typename std::tuple_element<
476 1, typename detail::WrapperFunctionHandlerHelper<
477 std::remove_reference_t<SendDeserializedResultFn>,
478 ResultSerializer, SPSRetTagT>::ArgTuple>::type;
479
480 auto ArgBuffer =
481 detail::serializeViaSPSToWrapperFunctionResult<SPSArgList<SPSTagTs...>>(
482 Args...);
483 if (auto *ErrMsg = ArgBuffer.getOutOfBandError()) {
484 SendDeserializedResult(
485 make_error<StringError>(ErrMsg, inconvertibleErrorCode()),
486 detail::ResultDeserializer<SPSRetTagT, RetT>::makeValue());
487 return;
488 }
489
490 auto SendSerializedResult = [SDR = std::move(SendDeserializedResult)](
491 WrapperFunctionResult R) mutable {
492 RetT RetVal = detail::ResultDeserializer<SPSRetTagT, RetT>::makeValue();
493 detail::ResultDeserializer<SPSRetTagT, RetT>::makeSafe(RetVal);
494
495 SPSInputBuffer IB(R.data(), R.size());
496 if (auto Err = detail::ResultDeserializer<SPSRetTagT, RetT>::deserialize(
497 RetVal, R.data(), R.size()))
498 SDR(std::move(Err), std::move(RetVal));
499
500 SDR(Error::success(), std::move(RetVal));
501 };
502
503 Caller(std::move(SendSerializedResult), ArgBuffer.data(), ArgBuffer.size());
504 }
505
506 /// Handle a call to a wrapper function.
507 template <typename HandlerT>
508 static WrapperFunctionResult handle(const char *ArgData, size_t ArgSize,
509 HandlerT &&Handler) {
510 using WFHH =
511 detail::WrapperFunctionHandlerHelper<std::remove_reference_t<HandlerT>,
512 ResultSerializer, SPSTagTs...>;
513 return WFHH::apply(std::forward<HandlerT>(Handler), ArgData, ArgSize);
514 }
515
516 /// Handle a call to an async wrapper function.
517 template <typename HandlerT, typename SendResultT>
518 static void handleAsync(const char *ArgData, size_t ArgSize,
519 HandlerT &&Handler, SendResultT &&SendResult) {
520 using WFAHH = detail::WrapperFunctionAsyncHandlerHelper<
521 std::remove_reference_t<HandlerT>, ResultSerializer, SPSTagTs...>;
522 WFAHH::applyAsync(std::forward<HandlerT>(Handler),
523 std::forward<SendResultT>(SendResult), ArgData, ArgSize);
524 }
525
526private:
527 template <typename T> static const T &makeSerializable(const T &Value) {
528 return Value;
529 }
530
531 static detail::SPSSerializableError makeSerializable(Error Err) {
532 return detail::toSPSSerializable(std::move(Err));
533 }
534
535 template <typename T>
536 static detail::SPSSerializableExpected<T> makeSerializable(Expected<T> E) {
537 return detail::toSPSSerializable(std::move(E));
538 }
539};
540
541template <typename... SPSTagTs>
542class WrapperFunction<void(SPSTagTs...)>
543 : private WrapperFunction<SPSEmpty(SPSTagTs...)> {
544
545public:
546 template <typename CallerFn, typename... ArgTs>
547 static Error call(const CallerFn &Caller, const ArgTs &...Args) {
548 SPSEmpty BE;
549 return WrapperFunction<SPSEmpty(SPSTagTs...)>::call(Caller, BE, Args...);
550 }
551
552 template <typename AsyncCallerFn, typename SendDeserializedResultFn,
553 typename... ArgTs>
554 static void callAsync(AsyncCallerFn &&Caller,
555 SendDeserializedResultFn &&SendDeserializedResult,
556 const ArgTs &...Args) {
557 WrapperFunction<SPSEmpty(SPSTagTs...)>::callAsync(
558 Caller,
559 [SDR = std::move(SendDeserializedResult)](Error SerializeErr,
560 SPSEmpty E) mutable {
561 SDR(std::move(SerializeErr));
562 },
563 Args...);
564 }
565
566 using WrapperFunction<SPSEmpty(SPSTagTs...)>::handle;
567 using WrapperFunction<SPSEmpty(SPSTagTs...)>::handleAsync;
568};
569
570/// A function object that takes an ExecutorAddr as its first argument,
571/// casts that address to a ClassT*, then calls the given method on that
572/// pointer passing in the remaining function arguments. This utility
573/// removes some of the boilerplate from writing wrappers for method calls.
574///
575/// @code{.cpp}
576/// class MyClass {
577/// public:
578/// void myMethod(uint32_t, bool) { ... }
579/// };
580///
581/// // SPS Method signature -- note MyClass object address as first argument.
582/// using SPSMyMethodWrapperSignature =
583/// SPSTuple<SPSExecutorAddr, uint32_t, bool>;
584///
585/// WrapperFunctionResult
586/// myMethodCallWrapper(const char *ArgData, size_t ArgSize) {
587/// return WrapperFunction<SPSMyMethodWrapperSignature>::handle(
588/// ArgData, ArgSize, makeMethodWrapperHandler(&MyClass::myMethod));
589/// }
590/// @endcode
591///
592template <typename RetT, typename ClassT, typename... ArgTs>
593class MethodWrapperHandler {
594public:
595 using MethodT = RetT (ClassT::*)(ArgTs...);
596 MethodWrapperHandler(MethodT M) : M(M) {}
597 RetT operator()(ExecutorAddr ObjAddr, ArgTs &...Args) {
598 return (ObjAddr.toPtr<ClassT*>()->*M)(std::forward<ArgTs>(Args)...);
599 }
600
601private:
602 MethodT M;
603};
604
605/// Create a MethodWrapperHandler object from the given method pointer.
606template <typename RetT, typename ClassT, typename... ArgTs>
607MethodWrapperHandler<RetT, ClassT, ArgTs...>
608makeMethodWrapperHandler(RetT (ClassT::*Method)(ArgTs...)) {
609 return MethodWrapperHandler<RetT, ClassT, ArgTs...>(Method);
610}
611
612} // end namespace shared
613} // end namespace orc
614} // end namespace llvm
615
616#endif // LLVM_EXECUTIONENGINE_ORC_SHARED_WRAPPERFUNCTIONUTILS_H
←

/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/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 // ErrorList needs to be able to yank ErrorInfoBase pointers out of Errors
159 // to add to the error list. It can't rely on handleErrors for this, since
160 // handleErrors does not support ErrorList handlers.
161 friend class ErrorList;
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);
5
←
Object 'Err' is moved
→
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 [[noreturn]] void fatalUncheckedError() const;
261#endif
262
263 void assertIsChecked() {
264#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
265 if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false))
266 fatalUncheckedError();
267#endif
268 }
269
270 ErrorInfoBase *getPtr() const {
271#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
272 return reinterpret_cast<ErrorInfoBase*>(
273 reinterpret_cast<uintptr_t>(Payload) &
274 ~static_cast<uintptr_t>(0x1));
275#else
276 return Payload;
277#endif
278 }
279
280 void setPtr(ErrorInfoBase *EI) {
281#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
282 Payload = reinterpret_cast<ErrorInfoBase*>(
283 (reinterpret_cast<uintptr_t>(EI) &
284 ~static_cast<uintptr_t>(0x1)) |
285 (reinterpret_cast<uintptr_t>(Payload) & 0x1));
286#else
287 Payload = EI;
288#endif
289 }
290
291 bool getChecked() const {
292#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
293 return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0;
294#else
295 return true;
296#endif
297 }
298
299 void setChecked(bool V) {
300#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
301 Payload = reinterpret_cast<ErrorInfoBase*>(
302 (reinterpret_cast<uintptr_t>(Payload) &
303 ~static_cast<uintptr_t>(0x1)) |
304 (V ? 0 : 1));
305#endif
306 }
307
308 std::unique_ptr<ErrorInfoBase> takePayload() {
309 std::unique_ptr<ErrorInfoBase> Tmp(getPtr());
310 setPtr(nullptr);
311 setChecked(true);
312 return Tmp;
313 }
314
315 friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) {
316 if (auto *P = E.getPtr())
317 P->log(OS);
318 else
319 OS << "success";
320 return OS;
321 }
322
323 ErrorInfoBase *Payload = nullptr;
324};
325
326/// Subclass of Error for the sole purpose of identifying the success path in
327/// the type system. This allows to catch invalid conversion to Expected<T> at
328/// compile time.
329class ErrorSuccess final : public Error {};
330
331inline ErrorSuccess Error::success() { return ErrorSuccess(); }
332
333/// Make a Error instance representing failure using the given error info
334/// type.
335template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
336 return Error(std::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
337}
338
339/// Base class for user error types. Users should declare their error types
340/// like:
341///
342/// class MyError : public ErrorInfo<MyError> {
343/// ....
344/// };
345///
346/// This class provides an implementation of the ErrorInfoBase::kind
347/// method, which is used by the Error RTTI system.
348template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
349class ErrorInfo : public ParentErrT {
350public:
351 using ParentErrT::ParentErrT; // inherit constructors
352
353 static const void *classID() { return &ThisErrT::ID; }
354
355 const void *dynamicClassID() const override { return &ThisErrT::ID; }
356
357 bool isA(const void *const ClassID) const override {
358 return ClassID == classID() || ParentErrT::isA(ClassID);
359 }
360};
361
362/// Special ErrorInfo subclass representing a list of ErrorInfos.
363/// Instances of this class are constructed by joinError.
364class ErrorList final : public ErrorInfo<ErrorList> {
365 // handleErrors needs to be able to iterate the payload list of an
366 // ErrorList.
367 template <typename... HandlerTs>
368 friend Error handleErrors(Error E, HandlerTs &&... Handlers);
369
370 // joinErrors is implemented in terms of join.
371 friend Error joinErrors(Error, Error);
372
373public:
374 void log(raw_ostream &OS) const override {
375 OS << "Multiple errors:\n";
376 for (const auto &ErrPayload : Payloads) {
377 ErrPayload->log(OS);
378 OS << "\n";
379 }
380 }
381
382 std::error_code convertToErrorCode() const override;
383
384 // Used by ErrorInfo::classID.
385 static char ID;
386
387private:
388 ErrorList(std::unique_ptr<ErrorInfoBase> Payload1,
389 std::unique_ptr<ErrorInfoBase> Payload2) {
390 assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&(static_cast <bool> (!Payload1->isA<ErrorList>
() && !Payload2->isA<ErrorList>() &&
"ErrorList constructor payloads should be singleton errors")
? void (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 391, __extension__ __PRETTY_FUNCTION__))
391 "ErrorList constructor payloads should be singleton errors")(static_cast <bool> (!Payload1->isA<ErrorList>
() && !Payload2->isA<ErrorList>() &&
"ErrorList constructor payloads should be singleton errors")
? void (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 391, __extension__ __PRETTY_FUNCTION__));
392 Payloads.push_back(std::move(Payload1));
393 Payloads.push_back(std::move(Payload2));
394 }
395
396 static Error join(Error E1, Error E2) {
397 if (!E1)
398 return E2;
399 if (!E2)
400 return E1;
401 if (E1.isA<ErrorList>()) {
402 auto &E1List = static_cast<ErrorList &>(*E1.getPtr());
403 if (E2.isA<ErrorList>()) {
404 auto E2Payload = E2.takePayload();
405 auto &E2List = static_cast<ErrorList &>(*E2Payload);
406 for (auto &Payload : E2List.Payloads)
407 E1List.Payloads.push_back(std::move(Payload));
408 } else
409 E1List.Payloads.push_back(E2.takePayload());
410
411 return E1;
412 }
413 if (E2.isA<ErrorList>()) {
414 auto &E2List = static_cast<ErrorList &>(*E2.getPtr());
415 E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload());
416 return E2;
417 }
418 return Error(std::unique_ptr<ErrorList>(
419 new ErrorList(E1.takePayload(), E2.takePayload())));
420 }
421
422 std::vector<std::unique_ptr<ErrorInfoBase>> Payloads;
423};
424
425/// Concatenate errors. The resulting Error is unchecked, and contains the
426/// ErrorInfo(s), if any, contained in E1, followed by the
427/// ErrorInfo(s), if any, contained in E2.
428inline Error joinErrors(Error E1, Error E2) {
429 return ErrorList::join(std::move(E1), std::move(E2));
430}
431
432/// Tagged union holding either a T or a Error.
433///
434/// This class parallels ErrorOr, but replaces error_code with Error. Since
435/// Error cannot be copied, this class replaces getError() with
436/// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the
437/// error class type.
438///
439/// Example usage of 'Expected<T>' as a function return type:
440///
441/// @code{.cpp}
442/// Expected<int> myDivide(int A, int B) {
443/// if (B == 0) {
444/// // return an Error
445/// return createStringError(inconvertibleErrorCode(),
446/// "B must not be zero!");
447/// }
448/// // return an integer
449/// return A / B;
450/// }
451/// @endcode
452///
453/// Checking the results of to a function returning 'Expected<T>':
454/// @code{.cpp}
455/// if (auto E = Result.takeError()) {
456/// // We must consume the error. Typically one of:
457/// // - return the error to our caller
458/// // - toString(), when logging
459/// // - consumeError(), to silently swallow the error
460/// // - handleErrors(), to distinguish error types
461/// errs() << "Problem with division " << toString(std::move(E)) << "\n";
462/// return;
463/// }
464/// // use the result
465/// outs() << "The answer is " << *Result << "\n";
466/// @endcode
467///
468/// For unit-testing a function returning an 'Expceted<T>', see the
469/// 'EXPECT_THAT_EXPECTED' macros in llvm/Testing/Support/Error.h
470
471template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected {
472 template <class T1> friend class ExpectedAsOutParameter;
473 template <class OtherT> friend class Expected;
474
475 static constexpr bool isRef = std::is_reference<T>::value;
476
477 using wrap = std::reference_wrapper<std::remove_reference_t<T>>;
478
479 using error_type = std::unique_ptr<ErrorInfoBase>;
480
481public:
482 using storage_type = std::conditional_t<isRef, wrap, T>;
483 using value_type = T;
484
485private:
486 using reference = std::remove_reference_t<T> &;
487 using const_reference = const std::remove_reference_t<T> &;
488 using pointer = std::remove_reference_t<T> *;
489 using const_pointer = const std::remove_reference_t<T> *;
490
491public:
492 /// Create an Expected<T> error value from the given Error.
493 Expected(Error Err)
494 : HasError(true)
495#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
496 // Expected is unchecked upon construction in Debug builds.
497 , Unchecked(true)
498#endif
499 {
500 assert(Err && "Cannot create Expected<T> from Error success value.")(static_cast <bool> (Err && "Cannot create Expected<T> from Error success value."
) ? void (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 500, __extension__ __PRETTY_FUNCTION__));
501 new (getErrorStorage()) error_type(Err.takePayload());
502 }
503
504 /// Forbid to convert from Error::success() implicitly, this avoids having
505 /// Expected<T> foo() { return Error::success(); } which compiles otherwise
506 /// but triggers the assertion above.
507 Expected(ErrorSuccess) = delete;
508
509 /// Create an Expected<T> success value from the given OtherT value, which
510 /// must be convertible to T.
511 template <typename OtherT>
512 Expected(OtherT &&Val,
513 std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr)
514 : HasError(false)
515#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
516 // Expected is unchecked upon construction in Debug builds.
517 ,
518 Unchecked(true)
519#endif
520 {
521 new (getStorage()) storage_type(std::forward<OtherT>(Val));
522 }
523
524 /// Move construct an Expected<T> value.
525 Expected(Expected &&Other) { moveConstruct(std::move(Other)); }
526
527 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
528 /// must be convertible to T.
529 template <class OtherT>
530 Expected(
531 Expected<OtherT> &&Other,
532 std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr) {
533 moveConstruct(std::move(Other));
534 }
535
536 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
537 /// isn't convertible to T.
538 template <class OtherT>
539 explicit Expected(
540 Expected<OtherT> &&Other,
541 std::enable_if_t<!std::is_convertible<OtherT, T>::value> * = nullptr) {
542 moveConstruct(std::move(Other));
543 }
544
545 /// Move-assign from another Expected<T>.
546 Expected &operator=(Expected &&Other) {
547 moveAssign(std::move(Other));
548 return *this;
549 }
550
551 /// Destroy an Expected<T>.
552 ~Expected() {
553 assertIsChecked();
554 if (!HasError)
555 getStorage()->~storage_type();
556 else
557 getErrorStorage()->~error_type();
558 }
559
560 /// Return false if there is an error.
561 explicit operator bool() {
562#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
563 Unchecked = HasError;
564#endif
565 return !HasError;
566 }
567
568 /// Returns a reference to the stored T value.
569 reference get() {
570 assertIsChecked();
571 return *getStorage();
572 }
573
574 /// Returns a const reference to the stored T value.
575 const_reference get() const {
576 assertIsChecked();
577 return const_cast<Expected<T> *>(this)->get();
578 }
579
580 /// Check that this Expected<T> is an error of type ErrT.
581 template <typename ErrT> bool errorIsA() const {
582 return HasError && (*getErrorStorage())->template isA<ErrT>();
583 }
584
585 /// Take ownership of the stored error.
586 /// After calling this the Expected<T> is in an indeterminate state that can
587 /// only be safely destructed. No further calls (beside the destructor) should
588 /// be made on the Expected<T> value.
589 Error takeError() {
590#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
591 Unchecked = false;
592#endif
593 return HasError ? Error(std::move(*getErrorStorage())) : Error::success();
594 }
595
596 /// Returns a pointer to the stored T value.
597 pointer operator->() {
598 assertIsChecked();
599 return toPointer(getStorage());
600 }
601
602 /// Returns a const pointer to the stored T value.
603 const_pointer operator->() const {
604 assertIsChecked();
605 return toPointer(getStorage());
606 }
607
608 /// Returns a reference to the stored T value.
609 reference operator*() {
610 assertIsChecked();
611 return *getStorage();
612 }
613
614 /// Returns a const reference to the stored T value.
615 const_reference operator*() const {
616 assertIsChecked();
617 return *getStorage();
618 }
619
620private:
621 template <class T1>
622 static bool compareThisIfSameType(const T1 &a, const T1 &b) {
623 return &a == &b;
624 }
625
626 template <class T1, class T2>
627 static bool compareThisIfSameType(const T1 &, const T2 &) {
628 return false;
629 }
630
631 template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) {
632 HasError = Other.HasError;
633#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
634 Unchecked = true;
635 Other.Unchecked = false;
636#endif
637
638 if (!HasError)
639 new (getStorage()) storage_type(std::move(*Other.getStorage()));
640 else
641 new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage()));
642 }
643
644 template <class OtherT> void moveAssign(Expected<OtherT> &&Other) {
645 assertIsChecked();
646
647 if (compareThisIfSameType(*this, Other))
648 return;
649
650 this->~Expected();
651 new (this) Expected(std::move(Other));
652 }
653
654 pointer toPointer(pointer Val) { return Val; }
655
656 const_pointer toPointer(const_pointer Val) const { return Val; }
657
658 pointer toPointer(wrap *Val) { return &Val->get(); }
659
660 const_pointer toPointer(const wrap *Val) const { return &Val->get(); }
661
662 storage_type *getStorage() {
663 assert(!HasError && "Cannot get value when an error exists!")(static_cast <bool> (!HasError && "Cannot get value when an error exists!"
) ? void (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 663, __extension__ __PRETTY_FUNCTION__));
664 return reinterpret_cast<storage_type *>(&TStorage);
665 }
666
667 const storage_type *getStorage() const {
668 assert(!HasError && "Cannot get value when an error exists!")(static_cast <bool> (!HasError && "Cannot get value when an error exists!"
) ? void (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 668, __extension__ __PRETTY_FUNCTION__));
669 return reinterpret_cast<const storage_type *>(&TStorage);
670 }
671
672 error_type *getErrorStorage() {
673 assert(HasError && "Cannot get error when a value exists!")(static_cast <bool> (HasError && "Cannot get error when a value exists!"
) ? void (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 673, __extension__ __PRETTY_FUNCTION__));
674 return reinterpret_cast<error_type *>(&ErrorStorage);
675 }
676
677 const error_type *getErrorStorage() const {
678 assert(HasError && "Cannot get error when a value exists!")(static_cast <bool> (HasError && "Cannot get error when a value exists!"
) ? void (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 678, __extension__ __PRETTY_FUNCTION__));
679 return reinterpret_cast<const error_type *>(&ErrorStorage);
680 }
681
682 // Used by ExpectedAsOutParameter to reset the checked flag.
683 void setUnchecked() {
684#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
685 Unchecked = true;
686#endif
687 }
688
689#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
690 [[noreturn]] LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline)) void fatalUncheckedExpected() const {
691 dbgs() << "Expected<T> must be checked before access or destruction.\n";
692 if (HasError) {
693 dbgs() << "Unchecked Expected<T> contained error:\n";
694 (*getErrorStorage())->log(dbgs());
695 } else
696 dbgs() << "Expected<T> value was in success state. (Note: Expected<T> "
697 "values in success mode must still be checked prior to being "
698 "destroyed).\n";
699 abort();
700 }
701#endif
702
703 void assertIsChecked() const {
704#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
705 if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false))
706 fatalUncheckedExpected();
707#endif
708 }
709
710 union {
711 AlignedCharArrayUnion<storage_type> TStorage;
712 AlignedCharArrayUnion<error_type> ErrorStorage;
713 };
714 bool HasError : 1;
715#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
716 bool Unchecked : 1;
717#endif
718};
719
720/// Report a serious error, calling any installed error handler. See
721/// ErrorHandling.h.
722[[noreturn]] void report_fatal_error(Error Err, bool gen_crash_diag = true);
723
724/// Report a fatal error if Err is a failure value.
725///
726/// This function can be used to wrap calls to fallible functions ONLY when it
727/// is known that the Error will always be a success value. E.g.
728///
729/// @code{.cpp}
730/// // foo only attempts the fallible operation if DoFallibleOperation is
731/// // true. If DoFallibleOperation is false then foo always returns
732/// // Error::success().
733/// Error foo(bool DoFallibleOperation);
734///
735/// cantFail(foo(false));
736/// @endcode
737inline void cantFail(Error Err, const char *Msg = nullptr) {
738 if (Err) {
739 if (!Msg)
740 Msg = "Failure value returned from cantFail wrapped call";
741#ifndef NDEBUG
742 std::string Str;
743 raw_string_ostream OS(Str);
744 OS << Msg << "\n" << Err;
745 Msg = OS.str().c_str();
746#endif
747 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 747);
748 }
749}
750
751/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
752/// returns the contained value.
753///
754/// This function can be used to wrap calls to fallible functions ONLY when it
755/// is known that the Error will always be a success value. E.g.
756///
757/// @code{.cpp}
758/// // foo only attempts the fallible operation if DoFallibleOperation is
759/// // true. If DoFallibleOperation is false then foo always returns an int.
760/// Expected<int> foo(bool DoFallibleOperation);
761///
762/// int X = cantFail(foo(false));
763/// @endcode
764template <typename T>
765T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) {
766 if (ValOrErr)
767 return std::move(*ValOrErr);
768 else {
769 if (!Msg)
770 Msg = "Failure value returned from cantFail wrapped call";
771#ifndef NDEBUG
772 std::string Str;
773 raw_string_ostream OS(Str);
774 auto E = ValOrErr.takeError();
775 OS << Msg << "\n" << E;
776 Msg = OS.str().c_str();
777#endif
778 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 778);
779 }
780}
781
782/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
783/// returns the contained reference.
784///
785/// This function can be used to wrap calls to fallible functions ONLY when it
786/// is known that the Error will always be a success value. E.g.
787///
788/// @code{.cpp}
789/// // foo only attempts the fallible operation if DoFallibleOperation is
790/// // true. If DoFallibleOperation is false then foo always returns a Bar&.
791/// Expected<Bar&> foo(bool DoFallibleOperation);
792///
793/// Bar &X = cantFail(foo(false));
794/// @endcode
795template <typename T>
796T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) {
797 if (ValOrErr)
798 return *ValOrErr;
799 else {
800 if (!Msg)
801 Msg = "Failure value returned from cantFail wrapped call";
802#ifndef NDEBUG
803 std::string Str;
804 raw_string_ostream OS(Str);
805 auto E = ValOrErr.takeError();
806 OS << Msg << "\n" << E;
807 Msg = OS.str().c_str();
808#endif
809 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 809);
810 }
811}
812
813/// Helper for testing applicability of, and applying, handlers for
814/// ErrorInfo types.
815template <typename HandlerT>
816class ErrorHandlerTraits
817 : public ErrorHandlerTraits<decltype(
818 &std::remove_reference<HandlerT>::type::operator())> {};
819
820// Specialization functions of the form 'Error (const ErrT&)'.
821template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
822public:
823 static bool appliesTo(const ErrorInfoBase &E) {
824 return E.template isA<ErrT>();
825 }
826
827 template <typename HandlerT>
828 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
829 assert(appliesTo(*E) && "Applying incorrect handler")(static_cast <bool> (appliesTo(*E) && "Applying incorrect handler"
) ? void (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 829, __extension__ __PRETTY_FUNCTION__));
830 return H(static_cast<ErrT &>(*E));
831 }
832};
833
834// Specialization functions of the form 'void (const ErrT&)'.
835template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
836public:
837 static bool appliesTo(const ErrorInfoBase &E) {
838 return E.template isA<ErrT>();
839 }
840
841 template <typename HandlerT>
842 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
843 assert(appliesTo(*E) && "Applying incorrect handler")(static_cast <bool> (appliesTo(*E) && "Applying incorrect handler"
) ? void (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 843, __extension__ __PRETTY_FUNCTION__));
844 H(static_cast<ErrT &>(*E));
845 return Error::success();
846 }
847};
848
849/// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'.
850template <typename ErrT>
851class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
852public:
853 static bool appliesTo(const ErrorInfoBase &E) {
854 return E.template isA<ErrT>();
855 }
856
857 template <typename HandlerT>
858 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
859 assert(appliesTo(*E) && "Applying incorrect handler")(static_cast <bool> (appliesTo(*E) && "Applying incorrect handler"
) ? void (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 859, __extension__ __PRETTY_FUNCTION__));
860 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
861 return H(std::move(SubE));
862 }
863};
864
865/// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'.
866template <typename ErrT>
867class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
868public:
869 static bool appliesTo(const ErrorInfoBase &E) {
870 return E.template isA<ErrT>();
871 }
872
873 template <typename HandlerT>
874 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
875 assert(appliesTo(*E) && "Applying incorrect handler")(static_cast <bool> (appliesTo(*E) && "Applying incorrect handler"
) ? void (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 875, __extension__ __PRETTY_FUNCTION__));
876 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
877 H(std::move(SubE));
878 return Error::success();
879 }
880};
881
882// Specialization for member functions of the form 'RetT (const ErrT&)'.
883template <typename C, typename RetT, typename ErrT>
884class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
885 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
886
887// Specialization for member functions of the form 'RetT (const ErrT&) const'.
888template <typename C, typename RetT, typename ErrT>
889class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
890 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
891
892// Specialization for member functions of the form 'RetT (const ErrT&)'.
893template <typename C, typename RetT, typename ErrT>
894class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
895 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
896
897// Specialization for member functions of the form 'RetT (const ErrT&) const'.
898template <typename C, typename RetT, typename ErrT>
899class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const>
900 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
901
902/// Specialization for member functions of the form
903/// 'RetT (std::unique_ptr<ErrT>)'.
904template <typename C, typename RetT, typename ErrT>
905class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)>
906 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
907
908/// Specialization for member functions of the form
909/// 'RetT (std::unique_ptr<ErrT>) const'.
910template <typename C, typename RetT, typename ErrT>
911class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
912 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
913
914inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
915 return Error(std::move(Payload));
916}
917
918template <typename HandlerT, typename... HandlerTs>
919Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload,
920 HandlerT &&Handler, HandlerTs &&... Handlers) {
921 if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload))
922 return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler),
923 std::move(Payload));
924 return handleErrorImpl(std::move(Payload),
925 std::forward<HandlerTs>(Handlers)...);
926}
927
928/// Pass the ErrorInfo(s) contained in E to their respective handlers. Any
929/// unhandled errors (or Errors returned by handlers) are re-concatenated and
930/// returned.
931/// Because this function returns an error, its result must also be checked
932/// or returned. If you intend to handle all errors use handleAllErrors
933/// (which returns void, and will abort() on unhandled errors) instead.
934template <typename... HandlerTs>
935Error handleErrors(Error E, HandlerTs &&... Hs) {
936 if (!E)
937 return Error::success();
938
939 std::unique_ptr<ErrorInfoBase> Payload = E.takePayload();
940
941 if (Payload->isA<ErrorList>()) {
942 ErrorList &List = static_cast<ErrorList &>(*Payload);
943 Error R;
944 for (auto &P : List.Payloads)
945 R = ErrorList::join(
946 std::move(R),
947 handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...));
948 return R;
949 }
950
951 return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...);
952}
953
954/// Behaves the same as handleErrors, except that by contract all errors
955/// *must* be handled by the given handlers (i.e. there must be no remaining
956/// errors after running the handlers, or llvm_unreachable is called).
957template <typename... HandlerTs>
958void handleAllErrors(Error E, HandlerTs &&... Handlers) {
959 cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...));
960}
961
962/// Check that E is a non-error, then drop it.
963/// If E is an error, llvm_unreachable will be called.
964inline void handleAllErrors(Error E) {
965 cantFail(std::move(E));
966}
967
968/// Handle any errors (if present) in an Expected<T>, then try a recovery path.
969///
970/// If the incoming value is a success value it is returned unmodified. If it
971/// is a failure value then it the contained error is passed to handleErrors.
972/// If handleErrors is able to handle the error then the RecoveryPath functor
973/// is called to supply the final result. If handleErrors is not able to
974/// handle all errors then the unhandled errors are returned.
975///
976/// This utility enables the follow pattern:
977///
978/// @code{.cpp}
979/// enum FooStrategy { Aggressive, Conservative };
980/// Expected<Foo> foo(FooStrategy S);
981///
982/// auto ResultOrErr =
983/// handleExpected(
984/// foo(Aggressive),
985/// []() { return foo(Conservative); },
986/// [](AggressiveStrategyError&) {
987/// // Implicitly conusme this - we'll recover by using a conservative
988/// // strategy.
989/// });
990///
991/// @endcode
992template <typename T, typename RecoveryFtor, typename... HandlerTs>
993Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath,
994 HandlerTs &&... Handlers) {
995 if (ValOrErr)
996 return ValOrErr;
997
998 if (auto Err = handleErrors(ValOrErr.takeError(),
999 std::forward<HandlerTs>(Handlers)...))
1000 return std::move(Err);
1001
1002 return RecoveryPath();
1003}
1004
1005/// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner
1006/// will be printed before the first one is logged. A newline will be printed
1007/// after each error.
1008///
1009/// This function is compatible with the helpers from Support/WithColor.h. You
1010/// can pass any of them as the OS. Please consider using them instead of
1011/// including 'error: ' in the ErrorBanner.
1012///
1013/// This is useful in the base level of your program to allow clean termination
1014/// (allowing clean deallocation of resources, etc.), while reporting error
1015/// information to the user.
1016void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {});
1017
1018/// Write all error messages (if any) in E to a string. The newline character
1019/// is used to separate error messages.
1020inline std::string toString(Error E) {
1021 SmallVector<std::string, 2> Errors;
1022 handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) {
1023 Errors.push_back(EI.message());
1024 });
1025 return join(Errors.begin(), Errors.end(), "\n");
1026}
1027
1028/// Consume a Error without doing anything. This method should be used
1029/// only where an error can be considered a reasonable and expected return
1030/// value.
1031///
1032/// Uses of this method are potentially indicative of design problems: If it's
1033/// legitimate to do nothing while processing an "error", the error-producer
1034/// might be more clearly refactored to return an Optional<T>.
1035inline void consumeError(Error Err) {
1036 handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {});
1037}
1038
1039/// Convert an Expected to an Optional without doing anything. This method
1040/// should be used only where an error can be considered a reasonable and
1041/// expected return value.
1042///
1043/// Uses of this method are potentially indicative of problems: perhaps the
1044/// error should be propagated further, or the error-producer should just
1045/// return an Optional in the first place.
1046template <typename T> Optional<T> expectedToOptional(Expected<T> &&E) {
1047 if (E)
1048 return std::move(*E);
1049 consumeError(E.takeError());
1050 return None;
1051}
1052
1053/// Helper for converting an Error to a bool.
1054///
1055/// This method returns true if Err is in an error state, or false if it is
1056/// in a success state. Puts Err in a checked state in both cases (unlike
1057/// Error::operator bool(), which only does this for success states).
1058inline bool errorToBool(Error Err) {
1059 bool IsError = static_cast<bool>(Err);
1060 if (IsError)
1061 consumeError(std::move(Err));
1062 return IsError;
1063}
1064
1065/// Helper for Errors used as out-parameters.
1066///
1067/// This helper is for use with the Error-as-out-parameter idiom, where an error
1068/// is passed to a function or method by reference, rather than being returned.
1069/// In such cases it is helpful to set the checked bit on entry to the function
1070/// so that the error can be written to (unchecked Errors abort on assignment)
1071/// and clear the checked bit on exit so that clients cannot accidentally forget
1072/// to check the result. This helper performs these actions automatically using
1073/// RAII:
1074///
1075/// @code{.cpp}
1076/// Result foo(Error &Err) {
1077/// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set
1078/// // <body of foo>
1079/// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed.
1080/// }
1081/// @endcode
1082///
1083/// ErrorAsOutParameter takes an Error* rather than Error& so that it can be
1084/// used with optional Errors (Error pointers that are allowed to be null). If
1085/// ErrorAsOutParameter took an Error reference, an instance would have to be
1086/// created inside every condition that verified that Error was non-null. By
1087/// taking an Error pointer we can just create one instance at the top of the
1088/// function.
1089class ErrorAsOutParameter {
1090public:
1091 ErrorAsOutParameter(Error *Err) : Err(Err) {
1092 // Raise the checked bit if Err is success.
1093 if (Err)
1094 (void)!!*Err;
1095 }
1096
1097 ~ErrorAsOutParameter() {
1098 // Clear the checked bit.
1099 if (Err && !*Err)
1100 *Err = Error::success();
1101 }
1102
1103private:
1104 Error *Err;
1105};
1106
1107/// Helper for Expected<T>s used as out-parameters.
1108///
1109/// See ErrorAsOutParameter.
1110template <typename T>
1111class ExpectedAsOutParameter {
1112public:
1113 ExpectedAsOutParameter(Expected<T> *ValOrErr)
1114 : ValOrErr(ValOrErr) {
1115 if (ValOrErr)
1116 (void)!!*ValOrErr;
1117 }
1118
1119 ~ExpectedAsOutParameter() {
1120 if (ValOrErr)
1121 ValOrErr->setUnchecked();
1122 }
1123
1124private:
1125 Expected<T> *ValOrErr;
1126};
1127
1128/// This class wraps a std::error_code in a Error.
1129///
1130/// This is useful if you're writing an interface that returns a Error
1131/// (or Expected) and you want to call code that still returns
1132/// std::error_codes.
1133class ECError : public ErrorInfo<ECError> {
1134 friend Error errorCodeToError(std::error_code);
1135
1136 virtual void anchor() override;
1137
1138public:
1139 void setErrorCode(std::error_code EC) { this->EC = EC; }
1140 std::error_code convertToErrorCode() const override { return EC; }
1141 void log(raw_ostream &OS) const override { OS << EC.message(); }
1142
1143 // Used by ErrorInfo::classID.
1144 static char ID;
1145
1146protected:
1147 ECError() = default;
1148 ECError(std::error_code EC) : EC(EC) {}
1149
1150 std::error_code EC;
1151};
1152
1153/// The value returned by this function can be returned from convertToErrorCode
1154/// for Error values where no sensible translation to std::error_code exists.
1155/// It should only be used in this situation, and should never be used where a
1156/// sensible conversion to std::error_code is available, as attempts to convert
1157/// to/from this error will result in a fatal error. (i.e. it is a programmatic
1158/// error to try to convert such a value).
1159std::error_code inconvertibleErrorCode();
1160
1161/// Helper for converting an std::error_code to a Error.
1162Error errorCodeToError(std::error_code EC);
1163
1164/// Helper for converting an ECError to a std::error_code.
1165///
1166/// This method requires that Err be Error() or an ECError, otherwise it
1167/// will trigger a call to abort().
1168std::error_code errorToErrorCode(Error Err);
1169
1170/// Convert an ErrorOr<T> to an Expected<T>.
1171template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) {
1172 if (auto EC = EO.getError())
1173 return errorCodeToError(EC);
1174 return std::move(*EO);
1175}
1176
1177/// Convert an Expected<T> to an ErrorOr<T>.
1178template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) {
1179 if (auto Err = E.takeError())
1180 return errorToErrorCode(std::move(Err));
1181 return std::move(*E);
1182}
1183
1184/// This class wraps a string in an Error.
1185///
1186/// StringError is useful in cases where the client is not expected to be able
1187/// to consume the specific error message programmatically (for example, if the
1188/// error message is to be presented to the user).
1189///
1190/// StringError can also be used when additional information is to be printed
1191/// along with a error_code message. Depending on the constructor called, this
1192/// class can either display:
1193/// 1. the error_code message (ECError behavior)
1194/// 2. a string
1195/// 3. the error_code message and a string
1196///
1197/// These behaviors are useful when subtyping is required; for example, when a
1198/// specific library needs an explicit error type. In the example below,
1199/// PDBError is derived from StringError:
1200///
1201/// @code{.cpp}
1202/// Expected<int> foo() {
1203/// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading,
1204/// "Additional information");
1205/// }
1206/// @endcode
1207///
1208class StringError : public ErrorInfo<StringError> {
1209public:
1210 static char ID;
1211
1212 // Prints EC + S and converts to EC
1213 StringError(std::error_code EC, const Twine &S = Twine());
1214
1215 // Prints S and converts to EC
1216 StringError(const Twine &S, std::error_code EC);
1217
1218 void log(raw_ostream &OS) const override;
1219 std::error_code convertToErrorCode() const override;
1220
1221 const std::string &getMessage() const { return Msg; }
1222
1223private:
1224 std::string Msg;
1225 std::error_code EC;
1226 const bool PrintMsgOnly = false;
1227};
1228
1229/// Create formatted StringError object.
1230template <typename... Ts>
1231inline Error createStringError(std::error_code EC, char const *Fmt,
1232 const Ts &... Vals) {
1233 std::string Buffer;
1234 raw_string_ostream Stream(Buffer);
1235 Stream << format(Fmt, Vals...);
1236 return make_error<StringError>(Stream.str(), EC);
1237}
1238
1239Error createStringError(std::error_code EC, char const *Msg);
1240
1241inline Error createStringError(std::error_code EC, const Twine &S) {
1242 return createStringError(EC, S.str().c_str());
1243}
1244
1245template <typename... Ts>
1246inline Error createStringError(std::errc EC, char const *Fmt,
1247 const Ts &... Vals) {
1248 return createStringError(std::make_error_code(EC), Fmt, Vals...);
1249}
1250
1251/// This class wraps a filename and another Error.
1252///
1253/// In some cases, an error needs to live along a 'source' name, in order to
1254/// show more detailed information to the user.
1255class FileError final : public ErrorInfo<FileError> {
1256
1257 friend Error createFileError(const Twine &, Error);
1258 friend Error createFileError(const Twine &, size_t, Error);
1259
1260public:
1261 void log(raw_ostream &OS) const override {
1262 assert(Err && "Trying to log after takeError().")(static_cast <bool> (Err && "Trying to log after takeError()."
) ? void (0) : __assert_fail ("Err && \"Trying to log after takeError().\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 1262, __extension__ __PRETTY_FUNCTION__));
1263 OS << "'" << FileName << "': ";
1264 if (Line.hasValue())
1265 OS << "line " << Line.getValue() << ": ";
1266 Err->log(OS);
1267 }
1268
1269 std::string messageWithoutFileInfo() const {
1270 std::string Msg;
1271 raw_string_ostream OS(Msg);
1272 Err->log(OS);
1273 return OS.str();
1274 }
1275
1276 StringRef getFileName() { return FileName; }
1277
1278 Error takeError() { return Error(std::move(Err)); }
1279
1280 std::error_code convertToErrorCode() const override;
1281
1282 // Used by ErrorInfo::classID.
1283 static char ID;
1284
1285private:
1286 FileError(const Twine &F, Optional<size_t> LineNum,
1287 std::unique_ptr<ErrorInfoBase> E) {
1288 assert(E && "Cannot create FileError from Error success value.")(static_cast <bool> (E && "Cannot create FileError from Error success value."
) ? void (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\""
, "/build/llvm-toolchain-snapshot-14~++20211008111112+c0f9c7c01561/llvm/include/llvm/Support/Error.h"
, 1288, __extension__ __PRETTY_FUNCTION__));
1289 FileName = F.str();
1290 Err = std::move(E);
1291 Line = std::move(LineNum);
1292 }
1293
1294 static Error build(const Twine &F, Optional<size_t> Line, Error E) {
1295 std::unique_ptr<ErrorInfoBase> Payload;
1296 handleAllErrors(std::move(E),
1297 [&](std::unique_ptr<ErrorInfoBase> EIB) -> Error {
1298 Payload = std::move(EIB);
1299 return Error::success();
1300 });
1301 return Error(
1302 std::unique_ptr<FileError>(new FileError(F, Line, std::move(Payload))));
1303 }
1304
1305 std::string FileName;
1306 Optional<size_t> Line;
1307 std::unique_ptr<ErrorInfoBase> Err;
1308};
1309
1310/// Concatenate a source file path and/or name with an Error. The resulting
1311/// Error is unchecked.
1312inline Error createFileError(const Twine &F, Error E) {
1313 return FileError::build(F, Optional<size_t>(), std::move(E));
1314}
1315
1316/// Concatenate a source file path and/or name with line number and an Error.
1317/// The resulting Error is unchecked.
1318inline Error createFileError(const Twine &F, size_t Line, Error E) {
1319 return FileError::build(F, Optional<size_t>(Line), std::move(E));
1320}
1321
1322/// Concatenate a source file path and/or name with a std::error_code
1323/// to form an Error object.
1324inline Error createFileError(const Twine &F, std::error_code EC) {
1325 return createFileError(F, errorCodeToError(EC));
1326}
1327
1328/// Concatenate a source file path and/or name with line number and
1329/// std::error_code to form an Error object.
1330inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) {
1331 return createFileError(F, Line, errorCodeToError(EC));
1332}
1333
1334Error createFileError(const Twine &F, ErrorSuccess) = delete;
1335
1336/// Helper for check-and-exit error handling.
1337///
1338/// For tool use only. NOT FOR USE IN LIBRARY CODE.
1339///
1340class ExitOnError {
1341public:
1342 /// Create an error on exit helper.
1343 ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1)
1344 : Banner(std::move(Banner)),
1345 GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {}
1346
1347 /// Set the banner string for any errors caught by operator().
1348 void setBanner(std::string Banner) { this->Banner = std::move(Banner); }
1349
1350 /// Set the exit-code mapper function.
1351 void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) {
1352 this->GetExitCode = std::move(GetExitCode);
1353 }
1354
1355 /// Check Err. If it's in a failure state log the error(s) and exit.
1356 void operator()(Error Err) const { checkError(std::move(Err)); }
1357
1358 /// Check E. If it's in a success state then return the contained value. If
1359 /// it's in a failure state log the error(s) and exit.
1360 template <typename T> T operator()(Expected<T> &&E) const {
1361 checkError(E.takeError());
1362 return std::move(*E);
1363 }
1364
1365 /// Check E. If it's in a success state then return the contained reference. If
1366 /// it's in a failure state log the error(s) and exit.
1367 template <typename T> T& operator()(Expected<T&> &&E) const {
1368 checkError(E.takeError());
1369 return *E;
1370 }
1371
1372private:
1373 void checkError(Error Err) const {
1374 if (Err) {
1375 int ExitCode = GetExitCode(Err);
1376 logAllUnhandledErrors(std::move(Err), errs(), Banner);
1377 exit(ExitCode);
1378 }
1379 }
1380
1381 std::string Banner;
1382 std::function<int(const Error &)> GetExitCode;
1383};
1384
1385/// Conversion from Error to LLVMErrorRef for C error bindings.
1386inline LLVMErrorRef wrap(Error Err) {
1387 return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1388}
1389
1390/// Conversion from LLVMErrorRef to Error for C error bindings.
1391inline Error unwrap(LLVMErrorRef ErrRef) {
1392 return Error(std::unique_ptr<ErrorInfoBase>(
1393 reinterpret_cast<ErrorInfoBase *>(ErrRef)));
1394}
1395
1396} // end namespace llvm
1397
1398#endif // LLVM_SUPPORT_ERROR_H