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 
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/Config/llvm-config.h"
13 #include "llvm/ExecutionEngine/Orc/DebugUtils.h"
14 #include "llvm/ExecutionEngine/Orc/OrcError.h"
15 #include "llvm/Support/FormatVariadic.h"
16 #include "llvm/Support/MSVCErrorWorkarounds.h"
17 
18 #include <condition_variable>
19 #include <future>
20 
21 #define DEBUG_TYPE "orc"
22 
23 namespace llvm {
24 namespace orc {
25 
26 char ResourceTrackerDefunct::ID = 0;
27 char FailedToMaterialize::ID = 0;
28 char SymbolsNotFound::ID = 0;
29 char SymbolsCouldNotBeRemoved::ID = 0;
30 char MissingSymbolDefinitions::ID = 0;
31 char UnexpectedSymbolDefinitions::ID = 0;
32 
33 RegisterDependenciesFunction NoDependenciesToRegister =
34     RegisterDependenciesFunction();
35 
36 void MaterializationUnit::anchor() {}
37 
38 ResourceTracker::ResourceTracker(JITDylibSP JD) {
39   assert((reinterpret_cast<uintptr_t>(JD.get()) & 0x1) == 0 &&
40          "JITDylib must be two byte aligned");
41   JD->Retain();
42   JDAndFlag.store(reinterpret_cast<uintptr_t>(JD.get()));
43 }
44 
45 ResourceTracker::~ResourceTracker() {
46   getJITDylib().getExecutionSession().destroyResourceTracker(*this);
47   getJITDylib().Release();
48 }
49 
50 Error ResourceTracker::remove() {
51   return getJITDylib().getExecutionSession().removeResourceTracker(*this);
52 }
53 
54 void ResourceTracker::transferTo(ResourceTracker &DstRT) {
55   getJITDylib().getExecutionSession().transferResourceTracker(DstRT, *this);
56 }
57 
58 void ResourceTracker::makeDefunct() {
59   uintptr_t Val = JDAndFlag.load();
60   Val |= 0x1U;
61   JDAndFlag.store(Val);
62 }
63 
64 ResourceManager::~ResourceManager() {}
65 
66 ResourceTrackerDefunct::ResourceTrackerDefunct(ResourceTrackerSP RT)
67     : RT(std::move(RT)) {}
68 
69 std::error_code ResourceTrackerDefunct::convertToErrorCode() const {
70   return orcError(OrcErrorCode::UnknownORCError);
71 }
72 
73 void ResourceTrackerDefunct::log(raw_ostream &OS) const {
74   OS << "Resource tracker " << (void *)RT.get() << " became defunct";
75 }
76 
77 FailedToMaterialize::FailedToMaterialize(
78     std::shared_ptr<SymbolDependenceMap> Symbols)
79     : Symbols(std::move(Symbols)) {
80   assert(!this->Symbols->empty() && "Can not fail to resolve an empty set");
81 }
82 
83 std::error_code FailedToMaterialize::convertToErrorCode() const {
84   return orcError(OrcErrorCode::UnknownORCError);
85 }
86 
87 void FailedToMaterialize::log(raw_ostream &OS) const {
88   OS << "Failed to materialize symbols: " << *Symbols;
89 }
90 
91 SymbolsNotFound::SymbolsNotFound(SymbolNameSet Symbols) {
92   for (auto &Sym : Symbols)
93     this->Symbols.push_back(Sym);
94   assert(!this->Symbols.empty() && "Can not fail to resolve an empty set");
95 }
96 
97 SymbolsNotFound::SymbolsNotFound(SymbolNameVector Symbols)
98     : Symbols(std::move(Symbols)) {
99   assert(!this->Symbols.empty() && "Can not fail to resolve an empty set");
100 }
101 
102 std::error_code SymbolsNotFound::convertToErrorCode() const {
103   return orcError(OrcErrorCode::UnknownORCError);
104 }
105 
106 void SymbolsNotFound::log(raw_ostream &OS) const {
107   OS << "Symbols not found: " << Symbols;
108 }
109 
110 SymbolsCouldNotBeRemoved::SymbolsCouldNotBeRemoved(SymbolNameSet Symbols)
111     : Symbols(std::move(Symbols)) {
112   assert(!this->Symbols.empty() && "Can not fail to resolve an empty set");
113 }
114 
115 std::error_code SymbolsCouldNotBeRemoved::convertToErrorCode() const {
116   return orcError(OrcErrorCode::UnknownORCError);
117 }
118 
119 void SymbolsCouldNotBeRemoved::log(raw_ostream &OS) const {
120   OS << "Symbols could not be removed: " << Symbols;
121 }
122 
123 std::error_code MissingSymbolDefinitions::convertToErrorCode() const {
124   return orcError(OrcErrorCode::MissingSymbolDefinitions);
125 }
126 
127 void MissingSymbolDefinitions::log(raw_ostream &OS) const {
128   OS << "Missing definitions in module " << ModuleName
129      << ": " << Symbols;
130 }
131 
132 std::error_code UnexpectedSymbolDefinitions::convertToErrorCode() const {
133   return orcError(OrcErrorCode::UnexpectedSymbolDefinitions);
134 }
135 
136 void UnexpectedSymbolDefinitions::log(raw_ostream &OS) const {
137   OS << "Unexpected definitions in module " << ModuleName
138      << ": " << Symbols;
139 }
140 
141 AsynchronousSymbolQuery::AsynchronousSymbolQuery(
142     const SymbolLookupSet &Symbols, SymbolState RequiredState,
143     SymbolsResolvedCallback NotifyComplete)
144     : NotifyComplete(std::move(NotifyComplete)), RequiredState(RequiredState) {
145   assert(RequiredState >= SymbolState::Resolved &&
146          "Cannot query for a symbols that have not reached the resolve state "
147          "yet");
148 
149   OutstandingSymbolsCount = Symbols.size();
150 
151   for (auto &KV : Symbols)
152     ResolvedSymbols[KV.first] = nullptr;
153 }
154 
155 void AsynchronousSymbolQuery::notifySymbolMetRequiredState(
156     const SymbolStringPtr &Name, JITEvaluatedSymbol Sym) {
157   auto I = ResolvedSymbols.find(Name);
158   assert(I != ResolvedSymbols.end() &&
159          "Resolving symbol outside the requested set");
160   assert(I->second.getAddress() == 0 && "Redundantly resolving symbol Name");
161 
162   // If this is a materialization-side-effects-only symbol then drop it,
163   // otherwise update its map entry with its resolved address.
164   if (Sym.getFlags().hasMaterializationSideEffectsOnly())
165     ResolvedSymbols.erase(I);
166   else
167     I->second = std::move(Sym);
168   --OutstandingSymbolsCount;
169 }
170 
171 void AsynchronousSymbolQuery::handleComplete() {
172   assert(OutstandingSymbolsCount == 0 &&
173          "Symbols remain, handleComplete called prematurely");
174 
175   auto TmpNotifyComplete = std::move(NotifyComplete);
176   NotifyComplete = SymbolsResolvedCallback();
177   TmpNotifyComplete(std::move(ResolvedSymbols));
178 }
179 
180 void AsynchronousSymbolQuery::handleFailed(Error Err) {
181   assert(QueryRegistrations.empty() && ResolvedSymbols.empty() &&
182          OutstandingSymbolsCount == 0 &&
183          "Query should already have been abandoned");
184   NotifyComplete(std::move(Err));
185   NotifyComplete = SymbolsResolvedCallback();
186 }
187 
188 void AsynchronousSymbolQuery::addQueryDependence(JITDylib &JD,
189                                                  SymbolStringPtr Name) {
190   bool Added = QueryRegistrations[&JD].insert(std::move(Name)).second;
191   (void)Added;
192   assert(Added && "Duplicate dependence notification?");
193 }
194 
195 void AsynchronousSymbolQuery::removeQueryDependence(
196     JITDylib &JD, const SymbolStringPtr &Name) {
197   auto QRI = QueryRegistrations.find(&JD);
198   assert(QRI != QueryRegistrations.end() &&
199          "No dependencies registered for JD");
200   assert(QRI->second.count(Name) && "No dependency on Name in JD");
201   QRI->second.erase(Name);
202   if (QRI->second.empty())
203     QueryRegistrations.erase(QRI);
204 }
205 
206 void AsynchronousSymbolQuery::dropSymbol(const SymbolStringPtr &Name) {
207   auto I = ResolvedSymbols.find(Name);
208   assert(I != ResolvedSymbols.end() &&
209          "Redundant removal of weakly-referenced symbol");
210   ResolvedSymbols.erase(I);
211   --OutstandingSymbolsCount;
212 }
213 
214 void AsynchronousSymbolQuery::detach() {
215   ResolvedSymbols.clear();
216   OutstandingSymbolsCount = 0;
217   for (auto &KV : QueryRegistrations)
218     KV.first->detachQueryHelper(*this, KV.second);
219   QueryRegistrations.clear();
220 }
221 
222 AbsoluteSymbolsMaterializationUnit::AbsoluteSymbolsMaterializationUnit(
223     SymbolMap Symbols)
224     : MaterializationUnit(extractFlags(Symbols), nullptr),
225       Symbols(std::move(Symbols)) {}
226 
227 StringRef AbsoluteSymbolsMaterializationUnit::getName() const {
228   return "<Absolute Symbols>";
229 }
230 
231 void AbsoluteSymbolsMaterializationUnit::materialize(
232     std::unique_ptr<MaterializationResponsibility> R) {
233   // No dependencies, so these calls can't fail.
234   cantFail(R->notifyResolved(Symbols));
235   cantFail(R->notifyEmitted());
236 }
237 
238 void AbsoluteSymbolsMaterializationUnit::discard(const JITDylib &JD,
239                                                  const SymbolStringPtr &Name) {
240   assert(Symbols.count(Name) && "Symbol is not part of this MU");
241   Symbols.erase(Name);
242 }
243 
244 SymbolFlagsMap
245 AbsoluteSymbolsMaterializationUnit::extractFlags(const SymbolMap &Symbols) {
246   SymbolFlagsMap Flags;
247   for (const auto &KV : Symbols)
248     Flags[KV.first] = KV.second.getFlags();
249   return Flags;
250 }
251 
252 ReExportsMaterializationUnit::ReExportsMaterializationUnit(
253     JITDylib *SourceJD, JITDylibLookupFlags SourceJDLookupFlags,
254     SymbolAliasMap Aliases)
255     : MaterializationUnit(extractFlags(Aliases), nullptr), SourceJD(SourceJD),
256       SourceJDLookupFlags(SourceJDLookupFlags), Aliases(std::move(Aliases)) {}
257 
258 StringRef ReExportsMaterializationUnit::getName() const {
259   return "<Reexports>";
260 }
261 
262 void ReExportsMaterializationUnit::materialize(
263     std::unique_ptr<MaterializationResponsibility> R) {
264 
265   auto &ES = R->getTargetJITDylib().getExecutionSession();
266   JITDylib &TgtJD = R->getTargetJITDylib();
267   JITDylib &SrcJD = SourceJD ? *SourceJD : TgtJD;
268 
269   // Find the set of requested aliases and aliasees. Return any unrequested
270   // aliases back to the JITDylib so as to not prematurely materialize any
271   // aliasees.
272   auto RequestedSymbols = R->getRequestedSymbols();
273   SymbolAliasMap RequestedAliases;
274 
275   for (auto &Name : RequestedSymbols) {
276     auto I = Aliases.find(Name);
277     assert(I != Aliases.end() && "Symbol not found in aliases map?");
278     RequestedAliases[Name] = std::move(I->second);
279     Aliases.erase(I);
280   }
281 
282   LLVM_DEBUG({
283     ES.runSessionLocked([&]() {
284       dbgs() << "materializing reexports: target = " << TgtJD.getName()
285              << ", source = " << SrcJD.getName() << " " << RequestedAliases
286              << "\n";
287     });
288   });
289 
290   if (!Aliases.empty()) {
291     auto Err = SourceJD ? R->replace(reexports(*SourceJD, std::move(Aliases),
292                                                SourceJDLookupFlags))
293                         : R->replace(symbolAliases(std::move(Aliases)));
294 
295     if (Err) {
296       // FIXME: Should this be reported / treated as failure to materialize?
297       // Or should this be treated as a sanctioned bailing-out?
298       ES.reportError(std::move(Err));
299       R->failMaterialization();
300       return;
301     }
302   }
303 
304   // The OnResolveInfo struct will hold the aliases and responsibilty for each
305   // query in the list.
306   struct OnResolveInfo {
307     OnResolveInfo(std::unique_ptr<MaterializationResponsibility> R,
308                   SymbolAliasMap Aliases)
309         : R(std::move(R)), Aliases(std::move(Aliases)) {}
310 
311     std::unique_ptr<MaterializationResponsibility> R;
312     SymbolAliasMap Aliases;
313   };
314 
315   // Build a list of queries to issue. In each round we build a query for the
316   // largest set of aliases that we can resolve without encountering a chain of
317   // aliases (e.g. Foo -> Bar, Bar -> Baz). Such a chain would deadlock as the
318   // query would be waiting on a symbol that it itself had to resolve. Creating
319   // a new query for each link in such a chain eliminates the possibility of
320   // deadlock. In practice chains are likely to be rare, and this algorithm will
321   // usually result in a single query to issue.
322 
323   std::vector<std::pair<SymbolLookupSet, std::shared_ptr<OnResolveInfo>>>
324       QueryInfos;
325   while (!RequestedAliases.empty()) {
326     SymbolNameSet ResponsibilitySymbols;
327     SymbolLookupSet QuerySymbols;
328     SymbolAliasMap QueryAliases;
329 
330     // Collect as many aliases as we can without including a chain.
331     for (auto &KV : RequestedAliases) {
332       // Chain detected. Skip this symbol for this round.
333       if (&SrcJD == &TgtJD && (QueryAliases.count(KV.second.Aliasee) ||
334                                RequestedAliases.count(KV.second.Aliasee)))
335         continue;
336 
337       ResponsibilitySymbols.insert(KV.first);
338       QuerySymbols.add(KV.second.Aliasee,
339                        KV.second.AliasFlags.hasMaterializationSideEffectsOnly()
340                            ? SymbolLookupFlags::WeaklyReferencedSymbol
341                            : SymbolLookupFlags::RequiredSymbol);
342       QueryAliases[KV.first] = std::move(KV.second);
343     }
344 
345     // Remove the aliases collected this round from the RequestedAliases map.
346     for (auto &KV : QueryAliases)
347       RequestedAliases.erase(KV.first);
348 
349     assert(!QuerySymbols.empty() && "Alias cycle detected!");
350 
351     auto NewR = R->delegate(ResponsibilitySymbols);
352     if (!NewR) {
353       ES.reportError(NewR.takeError());
354       R->failMaterialization();
355       return;
356     }
357 
358     auto QueryInfo = std::make_shared<OnResolveInfo>(std::move(*NewR),
359                                                      std::move(QueryAliases));
360     QueryInfos.push_back(
361         make_pair(std::move(QuerySymbols), std::move(QueryInfo)));
362   }
363 
364   // Issue the queries.
365   while (!QueryInfos.empty()) {
366     auto QuerySymbols = std::move(QueryInfos.back().first);
367     auto QueryInfo = std::move(QueryInfos.back().second);
368 
369     QueryInfos.pop_back();
370 
371     auto RegisterDependencies = [QueryInfo,
372                                  &SrcJD](const SymbolDependenceMap &Deps) {
373       // If there were no materializing symbols, just bail out.
374       if (Deps.empty())
375         return;
376 
377       // Otherwise the only deps should be on SrcJD.
378       assert(Deps.size() == 1 && Deps.count(&SrcJD) &&
379              "Unexpected dependencies for reexports");
380 
381       auto &SrcJDDeps = Deps.find(&SrcJD)->second;
382       SymbolDependenceMap PerAliasDepsMap;
383       auto &PerAliasDeps = PerAliasDepsMap[&SrcJD];
384 
385       for (auto &KV : QueryInfo->Aliases)
386         if (SrcJDDeps.count(KV.second.Aliasee)) {
387           PerAliasDeps = {KV.second.Aliasee};
388           QueryInfo->R->addDependencies(KV.first, PerAliasDepsMap);
389         }
390     };
391 
392     auto OnComplete = [QueryInfo](Expected<SymbolMap> Result) {
393       auto &ES = QueryInfo->R->getTargetJITDylib().getExecutionSession();
394       if (Result) {
395         SymbolMap ResolutionMap;
396         for (auto &KV : QueryInfo->Aliases) {
397           assert((KV.second.AliasFlags.hasMaterializationSideEffectsOnly() ||
398                   Result->count(KV.second.Aliasee)) &&
399                  "Result map missing entry?");
400           // Don't try to resolve materialization-side-effects-only symbols.
401           if (KV.second.AliasFlags.hasMaterializationSideEffectsOnly())
402             continue;
403 
404           ResolutionMap[KV.first] = JITEvaluatedSymbol(
405               (*Result)[KV.second.Aliasee].getAddress(), KV.second.AliasFlags);
406         }
407         if (auto Err = QueryInfo->R->notifyResolved(ResolutionMap)) {
408           ES.reportError(std::move(Err));
409           QueryInfo->R->failMaterialization();
410           return;
411         }
412         if (auto Err = QueryInfo->R->notifyEmitted()) {
413           ES.reportError(std::move(Err));
414           QueryInfo->R->failMaterialization();
415           return;
416         }
417       } else {
418         ES.reportError(Result.takeError());
419         QueryInfo->R->failMaterialization();
420       }
421     };
422 
423     ES.lookup(LookupKind::Static,
424               JITDylibSearchOrder({{&SrcJD, SourceJDLookupFlags}}),
425               QuerySymbols, SymbolState::Resolved, std::move(OnComplete),
426               std::move(RegisterDependencies));
427   }
428 }
429 
430 void ReExportsMaterializationUnit::discard(const JITDylib &JD,
431                                            const SymbolStringPtr &Name) {
432   assert(Aliases.count(Name) &&
433          "Symbol not covered by this MaterializationUnit");
434   Aliases.erase(Name);
435 }
436 
437 SymbolFlagsMap
438 ReExportsMaterializationUnit::extractFlags(const SymbolAliasMap &Aliases) {
439   SymbolFlagsMap SymbolFlags;
440   for (auto &KV : Aliases)
441     SymbolFlags[KV.first] = KV.second.AliasFlags;
442 
443   return SymbolFlags;
444 }
445 
446 Expected<SymbolAliasMap> buildSimpleReexportsAliasMap(JITDylib &SourceJD,
447                                                       SymbolNameSet Symbols) {
448   SymbolLookupSet LookupSet(Symbols);
449   auto Flags = SourceJD.getExecutionSession().lookupFlags(
450       LookupKind::Static, {{&SourceJD, JITDylibLookupFlags::MatchAllSymbols}},
451       SymbolLookupSet(std::move(Symbols)));
452 
453   if (!Flags)
454     return Flags.takeError();
455 
456   SymbolAliasMap Result;
457   for (auto &Name : Symbols) {
458     assert(Flags->count(Name) && "Missing entry in flags map");
459     Result[Name] = SymbolAliasMapEntry(Name, (*Flags)[Name]);
460   }
461 
462   return Result;
463 }
464 
465 class InProgressLookupState {
466 public:
467   InProgressLookupState(LookupKind K, JITDylibSearchOrder SearchOrder,
468                         SymbolLookupSet LookupSet, SymbolState RequiredState)
469       : K(K), SearchOrder(std::move(SearchOrder)),
470         LookupSet(std::move(LookupSet)), RequiredState(RequiredState) {
471     DefGeneratorCandidates = this->LookupSet;
472   }
473   virtual ~InProgressLookupState() {}
474   virtual void complete(std::unique_ptr<InProgressLookupState> IPLS) = 0;
475   virtual void fail(Error Err) = 0;
476 
477   LookupKind K;
478   JITDylibSearchOrder SearchOrder;
479   SymbolLookupSet LookupSet;
480   SymbolState RequiredState;
481 
482   std::unique_lock<std::mutex> GeneratorLock;
483   size_t CurSearchOrderIndex = 0;
484   bool NewJITDylib = true;
485   SymbolLookupSet DefGeneratorCandidates;
486   SymbolLookupSet DefGeneratorNonCandidates;
487   std::vector<std::weak_ptr<DefinitionGenerator>> CurDefGeneratorStack;
488 };
489 
490 class InProgressLookupFlagsState : public InProgressLookupState {
491 public:
492   InProgressLookupFlagsState(
493       LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet LookupSet,
494       unique_function<void(Expected<SymbolFlagsMap>)> OnComplete)
495       : InProgressLookupState(K, std::move(SearchOrder), std::move(LookupSet),
496                               SymbolState::NeverSearched),
497         OnComplete(std::move(OnComplete)) {}
498 
499   void complete(std::unique_ptr<InProgressLookupState> IPLS) override {
500     GeneratorLock = {}; // Unlock and release.
501     auto &ES = SearchOrder.front().first->getExecutionSession();
502     ES.OL_completeLookupFlags(std::move(IPLS), std::move(OnComplete));
503   }
504 
505   void fail(Error Err) override {
506     GeneratorLock = {}; // Unlock and release.
507     OnComplete(std::move(Err));
508   }
509 
510 private:
511   unique_function<void(Expected<SymbolFlagsMap>)> OnComplete;
512 };
513 
514 class InProgressFullLookupState : public InProgressLookupState {
515 public:
516   InProgressFullLookupState(LookupKind K, JITDylibSearchOrder SearchOrder,
517                             SymbolLookupSet LookupSet,
518                             SymbolState RequiredState,
519                             std::shared_ptr<AsynchronousSymbolQuery> Q,
520                             RegisterDependenciesFunction RegisterDependencies)
521       : InProgressLookupState(K, std::move(SearchOrder), std::move(LookupSet),
522                               RequiredState),
523         Q(std::move(Q)), RegisterDependencies(std::move(RegisterDependencies)) {
524   }
525 
526   void complete(std::unique_ptr<InProgressLookupState> IPLS) override {
527     GeneratorLock = {}; // Unlock and release.
528     auto &ES = SearchOrder.front().first->getExecutionSession();
529     ES.OL_completeLookup(std::move(IPLS), std::move(Q),
530                          std::move(RegisterDependencies));
531   }
532 
533   void fail(Error Err) override {
534     GeneratorLock = {};
535     Q->detach();
536     Q->handleFailed(std::move(Err));
537   }
538 
539 private:
540   std::shared_ptr<AsynchronousSymbolQuery> Q;
541   RegisterDependenciesFunction RegisterDependencies;
542 };
543 
544 ReexportsGenerator::ReexportsGenerator(JITDylib &SourceJD,
545                                        JITDylibLookupFlags SourceJDLookupFlags,
546                                        SymbolPredicate Allow)
547     : SourceJD(SourceJD), SourceJDLookupFlags(SourceJDLookupFlags),
548       Allow(std::move(Allow)) {}
549 
550 Error ReexportsGenerator::tryToGenerate(LookupState &LS, LookupKind K,
551                                         JITDylib &JD,
552                                         JITDylibLookupFlags JDLookupFlags,
553                                         const SymbolLookupSet &LookupSet) {
554   assert(&JD != &SourceJD && "Cannot re-export from the same dylib");
555 
556   // Use lookupFlags to find the subset of symbols that match our lookup.
557   auto Flags = JD.getExecutionSession().lookupFlags(
558       K, {{&SourceJD, JDLookupFlags}}, LookupSet);
559   if (!Flags)
560     return Flags.takeError();
561 
562   // Create an alias map.
563   orc::SymbolAliasMap AliasMap;
564   for (auto &KV : *Flags)
565     if (!Allow || Allow(KV.first))
566       AliasMap[KV.first] = SymbolAliasMapEntry(KV.first, KV.second);
567 
568   if (AliasMap.empty())
569     return Error::success();
570 
571   // Define the re-exports.
572   return JD.define(reexports(SourceJD, AliasMap, SourceJDLookupFlags));
573 }
574 
575 LookupState::LookupState(std::unique_ptr<InProgressLookupState> IPLS)
576     : IPLS(std::move(IPLS)) {}
577 
578 void LookupState::reset(InProgressLookupState *IPLS) { this->IPLS.reset(IPLS); }
579 
580 LookupState::~LookupState() {}
581 
582 void LookupState::continueLookup(Error Err) {
583   assert(IPLS && "Cannot call continueLookup on empty LookupState");
584   auto &ES = IPLS->SearchOrder.begin()->first->getExecutionSession();
585   ES.OL_applyQueryPhase1(std::move(IPLS), std::move(Err));
586 }
587 
588 DefinitionGenerator::~DefinitionGenerator() {}
589 
590 Error JITDylib::clear() {
591   std::vector<ResourceTrackerSP> TrackersToRemove;
592   ES.runSessionLocked([&]() {
593     for (auto &KV : TrackerSymbols)
594       TrackersToRemove.push_back(KV.first);
595     TrackersToRemove.push_back(getDefaultResourceTracker());
596   });
597 
598   Error Err = Error::success();
599   for (auto &RT : TrackersToRemove)
600     Err = joinErrors(std::move(Err), RT->remove());
601   return Err;
602 }
603 
604 ResourceTrackerSP JITDylib::getDefaultResourceTracker() {
605   return ES.runSessionLocked([this] {
606     if (!DefaultTracker)
607       DefaultTracker = new ResourceTracker(this);
608     return DefaultTracker;
609   });
610 }
611 
612 ResourceTrackerSP JITDylib::createResourceTracker() {
613   return ES.runSessionLocked([this] {
614     ResourceTrackerSP RT = new ResourceTracker(this);
615     return RT;
616   });
617 }
618 
619 void JITDylib::removeGenerator(DefinitionGenerator &G) {
620   std::lock_guard<std::mutex> Lock(GeneratorsMutex);
621   auto I = llvm::find_if(DefGenerators,
622                          [&](const std::shared_ptr<DefinitionGenerator> &H) {
623                            return H.get() == &G;
624                          });
625   assert(I != DefGenerators.end() && "Generator not found");
626   DefGenerators.erase(I);
627 }
628 
629 Expected<SymbolFlagsMap>
630 JITDylib::defineMaterializing(SymbolFlagsMap SymbolFlags) {
631 
632   return ES.runSessionLocked([&]() -> Expected<SymbolFlagsMap> {
633     std::vector<SymbolTable::iterator> AddedSyms;
634     std::vector<SymbolFlagsMap::iterator> RejectedWeakDefs;
635 
636     for (auto SFItr = SymbolFlags.begin(), SFEnd = SymbolFlags.end();
637          SFItr != SFEnd; ++SFItr) {
638 
639       auto &Name = SFItr->first;
640       auto &Flags = SFItr->second;
641 
642       auto EntryItr = Symbols.find(Name);
643 
644       // If the entry already exists...
645       if (EntryItr != Symbols.end()) {
646 
647         // If this is a strong definition then error out.
648         if (!Flags.isWeak()) {
649           // Remove any symbols already added.
650           for (auto &SI : AddedSyms)
651             Symbols.erase(SI);
652 
653           // FIXME: Return all duplicates.
654           return make_error<DuplicateDefinition>(std::string(*Name));
655         }
656 
657         // Otherwise just make a note to discard this symbol after the loop.
658         RejectedWeakDefs.push_back(SFItr);
659         continue;
660       } else
661         EntryItr =
662           Symbols.insert(std::make_pair(Name, SymbolTableEntry(Flags))).first;
663 
664       AddedSyms.push_back(EntryItr);
665       EntryItr->second.setState(SymbolState::Materializing);
666     }
667 
668     // Remove any rejected weak definitions from the SymbolFlags map.
669     while (!RejectedWeakDefs.empty()) {
670       SymbolFlags.erase(RejectedWeakDefs.back());
671       RejectedWeakDefs.pop_back();
672     }
673 
674     return SymbolFlags;
675   });
676 }
677 
678 Error JITDylib::replace(MaterializationResponsibility &FromMR,
679                         std::unique_ptr<MaterializationUnit> MU) {
680   assert(MU != nullptr && "Can not replace with a null MaterializationUnit");
681   std::unique_ptr<MaterializationUnit> MustRunMU;
682   std::unique_ptr<MaterializationResponsibility> MustRunMR;
683 
684   auto Err =
685       ES.runSessionLocked([&, this]() -> Error {
686         auto RT = getTracker(FromMR);
687 
688         if (RT->isDefunct())
689           return make_error<ResourceTrackerDefunct>(std::move(RT));
690 
691 #ifndef NDEBUG
692         for (auto &KV : MU->getSymbols()) {
693           auto SymI = Symbols.find(KV.first);
694           assert(SymI != Symbols.end() && "Replacing unknown symbol");
695           assert(SymI->second.getState() == SymbolState::Materializing &&
696                  "Can not replace a symbol that ha is not materializing");
697           assert(!SymI->second.hasMaterializerAttached() &&
698                  "Symbol should not have materializer attached already");
699           assert(UnmaterializedInfos.count(KV.first) == 0 &&
700                  "Symbol being replaced should have no UnmaterializedInfo");
701         }
702 #endif // NDEBUG
703 
704         // If the tracker is defunct we need to bail out immediately.
705 
706         // If any symbol has pending queries against it then we need to
707         // materialize MU immediately.
708         for (auto &KV : MU->getSymbols()) {
709           auto MII = MaterializingInfos.find(KV.first);
710           if (MII != MaterializingInfos.end()) {
711             if (MII->second.hasQueriesPending()) {
712               MustRunMR = ES.createMaterializationResponsibility(
713                   *RT, std::move(MU->SymbolFlags), std::move(MU->InitSymbol));
714               MustRunMU = std::move(MU);
715               return Error::success();
716             }
717           }
718         }
719 
720         // Otherwise, make MU responsible for all the symbols.
721         auto RTI = MRTrackers.find(&FromMR);
722         assert(RTI != MRTrackers.end() && "No tracker for FromMR");
723         auto UMI =
724             std::make_shared<UnmaterializedInfo>(std::move(MU), RTI->second);
725         for (auto &KV : UMI->MU->getSymbols()) {
726           auto SymI = Symbols.find(KV.first);
727           assert(SymI->second.getState() == SymbolState::Materializing &&
728                  "Can not replace a symbol that is not materializing");
729           assert(!SymI->second.hasMaterializerAttached() &&
730                  "Can not replace a symbol that has a materializer attached");
731           assert(UnmaterializedInfos.count(KV.first) == 0 &&
732                  "Unexpected materializer entry in map");
733           SymI->second.setAddress(SymI->second.getAddress());
734           SymI->second.setMaterializerAttached(true);
735 
736           auto &UMIEntry = UnmaterializedInfos[KV.first];
737           assert((!UMIEntry || !UMIEntry->MU) &&
738                  "Replacing symbol with materializer still attached");
739           UMIEntry = UMI;
740         }
741 
742         return Error::success();
743       });
744 
745   if (Err)
746     return Err;
747 
748   if (MustRunMU) {
749     assert(MustRunMR && "MustRunMU set implies MustRunMR set");
750     ES.dispatchMaterialization(std::move(MustRunMU), std::move(MustRunMR));
751   } else {
752     assert(!MustRunMR && "MustRunMU unset implies MustRunMR unset");
753   }
754 
755   return Error::success();
756 }
757 
758 Expected<std::unique_ptr<MaterializationResponsibility>>
759 JITDylib::delegate(MaterializationResponsibility &FromMR,
760                    SymbolFlagsMap SymbolFlags, SymbolStringPtr InitSymbol) {
761 
762   return ES.runSessionLocked(
763       [&]() -> Expected<std::unique_ptr<MaterializationResponsibility>> {
764         auto RT = getTracker(FromMR);
765 
766         if (RT->isDefunct())
767           return make_error<ResourceTrackerDefunct>(std::move(RT));
768 
769         return ES.createMaterializationResponsibility(
770             *RT, std::move(SymbolFlags), std::move(InitSymbol));
771       });
772 }
773 
774 SymbolNameSet
775 JITDylib::getRequestedSymbols(const SymbolFlagsMap &SymbolFlags) const {
776   return ES.runSessionLocked([&]() {
777     SymbolNameSet RequestedSymbols;
778 
779     for (auto &KV : SymbolFlags) {
780       assert(Symbols.count(KV.first) && "JITDylib does not cover this symbol?");
781       assert(Symbols.find(KV.first)->second.getState() !=
782                  SymbolState::NeverSearched &&
783              Symbols.find(KV.first)->second.getState() != SymbolState::Ready &&
784              "getRequestedSymbols can only be called for symbols that have "
785              "started materializing");
786       auto I = MaterializingInfos.find(KV.first);
787       if (I == MaterializingInfos.end())
788         continue;
789 
790       if (I->second.hasQueriesPending())
791         RequestedSymbols.insert(KV.first);
792     }
793 
794     return RequestedSymbols;
795   });
796 }
797 
798 void JITDylib::addDependencies(const SymbolStringPtr &Name,
799                                const SymbolDependenceMap &Dependencies) {
800   assert(Symbols.count(Name) && "Name not in symbol table");
801   assert(Symbols[Name].getState() < SymbolState::Emitted &&
802          "Can not add dependencies for a symbol that is not materializing");
803 
804   LLVM_DEBUG({
805       dbgs() << "In " << getName() << " adding dependencies for "
806              << *Name << ": " << Dependencies << "\n";
807     });
808 
809   // If Name is already in an error state then just bail out.
810   if (Symbols[Name].getFlags().hasError())
811     return;
812 
813   auto &MI = MaterializingInfos[Name];
814   assert(Symbols[Name].getState() != SymbolState::Emitted &&
815          "Can not add dependencies to an emitted symbol");
816 
817   bool DependsOnSymbolInErrorState = false;
818 
819   // Register dependencies, record whether any depenendency is in the error
820   // state.
821   for (auto &KV : Dependencies) {
822     assert(KV.first && "Null JITDylib in dependency?");
823     auto &OtherJITDylib = *KV.first;
824     auto &DepsOnOtherJITDylib = MI.UnemittedDependencies[&OtherJITDylib];
825 
826     for (auto &OtherSymbol : KV.second) {
827 
828       // Check the sym entry for the dependency.
829       auto OtherSymI = OtherJITDylib.Symbols.find(OtherSymbol);
830 
831       // Assert that this symbol exists and has not reached the ready state
832       // already.
833       assert(OtherSymI != OtherJITDylib.Symbols.end() &&
834              "Dependency on unknown symbol");
835 
836       auto &OtherSymEntry = OtherSymI->second;
837 
838       // If the other symbol is already in the Ready state then there's no
839       // dependency to add.
840       if (OtherSymEntry.getState() == SymbolState::Ready)
841         continue;
842 
843       // If the dependency is in an error state then note this and continue,
844       // we will move this symbol to the error state below.
845       if (OtherSymEntry.getFlags().hasError()) {
846         DependsOnSymbolInErrorState = true;
847         continue;
848       }
849 
850       // If the dependency was not in the error state then add it to
851       // our list of dependencies.
852       auto &OtherMI = OtherJITDylib.MaterializingInfos[OtherSymbol];
853 
854       if (OtherSymEntry.getState() == SymbolState::Emitted)
855         transferEmittedNodeDependencies(MI, Name, OtherMI);
856       else if (&OtherJITDylib != this || OtherSymbol != Name) {
857         OtherMI.Dependants[this].insert(Name);
858         DepsOnOtherJITDylib.insert(OtherSymbol);
859       }
860     }
861 
862     if (DepsOnOtherJITDylib.empty())
863       MI.UnemittedDependencies.erase(&OtherJITDylib);
864   }
865 
866   // If this symbol dependended on any symbols in the error state then move
867   // this symbol to the error state too.
868   if (DependsOnSymbolInErrorState)
869     Symbols[Name].setFlags(Symbols[Name].getFlags() | JITSymbolFlags::HasError);
870 }
871 
872 Error JITDylib::resolve(MaterializationResponsibility &MR,
873                         const SymbolMap &Resolved) {
874   AsynchronousSymbolQuerySet CompletedQueries;
875 
876   if (auto Err = ES.runSessionLocked([&, this]() -> Error {
877         auto RTI = MRTrackers.find(&MR);
878         assert(RTI != MRTrackers.end() && "No resource tracker for MR?");
879         if (RTI->second->isDefunct())
880           return make_error<ResourceTrackerDefunct>(RTI->second);
881 
882         struct WorklistEntry {
883           SymbolTable::iterator SymI;
884           JITEvaluatedSymbol ResolvedSym;
885         };
886 
887         SymbolNameSet SymbolsInErrorState;
888         std::vector<WorklistEntry> Worklist;
889         Worklist.reserve(Resolved.size());
890 
891         // Build worklist and check for any symbols in the error state.
892         for (const auto &KV : Resolved) {
893 
894           assert(!KV.second.getFlags().hasError() &&
895                  "Resolution result can not have error flag set");
896 
897           auto SymI = Symbols.find(KV.first);
898 
899           assert(SymI != Symbols.end() && "Symbol not found");
900           assert(!SymI->second.hasMaterializerAttached() &&
901                  "Resolving symbol with materializer attached?");
902           assert(SymI->second.getState() == SymbolState::Materializing &&
903                  "Symbol should be materializing");
904           assert(SymI->second.getAddress() == 0 &&
905                  "Symbol has already been resolved");
906 
907           if (SymI->second.getFlags().hasError())
908             SymbolsInErrorState.insert(KV.first);
909           else {
910             auto Flags = KV.second.getFlags();
911             Flags &= ~(JITSymbolFlags::Weak | JITSymbolFlags::Common);
912             assert(Flags ==
913                        (SymI->second.getFlags() &
914                         ~(JITSymbolFlags::Weak | JITSymbolFlags::Common)) &&
915                    "Resolved flags should match the declared flags");
916 
917             Worklist.push_back(
918                 {SymI, JITEvaluatedSymbol(KV.second.getAddress(), Flags)});
919           }
920         }
921 
922         // If any symbols were in the error state then bail out.
923         if (!SymbolsInErrorState.empty()) {
924           auto FailedSymbolsDepMap = std::make_shared<SymbolDependenceMap>();
925           (*FailedSymbolsDepMap)[this] = std::move(SymbolsInErrorState);
926           return make_error<FailedToMaterialize>(
927               std::move(FailedSymbolsDepMap));
928         }
929 
930         while (!Worklist.empty()) {
931           auto SymI = Worklist.back().SymI;
932           auto ResolvedSym = Worklist.back().ResolvedSym;
933           Worklist.pop_back();
934 
935           auto &Name = SymI->first;
936 
937           // Resolved symbols can not be weak: discard the weak flag.
938           JITSymbolFlags ResolvedFlags = ResolvedSym.getFlags();
939           SymI->second.setAddress(ResolvedSym.getAddress());
940           SymI->second.setFlags(ResolvedFlags);
941           SymI->second.setState(SymbolState::Resolved);
942 
943           auto MII = MaterializingInfos.find(Name);
944           if (MII == MaterializingInfos.end())
945             continue;
946 
947           auto &MI = MII->second;
948           for (auto &Q : MI.takeQueriesMeeting(SymbolState::Resolved)) {
949             Q->notifySymbolMetRequiredState(Name, ResolvedSym);
950             Q->removeQueryDependence(*this, Name);
951             if (Q->isComplete())
952               CompletedQueries.insert(std::move(Q));
953           }
954         }
955 
956         return Error::success();
957       }))
958     return Err;
959 
960   // Otherwise notify all the completed queries.
961   for (auto &Q : CompletedQueries) {
962     assert(Q->isComplete() && "Q not completed");
963     Q->handleComplete();
964   }
965 
966   return Error::success();
967 }
968 
969 Error JITDylib::emit(MaterializationResponsibility &MR,
970                      const SymbolFlagsMap &Emitted) {
971   AsynchronousSymbolQuerySet CompletedQueries;
972   DenseMap<JITDylib *, SymbolNameVector> ReadySymbols;
973 
974   if (auto Err = ES.runSessionLocked([&, this]() -> Error {
975         auto RTI = MRTrackers.find(&MR);
976         assert(RTI != MRTrackers.end() && "No resource tracker for MR?");
977         if (RTI->second->isDefunct())
978           return make_error<ResourceTrackerDefunct>(RTI->second);
979 
980         SymbolNameSet SymbolsInErrorState;
981         std::vector<SymbolTable::iterator> Worklist;
982 
983         // Scan to build worklist, record any symbols in the erorr state.
984         for (const auto &KV : Emitted) {
985           auto &Name = KV.first;
986 
987           auto SymI = Symbols.find(Name);
988           assert(SymI != Symbols.end() && "No symbol table entry for Name");
989 
990           if (SymI->second.getFlags().hasError())
991             SymbolsInErrorState.insert(Name);
992           else
993             Worklist.push_back(SymI);
994         }
995 
996         // If any symbols were in the error state then bail out.
997         if (!SymbolsInErrorState.empty()) {
998           auto FailedSymbolsDepMap = std::make_shared<SymbolDependenceMap>();
999           (*FailedSymbolsDepMap)[this] = std::move(SymbolsInErrorState);
1000           return make_error<FailedToMaterialize>(
1001               std::move(FailedSymbolsDepMap));
1002         }
1003 
1004         // Otherwise update dependencies and move to the emitted state.
1005         while (!Worklist.empty()) {
1006           auto SymI = Worklist.back();
1007           Worklist.pop_back();
1008 
1009           auto &Name = SymI->first;
1010           auto &SymEntry = SymI->second;
1011 
1012           // Move symbol to the emitted state.
1013           assert(((SymEntry.getFlags().hasMaterializationSideEffectsOnly() &&
1014                    SymEntry.getState() == SymbolState::Materializing) ||
1015                   SymEntry.getState() == SymbolState::Resolved) &&
1016                  "Emitting from state other than Resolved");
1017           SymEntry.setState(SymbolState::Emitted);
1018 
1019           auto MII = MaterializingInfos.find(Name);
1020 
1021           // If this symbol has no MaterializingInfo then it's trivially ready.
1022           // Update its state and continue.
1023           if (MII == MaterializingInfos.end()) {
1024             SymEntry.setState(SymbolState::Ready);
1025             continue;
1026           }
1027 
1028           auto &MI = MII->second;
1029 
1030           // For each dependant, transfer this node's emitted dependencies to
1031           // it. If the dependant node is ready (i.e. has no unemitted
1032           // dependencies) then notify any pending queries.
1033           for (auto &KV : MI.Dependants) {
1034             auto &DependantJD = *KV.first;
1035             auto &DependantJDReadySymbols = ReadySymbols[&DependantJD];
1036             for (auto &DependantName : KV.second) {
1037               auto DependantMII =
1038                   DependantJD.MaterializingInfos.find(DependantName);
1039               assert(DependantMII != DependantJD.MaterializingInfos.end() &&
1040                      "Dependant should have MaterializingInfo");
1041 
1042               auto &DependantMI = DependantMII->second;
1043 
1044               // Remove the dependant's dependency on this node.
1045               assert(DependantMI.UnemittedDependencies.count(this) &&
1046                      "Dependant does not have an unemitted dependencies record "
1047                      "for "
1048                      "this JITDylib");
1049               assert(DependantMI.UnemittedDependencies[this].count(Name) &&
1050                      "Dependant does not count this symbol as a dependency?");
1051 
1052               DependantMI.UnemittedDependencies[this].erase(Name);
1053               if (DependantMI.UnemittedDependencies[this].empty())
1054                 DependantMI.UnemittedDependencies.erase(this);
1055 
1056               // Transfer unemitted dependencies from this node to the
1057               // dependant.
1058               DependantJD.transferEmittedNodeDependencies(DependantMI,
1059                                                           DependantName, MI);
1060 
1061               auto DependantSymI = DependantJD.Symbols.find(DependantName);
1062               assert(DependantSymI != DependantJD.Symbols.end() &&
1063                      "Dependant has no entry in the Symbols table");
1064               auto &DependantSymEntry = DependantSymI->second;
1065 
1066               // If the dependant is emitted and this node was the last of its
1067               // unemitted dependencies then the dependant node is now ready, so
1068               // notify any pending queries on the dependant node.
1069               if (DependantSymEntry.getState() == SymbolState::Emitted &&
1070                   DependantMI.UnemittedDependencies.empty()) {
1071                 assert(DependantMI.Dependants.empty() &&
1072                        "Dependants should be empty by now");
1073 
1074                 // Since this dependant is now ready, we erase its
1075                 // MaterializingInfo and update its materializing state.
1076                 DependantSymEntry.setState(SymbolState::Ready);
1077                 DependantJDReadySymbols.push_back(DependantName);
1078 
1079                 for (auto &Q :
1080                      DependantMI.takeQueriesMeeting(SymbolState::Ready)) {
1081                   Q->notifySymbolMetRequiredState(
1082                       DependantName, DependantSymI->second.getSymbol());
1083                   if (Q->isComplete())
1084                     CompletedQueries.insert(Q);
1085                   Q->removeQueryDependence(DependantJD, DependantName);
1086                 }
1087               }
1088             }
1089           }
1090 
1091           auto &ThisJDReadySymbols = ReadySymbols[this];
1092           MI.Dependants.clear();
1093           if (MI.UnemittedDependencies.empty()) {
1094             SymI->second.setState(SymbolState::Ready);
1095             ThisJDReadySymbols.push_back(Name);
1096             for (auto &Q : MI.takeQueriesMeeting(SymbolState::Ready)) {
1097               Q->notifySymbolMetRequiredState(Name, SymI->second.getSymbol());
1098               if (Q->isComplete())
1099                 CompletedQueries.insert(Q);
1100               Q->removeQueryDependence(*this, Name);
1101             }
1102           }
1103         }
1104 
1105         return Error::success();
1106       }))
1107     return Err;
1108 
1109   // Otherwise notify all the completed queries.
1110   for (auto &Q : CompletedQueries) {
1111     assert(Q->isComplete() && "Q is not complete");
1112     Q->handleComplete();
1113   }
1114 
1115   return Error::success();
1116 }
1117 
1118 void JITDylib::unlinkMaterializationResponsibility(
1119     MaterializationResponsibility &MR) {
1120   ES.runSessionLocked([&]() {
1121     auto I = MRTrackers.find(&MR);
1122     assert(I != MRTrackers.end() && "MaterializationResponsibility not linked");
1123     MRTrackers.erase(I);
1124   });
1125 }
1126 
1127 std::pair<JITDylib::AsynchronousSymbolQuerySet,
1128           std::shared_ptr<SymbolDependenceMap>>
1129 JITDylib::failSymbols(FailedSymbolsWorklist Worklist) {
1130   AsynchronousSymbolQuerySet FailedQueries;
1131   auto FailedSymbolsMap = std::make_shared<SymbolDependenceMap>();
1132 
1133   while (!Worklist.empty()) {
1134     assert(Worklist.back().first && "Failed JITDylib can not be null");
1135     auto &JD = *Worklist.back().first;
1136     auto Name = std::move(Worklist.back().second);
1137     Worklist.pop_back();
1138 
1139     (*FailedSymbolsMap)[&JD].insert(Name);
1140 
1141     assert(JD.Symbols.count(Name) && "No symbol table entry for Name");
1142     auto &Sym = JD.Symbols[Name];
1143 
1144     // Move the symbol into the error state.
1145     // Note that this may be redundant: The symbol might already have been
1146     // moved to this state in response to the failure of a dependence.
1147     Sym.setFlags(Sym.getFlags() | JITSymbolFlags::HasError);
1148 
1149     // FIXME: Come up with a sane mapping of state to
1150     // presence-of-MaterializingInfo so that we can assert presence / absence
1151     // here, rather than testing it.
1152     auto MII = JD.MaterializingInfos.find(Name);
1153 
1154     if (MII == JD.MaterializingInfos.end())
1155       continue;
1156 
1157     auto &MI = MII->second;
1158 
1159     // Move all dependants to the error state and disconnect from them.
1160     for (auto &KV : MI.Dependants) {
1161       auto &DependantJD = *KV.first;
1162       for (auto &DependantName : KV.second) {
1163         assert(DependantJD.Symbols.count(DependantName) &&
1164                "No symbol table entry for DependantName");
1165         auto &DependantSym = DependantJD.Symbols[DependantName];
1166         DependantSym.setFlags(DependantSym.getFlags() |
1167                               JITSymbolFlags::HasError);
1168 
1169         assert(DependantJD.MaterializingInfos.count(DependantName) &&
1170                "No MaterializingInfo for dependant");
1171         auto &DependantMI = DependantJD.MaterializingInfos[DependantName];
1172 
1173         auto UnemittedDepI = DependantMI.UnemittedDependencies.find(&JD);
1174         assert(UnemittedDepI != DependantMI.UnemittedDependencies.end() &&
1175                "No UnemittedDependencies entry for this JITDylib");
1176         assert(UnemittedDepI->second.count(Name) &&
1177                "No UnemittedDependencies entry for this symbol");
1178         UnemittedDepI->second.erase(Name);
1179         if (UnemittedDepI->second.empty())
1180           DependantMI.UnemittedDependencies.erase(UnemittedDepI);
1181 
1182         // If this symbol is already in the emitted state then we need to
1183         // take responsibility for failing its queries, so add it to the
1184         // worklist.
1185         if (DependantSym.getState() == SymbolState::Emitted) {
1186           assert(DependantMI.Dependants.empty() &&
1187                  "Emitted symbol should not have dependants");
1188           Worklist.push_back(std::make_pair(&DependantJD, DependantName));
1189         }
1190       }
1191     }
1192     MI.Dependants.clear();
1193 
1194     // Disconnect from all unemitted depenencies.
1195     for (auto &KV : MI.UnemittedDependencies) {
1196       auto &UnemittedDepJD = *KV.first;
1197       for (auto &UnemittedDepName : KV.second) {
1198         auto UnemittedDepMII =
1199             UnemittedDepJD.MaterializingInfos.find(UnemittedDepName);
1200         assert(UnemittedDepMII != UnemittedDepJD.MaterializingInfos.end() &&
1201                "Missing MII for unemitted dependency");
1202         assert(UnemittedDepMII->second.Dependants.count(&JD) &&
1203                "JD not listed as a dependant of unemitted dependency");
1204         assert(UnemittedDepMII->second.Dependants[&JD].count(Name) &&
1205                "Name is not listed as a dependant of unemitted dependency");
1206         UnemittedDepMII->second.Dependants[&JD].erase(Name);
1207         if (UnemittedDepMII->second.Dependants[&JD].empty())
1208           UnemittedDepMII->second.Dependants.erase(&JD);
1209       }
1210     }
1211     MI.UnemittedDependencies.clear();
1212 
1213     // Collect queries to be failed for this MII.
1214     AsynchronousSymbolQueryList ToDetach;
1215     for (auto &Q : MII->second.pendingQueries()) {
1216       // Add the query to the list to be failed and detach it.
1217       FailedQueries.insert(Q);
1218       ToDetach.push_back(Q);
1219     }
1220     for (auto &Q : ToDetach)
1221       Q->detach();
1222 
1223     assert(MI.Dependants.empty() &&
1224            "Can not delete MaterializingInfo with dependants still attached");
1225     assert(MI.UnemittedDependencies.empty() &&
1226            "Can not delete MaterializingInfo with unemitted dependencies "
1227            "still attached");
1228     assert(!MI.hasQueriesPending() &&
1229            "Can not delete MaterializingInfo with queries pending");
1230     JD.MaterializingInfos.erase(MII);
1231   }
1232 
1233   return std::make_pair(std::move(FailedQueries), std::move(FailedSymbolsMap));
1234 }
1235 
1236 void JITDylib::setLinkOrder(JITDylibSearchOrder NewLinkOrder,
1237                             bool LinkAgainstThisJITDylibFirst) {
1238   ES.runSessionLocked([&]() {
1239     if (LinkAgainstThisJITDylibFirst) {
1240       LinkOrder.clear();
1241       if (NewLinkOrder.empty() || NewLinkOrder.front().first != this)
1242         LinkOrder.push_back(
1243             std::make_pair(this, JITDylibLookupFlags::MatchAllSymbols));
1244       llvm::append_range(LinkOrder, NewLinkOrder);
1245     } else
1246       LinkOrder = std::move(NewLinkOrder);
1247   });
1248 }
1249 
1250 void JITDylib::addToLinkOrder(JITDylib &JD, JITDylibLookupFlags JDLookupFlags) {
1251   ES.runSessionLocked([&]() { LinkOrder.push_back({&JD, JDLookupFlags}); });
1252 }
1253 
1254 void JITDylib::replaceInLinkOrder(JITDylib &OldJD, JITDylib &NewJD,
1255                                   JITDylibLookupFlags JDLookupFlags) {
1256   ES.runSessionLocked([&]() {
1257     for (auto &KV : LinkOrder)
1258       if (KV.first == &OldJD) {
1259         KV = {&NewJD, JDLookupFlags};
1260         break;
1261       }
1262   });
1263 }
1264 
1265 void JITDylib::removeFromLinkOrder(JITDylib &JD) {
1266   ES.runSessionLocked([&]() {
1267     auto I = llvm::find_if(LinkOrder,
1268                            [&](const JITDylibSearchOrder::value_type &KV) {
1269                              return KV.first == &JD;
1270                            });
1271     if (I != LinkOrder.end())
1272       LinkOrder.erase(I);
1273   });
1274 }
1275 
1276 Error JITDylib::remove(const SymbolNameSet &Names) {
1277   return ES.runSessionLocked([&]() -> Error {
1278     using SymbolMaterializerItrPair =
1279         std::pair<SymbolTable::iterator, UnmaterializedInfosMap::iterator>;
1280     std::vector<SymbolMaterializerItrPair> SymbolsToRemove;
1281     SymbolNameSet Missing;
1282     SymbolNameSet Materializing;
1283 
1284     for (auto &Name : Names) {
1285       auto I = Symbols.find(Name);
1286 
1287       // Note symbol missing.
1288       if (I == Symbols.end()) {
1289         Missing.insert(Name);
1290         continue;
1291       }
1292 
1293       // Note symbol materializing.
1294       if (I->second.getState() != SymbolState::NeverSearched &&
1295           I->second.getState() != SymbolState::Ready) {
1296         Materializing.insert(Name);
1297         continue;
1298       }
1299 
1300       auto UMII = I->second.hasMaterializerAttached()
1301                       ? UnmaterializedInfos.find(Name)
1302                       : UnmaterializedInfos.end();
1303       SymbolsToRemove.push_back(std::make_pair(I, UMII));
1304     }
1305 
1306     // If any of the symbols are not defined, return an error.
1307     if (!Missing.empty())
1308       return make_error<SymbolsNotFound>(std::move(Missing));
1309 
1310     // If any of the symbols are currently materializing, return an error.
1311     if (!Materializing.empty())
1312       return make_error<SymbolsCouldNotBeRemoved>(std::move(Materializing));
1313 
1314     // Remove the symbols.
1315     for (auto &SymbolMaterializerItrPair : SymbolsToRemove) {
1316       auto UMII = SymbolMaterializerItrPair.second;
1317 
1318       // If there is a materializer attached, call discard.
1319       if (UMII != UnmaterializedInfos.end()) {
1320         UMII->second->MU->doDiscard(*this, UMII->first);
1321         UnmaterializedInfos.erase(UMII);
1322       }
1323 
1324       auto SymI = SymbolMaterializerItrPair.first;
1325       Symbols.erase(SymI);
1326     }
1327 
1328     return Error::success();
1329   });
1330 }
1331 
1332 void JITDylib::dump(raw_ostream &OS) {
1333   ES.runSessionLocked([&, this]() {
1334     OS << "JITDylib \"" << JITDylibName << "\" (ES: "
1335        << format("0x%016" PRIx64, reinterpret_cast<uintptr_t>(&ES)) << "):\n"
1336        << "Link order: " << LinkOrder << "\n"
1337        << "Symbol table:\n";
1338 
1339     for (auto &KV : Symbols) {
1340       OS << "    \"" << *KV.first << "\": ";
1341       if (auto Addr = KV.second.getAddress())
1342         OS << format("0x%016" PRIx64, Addr) << ", " << KV.second.getFlags()
1343            << " ";
1344       else
1345         OS << "<not resolved> ";
1346 
1347       OS << KV.second.getFlags() << " " << KV.second.getState();
1348 
1349       if (KV.second.hasMaterializerAttached()) {
1350         OS << " (Materializer ";
1351         auto I = UnmaterializedInfos.find(KV.first);
1352         assert(I != UnmaterializedInfos.end() &&
1353                "Lazy symbol should have UnmaterializedInfo");
1354         OS << I->second->MU.get() << ", " << I->second->MU->getName() << ")\n";
1355       } else
1356         OS << "\n";
1357     }
1358 
1359     if (!MaterializingInfos.empty())
1360       OS << "  MaterializingInfos entries:\n";
1361     for (auto &KV : MaterializingInfos) {
1362       OS << "    \"" << *KV.first << "\":\n"
1363          << "      " << KV.second.pendingQueries().size()
1364          << " pending queries: { ";
1365       for (const auto &Q : KV.second.pendingQueries())
1366         OS << Q.get() << " (" << Q->getRequiredState() << ") ";
1367       OS << "}\n      Dependants:\n";
1368       for (auto &KV2 : KV.second.Dependants)
1369         OS << "        " << KV2.first->getName() << ": " << KV2.second << "\n";
1370       OS << "      Unemitted Dependencies:\n";
1371       for (auto &KV2 : KV.second.UnemittedDependencies)
1372         OS << "        " << KV2.first->getName() << ": " << KV2.second << "\n";
1373     }
1374   });
1375 }
1376 
1377 void JITDylib::MaterializingInfo::addQuery(
1378     std::shared_ptr<AsynchronousSymbolQuery> Q) {
1379 
1380   auto I = std::lower_bound(
1381       PendingQueries.rbegin(), PendingQueries.rend(), Q->getRequiredState(),
1382       [](const std::shared_ptr<AsynchronousSymbolQuery> &V, SymbolState S) {
1383         return V->getRequiredState() <= S;
1384       });
1385   PendingQueries.insert(I.base(), std::move(Q));
1386 }
1387 
1388 void JITDylib::MaterializingInfo::removeQuery(
1389     const AsynchronousSymbolQuery &Q) {
1390   // FIXME: Implement 'find_as' for shared_ptr<T>/T*.
1391   auto I = llvm::find_if(
1392       PendingQueries, [&Q](const std::shared_ptr<AsynchronousSymbolQuery> &V) {
1393         return V.get() == &Q;
1394       });
1395   assert(I != PendingQueries.end() &&
1396          "Query is not attached to this MaterializingInfo");
1397   PendingQueries.erase(I);
1398 }
1399 
1400 JITDylib::AsynchronousSymbolQueryList
1401 JITDylib::MaterializingInfo::takeQueriesMeeting(SymbolState RequiredState) {
1402   AsynchronousSymbolQueryList Result;
1403   while (!PendingQueries.empty()) {
1404     if (PendingQueries.back()->getRequiredState() > RequiredState)
1405       break;
1406 
1407     Result.push_back(std::move(PendingQueries.back()));
1408     PendingQueries.pop_back();
1409   }
1410 
1411   return Result;
1412 }
1413 
1414 JITDylib::JITDylib(ExecutionSession &ES, std::string Name)
1415     : ES(ES), JITDylibName(std::move(Name)) {
1416   LinkOrder.push_back({this, JITDylibLookupFlags::MatchAllSymbols});
1417 }
1418 
1419 ResourceTrackerSP JITDylib::getTracker(MaterializationResponsibility &MR) {
1420   auto I = MRTrackers.find(&MR);
1421   assert(I != MRTrackers.end() && "MR is not linked");
1422   assert(I->second && "Linked tracker is null");
1423   return I->second;
1424 }
1425 
1426 std::pair<JITDylib::AsynchronousSymbolQuerySet,
1427           std::shared_ptr<SymbolDependenceMap>>
1428 JITDylib::removeTracker(ResourceTracker &RT) {
1429   // Note: Should be called under the session lock.
1430 
1431   SymbolNameVector SymbolsToRemove;
1432   std::vector<std::pair<JITDylib *, SymbolStringPtr>> SymbolsToFail;
1433 
1434   if (&RT == DefaultTracker.get()) {
1435     SymbolNameSet TrackedSymbols;
1436     for (auto &KV : TrackerSymbols)
1437       for (auto &Sym : KV.second)
1438         TrackedSymbols.insert(Sym);
1439 
1440     for (auto &KV : Symbols) {
1441       auto &Sym = KV.first;
1442       if (!TrackedSymbols.count(Sym))
1443         SymbolsToRemove.push_back(Sym);
1444     }
1445 
1446     DefaultTracker.reset();
1447   } else {
1448     /// Check for a non-default tracker.
1449     auto I = TrackerSymbols.find(&RT);
1450     if (I != TrackerSymbols.end()) {
1451       SymbolsToRemove = std::move(I->second);
1452       TrackerSymbols.erase(I);
1453     }
1454     // ... if not found this tracker was already defunct. Nothing to do.
1455   }
1456 
1457   for (auto &Sym : SymbolsToRemove) {
1458     assert(Symbols.count(Sym) && "Symbol not in symbol table");
1459 
1460     // If there is a MaterializingInfo then collect any queries to fail.
1461     auto MII = MaterializingInfos.find(Sym);
1462     if (MII != MaterializingInfos.end())
1463       SymbolsToFail.push_back({this, Sym});
1464   }
1465 
1466   AsynchronousSymbolQuerySet QueriesToFail;
1467   auto Result = failSymbols(std::move(SymbolsToFail));
1468 
1469   // Removed symbols should be taken out of the table altogether.
1470   for (auto &Sym : SymbolsToRemove) {
1471     auto I = Symbols.find(Sym);
1472     assert(I != Symbols.end() && "Symbol not present in table");
1473 
1474     // Remove Materializer if present.
1475     if (I->second.hasMaterializerAttached()) {
1476       // FIXME: Should this discard the symbols?
1477       UnmaterializedInfos.erase(Sym);
1478     } else {
1479       assert(!UnmaterializedInfos.count(Sym) &&
1480              "Symbol has materializer attached");
1481     }
1482 
1483     Symbols.erase(I);
1484   }
1485 
1486   return Result;
1487 }
1488 
1489 void JITDylib::transferTracker(ResourceTracker &DstRT, ResourceTracker &SrcRT) {
1490   assert(&DstRT != &SrcRT && "No-op transfers shouldn't call transferTracker");
1491   assert(&DstRT.getJITDylib() == this && "DstRT is not for this JITDylib");
1492   assert(&SrcRT.getJITDylib() == this && "SrcRT is not for this JITDylib");
1493 
1494   // Update trackers for any not-yet materialized units.
1495   for (auto &KV : UnmaterializedInfos) {
1496     if (KV.second->RT == &SrcRT)
1497       KV.second->RT = &DstRT;
1498   }
1499 
1500   // Update trackers for any active materialization responsibilities.
1501   for (auto &KV : MRTrackers) {
1502     if (KV.second == &SrcRT)
1503       KV.second = &DstRT;
1504   }
1505 
1506   // If we're transfering to the default tracker we just need to delete the
1507   // tracked symbols for the source tracker.
1508   if (&DstRT == DefaultTracker.get()) {
1509     TrackerSymbols.erase(&SrcRT);
1510     return;
1511   }
1512 
1513   // If we're transferring from the default tracker we need to find all
1514   // currently untracked symbols.
1515   if (&SrcRT == DefaultTracker.get()) {
1516     assert(!TrackerSymbols.count(&SrcRT) &&
1517            "Default tracker should not appear in TrackerSymbols");
1518 
1519     SymbolNameVector SymbolsToTrack;
1520 
1521     SymbolNameSet CurrentlyTrackedSymbols;
1522     for (auto &KV : TrackerSymbols)
1523       for (auto &Sym : KV.second)
1524         CurrentlyTrackedSymbols.insert(Sym);
1525 
1526     for (auto &KV : Symbols) {
1527       auto &Sym = KV.first;
1528       if (!CurrentlyTrackedSymbols.count(Sym))
1529         SymbolsToTrack.push_back(Sym);
1530     }
1531 
1532     TrackerSymbols[&DstRT] = std::move(SymbolsToTrack);
1533     return;
1534   }
1535 
1536   auto &DstTrackedSymbols = TrackerSymbols[&DstRT];
1537 
1538   // Finally if neither SrtRT or DstRT are the default tracker then
1539   // just append DstRT's tracked symbols to SrtRT's.
1540   auto SI = TrackerSymbols.find(&SrcRT);
1541   if (SI == TrackerSymbols.end())
1542     return;
1543 
1544   DstTrackedSymbols.reserve(DstTrackedSymbols.size() + SI->second.size());
1545   for (auto &Sym : SI->second)
1546     DstTrackedSymbols.push_back(std::move(Sym));
1547   TrackerSymbols.erase(SI);
1548 }
1549 
1550 Error JITDylib::defineImpl(MaterializationUnit &MU) {
1551 
1552   LLVM_DEBUG({ dbgs() << "  " << MU.getSymbols() << "\n"; });
1553 
1554   SymbolNameSet Duplicates;
1555   std::vector<SymbolStringPtr> ExistingDefsOverridden;
1556   std::vector<SymbolStringPtr> MUDefsOverridden;
1557 
1558   for (const auto &KV : MU.getSymbols()) {
1559     auto I = Symbols.find(KV.first);
1560 
1561     if (I != Symbols.end()) {
1562       if (KV.second.isStrong()) {
1563         if (I->second.getFlags().isStrong() ||
1564             I->second.getState() > SymbolState::NeverSearched)
1565           Duplicates.insert(KV.first);
1566         else {
1567           assert(I->second.getState() == SymbolState::NeverSearched &&
1568                  "Overridden existing def should be in the never-searched "
1569                  "state");
1570           ExistingDefsOverridden.push_back(KV.first);
1571         }
1572       } else
1573         MUDefsOverridden.push_back(KV.first);
1574     }
1575   }
1576 
1577   // If there were any duplicate definitions then bail out.
1578   if (!Duplicates.empty()) {
1579     LLVM_DEBUG(
1580         { dbgs() << "  Error: Duplicate symbols " << Duplicates << "\n"; });
1581     return make_error<DuplicateDefinition>(std::string(**Duplicates.begin()));
1582   }
1583 
1584   // Discard any overridden defs in this MU.
1585   LLVM_DEBUG({
1586     if (!MUDefsOverridden.empty())
1587       dbgs() << "  Defs in this MU overridden: " << MUDefsOverridden << "\n";
1588   });
1589   for (auto &S : MUDefsOverridden)
1590     MU.doDiscard(*this, S);
1591 
1592   // Discard existing overridden defs.
1593   LLVM_DEBUG({
1594     if (!ExistingDefsOverridden.empty())
1595       dbgs() << "  Existing defs overridden by this MU: " << MUDefsOverridden
1596              << "\n";
1597   });
1598   for (auto &S : ExistingDefsOverridden) {
1599 
1600     auto UMII = UnmaterializedInfos.find(S);
1601     assert(UMII != UnmaterializedInfos.end() &&
1602            "Overridden existing def should have an UnmaterializedInfo");
1603     UMII->second->MU->doDiscard(*this, S);
1604   }
1605 
1606   // Finally, add the defs from this MU.
1607   for (auto &KV : MU.getSymbols()) {
1608     auto &SymEntry = Symbols[KV.first];
1609     SymEntry.setFlags(KV.second);
1610     SymEntry.setState(SymbolState::NeverSearched);
1611     SymEntry.setMaterializerAttached(true);
1612   }
1613 
1614   return Error::success();
1615 }
1616 
1617 void JITDylib::installMaterializationUnit(
1618     std::unique_ptr<MaterializationUnit> MU, ResourceTracker &RT) {
1619 
1620   /// defineImpl succeeded.
1621   if (&RT != DefaultTracker.get()) {
1622     auto &TS = TrackerSymbols[&RT];
1623     TS.reserve(TS.size() + MU->getSymbols().size());
1624     for (auto &KV : MU->getSymbols())
1625       TS.push_back(KV.first);
1626   }
1627 
1628   auto UMI = std::make_shared<UnmaterializedInfo>(std::move(MU), &RT);
1629   for (auto &KV : UMI->MU->getSymbols())
1630     UnmaterializedInfos[KV.first] = UMI;
1631 }
1632 
1633 void JITDylib::detachQueryHelper(AsynchronousSymbolQuery &Q,
1634                                  const SymbolNameSet &QuerySymbols) {
1635   for (auto &QuerySymbol : QuerySymbols) {
1636     assert(MaterializingInfos.count(QuerySymbol) &&
1637            "QuerySymbol does not have MaterializingInfo");
1638     auto &MI = MaterializingInfos[QuerySymbol];
1639     MI.removeQuery(Q);
1640   }
1641 }
1642 
1643 void JITDylib::transferEmittedNodeDependencies(
1644     MaterializingInfo &DependantMI, const SymbolStringPtr &DependantName,
1645     MaterializingInfo &EmittedMI) {
1646   for (auto &KV : EmittedMI.UnemittedDependencies) {
1647     auto &DependencyJD = *KV.first;
1648     SymbolNameSet *UnemittedDependenciesOnDependencyJD = nullptr;
1649 
1650     for (auto &DependencyName : KV.second) {
1651       auto &DependencyMI = DependencyJD.MaterializingInfos[DependencyName];
1652 
1653       // Do not add self dependencies.
1654       if (&DependencyMI == &DependantMI)
1655         continue;
1656 
1657       // If we haven't looked up the dependencies for DependencyJD yet, do it
1658       // now and cache the result.
1659       if (!UnemittedDependenciesOnDependencyJD)
1660         UnemittedDependenciesOnDependencyJD =
1661             &DependantMI.UnemittedDependencies[&DependencyJD];
1662 
1663       DependencyMI.Dependants[this].insert(DependantName);
1664       UnemittedDependenciesOnDependencyJD->insert(DependencyName);
1665     }
1666   }
1667 }
1668 
1669 Platform::~Platform() {}
1670 
1671 Expected<DenseMap<JITDylib *, SymbolMap>> Platform::lookupInitSymbols(
1672     ExecutionSession &ES,
1673     const DenseMap<JITDylib *, SymbolLookupSet> &InitSyms) {
1674 
1675   DenseMap<JITDylib *, SymbolMap> CompoundResult;
1676   Error CompoundErr = Error::success();
1677   std::mutex LookupMutex;
1678   std::condition_variable CV;
1679   uint64_t Count = InitSyms.size();
1680 
1681   LLVM_DEBUG({
1682     dbgs() << "Issuing init-symbol lookup:\n";
1683     for (auto &KV : InitSyms)
1684       dbgs() << "  " << KV.first->getName() << ": " << KV.second << "\n";
1685   });
1686 
1687   for (auto &KV : InitSyms) {
1688     auto *JD = KV.first;
1689     auto Names = std::move(KV.second);
1690     ES.lookup(
1691         LookupKind::Static,
1692         JITDylibSearchOrder({{JD, JITDylibLookupFlags::MatchAllSymbols}}),
1693         std::move(Names), SymbolState::Ready,
1694         [&, JD](Expected<SymbolMap> Result) {
1695           {
1696             std::lock_guard<std::mutex> Lock(LookupMutex);
1697             --Count;
1698             if (Result) {
1699               assert(!CompoundResult.count(JD) &&
1700                      "Duplicate JITDylib in lookup?");
1701               CompoundResult[JD] = std::move(*Result);
1702             } else
1703               CompoundErr =
1704                   joinErrors(std::move(CompoundErr), Result.takeError());
1705           }
1706           CV.notify_one();
1707         },
1708         NoDependenciesToRegister);
1709   }
1710 
1711   std::unique_lock<std::mutex> Lock(LookupMutex);
1712   CV.wait(Lock, [&] { return Count == 0 || CompoundErr; });
1713 
1714   if (CompoundErr)
1715     return std::move(CompoundErr);
1716 
1717   return std::move(CompoundResult);
1718 }
1719 
1720 ExecutionSession::ExecutionSession(std::shared_ptr<SymbolStringPool> SSP)
1721     : SSP(SSP ? std::move(SSP) : std::make_shared<SymbolStringPool>()) {}
1722 
1723 Error ExecutionSession::endSession() {
1724   LLVM_DEBUG(dbgs() << "Ending ExecutionSession " << this << "\n");
1725 
1726   std::vector<JITDylibSP> JITDylibsToClose = runSessionLocked([&] {
1727     SessionOpen = false;
1728     return std::move(JDs);
1729   });
1730 
1731   // TODO: notifiy platform? run static deinits?
1732 
1733   Error Err = Error::success();
1734   for (auto &JD : JITDylibsToClose)
1735     Err = joinErrors(std::move(Err), JD->clear());
1736   return Err;
1737 }
1738 
1739 void ExecutionSession::registerResourceManager(ResourceManager &RM) {
1740   runSessionLocked([&] { ResourceManagers.push_back(&RM); });
1741 }
1742 
1743 void ExecutionSession::deregisterResourceManager(ResourceManager &RM) {
1744   runSessionLocked([&] {
1745     assert(!ResourceManagers.empty() && "No managers registered");
1746     if (ResourceManagers.back() == &RM)
1747       ResourceManagers.pop_back();
1748     else {
1749       auto I = llvm::find(ResourceManagers, &RM);
1750       assert(I != ResourceManagers.end() && "RM not registered");
1751       ResourceManagers.erase(I);
1752     }
1753   });
1754 }
1755 
1756 JITDylib *ExecutionSession::getJITDylibByName(StringRef Name) {
1757   return runSessionLocked([&, this]() -> JITDylib * {
1758     for (auto &JD : JDs)
1759       if (JD->getName() == Name)
1760         return JD.get();
1761     return nullptr;
1762   });
1763 }
1764 
1765 JITDylib &ExecutionSession::createBareJITDylib(std::string Name) {
1766   assert(!getJITDylibByName(Name) && "JITDylib with that name already exists");
1767   return runSessionLocked([&, this]() -> JITDylib & {
1768     JDs.push_back(new JITDylib(*this, std::move(Name)));
1769     return *JDs.back();
1770   });
1771 }
1772 
1773 Expected<JITDylib &> ExecutionSession::createJITDylib(std::string Name) {
1774   auto &JD = createBareJITDylib(Name);
1775   if (P)
1776     if (auto Err = P->setupJITDylib(JD))
1777       return std::move(Err);
1778   return JD;
1779 }
1780 
1781 std::vector<JITDylibSP> JITDylib::getDFSLinkOrder(ArrayRef<JITDylibSP> JDs) {
1782   if (JDs.empty())
1783     return {};
1784 
1785   auto &ES = JDs.front()->getExecutionSession();
1786   return ES.runSessionLocked([&]() {
1787     DenseSet<JITDylib *> Visited;
1788     std::vector<JITDylibSP> Result;
1789 
1790     for (auto &JD : JDs) {
1791 
1792       if (Visited.count(JD.get()))
1793         continue;
1794 
1795       SmallVector<JITDylibSP, 64> WorkStack;
1796       WorkStack.push_back(JD);
1797       Visited.insert(JD.get());
1798 
1799       while (!WorkStack.empty()) {
1800         Result.push_back(std::move(WorkStack.back()));
1801         WorkStack.pop_back();
1802 
1803         for (auto &KV : llvm::reverse(Result.back()->LinkOrder)) {
1804           auto &JD = *KV.first;
1805           if (Visited.count(&JD))
1806             continue;
1807           Visited.insert(&JD);
1808           WorkStack.push_back(&JD);
1809         }
1810       }
1811     }
1812     return Result;
1813   });
1814 }
1815 
1816 std::vector<JITDylibSP>
1817 JITDylib::getReverseDFSLinkOrder(ArrayRef<JITDylibSP> JDs) {
1818   auto Tmp = getDFSLinkOrder(JDs);
1819   std::reverse(Tmp.begin(), Tmp.end());
1820   return Tmp;
1821 }
1822 
1823 std::vector<JITDylibSP> JITDylib::getDFSLinkOrder() {
1824   return getDFSLinkOrder({this});
1825 }
1826 
1827 std::vector<JITDylibSP> JITDylib::getReverseDFSLinkOrder() {
1828   return getReverseDFSLinkOrder({this});
1829 }
1830 
1831 void ExecutionSession::lookupFlags(
1832     LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet LookupSet,
1833     unique_function<void(Expected<SymbolFlagsMap>)> OnComplete) {
1834 
1835   OL_applyQueryPhase1(std::make_unique<InProgressLookupFlagsState>(
1836                           K, std::move(SearchOrder), std::move(LookupSet),
1837                           std::move(OnComplete)),
1838                       Error::success());
1839 }
1840 
1841 Expected<SymbolFlagsMap>
1842 ExecutionSession::lookupFlags(LookupKind K, JITDylibSearchOrder SearchOrder,
1843                               SymbolLookupSet LookupSet) {
1844 
1845   std::promise<MSVCPExpected<SymbolFlagsMap>> ResultP;
1846   OL_applyQueryPhase1(std::make_unique<InProgressLookupFlagsState>(
1847                           K, std::move(SearchOrder), std::move(LookupSet),
1848                           [&ResultP](Expected<SymbolFlagsMap> Result) {
1849                             ResultP.set_value(std::move(Result));
1850                           }),
1851                       Error::success());
1852 
1853   auto ResultF = ResultP.get_future();
1854   return ResultF.get();
1855 }
1856 
1857 void ExecutionSession::lookup(
1858     LookupKind K, const JITDylibSearchOrder &SearchOrder,
1859     SymbolLookupSet Symbols, SymbolState RequiredState,
1860     SymbolsResolvedCallback NotifyComplete,
1861     RegisterDependenciesFunction RegisterDependencies) {
1862 
1863   LLVM_DEBUG({
1864     runSessionLocked([&]() {
1865       dbgs() << "Looking up " << Symbols << " in " << SearchOrder
1866              << " (required state: " << RequiredState << ")\n";
1867     });
1868   });
1869 
1870   // lookup can be re-entered recursively if running on a single thread. Run any
1871   // outstanding MUs in case this query depends on them, otherwise this lookup
1872   // will starve waiting for a result from an MU that is stuck in the queue.
1873   dispatchOutstandingMUs();
1874 
1875   auto Unresolved = std::move(Symbols);
1876   auto Q = std::make_shared<AsynchronousSymbolQuery>(Unresolved, RequiredState,
1877                                                      std::move(NotifyComplete));
1878 
1879   auto IPLS = std::make_unique<InProgressFullLookupState>(
1880       K, SearchOrder, std::move(Unresolved), RequiredState, std::move(Q),
1881       std::move(RegisterDependencies));
1882 
1883   OL_applyQueryPhase1(std::move(IPLS), Error::success());
1884 }
1885 
1886 Expected<SymbolMap>
1887 ExecutionSession::lookup(const JITDylibSearchOrder &SearchOrder,
1888                          const SymbolLookupSet &Symbols, LookupKind K,
1889                          SymbolState RequiredState,
1890                          RegisterDependenciesFunction RegisterDependencies) {
1891 #if LLVM_ENABLE_THREADS
1892   // In the threaded case we use promises to return the results.
1893   std::promise<SymbolMap> PromisedResult;
1894   Error ResolutionError = Error::success();
1895 
1896   auto NotifyComplete = [&](Expected<SymbolMap> R) {
1897     if (R)
1898       PromisedResult.set_value(std::move(*R));
1899     else {
1900       ErrorAsOutParameter _(&ResolutionError);
1901       ResolutionError = R.takeError();
1902       PromisedResult.set_value(SymbolMap());
1903     }
1904   };
1905 
1906 #else
1907   SymbolMap Result;
1908   Error ResolutionError = Error::success();
1909 
1910   auto NotifyComplete = [&](Expected<SymbolMap> R) {
1911     ErrorAsOutParameter _(&ResolutionError);
1912     if (R)
1913       Result = std::move(*R);
1914     else
1915       ResolutionError = R.takeError();
1916   };
1917 #endif
1918 
1919   // Perform the asynchronous lookup.
1920   lookup(K, SearchOrder, Symbols, RequiredState, NotifyComplete,
1921          RegisterDependencies);
1922 
1923 #if LLVM_ENABLE_THREADS
1924   auto ResultFuture = PromisedResult.get_future();
1925   auto Result = ResultFuture.get();
1926 
1927   if (ResolutionError)
1928     return std::move(ResolutionError);
1929 
1930   return std::move(Result);
1931 
1932 #else
1933   if (ResolutionError)
1934     return std::move(ResolutionError);
1935 
1936   return Result;
1937 #endif
1938 }
1939 
1940 Expected<JITEvaluatedSymbol>
1941 ExecutionSession::lookup(const JITDylibSearchOrder &SearchOrder,
1942                          SymbolStringPtr Name, SymbolState RequiredState) {
1943   SymbolLookupSet Names({Name});
1944 
1945   if (auto ResultMap = lookup(SearchOrder, std::move(Names), LookupKind::Static,
1946                               RequiredState, NoDependenciesToRegister)) {
1947     assert(ResultMap->size() == 1 && "Unexpected number of results");
1948     assert(ResultMap->count(Name) && "Missing result for symbol");
1949     return std::move(ResultMap->begin()->second);
1950   } else
1951     return ResultMap.takeError();
1952 }
1953 
1954 Expected<JITEvaluatedSymbol>
1955 ExecutionSession::lookup(ArrayRef<JITDylib *> SearchOrder, SymbolStringPtr Name,
1956                          SymbolState RequiredState) {
1957   return lookup(makeJITDylibSearchOrder(SearchOrder), Name, RequiredState);
1958 }
1959 
1960 Expected<JITEvaluatedSymbol>
1961 ExecutionSession::lookup(ArrayRef<JITDylib *> SearchOrder, StringRef Name,
1962                          SymbolState RequiredState) {
1963   return lookup(SearchOrder, intern(Name), RequiredState);
1964 }
1965 
1966 void ExecutionSession::dump(raw_ostream &OS) {
1967   runSessionLocked([this, &OS]() {
1968     for (auto &JD : JDs)
1969       JD->dump(OS);
1970   });
1971 }
1972 
1973 void ExecutionSession::dispatchOutstandingMUs() {
1974   LLVM_DEBUG(dbgs() << "Dispatching MaterializationUnits...\n");
1975   while (1) {
1976     Optional<std::pair<std::unique_ptr<MaterializationUnit>,
1977                        std::unique_ptr<MaterializationResponsibility>>>
1978         JMU;
1979 
1980     {
1981       std::lock_guard<std::recursive_mutex> Lock(OutstandingMUsMutex);
1982       if (!OutstandingMUs.empty()) {
1983         JMU.emplace(std::move(OutstandingMUs.back()));
1984         OutstandingMUs.pop_back();
1985       }
1986     }
1987 
1988     if (!JMU)
1989       break;
1990 
1991     assert(JMU->first && "No MU?");
1992     LLVM_DEBUG(dbgs() << "  Dispatching \"" << JMU->first->getName() << "\"\n");
1993     dispatchMaterialization(std::move(JMU->first), std::move(JMU->second));
1994   }
1995   LLVM_DEBUG(dbgs() << "Done dispatching MaterializationUnits.\n");
1996 }
1997 
1998 Error ExecutionSession::removeResourceTracker(ResourceTracker &RT) {
1999   LLVM_DEBUG({
2000     dbgs() << "In " << RT.getJITDylib().getName() << " removing tracker "
2001            << formatv("{0:x}", RT.getKeyUnsafe()) << "\n";
2002   });
2003   std::vector<ResourceManager *> CurrentResourceManagers;
2004 
2005   JITDylib::AsynchronousSymbolQuerySet QueriesToFail;
2006   std::shared_ptr<SymbolDependenceMap> FailedSymbols;
2007 
2008   runSessionLocked([&] {
2009     CurrentResourceManagers = ResourceManagers;
2010     RT.makeDefunct();
2011     std::tie(QueriesToFail, FailedSymbols) = RT.getJITDylib().removeTracker(RT);
2012   });
2013 
2014   Error Err = Error::success();
2015 
2016   for (auto *L : reverse(CurrentResourceManagers))
2017     Err =
2018         joinErrors(std::move(Err), L->handleRemoveResources(RT.getKeyUnsafe()));
2019 
2020   for (auto &Q : QueriesToFail)
2021     Q->handleFailed(make_error<FailedToMaterialize>(FailedSymbols));
2022 
2023   return Err;
2024 }
2025 
2026 void ExecutionSession::transferResourceTracker(ResourceTracker &DstRT,
2027                                                ResourceTracker &SrcRT) {
2028   LLVM_DEBUG({
2029     dbgs() << "In " << SrcRT.getJITDylib().getName()
2030            << " transfering resources from tracker "
2031            << formatv("{0:x}", SrcRT.getKeyUnsafe()) << " to tracker "
2032            << formatv("{0:x}", DstRT.getKeyUnsafe()) << "\n";
2033   });
2034 
2035   // No-op transfers are allowed and do not invalidate the source.
2036   if (&DstRT == &SrcRT)
2037     return;
2038 
2039   assert(&DstRT.getJITDylib() == &SrcRT.getJITDylib() &&
2040          "Can't transfer resources between JITDylibs");
2041   runSessionLocked([&]() {
2042     SrcRT.makeDefunct();
2043     auto &JD = DstRT.getJITDylib();
2044     JD.transferTracker(DstRT, SrcRT);
2045     for (auto *L : reverse(ResourceManagers))
2046       L->handleTransferResources(DstRT.getKeyUnsafe(), SrcRT.getKeyUnsafe());
2047   });
2048 }
2049 
2050 void ExecutionSession::destroyResourceTracker(ResourceTracker &RT) {
2051   runSessionLocked([&]() {
2052     LLVM_DEBUG({
2053       dbgs() << "In " << RT.getJITDylib().getName() << " destroying tracker "
2054              << formatv("{0:x}", RT.getKeyUnsafe()) << "\n";
2055     });
2056     if (!RT.isDefunct())
2057       transferResourceTracker(*RT.getJITDylib().getDefaultResourceTracker(),
2058                               RT);
2059   });
2060 }
2061 
2062 Error ExecutionSession::IL_updateCandidatesFor(
2063     JITDylib &JD, JITDylibLookupFlags JDLookupFlags,
2064     SymbolLookupSet &Candidates, SymbolLookupSet *NonCandidates) {
2065   return Candidates.forEachWithRemoval(
2066       [&](const SymbolStringPtr &Name,
2067           SymbolLookupFlags SymLookupFlags) -> Expected<bool> {
2068         /// Search for the symbol. If not found then continue without
2069         /// removal.
2070         auto SymI = JD.Symbols.find(Name);
2071         if (SymI == JD.Symbols.end())
2072           return false;
2073 
2074         // If this is a non-exported symbol and we're matching exported
2075         // symbols only then remove this symbol from the candidates list.
2076         //
2077         // If we're tracking non-candidates then add this to the non-candidate
2078         // list.
2079         if (!SymI->second.getFlags().isExported() &&
2080             JDLookupFlags == JITDylibLookupFlags::MatchExportedSymbolsOnly) {
2081           if (NonCandidates)
2082             NonCandidates->add(Name, SymLookupFlags);
2083           return true;
2084         }
2085 
2086         // If we match against a materialization-side-effects only symbol
2087         // then make sure it is weakly-referenced. Otherwise bail out with
2088         // an error.
2089         // FIXME: Use a "materialization-side-effects-only symbols must be
2090         // weakly referenced" specific error here to reduce confusion.
2091         if (SymI->second.getFlags().hasMaterializationSideEffectsOnly() &&
2092             SymLookupFlags != SymbolLookupFlags::WeaklyReferencedSymbol)
2093           return make_error<SymbolsNotFound>(SymbolNameVector({Name}));
2094 
2095         // If we matched against this symbol but it is in the error state
2096         // then bail out and treat it as a failure to materialize.
2097         if (SymI->second.getFlags().hasError()) {
2098           auto FailedSymbolsMap = std::make_shared<SymbolDependenceMap>();
2099           (*FailedSymbolsMap)[&JD] = {Name};
2100           return make_error<FailedToMaterialize>(std::move(FailedSymbolsMap));
2101         }
2102 
2103         // Otherwise this is a match. Remove it from the candidate set.
2104         return true;
2105       });
2106 }
2107 
2108 void ExecutionSession::OL_applyQueryPhase1(
2109     std::unique_ptr<InProgressLookupState> IPLS, Error Err) {
2110 
2111   LLVM_DEBUG({
2112     dbgs() << "Entering OL_applyQueryPhase1:\n"
2113            << "  Lookup kind: " << IPLS->K << "\n"
2114            << "  Search order: " << IPLS->SearchOrder
2115            << ", Current index = " << IPLS->CurSearchOrderIndex
2116            << (IPLS->NewJITDylib ? " (entering new JITDylib)" : "") << "\n"
2117            << "  Lookup set: " << IPLS->LookupSet << "\n"
2118            << "  Definition generator candidates: "
2119            << IPLS->DefGeneratorCandidates << "\n"
2120            << "  Definition generator non-candidates: "
2121            << IPLS->DefGeneratorNonCandidates << "\n";
2122   });
2123 
2124   // FIXME: We should attach the query as we go: This provides a result in a
2125   // single pass in the common case where all symbols have already reached the
2126   // required state. The query could be detached again in the 'fail' method on
2127   // IPLS. Phase 2 would be reduced to collecting and dispatching the MUs.
2128 
2129   while (IPLS->CurSearchOrderIndex != IPLS->SearchOrder.size()) {
2130 
2131     // If we've been handed an error or received one back from a generator then
2132     // fail the query. We don't need to unlink: At this stage the query hasn't
2133     // actually been lodged.
2134     if (Err)
2135       return IPLS->fail(std::move(Err));
2136 
2137     // Get the next JITDylib and lookup flags.
2138     auto &KV = IPLS->SearchOrder[IPLS->CurSearchOrderIndex];
2139     auto &JD = *KV.first;
2140     auto JDLookupFlags = KV.second;
2141 
2142     LLVM_DEBUG({
2143       dbgs() << "Visiting \"" << JD.getName() << "\" (" << JDLookupFlags
2144              << ") with lookup set " << IPLS->LookupSet << ":\n";
2145     });
2146 
2147     // If we've just reached a new JITDylib then perform some setup.
2148     if (IPLS->NewJITDylib) {
2149 
2150       // Acquire the generator lock for this JITDylib.
2151       IPLS->GeneratorLock = std::unique_lock<std::mutex>(JD.GeneratorsMutex);
2152 
2153       // Add any non-candidates from the last JITDylib (if any) back on to the
2154       // list of definition candidates for this JITDylib, reset definition
2155       // non-candiates to the empty set.
2156       SymbolLookupSet Tmp;
2157       std::swap(IPLS->DefGeneratorNonCandidates, Tmp);
2158       IPLS->DefGeneratorCandidates.append(std::move(Tmp));
2159 
2160       LLVM_DEBUG({
2161         dbgs() << "  First time visiting " << JD.getName()
2162                << ", resetting candidate sets and building generator stack\n";
2163       });
2164 
2165       // Build the definition generator stack for this JITDylib.
2166       for (auto &DG : reverse(JD.DefGenerators))
2167         IPLS->CurDefGeneratorStack.push_back(DG);
2168 
2169       // Flag that we've done our initialization.
2170       IPLS->NewJITDylib = false;
2171     }
2172 
2173     // Remove any generation candidates that are already defined (and match) in
2174     // this JITDylib.
2175     runSessionLocked([&] {
2176       // Update the list of candidates (and non-candidates) for definition
2177       // generation.
2178       LLVM_DEBUG(dbgs() << "  Updating candidate set...\n");
2179       Err = IL_updateCandidatesFor(
2180           JD, JDLookupFlags, IPLS->DefGeneratorCandidates,
2181           JD.DefGenerators.empty() ? nullptr
2182                                    : &IPLS->DefGeneratorNonCandidates);
2183       LLVM_DEBUG({
2184         dbgs() << "    Remaining candidates = " << IPLS->DefGeneratorCandidates
2185                << "\n";
2186       });
2187     });
2188 
2189     // If we encountered an error while filtering generation candidates then
2190     // bail out.
2191     if (Err)
2192       return IPLS->fail(std::move(Err));
2193 
2194     /// Apply any definition generators on the stack.
2195     LLVM_DEBUG({
2196       if (IPLS->CurDefGeneratorStack.empty())
2197         LLVM_DEBUG(dbgs() << "  No generators to run for this JITDylib.\n");
2198       else if (IPLS->DefGeneratorCandidates.empty())
2199         LLVM_DEBUG(dbgs() << "  No candidates to generate.\n");
2200       else
2201         dbgs() << "  Running " << IPLS->CurDefGeneratorStack.size()
2202                << " remaining generators for "
2203                << IPLS->DefGeneratorCandidates.size() << " candidates\n";
2204     });
2205     while (!IPLS->CurDefGeneratorStack.empty() &&
2206            !IPLS->DefGeneratorCandidates.empty()) {
2207       auto DG = IPLS->CurDefGeneratorStack.back().lock();
2208       IPLS->CurDefGeneratorStack.pop_back();
2209 
2210       if (!DG)
2211         return IPLS->fail(make_error<StringError>(
2212             "DefinitionGenerator removed while lookup in progress",
2213             inconvertibleErrorCode()));
2214 
2215       auto K = IPLS->K;
2216       auto &LookupSet = IPLS->DefGeneratorCandidates;
2217 
2218       // Run the generator. If the generator takes ownership of QA then this
2219       // will break the loop.
2220       {
2221         LLVM_DEBUG(dbgs() << "  Attempting to generate " << LookupSet << "\n");
2222         LookupState LS(std::move(IPLS));
2223         Err = DG->tryToGenerate(LS, K, JD, JDLookupFlags, LookupSet);
2224         IPLS = std::move(LS.IPLS);
2225       }
2226 
2227       // If there was an error then fail the query.
2228       if (Err) {
2229         LLVM_DEBUG({
2230           dbgs() << "  Error attempting to generate " << LookupSet << "\n";
2231         });
2232         assert(IPLS && "LS cannot be retained if error is returned");
2233         return IPLS->fail(std::move(Err));
2234       }
2235 
2236       // Otherwise if QA was captured then break the loop.
2237       if (!IPLS) {
2238         LLVM_DEBUG(
2239             { dbgs() << "  LookupState captured. Exiting phase1 for now.\n"; });
2240         return;
2241       }
2242 
2243       // Otherwise if we're continuing around the loop then update candidates
2244       // for the next round.
2245       runSessionLocked([&] {
2246         LLVM_DEBUG(dbgs() << "  Updating candidate set post-generation\n");
2247         Err = IL_updateCandidatesFor(
2248             JD, JDLookupFlags, IPLS->DefGeneratorCandidates,
2249             JD.DefGenerators.empty() ? nullptr
2250                                      : &IPLS->DefGeneratorNonCandidates);
2251       });
2252 
2253       // If updating candidates failed then fail the query.
2254       if (Err) {
2255         LLVM_DEBUG(dbgs() << "  Error encountered while updating candidates\n");
2256         return IPLS->fail(std::move(Err));
2257       }
2258     }
2259 
2260     // If we get here then we've moved on to the next JITDylib.
2261     LLVM_DEBUG(dbgs() << "Phase 1 moving to next JITDylib.\n");
2262     ++IPLS->CurSearchOrderIndex;
2263     IPLS->NewJITDylib = true;
2264   }
2265 
2266   // Remove any weakly referenced candidates that could not be found/generated.
2267   IPLS->DefGeneratorCandidates.remove_if(
2268       [](const SymbolStringPtr &Name, SymbolLookupFlags SymLookupFlags) {
2269         return SymLookupFlags == SymbolLookupFlags::WeaklyReferencedSymbol;
2270       });
2271 
2272   // If we get here then we've finished searching all JITDylibs.
2273   // If we matched all symbols then move to phase 2, otherwise fail the query
2274   // with a SymbolsNotFound error.
2275   if (IPLS->DefGeneratorCandidates.empty()) {
2276     LLVM_DEBUG(dbgs() << "Phase 1 succeeded.\n");
2277     IPLS->complete(std::move(IPLS));
2278   } else {
2279     LLVM_DEBUG(dbgs() << "Phase 1 failed with unresolved symbols.\n");
2280     IPLS->fail(make_error<SymbolsNotFound>(
2281         IPLS->DefGeneratorCandidates.getSymbolNames()));
2282   }
2283 }
2284 
2285 void ExecutionSession::OL_completeLookup(
2286     std::unique_ptr<InProgressLookupState> IPLS,
2287     std::shared_ptr<AsynchronousSymbolQuery> Q,
2288     RegisterDependenciesFunction RegisterDependencies) {
2289 
2290   LLVM_DEBUG({
2291     dbgs() << "Entering OL_completeLookup:\n"
2292            << "  Lookup kind: " << IPLS->K << "\n"
2293            << "  Search order: " << IPLS->SearchOrder
2294            << ", Current index = " << IPLS->CurSearchOrderIndex
2295            << (IPLS->NewJITDylib ? " (entering new JITDylib)" : "") << "\n"
2296            << "  Lookup set: " << IPLS->LookupSet << "\n"
2297            << "  Definition generator candidates: "
2298            << IPLS->DefGeneratorCandidates << "\n"
2299            << "  Definition generator non-candidates: "
2300            << IPLS->DefGeneratorNonCandidates << "\n";
2301   });
2302 
2303   bool QueryComplete = false;
2304   DenseMap<JITDylib *, JITDylib::UnmaterializedInfosList> CollectedUMIs;
2305 
2306   auto LodgingErr = runSessionLocked([&]() -> Error {
2307     for (auto &KV : IPLS->SearchOrder) {
2308       auto &JD = *KV.first;
2309       auto JDLookupFlags = KV.second;
2310       LLVM_DEBUG({
2311         dbgs() << "Visiting \"" << JD.getName() << "\" (" << JDLookupFlags
2312                << ") with lookup set " << IPLS->LookupSet << ":\n";
2313       });
2314 
2315       auto Err = IPLS->LookupSet.forEachWithRemoval(
2316           [&](const SymbolStringPtr &Name,
2317               SymbolLookupFlags SymLookupFlags) -> Expected<bool> {
2318             LLVM_DEBUG({
2319               dbgs() << "  Attempting to match \"" << Name << "\" ("
2320                      << SymLookupFlags << ")... ";
2321             });
2322 
2323             /// Search for the symbol. If not found then continue without
2324             /// removal.
2325             auto SymI = JD.Symbols.find(Name);
2326             if (SymI == JD.Symbols.end()) {
2327               LLVM_DEBUG(dbgs() << "skipping: not present\n");
2328               return false;
2329             }
2330 
2331             // If this is a non-exported symbol and we're matching exported
2332             // symbols only then skip this symbol without removal.
2333             if (!SymI->second.getFlags().isExported() &&
2334                 JDLookupFlags ==
2335                     JITDylibLookupFlags::MatchExportedSymbolsOnly) {
2336               LLVM_DEBUG(dbgs() << "skipping: not exported\n");
2337               return false;
2338             }
2339 
2340             // If we match against a materialization-side-effects only symbol
2341             // then make sure it is weakly-referenced. Otherwise bail out with
2342             // an error.
2343             // FIXME: Use a "materialization-side-effects-only symbols must be
2344             // weakly referenced" specific error here to reduce confusion.
2345             if (SymI->second.getFlags().hasMaterializationSideEffectsOnly() &&
2346                 SymLookupFlags != SymbolLookupFlags::WeaklyReferencedSymbol) {
2347               LLVM_DEBUG({
2348                 dbgs() << "error: "
2349                           "required, but symbol is has-side-effects-only\n";
2350               });
2351               return make_error<SymbolsNotFound>(SymbolNameVector({Name}));
2352             }
2353 
2354             // If we matched against this symbol but it is in the error state
2355             // then bail out and treat it as a failure to materialize.
2356             if (SymI->second.getFlags().hasError()) {
2357               LLVM_DEBUG(dbgs() << "error: symbol is in error state\n");
2358               auto FailedSymbolsMap = std::make_shared<SymbolDependenceMap>();
2359               (*FailedSymbolsMap)[&JD] = {Name};
2360               return make_error<FailedToMaterialize>(
2361                   std::move(FailedSymbolsMap));
2362             }
2363 
2364             // Otherwise this is a match.
2365 
2366             // If this symbol is already in the requried state then notify the
2367             // query, remove the symbol and continue.
2368             if (SymI->second.getState() >= Q->getRequiredState()) {
2369               LLVM_DEBUG(dbgs()
2370                          << "matched, symbol already in required state\n");
2371               Q->notifySymbolMetRequiredState(Name, SymI->second.getSymbol());
2372               return true;
2373             }
2374 
2375             // Otherwise this symbol does not yet meet the required state. Check
2376             // whether it has a materializer attached, and if so prepare to run
2377             // it.
2378             if (SymI->second.hasMaterializerAttached()) {
2379               assert(SymI->second.getAddress() == 0 &&
2380                      "Symbol not resolved but already has address?");
2381               auto UMII = JD.UnmaterializedInfos.find(Name);
2382               assert(UMII != JD.UnmaterializedInfos.end() &&
2383                      "Lazy symbol should have UnmaterializedInfo");
2384 
2385               auto UMI = UMII->second;
2386               assert(UMI->MU && "Materializer should not be null");
2387               assert(UMI->RT && "Tracker should not be null");
2388               LLVM_DEBUG({
2389                 dbgs() << "matched, preparing to dispatch MU@" << UMI->MU.get()
2390                        << " (" << UMI->MU->getName() << ")\n";
2391               });
2392 
2393               // Move all symbols associated with this MaterializationUnit into
2394               // materializing state.
2395               for (auto &KV : UMI->MU->getSymbols()) {
2396                 auto SymK = JD.Symbols.find(KV.first);
2397                 assert(SymK != JD.Symbols.end() &&
2398                        "No entry for symbol covered by MaterializationUnit");
2399                 SymK->second.setMaterializerAttached(false);
2400                 SymK->second.setState(SymbolState::Materializing);
2401                 JD.UnmaterializedInfos.erase(KV.first);
2402               }
2403 
2404               // Add MU to the list of MaterializationUnits to be materialized.
2405               CollectedUMIs[&JD].push_back(std::move(UMI));
2406             } else
2407               LLVM_DEBUG(dbgs() << "matched, registering query");
2408 
2409             // Add the query to the PendingQueries list and continue, deleting
2410             // the element from the lookup set.
2411             assert(SymI->second.getState() != SymbolState::NeverSearched &&
2412                    SymI->second.getState() != SymbolState::Ready &&
2413                    "By this line the symbol should be materializing");
2414             auto &MI = JD.MaterializingInfos[Name];
2415             MI.addQuery(Q);
2416             Q->addQueryDependence(JD, Name);
2417 
2418             return true;
2419           });
2420 
2421       // Handle failure.
2422       if (Err) {
2423 
2424         LLVM_DEBUG({
2425           dbgs() << "Lookup failed. Detaching query and replacing MUs.\n";
2426         });
2427 
2428         // Detach the query.
2429         Q->detach();
2430 
2431         // Replace the MUs.
2432         for (auto &KV : CollectedUMIs) {
2433           auto &JD = *KV.first;
2434           for (auto &UMI : KV.second)
2435             for (auto &KV2 : UMI->MU->getSymbols()) {
2436               assert(!JD.UnmaterializedInfos.count(KV2.first) &&
2437                      "Unexpected materializer in map");
2438               auto SymI = JD.Symbols.find(KV2.first);
2439               assert(SymI != JD.Symbols.end() && "Missing symbol entry");
2440               assert(SymI->second.getState() == SymbolState::Materializing &&
2441                      "Can not replace symbol that is not materializing");
2442               assert(!SymI->second.hasMaterializerAttached() &&
2443                      "MaterializerAttached flag should not be set");
2444               SymI->second.setMaterializerAttached(true);
2445               JD.UnmaterializedInfos[KV2.first] = UMI;
2446             }
2447         }
2448 
2449         return Err;
2450       }
2451     }
2452 
2453     LLVM_DEBUG(dbgs() << "Stripping unmatched weakly-refererced symbols\n");
2454     IPLS->LookupSet.forEachWithRemoval(
2455         [&](const SymbolStringPtr &Name, SymbolLookupFlags SymLookupFlags) {
2456           if (SymLookupFlags == SymbolLookupFlags::WeaklyReferencedSymbol) {
2457             Q->dropSymbol(Name);
2458             return true;
2459           } else
2460             return false;
2461         });
2462 
2463     if (!IPLS->LookupSet.empty()) {
2464       LLVM_DEBUG(dbgs() << "Failing due to unresolved symbols\n");
2465       return make_error<SymbolsNotFound>(IPLS->LookupSet.getSymbolNames());
2466     }
2467 
2468     // Record whether the query completed.
2469     QueryComplete = Q->isComplete();
2470 
2471     LLVM_DEBUG({
2472       dbgs() << "Query successfully "
2473              << (QueryComplete ? "completed" : "lodged") << "\n";
2474     });
2475 
2476     // Move the collected MUs to the OutstandingMUs list.
2477     if (!CollectedUMIs.empty()) {
2478       std::lock_guard<std::recursive_mutex> Lock(OutstandingMUsMutex);
2479 
2480       LLVM_DEBUG(dbgs() << "Adding MUs to dispatch:\n");
2481       for (auto &KV : CollectedUMIs) {
2482         auto &JD = *KV.first;
2483         LLVM_DEBUG({
2484           dbgs() << "  For " << JD.getName() << ": Adding " << KV.second.size()
2485                  << " MUs.\n";
2486         });
2487         for (auto &UMI : KV.second) {
2488           std::unique_ptr<MaterializationResponsibility> MR(
2489               new MaterializationResponsibility(
2490                   &JD, std::move(UMI->MU->SymbolFlags),
2491                   std::move(UMI->MU->InitSymbol)));
2492           JD.MRTrackers[MR.get()] = UMI->RT;
2493           OutstandingMUs.push_back(
2494               std::make_pair(std::move(UMI->MU), std::move(MR)));
2495         }
2496       }
2497     } else
2498       LLVM_DEBUG(dbgs() << "No MUs to dispatch.\n");
2499 
2500     if (RegisterDependencies && !Q->QueryRegistrations.empty()) {
2501       LLVM_DEBUG(dbgs() << "Registering dependencies\n");
2502       RegisterDependencies(Q->QueryRegistrations);
2503     } else
2504       LLVM_DEBUG(dbgs() << "No dependencies to register\n");
2505 
2506     return Error::success();
2507   });
2508 
2509   if (LodgingErr) {
2510     LLVM_DEBUG(dbgs() << "Failing query\n");
2511     Q->detach();
2512     Q->handleFailed(std::move(LodgingErr));
2513     return;
2514   }
2515 
2516   if (QueryComplete) {
2517     LLVM_DEBUG(dbgs() << "Completing query\n");
2518     Q->handleComplete();
2519   }
2520 
2521   dispatchOutstandingMUs();
2522 }
2523 
2524 void ExecutionSession::OL_completeLookupFlags(
2525     std::unique_ptr<InProgressLookupState> IPLS,
2526     unique_function<void(Expected<SymbolFlagsMap>)> OnComplete) {
2527 
2528   auto Result = runSessionLocked([&]() -> Expected<SymbolFlagsMap> {
2529     LLVM_DEBUG({
2530       dbgs() << "Entering OL_completeLookupFlags:\n"
2531              << "  Lookup kind: " << IPLS->K << "\n"
2532              << "  Search order: " << IPLS->SearchOrder
2533              << ", Current index = " << IPLS->CurSearchOrderIndex
2534              << (IPLS->NewJITDylib ? " (entering new JITDylib)" : "") << "\n"
2535              << "  Lookup set: " << IPLS->LookupSet << "\n"
2536              << "  Definition generator candidates: "
2537              << IPLS->DefGeneratorCandidates << "\n"
2538              << "  Definition generator non-candidates: "
2539              << IPLS->DefGeneratorNonCandidates << "\n";
2540     });
2541 
2542     SymbolFlagsMap Result;
2543 
2544     // Attempt to find flags for each symbol.
2545     for (auto &KV : IPLS->SearchOrder) {
2546       auto &JD = *KV.first;
2547       auto JDLookupFlags = KV.second;
2548       LLVM_DEBUG({
2549         dbgs() << "Visiting \"" << JD.getName() << "\" (" << JDLookupFlags
2550                << ") with lookup set " << IPLS->LookupSet << ":\n";
2551       });
2552 
2553       IPLS->LookupSet.forEachWithRemoval([&](const SymbolStringPtr &Name,
2554                                              SymbolLookupFlags SymLookupFlags) {
2555         LLVM_DEBUG({
2556           dbgs() << "  Attempting to match \"" << Name << "\" ("
2557                  << SymLookupFlags << ")... ";
2558         });
2559 
2560         // Search for the symbol. If not found then continue without removing
2561         // from the lookup set.
2562         auto SymI = JD.Symbols.find(Name);
2563         if (SymI == JD.Symbols.end()) {
2564           LLVM_DEBUG(dbgs() << "skipping: not present\n");
2565           return false;
2566         }
2567 
2568         // If this is a non-exported symbol then it doesn't match. Skip it.
2569         if (!SymI->second.getFlags().isExported() &&
2570             JDLookupFlags == JITDylibLookupFlags::MatchExportedSymbolsOnly) {
2571           LLVM_DEBUG(dbgs() << "skipping: not exported\n");
2572           return false;
2573         }
2574 
2575         LLVM_DEBUG({
2576           dbgs() << "matched, \"" << Name << "\" -> " << SymI->second.getFlags()
2577                  << "\n";
2578         });
2579         Result[Name] = SymI->second.getFlags();
2580         return true;
2581       });
2582     }
2583 
2584     // Remove any weakly referenced symbols that haven't been resolved.
2585     IPLS->LookupSet.remove_if(
2586         [](const SymbolStringPtr &Name, SymbolLookupFlags SymLookupFlags) {
2587           return SymLookupFlags == SymbolLookupFlags::WeaklyReferencedSymbol;
2588         });
2589 
2590     if (!IPLS->LookupSet.empty()) {
2591       LLVM_DEBUG(dbgs() << "Failing due to unresolved symbols\n");
2592       return make_error<SymbolsNotFound>(IPLS->LookupSet.getSymbolNames());
2593     }
2594 
2595     LLVM_DEBUG(dbgs() << "Succeded, result = " << Result << "\n");
2596     return Result;
2597   });
2598 
2599   // Run the callback on the result.
2600   LLVM_DEBUG(dbgs() << "Sending result to handler.\n");
2601   OnComplete(std::move(Result));
2602 }
2603 
2604 void ExecutionSession::OL_destroyMaterializationResponsibility(
2605     MaterializationResponsibility &MR) {
2606 
2607   assert(MR.SymbolFlags.empty() &&
2608          "All symbols should have been explicitly materialized or failed");
2609   MR.JD->unlinkMaterializationResponsibility(MR);
2610 }
2611 
2612 SymbolNameSet ExecutionSession::OL_getRequestedSymbols(
2613     const MaterializationResponsibility &MR) {
2614   return MR.JD->getRequestedSymbols(MR.SymbolFlags);
2615 }
2616 
2617 Error ExecutionSession::OL_notifyResolved(MaterializationResponsibility &MR,
2618                                           const SymbolMap &Symbols) {
2619   LLVM_DEBUG({
2620     dbgs() << "In " << MR.JD->getName() << " resolving " << Symbols << "\n";
2621   });
2622 #ifndef NDEBUG
2623   for (auto &KV : Symbols) {
2624     auto WeakFlags = JITSymbolFlags::Weak | JITSymbolFlags::Common;
2625     auto I = MR.SymbolFlags.find(KV.first);
2626     assert(I != MR.SymbolFlags.end() &&
2627            "Resolving symbol outside this responsibility set");
2628     assert(!I->second.hasMaterializationSideEffectsOnly() &&
2629            "Can't resolve materialization-side-effects-only symbol");
2630     assert((KV.second.getFlags() & ~WeakFlags) == (I->second & ~WeakFlags) &&
2631            "Resolving symbol with incorrect flags");
2632   }
2633 #endif
2634 
2635   return MR.JD->resolve(MR, Symbols);
2636 }
2637 
2638 Error ExecutionSession::OL_notifyEmitted(MaterializationResponsibility &MR) {
2639   LLVM_DEBUG({
2640     dbgs() << "In " << MR.JD->getName() << " emitting " << MR.SymbolFlags << "\n";
2641   });
2642 
2643   if (auto Err = MR.JD->emit(MR, MR.SymbolFlags))
2644     return Err;
2645 
2646   MR.SymbolFlags.clear();
2647   return Error::success();
2648 }
2649 
2650 Error ExecutionSession::OL_defineMaterializing(
2651     MaterializationResponsibility &MR, SymbolFlagsMap NewSymbolFlags) {
2652 
2653   LLVM_DEBUG({
2654     dbgs() << "In " << MR.JD->getName() << " defining materializing symbols "
2655            << NewSymbolFlags << "\n";
2656   });
2657   if (auto AcceptedDefs = MR.JD->defineMaterializing(std::move(NewSymbolFlags))) {
2658     // Add all newly accepted symbols to this responsibility object.
2659     for (auto &KV : *AcceptedDefs)
2660       MR.SymbolFlags.insert(KV);
2661     return Error::success();
2662   } else
2663     return AcceptedDefs.takeError();
2664 }
2665 
2666 void ExecutionSession::OL_notifyFailed(MaterializationResponsibility &MR) {
2667 
2668   LLVM_DEBUG({
2669     dbgs() << "In " << MR.JD->getName() << " failing materialization for "
2670            << MR.SymbolFlags << "\n";
2671   });
2672 
2673   JITDylib::FailedSymbolsWorklist Worklist;
2674 
2675   for (auto &KV : MR.SymbolFlags)
2676     Worklist.push_back(std::make_pair(MR.JD.get(), KV.first));
2677   MR.SymbolFlags.clear();
2678 
2679   if (Worklist.empty())
2680     return;
2681 
2682   JITDylib::AsynchronousSymbolQuerySet FailedQueries;
2683   std::shared_ptr<SymbolDependenceMap> FailedSymbols;
2684 
2685   runSessionLocked([&]() {
2686     auto RTI = MR.JD->MRTrackers.find(&MR);
2687     assert(RTI != MR.JD->MRTrackers.end() && "No tracker for this");
2688     if (RTI->second->isDefunct())
2689       return;
2690 
2691     std::tie(FailedQueries, FailedSymbols) =
2692         JITDylib::failSymbols(std::move(Worklist));
2693   });
2694 
2695   for (auto &Q : FailedQueries)
2696     Q->handleFailed(make_error<FailedToMaterialize>(FailedSymbols));
2697 }
2698 
2699 Error ExecutionSession::OL_replace(MaterializationResponsibility &MR,
2700                                    std::unique_ptr<MaterializationUnit> MU) {
2701   for (auto &KV : MU->getSymbols()) {
2702     assert(MR.SymbolFlags.count(KV.first) &&
2703            "Replacing definition outside this responsibility set");
2704     MR.SymbolFlags.erase(KV.first);
2705   }
2706 
2707   if (MU->getInitializerSymbol() == MR.InitSymbol)
2708     MR.InitSymbol = nullptr;
2709 
2710   LLVM_DEBUG(MR.JD->getExecutionSession().runSessionLocked([&]() {
2711     dbgs() << "In " << MR.JD->getName() << " replacing symbols with " << *MU
2712            << "\n";
2713   }););
2714 
2715   return MR.JD->replace(MR, std::move(MU));
2716 }
2717 
2718 Expected<std::unique_ptr<MaterializationResponsibility>>
2719 ExecutionSession::OL_delegate(MaterializationResponsibility &MR,
2720                               const SymbolNameSet &Symbols) {
2721 
2722   SymbolStringPtr DelegatedInitSymbol;
2723   SymbolFlagsMap DelegatedFlags;
2724 
2725   for (auto &Name : Symbols) {
2726     auto I = MR.SymbolFlags.find(Name);
2727     assert(I != MR.SymbolFlags.end() &&
2728            "Symbol is not tracked by this MaterializationResponsibility "
2729            "instance");
2730 
2731     DelegatedFlags[Name] = std::move(I->second);
2732     if (Name == MR.InitSymbol)
2733       std::swap(MR.InitSymbol, DelegatedInitSymbol);
2734 
2735     MR.SymbolFlags.erase(I);
2736   }
2737 
2738   return MR.JD->delegate(MR, std::move(DelegatedFlags),
2739                          std::move(DelegatedInitSymbol));
2740 }
2741 
2742 void ExecutionSession::OL_addDependencies(
2743     MaterializationResponsibility &MR, const SymbolStringPtr &Name,
2744     const SymbolDependenceMap &Dependencies) {
2745   LLVM_DEBUG({
2746     dbgs() << "Adding dependencies for " << Name << ": " << Dependencies
2747            << "\n";
2748   });
2749   assert(MR.SymbolFlags.count(Name) &&
2750          "Symbol not covered by this MaterializationResponsibility instance");
2751   MR.JD->addDependencies(Name, Dependencies);
2752 }
2753 
2754 void ExecutionSession::OL_addDependenciesForAll(
2755     MaterializationResponsibility &MR,
2756     const SymbolDependenceMap &Dependencies) {
2757   LLVM_DEBUG({
2758     dbgs() << "Adding dependencies for all symbols in " << MR.SymbolFlags << ": "
2759            << Dependencies << "\n";
2760   });
2761   for (auto &KV : MR.SymbolFlags)
2762     MR.JD->addDependencies(KV.first, Dependencies);
2763 }
2764 
2765 #ifndef NDEBUG
2766 void ExecutionSession::dumpDispatchInfo(JITDylib &JD, MaterializationUnit &MU) {
2767   runSessionLocked([&]() {
2768     dbgs() << "Dispatching " << MU << " for " << JD.getName() << "\n";
2769   });
2770 }
2771 #endif // NDEBUG
2772 
2773 } // End namespace orc.
2774 } // End namespace llvm.
2775