Bug Summary

File:include/llvm/Support/Error.h
Warning:line 200, column 5
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'

Annotated Source Code

Press '?' to see keyboard shortcuts

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

/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp

1//===--- Core.cpp - Core ORC APIs (MaterializationUnit, JITDylib, etc.) ---===//
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/Core.h"
10#include "llvm/Config/llvm-config.h"
11#include "llvm/ExecutionEngine/Orc/OrcError.h"
12#include "llvm/IR/Mangler.h"
13#include "llvm/Support/CommandLine.h"
14#include "llvm/Support/Debug.h"
15#include "llvm/Support/Format.h"
16
17#if LLVM_ENABLE_THREADS1
18#include <future>
19#endif
20
21#define DEBUG_TYPE"orc" "orc"
22
23using namespace llvm;
24
25namespace {
26
27#ifndef NDEBUG
28
29cl::opt<bool> PrintHidden("debug-orc-print-hidden", cl::init(true),
30 cl::desc("debug print hidden symbols defined by "
31 "materialization units"),
32 cl::Hidden);
33
34cl::opt<bool> PrintCallable("debug-orc-print-callable", cl::init(true),
35 cl::desc("debug print callable symbols defined by "
36 "materialization units"),
37 cl::Hidden);
38
39cl::opt<bool> PrintData("debug-orc-print-data", cl::init(true),
40 cl::desc("debug print data symbols defined by "
41 "materialization units"),
42 cl::Hidden);
43
44#endif // NDEBUG
45
46// SetPrinter predicate that prints every element.
47template <typename T> struct PrintAll {
48 bool operator()(const T &E) { return true; }
49};
50
51bool anyPrintSymbolOptionSet() {
52#ifndef NDEBUG
53 return PrintHidden || PrintCallable || PrintData;
54#else
55 return false;
56#endif // NDEBUG
57}
58
59bool flagsMatchCLOpts(const JITSymbolFlags &Flags) {
60#ifndef NDEBUG
61 // Bail out early if this is a hidden symbol and we're not printing hiddens.
62 if (!PrintHidden && !Flags.isExported())
63 return false;
64
65 // Return true if this is callable and we're printing callables.
66 if (PrintCallable && Flags.isCallable())
67 return true;
68
69 // Return true if this is data and we're printing data.
70 if (PrintData && !Flags.isCallable())
71 return true;
72
73 // otherwise return false.
74 return false;
75#else
76 return false;
77#endif // NDEBUG
78}
79
80// Prints a set of items, filtered by an user-supplied predicate.
81template <typename Set, typename Pred = PrintAll<typename Set::value_type>>
82class SetPrinter {
83public:
84 SetPrinter(const Set &S, Pred ShouldPrint = Pred())
85 : S(S), ShouldPrint(std::move(ShouldPrint)) {}
86
87 void printTo(llvm::raw_ostream &OS) const {
88 bool PrintComma = false;
89 OS << "{";
90 for (auto &E : S) {
91 if (ShouldPrint(E)) {
92 if (PrintComma)
93 OS << ',';
94 OS << ' ' << E;
95 PrintComma = true;
96 }
97 }
98 OS << " }";
99 }
100
101private:
102 const Set &S;
103 mutable Pred ShouldPrint;
104};
105
106template <typename Set, typename Pred>
107SetPrinter<Set, Pred> printSet(const Set &S, Pred P = Pred()) {
108 return SetPrinter<Set, Pred>(S, std::move(P));
109}
110
111// Render a SetPrinter by delegating to its printTo method.
112template <typename Set, typename Pred>
113llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
114 const SetPrinter<Set, Pred> &Printer) {
115 Printer.printTo(OS);
116 return OS;
117}
118
119struct PrintSymbolFlagsMapElemsMatchingCLOpts {
120 bool operator()(const orc::SymbolFlagsMap::value_type &KV) {
121 return flagsMatchCLOpts(KV.second);
122 }
123};
124
125struct PrintSymbolMapElemsMatchingCLOpts {
126 bool operator()(const orc::SymbolMap::value_type &KV) {
127 return flagsMatchCLOpts(KV.second.getFlags());
128 }
129};
130
131} // end anonymous namespace
132
133namespace llvm {
134namespace orc {
135
136char FailedToMaterialize::ID = 0;
137char SymbolsNotFound::ID = 0;
138char SymbolsCouldNotBeRemoved::ID = 0;
139
140RegisterDependenciesFunction NoDependenciesToRegister =
141 RegisterDependenciesFunction();
142
143void MaterializationUnit::anchor() {}
144
145raw_ostream &operator<<(raw_ostream &OS, const SymbolStringPtr &Sym) {
146 return OS << *Sym;
147}
148
149raw_ostream &operator<<(raw_ostream &OS, const SymbolNameSet &Symbols) {
150 return OS << printSet(Symbols, PrintAll<SymbolStringPtr>());
151}
152
153raw_ostream &operator<<(raw_ostream &OS, const JITSymbolFlags &Flags) {
154 if (Flags.isCallable())
155 OS << "[Callable]";
156 else
157 OS << "[Data]";
158 if (Flags.isWeak())
159 OS << "[Weak]";
160 else if (Flags.isCommon())
161 OS << "[Common]";
162
163 if (!Flags.isExported())
164 OS << "[Hidden]";
165
166 return OS;
167}
168
169raw_ostream &operator<<(raw_ostream &OS, const JITEvaluatedSymbol &Sym) {
170 return OS << format("0x%016" PRIx64"l" "x", Sym.getAddress()) << " "
171 << Sym.getFlags();
172}
173
174raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap::value_type &KV) {
175 return OS << "(\"" << KV.first << "\", " << KV.second << ")";
176}
177
178raw_ostream &operator<<(raw_ostream &OS, const SymbolMap::value_type &KV) {
179 return OS << "(\"" << KV.first << "\": " << KV.second << ")";
180}
181
182raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap &SymbolFlags) {
183 return OS << printSet(SymbolFlags, PrintSymbolFlagsMapElemsMatchingCLOpts());
184}
185
186raw_ostream &operator<<(raw_ostream &OS, const SymbolMap &Symbols) {
187 return OS << printSet(Symbols, PrintSymbolMapElemsMatchingCLOpts());
188}
189
190raw_ostream &operator<<(raw_ostream &OS,
191 const SymbolDependenceMap::value_type &KV) {
192 return OS << "(" << KV.first << ", " << KV.second << ")";
193}
194
195raw_ostream &operator<<(raw_ostream &OS, const SymbolDependenceMap &Deps) {
196 return OS << printSet(Deps, PrintAll<SymbolDependenceMap::value_type>());
197}
198
199raw_ostream &operator<<(raw_ostream &OS, const MaterializationUnit &MU) {
200 OS << "MU@" << &MU << " (\"" << MU.getName() << "\"";
201 if (anyPrintSymbolOptionSet())
202 OS << ", " << MU.getSymbols();
203 return OS << ")";
204}
205
206raw_ostream &operator<<(raw_ostream &OS, const JITDylibSearchList &JDs) {
207 OS << "[";
208 if (!JDs.empty()) {
209 assert(JDs.front().first && "JITDylibList entries must not be null")((JDs.front().first && "JITDylibList entries must not be null"
) ? static_cast<void> (0) : __assert_fail ("JDs.front().first && \"JITDylibList entries must not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 209, __PRETTY_FUNCTION__))
;
210 OS << " (\"" << JDs.front().first->getName() << "\", "
211 << (JDs.front().second ? "true" : "false") << ")";
212 for (auto &KV : make_range(std::next(JDs.begin()), JDs.end())) {
213 assert(KV.first && "JITDylibList entries must not be null")((KV.first && "JITDylibList entries must not be null"
) ? static_cast<void> (0) : __assert_fail ("KV.first && \"JITDylibList entries must not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 213, __PRETTY_FUNCTION__))
;
214 OS << ", (\"" << KV.first->getName() << "\", "
215 << (KV.second ? "true" : "false") << ")";
216 }
217 }
218 OS << " ]";
219 return OS;
220}
221
222FailedToMaterialize::FailedToMaterialize(SymbolNameSet Symbols)
223 : Symbols(std::move(Symbols)) {
224 assert(!this->Symbols.empty() && "Can not fail to resolve an empty set")((!this->Symbols.empty() && "Can not fail to resolve an empty set"
) ? static_cast<void> (0) : __assert_fail ("!this->Symbols.empty() && \"Can not fail to resolve an empty set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 224, __PRETTY_FUNCTION__))
;
225}
226
227std::error_code FailedToMaterialize::convertToErrorCode() const {
228 return orcError(OrcErrorCode::UnknownORCError);
229}
230
231void FailedToMaterialize::log(raw_ostream &OS) const {
232 OS << "Failed to materialize symbols: " << Symbols;
233}
234
235SymbolsNotFound::SymbolsNotFound(SymbolNameSet Symbols)
236 : Symbols(std::move(Symbols)) {
237 assert(!this->Symbols.empty() && "Can not fail to resolve an empty set")((!this->Symbols.empty() && "Can not fail to resolve an empty set"
) ? static_cast<void> (0) : __assert_fail ("!this->Symbols.empty() && \"Can not fail to resolve an empty set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 237, __PRETTY_FUNCTION__))
;
238}
239
240std::error_code SymbolsNotFound::convertToErrorCode() const {
241 return orcError(OrcErrorCode::UnknownORCError);
242}
243
244void SymbolsNotFound::log(raw_ostream &OS) const {
245 OS << "Symbols not found: " << Symbols;
246}
247
248SymbolsCouldNotBeRemoved::SymbolsCouldNotBeRemoved(SymbolNameSet Symbols)
249 : Symbols(std::move(Symbols)) {
250 assert(!this->Symbols.empty() && "Can not fail to resolve an empty set")((!this->Symbols.empty() && "Can not fail to resolve an empty set"
) ? static_cast<void> (0) : __assert_fail ("!this->Symbols.empty() && \"Can not fail to resolve an empty set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 250, __PRETTY_FUNCTION__))
;
251}
252
253std::error_code SymbolsCouldNotBeRemoved::convertToErrorCode() const {
254 return orcError(OrcErrorCode::UnknownORCError);
255}
256
257void SymbolsCouldNotBeRemoved::log(raw_ostream &OS) const {
258 OS << "Symbols could not be removed: " << Symbols;
259}
260
261AsynchronousSymbolQuery::AsynchronousSymbolQuery(
262 const SymbolNameSet &Symbols, SymbolsResolvedCallback NotifySymbolsResolved,
263 SymbolsReadyCallback NotifySymbolsReady)
264 : NotifySymbolsResolved(std::move(NotifySymbolsResolved)),
265 NotifySymbolsReady(std::move(NotifySymbolsReady)) {
266 NotYetResolvedCount = NotYetReadyCount = Symbols.size();
267
268 for (auto &S : Symbols)
269 ResolvedSymbols[S] = nullptr;
270}
271
272void AsynchronousSymbolQuery::resolve(const SymbolStringPtr &Name,
273 JITEvaluatedSymbol Sym) {
274 auto I = ResolvedSymbols.find(Name);
275 assert(I != ResolvedSymbols.end() &&((I != ResolvedSymbols.end() && "Resolving symbol outside the requested set"
) ? static_cast<void> (0) : __assert_fail ("I != ResolvedSymbols.end() && \"Resolving symbol outside the requested set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 276, __PRETTY_FUNCTION__))
276 "Resolving symbol outside the requested set")((I != ResolvedSymbols.end() && "Resolving symbol outside the requested set"
) ? static_cast<void> (0) : __assert_fail ("I != ResolvedSymbols.end() && \"Resolving symbol outside the requested set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 276, __PRETTY_FUNCTION__))
;
277 assert(I->second.getAddress() == 0 && "Redundantly resolving symbol Name")((I->second.getAddress() == 0 && "Redundantly resolving symbol Name"
) ? static_cast<void> (0) : __assert_fail ("I->second.getAddress() == 0 && \"Redundantly resolving symbol Name\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 277, __PRETTY_FUNCTION__))
;
278 I->second = std::move(Sym);
279 --NotYetResolvedCount;
280}
281
282void AsynchronousSymbolQuery::handleFullyResolved() {
283 assert(NotYetResolvedCount == 0 && "Not fully resolved?")((NotYetResolvedCount == 0 && "Not fully resolved?") ?
static_cast<void> (0) : __assert_fail ("NotYetResolvedCount == 0 && \"Not fully resolved?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 283, __PRETTY_FUNCTION__))
;
284
285 if (!NotifySymbolsResolved) {
286 // handleFullyResolved may be called by handleFullyReady (see comments in
287 // that method), in which case this is a no-op, so bail out.
288 assert(!NotifySymbolsReady &&((!NotifySymbolsReady && "NotifySymbolsResolved already called or an error occurred"
) ? static_cast<void> (0) : __assert_fail ("!NotifySymbolsReady && \"NotifySymbolsResolved already called or an error occurred\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 289, __PRETTY_FUNCTION__))
289 "NotifySymbolsResolved already called or an error occurred")((!NotifySymbolsReady && "NotifySymbolsResolved already called or an error occurred"
) ? static_cast<void> (0) : __assert_fail ("!NotifySymbolsReady && \"NotifySymbolsResolved already called or an error occurred\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 289, __PRETTY_FUNCTION__))
;
290 return;
291 }
292
293 auto TmpNotifySymbolsResolved = std::move(NotifySymbolsResolved);
294 NotifySymbolsResolved = SymbolsResolvedCallback();
295 TmpNotifySymbolsResolved(std::move(ResolvedSymbols));
296}
297
298void AsynchronousSymbolQuery::notifySymbolReady() {
299 assert(NotYetReadyCount != 0 && "All symbols already emitted")((NotYetReadyCount != 0 && "All symbols already emitted"
) ? static_cast<void> (0) : __assert_fail ("NotYetReadyCount != 0 && \"All symbols already emitted\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 299, __PRETTY_FUNCTION__))
;
300 --NotYetReadyCount;
301}
302
303void AsynchronousSymbolQuery::handleFullyReady() {
304 assert(NotifySymbolsReady &&((NotifySymbolsReady && "NotifySymbolsReady already called or an error occurred"
) ? static_cast<void> (0) : __assert_fail ("NotifySymbolsReady && \"NotifySymbolsReady already called or an error occurred\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 305, __PRETTY_FUNCTION__))
305 "NotifySymbolsReady already called or an error occurred")((NotifySymbolsReady && "NotifySymbolsReady already called or an error occurred"
) ? static_cast<void> (0) : __assert_fail ("NotifySymbolsReady && \"NotifySymbolsReady already called or an error occurred\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 305, __PRETTY_FUNCTION__))
;
306
307 auto TmpNotifySymbolsReady = std::move(NotifySymbolsReady);
308 NotifySymbolsReady = SymbolsReadyCallback();
309
310 if (NotYetResolvedCount == 0 && NotifySymbolsResolved) {
311 // The NotifyResolved callback of one query must have caused this query to
312 // become ready (i.e. there is still a handleFullyResolved callback waiting
313 // to be made back up the stack). Fold the handleFullyResolved call into
314 // this one before proceeding. This will cause the call further up the
315 // stack to become a no-op.
316 handleFullyResolved();
317 }
318
319 assert(QueryRegistrations.empty() &&((QueryRegistrations.empty() && "Query is still registered with some symbols"
) ? static_cast<void> (0) : __assert_fail ("QueryRegistrations.empty() && \"Query is still registered with some symbols\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 320, __PRETTY_FUNCTION__))
320 "Query is still registered with some symbols")((QueryRegistrations.empty() && "Query is still registered with some symbols"
) ? static_cast<void> (0) : __assert_fail ("QueryRegistrations.empty() && \"Query is still registered with some symbols\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 320, __PRETTY_FUNCTION__))
;
321 assert(!NotifySymbolsResolved && "Resolution not applied yet")((!NotifySymbolsResolved && "Resolution not applied yet"
) ? static_cast<void> (0) : __assert_fail ("!NotifySymbolsResolved && \"Resolution not applied yet\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 321, __PRETTY_FUNCTION__))
;
322 TmpNotifySymbolsReady(Error::success());
323}
324
325bool AsynchronousSymbolQuery::canStillFail() {
326 return (NotifySymbolsResolved || NotifySymbolsReady);
327}
328
329void AsynchronousSymbolQuery::handleFailed(Error Err) {
330 assert(QueryRegistrations.empty() && ResolvedSymbols.empty() &&((QueryRegistrations.empty() && ResolvedSymbols.empty
() && NotYetResolvedCount == 0 && NotYetReadyCount
== 0 && "Query should already have been abandoned") ?
static_cast<void> (0) : __assert_fail ("QueryRegistrations.empty() && ResolvedSymbols.empty() && NotYetResolvedCount == 0 && NotYetReadyCount == 0 && \"Query should already have been abandoned\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 332, __PRETTY_FUNCTION__))
331 NotYetResolvedCount == 0 && NotYetReadyCount == 0 &&((QueryRegistrations.empty() && ResolvedSymbols.empty
() && NotYetResolvedCount == 0 && NotYetReadyCount
== 0 && "Query should already have been abandoned") ?
static_cast<void> (0) : __assert_fail ("QueryRegistrations.empty() && ResolvedSymbols.empty() && NotYetResolvedCount == 0 && NotYetReadyCount == 0 && \"Query should already have been abandoned\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 332, __PRETTY_FUNCTION__))
332 "Query should already have been abandoned")((QueryRegistrations.empty() && ResolvedSymbols.empty
() && NotYetResolvedCount == 0 && NotYetReadyCount
== 0 && "Query should already have been abandoned") ?
static_cast<void> (0) : __assert_fail ("QueryRegistrations.empty() && ResolvedSymbols.empty() && NotYetResolvedCount == 0 && NotYetReadyCount == 0 && \"Query should already have been abandoned\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 332, __PRETTY_FUNCTION__))
;
333 if (NotifySymbolsResolved) {
334 NotifySymbolsResolved(std::move(Err));
335 NotifySymbolsResolved = SymbolsResolvedCallback();
336 } else {
337 assert(NotifySymbolsReady && "Failed after both callbacks issued?")((NotifySymbolsReady && "Failed after both callbacks issued?"
) ? static_cast<void> (0) : __assert_fail ("NotifySymbolsReady && \"Failed after both callbacks issued?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 337, __PRETTY_FUNCTION__))
;
338 NotifySymbolsReady(std::move(Err));
339 }
340 NotifySymbolsReady = SymbolsReadyCallback();
341}
342
343void AsynchronousSymbolQuery::addQueryDependence(JITDylib &JD,
344 SymbolStringPtr Name) {
345 bool Added = QueryRegistrations[&JD].insert(std::move(Name)).second;
346 (void)Added;
347 assert(Added && "Duplicate dependence notification?")((Added && "Duplicate dependence notification?") ? static_cast
<void> (0) : __assert_fail ("Added && \"Duplicate dependence notification?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 347, __PRETTY_FUNCTION__))
;
348}
349
350void AsynchronousSymbolQuery::removeQueryDependence(
351 JITDylib &JD, const SymbolStringPtr &Name) {
352 auto QRI = QueryRegistrations.find(&JD);
353 assert(QRI != QueryRegistrations.end() &&((QRI != QueryRegistrations.end() && "No dependencies registered for JD"
) ? static_cast<void> (0) : __assert_fail ("QRI != QueryRegistrations.end() && \"No dependencies registered for JD\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 354, __PRETTY_FUNCTION__))
354 "No dependencies registered for JD")((QRI != QueryRegistrations.end() && "No dependencies registered for JD"
) ? static_cast<void> (0) : __assert_fail ("QRI != QueryRegistrations.end() && \"No dependencies registered for JD\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 354, __PRETTY_FUNCTION__))
;
355 assert(QRI->second.count(Name) && "No dependency on Name in JD")((QRI->second.count(Name) && "No dependency on Name in JD"
) ? static_cast<void> (0) : __assert_fail ("QRI->second.count(Name) && \"No dependency on Name in JD\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 355, __PRETTY_FUNCTION__))
;
356 QRI->second.erase(Name);
357 if (QRI->second.empty())
358 QueryRegistrations.erase(QRI);
359}
360
361void AsynchronousSymbolQuery::detach() {
362 ResolvedSymbols.clear();
363 NotYetResolvedCount = 0;
364 NotYetReadyCount = 0;
365 for (auto &KV : QueryRegistrations)
366 KV.first->detachQueryHelper(*this, KV.second);
367 QueryRegistrations.clear();
368}
369
370MaterializationResponsibility::MaterializationResponsibility(
371 JITDylib &JD, SymbolFlagsMap SymbolFlags, VModuleKey K)
372 : JD(JD), SymbolFlags(std::move(SymbolFlags)), K(std::move(K)) {
373 assert(!this->SymbolFlags.empty() && "Materializing nothing?")((!this->SymbolFlags.empty() && "Materializing nothing?"
) ? static_cast<void> (0) : __assert_fail ("!this->SymbolFlags.empty() && \"Materializing nothing?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 373, __PRETTY_FUNCTION__))
;
374}
375
376MaterializationResponsibility::~MaterializationResponsibility() {
377 assert(SymbolFlags.empty() &&((SymbolFlags.empty() && "All symbols should have been explicitly materialized or failed"
) ? static_cast<void> (0) : __assert_fail ("SymbolFlags.empty() && \"All symbols should have been explicitly materialized or failed\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 378, __PRETTY_FUNCTION__))
378 "All symbols should have been explicitly materialized or failed")((SymbolFlags.empty() && "All symbols should have been explicitly materialized or failed"
) ? static_cast<void> (0) : __assert_fail ("SymbolFlags.empty() && \"All symbols should have been explicitly materialized or failed\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 378, __PRETTY_FUNCTION__))
;
379}
380
381SymbolNameSet MaterializationResponsibility::getRequestedSymbols() const {
382 return JD.getRequestedSymbols(SymbolFlags);
383}
384
385void MaterializationResponsibility::resolve(const SymbolMap &Symbols) {
386 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" resolving " << Symbols << "\n"; }; } } while (
false)
387 { dbgs() << "In " << JD.getName() << " resolving " << Symbols << "\n"; })do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" resolving " << Symbols << "\n"; }; } } while (
false)
;
388#ifndef NDEBUG
389 for (auto &KV : Symbols) {
390 auto I = SymbolFlags.find(KV.first);
391 assert(I != SymbolFlags.end() &&((I != SymbolFlags.end() && "Resolving symbol outside this responsibility set"
) ? static_cast<void> (0) : __assert_fail ("I != SymbolFlags.end() && \"Resolving symbol outside this responsibility set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 392, __PRETTY_FUNCTION__))
392 "Resolving symbol outside this responsibility set")((I != SymbolFlags.end() && "Resolving symbol outside this responsibility set"
) ? static_cast<void> (0) : __assert_fail ("I != SymbolFlags.end() && \"Resolving symbol outside this responsibility set\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 392, __PRETTY_FUNCTION__))
;
393 if (I->second.isWeak())
394 assert(I->second == (KV.second.getFlags() | JITSymbolFlags::Weak) &&((I->second == (KV.second.getFlags() | JITSymbolFlags::Weak
) && "Resolving symbol with incorrect flags") ? static_cast
<void> (0) : __assert_fail ("I->second == (KV.second.getFlags() | JITSymbolFlags::Weak) && \"Resolving symbol with incorrect flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 395, __PRETTY_FUNCTION__))
395 "Resolving symbol with incorrect flags")((I->second == (KV.second.getFlags() | JITSymbolFlags::Weak
) && "Resolving symbol with incorrect flags") ? static_cast
<void> (0) : __assert_fail ("I->second == (KV.second.getFlags() | JITSymbolFlags::Weak) && \"Resolving symbol with incorrect flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 395, __PRETTY_FUNCTION__))
;
396 else
397 assert(I->second == KV.second.getFlags() &&((I->second == KV.second.getFlags() && "Resolving symbol with incorrect flags"
) ? static_cast<void> (0) : __assert_fail ("I->second == KV.second.getFlags() && \"Resolving symbol with incorrect flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 398, __PRETTY_FUNCTION__))
398 "Resolving symbol with incorrect flags")((I->second == KV.second.getFlags() && "Resolving symbol with incorrect flags"
) ? static_cast<void> (0) : __assert_fail ("I->second == KV.second.getFlags() && \"Resolving symbol with incorrect flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 398, __PRETTY_FUNCTION__))
;
399 }
400#endif
401
402 JD.resolve(Symbols);
403}
404
405void MaterializationResponsibility::emit() {
406
407 LLVM_DEBUG({do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" emitting " << SymbolFlags << "\n"; }; } } while
(false)
408 dbgs() << "In " << JD.getName() << " emitting " << SymbolFlags << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" emitting " << SymbolFlags << "\n"; }; } } while
(false)
409 })do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" emitting " << SymbolFlags << "\n"; }; } } while
(false)
;
410
411 JD.emit(SymbolFlags);
412 SymbolFlags.clear();
413}
414
415Error MaterializationResponsibility::defineMaterializing(
416 const SymbolFlagsMap &NewSymbolFlags) {
417 // Add the given symbols to this responsibility object.
418 // It's ok if we hit a duplicate here: In that case the new version will be
419 // discarded, and the JITDylib::defineMaterializing method will return a
420 // duplicate symbol error.
421 for (auto &KV : NewSymbolFlags)
422 SymbolFlags.insert(KV);
423
424 return JD.defineMaterializing(NewSymbolFlags);
1
Calling 'JITDylib::defineMaterializing'
425}
426
427void MaterializationResponsibility::failMaterialization() {
428
429 LLVM_DEBUG({do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" failing materialization for " << SymbolFlags <<
"\n"; }; } } while (false)
430 dbgs() << "In " << JD.getName() << " failing materialization for "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" failing materialization for " << SymbolFlags <<
"\n"; }; } } while (false)
431 << SymbolFlags << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" failing materialization for " << SymbolFlags <<
"\n"; }; } } while (false)
432 })do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { { dbgs() << "In " << JD.getName() <<
" failing materialization for " << SymbolFlags <<
"\n"; }; } } while (false)
;
433
434 SymbolNameSet FailedSymbols;
435 for (auto &KV : SymbolFlags)
436 FailedSymbols.insert(KV.first);
437
438 JD.notifyFailed(FailedSymbols);
439 SymbolFlags.clear();
440}
441
442void MaterializationResponsibility::replace(
443 std::unique_ptr<MaterializationUnit> MU) {
444 for (auto &KV : MU->getSymbols())
445 SymbolFlags.erase(KV.first);
446
447 LLVM_DEBUG(JD.getExecutionSession().runSessionLocked([&]() {do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { JD.getExecutionSession().runSessionLocked([&](
) { dbgs() << "In " << JD.getName() << " replacing symbols with "
<< *MU << "\n"; });; } } while (false)
448 dbgs() << "In " << JD.getName() << " replacing symbols with " << *MUdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { JD.getExecutionSession().runSessionLocked([&](
) { dbgs() << "In " << JD.getName() << " replacing symbols with "
<< *MU << "\n"; });; } } while (false)
449 << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { JD.getExecutionSession().runSessionLocked([&](
) { dbgs() << "In " << JD.getName() << " replacing symbols with "
<< *MU << "\n"; });; } } while (false)
450 });)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { JD.getExecutionSession().runSessionLocked([&](
) { dbgs() << "In " << JD.getName() << " replacing symbols with "
<< *MU << "\n"; });; } } while (false)
;
451
452 JD.replace(std::move(MU));
453}
454
455MaterializationResponsibility
456MaterializationResponsibility::delegate(const SymbolNameSet &Symbols,
457 VModuleKey NewKey) {
458
459 if (NewKey == VModuleKey())
460 NewKey = K;
461
462 SymbolFlagsMap DelegatedFlags;
463
464 for (auto &Name : Symbols) {
465 auto I = SymbolFlags.find(Name);
466 assert(I != SymbolFlags.end() &&((I != SymbolFlags.end() && "Symbol is not tracked by this MaterializationResponsibility "
"instance") ? static_cast<void> (0) : __assert_fail ("I != SymbolFlags.end() && \"Symbol is not tracked by this MaterializationResponsibility \" \"instance\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 468, __PRETTY_FUNCTION__))
467 "Symbol is not tracked by this MaterializationResponsibility "((I != SymbolFlags.end() && "Symbol is not tracked by this MaterializationResponsibility "
"instance") ? static_cast<void> (0) : __assert_fail ("I != SymbolFlags.end() && \"Symbol is not tracked by this MaterializationResponsibility \" \"instance\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 468, __PRETTY_FUNCTION__))
468 "instance")((I != SymbolFlags.end() && "Symbol is not tracked by this MaterializationResponsibility "
"instance") ? static_cast<void> (0) : __assert_fail ("I != SymbolFlags.end() && \"Symbol is not tracked by this MaterializationResponsibility \" \"instance\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 468, __PRETTY_FUNCTION__))
;
469
470 DelegatedFlags[Name] = std::move(I->second);
471 SymbolFlags.erase(I);
472 }
473
474 return MaterializationResponsibility(JD, std::move(DelegatedFlags),
475 std::move(NewKey));
476}
477
478void MaterializationResponsibility::addDependencies(
479 const SymbolStringPtr &Name, const SymbolDependenceMap &Dependencies) {
480 assert(SymbolFlags.count(Name) &&((SymbolFlags.count(Name) && "Symbol not covered by this MaterializationResponsibility instance"
) ? static_cast<void> (0) : __assert_fail ("SymbolFlags.count(Name) && \"Symbol not covered by this MaterializationResponsibility instance\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 481, __PRETTY_FUNCTION__))
481 "Symbol not covered by this MaterializationResponsibility instance")((SymbolFlags.count(Name) && "Symbol not covered by this MaterializationResponsibility instance"
) ? static_cast<void> (0) : __assert_fail ("SymbolFlags.count(Name) && \"Symbol not covered by this MaterializationResponsibility instance\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 481, __PRETTY_FUNCTION__))
;
482 JD.addDependencies(Name, Dependencies);
483}
484
485void MaterializationResponsibility::addDependenciesForAll(
486 const SymbolDependenceMap &Dependencies) {
487 for (auto &KV : SymbolFlags)
488 JD.addDependencies(KV.first, Dependencies);
489}
490
491AbsoluteSymbolsMaterializationUnit::AbsoluteSymbolsMaterializationUnit(
492 SymbolMap Symbols, VModuleKey K)
493 : MaterializationUnit(extractFlags(Symbols), std::move(K)),
494 Symbols(std::move(Symbols)) {}
495
496StringRef AbsoluteSymbolsMaterializationUnit::getName() const {
497 return "<Absolute Symbols>";
498}
499
500void AbsoluteSymbolsMaterializationUnit::materialize(
501 MaterializationResponsibility R) {
502 R.resolve(Symbols);
503 R.emit();
504}
505
506void AbsoluteSymbolsMaterializationUnit::discard(const JITDylib &JD,
507 const SymbolStringPtr &Name) {
508 assert(Symbols.count(Name) && "Symbol is not part of this MU")((Symbols.count(Name) && "Symbol is not part of this MU"
) ? static_cast<void> (0) : __assert_fail ("Symbols.count(Name) && \"Symbol is not part of this MU\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 508, __PRETTY_FUNCTION__))
;
509 Symbols.erase(Name);
510}
511
512SymbolFlagsMap
513AbsoluteSymbolsMaterializationUnit::extractFlags(const SymbolMap &Symbols) {
514 SymbolFlagsMap Flags;
515 for (const auto &KV : Symbols)
516 Flags[KV.first] = KV.second.getFlags();
517 return Flags;
518}
519
520ReExportsMaterializationUnit::ReExportsMaterializationUnit(
521 JITDylib *SourceJD, bool MatchNonExported, SymbolAliasMap Aliases,
522 VModuleKey K)
523 : MaterializationUnit(extractFlags(Aliases), std::move(K)),
524 SourceJD(SourceJD), MatchNonExported(MatchNonExported),
525 Aliases(std::move(Aliases)) {}
526
527StringRef ReExportsMaterializationUnit::getName() const {
528 return "<Reexports>";
529}
530
531void ReExportsMaterializationUnit::materialize(
532 MaterializationResponsibility R) {
533
534 auto &ES = R.getTargetJITDylib().getExecutionSession();
535 JITDylib &TgtJD = R.getTargetJITDylib();
536 JITDylib &SrcJD = SourceJD ? *SourceJD : TgtJD;
537
538 // Find the set of requested aliases and aliasees. Return any unrequested
539 // aliases back to the JITDylib so as to not prematurely materialize any
540 // aliasees.
541 auto RequestedSymbols = R.getRequestedSymbols();
542 SymbolAliasMap RequestedAliases;
543
544 for (auto &Name : RequestedSymbols) {
545 auto I = Aliases.find(Name);
546 assert(I != Aliases.end() && "Symbol not found in aliases map?")((I != Aliases.end() && "Symbol not found in aliases map?"
) ? static_cast<void> (0) : __assert_fail ("I != Aliases.end() && \"Symbol not found in aliases map?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 546, __PRETTY_FUNCTION__))
;
547 RequestedAliases[Name] = std::move(I->second);
548 Aliases.erase(I);
549 }
550
551 if (!Aliases.empty()) {
552 if (SourceJD)
553 R.replace(reexports(*SourceJD, std::move(Aliases), MatchNonExported));
554 else
555 R.replace(symbolAliases(std::move(Aliases)));
556 }
557
558 // The OnResolveInfo struct will hold the aliases and responsibilty for each
559 // query in the list.
560 struct OnResolveInfo {
561 OnResolveInfo(MaterializationResponsibility R, SymbolAliasMap Aliases)
562 : R(std::move(R)), Aliases(std::move(Aliases)) {}
563
564 MaterializationResponsibility R;
565 SymbolAliasMap Aliases;
566 };
567
568 // Build a list of queries to issue. In each round we build the largest set of
569 // aliases that we can resolve without encountering a chain definition of the
570 // form Foo -> Bar, Bar -> Baz. Such a form would deadlock as the query would
571 // be waitin on a symbol that it itself had to resolve. Usually this will just
572 // involve one round and a single query.
573
574 std::vector<std::pair<SymbolNameSet, std::shared_ptr<OnResolveInfo>>>
575 QueryInfos;
576 while (!RequestedAliases.empty()) {
577 SymbolNameSet ResponsibilitySymbols;
578 SymbolNameSet QuerySymbols;
579 SymbolAliasMap QueryAliases;
580
581 // Collect as many aliases as we can without including a chain.
582 for (auto &KV : RequestedAliases) {
583 // Chain detected. Skip this symbol for this round.
584 if (&SrcJD == &TgtJD && (QueryAliases.count(KV.second.Aliasee) ||
585 RequestedAliases.count(KV.second.Aliasee)))
586 continue;
587
588 ResponsibilitySymbols.insert(KV.first);
589 QuerySymbols.insert(KV.second.Aliasee);
590 QueryAliases[KV.first] = std::move(KV.second);
591 }
592
593 // Remove the aliases collected this round from the RequestedAliases map.
594 for (auto &KV : QueryAliases)
595 RequestedAliases.erase(KV.first);
596
597 assert(!QuerySymbols.empty() && "Alias cycle detected!")((!QuerySymbols.empty() && "Alias cycle detected!") ?
static_cast<void> (0) : __assert_fail ("!QuerySymbols.empty() && \"Alias cycle detected!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 597, __PRETTY_FUNCTION__))
;
598
599 auto QueryInfo = std::make_shared<OnResolveInfo>(
600 R.delegate(ResponsibilitySymbols), std::move(QueryAliases));
601 QueryInfos.push_back(
602 make_pair(std::move(QuerySymbols), std::move(QueryInfo)));
603 }
604
605 // Issue the queries.
606 while (!QueryInfos.empty()) {
607 auto QuerySymbols = std::move(QueryInfos.back().first);
608 auto QueryInfo = std::move(QueryInfos.back().second);
609
610 QueryInfos.pop_back();
611
612 auto RegisterDependencies = [QueryInfo,
613 &SrcJD](const SymbolDependenceMap &Deps) {
614 // If there were no materializing symbols, just bail out.
615 if (Deps.empty())
616 return;
617
618 // Otherwise the only deps should be on SrcJD.
619 assert(Deps.size() == 1 && Deps.count(&SrcJD) &&((Deps.size() == 1 && Deps.count(&SrcJD) &&
"Unexpected dependencies for reexports") ? static_cast<void
> (0) : __assert_fail ("Deps.size() == 1 && Deps.count(&SrcJD) && \"Unexpected dependencies for reexports\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 620, __PRETTY_FUNCTION__))
620 "Unexpected dependencies for reexports")((Deps.size() == 1 && Deps.count(&SrcJD) &&
"Unexpected dependencies for reexports") ? static_cast<void
> (0) : __assert_fail ("Deps.size() == 1 && Deps.count(&SrcJD) && \"Unexpected dependencies for reexports\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 620, __PRETTY_FUNCTION__))
;
621
622 auto &SrcJDDeps = Deps.find(&SrcJD)->second;
623 SymbolDependenceMap PerAliasDepsMap;
624 auto &PerAliasDeps = PerAliasDepsMap[&SrcJD];
625
626 for (auto &KV : QueryInfo->Aliases)
627 if (SrcJDDeps.count(KV.second.Aliasee)) {
628 PerAliasDeps = {KV.second.Aliasee};
629 QueryInfo->R.addDependencies(KV.first, PerAliasDepsMap);
630 }
631 };
632
633 auto OnResolve = [QueryInfo](Expected<SymbolMap> Result) {
634 if (Result) {
635 SymbolMap ResolutionMap;
636 for (auto &KV : QueryInfo->Aliases) {
637 assert(Result->count(KV.second.Aliasee) &&((Result->count(KV.second.Aliasee) && "Result map missing entry?"
) ? static_cast<void> (0) : __assert_fail ("Result->count(KV.second.Aliasee) && \"Result map missing entry?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 638, __PRETTY_FUNCTION__))
638 "Result map missing entry?")((Result->count(KV.second.Aliasee) && "Result map missing entry?"
) ? static_cast<void> (0) : __assert_fail ("Result->count(KV.second.Aliasee) && \"Result map missing entry?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 638, __PRETTY_FUNCTION__))
;
639 ResolutionMap[KV.first] = JITEvaluatedSymbol(
640 (*Result)[KV.second.Aliasee].getAddress(), KV.second.AliasFlags);
641 }
642 QueryInfo->R.resolve(ResolutionMap);
643 QueryInfo->R.emit();
644 } else {
645 auto &ES = QueryInfo->R.getTargetJITDylib().getExecutionSession();
646 ES.reportError(Result.takeError());
647 QueryInfo->R.failMaterialization();
648 }
649 };
650
651 auto OnReady = [&ES](Error Err) { ES.reportError(std::move(Err)); };
652
653 ES.lookup(JITDylibSearchList({{&SrcJD, MatchNonExported}}), QuerySymbols,
654 std::move(OnResolve), std::move(OnReady),
655 std::move(RegisterDependencies));
656 }
657}
658
659void ReExportsMaterializationUnit::discard(const JITDylib &JD,
660 const SymbolStringPtr &Name) {
661 assert(Aliases.count(Name) &&((Aliases.count(Name) && "Symbol not covered by this MaterializationUnit"
) ? static_cast<void> (0) : __assert_fail ("Aliases.count(Name) && \"Symbol not covered by this MaterializationUnit\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 662, __PRETTY_FUNCTION__))
662 "Symbol not covered by this MaterializationUnit")((Aliases.count(Name) && "Symbol not covered by this MaterializationUnit"
) ? static_cast<void> (0) : __assert_fail ("Aliases.count(Name) && \"Symbol not covered by this MaterializationUnit\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 662, __PRETTY_FUNCTION__))
;
663 Aliases.erase(Name);
664}
665
666SymbolFlagsMap
667ReExportsMaterializationUnit::extractFlags(const SymbolAliasMap &Aliases) {
668 SymbolFlagsMap SymbolFlags;
669 for (auto &KV : Aliases)
670 SymbolFlags[KV.first] = KV.second.AliasFlags;
671
672 return SymbolFlags;
673}
674
675Expected<SymbolAliasMap>
676buildSimpleReexportsAliasMap(JITDylib &SourceJD, const SymbolNameSet &Symbols) {
677 auto Flags = SourceJD.lookupFlags(Symbols);
678
679 if (!Flags)
680 return Flags.takeError();
681
682 if (Flags->size() != Symbols.size()) {
683 SymbolNameSet Unresolved = Symbols;
684 for (auto &KV : *Flags)
685 Unresolved.erase(KV.first);
686 return make_error<SymbolsNotFound>(std::move(Unresolved));
687 }
688
689 SymbolAliasMap Result;
690 for (auto &Name : Symbols) {
691 assert(Flags->count(Name) && "Missing entry in flags map")((Flags->count(Name) && "Missing entry in flags map"
) ? static_cast<void> (0) : __assert_fail ("Flags->count(Name) && \"Missing entry in flags map\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 691, __PRETTY_FUNCTION__))
;
692 Result[Name] = SymbolAliasMapEntry(Name, (*Flags)[Name]);
693 }
694
695 return Result;
696}
697
698ReexportsGenerator::ReexportsGenerator(JITDylib &SourceJD,
699 bool MatchNonExported,
700 SymbolPredicate Allow)
701 : SourceJD(SourceJD), MatchNonExported(MatchNonExported),
702 Allow(std::move(Allow)) {}
703
704Expected<SymbolNameSet>
705ReexportsGenerator::operator()(JITDylib &JD, const SymbolNameSet &Names) {
706 orc::SymbolNameSet Added;
707 orc::SymbolAliasMap AliasMap;
708
709 auto Flags = SourceJD.lookupFlags(Names);
710
711 if (!Flags)
712 return Flags.takeError();
713
714 for (auto &KV : *Flags) {
715 if (Allow && !Allow(KV.first))
716 continue;
717 AliasMap[KV.first] = SymbolAliasMapEntry(KV.first, KV.second);
718 Added.insert(KV.first);
719 }
720
721 if (!Added.empty())
722 cantFail(JD.define(reexports(SourceJD, AliasMap, MatchNonExported)));
723
724 return Added;
725}
726
727Error JITDylib::defineMaterializing(const SymbolFlagsMap &SymbolFlags) {
728 return ES.runSessionLocked([&]() -> Error {
2
Calling 'ExecutionSession::runSessionLocked'
729 std::vector<SymbolTable::iterator> AddedSyms;
730
731 for (auto &KV : SymbolFlags) {
732 SymbolTable::iterator EntryItr;
733 bool Added;
734
735 std::tie(EntryItr, Added) =
736 Symbols.insert(std::make_pair(KV.first, SymbolTableEntry(KV.second)));
737
738 if (Added) {
4
Assuming 'Added' is 0
5
Taking false branch
739 AddedSyms.push_back(EntryItr);
740 EntryItr->second.setState(SymbolState::Materializing);
741 } else {
742 // Remove any symbols already added.
743 for (auto &SI : AddedSyms)
744 Symbols.erase(SI);
745
746 // FIXME: Return all duplicates.
747 return make_error<DuplicateDefinition>(*KV.first);
6
Calling 'make_error<llvm::orc::DuplicateDefinition, llvm::StringRef>'
748 }
749 }
750
751 return Error::success();
752 });
753}
754
755void JITDylib::replace(std::unique_ptr<MaterializationUnit> MU) {
756 assert(MU != nullptr && "Can not replace with a null MaterializationUnit")((MU != nullptr && "Can not replace with a null MaterializationUnit"
) ? static_cast<void> (0) : __assert_fail ("MU != nullptr && \"Can not replace with a null MaterializationUnit\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 756, __PRETTY_FUNCTION__))
;
757
758 auto MustRunMU =
759 ES.runSessionLocked([&, this]() -> std::unique_ptr<MaterializationUnit> {
760
761#ifndef NDEBUG
762 for (auto &KV : MU->getSymbols()) {
763 auto SymI = Symbols.find(KV.first);
764 assert(SymI != Symbols.end() && "Replacing unknown symbol")((SymI != Symbols.end() && "Replacing unknown symbol"
) ? static_cast<void> (0) : __assert_fail ("SymI != Symbols.end() && \"Replacing unknown symbol\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 764, __PRETTY_FUNCTION__))
;
765 assert(SymI->second.isInMaterializationPhase() &&((SymI->second.isInMaterializationPhase() && "Can not call replace on a symbol that is not materializing"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.isInMaterializationPhase() && \"Can not call replace on a symbol that is not materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 766, __PRETTY_FUNCTION__))
766 "Can not call replace on a symbol that is not materializing")((SymI->second.isInMaterializationPhase() && "Can not call replace on a symbol that is not materializing"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.isInMaterializationPhase() && \"Can not call replace on a symbol that is not materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 766, __PRETTY_FUNCTION__))
;
767 assert(!SymI->second.hasMaterializerAttached() &&((!SymI->second.hasMaterializerAttached() && "Symbol should not have materializer attached already"
) ? static_cast<void> (0) : __assert_fail ("!SymI->second.hasMaterializerAttached() && \"Symbol should not have materializer attached already\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 768, __PRETTY_FUNCTION__))
768 "Symbol should not have materializer attached already")((!SymI->second.hasMaterializerAttached() && "Symbol should not have materializer attached already"
) ? static_cast<void> (0) : __assert_fail ("!SymI->second.hasMaterializerAttached() && \"Symbol should not have materializer attached already\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 768, __PRETTY_FUNCTION__))
;
769 assert(UnmaterializedInfos.count(KV.first) == 0 &&((UnmaterializedInfos.count(KV.first) == 0 && "Symbol being replaced should have no UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UnmaterializedInfos.count(KV.first) == 0 && \"Symbol being replaced should have no UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 770, __PRETTY_FUNCTION__))
770 "Symbol being replaced should have no UnmaterializedInfo")((UnmaterializedInfos.count(KV.first) == 0 && "Symbol being replaced should have no UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UnmaterializedInfos.count(KV.first) == 0 && \"Symbol being replaced should have no UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 770, __PRETTY_FUNCTION__))
;
771 }
772#endif // NDEBUG
773
774 // If any symbol has pending queries against it then we need to
775 // materialize MU immediately.
776 for (auto &KV : MU->getSymbols()) {
777 auto MII = MaterializingInfos.find(KV.first);
778 if (MII != MaterializingInfos.end()) {
779 if (!MII->second.PendingQueries.empty())
780 return std::move(MU);
781 }
782 }
783
784 // Otherwise, make MU responsible for all the symbols.
785 auto UMI = std::make_shared<UnmaterializedInfo>(std::move(MU));
786 for (auto &KV : UMI->MU->getSymbols()) {
787 auto SymI = Symbols.find(KV.first);
788 assert(SymI->second.getState() == SymbolState::Materializing &&((SymI->second.getState() == SymbolState::Materializing &&
"Can not replace a symbol that is not materializing") ? static_cast
<void> (0) : __assert_fail ("SymI->second.getState() == SymbolState::Materializing && \"Can not replace a symbol that is not materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 789, __PRETTY_FUNCTION__))
789 "Can not replace a symbol that is not materializing")((SymI->second.getState() == SymbolState::Materializing &&
"Can not replace a symbol that is not materializing") ? static_cast
<void> (0) : __assert_fail ("SymI->second.getState() == SymbolState::Materializing && \"Can not replace a symbol that is not materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 789, __PRETTY_FUNCTION__))
;
790 assert(!SymI->second.hasMaterializerAttached() &&((!SymI->second.hasMaterializerAttached() && "Can not replace a symbol that has a materializer attached"
) ? static_cast<void> (0) : __assert_fail ("!SymI->second.hasMaterializerAttached() && \"Can not replace a symbol that has a materializer attached\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 791, __PRETTY_FUNCTION__))
791 "Can not replace a symbol that has a materializer attached")((!SymI->second.hasMaterializerAttached() && "Can not replace a symbol that has a materializer attached"
) ? static_cast<void> (0) : __assert_fail ("!SymI->second.hasMaterializerAttached() && \"Can not replace a symbol that has a materializer attached\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 791, __PRETTY_FUNCTION__))
;
792 assert(UnmaterializedInfos.count(KV.first) == 0 &&((UnmaterializedInfos.count(KV.first) == 0 && "Unexpected materializer entry in map"
) ? static_cast<void> (0) : __assert_fail ("UnmaterializedInfos.count(KV.first) == 0 && \"Unexpected materializer entry in map\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 793, __PRETTY_FUNCTION__))
793 "Unexpected materializer entry in map")((UnmaterializedInfos.count(KV.first) == 0 && "Unexpected materializer entry in map"
) ? static_cast<void> (0) : __assert_fail ("UnmaterializedInfos.count(KV.first) == 0 && \"Unexpected materializer entry in map\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 793, __PRETTY_FUNCTION__))
;
794 SymI->second.setAddress(SymI->second.getAddress());
795 SymI->second.setMaterializerAttached(true);
796 UnmaterializedInfos[KV.first] = UMI;
797 }
798
799 return nullptr;
800 });
801
802 if (MustRunMU)
803 ES.dispatchMaterialization(*this, std::move(MustRunMU));
804}
805
806SymbolNameSet
807JITDylib::getRequestedSymbols(const SymbolFlagsMap &SymbolFlags) const {
808 return ES.runSessionLocked([&]() {
809 SymbolNameSet RequestedSymbols;
810
811 for (auto &KV : SymbolFlags) {
812 assert(Symbols.count(KV.first) && "JITDylib does not cover this symbol?")((Symbols.count(KV.first) && "JITDylib does not cover this symbol?"
) ? static_cast<void> (0) : __assert_fail ("Symbols.count(KV.first) && \"JITDylib does not cover this symbol?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 812, __PRETTY_FUNCTION__))
;
813 assert(Symbols.find(KV.first)->second.isInMaterializationPhase() &&((Symbols.find(KV.first)->second.isInMaterializationPhase(
) && "getRequestedSymbols can only be called for symbols that have "
"started materializing") ? static_cast<void> (0) : __assert_fail
("Symbols.find(KV.first)->second.isInMaterializationPhase() && \"getRequestedSymbols can only be called for symbols that have \" \"started materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 815, __PRETTY_FUNCTION__))
814 "getRequestedSymbols can only be called for symbols that have "((Symbols.find(KV.first)->second.isInMaterializationPhase(
) && "getRequestedSymbols can only be called for symbols that have "
"started materializing") ? static_cast<void> (0) : __assert_fail
("Symbols.find(KV.first)->second.isInMaterializationPhase() && \"getRequestedSymbols can only be called for symbols that have \" \"started materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 815, __PRETTY_FUNCTION__))
815 "started materializing")((Symbols.find(KV.first)->second.isInMaterializationPhase(
) && "getRequestedSymbols can only be called for symbols that have "
"started materializing") ? static_cast<void> (0) : __assert_fail
("Symbols.find(KV.first)->second.isInMaterializationPhase() && \"getRequestedSymbols can only be called for symbols that have \" \"started materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 815, __PRETTY_FUNCTION__))
;
816 auto I = MaterializingInfos.find(KV.first);
817 if (I == MaterializingInfos.end())
818 continue;
819
820 if (!I->second.PendingQueries.empty())
821 RequestedSymbols.insert(KV.first);
822 }
823
824 return RequestedSymbols;
825 });
826}
827
828void JITDylib::addDependencies(const SymbolStringPtr &Name,
829 const SymbolDependenceMap &Dependencies) {
830 assert(Symbols.count(Name) && "Name not in symbol table")((Symbols.count(Name) && "Name not in symbol table") ?
static_cast<void> (0) : __assert_fail ("Symbols.count(Name) && \"Name not in symbol table\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 830, __PRETTY_FUNCTION__))
;
831 assert(Symbols[Name].isInMaterializationPhase() &&((Symbols[Name].isInMaterializationPhase() && "Can not add dependencies for a symbol that is not materializing"
) ? static_cast<void> (0) : __assert_fail ("Symbols[Name].isInMaterializationPhase() && \"Can not add dependencies for a symbol that is not materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 832, __PRETTY_FUNCTION__))
832 "Can not add dependencies for a symbol that is not materializing")((Symbols[Name].isInMaterializationPhase() && "Can not add dependencies for a symbol that is not materializing"
) ? static_cast<void> (0) : __assert_fail ("Symbols[Name].isInMaterializationPhase() && \"Can not add dependencies for a symbol that is not materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 832, __PRETTY_FUNCTION__))
;
833
834 auto &MI = MaterializingInfos[Name];
835 assert(!MI.IsEmitted && "Can not add dependencies to an emitted symbol")((!MI.IsEmitted && "Can not add dependencies to an emitted symbol"
) ? static_cast<void> (0) : __assert_fail ("!MI.IsEmitted && \"Can not add dependencies to an emitted symbol\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 835, __PRETTY_FUNCTION__))
;
836
837 for (auto &KV : Dependencies) {
838 assert(KV.first && "Null JITDylib in dependency?")((KV.first && "Null JITDylib in dependency?") ? static_cast
<void> (0) : __assert_fail ("KV.first && \"Null JITDylib in dependency?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 838, __PRETTY_FUNCTION__))
;
839 auto &OtherJITDylib = *KV.first;
840 auto &DepsOnOtherJITDylib = MI.UnemittedDependencies[&OtherJITDylib];
841
842 for (auto &OtherSymbol : KV.second) {
843#ifndef NDEBUG
844 // Assert that this symbol exists and has not been emitted already.
845 auto SymI = OtherJITDylib.Symbols.find(OtherSymbol);
846 assert(SymI != OtherJITDylib.Symbols.end() &&((SymI != OtherJITDylib.Symbols.end() && (SymI->second
.getState() != SymbolState::Ready && "Dependency on emitted symbol"
)) ? static_cast<void> (0) : __assert_fail ("SymI != OtherJITDylib.Symbols.end() && (SymI->second.getState() != SymbolState::Ready && \"Dependency on emitted symbol\")"
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 848, __PRETTY_FUNCTION__))
847 (SymI->second.getState() != SymbolState::Ready &&((SymI != OtherJITDylib.Symbols.end() && (SymI->second
.getState() != SymbolState::Ready && "Dependency on emitted symbol"
)) ? static_cast<void> (0) : __assert_fail ("SymI != OtherJITDylib.Symbols.end() && (SymI->second.getState() != SymbolState::Ready && \"Dependency on emitted symbol\")"
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 848, __PRETTY_FUNCTION__))
848 "Dependency on emitted symbol"))((SymI != OtherJITDylib.Symbols.end() && (SymI->second
.getState() != SymbolState::Ready && "Dependency on emitted symbol"
)) ? static_cast<void> (0) : __assert_fail ("SymI != OtherJITDylib.Symbols.end() && (SymI->second.getState() != SymbolState::Ready && \"Dependency on emitted symbol\")"
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 848, __PRETTY_FUNCTION__))
;
849#endif
850
851 auto &OtherMI = OtherJITDylib.MaterializingInfos[OtherSymbol];
852
853 if (OtherMI.IsEmitted)
854 transferEmittedNodeDependencies(MI, Name, OtherMI);
855 else if (&OtherJITDylib != this || OtherSymbol != Name) {
856 OtherMI.Dependants[this].insert(Name);
857 DepsOnOtherJITDylib.insert(OtherSymbol);
858 }
859 }
860
861 if (DepsOnOtherJITDylib.empty())
862 MI.UnemittedDependencies.erase(&OtherJITDylib);
863 }
864}
865
866void JITDylib::resolve(const SymbolMap &Resolved) {
867 auto FullyResolvedQueries = ES.runSessionLocked([&, this]() {
868 AsynchronousSymbolQuerySet FullyResolvedQueries;
869 for (const auto &KV : Resolved) {
870 auto &Name = KV.first;
871 auto Sym = KV.second;
872
873 auto I = Symbols.find(Name);
874
875 assert(I != Symbols.end() && "Symbol not found")((I != Symbols.end() && "Symbol not found") ? static_cast
<void> (0) : __assert_fail ("I != Symbols.end() && \"Symbol not found\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 875, __PRETTY_FUNCTION__))
;
876 assert(!I->second.hasMaterializerAttached() &&((!I->second.hasMaterializerAttached() && "Resolving symbol with materializer attached?"
) ? static_cast<void> (0) : __assert_fail ("!I->second.hasMaterializerAttached() && \"Resolving symbol with materializer attached?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 877, __PRETTY_FUNCTION__))
877 "Resolving symbol with materializer attached?")((!I->second.hasMaterializerAttached() && "Resolving symbol with materializer attached?"
) ? static_cast<void> (0) : __assert_fail ("!I->second.hasMaterializerAttached() && \"Resolving symbol with materializer attached?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 877, __PRETTY_FUNCTION__))
;
878 assert(I->second.getState() == SymbolState::Materializing &&((I->second.getState() == SymbolState::Materializing &&
"Symbol should be materializing") ? static_cast<void> (
0) : __assert_fail ("I->second.getState() == SymbolState::Materializing && \"Symbol should be materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 879, __PRETTY_FUNCTION__))
879 "Symbol should be materializing")((I->second.getState() == SymbolState::Materializing &&
"Symbol should be materializing") ? static_cast<void> (
0) : __assert_fail ("I->second.getState() == SymbolState::Materializing && \"Symbol should be materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 879, __PRETTY_FUNCTION__))
;
880 assert(I->second.getAddress() == 0 && "Symbol has already been resolved")((I->second.getAddress() == 0 && "Symbol has already been resolved"
) ? static_cast<void> (0) : __assert_fail ("I->second.getAddress() == 0 && \"Symbol has already been resolved\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 880, __PRETTY_FUNCTION__))
;
881
882 assert((Sym.getFlags() & ~JITSymbolFlags::Weak) ==(((Sym.getFlags() & ~JITSymbolFlags::Weak) == (I->second
.getFlags() & ~JITSymbolFlags::Weak) && "Resolved flags should match the declared flags"
) ? static_cast<void> (0) : __assert_fail ("(Sym.getFlags() & ~JITSymbolFlags::Weak) == (I->second.getFlags() & ~JITSymbolFlags::Weak) && \"Resolved flags should match the declared flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 884, __PRETTY_FUNCTION__))
883 (I->second.getFlags() & ~JITSymbolFlags::Weak) &&(((Sym.getFlags() & ~JITSymbolFlags::Weak) == (I->second
.getFlags() & ~JITSymbolFlags::Weak) && "Resolved flags should match the declared flags"
) ? static_cast<void> (0) : __assert_fail ("(Sym.getFlags() & ~JITSymbolFlags::Weak) == (I->second.getFlags() & ~JITSymbolFlags::Weak) && \"Resolved flags should match the declared flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 884, __PRETTY_FUNCTION__))
884 "Resolved flags should match the declared flags")(((Sym.getFlags() & ~JITSymbolFlags::Weak) == (I->second
.getFlags() & ~JITSymbolFlags::Weak) && "Resolved flags should match the declared flags"
) ? static_cast<void> (0) : __assert_fail ("(Sym.getFlags() & ~JITSymbolFlags::Weak) == (I->second.getFlags() & ~JITSymbolFlags::Weak) && \"Resolved flags should match the declared flags\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 884, __PRETTY_FUNCTION__))
;
885
886 // Once resolved, symbols can never be weak.
887 JITSymbolFlags ResolvedFlags = Sym.getFlags();
888 ResolvedFlags &= ~JITSymbolFlags::Weak;
889 I->second.setAddress(Sym.getAddress());
890 I->second.setFlags(ResolvedFlags);
891 I->second.setState(SymbolState::Resolved);
892
893 auto &MI = MaterializingInfos[Name];
894 for (auto &Q : MI.PendingQueries) {
895 Q->resolve(Name, Sym);
896 if (Q->isFullyResolved())
897 FullyResolvedQueries.insert(Q);
898 }
899 }
900
901 return FullyResolvedQueries;
902 });
903
904 for (auto &Q : FullyResolvedQueries) {
905 assert(Q->isFullyResolved() && "Q not fully resolved")((Q->isFullyResolved() && "Q not fully resolved") ?
static_cast<void> (0) : __assert_fail ("Q->isFullyResolved() && \"Q not fully resolved\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 905, __PRETTY_FUNCTION__))
;
906 Q->handleFullyResolved();
907 }
908}
909
910void JITDylib::emit(const SymbolFlagsMap &Emitted) {
911 auto FullyReadyQueries = ES.runSessionLocked([&, this]() {
912 AsynchronousSymbolQuerySet ReadyQueries;
913
914 for (const auto &KV : Emitted) {
915 const auto &Name = KV.first;
916
917 auto MII = MaterializingInfos.find(Name);
918 assert(MII != MaterializingInfos.end() &&((MII != MaterializingInfos.end() && "Missing MaterializingInfo entry"
) ? static_cast<void> (0) : __assert_fail ("MII != MaterializingInfos.end() && \"Missing MaterializingInfo entry\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 919, __PRETTY_FUNCTION__))
919 "Missing MaterializingInfo entry")((MII != MaterializingInfos.end() && "Missing MaterializingInfo entry"
) ? static_cast<void> (0) : __assert_fail ("MII != MaterializingInfos.end() && \"Missing MaterializingInfo entry\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 919, __PRETTY_FUNCTION__))
;
920
921 auto &MI = MII->second;
922
923 // For each dependant, transfer this node's emitted dependencies to
924 // it. If the dependant node is ready (i.e. has no unemitted
925 // dependencies) then notify any pending queries.
926 for (auto &KV : MI.Dependants) {
927 auto &DependantJD = *KV.first;
928 for (auto &DependantName : KV.second) {
929 auto DependantMII =
930 DependantJD.MaterializingInfos.find(DependantName);
931 assert(DependantMII != DependantJD.MaterializingInfos.end() &&((DependantMII != DependantJD.MaterializingInfos.end() &&
"Dependant should have MaterializingInfo") ? static_cast<
void> (0) : __assert_fail ("DependantMII != DependantJD.MaterializingInfos.end() && \"Dependant should have MaterializingInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 932, __PRETTY_FUNCTION__))
932 "Dependant should have MaterializingInfo")((DependantMII != DependantJD.MaterializingInfos.end() &&
"Dependant should have MaterializingInfo") ? static_cast<
void> (0) : __assert_fail ("DependantMII != DependantJD.MaterializingInfos.end() && \"Dependant should have MaterializingInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 932, __PRETTY_FUNCTION__))
;
933
934 auto &DependantMI = DependantMII->second;
935
936 // Remove the dependant's dependency on this node.
937 assert(DependantMI.UnemittedDependencies[this].count(Name) &&((DependantMI.UnemittedDependencies[this].count(Name) &&
"Dependant does not count this symbol as a dependency?") ? static_cast
<void> (0) : __assert_fail ("DependantMI.UnemittedDependencies[this].count(Name) && \"Dependant does not count this symbol as a dependency?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 938, __PRETTY_FUNCTION__))
938 "Dependant does not count this symbol as a dependency?")((DependantMI.UnemittedDependencies[this].count(Name) &&
"Dependant does not count this symbol as a dependency?") ? static_cast
<void> (0) : __assert_fail ("DependantMI.UnemittedDependencies[this].count(Name) && \"Dependant does not count this symbol as a dependency?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 938, __PRETTY_FUNCTION__))
;
939 DependantMI.UnemittedDependencies[this].erase(Name);
940 if (DependantMI.UnemittedDependencies[this].empty())
941 DependantMI.UnemittedDependencies.erase(this);
942
943 // Transfer unemitted dependencies from this node to the dependant.
944 DependantJD.transferEmittedNodeDependencies(DependantMI,
945 DependantName, MI);
946
947 // If the dependant is emitted and this node was the last of its
948 // unemitted dependencies then the dependant node is now ready, so
949 // notify any pending queries on the dependant node.
950 if (DependantMI.IsEmitted &&
951 DependantMI.UnemittedDependencies.empty()) {
952 assert(DependantMI.Dependants.empty() &&((DependantMI.Dependants.empty() && "Dependants should be empty by now"
) ? static_cast<void> (0) : __assert_fail ("DependantMI.Dependants.empty() && \"Dependants should be empty by now\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 953, __PRETTY_FUNCTION__))
953 "Dependants should be empty by now")((DependantMI.Dependants.empty() && "Dependants should be empty by now"
) ? static_cast<void> (0) : __assert_fail ("DependantMI.Dependants.empty() && \"Dependants should be empty by now\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 953, __PRETTY_FUNCTION__))
;
954 for (auto &Q : DependantMI.PendingQueries) {
955 Q->notifySymbolReady();
956 if (Q->isFullyReady())
957 ReadyQueries.insert(Q);
958 Q->removeQueryDependence(DependantJD, DependantName);
959 }
960
961 // Since this dependant is now ready, we erase its MaterializingInfo
962 // and update its materializing state.
963 assert(DependantJD.Symbols.count(DependantName) &&((DependantJD.Symbols.count(DependantName) && "Dependant has no entry in the Symbols table"
) ? static_cast<void> (0) : __assert_fail ("DependantJD.Symbols.count(DependantName) && \"Dependant has no entry in the Symbols table\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 964, __PRETTY_FUNCTION__))
964 "Dependant has no entry in the Symbols table")((DependantJD.Symbols.count(DependantName) && "Dependant has no entry in the Symbols table"
) ? static_cast<void> (0) : __assert_fail ("DependantJD.Symbols.count(DependantName) && \"Dependant has no entry in the Symbols table\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 964, __PRETTY_FUNCTION__))
;
965 DependantJD.Symbols[DependantName].setState(SymbolState::Ready);
966 DependantJD.MaterializingInfos.erase(DependantMII);
967 }
968 }
969 }
970 MI.Dependants.clear();
971 MI.IsEmitted = true;
972
973 if (MI.UnemittedDependencies.empty()) {
974 for (auto &Q : MI.PendingQueries) {
975 Q->notifySymbolReady();
976 if (Q->isFullyReady())
977 ReadyQueries.insert(Q);
978 Q->removeQueryDependence(*this, Name);
979 }
980 assert(Symbols.count(Name) &&((Symbols.count(Name) && "Symbol has no entry in the Symbols table"
) ? static_cast<void> (0) : __assert_fail ("Symbols.count(Name) && \"Symbol has no entry in the Symbols table\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 981, __PRETTY_FUNCTION__))
981 "Symbol has no entry in the Symbols table")((Symbols.count(Name) && "Symbol has no entry in the Symbols table"
) ? static_cast<void> (0) : __assert_fail ("Symbols.count(Name) && \"Symbol has no entry in the Symbols table\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 981, __PRETTY_FUNCTION__))
;
982 Symbols[Name].setState(SymbolState::Ready);
983 MaterializingInfos.erase(MII);
984 }
985 }
986
987 return ReadyQueries;
988 });
989
990 for (auto &Q : FullyReadyQueries) {
991 assert(Q->isFullyReady() && "Q is not fully ready")((Q->isFullyReady() && "Q is not fully ready") ? static_cast
<void> (0) : __assert_fail ("Q->isFullyReady() && \"Q is not fully ready\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 991, __PRETTY_FUNCTION__))
;
992 Q->handleFullyReady();
993 }
994}
995
996void JITDylib::notifyFailed(const SymbolNameSet &FailedSymbols) {
997
998 // FIXME: This should fail any transitively dependant symbols too.
999
1000 auto FailedQueriesToNotify = ES.runSessionLocked([&, this]() {
1001 AsynchronousSymbolQuerySet FailedQueries;
1002
1003 for (auto &Name : FailedSymbols) {
1004 auto I = Symbols.find(Name);
1005 assert(I != Symbols.end() && "Symbol not present in this JITDylib")((I != Symbols.end() && "Symbol not present in this JITDylib"
) ? static_cast<void> (0) : __assert_fail ("I != Symbols.end() && \"Symbol not present in this JITDylib\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1005, __PRETTY_FUNCTION__))
;
1006 Symbols.erase(I);
1007
1008 auto MII = MaterializingInfos.find(Name);
1009
1010 // If we have not created a MaterializingInfo for this symbol yet then
1011 // there is nobody to notify.
1012 if (MII == MaterializingInfos.end())
1013 continue;
1014
1015 // Remove this symbol from the dependants list of any dependencies.
1016 for (auto &KV : MII->second.UnemittedDependencies) {
1017 auto *DependencyJD = KV.first;
1018 auto &Dependencies = KV.second;
1019 for (auto &DependencyName : Dependencies) {
1020 auto DependencyMII =
1021 DependencyJD->MaterializingInfos.find(DependencyName);
1022 assert(DependencyMII != DependencyJD->MaterializingInfos.end() &&((DependencyMII != DependencyJD->MaterializingInfos.end() &&
"Unemitted dependency must have a MaterializingInfo entry") ?
static_cast<void> (0) : __assert_fail ("DependencyMII != DependencyJD->MaterializingInfos.end() && \"Unemitted dependency must have a MaterializingInfo entry\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1023, __PRETTY_FUNCTION__))
1023 "Unemitted dependency must have a MaterializingInfo entry")((DependencyMII != DependencyJD->MaterializingInfos.end() &&
"Unemitted dependency must have a MaterializingInfo entry") ?
static_cast<void> (0) : __assert_fail ("DependencyMII != DependencyJD->MaterializingInfos.end() && \"Unemitted dependency must have a MaterializingInfo entry\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1023, __PRETTY_FUNCTION__))
;
1024 assert(DependencyMII->second.Dependants.count(this) &&((DependencyMII->second.Dependants.count(this) && "Dependency's dependants list does not contain this JITDylib"
) ? static_cast<void> (0) : __assert_fail ("DependencyMII->second.Dependants.count(this) && \"Dependency's dependants list does not contain this JITDylib\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1025, __PRETTY_FUNCTION__))
1025 "Dependency's dependants list does not contain this JITDylib")((DependencyMII->second.Dependants.count(this) && "Dependency's dependants list does not contain this JITDylib"
) ? static_cast<void> (0) : __assert_fail ("DependencyMII->second.Dependants.count(this) && \"Dependency's dependants list does not contain this JITDylib\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1025, __PRETTY_FUNCTION__))
;
1026 assert(DependencyMII->second.Dependants[this].count(Name) &&((DependencyMII->second.Dependants[this].count(Name) &&
"Dependency's dependants list does not contain dependant") ?
static_cast<void> (0) : __assert_fail ("DependencyMII->second.Dependants[this].count(Name) && \"Dependency's dependants list does not contain dependant\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1027, __PRETTY_FUNCTION__))
1027 "Dependency's dependants list does not contain dependant")((DependencyMII->second.Dependants[this].count(Name) &&
"Dependency's dependants list does not contain dependant") ?
static_cast<void> (0) : __assert_fail ("DependencyMII->second.Dependants[this].count(Name) && \"Dependency's dependants list does not contain dependant\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1027, __PRETTY_FUNCTION__))
;
1028 DependencyMII->second.Dependants[this].erase(Name);
1029 }
1030 }
1031
1032 // Copy all the queries to the FailedQueries list, then abandon them.
1033 // This has to be a copy, and the copy has to come before the abandon
1034 // operation: Each Q.detach() call will reach back into this
1035 // PendingQueries list to remove Q.
1036 for (auto &Q : MII->second.PendingQueries)
1037 FailedQueries.insert(Q);
1038
1039 for (auto &Q : FailedQueries)
1040 Q->detach();
1041
1042 assert(MII->second.PendingQueries.empty() &&((MII->second.PendingQueries.empty() && "Queries remain after symbol was failed"
) ? static_cast<void> (0) : __assert_fail ("MII->second.PendingQueries.empty() && \"Queries remain after symbol was failed\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1043, __PRETTY_FUNCTION__))
1043 "Queries remain after symbol was failed")((MII->second.PendingQueries.empty() && "Queries remain after symbol was failed"
) ? static_cast<void> (0) : __assert_fail ("MII->second.PendingQueries.empty() && \"Queries remain after symbol was failed\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1043, __PRETTY_FUNCTION__))
;
1044
1045 MaterializingInfos.erase(MII);
1046 }
1047
1048 return FailedQueries;
1049 });
1050
1051 for (auto &Q : FailedQueriesToNotify)
1052 Q->handleFailed(make_error<FailedToMaterialize>(FailedSymbols));
1053}
1054
1055void JITDylib::setSearchOrder(JITDylibSearchList NewSearchOrder,
1056 bool SearchThisJITDylibFirst,
1057 bool MatchNonExportedInThisDylib) {
1058 if (SearchThisJITDylibFirst) {
1059 if (NewSearchOrder.empty() || NewSearchOrder.front().first != this)
1060 NewSearchOrder.insert(NewSearchOrder.begin(),
1061 {this, MatchNonExportedInThisDylib});
1062 }
1063
1064 ES.runSessionLocked([&]() { SearchOrder = std::move(NewSearchOrder); });
1065}
1066
1067void JITDylib::addToSearchOrder(JITDylib &JD, bool MatchNonExported) {
1068 ES.runSessionLocked([&]() {
1069 SearchOrder.push_back({&JD, MatchNonExported});
1070 });
1071}
1072
1073void JITDylib::replaceInSearchOrder(JITDylib &OldJD, JITDylib &NewJD,
1074 bool MatchNonExported) {
1075 ES.runSessionLocked([&]() {
1076 auto I = std::find_if(SearchOrder.begin(), SearchOrder.end(),
1077 [&](const JITDylibSearchList::value_type &KV) {
1078 return KV.first == &OldJD;
1079 });
1080
1081 if (I != SearchOrder.end())
1082 *I = {&NewJD, MatchNonExported};
1083 });
1084}
1085
1086void JITDylib::removeFromSearchOrder(JITDylib &JD) {
1087 ES.runSessionLocked([&]() {
1088 auto I = std::find_if(SearchOrder.begin(), SearchOrder.end(),
1089 [&](const JITDylibSearchList::value_type &KV) {
1090 return KV.first == &JD;
1091 });
1092 if (I != SearchOrder.end())
1093 SearchOrder.erase(I);
1094 });
1095}
1096
1097Error JITDylib::remove(const SymbolNameSet &Names) {
1098 return ES.runSessionLocked([&]() -> Error {
1099 using SymbolMaterializerItrPair =
1100 std::pair<SymbolTable::iterator, UnmaterializedInfosMap::iterator>;
1101 std::vector<SymbolMaterializerItrPair> SymbolsToRemove;
1102 SymbolNameSet Missing;
1103 SymbolNameSet Materializing;
1104
1105 for (auto &Name : Names) {
1106 auto I = Symbols.find(Name);
1107
1108 // Note symbol missing.
1109 if (I == Symbols.end()) {
1110 Missing.insert(Name);
1111 continue;
1112 }
1113
1114 // Note symbol materializing.
1115 if (I->second.isInMaterializationPhase()) {
1116 Materializing.insert(Name);
1117 continue;
1118 }
1119
1120 auto UMII = I->second.hasMaterializerAttached()
1121 ? UnmaterializedInfos.find(Name)
1122 : UnmaterializedInfos.end();
1123 SymbolsToRemove.push_back(std::make_pair(I, UMII));
1124 }
1125
1126 // If any of the symbols are not defined, return an error.
1127 if (!Missing.empty())
1128 return make_error<SymbolsNotFound>(std::move(Missing));
1129
1130 // If any of the symbols are currently materializing, return an error.
1131 if (!Materializing.empty())
1132 return make_error<SymbolsCouldNotBeRemoved>(std::move(Materializing));
1133
1134 // Remove the symbols.
1135 for (auto &SymbolMaterializerItrPair : SymbolsToRemove) {
1136 auto UMII = SymbolMaterializerItrPair.second;
1137
1138 // If there is a materializer attached, call discard.
1139 if (UMII != UnmaterializedInfos.end()) {
1140 UMII->second->MU->doDiscard(*this, UMII->first);
1141 UnmaterializedInfos.erase(UMII);
1142 }
1143
1144 auto SymI = SymbolMaterializerItrPair.first;
1145 Symbols.erase(SymI);
1146 }
1147
1148 return Error::success();
1149 });
1150}
1151
1152Expected<SymbolFlagsMap> JITDylib::lookupFlags(const SymbolNameSet &Names) {
1153 return ES.runSessionLocked([&, this]() -> Expected<SymbolFlagsMap> {
1154 SymbolFlagsMap Result;
1155 auto Unresolved = lookupFlagsImpl(Result, Names);
1156 if (!Unresolved)
1157 return Unresolved.takeError();
1158
1159 if (DefGenerator && !Unresolved->empty()) {
1160 auto NewDefs = DefGenerator(*this, *Unresolved);
1161 if (!NewDefs)
1162 return NewDefs.takeError();
1163 if (!NewDefs->empty()) {
1164 auto Unresolved2 = lookupFlagsImpl(Result, *NewDefs);
1165 if (!Unresolved2)
1166 return Unresolved2.takeError();
1167 (void)Unresolved2;
1168 assert(Unresolved2->empty() &&((Unresolved2->empty() && "All fallback defs should have been found by lookupFlagsImpl"
) ? static_cast<void> (0) : __assert_fail ("Unresolved2->empty() && \"All fallback defs should have been found by lookupFlagsImpl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1169, __PRETTY_FUNCTION__))
1169 "All fallback defs should have been found by lookupFlagsImpl")((Unresolved2->empty() && "All fallback defs should have been found by lookupFlagsImpl"
) ? static_cast<void> (0) : __assert_fail ("Unresolved2->empty() && \"All fallback defs should have been found by lookupFlagsImpl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1169, __PRETTY_FUNCTION__))
;
1170 }
1171 };
1172 return Result;
1173 });
1174}
1175
1176Expected<SymbolNameSet> JITDylib::lookupFlagsImpl(SymbolFlagsMap &Flags,
1177 const SymbolNameSet &Names) {
1178 SymbolNameSet Unresolved;
1179
1180 for (auto &Name : Names) {
1181 auto I = Symbols.find(Name);
1182 if (I != Symbols.end()) {
1183 assert(!Flags.count(Name) && "Symbol already present in Flags map")((!Flags.count(Name) && "Symbol already present in Flags map"
) ? static_cast<void> (0) : __assert_fail ("!Flags.count(Name) && \"Symbol already present in Flags map\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1183, __PRETTY_FUNCTION__))
;
1184 Flags[Name] = I->second.getFlags();
1185 } else
1186 Unresolved.insert(Name);
1187 }
1188
1189 return Unresolved;
1190}
1191
1192Error JITDylib::lodgeQuery(std::shared_ptr<AsynchronousSymbolQuery> &Q,
1193 SymbolNameSet &Unresolved, bool MatchNonExported,
1194 MaterializationUnitList &MUs) {
1195 assert(Q && "Query can not be null")((Q && "Query can not be null") ? static_cast<void
> (0) : __assert_fail ("Q && \"Query can not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1195, __PRETTY_FUNCTION__))
;
1196
1197 lodgeQueryImpl(Q, Unresolved, MatchNonExported, MUs);
1198 if (DefGenerator && !Unresolved.empty()) {
1199 auto NewDefs = DefGenerator(*this, Unresolved);
1200 if (!NewDefs)
1201 return NewDefs.takeError();
1202 if (!NewDefs->empty()) {
1203 for (auto &D : *NewDefs)
1204 Unresolved.erase(D);
1205 lodgeQueryImpl(Q, *NewDefs, MatchNonExported, MUs);
1206 assert(NewDefs->empty() &&((NewDefs->empty() && "All fallback defs should have been found by lookupImpl"
) ? static_cast<void> (0) : __assert_fail ("NewDefs->empty() && \"All fallback defs should have been found by lookupImpl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1207, __PRETTY_FUNCTION__))
1207 "All fallback defs should have been found by lookupImpl")((NewDefs->empty() && "All fallback defs should have been found by lookupImpl"
) ? static_cast<void> (0) : __assert_fail ("NewDefs->empty() && \"All fallback defs should have been found by lookupImpl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1207, __PRETTY_FUNCTION__))
;
1208 }
1209 }
1210
1211 return Error::success();
1212}
1213
1214void JITDylib::lodgeQueryImpl(
1215 std::shared_ptr<AsynchronousSymbolQuery> &Q, SymbolNameSet &Unresolved,
1216 bool MatchNonExported,
1217 std::vector<std::unique_ptr<MaterializationUnit>> &MUs) {
1218
1219 std::vector<SymbolStringPtr> ToRemove;
1220 for (auto Name : Unresolved) {
1221
1222 // Search for the name in Symbols. Skip it if not found.
1223 auto SymI = Symbols.find(Name);
1224 if (SymI == Symbols.end())
1225 continue;
1226
1227 // If this is a non exported symbol and we're skipping those then skip it.
1228 if (!SymI->second.getFlags().isExported() && !MatchNonExported)
1229 continue;
1230
1231 // If we matched against Name in JD, mark it to be removed from the Unresolved
1232 // set.
1233 ToRemove.push_back(Name);
1234
1235 if (SymI->second.getState() >= SymbolState::Resolved) {
1236 assert(!SymI->second.hasMaterializerAttached() &&((!SymI->second.hasMaterializerAttached() && "Resolved symbols should not have materializers attached"
) ? static_cast<void> (0) : __assert_fail ("!SymI->second.hasMaterializerAttached() && \"Resolved symbols should not have materializers attached\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1237, __PRETTY_FUNCTION__))
1237 "Resolved symbols should not have materializers attached")((!SymI->second.hasMaterializerAttached() && "Resolved symbols should not have materializers attached"
) ? static_cast<void> (0) : __assert_fail ("!SymI->second.hasMaterializerAttached() && \"Resolved symbols should not have materializers attached\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1237, __PRETTY_FUNCTION__))
;
1238 Q->resolve(Name, SymI->second.getSymbol());
1239 if (SymI->second.getState() == SymbolState::Ready) {
1240 Q->notifySymbolReady();
1241 continue;
1242 }
1243 } else if (SymI->second.hasMaterializerAttached()) {
1244 assert(SymI->second.getAddress() == 0 &&((SymI->second.getAddress() == 0 && "Symbol not resolved but already has address?"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.getAddress() == 0 && \"Symbol not resolved but already has address?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1245, __PRETTY_FUNCTION__))
1245 "Symbol not resolved but already has address?")((SymI->second.getAddress() == 0 && "Symbol not resolved but already has address?"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.getAddress() == 0 && \"Symbol not resolved but already has address?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1245, __PRETTY_FUNCTION__))
;
1246 auto UMII = UnmaterializedInfos.find(Name);
1247 assert(UMII != UnmaterializedInfos.end() &&((UMII != UnmaterializedInfos.end() && "Lazy symbol should have UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UMII != UnmaterializedInfos.end() && \"Lazy symbol should have UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1248, __PRETTY_FUNCTION__))
1248 "Lazy symbol should have UnmaterializedInfo")((UMII != UnmaterializedInfos.end() && "Lazy symbol should have UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UMII != UnmaterializedInfos.end() && \"Lazy symbol should have UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1248, __PRETTY_FUNCTION__))
;
1249 auto MU = std::move(UMII->second->MU);
1250 assert(MU != nullptr && "Materializer should not be null")((MU != nullptr && "Materializer should not be null")
? static_cast<void> (0) : __assert_fail ("MU != nullptr && \"Materializer should not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1250, __PRETTY_FUNCTION__))
;
1251
1252 // Move all symbols associated with this MaterializationUnit into
1253 // materializing state.
1254 for (auto &KV : MU->getSymbols()) {
1255 auto SymK = Symbols.find(KV.first);
1256 SymK->second.setMaterializerAttached(false);
1257 SymK->second.setState(SymbolState::Materializing);
1258 UnmaterializedInfos.erase(KV.first);
1259 }
1260
1261 // Add MU to the list of MaterializationUnits to be materialized.
1262 MUs.push_back(std::move(MU));
1263 }
1264
1265 // Add the query to the PendingQueries list.
1266 assert(SymI->second.isInMaterializationPhase() &&((SymI->second.isInMaterializationPhase() && "By this line the symbol should be materializing"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.isInMaterializationPhase() && \"By this line the symbol should be materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1267, __PRETTY_FUNCTION__))
1267 "By this line the symbol should be materializing")((SymI->second.isInMaterializationPhase() && "By this line the symbol should be materializing"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.isInMaterializationPhase() && \"By this line the symbol should be materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1267, __PRETTY_FUNCTION__))
;
1268 auto &MI = MaterializingInfos[Name];
1269 MI.PendingQueries.push_back(Q);
1270 Q->addQueryDependence(*this, Name);
1271 }
1272
1273 // Remove any symbols that we found.
1274 for (auto &Name : ToRemove)
1275 Unresolved.erase(Name);
1276}
1277
1278Expected<SymbolNameSet>
1279JITDylib::legacyLookup(std::shared_ptr<AsynchronousSymbolQuery> Q,
1280 SymbolNameSet Names) {
1281 assert(Q && "Query can not be null")((Q && "Query can not be null") ? static_cast<void
> (0) : __assert_fail ("Q && \"Query can not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1281, __PRETTY_FUNCTION__))
;
1282
1283 ES.runOutstandingMUs();
1284
1285 LookupImplActionFlags ActionFlags = None;
1286 std::vector<std::unique_ptr<MaterializationUnit>> MUs;
1287
1288 SymbolNameSet Unresolved = std::move(Names);
1289 auto Err = ES.runSessionLocked([&, this]() -> Error {
1290 ActionFlags = lookupImpl(Q, MUs, Unresolved);
1291 if (DefGenerator && !Unresolved.empty()) {
1292 assert(ActionFlags == None &&((ActionFlags == None && "ActionFlags set but unresolved symbols remain?"
) ? static_cast<void> (0) : __assert_fail ("ActionFlags == None && \"ActionFlags set but unresolved symbols remain?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1293, __PRETTY_FUNCTION__))
1293 "ActionFlags set but unresolved symbols remain?")((ActionFlags == None && "ActionFlags set but unresolved symbols remain?"
) ? static_cast<void> (0) : __assert_fail ("ActionFlags == None && \"ActionFlags set but unresolved symbols remain?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1293, __PRETTY_FUNCTION__))
;
1294 auto NewDefs = DefGenerator(*this, Unresolved);
1295 if (!NewDefs)
1296 return NewDefs.takeError();
1297 if (!NewDefs->empty()) {
1298 for (auto &D : *NewDefs)
1299 Unresolved.erase(D);
1300 ActionFlags = lookupImpl(Q, MUs, *NewDefs);
1301 assert(NewDefs->empty() &&((NewDefs->empty() && "All fallback defs should have been found by lookupImpl"
) ? static_cast<void> (0) : __assert_fail ("NewDefs->empty() && \"All fallback defs should have been found by lookupImpl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1302, __PRETTY_FUNCTION__))
1302 "All fallback defs should have been found by lookupImpl")((NewDefs->empty() && "All fallback defs should have been found by lookupImpl"
) ? static_cast<void> (0) : __assert_fail ("NewDefs->empty() && \"All fallback defs should have been found by lookupImpl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1302, __PRETTY_FUNCTION__))
;
1303 }
1304 }
1305 return Error::success();
1306 });
1307
1308 if (Err)
1309 return std::move(Err);
1310
1311 assert((MUs.empty() || ActionFlags == None) &&(((MUs.empty() || ActionFlags == None) && "If action flags are set, there should be no work to do (so no MUs)"
) ? static_cast<void> (0) : __assert_fail ("(MUs.empty() || ActionFlags == None) && \"If action flags are set, there should be no work to do (so no MUs)\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1312, __PRETTY_FUNCTION__))
1312 "If action flags are set, there should be no work to do (so no MUs)")(((MUs.empty() || ActionFlags == None) && "If action flags are set, there should be no work to do (so no MUs)"
) ? static_cast<void> (0) : __assert_fail ("(MUs.empty() || ActionFlags == None) && \"If action flags are set, there should be no work to do (so no MUs)\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1312, __PRETTY_FUNCTION__))
;
1313
1314 if (ActionFlags & NotifyFullyResolved)
1315 Q->handleFullyResolved();
1316
1317 if (ActionFlags & NotifyFullyReady)
1318 Q->handleFullyReady();
1319
1320 // FIXME: Swap back to the old code below once RuntimeDyld works with
1321 // callbacks from asynchronous queries.
1322 // Add MUs to the OutstandingMUs list.
1323 {
1324 std::lock_guard<std::recursive_mutex> Lock(ES.OutstandingMUsMutex);
1325 for (auto &MU : MUs)
1326 ES.OutstandingMUs.push_back(make_pair(this, std::move(MU)));
1327 }
1328 ES.runOutstandingMUs();
1329
1330 // Dispatch any required MaterializationUnits for materialization.
1331 // for (auto &MU : MUs)
1332 // ES.dispatchMaterialization(*this, std::move(MU));
1333
1334 return Unresolved;
1335}
1336
1337JITDylib::LookupImplActionFlags
1338JITDylib::lookupImpl(std::shared_ptr<AsynchronousSymbolQuery> &Q,
1339 std::vector<std::unique_ptr<MaterializationUnit>> &MUs,
1340 SymbolNameSet &Unresolved) {
1341 LookupImplActionFlags ActionFlags = None;
1342 std::vector<SymbolStringPtr> ToRemove;
1343
1344 for (auto Name : Unresolved) {
1345
1346 // Search for the name in Symbols. Skip it if not found.
1347 auto SymI = Symbols.find(Name);
1348 if (SymI == Symbols.end())
1349 continue;
1350
1351 // If we found Name, mark it to be removed from the Unresolved set.
1352 ToRemove.push_back(Name);
1353
1354 // If the symbol has an address then resolve it.
1355 if (SymI->second.getAddress() != 0) {
1356 Q->resolve(Name, SymI->second.getSymbol());
1357 if (Q->isFullyResolved())
1358 ActionFlags |= NotifyFullyResolved;
1359 }
1360
1361 // If the symbol is lazy, get the MaterialiaztionUnit for it.
1362 if (SymI->second.hasMaterializerAttached()) {
1363 assert(SymI->second.getAddress() == 0 &&((SymI->second.getAddress() == 0 && "Lazy symbol should not have a resolved address"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.getAddress() == 0 && \"Lazy symbol should not have a resolved address\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1364, __PRETTY_FUNCTION__))
1364 "Lazy symbol should not have a resolved address")((SymI->second.getAddress() == 0 && "Lazy symbol should not have a resolved address"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.getAddress() == 0 && \"Lazy symbol should not have a resolved address\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1364, __PRETTY_FUNCTION__))
;
1365 auto UMII = UnmaterializedInfos.find(Name);
1366 assert(UMII != UnmaterializedInfos.end() &&((UMII != UnmaterializedInfos.end() && "Lazy symbol should have UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UMII != UnmaterializedInfos.end() && \"Lazy symbol should have UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1367, __PRETTY_FUNCTION__))
1367 "Lazy symbol should have UnmaterializedInfo")((UMII != UnmaterializedInfos.end() && "Lazy symbol should have UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UMII != UnmaterializedInfos.end() && \"Lazy symbol should have UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1367, __PRETTY_FUNCTION__))
;
1368 auto MU = std::move(UMII->second->MU);
1369 assert(MU != nullptr && "Materializer should not be null")((MU != nullptr && "Materializer should not be null")
? static_cast<void> (0) : __assert_fail ("MU != nullptr && \"Materializer should not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1369, __PRETTY_FUNCTION__))
;
1370
1371 // Kick all symbols associated with this MaterializationUnit into
1372 // materializing state.
1373 for (auto &KV : MU->getSymbols()) {
1374 auto SymK = Symbols.find(KV.first);
1375 assert(SymK != Symbols.end() && "Missing symbol table entry")((SymK != Symbols.end() && "Missing symbol table entry"
) ? static_cast<void> (0) : __assert_fail ("SymK != Symbols.end() && \"Missing symbol table entry\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1375, __PRETTY_FUNCTION__))
;
1376 SymK->second.setState(SymbolState::Materializing);
1377 SymK->second.setMaterializerAttached(false);
1378 UnmaterializedInfos.erase(KV.first);
1379 }
1380
1381 // Add MU to the list of MaterializationUnits to be materialized.
1382 MUs.push_back(std::move(MU));
1383 } else if (SymI->second.getState() == SymbolState::Ready) {
1384 Q->notifySymbolReady();
1385 if (Q->isFullyReady())
1386 ActionFlags |= NotifyFullyReady;
1387 continue;
1388 }
1389
1390 // Add the query to the PendingQueries list.
1391 assert(SymI->second.isInMaterializationPhase() &&((SymI->second.isInMaterializationPhase() && "By this line the symbol should be materializing"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.isInMaterializationPhase() && \"By this line the symbol should be materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1392, __PRETTY_FUNCTION__))
1392 "By this line the symbol should be materializing")((SymI->second.isInMaterializationPhase() && "By this line the symbol should be materializing"
) ? static_cast<void> (0) : __assert_fail ("SymI->second.isInMaterializationPhase() && \"By this line the symbol should be materializing\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1392, __PRETTY_FUNCTION__))
;
1393 auto &MI = MaterializingInfos[Name];
1394 MI.PendingQueries.push_back(Q);
1395 Q->addQueryDependence(*this, Name);
1396 }
1397
1398 // Remove any marked symbols from the Unresolved set.
1399 for (auto &Name : ToRemove)
1400 Unresolved.erase(Name);
1401
1402 return ActionFlags;
1403}
1404
1405void JITDylib::dump(raw_ostream &OS) {
1406 ES.runSessionLocked([&, this]() {
1407 OS << "JITDylib \"" << JITDylibName << "\" (ES: "
1408 << format("0x%016" PRIx64"l" "x", reinterpret_cast<uintptr_t>(&ES)) << "):\n"
1409 << "Search order: [";
1410 for (auto &KV : SearchOrder)
1411 OS << " (\"" << KV.first->getName() << "\", "
1412 << (KV.second ? "all" : "exported only") << ")";
1413 OS << " ]\n"
1414 << "Symbol table:\n";
1415
1416 for (auto &KV : Symbols) {
1417 OS << " \"" << *KV.first << "\": ";
1418 if (auto Addr = KV.second.getAddress())
1419 OS << format("0x%016" PRIx64"l" "x", Addr) << ", " << KV.second.getFlags()
1420 << " ";
1421 else
1422 OS << "<not resolved> ";
1423
1424 switch (KV.second.getState()) {
1425 case SymbolState::Invalid:
1426 OS << "Invalid";
1427 break;
1428 case SymbolState::NeverSearched:
1429 OS << "Never-Searched";
1430 break;
1431 case SymbolState::Materializing:
1432 OS << "Materializing";
1433 break;
1434 case SymbolState::Resolved:
1435 OS << "Resolved";
1436 break;
1437 case SymbolState::Ready:
1438 OS << "Ready";
1439 break;
1440 // default: llvm_unreachable("Invalid state"); break;
1441 }
1442
1443 if (KV.second.hasMaterializerAttached()) {
1444 OS << " (Materializer ";
1445 auto I = UnmaterializedInfos.find(KV.first);
1446 assert(I != UnmaterializedInfos.end() &&((I != UnmaterializedInfos.end() && "Lazy symbol should have UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("I != UnmaterializedInfos.end() && \"Lazy symbol should have UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1447, __PRETTY_FUNCTION__))
1447 "Lazy symbol should have UnmaterializedInfo")((I != UnmaterializedInfos.end() && "Lazy symbol should have UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("I != UnmaterializedInfos.end() && \"Lazy symbol should have UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1447, __PRETTY_FUNCTION__))
;
1448 OS << I->second->MU.get() << ")\n";
1449 } else
1450 OS << "\n";
1451 }
1452
1453 if (!MaterializingInfos.empty())
1454 OS << " MaterializingInfos entries:\n";
1455 for (auto &KV : MaterializingInfos) {
1456 OS << " \"" << *KV.first << "\":\n"
1457 << " IsEmitted = " << (KV.second.IsEmitted ? "true" : "false")
1458 << "\n"
1459 << " " << KV.second.PendingQueries.size()
1460 << " pending queries: { ";
1461 for (auto &Q : KV.second.PendingQueries)
1462 OS << Q.get() << " ";
1463 OS << "}\n Dependants:\n";
1464 for (auto &KV2 : KV.second.Dependants)
1465 OS << " " << KV2.first->getName() << ": " << KV2.second << "\n";
1466 OS << " Unemitted Dependencies:\n";
1467 for (auto &KV2 : KV.second.UnemittedDependencies)
1468 OS << " " << KV2.first->getName() << ": " << KV2.second << "\n";
1469 }
1470 });
1471}
1472
1473JITDylib::JITDylib(ExecutionSession &ES, std::string Name)
1474 : ES(ES), JITDylibName(std::move(Name)) {
1475 SearchOrder.push_back({this, true});
1476}
1477
1478Error JITDylib::defineImpl(MaterializationUnit &MU) {
1479 SymbolNameSet Duplicates;
1480 std::vector<SymbolStringPtr> ExistingDefsOverridden;
1481 std::vector<SymbolStringPtr> MUDefsOverridden;
1482
1483 for (const auto &KV : MU.getSymbols()) {
1484 auto I = Symbols.find(KV.first);
1485
1486 if (I != Symbols.end()) {
1487 if (KV.second.isStrong()) {
1488 if (I->second.getFlags().isStrong() ||
1489 I->second.getState() > SymbolState::NeverSearched)
1490 Duplicates.insert(KV.first);
1491 else {
1492 assert(I->second.getState() == SymbolState::NeverSearched &&((I->second.getState() == SymbolState::NeverSearched &&
"Overridden existing def should be in the never-searched " "state"
) ? static_cast<void> (0) : __assert_fail ("I->second.getState() == SymbolState::NeverSearched && \"Overridden existing def should be in the never-searched \" \"state\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1494, __PRETTY_FUNCTION__))
1493 "Overridden existing def should be in the never-searched "((I->second.getState() == SymbolState::NeverSearched &&
"Overridden existing def should be in the never-searched " "state"
) ? static_cast<void> (0) : __assert_fail ("I->second.getState() == SymbolState::NeverSearched && \"Overridden existing def should be in the never-searched \" \"state\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1494, __PRETTY_FUNCTION__))
1494 "state")((I->second.getState() == SymbolState::NeverSearched &&
"Overridden existing def should be in the never-searched " "state"
) ? static_cast<void> (0) : __assert_fail ("I->second.getState() == SymbolState::NeverSearched && \"Overridden existing def should be in the never-searched \" \"state\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1494, __PRETTY_FUNCTION__))
;
1495 ExistingDefsOverridden.push_back(KV.first);
1496 }
1497 } else
1498 MUDefsOverridden.push_back(KV.first);
1499 }
1500 }
1501
1502 // If there were any duplicate definitions then bail out.
1503 if (!Duplicates.empty())
1504 return make_error<DuplicateDefinition>(**Duplicates.begin());
1505
1506 // Discard any overridden defs in this MU.
1507 for (auto &S : MUDefsOverridden)
1508 MU.doDiscard(*this, S);
1509
1510 // Discard existing overridden defs.
1511 for (auto &S : ExistingDefsOverridden) {
1512
1513 auto UMII = UnmaterializedInfos.find(S);
1514 assert(UMII != UnmaterializedInfos.end() &&((UMII != UnmaterializedInfos.end() && "Overridden existing def should have an UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UMII != UnmaterializedInfos.end() && \"Overridden existing def should have an UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1515, __PRETTY_FUNCTION__))
1515 "Overridden existing def should have an UnmaterializedInfo")((UMII != UnmaterializedInfos.end() && "Overridden existing def should have an UnmaterializedInfo"
) ? static_cast<void> (0) : __assert_fail ("UMII != UnmaterializedInfos.end() && \"Overridden existing def should have an UnmaterializedInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1515, __PRETTY_FUNCTION__))
;
1516 UMII->second->MU->doDiscard(*this, S);
1517 }
1518
1519 // Finally, add the defs from this MU.
1520 for (auto &KV : MU.getSymbols()) {
1521 auto &SymEntry = Symbols[KV.first];
1522 SymEntry.setFlags(KV.second);
1523 SymEntry.setState(SymbolState::NeverSearched);
1524 SymEntry.setMaterializerAttached(true);
1525 }
1526
1527 return Error::success();
1528}
1529
1530void JITDylib::detachQueryHelper(AsynchronousSymbolQuery &Q,
1531 const SymbolNameSet &QuerySymbols) {
1532 for (auto &QuerySymbol : QuerySymbols) {
1533 assert(MaterializingInfos.count(QuerySymbol) &&((MaterializingInfos.count(QuerySymbol) && "QuerySymbol does not have MaterializingInfo"
) ? static_cast<void> (0) : __assert_fail ("MaterializingInfos.count(QuerySymbol) && \"QuerySymbol does not have MaterializingInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1534, __PRETTY_FUNCTION__))
1534 "QuerySymbol does not have MaterializingInfo")((MaterializingInfos.count(QuerySymbol) && "QuerySymbol does not have MaterializingInfo"
) ? static_cast<void> (0) : __assert_fail ("MaterializingInfos.count(QuerySymbol) && \"QuerySymbol does not have MaterializingInfo\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1534, __PRETTY_FUNCTION__))
;
1535 auto &MI = MaterializingInfos[QuerySymbol];
1536
1537 auto IdenticalQuery =
1538 [&](const std::shared_ptr<AsynchronousSymbolQuery> &R) {
1539 return R.get() == &Q;
1540 };
1541
1542 auto I = std::find_if(MI.PendingQueries.begin(), MI.PendingQueries.end(),
1543 IdenticalQuery);
1544 assert(I != MI.PendingQueries.end() &&((I != MI.PendingQueries.end() && "Query Q should be in the PendingQueries list for QuerySymbol"
) ? static_cast<void> (0) : __assert_fail ("I != MI.PendingQueries.end() && \"Query Q should be in the PendingQueries list for QuerySymbol\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1545, __PRETTY_FUNCTION__))
1545 "Query Q should be in the PendingQueries list for QuerySymbol")((I != MI.PendingQueries.end() && "Query Q should be in the PendingQueries list for QuerySymbol"
) ? static_cast<void> (0) : __assert_fail ("I != MI.PendingQueries.end() && \"Query Q should be in the PendingQueries list for QuerySymbol\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1545, __PRETTY_FUNCTION__))
;
1546 MI.PendingQueries.erase(I);
1547 }
1548}
1549
1550void JITDylib::transferEmittedNodeDependencies(
1551 MaterializingInfo &DependantMI, const SymbolStringPtr &DependantName,
1552 MaterializingInfo &EmittedMI) {
1553 for (auto &KV : EmittedMI.UnemittedDependencies) {
1554 auto &DependencyJD = *KV.first;
1555 SymbolNameSet *UnemittedDependenciesOnDependencyJD = nullptr;
1556
1557 for (auto &DependencyName : KV.second) {
1558 auto &DependencyMI = DependencyJD.MaterializingInfos[DependencyName];
1559
1560 // Do not add self dependencies.
1561 if (&DependencyMI == &DependantMI)
1562 continue;
1563
1564 // If we haven't looked up the dependencies for DependencyJD yet, do it
1565 // now and cache the result.
1566 if (!UnemittedDependenciesOnDependencyJD)
1567 UnemittedDependenciesOnDependencyJD =
1568 &DependantMI.UnemittedDependencies[&DependencyJD];
1569
1570 DependencyMI.Dependants[this].insert(DependantName);
1571 UnemittedDependenciesOnDependencyJD->insert(DependencyName);
1572 }
1573 }
1574}
1575
1576ExecutionSession::ExecutionSession(std::shared_ptr<SymbolStringPool> SSP)
1577 : SSP(SSP ? std::move(SSP) : std::make_shared<SymbolStringPool>()) {
1578 // Construct the main dylib.
1579 JDs.push_back(std::unique_ptr<JITDylib>(new JITDylib(*this, "<main>")));
1580}
1581
1582JITDylib &ExecutionSession::getMainJITDylib() {
1583 return runSessionLocked([this]() -> JITDylib & { return *JDs.front(); });
1584}
1585
1586JITDylib *ExecutionSession::getJITDylibByName(StringRef Name) {
1587 return runSessionLocked([&, this]() -> JITDylib * {
1588 for (auto &JD : JDs)
1589 if (JD->getName() == Name)
1590 return JD.get();
1591 return nullptr;
1592 });
1593}
1594
1595JITDylib &ExecutionSession::createJITDylib(std::string Name,
1596 bool AddToMainDylibSearchOrder) {
1597 assert(!getJITDylibByName(Name) && "JITDylib with that name already exists")((!getJITDylibByName(Name) && "JITDylib with that name already exists"
) ? static_cast<void> (0) : __assert_fail ("!getJITDylibByName(Name) && \"JITDylib with that name already exists\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1597, __PRETTY_FUNCTION__))
;
1598 return runSessionLocked([&, this]() -> JITDylib & {
1599 JDs.push_back(
1600 std::unique_ptr<JITDylib>(new JITDylib(*this, std::move(Name))));
1601 if (AddToMainDylibSearchOrder)
1602 JDs.front()->addToSearchOrder(*JDs.back());
1603 return *JDs.back();
1604 });
1605}
1606
1607void ExecutionSession::legacyFailQuery(AsynchronousSymbolQuery &Q, Error Err) {
1608 assert(!!Err && "Error should be in failure state")((!!Err && "Error should be in failure state") ? static_cast
<void> (0) : __assert_fail ("!!Err && \"Error should be in failure state\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1608, __PRETTY_FUNCTION__))
;
1609
1610 bool SendErrorToQuery;
1611 runSessionLocked([&]() {
1612 Q.detach();
1613 SendErrorToQuery = Q.canStillFail();
1614 });
1615
1616 if (SendErrorToQuery)
1617 Q.handleFailed(std::move(Err));
1618 else
1619 reportError(std::move(Err));
1620}
1621
1622Expected<SymbolMap> ExecutionSession::legacyLookup(
1623 LegacyAsyncLookupFunction AsyncLookup, SymbolNameSet Names,
1624 bool WaitUntilReady, RegisterDependenciesFunction RegisterDependencies) {
1625#if LLVM_ENABLE_THREADS1
1626 // In the threaded case we use promises to return the results.
1627 std::promise<SymbolMap> PromisedResult;
1628 std::mutex ErrMutex;
1629 Error ResolutionError = Error::success();
1630 std::promise<void> PromisedReady;
1631 Error ReadyError = Error::success();
1632 auto OnResolve = [&](Expected<SymbolMap> R) {
1633 if (R)
1634 PromisedResult.set_value(std::move(*R));
1635 else {
1636 {
1637 ErrorAsOutParameter _(&ResolutionError);
1638 std::lock_guard<std::mutex> Lock(ErrMutex);
1639 ResolutionError = R.takeError();
1640 }
1641 PromisedResult.set_value(SymbolMap());
1642 }
1643 };
1644
1645 std::function<void(Error)> OnReady;
1646 if (WaitUntilReady) {
1647 OnReady = [&](Error Err) {
1648 if (Err) {
1649 ErrorAsOutParameter _(&ReadyError);
1650 std::lock_guard<std::mutex> Lock(ErrMutex);
1651 ReadyError = std::move(Err);
1652 }
1653 PromisedReady.set_value();
1654 };
1655 } else {
1656 OnReady = [&](Error Err) {
1657 if (Err)
1658 reportError(std::move(Err));
1659 };
1660 }
1661
1662#else
1663 SymbolMap Result;
1664 Error ResolutionError = Error::success();
1665 Error ReadyError = Error::success();
1666
1667 auto OnResolve = [&](Expected<SymbolMap> R) {
1668 ErrorAsOutParameter _(&ResolutionError);
1669 if (R)
1670 Result = std::move(*R);
1671 else
1672 ResolutionError = R.takeError();
1673 };
1674
1675 std::function<void(Error)> OnReady;
1676 if (WaitUntilReady) {
1677 OnReady = [&](Error Err) {
1678 ErrorAsOutParameter _(&ReadyError);
1679 if (Err)
1680 ReadyError = std::move(Err);
1681 };
1682 } else {
1683 OnReady = [&](Error Err) {
1684 if (Err)
1685 reportError(std::move(Err));
1686 };
1687 }
1688#endif
1689
1690 auto Query = std::make_shared<AsynchronousSymbolQuery>(
1691 Names, std::move(OnResolve), std::move(OnReady));
1692 // FIXME: This should be run session locked along with the registration code
1693 // and error reporting below.
1694 SymbolNameSet UnresolvedSymbols = AsyncLookup(Query, std::move(Names));
1695
1696 // If the query was lodged successfully then register the dependencies,
1697 // otherwise fail it with an error.
1698 if (UnresolvedSymbols.empty())
1699 RegisterDependencies(Query->QueryRegistrations);
1700 else {
1701 bool DeliverError = runSessionLocked([&]() {
1702 Query->detach();
1703 return Query->canStillFail();
1704 });
1705 auto Err = make_error<SymbolsNotFound>(std::move(UnresolvedSymbols));
1706 if (DeliverError)
1707 Query->handleFailed(std::move(Err));
1708 else
1709 reportError(std::move(Err));
1710 }
1711
1712#if LLVM_ENABLE_THREADS1
1713 auto ResultFuture = PromisedResult.get_future();
1714 auto Result = ResultFuture.get();
1715
1716 {
1717 std::lock_guard<std::mutex> Lock(ErrMutex);
1718 if (ResolutionError) {
1719 // ReadyError will never be assigned. Consume the success value.
1720 cantFail(std::move(ReadyError));
1721 return std::move(ResolutionError);
1722 }
1723 }
1724
1725 if (WaitUntilReady) {
1726 auto ReadyFuture = PromisedReady.get_future();
1727 ReadyFuture.get();
1728
1729 {
1730 std::lock_guard<std::mutex> Lock(ErrMutex);
1731 if (ReadyError)
1732 return std::move(ReadyError);
1733 }
1734 } else
1735 cantFail(std::move(ReadyError));
1736
1737 return std::move(Result);
1738
1739#else
1740 if (ResolutionError) {
1741 // ReadyError will never be assigned. Consume the success value.
1742 cantFail(std::move(ReadyError));
1743 return std::move(ResolutionError);
1744 }
1745
1746 if (ReadyError)
1747 return std::move(ReadyError);
1748
1749 return Result;
1750#endif
1751}
1752
1753void ExecutionSession::lookup(
1754 const JITDylibSearchList &SearchOrder, SymbolNameSet Symbols,
1755 SymbolsResolvedCallback OnResolve, SymbolsReadyCallback OnReady,
1756 RegisterDependenciesFunction RegisterDependencies) {
1757
1758 // lookup can be re-entered recursively if running on a single thread. Run any
1759 // outstanding MUs in case this query depends on them, otherwise this lookup
1760 // will starve waiting for a result from an MU that is stuck in the queue.
1761 runOutstandingMUs();
1762
1763 auto Unresolved = std::move(Symbols);
1764 std::map<JITDylib *, MaterializationUnitList> CollectedMUsMap;
1765 auto Q = std::make_shared<AsynchronousSymbolQuery>(
1766 Unresolved, std::move(OnResolve), std::move(OnReady));
1767 bool QueryIsFullyResolved = false;
1768 bool QueryIsFullyReady = false;
1769
1770 auto LodgingErr = runSessionLocked([&]() -> Error {
1771 auto LodgeQuery = [&]() -> Error {
1772 for (auto &KV : SearchOrder) {
1773 assert(KV.first && "JITDylibList entries must not be null")((KV.first && "JITDylibList entries must not be null"
) ? static_cast<void> (0) : __assert_fail ("KV.first && \"JITDylibList entries must not be null\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1773, __PRETTY_FUNCTION__))
;
1774 assert(!CollectedMUsMap.count(KV.first) &&((!CollectedMUsMap.count(KV.first) && "JITDylibList should not contain duplicate entries"
) ? static_cast<void> (0) : __assert_fail ("!CollectedMUsMap.count(KV.first) && \"JITDylibList should not contain duplicate entries\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1775, __PRETTY_FUNCTION__))
1775 "JITDylibList should not contain duplicate entries")((!CollectedMUsMap.count(KV.first) && "JITDylibList should not contain duplicate entries"
) ? static_cast<void> (0) : __assert_fail ("!CollectedMUsMap.count(KV.first) && \"JITDylibList should not contain duplicate entries\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1775, __PRETTY_FUNCTION__))
;
1776
1777 auto &JD = *KV.first;
1778 auto MatchNonExported = KV.second;
1779 if (auto Err = JD.lodgeQuery(Q, Unresolved, MatchNonExported,
1780 CollectedMUsMap[&JD]))
1781 return Err;
1782 }
1783
1784 if (!Unresolved.empty())
1785 return make_error<SymbolsNotFound>(std::move(Unresolved));
1786
1787 return Error::success();
1788 };
1789
1790 if (auto Err = LodgeQuery()) {
1791 // Query failed.
1792
1793 // Disconnect the query from its dependencies.
1794 Q->detach();
1795
1796 // Replace the MUs.
1797 for (auto &KV : CollectedMUsMap)
1798 for (auto &MU : KV.second)
1799 KV.first->replace(std::move(MU));
1800
1801 return Err;
1802 }
1803
1804 // Query lodged successfully.
1805
1806 // Record whether this query is fully ready / resolved. We will use
1807 // this to call handleFullyResolved/handleFullyReady outside the session
1808 // lock.
1809 QueryIsFullyResolved = Q->isFullyResolved();
1810 QueryIsFullyReady = Q->isFullyReady();
1811
1812 // Call the register dependencies function.
1813 if (RegisterDependencies && !Q->QueryRegistrations.empty())
1814 RegisterDependencies(Q->QueryRegistrations);
1815
1816 return Error::success();
1817 });
1818
1819 if (LodgingErr) {
1820 Q->handleFailed(std::move(LodgingErr));
1821 return;
1822 } else {
1823 if (QueryIsFullyResolved)
1824 Q->handleFullyResolved();
1825 if (QueryIsFullyReady)
1826 Q->handleFullyReady();
1827 }
1828
1829 // Move the MUs to the OutstandingMUs list, then materialize.
1830 {
1831 std::lock_guard<std::recursive_mutex> Lock(OutstandingMUsMutex);
1832
1833 for (auto &KV : CollectedMUsMap)
1834 for (auto &MU : KV.second)
1835 OutstandingMUs.push_back(std::make_pair(KV.first, std::move(MU)));
1836 }
1837
1838 runOutstandingMUs();
1839}
1840
1841Expected<SymbolMap> ExecutionSession::lookup(
1842 const JITDylibSearchList &SearchOrder, const SymbolNameSet &Symbols,
1843 RegisterDependenciesFunction RegisterDependencies, bool WaitUntilReady) {
1844#if LLVM_ENABLE_THREADS1
1845 // In the threaded case we use promises to return the results.
1846 std::promise<SymbolMap> PromisedResult;
1847 std::mutex ErrMutex;
1848 Error ResolutionError = Error::success();
1849 std::promise<void> PromisedReady;
1850 Error ReadyError = Error::success();
1851 auto OnResolve = [&](Expected<SymbolMap> R) {
1852 if (R)
1853 PromisedResult.set_value(std::move(*R));
1854 else {
1855 {
1856 ErrorAsOutParameter _(&ResolutionError);
1857 std::lock_guard<std::mutex> Lock(ErrMutex);
1858 ResolutionError = R.takeError();
1859 }
1860 PromisedResult.set_value(SymbolMap());
1861 }
1862 };
1863
1864 std::function<void(Error)> OnReady;
1865 if (WaitUntilReady) {
1866 OnReady = [&](Error Err) {
1867 if (Err) {
1868 ErrorAsOutParameter _(&ReadyError);
1869 std::lock_guard<std::mutex> Lock(ErrMutex);
1870 ReadyError = std::move(Err);
1871 }
1872 PromisedReady.set_value();
1873 };
1874 } else {
1875 OnReady = [&](Error Err) {
1876 if (Err)
1877 reportError(std::move(Err));
1878 };
1879 }
1880
1881#else
1882 SymbolMap Result;
1883 Error ResolutionError = Error::success();
1884 Error ReadyError = Error::success();
1885
1886 auto OnResolve = [&](Expected<SymbolMap> R) {
1887 ErrorAsOutParameter _(&ResolutionError);
1888 if (R)
1889 Result = std::move(*R);
1890 else
1891 ResolutionError = R.takeError();
1892 };
1893
1894 std::function<void(Error)> OnReady;
1895 if (WaitUntilReady) {
1896 OnReady = [&](Error Err) {
1897 ErrorAsOutParameter _(&ReadyError);
1898 if (Err)
1899 ReadyError = std::move(Err);
1900 };
1901 } else {
1902 OnReady = [&](Error Err) {
1903 if (Err)
1904 reportError(std::move(Err));
1905 };
1906 }
1907#endif
1908
1909 // Perform the asynchronous lookup.
1910 lookup(SearchOrder, Symbols, OnResolve, OnReady, RegisterDependencies);
1911
1912#if LLVM_ENABLE_THREADS1
1913 auto ResultFuture = PromisedResult.get_future();
1914 auto Result = ResultFuture.get();
1915
1916 {
1917 std::lock_guard<std::mutex> Lock(ErrMutex);
1918 if (ResolutionError) {
1919 // ReadyError will never be assigned. Consume the success value.
1920 cantFail(std::move(ReadyError));
1921 return std::move(ResolutionError);
1922 }
1923 }
1924
1925 if (WaitUntilReady) {
1926 auto ReadyFuture = PromisedReady.get_future();
1927 ReadyFuture.get();
1928
1929 {
1930 std::lock_guard<std::mutex> Lock(ErrMutex);
1931 if (ReadyError)
1932 return std::move(ReadyError);
1933 }
1934 } else
1935 cantFail(std::move(ReadyError));
1936
1937 return std::move(Result);
1938
1939#else
1940 if (ResolutionError) {
1941 // ReadyError will never be assigned. Consume the success value.
1942 cantFail(std::move(ReadyError));
1943 return std::move(ResolutionError);
1944 }
1945
1946 if (ReadyError)
1947 return std::move(ReadyError);
1948
1949 return Result;
1950#endif
1951}
1952
1953Expected<JITEvaluatedSymbol>
1954ExecutionSession::lookup(const JITDylibSearchList &SearchOrder,
1955 SymbolStringPtr Name) {
1956 SymbolNameSet Names({Name});
1957
1958 if (auto ResultMap = lookup(SearchOrder, std::move(Names),
1959 NoDependenciesToRegister, true)) {
1960 assert(ResultMap->size() == 1 && "Unexpected number of results")((ResultMap->size() == 1 && "Unexpected number of results"
) ? static_cast<void> (0) : __assert_fail ("ResultMap->size() == 1 && \"Unexpected number of results\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1960, __PRETTY_FUNCTION__))
;
1961 assert(ResultMap->count(Name) && "Missing result for symbol")((ResultMap->count(Name) && "Missing result for symbol"
) ? static_cast<void> (0) : __assert_fail ("ResultMap->count(Name) && \"Missing result for symbol\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 1961, __PRETTY_FUNCTION__))
;
1962 return std::move(ResultMap->begin()->second);
1963 } else
1964 return ResultMap.takeError();
1965}
1966
1967Expected<JITEvaluatedSymbol>
1968ExecutionSession::lookup(ArrayRef<JITDylib *> SearchOrder,
1969 SymbolStringPtr Name) {
1970 SymbolNameSet Names({Name});
1971
1972 JITDylibSearchList FullSearchOrder;
1973 FullSearchOrder.reserve(SearchOrder.size());
1974 for (auto *JD : SearchOrder)
1975 FullSearchOrder.push_back({JD, false});
1976
1977 return lookup(FullSearchOrder, Name);
1978}
1979
1980Expected<JITEvaluatedSymbol>
1981ExecutionSession::lookup(ArrayRef<JITDylib *> SearchOrder, StringRef Name) {
1982 return lookup(SearchOrder, intern(Name));
1983}
1984
1985void ExecutionSession::dump(raw_ostream &OS) {
1986 runSessionLocked([this, &OS]() {
1987 for (auto &JD : JDs)
1988 JD->dump(OS);
1989 });
1990}
1991
1992void ExecutionSession::runOutstandingMUs() {
1993 while (1) {
1994 std::pair<JITDylib *, std::unique_ptr<MaterializationUnit>> JITDylibAndMU;
1995
1996 {
1997 std::lock_guard<std::recursive_mutex> Lock(OutstandingMUsMutex);
1998 if (!OutstandingMUs.empty()) {
1999 JITDylibAndMU = std::move(OutstandingMUs.back());
2000 OutstandingMUs.pop_back();
2001 }
2002 }
2003
2004 if (JITDylibAndMU.first) {
2005 assert(JITDylibAndMU.second && "JITDylib, but no MU?")((JITDylibAndMU.second && "JITDylib, but no MU?") ? static_cast
<void> (0) : __assert_fail ("JITDylibAndMU.second && \"JITDylib, but no MU?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/lib/ExecutionEngine/Orc/Core.cpp"
, 2005, __PRETTY_FUNCTION__))
;
2006 dispatchMaterialization(*JITDylibAndMU.first,
2007 std::move(JITDylibAndMU.second));
2008 } else
2009 break;
2010 }
2011}
2012
2013MangleAndInterner::MangleAndInterner(ExecutionSession &ES, const DataLayout &DL)
2014 : ES(ES), DL(DL) {}
2015
2016SymbolStringPtr MangleAndInterner::operator()(StringRef Name) {
2017 std::string MangledName;
2018 {
2019 raw_string_ostream MangledNameStream(MangledName);
2020 Mangler::getNameWithPrefix(MangledNameStream, Name, DL);
2021 }
2022 return ES.intern(MangledName);
2023}
2024
2025} // End namespace orc.
2026} // End namespace llvm.

/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ExecutionEngine/Orc/Core.h

1//===------ Core.h -- Core ORC APIs (Layer, JITDylib, etc.) -----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Contains core ORC APIs.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_ORC_CORE_H
14#define LLVM_EXECUTIONENGINE_ORC_CORE_H
15
16#include "llvm/ADT/BitmaskEnum.h"
17#include "llvm/ExecutionEngine/JITSymbol.h"
18#include "llvm/ExecutionEngine/Orc/SymbolStringPool.h"
19#include "llvm/IR/Module.h"
20#include "llvm/Support/Debug.h"
21
22#include <memory>
23#include <vector>
24
25#define DEBUG_TYPE"orc" "orc"
26
27namespace llvm {
28namespace orc {
29
30// Forward declare some classes.
31class AsynchronousSymbolQuery;
32class ExecutionSession;
33class MaterializationUnit;
34class MaterializationResponsibility;
35class JITDylib;
36
37/// VModuleKey provides a unique identifier (allocated and managed by
38/// ExecutionSessions) for a module added to the JIT.
39using VModuleKey = uint64_t;
40
41/// A set of symbol names (represented by SymbolStringPtrs for
42// efficiency).
43using SymbolNameSet = DenseSet<SymbolStringPtr>;
44
45/// A map from symbol names (as SymbolStringPtrs) to JITSymbols
46/// (address/flags pairs).
47using SymbolMap = DenseMap<SymbolStringPtr, JITEvaluatedSymbol>;
48
49/// A map from symbol names (as SymbolStringPtrs) to JITSymbolFlags.
50using SymbolFlagsMap = DenseMap<SymbolStringPtr, JITSymbolFlags>;
51
52/// A base class for materialization failures that allows the failing
53/// symbols to be obtained for logging.
54using SymbolDependenceMap = DenseMap<JITDylib *, SymbolNameSet>;
55
56/// A list of (JITDylib*, bool) pairs.
57using JITDylibSearchList = std::vector<std::pair<JITDylib *, bool>>;
58
59/// Render a SymbolStringPtr.
60raw_ostream &operator<<(raw_ostream &OS, const SymbolStringPtr &Sym);
61
62/// Render a SymbolNameSet.
63raw_ostream &operator<<(raw_ostream &OS, const SymbolNameSet &Symbols);
64
65/// Render a SymbolFlagsMap entry.
66raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap::value_type &KV);
67
68/// Render a SymbolMap entry.
69raw_ostream &operator<<(raw_ostream &OS, const SymbolMap::value_type &KV);
70
71/// Render a SymbolFlagsMap.
72raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap &SymbolFlags);
73
74/// Render a SymbolMap.
75raw_ostream &operator<<(raw_ostream &OS, const SymbolMap &Symbols);
76
77/// Render a SymbolDependenceMap entry.
78raw_ostream &operator<<(raw_ostream &OS,
79 const SymbolDependenceMap::value_type &KV);
80
81/// Render a SymbolDependendeMap.
82raw_ostream &operator<<(raw_ostream &OS, const SymbolDependenceMap &Deps);
83
84/// Render a MaterializationUnit.
85raw_ostream &operator<<(raw_ostream &OS, const MaterializationUnit &MU);
86
87/// Render a JITDylibSearchList.
88raw_ostream &operator<<(raw_ostream &OS, const JITDylibSearchList &JDs);
89
90/// Callback to notify client that symbols have been resolved.
91using SymbolsResolvedCallback = std::function<void(Expected<SymbolMap>)>;
92
93/// Callback to notify client that symbols are ready for execution.
94using SymbolsReadyCallback = std::function<void(Error)>;
95
96/// Callback to register the dependencies for a given query.
97using RegisterDependenciesFunction =
98 std::function<void(const SymbolDependenceMap &)>;
99
100/// This can be used as the value for a RegisterDependenciesFunction if there
101/// are no dependants to register with.
102extern RegisterDependenciesFunction NoDependenciesToRegister;
103
104/// Used to notify a JITDylib that the given set of symbols failed to
105/// materialize.
106class FailedToMaterialize : public ErrorInfo<FailedToMaterialize> {
107public:
108 static char ID;
109
110 FailedToMaterialize(SymbolNameSet Symbols);
111 std::error_code convertToErrorCode() const override;
112 void log(raw_ostream &OS) const override;
113 const SymbolNameSet &getSymbols() const { return Symbols; }
114
115private:
116 SymbolNameSet Symbols;
117};
118
119/// Used to notify clients when symbols can not be found during a lookup.
120class SymbolsNotFound : public ErrorInfo<SymbolsNotFound> {
121public:
122 static char ID;
123
124 SymbolsNotFound(SymbolNameSet Symbols);
125 std::error_code convertToErrorCode() const override;
126 void log(raw_ostream &OS) const override;
127 const SymbolNameSet &getSymbols() const { return Symbols; }
128
129private:
130 SymbolNameSet Symbols;
131};
132
133/// Used to notify clients that a set of symbols could not be removed.
134class SymbolsCouldNotBeRemoved : public ErrorInfo<SymbolsCouldNotBeRemoved> {
135public:
136 static char ID;
137
138 SymbolsCouldNotBeRemoved(SymbolNameSet Symbols);
139 std::error_code convertToErrorCode() const override;
140 void log(raw_ostream &OS) const override;
141 const SymbolNameSet &getSymbols() const { return Symbols; }
142
143private:
144 SymbolNameSet Symbols;
145};
146
147/// Tracks responsibility for materialization, and mediates interactions between
148/// MaterializationUnits and JDs.
149///
150/// An instance of this class is passed to MaterializationUnits when their
151/// materialize method is called. It allows MaterializationUnits to resolve and
152/// emit symbols, or abandon materialization by notifying any unmaterialized
153/// symbols of an error.
154class MaterializationResponsibility {
155 friend class MaterializationUnit;
156public:
157 MaterializationResponsibility(MaterializationResponsibility &&) = default;
158 MaterializationResponsibility &
159 operator=(MaterializationResponsibility &&) = delete;
160
161 /// Destruct a MaterializationResponsibility instance. In debug mode
162 /// this asserts that all symbols being tracked have been either
163 /// emitted or notified of an error.
164 ~MaterializationResponsibility();
165
166 /// Returns the target JITDylib that these symbols are being materialized
167 /// into.
168 JITDylib &getTargetJITDylib() const { return JD; }
169
170 /// Returns the VModuleKey for this instance.
171 VModuleKey getVModuleKey() const { return K; }
172
173 /// Returns the symbol flags map for this responsibility instance.
174 /// Note: The returned flags may have transient flags (Lazy, Materializing)
175 /// set. These should be stripped with JITSymbolFlags::stripTransientFlags
176 /// before using.
177 const SymbolFlagsMap &getSymbols() const { return SymbolFlags; }
178
179 /// Returns the names of any symbols covered by this
180 /// MaterializationResponsibility object that have queries pending. This
181 /// information can be used to return responsibility for unrequested symbols
182 /// back to the JITDylib via the delegate method.
183 SymbolNameSet getRequestedSymbols() const;
184
185 /// Notifies the target JITDylib that the given symbols have been resolved.
186 /// This will update the given symbols' addresses in the JITDylib, and notify
187 /// any pending queries on the given symbols of their resolution. The given
188 /// symbols must be ones covered by this MaterializationResponsibility
189 /// instance. Individual calls to this method may resolve a subset of the
190 /// symbols, but all symbols must have been resolved prior to calling emit.
191 void resolve(const SymbolMap &Symbols);
192
193 /// Notifies the target JITDylib (and any pending queries on that JITDylib)
194 /// that all symbols covered by this MaterializationResponsibility instance
195 /// have been emitted.
196 void emit();
197
198 /// Adds new symbols to the JITDylib and this responsibility instance.
199 /// JITDylib entries start out in the materializing state.
200 ///
201 /// This method can be used by materialization units that want to add
202 /// additional symbols at materialization time (e.g. stubs, compile
203 /// callbacks, metadata).
204 Error defineMaterializing(const SymbolFlagsMap &SymbolFlags);
205
206 /// Notify all not-yet-emitted covered by this MaterializationResponsibility
207 /// instance that an error has occurred.
208 /// This will remove all symbols covered by this MaterializationResponsibilty
209 /// from the target JITDylib, and send an error to any queries waiting on
210 /// these symbols.
211 void failMaterialization();
212
213 /// Transfers responsibility to the given MaterializationUnit for all
214 /// symbols defined by that MaterializationUnit. This allows
215 /// materializers to break up work based on run-time information (e.g.
216 /// by introspecting which symbols have actually been looked up and
217 /// materializing only those).
218 void replace(std::unique_ptr<MaterializationUnit> MU);
219
220 /// Delegates responsibility for the given symbols to the returned
221 /// materialization responsibility. Useful for breaking up work between
222 /// threads, or different kinds of materialization processes.
223 MaterializationResponsibility delegate(const SymbolNameSet &Symbols,
224 VModuleKey NewKey = VModuleKey());
225
226 void addDependencies(const SymbolStringPtr &Name,
227 const SymbolDependenceMap &Dependencies);
228
229 /// Add dependencies that apply to all symbols covered by this instance.
230 void addDependenciesForAll(const SymbolDependenceMap &Dependencies);
231
232private:
233 /// Create a MaterializationResponsibility for the given JITDylib and
234 /// initial symbols.
235 MaterializationResponsibility(JITDylib &JD, SymbolFlagsMap SymbolFlags,
236 VModuleKey K);
237
238 JITDylib &JD;
239 SymbolFlagsMap SymbolFlags;
240 VModuleKey K;
241};
242
243/// A MaterializationUnit represents a set of symbol definitions that can
244/// be materialized as a group, or individually discarded (when
245/// overriding definitions are encountered).
246///
247/// MaterializationUnits are used when providing lazy definitions of symbols to
248/// JITDylibs. The JITDylib will call materialize when the address of a symbol
249/// is requested via the lookup method. The JITDylib will call discard if a
250/// stronger definition is added or already present.
251class MaterializationUnit {
252public:
253 MaterializationUnit(SymbolFlagsMap InitalSymbolFlags, VModuleKey K)
254 : SymbolFlags(std::move(InitalSymbolFlags)), K(std::move(K)) {}
255
256 virtual ~MaterializationUnit() {}
257
258 /// Return the name of this materialization unit. Useful for debugging
259 /// output.
260 virtual StringRef getName() const = 0;
261
262 /// Return the set of symbols that this source provides.
263 const SymbolFlagsMap &getSymbols() const { return SymbolFlags; }
264
265 /// Called by materialization dispatchers (see
266 /// ExecutionSession::DispatchMaterializationFunction) to trigger
267 /// materialization of this MaterializationUnit.
268 void doMaterialize(JITDylib &JD) {
269 materialize(MaterializationResponsibility(JD, std::move(SymbolFlags),
270 std::move(K)));
271 }
272
273 /// Called by JITDylibs to notify MaterializationUnits that the given symbol
274 /// has been overridden.
275 void doDiscard(const JITDylib &JD, const SymbolStringPtr &Name) {
276 SymbolFlags.erase(Name);
277 discard(JD, std::move(Name));
278 }
279
280protected:
281 SymbolFlagsMap SymbolFlags;
282 VModuleKey K;
283
284private:
285 virtual void anchor();
286
287 /// Implementations of this method should materialize all symbols
288 /// in the materialzation unit, except for those that have been
289 /// previously discarded.
290 virtual void materialize(MaterializationResponsibility R) = 0;
291
292 /// Implementations of this method should discard the given symbol
293 /// from the source (e.g. if the source is an LLVM IR Module and the
294 /// symbol is a function, delete the function body or mark it available
295 /// externally).
296 virtual void discard(const JITDylib &JD, const SymbolStringPtr &Name) = 0;
297};
298
299using MaterializationUnitList =
300 std::vector<std::unique_ptr<MaterializationUnit>>;
301
302/// A MaterializationUnit implementation for pre-existing absolute symbols.
303///
304/// All symbols will be resolved and marked ready as soon as the unit is
305/// materialized.
306class AbsoluteSymbolsMaterializationUnit : public MaterializationUnit {
307public:
308 AbsoluteSymbolsMaterializationUnit(SymbolMap Symbols, VModuleKey K);
309
310 StringRef getName() const override;
311
312private:
313 void materialize(MaterializationResponsibility R) override;
314 void discard(const JITDylib &JD, const SymbolStringPtr &Name) override;
315 static SymbolFlagsMap extractFlags(const SymbolMap &Symbols);
316
317 SymbolMap Symbols;
318};
319
320/// Create an AbsoluteSymbolsMaterializationUnit with the given symbols.
321/// Useful for inserting absolute symbols into a JITDylib. E.g.:
322/// \code{.cpp}
323/// JITDylib &JD = ...;
324/// SymbolStringPtr Foo = ...;
325/// JITEvaluatedSymbol FooSym = ...;
326/// if (auto Err = JD.define(absoluteSymbols({{Foo, FooSym}})))
327/// return Err;
328/// \endcode
329///
330inline std::unique_ptr<AbsoluteSymbolsMaterializationUnit>
331absoluteSymbols(SymbolMap Symbols, VModuleKey K = VModuleKey()) {
332 return llvm::make_unique<AbsoluteSymbolsMaterializationUnit>(
333 std::move(Symbols), std::move(K));
334}
335
336struct SymbolAliasMapEntry {
337 SymbolAliasMapEntry() = default;
338 SymbolAliasMapEntry(SymbolStringPtr Aliasee, JITSymbolFlags AliasFlags)
339 : Aliasee(std::move(Aliasee)), AliasFlags(AliasFlags) {}
340
341 SymbolStringPtr Aliasee;
342 JITSymbolFlags AliasFlags;
343};
344
345/// A map of Symbols to (Symbol, Flags) pairs.
346using SymbolAliasMap = DenseMap<SymbolStringPtr, SymbolAliasMapEntry>;
347
348/// A materialization unit for symbol aliases. Allows existing symbols to be
349/// aliased with alternate flags.
350class ReExportsMaterializationUnit : public MaterializationUnit {
351public:
352 /// SourceJD is allowed to be nullptr, in which case the source JITDylib is
353 /// taken to be whatever JITDylib these definitions are materialized in (and
354 /// MatchNonExported has no effect). This is useful for defining aliases
355 /// within a JITDylib.
356 ///
357 /// Note: Care must be taken that no sets of aliases form a cycle, as such
358 /// a cycle will result in a deadlock when any symbol in the cycle is
359 /// resolved.
360 ReExportsMaterializationUnit(JITDylib *SourceJD, bool MatchNonExported,
361 SymbolAliasMap Aliases, VModuleKey K);
362
363 StringRef getName() const override;
364
365private:
366 void materialize(MaterializationResponsibility R) override;
367 void discard(const JITDylib &JD, const SymbolStringPtr &Name) override;
368 static SymbolFlagsMap extractFlags(const SymbolAliasMap &Aliases);
369
370 JITDylib *SourceJD = nullptr;
371 bool MatchNonExported = false;
372 SymbolAliasMap Aliases;
373};
374
375/// Create a ReExportsMaterializationUnit with the given aliases.
376/// Useful for defining symbol aliases.: E.g., given a JITDylib JD containing
377/// symbols "foo" and "bar", we can define aliases "baz" (for "foo") and "qux"
378/// (for "bar") with: \code{.cpp}
379/// SymbolStringPtr Baz = ...;
380/// SymbolStringPtr Qux = ...;
381/// if (auto Err = JD.define(symbolAliases({
382/// {Baz, { Foo, JITSymbolFlags::Exported }},
383/// {Qux, { Bar, JITSymbolFlags::Weak }}}))
384/// return Err;
385/// \endcode
386inline std::unique_ptr<ReExportsMaterializationUnit>
387symbolAliases(SymbolAliasMap Aliases, VModuleKey K = VModuleKey()) {
388 return llvm::make_unique<ReExportsMaterializationUnit>(
389 nullptr, true, std::move(Aliases), std::move(K));
390}
391
392/// Create a materialization unit for re-exporting symbols from another JITDylib
393/// with alternative names/flags.
394/// If MatchNonExported is true then non-exported symbols from SourceJD can be
395/// re-exported. If it is false, attempts to re-export a non-exported symbol
396/// will result in a "symbol not found" error.
397inline std::unique_ptr<ReExportsMaterializationUnit>
398reexports(JITDylib &SourceJD, SymbolAliasMap Aliases,
399 bool MatchNonExported = false, VModuleKey K = VModuleKey()) {
400 return llvm::make_unique<ReExportsMaterializationUnit>(
401 &SourceJD, MatchNonExported, std::move(Aliases), std::move(K));
402}
403
404/// Build a SymbolAliasMap for the common case where you want to re-export
405/// symbols from another JITDylib with the same linkage/flags.
406Expected<SymbolAliasMap>
407buildSimpleReexportsAliasMap(JITDylib &SourceJD, const SymbolNameSet &Symbols);
408
409/// ReexportsGenerator can be used with JITDylib::setGenerator to automatically
410/// re-export a subset of the source JITDylib's symbols in the target.
411class ReexportsGenerator {
412public:
413 using SymbolPredicate = std::function<bool(SymbolStringPtr)>;
414
415 /// Create a reexports generator. If an Allow predicate is passed, only
416 /// symbols for which the predicate returns true will be reexported. If no
417 /// Allow predicate is passed, all symbols will be exported.
418 ReexportsGenerator(JITDylib &SourceJD, bool MatchNonExported = false,
419 SymbolPredicate Allow = SymbolPredicate());
420
421 Expected<SymbolNameSet> operator()(JITDylib &JD, const SymbolNameSet &Names);
422
423private:
424 JITDylib &SourceJD;
425 bool MatchNonExported = false;
426 SymbolPredicate Allow;
427};
428
429/// A symbol query that returns results via a callback when results are
430/// ready.
431///
432/// makes a callback when all symbols are available.
433class AsynchronousSymbolQuery {
434 friend class ExecutionSession;
435 friend class JITDylib;
436 friend class JITSymbolResolverAdapter;
437
438public:
439
440 /// Create a query for the given symbols, notify-resolved and
441 /// notify-ready callbacks.
442 AsynchronousSymbolQuery(const SymbolNameSet &Symbols,
443 SymbolsResolvedCallback NotifySymbolsResolved,
444 SymbolsReadyCallback NotifySymbolsReady);
445
446 /// Set the resolved symbol information for the given symbol name.
447 void resolve(const SymbolStringPtr &Name, JITEvaluatedSymbol Sym);
448
449 /// Returns true if all symbols covered by this query have been
450 /// resolved.
451 bool isFullyResolved() const { return NotYetResolvedCount == 0; }
452
453 /// Call the NotifySymbolsResolved callback.
454 ///
455 /// This should only be called if all symbols covered by the query have been
456 /// resolved.
457 void handleFullyResolved();
458
459 /// Notify the query that a requested symbol is ready for execution.
460 void notifySymbolReady();
461
462 /// Returns true if all symbols covered by this query are ready.
463 bool isFullyReady() const { return NotYetReadyCount == 0; }
464
465 /// Calls the NotifySymbolsReady callback.
466 ///
467 /// This should only be called if all symbols covered by this query are ready.
468 void handleFullyReady();
469
470private:
471 void addQueryDependence(JITDylib &JD, SymbolStringPtr Name);
472
473 void removeQueryDependence(JITDylib &JD, const SymbolStringPtr &Name);
474
475 bool canStillFail();
476
477 void handleFailed(Error Err);
478
479 void detach();
480
481 SymbolsResolvedCallback NotifySymbolsResolved;
482 SymbolsReadyCallback NotifySymbolsReady;
483 SymbolDependenceMap QueryRegistrations;
484 SymbolMap ResolvedSymbols;
485 size_t NotYetResolvedCount;
486 size_t NotYetReadyCount;
487};
488
489/// A symbol table that supports asynchoronous symbol queries.
490///
491/// Represents a virtual shared object. Instances can not be copied or moved, so
492/// their addresses may be used as keys for resource management.
493/// JITDylib state changes must be made via an ExecutionSession to guarantee
494/// that they are synchronized with respect to other JITDylib operations.
495class JITDylib {
496 friend class AsynchronousSymbolQuery;
497 friend class ExecutionSession;
498 friend class MaterializationResponsibility;
499public:
500 using GeneratorFunction = std::function<Expected<SymbolNameSet>(
501 JITDylib &Parent, const SymbolNameSet &Names)>;
502
503 using AsynchronousSymbolQuerySet =
504 std::set<std::shared_ptr<AsynchronousSymbolQuery>>;
505
506 JITDylib(const JITDylib &) = delete;
507 JITDylib &operator=(const JITDylib &) = delete;
508 JITDylib(JITDylib &&) = delete;
509 JITDylib &operator=(JITDylib &&) = delete;
510
511 /// Get the name for this JITDylib.
512 const std::string &getName() const { return JITDylibName; }
513
514 /// Get a reference to the ExecutionSession for this JITDylib.
515 ExecutionSession &getExecutionSession() const { return ES; }
516
517 /// Set a definition generator. If set, whenever a symbol fails to resolve
518 /// within this JITDylib, lookup and lookupFlags will pass the unresolved
519 /// symbols set to the definition generator. The generator can optionally
520 /// add a definition for the unresolved symbols to the dylib.
521 void setGenerator(GeneratorFunction DefGenerator) {
522 this->DefGenerator = std::move(DefGenerator);
523 }
524
525 /// Set the search order to be used when fixing up definitions in JITDylib.
526 /// This will replace the previous search order, and apply to any symbol
527 /// resolutions made for definitions in this JITDylib after the call to
528 /// setSearchOrder (even if the definition itself was added before the
529 /// call).
530 ///
531 /// If SearchThisJITDylibFirst is set, which by default it is, then this
532 /// JITDylib will add itself to the beginning of the SearchOrder (Clients
533 /// should *not* put this JITDylib in the list in this case, to avoid
534 /// redundant lookups).
535 ///
536 /// If SearchThisJITDylibFirst is false then the search order will be used as
537 /// given. The main motivation for this feature is to support deliberate
538 /// shadowing of symbols in this JITDylib by a facade JITDylib. For example,
539 /// the facade may resolve function names to stubs, and the stubs may compile
540 /// lazily by looking up symbols in this dylib. Adding the facade dylib
541 /// as the first in the search order (instead of this dylib) ensures that
542 /// definitions within this dylib resolve to the lazy-compiling stubs,
543 /// rather than immediately materializing the definitions in this dylib.
544 void setSearchOrder(JITDylibSearchList NewSearchOrder,
545 bool SearchThisJITDylibFirst = true,
546 bool MatchNonExportedInThisDylib = true);
547
548 /// Add the given JITDylib to the search order for definitions in this
549 /// JITDylib.
550 void addToSearchOrder(JITDylib &JD, bool MatcNonExported = false);
551
552 /// Replace OldJD with NewJD in the search order if OldJD is present.
553 /// Otherwise this operation is a no-op.
554 void replaceInSearchOrder(JITDylib &OldJD, JITDylib &NewJD,
555 bool MatchNonExported = false);
556
557 /// Remove the given JITDylib from the search order for this JITDylib if it is
558 /// present. Otherwise this operation is a no-op.
559 void removeFromSearchOrder(JITDylib &JD);
560
561 /// Do something with the search order (run under the session lock).
562 template <typename Func>
563 auto withSearchOrderDo(Func &&F)
564 -> decltype(F(std::declval<const JITDylibSearchList &>()));
565
566 /// Define all symbols provided by the materialization unit to be part of this
567 /// JITDylib.
568 ///
569 /// This overload always takes ownership of the MaterializationUnit. If any
570 /// errors occur, the MaterializationUnit consumed.
571 template <typename MaterializationUnitType>
572 Error define(std::unique_ptr<MaterializationUnitType> &&MU);
573
574 /// Define all symbols provided by the materialization unit to be part of this
575 /// JITDylib.
576 ///
577 /// This overload only takes ownership of the MaterializationUnit no error is
578 /// generated. If an error occurs, ownership remains with the caller. This
579 /// may allow the caller to modify the MaterializationUnit to correct the
580 /// issue, then re-call define.
581 template <typename MaterializationUnitType>
582 Error define(std::unique_ptr<MaterializationUnitType> &MU);
583
584 /// Tries to remove the given symbols.
585 ///
586 /// If any symbols are not defined in this JITDylib this method will return
587 /// a SymbolsNotFound error covering the missing symbols.
588 ///
589 /// If all symbols are found but some symbols are in the process of being
590 /// materialized this method will return a SymbolsCouldNotBeRemoved error.
591 ///
592 /// On success, all symbols are removed. On failure, the JITDylib state is
593 /// left unmodified (no symbols are removed).
594 Error remove(const SymbolNameSet &Names);
595
596 /// Search the given JITDylib for the symbols in Symbols. If found, store
597 /// the flags for each symbol in Flags. Returns any unresolved symbols.
598 Expected<SymbolFlagsMap> lookupFlags(const SymbolNameSet &Names);
599
600 /// Dump current JITDylib state to OS.
601 void dump(raw_ostream &OS);
602
603 /// FIXME: Remove this when we remove the old ORC layers.
604 /// Search the given JITDylibs in order for the symbols in Symbols. Results
605 /// (once they become available) will be returned via the given Query.
606 ///
607 /// If any symbol is not found then the unresolved symbols will be returned,
608 /// and the query will not be applied. The Query is not failed and can be
609 /// re-used in a subsequent lookup once the symbols have been added, or
610 /// manually failed.
611 Expected<SymbolNameSet>
612 legacyLookup(std::shared_ptr<AsynchronousSymbolQuery> Q, SymbolNameSet Names);
613
614private:
615 using AsynchronousSymbolQueryList =
616 std::vector<std::shared_ptr<AsynchronousSymbolQuery>>;
617
618 struct UnmaterializedInfo {
619 UnmaterializedInfo(std::unique_ptr<MaterializationUnit> MU)
620 : MU(std::move(MU)) {}
621
622 std::unique_ptr<MaterializationUnit> MU;
623 };
624
625 using UnmaterializedInfosMap =
626 DenseMap<SymbolStringPtr, std::shared_ptr<UnmaterializedInfo>>;
627
628 struct MaterializingInfo {
629 AsynchronousSymbolQueryList PendingQueries;
630 SymbolDependenceMap Dependants;
631 SymbolDependenceMap UnemittedDependencies;
632 bool IsEmitted = false;
633 };
634
635 using MaterializingInfosMap = DenseMap<SymbolStringPtr, MaterializingInfo>;
636
637 using LookupImplActionFlags = enum {
638 None = 0,
639 NotifyFullyResolved = 1 << 0U,
640 NotifyFullyReady = 1 << 1U,
641 LLVM_MARK_AS_BITMASK_ENUM(NotifyFullyReady)LLVM_BITMASK_LARGEST_ENUMERATOR = NotifyFullyReady
642 };
643
644 enum class SymbolState : uint8_t {
645 Invalid, // No symbol should be in this state.
646 NeverSearched, // Added to the symbol table, never queried.
647 Materializing, // Queried, materialization begun.
648 Resolved, // Assigned address, still materializing.
649 Ready = 0x3f // Ready and safe for clients to access.
650 };
651
652 class SymbolTableEntry {
653 public:
654 SymbolTableEntry() = default;
655 SymbolTableEntry(JITSymbolFlags Flags)
656 : Flags(Flags), State(static_cast<uint8_t>(SymbolState::NeverSearched)),
657 MaterializerAttached(false), PendingRemoval(false) {}
658
659 JITTargetAddress getAddress() const { return Addr; }
660 JITSymbolFlags getFlags() const { return Flags; }
661 SymbolState getState() const { return static_cast<SymbolState>(State); }
662
663 bool isInMaterializationPhase() const {
664 return getState() == SymbolState::Materializing ||
665 getState() == SymbolState::Resolved;
666 }
667
668 bool hasMaterializerAttached() const { return MaterializerAttached; }
669 bool isPendingRemoval() const { return PendingRemoval; }
670
671 void setAddress(JITTargetAddress Addr) { this->Addr = Addr; }
672 void setFlags(JITSymbolFlags Flags) { this->Flags = Flags; }
673 void setState(SymbolState State) {
674 assert(static_cast<uint8_t>(State) < (1 << 6) &&((static_cast<uint8_t>(State) < (1 << 6) &&
"State does not fit in bitfield") ? static_cast<void> (
0) : __assert_fail ("static_cast<uint8_t>(State) < (1 << 6) && \"State does not fit in bitfield\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ExecutionEngine/Orc/Core.h"
, 675, __PRETTY_FUNCTION__))
675 "State does not fit in bitfield")((static_cast<uint8_t>(State) < (1 << 6) &&
"State does not fit in bitfield") ? static_cast<void> (
0) : __assert_fail ("static_cast<uint8_t>(State) < (1 << 6) && \"State does not fit in bitfield\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ExecutionEngine/Orc/Core.h"
, 675, __PRETTY_FUNCTION__))
;
676 this->State = static_cast<uint8_t>(State);
677 }
678
679 void setMaterializerAttached(bool MaterializerAttached) {
680 this->MaterializerAttached = MaterializerAttached;
681 }
682
683 void setPendingRemoval(bool PendingRemoval) {
684 this->PendingRemoval = PendingRemoval;
685 }
686
687 JITEvaluatedSymbol getSymbol() const {
688 return JITEvaluatedSymbol(Addr, Flags);
689 }
690
691 private:
692 JITTargetAddress Addr = 0;
693 JITSymbolFlags Flags;
694 uint8_t State : 6;
695 uint8_t MaterializerAttached : 1;
696 uint8_t PendingRemoval : 1;
697 };
698
699 using SymbolTable = DenseMap<SymbolStringPtr, SymbolTableEntry>;
700
701 JITDylib(ExecutionSession &ES, std::string Name);
702
703 Error defineImpl(MaterializationUnit &MU);
704
705 Expected<SymbolNameSet> lookupFlagsImpl(SymbolFlagsMap &Flags,
706 const SymbolNameSet &Names);
707
708 Error lodgeQuery(std::shared_ptr<AsynchronousSymbolQuery> &Q,
709 SymbolNameSet &Unresolved, bool MatchNonExported,
710 MaterializationUnitList &MUs);
711
712 void lodgeQueryImpl(std::shared_ptr<AsynchronousSymbolQuery> &Q,
713 SymbolNameSet &Unresolved, bool MatchNonExported,
714 MaterializationUnitList &MUs);
715
716 LookupImplActionFlags
717 lookupImpl(std::shared_ptr<AsynchronousSymbolQuery> &Q,
718 std::vector<std::unique_ptr<MaterializationUnit>> &MUs,
719 SymbolNameSet &Unresolved);
720
721 void detachQueryHelper(AsynchronousSymbolQuery &Q,
722 const SymbolNameSet &QuerySymbols);
723
724 void transferEmittedNodeDependencies(MaterializingInfo &DependantMI,
725 const SymbolStringPtr &DependantName,
726 MaterializingInfo &EmittedMI);
727
728 Error defineMaterializing(const SymbolFlagsMap &SymbolFlags);
729
730 void replace(std::unique_ptr<MaterializationUnit> MU);
731
732 SymbolNameSet getRequestedSymbols(const SymbolFlagsMap &SymbolFlags) const;
733
734 void addDependencies(const SymbolStringPtr &Name,
735 const SymbolDependenceMap &Dependants);
736
737 void resolve(const SymbolMap &Resolved);
738
739 void emit(const SymbolFlagsMap &Emitted);
740
741 void notifyFailed(const SymbolNameSet &FailedSymbols);
742
743 ExecutionSession &ES;
744 std::string JITDylibName;
745 SymbolTable Symbols;
746 UnmaterializedInfosMap UnmaterializedInfos;
747 MaterializingInfosMap MaterializingInfos;
748 GeneratorFunction DefGenerator;
749 JITDylibSearchList SearchOrder;
750};
751
752/// An ExecutionSession represents a running JIT program.
753class ExecutionSession {
754 // FIXME: Remove this when we remove the old ORC layers.
755 friend class JITDylib;
756
757public:
758 /// For reporting errors.
759 using ErrorReporter = std::function<void(Error)>;
760
761 /// For dispatching MaterializationUnit::materialize calls.
762 using DispatchMaterializationFunction = std::function<void(
763 JITDylib &JD, std::unique_ptr<MaterializationUnit> MU)>;
764
765 /// Construct an ExecutionSession.
766 ///
767 /// SymbolStringPools may be shared between ExecutionSessions.
768 ExecutionSession(std::shared_ptr<SymbolStringPool> SSP = nullptr);
769
770 /// Add a symbol name to the SymbolStringPool and return a pointer to it.
771 SymbolStringPtr intern(StringRef SymName) { return SSP->intern(SymName); }
772
773 /// Returns a shared_ptr to the SymbolStringPool for this ExecutionSession.
774 std::shared_ptr<SymbolStringPool> getSymbolStringPool() const { return SSP; }
775
776 /// Run the given lambda with the session mutex locked.
777 template <typename Func> auto runSessionLocked(Func &&F) -> decltype(F()) {
778 std::lock_guard<std::recursive_mutex> Lock(SessionMutex);
779 return F();
3
Calling 'operator()'
780 }
781
782 /// Get the "main" JITDylib, which is created automatically on construction of
783 /// the ExecutionSession.
784 JITDylib &getMainJITDylib();
785
786 /// Return a pointer to the "name" JITDylib.
787 /// Ownership of JITDylib remains within Execution Session
788 JITDylib *getJITDylibByName(StringRef Name);
789
790 /// Add a new JITDylib to this ExecutionSession.
791 ///
792 /// The JITDylib Name is required to be unique. Clients should verify that
793 /// names are not being re-used (e.g. by calling getJITDylibByName) if names
794 /// are based on user input.
795 JITDylib &createJITDylib(std::string Name,
796 bool AddToMainDylibSearchOrder = true);
797
798 /// Allocate a module key for a new module to add to the JIT.
799 VModuleKey allocateVModule() {
800 return runSessionLocked([this]() { return ++LastKey; });
801 }
802
803 /// Return a module key to the ExecutionSession so that it can be
804 /// re-used. This should only be done once all resources associated
805 /// with the original key have been released.
806 void releaseVModule(VModuleKey Key) { /* FIXME: Recycle keys */
807 }
808
809 /// Set the error reporter function.
810 ExecutionSession &setErrorReporter(ErrorReporter ReportError) {
811 this->ReportError = std::move(ReportError);
812 return *this;
813 }
814
815 /// Report a error for this execution session.
816 ///
817 /// Unhandled errors can be sent here to log them.
818 void reportError(Error Err) { ReportError(std::move(Err)); }
819
820 /// Set the materialization dispatch function.
821 ExecutionSession &setDispatchMaterialization(
822 DispatchMaterializationFunction DispatchMaterialization) {
823 this->DispatchMaterialization = std::move(DispatchMaterialization);
824 return *this;
825 }
826
827 void legacyFailQuery(AsynchronousSymbolQuery &Q, Error Err);
828
829 using LegacyAsyncLookupFunction = std::function<SymbolNameSet(
830 std::shared_ptr<AsynchronousSymbolQuery> Q, SymbolNameSet Names)>;
831
832 /// A legacy lookup function for JITSymbolResolverAdapter.
833 /// Do not use -- this will be removed soon.
834 Expected<SymbolMap>
835 legacyLookup(LegacyAsyncLookupFunction AsyncLookup, SymbolNameSet Names,
836 bool WaiUntilReady,
837 RegisterDependenciesFunction RegisterDependencies);
838
839 /// Search the given JITDylib list for the given symbols.
840 ///
841 /// SearchOrder lists the JITDylibs to search. For each dylib, the associated
842 /// boolean indicates whether the search should match against non-exported
843 /// (hidden visibility) symbols in that dylib (true means match against
844 /// non-exported symbols, false means do not match).
845 ///
846 /// The OnResolve callback will be called once all requested symbols are
847 /// resolved, or if an error occurs prior to resolution.
848 ///
849 /// The OnReady callback will be called once all requested symbols are ready,
850 /// or if an error occurs after resolution but before all symbols are ready.
851 ///
852 /// If all symbols are found, the RegisterDependencies function will be called
853 /// while the session lock is held. This gives clients a chance to register
854 /// dependencies for on the queried symbols for any symbols they are
855 /// materializing (if a MaterializationResponsibility instance is present,
856 /// this can be implemented by calling
857 /// MaterializationResponsibility::addDependencies). If there are no
858 /// dependenant symbols for this query (e.g. it is being made by a top level
859 /// client to get an address to call) then the value NoDependenciesToRegister
860 /// can be used.
861 void lookup(const JITDylibSearchList &SearchOrder, SymbolNameSet Symbols,
862 SymbolsResolvedCallback OnResolve, SymbolsReadyCallback OnReady,
863 RegisterDependenciesFunction RegisterDependencies);
864
865 /// Blocking version of lookup above. Returns the resolved symbol map.
866 /// If WaitUntilReady is true (the default), will not return until all
867 /// requested symbols are ready (or an error occurs). If WaitUntilReady is
868 /// false, will return as soon as all requested symbols are resolved,
869 /// or an error occurs. If WaitUntilReady is false and an error occurs
870 /// after resolution, the function will return a success value, but the
871 /// error will be reported via reportErrors.
872 Expected<SymbolMap> lookup(const JITDylibSearchList &SearchOrder,
873 const SymbolNameSet &Symbols,
874 RegisterDependenciesFunction RegisterDependencies =
875 NoDependenciesToRegister,
876 bool WaitUntilReady = true);
877
878 /// Convenience version of blocking lookup.
879 /// Searches each of the JITDylibs in the search order in turn for the given
880 /// symbol.
881 Expected<JITEvaluatedSymbol> lookup(const JITDylibSearchList &SearchOrder,
882 SymbolStringPtr Symbol);
883
884 /// Convenience version of blocking lookup.
885 /// Searches each of the JITDylibs in the search order in turn for the given
886 /// symbol. The search will not find non-exported symbols.
887 Expected<JITEvaluatedSymbol> lookup(ArrayRef<JITDylib *> SearchOrder,
888 SymbolStringPtr Symbol);
889
890 /// Convenience version of blocking lookup.
891 /// Searches each of the JITDylibs in the search order in turn for the given
892 /// symbol. The search will not find non-exported symbols.
893 Expected<JITEvaluatedSymbol> lookup(ArrayRef<JITDylib *> SearchOrder,
894 StringRef Symbol);
895
896 /// Materialize the given unit.
897 void dispatchMaterialization(JITDylib &JD,
898 std::unique_ptr<MaterializationUnit> MU) {
899 LLVM_DEBUG(runSessionLocked([&]() {do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { runSessionLocked([&]() { dbgs() << "Compiling, for "
<< JD.getName() << ", " << *MU << "\n"
; });; } } while (false)
900 dbgs() << "Compiling, for " << JD.getName() << ", " << *MUdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { runSessionLocked([&]() { dbgs() << "Compiling, for "
<< JD.getName() << ", " << *MU << "\n"
; });; } } while (false)
901 << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { runSessionLocked([&]() { dbgs() << "Compiling, for "
<< JD.getName() << ", " << *MU << "\n"
; });; } } while (false)
902 });)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("orc")) { runSessionLocked([&]() { dbgs() << "Compiling, for "
<< JD.getName() << ", " << *MU << "\n"
; });; } } while (false)
;
903 DispatchMaterialization(JD, std::move(MU));
904 }
905
906 /// Dump the state of all the JITDylibs in this session.
907 void dump(raw_ostream &OS);
908
909private:
910 static void logErrorsToStdErr(Error Err) {
911 logAllUnhandledErrors(std::move(Err), errs(), "JIT session error: ");
912 }
913
914 static void
915 materializeOnCurrentThread(JITDylib &JD,
916 std::unique_ptr<MaterializationUnit> MU) {
917 MU->doMaterialize(JD);
918 }
919
920 void runOutstandingMUs();
921
922 mutable std::recursive_mutex SessionMutex;
923 std::shared_ptr<SymbolStringPool> SSP;
924 VModuleKey LastKey = 0;
925 ErrorReporter ReportError = logErrorsToStdErr;
926 DispatchMaterializationFunction DispatchMaterialization =
927 materializeOnCurrentThread;
928
929 std::vector<std::unique_ptr<JITDylib>> JDs;
930
931 // FIXME: Remove this (and runOutstandingMUs) once the linking layer works
932 // with callbacks from asynchronous queries.
933 mutable std::recursive_mutex OutstandingMUsMutex;
934 std::vector<std::pair<JITDylib *, std::unique_ptr<MaterializationUnit>>>
935 OutstandingMUs;
936};
937
938template <typename Func>
939auto JITDylib::withSearchOrderDo(Func &&F)
940 -> decltype(F(std::declval<const JITDylibSearchList &>())) {
941 return ES.runSessionLocked([&]() { return F(SearchOrder); });
942}
943
944template <typename MaterializationUnitType>
945Error JITDylib::define(std::unique_ptr<MaterializationUnitType> &&MU) {
946 assert(MU && "Can not define with a null MU")((MU && "Can not define with a null MU") ? static_cast
<void> (0) : __assert_fail ("MU && \"Can not define with a null MU\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ExecutionEngine/Orc/Core.h"
, 946, __PRETTY_FUNCTION__))
;
947 return ES.runSessionLocked([&, this]() -> Error {
948 if (auto Err = defineImpl(*MU))
949 return Err;
950
951 /// defineImpl succeeded.
952 auto UMI = std::make_shared<UnmaterializedInfo>(std::move(MU));
953 for (auto &KV : UMI->MU->getSymbols())
954 UnmaterializedInfos[KV.first] = UMI;
955
956 return Error::success();
957 });
958}
959
960template <typename MaterializationUnitType>
961Error JITDylib::define(std::unique_ptr<MaterializationUnitType> &MU) {
962 assert(MU && "Can not define with a null MU")((MU && "Can not define with a null MU") ? static_cast
<void> (0) : __assert_fail ("MU && \"Can not define with a null MU\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ExecutionEngine/Orc/Core.h"
, 962, __PRETTY_FUNCTION__))
;
963
964 return ES.runSessionLocked([&, this]() -> Error {
965 if (auto Err = defineImpl(*MU))
966 return Err;
967
968 /// defineImpl succeeded.
969 auto UMI = std::make_shared<UnmaterializedInfo>(std::move(MU));
970 for (auto &KV : UMI->MU->getSymbols())
971 UnmaterializedInfos[KV.first] = UMI;
972
973 return Error::success();
974 });
975}
976
977/// Mangles symbol names then uniques them in the context of an
978/// ExecutionSession.
979class MangleAndInterner {
980public:
981 MangleAndInterner(ExecutionSession &ES, const DataLayout &DL);
982 SymbolStringPtr operator()(StringRef Name);
983
984private:
985 ExecutionSession &ES;
986 const DataLayout &DL;
987};
988
989} // End namespace orc
990} // End namespace llvm
991
992#undef DEBUG_TYPE"orc" // "orc"
993
994#endif // LLVM_EXECUTIONENGINE_ORC_CORE_H

/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h

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

/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h

1//===- llvm/ADT/STLExtras.h - Useful STL related 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// This file contains some templates that are useful if you are working with the
10// STL at all.
11//
12// No library is required when using these functions.
13//
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_ADT_STLEXTRAS_H
17#define LLVM_ADT_STLEXTRAS_H
18
19#include "llvm/ADT/Optional.h"
20#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/iterator.h"
22#include "llvm/ADT/iterator_range.h"
23#include "llvm/Config/abi-breaking.h"
24#include "llvm/Support/ErrorHandling.h"
25#include <algorithm>
26#include <cassert>
27#include <cstddef>
28#include <cstdint>
29#include <cstdlib>
30#include <functional>
31#include <initializer_list>
32#include <iterator>
33#include <limits>
34#include <memory>
35#include <tuple>
36#include <type_traits>
37#include <utility>
38
39#ifdef EXPENSIVE_CHECKS
40#include <random> // for std::mt19937
41#endif
42
43namespace llvm {
44
45// Only used by compiler if both template types are the same. Useful when
46// using SFINAE to test for the existence of member functions.
47template <typename T, T> struct SameType;
48
49namespace detail {
50
51template <typename RangeT>
52using IterOfRange = decltype(std::begin(std::declval<RangeT &>()));
53
54template <typename RangeT>
55using ValueOfRange = typename std::remove_reference<decltype(
56 *std::begin(std::declval<RangeT &>()))>::type;
57
58} // end namespace detail
59
60//===----------------------------------------------------------------------===//
61// Extra additions to <type_traits>
62//===----------------------------------------------------------------------===//
63
64template <typename T>
65struct negation : std::integral_constant<bool, !bool(T::value)> {};
66
67template <typename...> struct conjunction : std::true_type {};
68template <typename B1> struct conjunction<B1> : B1 {};
69template <typename B1, typename... Bn>
70struct conjunction<B1, Bn...>
71 : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
72
73template <typename T> struct make_const_ptr {
74 using type =
75 typename std::add_pointer<typename std::add_const<T>::type>::type;
76};
77
78template <typename T> struct make_const_ref {
79 using type = typename std::add_lvalue_reference<
80 typename std::add_const<T>::type>::type;
81};
82
83//===----------------------------------------------------------------------===//
84// Extra additions to <functional>
85//===----------------------------------------------------------------------===//
86
87template <class Ty> struct identity {
88 using argument_type = Ty;
89
90 Ty &operator()(Ty &self) const {
91 return self;
92 }
93 const Ty &operator()(const Ty &self) const {
94 return self;
95 }
96};
97
98template <class Ty> struct less_ptr {
99 bool operator()(const Ty* left, const Ty* right) const {
100 return *left < *right;
101 }
102};
103
104template <class Ty> struct greater_ptr {
105 bool operator()(const Ty* left, const Ty* right) const {
106 return *right < *left;
107 }
108};
109
110/// An efficient, type-erasing, non-owning reference to a callable. This is
111/// intended for use as the type of a function parameter that is not used
112/// after the function in question returns.
113///
114/// This class does not own the callable, so it is not in general safe to store
115/// a function_ref.
116template<typename Fn> class function_ref;
117
118template<typename Ret, typename ...Params>
119class function_ref<Ret(Params...)> {
120 Ret (*callback)(intptr_t callable, Params ...params) = nullptr;
121 intptr_t callable;
122
123 template<typename Callable>
124 static Ret callback_fn(intptr_t callable, Params ...params) {
125 return (*reinterpret_cast<Callable*>(callable))(
126 std::forward<Params>(params)...);
127 }
128
129public:
130 function_ref() = default;
131 function_ref(std::nullptr_t) {}
132
133 template <typename Callable>
134 function_ref(Callable &&callable,
135 typename std::enable_if<
136 !std::is_same<typename std::remove_reference<Callable>::type,
137 function_ref>::value>::type * = nullptr)
138 : callback(callback_fn<typename std::remove_reference<Callable>::type>),
139 callable(reinterpret_cast<intptr_t>(&callable)) {}
140
141 Ret operator()(Params ...params) const {
142 return callback(callable, std::forward<Params>(params)...);
143 }
144
145 operator bool() const { return callback; }
146};
147
148// deleter - Very very very simple method that is used to invoke operator
149// delete on something. It is used like this:
150//
151// for_each(V.begin(), B.end(), deleter<Interval>);
152template <class T>
153inline void deleter(T *Ptr) {
154 delete Ptr;
155}
156
157//===----------------------------------------------------------------------===//
158// Extra additions to <iterator>
159//===----------------------------------------------------------------------===//
160
161namespace adl_detail {
162
163using std::begin;
164
165template <typename ContainerTy>
166auto adl_begin(ContainerTy &&container)
167 -> decltype(begin(std::forward<ContainerTy>(container))) {
168 return begin(std::forward<ContainerTy>(container));
169}
170
171using std::end;
172
173template <typename ContainerTy>
174auto adl_end(ContainerTy &&container)
175 -> decltype(end(std::forward<ContainerTy>(container))) {
176 return end(std::forward<ContainerTy>(container));
177}
178
179using std::swap;
180
181template <typename T>
182void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(),
183 std::declval<T>()))) {
184 swap(std::forward<T>(lhs), std::forward<T>(rhs));
185}
186
187} // end namespace adl_detail
188
189template <typename ContainerTy>
190auto adl_begin(ContainerTy &&container)
191 -> decltype(adl_detail::adl_begin(std::forward<ContainerTy>(container))) {
192 return adl_detail::adl_begin(std::forward<ContainerTy>(container));
193}
194
195template <typename ContainerTy>
196auto adl_end(ContainerTy &&container)
197 -> decltype(adl_detail::adl_end(std::forward<ContainerTy>(container))) {
198 return adl_detail::adl_end(std::forward<ContainerTy>(container));
199}
200
201template <typename T>
202void adl_swap(T &&lhs, T &&rhs) noexcept(
203 noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) {
204 adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs));
205}
206
207/// Test whether \p RangeOrContainer is empty. Similar to C++17 std::empty.
208template <typename T>
209constexpr bool empty(const T &RangeOrContainer) {
210 return adl_begin(RangeOrContainer) == adl_end(RangeOrContainer);
211}
212
213// mapped_iterator - This is a simple iterator adapter that causes a function to
214// be applied whenever operator* is invoked on the iterator.
215
216template <typename ItTy, typename FuncTy,
217 typename FuncReturnTy =
218 decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))>
219class mapped_iterator
220 : public iterator_adaptor_base<
221 mapped_iterator<ItTy, FuncTy>, ItTy,
222 typename std::iterator_traits<ItTy>::iterator_category,
223 typename std::remove_reference<FuncReturnTy>::type> {
224public:
225 mapped_iterator(ItTy U, FuncTy F)
226 : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {}
227
228 ItTy getCurrent() { return this->I; }
229
230 FuncReturnTy operator*() { return F(*this->I); }
231
232private:
233 FuncTy F;
234};
235
236// map_iterator - Provide a convenient way to create mapped_iterators, just like
237// make_pair is useful for creating pairs...
238template <class ItTy, class FuncTy>
239inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) {
240 return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F));
241}
242
243/// Helper to determine if type T has a member called rbegin().
244template <typename Ty> class has_rbegin_impl {
245 using yes = char[1];
246 using no = char[2];
247
248 template <typename Inner>
249 static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr);
250
251 template <typename>
252 static no& test(...);
253
254public:
255 static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes);
256};
257
258/// Metafunction to determine if T& or T has a member called rbegin().
259template <typename Ty>
260struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> {
261};
262
263// Returns an iterator_range over the given container which iterates in reverse.
264// Note that the container must have rbegin()/rend() methods for this to work.
265template <typename ContainerTy>
266auto reverse(ContainerTy &&C,
267 typename std::enable_if<has_rbegin<ContainerTy>::value>::type * =
268 nullptr) -> decltype(make_range(C.rbegin(), C.rend())) {
269 return make_range(C.rbegin(), C.rend());
270}
271
272// Returns a std::reverse_iterator wrapped around the given iterator.
273template <typename IteratorTy>
274std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) {
275 return std::reverse_iterator<IteratorTy>(It);
276}
277
278// Returns an iterator_range over the given container which iterates in reverse.
279// Note that the container must have begin()/end() methods which return
280// bidirectional iterators for this to work.
281template <typename ContainerTy>
282auto reverse(
283 ContainerTy &&C,
284 typename std::enable_if<!has_rbegin<ContainerTy>::value>::type * = nullptr)
285 -> decltype(make_range(llvm::make_reverse_iterator(std::end(C)),
286 llvm::make_reverse_iterator(std::begin(C)))) {
287 return make_range(llvm::make_reverse_iterator(std::end(C)),
288 llvm::make_reverse_iterator(std::begin(C)));
289}
290
291/// An iterator adaptor that filters the elements of given inner iterators.
292///
293/// The predicate parameter should be a callable object that accepts the wrapped
294/// iterator's reference type and returns a bool. When incrementing or
295/// decrementing the iterator, it will call the predicate on each element and
296/// skip any where it returns false.
297///
298/// \code
299/// int A[] = { 1, 2, 3, 4 };
300/// auto R = make_filter_range(A, [](int N) { return N % 2 == 1; });
301/// // R contains { 1, 3 }.
302/// \endcode
303///
304/// Note: filter_iterator_base implements support for forward iteration.
305/// filter_iterator_impl exists to provide support for bidirectional iteration,
306/// conditional on whether the wrapped iterator supports it.
307template <typename WrappedIteratorT, typename PredicateT, typename IterTag>
308class filter_iterator_base
309 : public iterator_adaptor_base<
310 filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>,
311 WrappedIteratorT,
312 typename std::common_type<
313 IterTag, typename std::iterator_traits<
314 WrappedIteratorT>::iterator_category>::type> {
315 using BaseT = iterator_adaptor_base<
316 filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>,
317 WrappedIteratorT,
318 typename std::common_type<
319 IterTag, typename std::iterator_traits<
320 WrappedIteratorT>::iterator_category>::type>;
321
322protected:
323 WrappedIteratorT End;
324 PredicateT Pred;
325
326 void findNextValid() {
327 while (this->I != End && !Pred(*this->I))
328 BaseT::operator++();
329 }
330
331 // Construct the iterator. The begin iterator needs to know where the end
332 // is, so that it can properly stop when it gets there. The end iterator only
333 // needs the predicate to support bidirectional iteration.
334 filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End,
335 PredicateT Pred)
336 : BaseT(Begin), End(End), Pred(Pred) {
337 findNextValid();
338 }
339
340public:
341 using BaseT::operator++;
342
343 filter_iterator_base &operator++() {
344 BaseT::operator++();
345 findNextValid();
346 return *this;
347 }
348};
349
350/// Specialization of filter_iterator_base for forward iteration only.
351template <typename WrappedIteratorT, typename PredicateT,
352 typename IterTag = std::forward_iterator_tag>
353class filter_iterator_impl
354 : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> {
355 using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>;
356
357public:
358 filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End,
359 PredicateT Pred)
360 : BaseT(Begin, End, Pred) {}
361};
362
363/// Specialization of filter_iterator_base for bidirectional iteration.
364template <typename WrappedIteratorT, typename PredicateT>
365class filter_iterator_impl<WrappedIteratorT, PredicateT,
366 std::bidirectional_iterator_tag>
367 : public filter_iterator_base<WrappedIteratorT, PredicateT,
368 std::bidirectional_iterator_tag> {
369 using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT,
370 std::bidirectional_iterator_tag>;
371 void findPrevValid() {
372 while (!this->Pred(*this->I))
373 BaseT::operator--();
374 }
375
376public:
377 using BaseT::operator--;
378
379 filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End,
380 PredicateT Pred)
381 : BaseT(Begin, End, Pred) {}
382
383 filter_iterator_impl &operator--() {
384 BaseT::operator--();
385 findPrevValid();
386 return *this;
387 }
388};
389
390namespace detail {
391
392template <bool is_bidirectional> struct fwd_or_bidi_tag_impl {
393 using type = std::forward_iterator_tag;
394};
395
396template <> struct fwd_or_bidi_tag_impl<true> {
397 using type = std::bidirectional_iterator_tag;
398};
399
400/// Helper which sets its type member to forward_iterator_tag if the category
401/// of \p IterT does not derive from bidirectional_iterator_tag, and to
402/// bidirectional_iterator_tag otherwise.
403template <typename IterT> struct fwd_or_bidi_tag {
404 using type = typename fwd_or_bidi_tag_impl<std::is_base_of<
405 std::bidirectional_iterator_tag,
406 typename std::iterator_traits<IterT>::iterator_category>::value>::type;
407};
408
409} // namespace detail
410
411/// Defines filter_iterator to a suitable specialization of
412/// filter_iterator_impl, based on the underlying iterator's category.
413template <typename WrappedIteratorT, typename PredicateT>
414using filter_iterator = filter_iterator_impl<
415 WrappedIteratorT, PredicateT,
416 typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>;
417
418/// Convenience function that takes a range of elements and a predicate,
419/// and return a new filter_iterator range.
420///
421/// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the
422/// lifetime of that temporary is not kept by the returned range object, and the
423/// temporary is going to be dropped on the floor after the make_iterator_range
424/// full expression that contains this function call.
425template <typename RangeT, typename PredicateT>
426iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>>
427make_filter_range(RangeT &&Range, PredicateT Pred) {
428 using FilterIteratorT =
429 filter_iterator<detail::IterOfRange<RangeT>, PredicateT>;
430 return make_range(
431 FilterIteratorT(std::begin(std::forward<RangeT>(Range)),
432 std::end(std::forward<RangeT>(Range)), Pred),
433 FilterIteratorT(std::end(std::forward<RangeT>(Range)),
434 std::end(std::forward<RangeT>(Range)), Pred));
435}
436
437/// A pseudo-iterator adaptor that is designed to implement "early increment"
438/// style loops.
439///
440/// This is *not a normal iterator* and should almost never be used directly. It
441/// is intended primarily to be used with range based for loops and some range
442/// algorithms.
443///
444/// The iterator isn't quite an `OutputIterator` or an `InputIterator` but
445/// somewhere between them. The constraints of these iterators are:
446///
447/// - On construction or after being incremented, it is comparable and
448/// dereferencable. It is *not* incrementable.
449/// - After being dereferenced, it is neither comparable nor dereferencable, it
450/// is only incrementable.
451///
452/// This means you can only dereference the iterator once, and you can only
453/// increment it once between dereferences.
454template <typename WrappedIteratorT>
455class early_inc_iterator_impl
456 : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>,
457 WrappedIteratorT, std::input_iterator_tag> {
458 using BaseT =
459 iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>,
460 WrappedIteratorT, std::input_iterator_tag>;
461
462 using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer;
463
464protected:
465#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
466 bool IsEarlyIncremented = false;
467#endif
468
469public:
470 early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {}
471
472 using BaseT::operator*;
473 typename BaseT::reference operator*() {
474#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
475 assert(!IsEarlyIncremented && "Cannot dereference twice!")((!IsEarlyIncremented && "Cannot dereference twice!")
? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot dereference twice!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 475, __PRETTY_FUNCTION__))
;
476 IsEarlyIncremented = true;
477#endif
478 return *(this->I)++;
479 }
480
481 using BaseT::operator++;
482 early_inc_iterator_impl &operator++() {
483#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
484 assert(IsEarlyIncremented && "Cannot increment before dereferencing!")((IsEarlyIncremented && "Cannot increment before dereferencing!"
) ? static_cast<void> (0) : __assert_fail ("IsEarlyIncremented && \"Cannot increment before dereferencing!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 484, __PRETTY_FUNCTION__))
;
485 IsEarlyIncremented = false;
486#endif
487 return *this;
488 }
489
490 using BaseT::operator==;
491 bool operator==(const early_inc_iterator_impl &RHS) const {
492#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
493 assert(!IsEarlyIncremented && "Cannot compare after dereferencing!")((!IsEarlyIncremented && "Cannot compare after dereferencing!"
) ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot compare after dereferencing!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 493, __PRETTY_FUNCTION__))
;
494#endif
495 return BaseT::operator==(RHS);
496 }
497};
498
499/// Make a range that does early increment to allow mutation of the underlying
500/// range without disrupting iteration.
501///
502/// The underlying iterator will be incremented immediately after it is
503/// dereferenced, allowing deletion of the current node or insertion of nodes to
504/// not disrupt iteration provided they do not invalidate the *next* iterator --
505/// the current iterator can be invalidated.
506///
507/// This requires a very exact pattern of use that is only really suitable to
508/// range based for loops and other range algorithms that explicitly guarantee
509/// to dereference exactly once each element, and to increment exactly once each
510/// element.
511template <typename RangeT>
512iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>>
513make_early_inc_range(RangeT &&Range) {
514 using EarlyIncIteratorT =
515 early_inc_iterator_impl<detail::IterOfRange<RangeT>>;
516 return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))),
517 EarlyIncIteratorT(std::end(std::forward<RangeT>(Range))));
518}
519
520// forward declarations required by zip_shortest/zip_first/zip_longest
521template <typename R, typename UnaryPredicate>
522bool all_of(R &&range, UnaryPredicate P);
523template <typename R, typename UnaryPredicate>
524bool any_of(R &&range, UnaryPredicate P);
525
526template <size_t... I> struct index_sequence;
527
528template <class... Ts> struct index_sequence_for;
529
530namespace detail {
531
532using std::declval;
533
534// We have to alias this since inlining the actual type at the usage site
535// in the parameter list of iterator_facade_base<> below ICEs MSVC 2017.
536template<typename... Iters> struct ZipTupleType {
537 using type = std::tuple<decltype(*declval<Iters>())...>;
538};
539
540template <typename ZipType, typename... Iters>
541using zip_traits = iterator_facade_base<
542 ZipType, typename std::common_type<std::bidirectional_iterator_tag,
543 typename std::iterator_traits<
544 Iters>::iterator_category...>::type,
545 // ^ TODO: Implement random access methods.
546 typename ZipTupleType<Iters...>::type,
547 typename std::iterator_traits<typename std::tuple_element<
548 0, std::tuple<Iters...>>::type>::difference_type,
549 // ^ FIXME: This follows boost::make_zip_iterator's assumption that all
550 // inner iterators have the same difference_type. It would fail if, for
551 // instance, the second field's difference_type were non-numeric while the
552 // first is.
553 typename ZipTupleType<Iters...>::type *,
554 typename ZipTupleType<Iters...>::type>;
555
556template <typename ZipType, typename... Iters>
557struct zip_common : public zip_traits<ZipType, Iters...> {
558 using Base = zip_traits<ZipType, Iters...>;
559 using value_type = typename Base::value_type;
560
561 std::tuple<Iters...> iterators;
562
563protected:
564 template <size_t... Ns> value_type deref(index_sequence<Ns...>) const {
565 return value_type(*std::get<Ns>(iterators)...);
566 }
567
568 template <size_t... Ns>
569 decltype(iterators) tup_inc(index_sequence<Ns...>) const {
570 return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...);
571 }
572
573 template <size_t... Ns>
574 decltype(iterators) tup_dec(index_sequence<Ns...>) const {
575 return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...);
576 }
577
578public:
579 zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {}
580
581 value_type operator*() { return deref(index_sequence_for<Iters...>{}); }
582
583 const value_type operator*() const {
584 return deref(index_sequence_for<Iters...>{});
585 }
586
587 ZipType &operator++() {
588 iterators = tup_inc(index_sequence_for<Iters...>{});
589 return *reinterpret_cast<ZipType *>(this);
590 }
591
592 ZipType &operator--() {
593 static_assert(Base::IsBidirectional,
594 "All inner iterators must be at least bidirectional.");
595 iterators = tup_dec(index_sequence_for<Iters...>{});
596 return *reinterpret_cast<ZipType *>(this);
597 }
598};
599
600template <typename... Iters>
601struct zip_first : public zip_common<zip_first<Iters...>, Iters...> {
602 using Base = zip_common<zip_first<Iters...>, Iters...>;
603
604 bool operator==(const zip_first<Iters...> &other) const {
605 return std::get<0>(this->iterators) == std::get<0>(other.iterators);
606 }
607
608 zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {}
609};
610
611template <typename... Iters>
612class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> {
613 template <size_t... Ns>
614 bool test(const zip_shortest<Iters...> &other, index_sequence<Ns...>) const {
615 return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) !=
616 std::get<Ns>(other.iterators)...},
617 identity<bool>{});
618 }
619
620public:
621 using Base = zip_common<zip_shortest<Iters...>, Iters...>;
622
623 zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {}
624
625 bool operator==(const zip_shortest<Iters...> &other) const {
626 return !test(other, index_sequence_for<Iters...>{});
627 }
628};
629
630template <template <typename...> class ItType, typename... Args> class zippy {
631public:
632 using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>;
633 using iterator_category = typename iterator::iterator_category;
634 using value_type = typename iterator::value_type;
635 using difference_type = typename iterator::difference_type;
636 using pointer = typename iterator::pointer;
637 using reference = typename iterator::reference;
638
639private:
640 std::tuple<Args...> ts;
641
642 template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const {
643 return iterator(std::begin(std::get<Ns>(ts))...);
644 }
645 template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const {
646 return iterator(std::end(std::get<Ns>(ts))...);
647 }
648
649public:
650 zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {}
651
652 iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); }
653 iterator end() const { return end_impl(index_sequence_for<Args...>{}); }
654};
655
656} // end namespace detail
657
658/// zip iterator for two or more iteratable types.
659template <typename T, typename U, typename... Args>
660detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u,
661 Args &&... args) {
662 return detail::zippy<detail::zip_shortest, T, U, Args...>(
663 std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
664}
665
666/// zip iterator that, for the sake of efficiency, assumes the first iteratee to
667/// be the shortest.
668template <typename T, typename U, typename... Args>
669detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u,
670 Args &&... args) {
671 return detail::zippy<detail::zip_first, T, U, Args...>(
672 std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
673}
674
675namespace detail {
676template <typename Iter>
677static Iter next_or_end(const Iter &I, const Iter &End) {
678 if (I == End)
679 return End;
680 return std::next(I);
681}
682
683template <typename Iter>
684static auto deref_or_none(const Iter &I, const Iter &End)
685 -> llvm::Optional<typename std::remove_const<
686 typename std::remove_reference<decltype(*I)>::type>::type> {
687 if (I == End)
688 return None;
689 return *I;
690}
691
692template <typename Iter> struct ZipLongestItemType {
693 using type =
694 llvm::Optional<typename std::remove_const<typename std::remove_reference<
695 decltype(*std::declval<Iter>())>::type>::type>;
696};
697
698template <typename... Iters> struct ZipLongestTupleType {
699 using type = std::tuple<typename ZipLongestItemType<Iters>::type...>;
700};
701
702template <typename... Iters>
703class zip_longest_iterator
704 : public iterator_facade_base<
705 zip_longest_iterator<Iters...>,
706 typename std::common_type<
707 std::forward_iterator_tag,
708 typename std::iterator_traits<Iters>::iterator_category...>::type,
709 typename ZipLongestTupleType<Iters...>::type,
710 typename std::iterator_traits<typename std::tuple_element<
711 0, std::tuple<Iters...>>::type>::difference_type,
712 typename ZipLongestTupleType<Iters...>::type *,
713 typename ZipLongestTupleType<Iters...>::type> {
714public:
715 using value_type = typename ZipLongestTupleType<Iters...>::type;
716
717private:
718 std::tuple<Iters...> iterators;
719 std::tuple<Iters...> end_iterators;
720
721 template <size_t... Ns>
722 bool test(const zip_longest_iterator<Iters...> &other,
723 index_sequence<Ns...>) const {
724 return llvm::any_of(
725 std::initializer_list<bool>{std::get<Ns>(this->iterators) !=
726 std::get<Ns>(other.iterators)...},
727 identity<bool>{});
728 }
729
730 template <size_t... Ns> value_type deref(index_sequence<Ns...>) const {
731 return value_type(
732 deref_or_none(std::get<Ns>(iterators), std::get<Ns>(end_iterators))...);
733 }
734
735 template <size_t... Ns>
736 decltype(iterators) tup_inc(index_sequence<Ns...>) const {
737 return std::tuple<Iters...>(
738 next_or_end(std::get<Ns>(iterators), std::get<Ns>(end_iterators))...);
739 }
740
741public:
742 zip_longest_iterator(std::pair<Iters &&, Iters &&>... ts)
743 : iterators(std::forward<Iters>(ts.first)...),
744 end_iterators(std::forward<Iters>(ts.second)...) {}
745
746 value_type operator*() { return deref(index_sequence_for<Iters...>{}); }
747
748 value_type operator*() const { return deref(index_sequence_for<Iters...>{}); }
749
750 zip_longest_iterator<Iters...> &operator++() {
751 iterators = tup_inc(index_sequence_for<Iters...>{});
752 return *this;
753 }
754
755 bool operator==(const zip_longest_iterator<Iters...> &other) const {
756 return !test(other, index_sequence_for<Iters...>{});
757 }
758};
759
760template <typename... Args> class zip_longest_range {
761public:
762 using iterator =
763 zip_longest_iterator<decltype(adl_begin(std::declval<Args>()))...>;
764 using iterator_category = typename iterator::iterator_category;
765 using value_type = typename iterator::value_type;
766 using difference_type = typename iterator::difference_type;
767 using pointer = typename iterator::pointer;
768 using reference = typename iterator::reference;
769
770private:
771 std::tuple<Args...> ts;
772
773 template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const {
774 return iterator(std::make_pair(adl_begin(std::get<Ns>(ts)),
775 adl_end(std::get<Ns>(ts)))...);
776 }
777
778 template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const {
779 return iterator(std::make_pair(adl_end(std::get<Ns>(ts)),
780 adl_end(std::get<Ns>(ts)))...);
781 }
782
783public:
784 zip_longest_range(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {}
785
786 iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); }
787 iterator end() const { return end_impl(index_sequence_for<Args...>{}); }
788};
789} // namespace detail
790
791/// Iterate over two or more iterators at the same time. Iteration continues
792/// until all iterators reach the end. The llvm::Optional only contains a value
793/// if the iterator has not reached the end.
794template <typename T, typename U, typename... Args>
795detail::zip_longest_range<T, U, Args...> zip_longest(T &&t, U &&u,
796 Args &&... args) {
797 return detail::zip_longest_range<T, U, Args...>(
798 std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
799}
800
801/// Iterator wrapper that concatenates sequences together.
802///
803/// This can concatenate different iterators, even with different types, into
804/// a single iterator provided the value types of all the concatenated
805/// iterators expose `reference` and `pointer` types that can be converted to
806/// `ValueT &` and `ValueT *` respectively. It doesn't support more
807/// interesting/customized pointer or reference types.
808///
809/// Currently this only supports forward or higher iterator categories as
810/// inputs and always exposes a forward iterator interface.
811template <typename ValueT, typename... IterTs>
812class concat_iterator
813 : public iterator_facade_base<concat_iterator<ValueT, IterTs...>,
814 std::forward_iterator_tag, ValueT> {
815 using BaseT = typename concat_iterator::iterator_facade_base;
816
817 /// We store both the current and end iterators for each concatenated
818 /// sequence in a tuple of pairs.
819 ///
820 /// Note that something like iterator_range seems nice at first here, but the
821 /// range properties are of little benefit and end up getting in the way
822 /// because we need to do mutation on the current iterators.
823 std::tuple<IterTs...> Begins;
824 std::tuple<IterTs...> Ends;
825
826 /// Attempts to increment a specific iterator.
827 ///
828 /// Returns true if it was able to increment the iterator. Returns false if
829 /// the iterator is already at the end iterator.
830 template <size_t Index> bool incrementHelper() {
831 auto &Begin = std::get<Index>(Begins);
832 auto &End = std::get<Index>(Ends);
833 if (Begin == End)
834 return false;
835
836 ++Begin;
837 return true;
838 }
839
840 /// Increments the first non-end iterator.
841 ///
842 /// It is an error to call this with all iterators at the end.
843 template <size_t... Ns> void increment(index_sequence<Ns...>) {
844 // Build a sequence of functions to increment each iterator if possible.
845 bool (concat_iterator::*IncrementHelperFns[])() = {
846 &concat_iterator::incrementHelper<Ns>...};
847
848 // Loop over them, and stop as soon as we succeed at incrementing one.
849 for (auto &IncrementHelperFn : IncrementHelperFns)
850 if ((this->*IncrementHelperFn)())
851 return;
852
853 llvm_unreachable("Attempted to increment an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to increment an end concat iterator!"
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 853)
;
854 }
855
856 /// Returns null if the specified iterator is at the end. Otherwise,
857 /// dereferences the iterator and returns the address of the resulting
858 /// reference.
859 template <size_t Index> ValueT *getHelper() const {
860 auto &Begin = std::get<Index>(Begins);
861 auto &End = std::get<Index>(Ends);
862 if (Begin == End)
863 return nullptr;
864
865 return &*Begin;
866 }
867
868 /// Finds the first non-end iterator, dereferences, and returns the resulting
869 /// reference.
870 ///
871 /// It is an error to call this with all iterators at the end.
872 template <size_t... Ns> ValueT &get(index_sequence<Ns...>) const {
873 // Build a sequence of functions to get from iterator if possible.
874 ValueT *(concat_iterator::*GetHelperFns[])() const = {
875 &concat_iterator::getHelper<Ns>...};
876
877 // Loop over them, and return the first result we find.
878 for (auto &GetHelperFn : GetHelperFns)
879 if (ValueT *P = (this->*GetHelperFn)())
880 return *P;
881
882 llvm_unreachable("Attempted to get a pointer from an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to get a pointer from an end concat iterator!"
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 882)
;
883 }
884
885public:
886 /// Constructs an iterator from a squence of ranges.
887 ///
888 /// We need the full range to know how to switch between each of the
889 /// iterators.
890 template <typename... RangeTs>
891 explicit concat_iterator(RangeTs &&... Ranges)
892 : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {}
893
894 using BaseT::operator++;
895
896 concat_iterator &operator++() {
897 increment(index_sequence_for<IterTs...>());
898 return *this;
899 }
900
901 ValueT &operator*() const { return get(index_sequence_for<IterTs...>()); }
902
903 bool operator==(const concat_iterator &RHS) const {
904 return Begins == RHS.Begins && Ends == RHS.Ends;
905 }
906};
907
908namespace detail {
909
910/// Helper to store a sequence of ranges being concatenated and access them.
911///
912/// This is designed to facilitate providing actual storage when temporaries
913/// are passed into the constructor such that we can use it as part of range
914/// based for loops.
915template <typename ValueT, typename... RangeTs> class concat_range {
916public:
917 using iterator =
918 concat_iterator<ValueT,
919 decltype(std::begin(std::declval<RangeTs &>()))...>;
920
921private:
922 std::tuple<RangeTs...> Ranges;
923
924 template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) {
925 return iterator(std::get<Ns>(Ranges)...);
926 }
927 template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) {
928 return iterator(make_range(std::end(std::get<Ns>(Ranges)),
929 std::end(std::get<Ns>(Ranges)))...);
930 }
931
932public:
933 concat_range(RangeTs &&... Ranges)
934 : Ranges(std::forward<RangeTs>(Ranges)...) {}
935
936 iterator begin() { return begin_impl(index_sequence_for<RangeTs...>{}); }
937 iterator end() { return end_impl(index_sequence_for<RangeTs...>{}); }
938};
939
940} // end namespace detail
941
942/// Concatenated range across two or more ranges.
943///
944/// The desired value type must be explicitly specified.
945template <typename ValueT, typename... RangeTs>
946detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) {
947 static_assert(sizeof...(RangeTs) > 1,
948 "Need more than one range to concatenate!");
949 return detail::concat_range<ValueT, RangeTs...>(
950 std::forward<RangeTs>(Ranges)...);
951}
952
953//===----------------------------------------------------------------------===//
954// Extra additions to <utility>
955//===----------------------------------------------------------------------===//
956
957/// Function object to check whether the first component of a std::pair
958/// compares less than the first component of another std::pair.
959struct less_first {
960 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
961 return lhs.first < rhs.first;
962 }
963};
964
965/// Function object to check whether the second component of a std::pair
966/// compares less than the second component of another std::pair.
967struct less_second {
968 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
969 return lhs.second < rhs.second;
970 }
971};
972
973/// \brief Function object to apply a binary function to the first component of
974/// a std::pair.
975template<typename FuncTy>
976struct on_first {
977 FuncTy func;
978
979 template <typename T>
980 auto operator()(const T &lhs, const T &rhs) const
981 -> decltype(func(lhs.first, rhs.first)) {
982 return func(lhs.first, rhs.first);
983 }
984};
985
986// A subset of N3658. More stuff can be added as-needed.
987
988/// Represents a compile-time sequence of integers.
989template <class T, T... I> struct integer_sequence {
990 using value_type = T;
991
992 static constexpr size_t size() { return sizeof...(I); }
993};
994
995/// Alias for the common case of a sequence of size_ts.
996template <size_t... I>
997struct index_sequence : integer_sequence<std::size_t, I...> {};
998
999template <std::size_t N, std::size_t... I>
1000struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {};
1001template <std::size_t... I>
1002struct build_index_impl<0, I...> : index_sequence<I...> {};
1003
1004/// Creates a compile-time integer sequence for a parameter pack.
1005template <class... Ts>
1006struct index_sequence_for : build_index_impl<sizeof...(Ts)> {};
1007
1008/// Utility type to build an inheritance chain that makes it easy to rank
1009/// overload candidates.
1010template <int N> struct rank : rank<N - 1> {};
1011template <> struct rank<0> {};
1012
1013/// traits class for checking whether type T is one of any of the given
1014/// types in the variadic list.
1015template <typename T, typename... Ts> struct is_one_of {
1016 static const bool value = false;
1017};
1018
1019template <typename T, typename U, typename... Ts>
1020struct is_one_of<T, U, Ts...> {
1021 static const bool value =
1022 std::is_same<T, U>::value || is_one_of<T, Ts...>::value;
1023};
1024
1025/// traits class for checking whether type T is a base class for all
1026/// the given types in the variadic list.
1027template <typename T, typename... Ts> struct are_base_of {
1028 static const bool value = true;
1029};
1030
1031template <typename T, typename U, typename... Ts>
1032struct are_base_of<T, U, Ts...> {
1033 static const bool value =
1034 std::is_base_of<T, U>::value && are_base_of<T, Ts...>::value;
1035};
1036
1037//===----------------------------------------------------------------------===//
1038// Extra additions for arrays
1039//===----------------------------------------------------------------------===//
1040
1041/// Find the length of an array.
1042template <class T, std::size_t N>
1043constexpr inline size_t array_lengthof(T (&)[N]) {
1044 return N;
1045}
1046
1047/// Adapt std::less<T> for array_pod_sort.
1048template<typename T>
1049inline int array_pod_sort_comparator(const void *P1, const void *P2) {
1050 if (std::less<T>()(*reinterpret_cast<const T*>(P1),
1051 *reinterpret_cast<const T*>(P2)))
1052 return -1;
1053 if (std::less<T>()(*reinterpret_cast<const T*>(P2),
1054 *reinterpret_cast<const T*>(P1)))
1055 return 1;
1056 return 0;
1057}
1058
1059/// get_array_pod_sort_comparator - This is an internal helper function used to
1060/// get type deduction of T right.
1061template<typename T>
1062inline int (*get_array_pod_sort_comparator(const T &))
1063 (const void*, const void*) {
1064 return array_pod_sort_comparator<T>;
1065}
1066
1067/// array_pod_sort - This sorts an array with the specified start and end
1068/// extent. This is just like std::sort, except that it calls qsort instead of
1069/// using an inlined template. qsort is slightly slower than std::sort, but
1070/// most sorts are not performance critical in LLVM and std::sort has to be
1071/// template instantiated for each type, leading to significant measured code
1072/// bloat. This function should generally be used instead of std::sort where
1073/// possible.
1074///
1075/// This function assumes that you have simple POD-like types that can be
1076/// compared with std::less and can be moved with memcpy. If this isn't true,
1077/// you should use std::sort.
1078///
1079/// NOTE: If qsort_r were portable, we could allow a custom comparator and
1080/// default to std::less.
1081template<class IteratorTy>
1082inline void array_pod_sort(IteratorTy Start, IteratorTy End) {
1083 // Don't inefficiently call qsort with one element or trigger undefined
1084 // behavior with an empty sequence.
1085 auto NElts = End - Start;
1086 if (NElts <= 1) return;
1087#ifdef EXPENSIVE_CHECKS
1088 std::mt19937 Generator(std::random_device{}());
1089 std::shuffle(Start, End, Generator);
1090#endif
1091 qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start));
1092}
1093
1094template <class IteratorTy>
1095inline void array_pod_sort(
1096 IteratorTy Start, IteratorTy End,
1097 int (*Compare)(
1098 const typename std::iterator_traits<IteratorTy>::value_type *,
1099 const typename std::iterator_traits<IteratorTy>::value_type *)) {
1100 // Don't inefficiently call qsort with one element or trigger undefined
1101 // behavior with an empty sequence.
1102 auto NElts = End - Start;
1103 if (NElts <= 1) return;
1104#ifdef EXPENSIVE_CHECKS
1105 std::mt19937 Generator(std::random_device{}());
1106 std::shuffle(Start, End, Generator);
1107#endif
1108 qsort(&*Start, NElts, sizeof(*Start),
1109 reinterpret_cast<int (*)(const void *, const void *)>(Compare));
1110}
1111
1112// Provide wrappers to std::sort which shuffle the elements before sorting
1113// to help uncover non-deterministic behavior (PR35135).
1114template <typename IteratorTy>
1115inline void sort(IteratorTy Start, IteratorTy End) {
1116#ifdef EXPENSIVE_CHECKS
1117 std::mt19937 Generator(std::random_device{}());
1118 std::shuffle(Start, End, Generator);
1119#endif
1120 std::sort(Start, End);
1121}
1122
1123template <typename Container> inline void sort(Container &&C) {
1124 llvm::sort(adl_begin(C), adl_end(C));
1125}
1126
1127template <typename IteratorTy, typename Compare>
1128inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) {
1129#ifdef EXPENSIVE_CHECKS
1130 std::mt19937 Generator(std::random_device{}());
1131 std::shuffle(Start, End, Generator);
1132#endif
1133 std::sort(Start, End, Comp);
1134}
1135
1136template <typename Container, typename Compare>
1137inline void sort(Container &&C, Compare Comp) {
1138 llvm::sort(adl_begin(C), adl_end(C), Comp);
1139}
1140
1141//===----------------------------------------------------------------------===//
1142// Extra additions to <algorithm>
1143//===----------------------------------------------------------------------===//
1144
1145/// For a container of pointers, deletes the pointers and then clears the
1146/// container.
1147template<typename Container>
1148void DeleteContainerPointers(Container &C) {
1149 for (auto V : C)
1150 delete V;
1151 C.clear();
1152}
1153
1154/// In a container of pairs (usually a map) whose second element is a pointer,
1155/// deletes the second elements and then clears the container.
1156template<typename Container>
1157void DeleteContainerSeconds(Container &C) {
1158 for (auto &V : C)
1159 delete V.second;
1160 C.clear();
1161}
1162
1163/// Get the size of a range. This is a wrapper function around std::distance
1164/// which is only enabled when the operation is O(1).
1165template <typename R>
1166auto size(R &&Range, typename std::enable_if<
1167 std::is_same<typename std::iterator_traits<decltype(
1168 Range.begin())>::iterator_category,
1169 std::random_access_iterator_tag>::value,
1170 void>::type * = nullptr)
1171 -> decltype(std::distance(Range.begin(), Range.end())) {
1172 return std::distance(Range.begin(), Range.end());
1173}
1174
1175/// Provide wrappers to std::for_each which take ranges instead of having to
1176/// pass begin/end explicitly.
1177template <typename R, typename UnaryPredicate>
1178UnaryPredicate for_each(R &&Range, UnaryPredicate P) {
1179 return std::for_each(adl_begin(Range), adl_end(Range), P);
1180}
1181
1182/// Provide wrappers to std::all_of which take ranges instead of having to pass
1183/// begin/end explicitly.
1184template <typename R, typename UnaryPredicate>
1185bool all_of(R &&Range, UnaryPredicate P) {
1186 return std::all_of(adl_begin(Range), adl_end(Range), P);
1187}
1188
1189/// Provide wrappers to std::any_of which take ranges instead of having to pass
1190/// begin/end explicitly.
1191template <typename R, typename UnaryPredicate>
1192bool any_of(R &&Range, UnaryPredicate P) {
1193 return std::any_of(adl_begin(Range), adl_end(Range), P);
1194}
1195
1196/// Provide wrappers to std::none_of which take ranges instead of having to pass
1197/// begin/end explicitly.
1198template <typename R, typename UnaryPredicate>
1199bool none_of(R &&Range, UnaryPredicate P) {
1200 return std::none_of(adl_begin(Range), adl_end(Range), P);
1201}
1202
1203/// Provide wrappers to std::find which take ranges instead of having to pass
1204/// begin/end explicitly.
1205template <typename R, typename T>
1206auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range)) {
1207 return std::find(adl_begin(Range), adl_end(Range), Val);
1208}
1209
1210/// Provide wrappers to std::find_if which take ranges instead of having to pass
1211/// begin/end explicitly.
1212template <typename R, typename UnaryPredicate>
1213auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1214 return std::find_if(adl_begin(Range), adl_end(Range), P);
1215}
1216
1217template <typename R, typename UnaryPredicate>
1218auto find_if_not(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1219 return std::find_if_not(adl_begin(Range), adl_end(Range), P);
1220}
1221
1222/// Provide wrappers to std::remove_if which take ranges instead of having to
1223/// pass begin/end explicitly.
1224template <typename R, typename UnaryPredicate>
1225auto remove_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1226 return std::remove_if(adl_begin(Range), adl_end(Range), P);
1227}
1228
1229/// Provide wrappers to std::copy_if which take ranges instead of having to
1230/// pass begin/end explicitly.
1231template <typename R, typename OutputIt, typename UnaryPredicate>
1232OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) {
1233 return std::copy_if(adl_begin(Range), adl_end(Range), Out, P);
1234}
1235
1236template <typename R, typename OutputIt>
1237OutputIt copy(R &&Range, OutputIt Out) {
1238 return std::copy(adl_begin(Range), adl_end(Range), Out);
1239}
1240
1241/// Wrapper function around std::find to detect if an element exists
1242/// in a container.
1243template <typename R, typename E>
1244bool is_contained(R &&Range, const E &Element) {
1245 return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range);
1246}
1247
1248/// Wrapper function around std::count to count the number of times an element
1249/// \p Element occurs in the given range \p Range.
1250template <typename R, typename E>
1251auto count(R &&Range, const E &Element) ->
1252 typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type {
1253 return std::count(adl_begin(Range), adl_end(Range), Element);
1254}
1255
1256/// Wrapper function around std::count_if to count the number of times an
1257/// element satisfying a given predicate occurs in a range.
1258template <typename R, typename UnaryPredicate>
1259auto count_if(R &&Range, UnaryPredicate P) ->
1260 typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type {
1261 return std::count_if(adl_begin(Range), adl_end(Range), P);
1262}
1263
1264/// Wrapper function around std::transform to apply a function to a range and
1265/// store the result elsewhere.
1266template <typename R, typename OutputIt, typename UnaryPredicate>
1267OutputIt transform(R &&Range, OutputIt d_first, UnaryPredicate P) {
1268 return std::transform(adl_begin(Range), adl_end(Range), d_first, P);
1269}
1270
1271/// Provide wrappers to std::partition which take ranges instead of having to
1272/// pass begin/end explicitly.
1273template <typename R, typename UnaryPredicate>
1274auto partition(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1275 return std::partition(adl_begin(Range), adl_end(Range), P);
1276}
1277
1278/// Provide wrappers to std::lower_bound which take ranges instead of having to
1279/// pass begin/end explicitly.
1280template <typename R, typename T>
1281auto lower_bound(R &&Range, T &&Value) -> decltype(adl_begin(Range)) {
1282 return std::lower_bound(adl_begin(Range), adl_end(Range),
1283 std::forward<T>(Value));
1284}
1285
1286template <typename R, typename T, typename Compare>
1287auto lower_bound(R &&Range, T &&Value, Compare C)
1288 -> decltype(adl_begin(Range)) {
1289 return std::lower_bound(adl_begin(Range), adl_end(Range),
1290 std::forward<T>(Value), C);
1291}
1292
1293/// Provide wrappers to std::upper_bound which take ranges instead of having to
1294/// pass begin/end explicitly.
1295template <typename R, typename T>
1296auto upper_bound(R &&Range, T &&Value) -> decltype(adl_begin(Range)) {
1297 return std::upper_bound(adl_begin(Range), adl_end(Range),
1298 std::forward<T>(Value));
1299}
1300
1301template <typename R, typename T, typename Compare>
1302auto upper_bound(R &&Range, T &&Value, Compare C)
1303 -> decltype(adl_begin(Range)) {
1304 return std::upper_bound(adl_begin(Range), adl_end(Range),
1305 std::forward<T>(Value), C);
1306}
1307
1308template <typename R>
1309void stable_sort(R &&Range) {
1310 std::stable_sort(adl_begin(Range), adl_end(Range));
1311}
1312
1313template <typename R, typename Compare>
1314void stable_sort(R &&Range, Compare C) {
1315 std::stable_sort(adl_begin(Range), adl_end(Range), C);
1316}
1317
1318/// Binary search for the first index where a predicate is true.
1319/// Returns the first I in [Lo, Hi) where C(I) is true, or Hi if it never is.
1320/// Requires that C is always false below some limit, and always true above it.
1321///
1322/// Example:
1323/// size_t DawnModernEra = bsearch(1776, 2050, [](size_t Year){
1324/// return Presidents.for(Year).twitterHandle() != None;
1325/// });
1326///
1327/// Note the return value differs from std::binary_search!
1328template <typename Predicate>
1329size_t bsearch(size_t Lo, size_t Hi, Predicate P) {
1330 while (Lo != Hi) {
1331 assert(Hi > Lo)((Hi > Lo) ? static_cast<void> (0) : __assert_fail (
"Hi > Lo", "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 1331, __PRETTY_FUNCTION__))
;
1332 size_t Mid = Lo + (Hi - Lo) / 2;
1333 if (P(Mid))
1334 Hi = Mid;
1335 else
1336 Lo = Mid + 1;
1337 }
1338 return Hi;
1339}
1340
1341/// Binary search for the first iterator where a predicate is true.
1342/// Returns the first I in [Lo, Hi) where C(*I) is true, or Hi if it never is.
1343/// Requires that C is always false below some limit, and always true above it.
1344template <typename It, typename Predicate,
1345 typename Val = decltype(*std::declval<It>())>
1346It bsearch(It Lo, It Hi, Predicate P) {
1347 return std::lower_bound(Lo, Hi, 0u,
1348 [&](const Val &V, unsigned) { return !P(V); });
1349}
1350
1351/// Binary search for the first iterator in a range where a predicate is true.
1352/// Requires that C is always false below some limit, and always true above it.
1353template <typename R, typename Predicate>
1354auto bsearch(R &&Range, Predicate P) -> decltype(adl_begin(Range)) {
1355 return bsearch(adl_begin(Range), adl_end(Range), P);
1356}
1357
1358/// Wrapper function around std::equal to detect if all elements
1359/// in a container are same.
1360template <typename R>
1361bool is_splat(R &&Range) {
1362 size_t range_size = size(Range);
1363 return range_size != 0 && (range_size == 1 ||
1364 std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range)));
1365}
1366
1367/// Given a range of type R, iterate the entire range and return a
1368/// SmallVector with elements of the vector. This is useful, for example,
1369/// when you want to iterate a range and then sort the results.
1370template <unsigned Size, typename R>
1371SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size>
1372to_vector(R &&Range) {
1373 return {adl_begin(Range), adl_end(Range)};
1374}
1375
1376/// Provide a container algorithm similar to C++ Library Fundamentals v2's
1377/// `erase_if` which is equivalent to:
1378///
1379/// C.erase(remove_if(C, pred), C.end());
1380///
1381/// This version works for any container with an erase method call accepting
1382/// two iterators.
1383template <typename Container, typename UnaryPredicate>
1384void erase_if(Container &C, UnaryPredicate P) {
1385 C.erase(remove_if(C, P), C.end());
1386}
1387
1388//===----------------------------------------------------------------------===//
1389// Extra additions to <memory>
1390//===----------------------------------------------------------------------===//
1391
1392// Implement make_unique according to N3656.
1393
1394/// Constructs a `new T()` with the given args and returns a
1395/// `unique_ptr<T>` which owns the object.
1396///
1397/// Example:
1398///
1399/// auto p = make_unique<int>();
1400/// auto p = make_unique<std::tuple<int, int>>(0, 1);
1401template <class T, class... Args>
1402typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
1403make_unique(Args &&... args) {
1404 return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
8
Memory is allocated
1405}
1406
1407/// Constructs a `new T[n]` with the given args and returns a
1408/// `unique_ptr<T[]>` which owns the object.
1409///
1410/// \param n size of the new array.
1411///
1412/// Example:
1413///
1414/// auto p = make_unique<int[]>(2); // value-initializes the array with 0's.
1415template <class T>
1416typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0,
1417 std::unique_ptr<T>>::type
1418make_unique(size_t n) {
1419 return std::unique_ptr<T>(new typename std::remove_extent<T>::type[n]());
1420}
1421
1422/// This function isn't used and is only here to provide better compile errors.
1423template <class T, class... Args>
1424typename std::enable_if<std::extent<T>::value != 0>::type
1425make_unique(Args &&...) = delete;
1426
1427struct FreeDeleter {
1428 void operator()(void* v) {
1429 ::free(v);
1430 }
1431};
1432
1433template<typename First, typename Second>
1434struct pair_hash {
1435 size_t operator()(const std::pair<First, Second> &P) const {
1436 return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second);
1437 }
1438};
1439
1440/// A functor like C++14's std::less<void> in its absence.
1441struct less {
1442 template <typename A, typename B> bool operator()(A &&a, B &&b) const {
1443 return std::forward<A>(a) < std::forward<B>(b);
1444 }
1445};
1446
1447/// A functor like C++14's std::equal<void> in its absence.
1448struct equal {
1449 template <typename A, typename B> bool operator()(A &&a, B &&b) const {
1450 return std::forward<A>(a) == std::forward<B>(b);
1451 }
1452};
1453
1454/// Binary functor that adapts to any other binary functor after dereferencing
1455/// operands.
1456template <typename T> struct deref {
1457 T func;
1458
1459 // Could be further improved to cope with non-derivable functors and
1460 // non-binary functors (should be a variadic template member function
1461 // operator()).
1462 template <typename A, typename B>
1463 auto operator()(A &lhs, B &rhs) const -> decltype(func(*lhs, *rhs)) {
1464 assert(lhs)((lhs) ? static_cast<void> (0) : __assert_fail ("lhs", "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 1464, __PRETTY_FUNCTION__))
;
1465 assert(rhs)((rhs) ? static_cast<void> (0) : __assert_fail ("rhs", "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 1465, __PRETTY_FUNCTION__))
;
1466 return func(*lhs, *rhs);
1467 }
1468};
1469
1470namespace detail {
1471
1472template <typename R> class enumerator_iter;
1473
1474template <typename R> struct result_pair {
1475 friend class enumerator_iter<R>;
1476
1477 result_pair() = default;
1478 result_pair(std::size_t Index, IterOfRange<R> Iter)
1479 : Index(Index), Iter(Iter) {}
1480
1481 result_pair<R> &operator=(const result_pair<R> &Other) {
1482 Index = Other.Index;
1483 Iter = Other.Iter;
1484 return *this;
1485 }
1486
1487 std::size_t index() const { return Index; }
1488 const ValueOfRange<R> &value() const { return *Iter; }
1489 ValueOfRange<R> &value() { return *Iter; }
1490
1491private:
1492 std::size_t Index = std::numeric_limits<std::size_t>::max();
1493 IterOfRange<R> Iter;
1494};
1495
1496template <typename R>
1497class enumerator_iter
1498 : public iterator_facade_base<
1499 enumerator_iter<R>, std::forward_iterator_tag, result_pair<R>,
1500 typename std::iterator_traits<IterOfRange<R>>::difference_type,
1501 typename std::iterator_traits<IterOfRange<R>>::pointer,
1502 typename std::iterator_traits<IterOfRange<R>>::reference> {
1503 using result_type = result_pair<R>;
1504
1505public:
1506 explicit enumerator_iter(IterOfRange<R> EndIter)
1507 : Result(std::numeric_limits<size_t>::max(), EndIter) {}
1508
1509 enumerator_iter(std::size_t Index, IterOfRange<R> Iter)
1510 : Result(Index, Iter) {}
1511
1512 result_type &operator*() { return Result; }
1513 const result_type &operator*() const { return Result; }
1514
1515 enumerator_iter<R> &operator++() {
1516 assert(Result.Index != std::numeric_limits<size_t>::max())((Result.Index != std::numeric_limits<size_t>::max()) ?
static_cast<void> (0) : __assert_fail ("Result.Index != std::numeric_limits<size_t>::max()"
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/ADT/STLExtras.h"
, 1516, __PRETTY_FUNCTION__))
;
1517 ++Result.Iter;
1518 ++Result.Index;
1519 return *this;
1520 }
1521
1522 bool operator==(const enumerator_iter<R> &RHS) const {
1523 // Don't compare indices here, only iterators. It's possible for an end
1524 // iterator to have different indices depending on whether it was created
1525 // by calling std::end() versus incrementing a valid iterator.
1526 return Result.Iter == RHS.Result.Iter;
1527 }
1528
1529 enumerator_iter<R> &operator=(const enumerator_iter<R> &Other) {
1530 Result = Other.Result;
1531 return *this;
1532 }
1533
1534private:
1535 result_type Result;
1536};
1537
1538template <typename R> class enumerator {
1539public:
1540 explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {}
1541
1542 enumerator_iter<R> begin() {
1543 return enumerator_iter<R>(0, std::begin(TheRange));
1544 }
1545
1546 enumerator_iter<R> end() {
1547 return enumerator_iter<R>(std::end(TheRange));
1548 }
1549
1550private:
1551 R TheRange;
1552};
1553
1554} // end namespace detail
1555
1556/// Given an input range, returns a new range whose values are are pair (A,B)
1557/// such that A is the 0-based index of the item in the sequence, and B is
1558/// the value from the original sequence. Example:
1559///
1560/// std::vector<char> Items = {'A', 'B', 'C', 'D'};
1561/// for (auto X : enumerate(Items)) {
1562/// printf("Item %d - %c\n", X.index(), X.value());
1563/// }
1564///
1565/// Output:
1566/// Item 0 - A
1567/// Item 1 - B
1568/// Item 2 - C
1569/// Item 3 - D
1570///
1571template <typename R> detail::enumerator<R> enumerate(R &&TheRange) {
1572 return detail::enumerator<R>(std::forward<R>(TheRange));
1573}
1574
1575namespace detail {
1576
1577template <typename F, typename Tuple, std::size_t... I>
1578auto apply_tuple_impl(F &&f, Tuple &&t, index_sequence<I...>)
1579 -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...)) {
1580 return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...);
1581}
1582
1583} // end namespace detail
1584
1585/// Given an input tuple (a1, a2, ..., an), pass the arguments of the
1586/// tuple variadically to f as if by calling f(a1, a2, ..., an) and
1587/// return the result.
1588template <typename F, typename Tuple>
1589auto apply_tuple(F &&f, Tuple &&t) -> decltype(detail::apply_tuple_impl(
1590 std::forward<F>(f), std::forward<Tuple>(t),
1591 build_index_impl<
1592 std::tuple_size<typename std::decay<Tuple>::type>::value>{})) {
1593 using Indices = build_index_impl<
1594 std::tuple_size<typename std::decay<Tuple>::type>::value>;
1595
1596 return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t),
1597 Indices{});
1598}
1599
1600/// Return true if the sequence [Begin, End) has exactly N items. Runs in O(N)
1601/// time. Not meant for use with random-access iterators.
1602template <typename IterTy>
1603bool hasNItems(
1604 IterTy &&Begin, IterTy &&End, unsigned N,
1605 typename std::enable_if<
1606 !std::is_same<
1607 typename std::iterator_traits<typename std::remove_reference<
1608 decltype(Begin)>::type>::iterator_category,
1609 std::random_access_iterator_tag>::value,
1610 void>::type * = nullptr) {
1611 for (; N; --N, ++Begin)
1612 if (Begin == End)
1613 return false; // Too few.
1614 return Begin == End;
1615}
1616
1617/// Return true if the sequence [Begin, End) has N or more items. Runs in O(N)
1618/// time. Not meant for use with random-access iterators.
1619template <typename IterTy>
1620bool hasNItemsOrMore(
1621 IterTy &&Begin, IterTy &&End, unsigned N,
1622 typename std::enable_if<
1623 !std::is_same<
1624 typename std::iterator_traits<typename std::remove_reference<
1625 decltype(Begin)>::type>::iterator_category,
1626 std::random_access_iterator_tag>::value,
1627 void>::type * = nullptr) {
1628 for (; N; --N, ++Begin)
1629 if (Begin == End)
1630 return false; // Too few.
1631 return true;
1632}
1633
1634/// Returns a raw pointer that represents the same address as the argument.
1635///
1636/// The late bound return should be removed once we move to C++14 to better
1637/// align with the C++20 declaration. Also, this implementation can be removed
1638/// once we move to C++20 where it's defined as std::to_addres()
1639///
1640/// The std::pointer_traits<>::to_address(p) variations of these overloads has
1641/// not been implemented.
1642template <class Ptr> auto to_address(const Ptr &P) -> decltype(P.operator->()) {
1643 return P.operator->();
1644}
1645template <class T> constexpr T *to_address(T *P) { return P; }
1646
1647} // end namespace llvm
1648
1649#endif // LLVM_ADT_STLEXTRAS_H