12#include "llvm/Config/llvm-config.h"
19#include <condition_variable>
23#define DEBUG_TYPE "orc"
42void MaterializationUnit::anchor() {}
45 assert((
reinterpret_cast<uintptr_t
>(JD.get()) & 0x1) == 0 &&
46 "JITDylib must be two byte aligned");
48 JDAndFlag.store(
reinterpret_cast<uintptr_t
>(JD.get()));
64void ResourceTracker::makeDefunct() {
65 uintptr_t Val = JDAndFlag.load();
80 OS <<
"Resource tracker " << (
void *)RT.get() <<
" became defunct";
88 OS <<
"JITDylib " << JD->getName() <<
" (" << (
void *)JD.get()
93 std::shared_ptr<SymbolStringPool> SSP,
94 std::shared_ptr<SymbolDependenceMap> Symbols)
96 assert(this->SSP &&
"String pool cannot be null");
97 assert(!this->Symbols->empty() &&
"Can not fail to resolve an empty set");
101 for (
auto &[JD, Syms] : *this->Symbols)
106 for (
auto &[JD, Syms] : *Symbols)
115 OS <<
"Failed to materialize symbols: " << *Symbols;
119 std::shared_ptr<SymbolStringPool> SSP,
JITDylibSP JD,
121 std::string Explanation)
123 FailedSymbols(
std::
move(FailedSymbols)), BadDeps(
std::
move(BadDeps)),
124 Explanation(
std::
move(Explanation)) {}
131 OS <<
"In " << JD->getName() <<
", failed to materialize " << FailedSymbols
132 <<
", due to unsatisfied dependencies " << BadDeps;
133 if (!Explanation.empty())
134 OS <<
" (" << Explanation <<
")";
141 assert(!this->Symbols.
empty() &&
"Can not fail to resolve an empty set");
147 assert(!this->Symbols.empty() &&
"Can not fail to resolve an empty set");
155 OS <<
"Symbols not found: " << Symbols;
159 std::shared_ptr<SymbolStringPool> SSP,
SymbolNameSet Symbols)
161 assert(!this->Symbols.
empty() &&
"Can not fail to resolve an empty set");
169 OS <<
"Symbols could not be removed: " << Symbols;
177 OS <<
"Missing definitions in module " << ModuleName
186 OS <<
"Unexpected definitions in module " << ModuleName
191 JD->getExecutionSession().lookup(
194 [OnComplete = std::move(OnComplete)
201 assert(
Result->size() == 1 &&
"Unexpected number of results");
203 "Result does not contain expected symbol");
204 OnComplete(
Result->begin()->second);
206 OnComplete(
Result.takeError());
214 : NotifyComplete(
std::
move(NotifyComplete)), RequiredState(RequiredState) {
216 "Cannot query for a symbols that have not reached the resolve state "
219 OutstandingSymbolsCount = Symbols.size();
221 for (
auto &[Name, Flags] : Symbols)
227 auto I = ResolvedSymbols.find(Name);
228 assert(
I != ResolvedSymbols.end() &&
229 "Resolving symbol outside the requested set");
231 "Redundantly resolving symbol Name");
236 ResolvedSymbols.erase(
I);
238 I->second = std::move(Sym);
239 --OutstandingSymbolsCount;
243 assert(OutstandingSymbolsCount == 0 &&
244 "Symbols remain, handleComplete called prematurely");
246 class RunQueryCompleteTask :
public Task {
248 RunQueryCompleteTask(
SymbolMap ResolvedSymbols,
250 : ResolvedSymbols(
std::
move(ResolvedSymbols)),
251 NotifyComplete(
std::
move(NotifyComplete)) {}
253 OS <<
"Execute query complete callback for " << ResolvedSymbols;
255 void run()
override { NotifyComplete(std::move(ResolvedSymbols)); }
262 auto T = std::make_unique<RunQueryCompleteTask>(std::move(ResolvedSymbols),
263 std::move(NotifyComplete));
268void AsynchronousSymbolQuery::handleFailed(
Error Err) {
269 assert(QueryRegistrations.empty() && ResolvedSymbols.empty() &&
270 OutstandingSymbolsCount == 0 &&
271 "Query should already have been abandoned");
272 NotifyComplete(std::move(Err));
276void AsynchronousSymbolQuery::addQueryDependence(
JITDylib &JD,
278 bool Added = QueryRegistrations[&JD].insert(std::move(Name)).second;
280 assert(Added &&
"Duplicate dependence notification?");
283void AsynchronousSymbolQuery::removeQueryDependence(
285 auto QRI = QueryRegistrations.find(&JD);
286 assert(QRI != QueryRegistrations.end() &&
287 "No dependencies registered for JD");
288 assert(QRI->second.count(Name) &&
"No dependency on Name in JD");
289 QRI->second.erase(Name);
290 if (QRI->second.empty())
291 QueryRegistrations.erase(QRI);
295 auto I = ResolvedSymbols.find(Name);
296 assert(
I != ResolvedSymbols.end() &&
297 "Redundant removal of weakly-referenced symbol");
298 ResolvedSymbols.erase(
I);
299 --OutstandingSymbolsCount;
302void AsynchronousSymbolQuery::detach() {
303 ResolvedSymbols.clear();
304 OutstandingSymbolsCount = 0;
305 for (
auto &[JD, Syms] : QueryRegistrations)
306 JD->detachQueryHelper(*
this, Syms);
307 QueryRegistrations.clear();
314 SourceJDLookupFlags(SourceJDLookupFlags), Aliases(
std::
move(Aliases)) {}
317 return "<Reexports>";
320void ReExportsMaterializationUnit::materialize(
321 std::unique_ptr<MaterializationResponsibility> R) {
323 auto &ES = R->getTargetJITDylib().getExecutionSession();
324 JITDylib &TgtJD = R->getTargetJITDylib();
325 JITDylib &SrcJD = SourceJD ? *SourceJD : TgtJD;
330 auto RequestedSymbols = R->getRequestedSymbols();
333 for (
auto &Name : RequestedSymbols) {
334 auto I = Aliases.
find(Name);
335 assert(
I != Aliases.
end() &&
"Symbol not found in aliases map?");
336 RequestedAliases[Name] = std::move(
I->second);
342 dbgs() <<
"materializing reexports: target = " << TgtJD.
getName()
343 <<
", source = " << SrcJD.
getName() <<
" " << RequestedAliases
348 if (!Aliases.empty()) {
349 auto Err = SourceJD ?
R->replace(
reexports(*SourceJD, std::move(Aliases),
350 SourceJDLookupFlags))
357 R->failMaterialization();
364 struct OnResolveInfo {
365 OnResolveInfo(std::unique_ptr<MaterializationResponsibility> R,
366 SymbolAliasMap Aliases)
367 :
R(std::
move(
R)), Aliases(std::
move(Aliases)) {}
369 std::unique_ptr<MaterializationResponsibility>
R;
371 std::vector<SymbolDependenceGroup> SDGs;
382 std::vector<std::pair<SymbolLookupSet, std::shared_ptr<OnResolveInfo>>>
384 while (!RequestedAliases.
empty()) {
385 SymbolNameSet ResponsibilitySymbols;
386 SymbolLookupSet QuerySymbols;
387 SymbolAliasMap QueryAliases;
390 for (auto &[Alias, AliasInfo] : RequestedAliases) {
392 if (&SrcJD == &TgtJD && (QueryAliases.count(AliasInfo.Aliasee) ||
393 RequestedAliases.count(AliasInfo.Aliasee)))
396 ResponsibilitySymbols.insert(Alias);
397 QuerySymbols.add(AliasInfo.Aliasee,
398 AliasInfo.AliasFlags.hasMaterializationSideEffectsOnly()
399 ? SymbolLookupFlags::WeaklyReferencedSymbol
400 : SymbolLookupFlags::RequiredSymbol);
401 QueryAliases[Alias] = std::move(AliasInfo);
405 for (
auto &KV : QueryAliases)
406 RequestedAliases.
erase(KV.first);
408 assert(!QuerySymbols.empty() &&
"Alias cycle detected!");
410 auto NewR =
R->delegate(ResponsibilitySymbols);
413 R->failMaterialization();
417 auto QueryInfo = std::make_shared<OnResolveInfo>(std::move(*NewR),
418 std::move(QueryAliases));
419 QueryInfos.push_back(
420 make_pair(std::move(QuerySymbols), std::move(QueryInfo)));
424 while (!QueryInfos.empty()) {
425 auto QuerySymbols = std::move(QueryInfos.back().first);
426 auto QueryInfo = std::move(QueryInfos.back().second);
428 QueryInfos.pop_back();
430 auto RegisterDependencies = [QueryInfo,
437 assert(Deps.size() == 1 && Deps.count(&SrcJD) &&
438 "Unexpected dependencies for reexports");
440 auto &SrcJDDeps = Deps.find(&SrcJD)->second;
442 for (
auto &[Alias, AliasInfo] : QueryInfo->Aliases)
443 if (SrcJDDeps.count(AliasInfo.Aliasee))
444 QueryInfo->SDGs.push_back({{Alias}, {{&SrcJD, {AliasInfo.Aliasee}}}});
447 auto OnComplete = [QueryInfo](Expected<SymbolMap>
Result) {
448 auto &ES = QueryInfo->R->getTargetJITDylib().getExecutionSession();
451 for (
auto &KV : QueryInfo->Aliases) {
452 assert((KV.second.AliasFlags.hasMaterializationSideEffectsOnly() ||
453 Result->count(KV.second.Aliasee)) &&
454 "Result map missing entry?");
456 if (KV.second.AliasFlags.hasMaterializationSideEffectsOnly())
459 ResolutionMap[KV.first] = {(*Result)[KV.second.Aliasee].getAddress(),
460 KV.second.AliasFlags};
462 if (
auto Err = QueryInfo->R->notifyResolved(ResolutionMap)) {
464 QueryInfo->R->failMaterialization();
467 if (
auto Err = QueryInfo->R->notifyEmitted(QueryInfo->SDGs)) {
469 QueryInfo->R->failMaterialization();
474 QueryInfo->R->failMaterialization();
481 std::move(RegisterDependencies));
485void ReExportsMaterializationUnit::discard(
const JITDylib &JD,
486 const SymbolStringPtr &Name) {
487 assert(Aliases.count(Name) &&
488 "Symbol not covered by this MaterializationUnit");
492MaterializationUnit::Interface
493ReExportsMaterializationUnit::extractFlags(
const SymbolAliasMap &Aliases) {
495 for (
auto &KV : Aliases)
498 return MaterializationUnit::Interface(std::move(SymbolFlags),
nullptr);
509 return Flags.takeError();
512 for (
auto &Name : Symbols) {
513 assert(Flags->count(Name) &&
"Missing entry in flags map");
532 virtual void complete(std::unique_ptr<InProgressLookupState> IPLS) = 0;
549 } GenState = NotInGenerator;
560 OnComplete(
std::
move(OnComplete)) {}
562 void complete(std::unique_ptr<InProgressLookupState> IPLS)
override {
563 auto &ES =
SearchOrder.front().first->getExecutionSession();
564 ES.OL_completeLookupFlags(std::move(IPLS), std::move(OnComplete));
567 void fail(
Error Err)
override { OnComplete(std::move(Err)); }
578 std::shared_ptr<AsynchronousSymbolQuery> Q,
582 Q(
std::
move(Q)), RegisterDependencies(
std::
move(RegisterDependencies)) {
585 void complete(std::unique_ptr<InProgressLookupState> IPLS)
override {
586 auto &ES =
SearchOrder.front().first->getExecutionSession();
587 ES.OL_completeLookup(std::move(IPLS), std::move(Q),
588 std::move(RegisterDependencies));
593 Q->handleFailed(std::move(Err));
597 std::shared_ptr<AsynchronousSymbolQuery> Q;
604 : SourceJD(SourceJD), SourceJDLookupFlags(SourceJDLookupFlags),
611 assert(&JD != &SourceJD &&
"Cannot re-export from the same dylib");
615 K, {{&SourceJD, JDLookupFlags}}, LookupSet);
617 return Flags.takeError();
621 for (
auto &KV : *Flags)
622 if (!Allow || Allow(KV.first))
625 if (AliasMap.empty())
635void LookupState::reset(InProgressLookupState *IPLS) { this->IPLS.reset(IPLS); }
643 assert(IPLS &&
"Cannot call continueLookup on empty LookupState");
644 auto &ES = IPLS->SearchOrder.begin()->first->getExecutionSession();
645 ES.OL_applyQueryPhase1(std::move(IPLS), std::move(Err));
649 std::deque<LookupState> LookupsToFail;
651 std::lock_guard<std::mutex> Lock(M);
652 std::swap(PendingLookups, LookupsToFail);
656 for (
auto &LS : LookupsToFail)
658 "Query waiting on DefinitionGenerator that was destroyed",
667 std::vector<ResourceTrackerSP> TrackersToRemove;
668 ES.runSessionLocked([&]() {
669 assert(State != Closed &&
"JD is defunct");
670 for (
auto &KV : TrackerSymbols)
671 TrackersToRemove.push_back(KV.first);
676 for (
auto &RT : TrackersToRemove)
677 Err =
joinErrors(std::move(Err), RT->remove());
682 return ES.runSessionLocked([
this] {
683 assert(State != Closed &&
"JD is defunct");
686 return DefaultTracker;
691 return ES.runSessionLocked([
this] {
692 assert(State == Open &&
"JD is defunct");
701 std::shared_ptr<DefinitionGenerator> TmpDG;
703 ES.runSessionLocked([&] {
704 assert(State == Open &&
"JD is defunct");
706 [&](
const std::shared_ptr<DefinitionGenerator> &
H) {
707 return H.get() == &
G;
709 assert(
I != DefGenerators.end() &&
"Generator not found");
710 TmpDG = std::move(*
I);
711 DefGenerators.erase(
I);
720 if (FromMR.RT->isDefunct())
723 std::vector<NonOwningSymbolStringPtr> AddedSyms;
724 std::vector<NonOwningSymbolStringPtr> RejectedWeakDefs;
726 for (
auto &[Name, Flags] : SymbolFlags) {
727 auto EntryItr = Symbols.
find(Name);
730 if (EntryItr != Symbols.
end()) {
733 if (!Flags.isWeak()) {
735 for (
auto &S : AddedSyms)
740 std::string(*Name),
"defineMaterializing operation");
744 RejectedWeakDefs.push_back(NonOwningSymbolStringPtr(Name));
748 Symbols.
insert(std::make_pair(Name, SymbolTableEntry(Flags))).first;
750 AddedSyms.push_back(NonOwningSymbolStringPtr(Name));
755 while (!RejectedWeakDefs.empty()) {
757 RejectedWeakDefs.pop_back();
765 std::unique_ptr<MaterializationUnit> MU) {
766 assert(MU !=
nullptr &&
"Can not replace with a null MaterializationUnit");
767 std::unique_ptr<MaterializationUnit> MustRunMU;
768 std::unique_ptr<MaterializationResponsibility> MustRunMR;
771 ES.runSessionLocked([&,
this]() ->
Error {
772 if (FromMR.RT->isDefunct())
776 for (
auto &KV : MU->getSymbols()) {
777 auto SymI = Symbols.find(KV.first);
778 assert(SymI != Symbols.end() &&
"Replacing unknown symbol");
780 "Can not replace a symbol that ha is not materializing");
781 assert(!SymI->second.hasMaterializerAttached() &&
782 "Symbol should not have materializer attached already");
783 assert(UnmaterializedInfos.count(KV.first) == 0 &&
784 "Symbol being replaced should have no UnmaterializedInfo");
792 for (
auto &KV : MU->getSymbols()) {
793 auto MII = MaterializingInfos.find(KV.first);
794 if (MII != MaterializingInfos.end()) {
795 if (MII->second.hasQueriesPending()) {
796 MustRunMR = ES.createMaterializationResponsibility(
797 *FromMR.RT, std::move(MU->SymbolFlags),
798 std::move(MU->InitSymbol));
799 MustRunMU = std::move(MU);
806 auto UMI = std::make_shared<UnmaterializedInfo>(std::move(MU),
808 for (
auto &KV : UMI->MU->getSymbols()) {
809 auto SymI = Symbols.find(KV.first);
811 "Can not replace a symbol that is not materializing");
812 assert(!SymI->second.hasMaterializerAttached() &&
813 "Can not replace a symbol that has a materializer attached");
814 assert(UnmaterializedInfos.count(KV.first) == 0 &&
815 "Unexpected materializer entry in map");
816 SymI->second.setAddress(SymI->second.getAddress());
817 SymI->second.setMaterializerAttached(
true);
819 auto &UMIEntry = UnmaterializedInfos[KV.first];
820 assert((!UMIEntry || !UMIEntry->MU) &&
821 "Replacing symbol with materializer still attached");
832 assert(MustRunMR &&
"MustRunMU set implies MustRunMR set");
833 ES.dispatchTask(std::make_unique<MaterializationTask>(
834 std::move(MustRunMU), std::move(MustRunMR)));
836 assert(!MustRunMR &&
"MustRunMU unset implies MustRunMR unset");
842Expected<std::unique_ptr<MaterializationResponsibility>>
846 return ES.runSessionLocked(
847 [&]() -> Expected<std::unique_ptr<MaterializationResponsibility>> {
848 if (FromMR.RT->isDefunct())
851 return ES.createMaterializationResponsibility(
852 *FromMR.RT, std::move(SymbolFlags), std::move(InitSymbol));
857JITDylib::getRequestedSymbols(
const SymbolFlagsMap &SymbolFlags)
const {
858 return ES.runSessionLocked([&]() {
861 for (
auto &KV : SymbolFlags) {
862 assert(Symbols.count(KV.first) &&
"JITDylib does not cover this symbol?");
863 assert(Symbols.find(KV.first)->second.getState() !=
866 "getRequestedSymbols can only be called for symbols that have "
867 "started materializing");
868 auto I = MaterializingInfos.find(KV.first);
869 if (
I == MaterializingInfos.end())
872 if (
I->second.hasQueriesPending())
873 RequestedSymbols.insert(KV.first);
876 return RequestedSymbols;
882 AsynchronousSymbolQuerySet CompletedQueries;
884 if (
auto Err = ES.runSessionLocked([&,
this]() ->
Error {
885 if (MR.RT->isDefunct())
886 return make_error<ResourceTrackerDefunct>(MR.RT);
889 return make_error<StringError>(
"JITDylib " + getName() +
891 inconvertibleErrorCode());
893 struct WorklistEntry {
894 SymbolTable::iterator SymI;
895 ExecutorSymbolDef ResolvedSym;
899 std::vector<WorklistEntry> Worklist;
905 assert(!KV.second.getFlags().hasError() &&
906 "Resolution result can not have error flag set");
908 auto SymI = Symbols.find(KV.first);
910 assert(SymI != Symbols.end() &&
"Symbol not found");
911 assert(!SymI->second.hasMaterializerAttached() &&
912 "Resolving symbol with materializer attached?");
914 "Symbol should be materializing");
915 assert(SymI->second.getAddress() == ExecutorAddr() &&
916 "Symbol has already been resolved");
918 if (SymI->second.getFlags().hasError())
919 SymbolsInErrorState.insert(KV.first);
922 [[maybe_unused]]
auto WeakOrCommon =
924 assert((KV.second.getFlags() & WeakOrCommon) &&
925 "Common symbols must be resolved as common or weak");
926 assert((KV.second.getFlags() & ~WeakOrCommon) ==
928 "Resolving symbol with incorrect flags");
931 assert(KV.second.getFlags() == SymI->second.getFlags() &&
932 "Resolved flags should match the declared flags");
935 {SymI, {KV.second.getAddress(), SymI->second.getFlags()}});
940 if (!SymbolsInErrorState.empty()) {
941 auto FailedSymbolsDepMap = std::make_shared<SymbolDependenceMap>();
942 (*FailedSymbolsDepMap)[this] = std::move(SymbolsInErrorState);
943 return make_error<FailedToMaterialize>(
944 getExecutionSession().getSymbolStringPool(),
945 std::move(FailedSymbolsDepMap));
948 while (!Worklist.empty()) {
949 auto SymI = Worklist.back().SymI;
950 auto ResolvedSym = Worklist.back().ResolvedSym;
953 auto &Name = SymI->first;
956 JITSymbolFlags ResolvedFlags = ResolvedSym.getFlags();
957 SymI->second.setAddress(ResolvedSym.getAddress());
958 SymI->second.setFlags(ResolvedFlags);
959 SymI->second.setState(SymbolState::Resolved);
961 auto MII = MaterializingInfos.find(Name);
962 if (MII == MaterializingInfos.end())
965 auto &MI = MII->second;
966 for (auto &Q : MI.takeQueriesMeeting(SymbolState::Resolved)) {
967 Q->notifySymbolMetRequiredState(Name, ResolvedSym);
969 CompletedQueries.insert(std::move(Q));
978 for (
auto &Q : CompletedQueries) {
979 assert(Q->isComplete() &&
"Q not completed");
980 Q->handleComplete(ES);
986void JITDylib::unlinkMaterializationResponsibility(
987 MaterializationResponsibility &MR) {
989 auto I = TrackerMRs.find(MR.RT.get());
990 assert(
I != TrackerMRs.end() &&
"No MRs in TrackerMRs list for RT");
991 assert(
I->second.count(&MR) &&
"MR not in TrackerMRs list for RT");
992 I->second.erase(&MR);
993 if (
I->second.empty())
994 TrackerMRs.erase(MR.RT.get());
998void JITDylib::shrinkMaterializationInfoMemory() {
1002 if (UnmaterializedInfos.empty())
1003 UnmaterializedInfos.clear();
1005 if (MaterializingInfos.empty())
1006 MaterializingInfos.clear();
1010 bool LinkAgainstThisJITDylibFirst) {
1011 ES.runSessionLocked([&]() {
1012 assert(State == Open &&
"JD is defunct");
1013 if (LinkAgainstThisJITDylibFirst) {
1015 if (NewLinkOrder.empty() || NewLinkOrder.front().first !=
this)
1016 LinkOrder.push_back(
1020 LinkOrder = std::move(NewLinkOrder);
1025 ES.runSessionLocked([&]() {
1026 for (
auto &KV : NewLinks) {
1031 LinkOrder.push_back(std::move(KV));
1037 ES.runSessionLocked([&]() { LinkOrder.push_back({&JD, JDLookupFlags}); });
1042 ES.runSessionLocked([&]() {
1043 assert(State == Open &&
"JD is defunct");
1044 for (
auto &KV : LinkOrder)
1045 if (KV.first == &OldJD) {
1046 KV = {&NewJD, JDLookupFlags};
1053 ES.runSessionLocked([&]() {
1054 assert(State == Open &&
"JD is defunct");
1056 [&](
const JITDylibSearchOrder::value_type &KV) {
1057 return KV.first == &JD;
1059 if (
I != LinkOrder.end())
1065 return ES.runSessionLocked([&]() ->
Error {
1066 assert(State == Open &&
"JD is defunct");
1067 using SymbolMaterializerItrPair =
1068 std::pair<SymbolTable::iterator, UnmaterializedInfosMap::iterator>;
1069 std::vector<SymbolMaterializerItrPair> SymbolsToRemove;
1073 for (
auto &Name : Names) {
1074 auto I = Symbols.find(Name);
1077 if (
I == Symbols.end()) {
1078 Missing.insert(Name);
1089 auto UMII =
I->second.hasMaterializerAttached()
1090 ? UnmaterializedInfos.find(Name)
1091 : UnmaterializedInfos.end();
1092 SymbolsToRemove.push_back(std::make_pair(
I, UMII));
1096 if (!Missing.empty())
1098 std::move(Missing));
1106 for (
auto &SymbolMaterializerItrPair : SymbolsToRemove) {
1107 auto UMII = SymbolMaterializerItrPair.second;
1110 if (UMII != UnmaterializedInfos.end()) {
1111 UMII->second->MU->doDiscard(*
this, UMII->first);
1112 UnmaterializedInfos.erase(UMII);
1115 auto SymI = SymbolMaterializerItrPair.first;
1116 Symbols.erase(SymI);
1119 shrinkMaterializationInfoMemory();
1126 ES.runSessionLocked([&,
this]() {
1127 OS <<
"JITDylib \"" <<
getName() <<
"\" (ES: "
1128 <<
format(
"0x%016" PRIx64,
reinterpret_cast<uintptr_t
>(&ES))
1142 if (State == Closed)
1144 OS <<
"Link order: " << LinkOrder <<
"\n"
1145 <<
"Symbol table:\n";
1148 std::vector<std::pair<SymbolStringPtr, SymbolTableEntry *>> SymbolsSorted;
1149 for (
auto &KV : Symbols)
1150 SymbolsSorted.emplace_back(KV.first, &KV.second);
1151 std::sort(SymbolsSorted.begin(), SymbolsSorted.end(),
1152 [](
const auto &L,
const auto &R) { return *L.first < *R.first; });
1154 for (
auto &KV : SymbolsSorted) {
1155 OS <<
" \"" << *KV.first <<
"\": ";
1156 if (
auto Addr = KV.second->getAddress())
1159 OS <<
"<not resolved> ";
1161 OS <<
" " << KV.second->getFlags() <<
" " << KV.second->getState();
1163 if (KV.second->hasMaterializerAttached()) {
1164 OS <<
" (Materializer ";
1165 auto I = UnmaterializedInfos.find(KV.first);
1166 assert(
I != UnmaterializedInfos.end() &&
1167 "Lazy symbol should have UnmaterializedInfo");
1168 OS <<
I->second->MU.get() <<
", " <<
I->second->MU->getName() <<
")\n";
1173 if (!MaterializingInfos.empty())
1174 OS <<
" MaterializingInfos entries:\n";
1175 for (
auto &KV : MaterializingInfos) {
1176 OS <<
" \"" << *KV.first <<
"\":\n"
1177 <<
" " << KV.second.pendingQueries().size()
1178 <<
" pending queries: { ";
1179 for (
const auto &Q : KV.second.pendingQueries())
1180 OS << Q.get() <<
" (" << Q->getRequiredState() <<
") ";
1186void JITDylib::MaterializingInfo::addQuery(
1187 std::shared_ptr<AsynchronousSymbolQuery> Q) {
1191 [](
const std::shared_ptr<AsynchronousSymbolQuery> &V,
SymbolState S) {
1192 return V->getRequiredState() <= S;
1194 PendingQueries.insert(
I.base(), std::move(Q));
1197void JITDylib::MaterializingInfo::removeQuery(
1198 const AsynchronousSymbolQuery &Q) {
1201 PendingQueries, [&Q](
const std::shared_ptr<AsynchronousSymbolQuery> &V) {
1202 return V.get() == &Q;
1204 if (
I != PendingQueries.end())
1205 PendingQueries.erase(
I);
1208JITDylib::AsynchronousSymbolQueryList
1209JITDylib::MaterializingInfo::takeQueriesMeeting(SymbolState RequiredState) {
1210 AsynchronousSymbolQueryList
Result;
1211 while (!PendingQueries.empty()) {
1212 if (PendingQueries.back()->getRequiredState() > RequiredState)
1215 Result.push_back(std::move(PendingQueries.back()));
1216 PendingQueries.pop_back();
1222JITDylib::JITDylib(ExecutionSession &ES, std::string Name)
1223 : JITLinkDylib(std::
move(
Name)), ES(ES) {
1227JITDylib::RemoveTrackerResult JITDylib::IL_removeTracker(
ResourceTracker &RT) {
1229 assert(State != Closed &&
"JD is defunct");
1234 if (&RT == DefaultTracker.get()) {
1236 for (
auto &KV : TrackerSymbols)
1239 for (
auto &KV : Symbols) {
1240 auto &Sym = KV.first;
1241 if (!TrackedSymbols.count(Sym))
1242 SymbolsToRemove.push_back(Sym);
1245 DefaultTracker.reset();
1248 auto I = TrackerSymbols.find(&RT);
1249 if (
I != TrackerSymbols.end()) {
1250 SymbolsToRemove = std::move(
I->second);
1251 TrackerSymbols.erase(
I);
1256 for (
auto &Sym : SymbolsToRemove) {
1257 assert(Symbols.count(Sym) &&
"Symbol not in symbol table");
1260 auto MII = MaterializingInfos.find(Sym);
1261 if (MII != MaterializingInfos.end())
1262 SymbolsToFail.push_back(Sym);
1265 auto [QueriesToFail, FailedSymbols] =
1266 ES.IL_failSymbols(*
this, std::move(SymbolsToFail));
1268 std::vector<std::unique_ptr<MaterializationUnit>> DefunctMUs;
1271 for (
auto &Sym : SymbolsToRemove) {
1272 auto I = Symbols.find(Sym);
1273 assert(
I != Symbols.end() &&
"Symbol not present in table");
1276 if (
I->second.hasMaterializerAttached()) {
1278 auto J = UnmaterializedInfos.find(Sym);
1279 assert(J != UnmaterializedInfos.end() &&
1280 "Symbol table indicates MU present, but no UMI record");
1282 DefunctMUs.push_back(std::move(J->second->MU));
1283 UnmaterializedInfos.erase(J);
1285 assert(!UnmaterializedInfos.count(Sym) &&
1286 "Symbol has materializer attached");
1292 shrinkMaterializationInfoMemory();
1294 return {std::move(QueriesToFail), std::move(FailedSymbols),
1295 std::move(DefunctMUs)};
1299 assert(State != Closed &&
"JD is defunct");
1300 assert(&DstRT != &SrcRT &&
"No-op transfers shouldn't call transferTracker");
1301 assert(&DstRT.getJITDylib() ==
this &&
"DstRT is not for this JITDylib");
1302 assert(&SrcRT.getJITDylib() ==
this &&
"SrcRT is not for this JITDylib");
1305 for (
auto &KV : UnmaterializedInfos) {
1306 if (KV.second->RT == &SrcRT)
1307 KV.second->RT = &DstRT;
1312 auto I = TrackerMRs.find(&SrcRT);
1313 if (
I != TrackerMRs.end()) {
1314 auto &SrcMRs =
I->second;
1315 auto &DstMRs = TrackerMRs[&DstRT];
1316 for (
auto *MR : SrcMRs)
1319 DstMRs = std::move(SrcMRs);
1321 DstMRs.insert_range(SrcMRs);
1324 TrackerMRs.erase(&SrcRT);
1330 if (&DstRT == DefaultTracker.get()) {
1331 TrackerSymbols.erase(&SrcRT);
1337 if (&SrcRT == DefaultTracker.get()) {
1338 assert(!TrackerSymbols.count(&SrcRT) &&
1339 "Default tracker should not appear in TrackerSymbols");
1344 for (
auto &KV : TrackerSymbols)
1347 for (
auto &KV : Symbols) {
1348 auto &Sym = KV.first;
1349 if (!CurrentlyTrackedSymbols.count(Sym))
1350 SymbolsToTrack.push_back(Sym);
1353 TrackerSymbols[&DstRT] = std::move(SymbolsToTrack);
1357 auto &DstTrackedSymbols = TrackerSymbols[&DstRT];
1361 auto SI = TrackerSymbols.find(&SrcRT);
1362 if (SI == TrackerSymbols.end())
1365 DstTrackedSymbols.reserve(DstTrackedSymbols.size() +
SI->second.size());
1366 for (
auto &Sym :
SI->second)
1367 DstTrackedSymbols.push_back(std::move(Sym));
1368 TrackerSymbols.erase(SI);
1375 std::vector<SymbolStringPtr> ExistingDefsOverridden;
1376 std::vector<SymbolStringPtr> MUDefsOverridden;
1378 for (
const auto &KV : MU.getSymbols()) {
1379 auto I = Symbols.find(KV.first);
1381 if (
I != Symbols.end()) {
1382 if (KV.second.isStrong()) {
1383 if (
I->second.getFlags().isStrong() ||
1385 Duplicates.insert(KV.first);
1388 "Overridden existing def should be in the never-searched "
1390 ExistingDefsOverridden.push_back(KV.first);
1393 MUDefsOverridden.push_back(KV.first);
1398 if (!Duplicates.empty()) {
1400 {
dbgs() <<
" Error: Duplicate symbols " << Duplicates <<
"\n"; });
1402 MU.getName().str());
1407 if (!MUDefsOverridden.empty())
1408 dbgs() <<
" Defs in this MU overridden: " << MUDefsOverridden <<
"\n";
1410 for (
auto &S : MUDefsOverridden)
1411 MU.doDiscard(*
this, S);
1415 if (!ExistingDefsOverridden.empty())
1416 dbgs() <<
" Existing defs overridden by this MU: " << MUDefsOverridden
1419 for (
auto &S : ExistingDefsOverridden) {
1421 auto UMII = UnmaterializedInfos.find(S);
1422 assert(UMII != UnmaterializedInfos.end() &&
1423 "Overridden existing def should have an UnmaterializedInfo");
1424 UMII->second->MU->doDiscard(*
this, S);
1428 for (
auto &KV : MU.getSymbols()) {
1429 auto &SymEntry = Symbols[KV.first];
1430 SymEntry.setFlags(KV.second);
1432 SymEntry.setMaterializerAttached(
true);
1438void JITDylib::installMaterializationUnit(
1442 if (&RT != DefaultTracker.get()) {
1443 auto &TS = TrackerSymbols[&RT];
1444 TS.reserve(TS.size() + MU->getSymbols().size());
1445 for (
auto &KV : MU->getSymbols())
1446 TS.push_back(KV.first);
1449 auto UMI = std::make_shared<UnmaterializedInfo>(std::move(MU), &RT);
1450 for (
auto &KV : UMI->MU->getSymbols())
1451 UnmaterializedInfos[KV.first] = UMI;
1456 for (
auto &QuerySymbol : QuerySymbols) {
1457 auto MII = MaterializingInfos.find(QuerySymbol);
1458 if (MII != MaterializingInfos.end())
1459 MII->second.removeQuery(Q);
1471 std::mutex LookupMutex;
1472 std::condition_variable CV;
1476 dbgs() <<
"Issuing init-symbol lookup:\n";
1477 for (
auto &KV : InitSyms)
1478 dbgs() <<
" " << KV.first->getName() <<
": " << KV.second <<
"\n";
1481 for (
auto &KV : InitSyms) {
1482 auto *JD = KV.first;
1483 auto Names = std::move(KV.second);
1490 std::lock_guard<std::mutex> Lock(LookupMutex);
1494 "Duplicate JITDylib in lookup?");
1495 CompoundResult[JD] = std::move(*
Result);
1505 std::unique_lock<std::mutex> Lock(LookupMutex);
1506 CV.wait(Lock, [&] {
return Count == 0; });
1509 return std::move(CompoundErr);
1511 return std::move(CompoundResult);
1518 class TriggerOnComplete {
1521 TriggerOnComplete(OnCompleteFn OnComplete)
1522 : OnComplete(std::move(OnComplete)) {}
1523 ~TriggerOnComplete() { OnComplete(std::move(LookupResult)); }
1524 void reportResult(
Error Err) {
1525 std::lock_guard<std::mutex> Lock(ResultMutex);
1526 LookupResult =
joinErrors(std::move(LookupResult), std::move(Err));
1530 std::mutex ResultMutex;
1532 OnCompleteFn OnComplete;
1536 dbgs() <<
"Issuing init-symbol lookup:\n";
1537 for (
auto &KV : InitSyms)
1538 dbgs() <<
" " << KV.first->getName() <<
": " << KV.second <<
"\n";
1541 auto TOC = std::make_shared<TriggerOnComplete>(std::move(OnComplete));
1543 for (
auto &KV : InitSyms) {
1544 auto *JD = KV.first;
1545 auto Names = std::move(KV.second);
1551 TOC->reportResult(
Result.takeError());
1560 MR->failMaterialization();
1564 OS <<
"Materialization task: " << MU->getName() <<
" in "
1565 << MR->getTargetJITDylib().getName();
1569 assert(MU &&
"MU should not be null");
1570 assert(MR &&
"MR should not be null");
1571 MU->materialize(std::move(MR));
1581 this->EPC->ES =
this;
1587 "Session still open. Did you forget to call endSession?");
1591 LLVM_DEBUG(
dbgs() <<
"Ending ExecutionSession " <<
this <<
"\n");
1595#ifdef EXPENSIVE_CHECKS
1596 verifySessionState(
"Entering ExecutionSession::endSession");
1599 SessionOpen =
false;
1603 std::reverse(JDsToRemove.begin(), JDsToRemove.end());
1607 Err =
joinErrors(std::move(Err), EPC->disconnect());
1618 assert(!ResourceManagers.empty() &&
"No managers registered");
1619 if (ResourceManagers.back() == &RM)
1620 ResourceManagers.pop_back();
1623 assert(
I != ResourceManagers.end() &&
"RM not registered");
1624 ResourceManagers.erase(
I);
1631 for (
auto &JD : JDs)
1632 if (JD->getName() == Name)
1641 assert(SessionOpen &&
"Cannot create JITDylib after session is closed");
1642 JDs.push_back(
new JITDylib(*
this, std::move(Name)));
1650 if (
auto Err = P->setupJITDylib(JD))
1651 return std::move(Err);
1658 for (
auto &JD : JDsToRemove) {
1659 assert(JD->State == JITDylib::Open &&
"JD already closed");
1660 JD->State = JITDylib::Closing;
1662 assert(
I != JDs.end() &&
"JD does not appear in session JDs");
1669 for (
auto JD : JDsToRemove) {
1670 Err =
joinErrors(std::move(Err), JD->clear());
1672 Err =
joinErrors(std::move(Err), P->teardownJITDylib(*JD));
1677 for (
auto &JD : JDsToRemove) {
1678 assert(JD->State == JITDylib::Closing &&
"JD should be closing");
1679 JD->State = JITDylib::Closed;
1680 assert(JD->Symbols.empty() &&
"JD.Symbols is not empty after clear");
1681 assert(JD->UnmaterializedInfos.empty() &&
1682 "JD.UnmaterializedInfos is not empty after clear");
1683 assert(JD->MaterializingInfos.empty() &&
1684 "JD.MaterializingInfos is not empty after clear");
1685 assert(JD->TrackerSymbols.empty() &&
1686 "TrackerSymbols is not empty after clear");
1687 JD->DefGenerators.clear();
1688 JD->LinkOrder.clear();
1698 return std::vector<JITDylibSP>();
1700 auto &ES = JDs.
front()->getExecutionSession();
1701 return ES.runSessionLocked([&]() ->
Expected<std::vector<JITDylibSP>> {
1703 std::vector<JITDylibSP>
Result;
1705 for (
auto &JD : JDs) {
1707 if (JD->State != Open)
1709 "Error building link order: " + JD->getName() +
" is defunct",
1711 if (Visited.
count(JD.get()))
1716 Visited.
insert(JD.get());
1718 while (!WorkStack.
empty()) {
1719 Result.push_back(std::move(WorkStack.
back()));
1723 auto &JD = *KV.first;
1724 if (!Visited.
insert(&JD).second)
1754 OL_applyQueryPhase1(std::make_unique<InProgressLookupFlagsState>(
1755 K, std::move(SearchOrder), std::move(LookupSet),
1756 std::move(OnComplete)),
1764 std::promise<MSVCPExpected<SymbolFlagsMap>> ResultP;
1765 OL_applyQueryPhase1(std::make_unique<InProgressLookupFlagsState>(
1766 K, std::move(SearchOrder), std::move(LookupSet),
1768 ResultP.set_value(std::move(
Result));
1772 auto ResultF = ResultP.get_future();
1773 return ResultF.
get();
1784 dbgs() <<
"Looking up " << Symbols <<
" in " << SearchOrder
1785 <<
" (required state: " << RequiredState <<
")\n";
1792 dispatchOutstandingMUs();
1794 auto Unresolved = std::move(Symbols);
1795 auto Q = std::make_shared<AsynchronousSymbolQuery>(Unresolved, RequiredState,
1796 std::move(NotifyComplete));
1798 auto IPLS = std::make_unique<InProgressFullLookupState>(
1799 K, SearchOrder, std::move(Unresolved), RequiredState, std::move(Q),
1800 std::move(RegisterDependencies));
1810#if LLVM_ENABLE_THREADS
1812 std::promise<MSVCPExpected<SymbolMap>> PromisedResult;
1815 PromisedResult.set_value(std::move(R));
1827 ResolutionError = R.takeError();
1832 lookup(K, SearchOrder, std::move(Symbols), RequiredState,
1833 std::move(NotifyComplete), RegisterDependencies);
1835#if LLVM_ENABLE_THREADS
1836 return PromisedResult.get_future().get();
1838 if (ResolutionError)
1839 return std::move(ResolutionError);
1852 assert(ResultMap->size() == 1 &&
"Unexpected number of results");
1853 assert(ResultMap->count(Name) &&
"Missing result for symbol");
1854 return std::move(ResultMap->begin()->second);
1856 return ResultMap.takeError();
1868 return lookup(SearchOrder,
intern(Name), RequiredState);
1878 return TagSyms.takeError();
1881 std::lock_guard<std::mutex> Lock(JITDispatchHandlersMutex);
1884 for (
auto &[TagName, TagSym] : *TagSyms) {
1885 auto TagAddr = TagSym.getAddress();
1886 if (JITDispatchHandlers.count(TagAddr))
1888 " (for " + *TagName +
1889 ") already registered",
1894 for (
auto &[TagName, TagSym] : *TagSyms) {
1895 auto TagAddr = TagSym.getAddress();
1896 auto I = WFs.
find(TagName);
1898 "JITDispatchHandler implementation missing");
1899 JITDispatchHandlers[TagAddr] =
1900 std::make_shared<JITDispatchHandlerFunction>(std::move(
I->second));
1902 dbgs() <<
"Associated function tag \"" << *TagName <<
"\" ("
1903 <<
formatv(
"{0:x}", TagAddr) <<
") with handler\n";
1914 std::shared_ptr<JITDispatchHandlerFunction>
F;
1916 std::lock_guard<std::mutex> Lock(JITDispatchHandlersMutex);
1917 auto I = JITDispatchHandlers.find(HandlerFnTagAddr);
1918 if (
I != JITDispatchHandlers.end())
1923 (*F)(std::move(SendResult), ArgBytes.
data(), ArgBytes.
size());
1926 (
"No function registered for tag " +
1927 formatv(
"{0:x16}", HandlerFnTagAddr))
1933 for (
auto &JD : JDs)
1938#ifdef EXPENSIVE_CHECKS
1939bool ExecutionSession::verifySessionState(
Twine Phase) {
1943 for (
auto &JD : JDs) {
1946 auto &Stream =
errs();
1948 Stream <<
"ERROR: Bad ExecutionSession state detected " <<
Phase
1950 Stream <<
" In JITDylib " << JD->getName() <<
", ";
1955 if (JD->State != JITDylib::Open) {
1957 <<
"state is not Open, but JD is in ExecutionSession list.";
1965 for (
auto &[Sym, Entry] : JD->Symbols) {
1968 if (Entry.getAddress()) {
1969 LogFailure() <<
"symbol " << Sym <<
" has state "
1971 <<
" (not-yet-resolved) but non-null address "
1972 << Entry.getAddress() <<
".\n";
1977 auto UMIItr = JD->UnmaterializedInfos.find(Sym);
1978 if (
Entry.hasMaterializerAttached()) {
1979 if (UMIItr == JD->UnmaterializedInfos.end()) {
1980 LogFailure() <<
"symbol " << Sym
1981 <<
" entry claims materializer attached, but "
1982 "UnmaterializedInfos has no corresponding entry.\n";
1984 }
else if (UMIItr != JD->UnmaterializedInfos.end()) {
1987 <<
" entry claims no materializer attached, but "
1988 "UnmaterializedInfos has an unexpected entry for it.\n";
1994 for (
auto &[Sym, UMI] : JD->UnmaterializedInfos) {
1995 auto SymItr = JD->Symbols.find(Sym);
1996 if (SymItr == JD->Symbols.end()) {
1999 <<
" has UnmaterializedInfos entry, but no Symbols entry.\n";
2004 for (
auto &[Sym, MII] : JD->MaterializingInfos) {
2006 auto SymItr = JD->Symbols.find(Sym);
2007 if (SymItr == JD->Symbols.end()) {
2012 <<
" has MaterializingInfos entry, but no Symbols entry.\n";
2020 <<
" is in Ready state, should not have MaterializingInfo.\n";
2025 static_cast<std::underlying_type_t<SymbolState>
>(
2026 SymItr->second.getState()) + 1);
2027 for (
auto &Q : MII.PendingQueries) {
2028 if (Q->getRequiredState() != CurState) {
2029 if (Q->getRequiredState() > CurState)
2030 CurState = Q->getRequiredState();
2032 LogFailure() <<
"symbol " << Sym
2033 <<
" has stale or misordered queries.\n";
2045void ExecutionSession::dispatchOutstandingMUs() {
2048 std::optional<std::pair<std::unique_ptr<MaterializationUnit>,
2049 std::unique_ptr<MaterializationResponsibility>>>
2053 std::lock_guard<std::recursive_mutex> Lock(OutstandingMUsMutex);
2054 if (!OutstandingMUs.empty()) {
2055 JMU.emplace(std::move(OutstandingMUs.back()));
2056 OutstandingMUs.pop_back();
2063 assert(JMU->first &&
"No MU?");
2064 LLVM_DEBUG(
dbgs() <<
" Dispatching \"" << JMU->first->getName() <<
"\"\n");
2065 dispatchTask(std::make_unique<MaterializationTask>(std::move(JMU->first),
2066 std::move(JMU->second)));
2068 LLVM_DEBUG(
dbgs() <<
"Done dispatching MaterializationUnits.\n");
2073 dbgs() <<
"In " << RT.getJITDylib().getName() <<
" removing tracker "
2074 <<
formatv(
"{0:x}", RT.getKeyUnsafe()) <<
"\n";
2076 std::vector<ResourceManager *> CurrentResourceManagers;
2078 JITDylib::RemoveTrackerResult
R;
2081 CurrentResourceManagers = ResourceManagers;
2083 R = RT.getJITDylib().IL_removeTracker(RT);
2087 R.DefunctMUs.clear();
2091 auto &JD = RT.getJITDylib();
2092 for (
auto *L :
reverse(CurrentResourceManagers))
2094 L->handleRemoveResources(JD, RT.getKeyUnsafe()));
2096 for (
auto &Q :
R.QueriesToFail)
2106 dbgs() <<
"In " << SrcRT.getJITDylib().getName()
2107 <<
" transfering resources from tracker "
2108 <<
formatv(
"{0:x}", SrcRT.getKeyUnsafe()) <<
" to tracker "
2109 <<
formatv(
"{0:x}", DstRT.getKeyUnsafe()) <<
"\n";
2113 if (&DstRT == &SrcRT)
2116 assert(&DstRT.getJITDylib() == &SrcRT.getJITDylib() &&
2117 "Can't transfer resources between JITDylibs");
2119 SrcRT.makeDefunct();
2120 auto &JD = DstRT.getJITDylib();
2121 JD.transferTracker(DstRT, SrcRT);
2122 for (
auto *L :
reverse(ResourceManagers))
2123 L->handleTransferResources(JD, DstRT.getKeyUnsafe(),
2124 SrcRT.getKeyUnsafe());
2131 dbgs() <<
"In " << RT.getJITDylib().getName() <<
" destroying tracker "
2132 <<
formatv(
"{0:x}", RT.getKeyUnsafe()) <<
"\n";
2134 if (!RT.isDefunct())
2135 transferResourceTracker(*RT.getJITDylib().getDefaultResourceTracker(),
2140Error ExecutionSession::IL_updateCandidatesFor(
2143 return Candidates.forEachWithRemoval(
2144 [&](
const SymbolStringPtr &Name,
2148 auto SymI = JD.Symbols.find(Name);
2149 if (SymI == JD.Symbols.end())
2157 if (!SymI->second.getFlags().isExported() &&
2160 NonCandidates->add(Name, SymLookupFlags);
2169 if (SymI->second.getFlags().hasMaterializationSideEffectsOnly() &&
2176 if (SymI->second.getFlags().hasError()) {
2177 auto FailedSymbolsMap = std::make_shared<SymbolDependenceMap>();
2178 (*FailedSymbolsMap)[&JD] = {
Name};
2180 std::move(FailedSymbolsMap));
2188void ExecutionSession::OL_resumeLookupAfterGeneration(
2192 "Should not be called for not-in-generator lookups");
2197 if (
auto DG = IPLS.CurDefGeneratorStack.back().lock()) {
2198 IPLS.CurDefGeneratorStack.pop_back();
2199 std::lock_guard<std::mutex> Lock(DG->M);
2203 if (DG->PendingLookups.empty()) {
2209 LS = std::move(DG->PendingLookups.front());
2210 DG->PendingLookups.pop_front();
2215 dispatchTask(std::make_unique<LookupTask>(std::move(LS)));
2219void ExecutionSession::OL_applyQueryPhase1(
2220 std::unique_ptr<InProgressLookupState> IPLS,
Error Err) {
2223 dbgs() <<
"Entering OL_applyQueryPhase1:\n"
2224 <<
" Lookup kind: " << IPLS->K <<
"\n"
2225 <<
" Search order: " << IPLS->SearchOrder
2226 <<
", Current index = " << IPLS->CurSearchOrderIndex
2227 << (IPLS->NewJITDylib ?
" (entering new JITDylib)" :
"") <<
"\n"
2228 <<
" Lookup set: " << IPLS->LookupSet <<
"\n"
2229 <<
" Definition generator candidates: "
2230 << IPLS->DefGeneratorCandidates <<
"\n"
2231 <<
" Definition generator non-candidates: "
2232 << IPLS->DefGeneratorNonCandidates <<
"\n";
2236 OL_resumeLookupAfterGeneration(*IPLS);
2239 "Lookup should not be in InGenerator state here");
2246 while (IPLS->CurSearchOrderIndex != IPLS->SearchOrder.size()) {
2252 return IPLS->fail(std::move(Err));
2255 auto &KV = IPLS->SearchOrder[IPLS->CurSearchOrderIndex];
2256 auto &JD = *KV.first;
2257 auto JDLookupFlags = KV.second;
2260 dbgs() <<
"Visiting \"" << JD.getName() <<
"\" (" << JDLookupFlags
2261 <<
") with lookup set " << IPLS->LookupSet <<
":\n";
2265 if (IPLS->NewJITDylib) {
2269 SymbolLookupSet Tmp;
2270 std::swap(IPLS->DefGeneratorNonCandidates, Tmp);
2271 IPLS->DefGeneratorCandidates.append(std::move(Tmp));
2274 dbgs() <<
" First time visiting " << JD.getName()
2275 <<
", resetting candidate sets and building generator stack\n";
2280 IPLS->CurDefGeneratorStack.reserve(JD.DefGenerators.size());
2286 IPLS->NewJITDylib =
false;
2295 Err = IL_updateCandidatesFor(
2296 JD, JDLookupFlags, IPLS->DefGeneratorCandidates,
2297 JD.DefGenerators.empty() ?
nullptr
2298 : &IPLS->DefGeneratorNonCandidates);
2300 dbgs() <<
" Remaining candidates = " << IPLS->DefGeneratorCandidates
2308 IPLS->DefGeneratorCandidates.empty())
2309 OL_resumeLookupAfterGeneration(*IPLS);
2315 return IPLS->fail(std::move(Err));
2319 if (IPLS->CurDefGeneratorStack.empty())
2320 LLVM_DEBUG(
dbgs() <<
" No generators to run for this JITDylib.\n");
2321 else if (IPLS->DefGeneratorCandidates.empty())
2324 dbgs() <<
" Running " << IPLS->CurDefGeneratorStack.size()
2325 <<
" remaining generators for "
2326 << IPLS->DefGeneratorCandidates.size() <<
" candidates\n";
2328 while (!IPLS->CurDefGeneratorStack.empty() &&
2329 !IPLS->DefGeneratorCandidates.empty()) {
2330 auto DG = IPLS->CurDefGeneratorStack.back().lock();
2334 "DefinitionGenerator removed while lookup in progress",
2347 std::lock_guard<std::mutex> Lock(DG->M);
2349 DG->PendingLookups.push_back(std::move(IPLS));
2358 auto &LookupSet = IPLS->DefGeneratorCandidates;
2363 LLVM_DEBUG(
dbgs() <<
" Attempting to generate " << LookupSet <<
"\n");
2365 Err = DG->tryToGenerate(LS, K, JD, JDLookupFlags, LookupSet);
2366 IPLS = std::move(
LS.IPLS);
2372 OL_resumeLookupAfterGeneration(*IPLS);
2377 dbgs() <<
" Error attempting to generate " << LookupSet <<
"\n";
2379 assert(IPLS &&
"LS cannot be retained if error is returned");
2380 return IPLS->fail(std::move(Err));
2386 {
dbgs() <<
" LookupState captured. Exiting phase1 for now.\n"; });
2393 LLVM_DEBUG(
dbgs() <<
" Updating candidate set post-generation\n");
2394 Err = IL_updateCandidatesFor(
2395 JD, JDLookupFlags, IPLS->DefGeneratorCandidates,
2396 JD.DefGenerators.empty() ?
nullptr
2397 : &IPLS->DefGeneratorNonCandidates);
2402 LLVM_DEBUG(
dbgs() <<
" Error encountered while updating candidates\n");
2403 return IPLS->fail(std::move(Err));
2407 if (IPLS->DefGeneratorCandidates.empty() &&
2408 IPLS->DefGeneratorNonCandidates.empty()) {
2411 IPLS->CurSearchOrderIndex = IPLS->SearchOrder.size();
2417 ++IPLS->CurSearchOrderIndex;
2418 IPLS->NewJITDylib =
true;
2423 IPLS->DefGeneratorCandidates.remove_if(
2431 if (IPLS->DefGeneratorCandidates.empty()) {
2433 IPLS->complete(std::move(IPLS));
2435 LLVM_DEBUG(
dbgs() <<
"Phase 1 failed with unresolved symbols.\n");
2441void ExecutionSession::OL_completeLookup(
2442 std::unique_ptr<InProgressLookupState> IPLS,
2443 std::shared_ptr<AsynchronousSymbolQuery> Q,
2447 dbgs() <<
"Entering OL_completeLookup:\n"
2448 <<
" Lookup kind: " << IPLS->K <<
"\n"
2449 <<
" Search order: " << IPLS->SearchOrder
2450 <<
", Current index = " << IPLS->CurSearchOrderIndex
2451 << (IPLS->NewJITDylib ?
" (entering new JITDylib)" :
"") <<
"\n"
2452 <<
" Lookup set: " << IPLS->LookupSet <<
"\n"
2453 <<
" Definition generator candidates: "
2454 << IPLS->DefGeneratorCandidates <<
"\n"
2455 <<
" Definition generator non-candidates: "
2456 << IPLS->DefGeneratorNonCandidates <<
"\n";
2459 bool QueryComplete =
false;
2460 DenseMap<JITDylib *, JITDylib::UnmaterializedInfosList> CollectedUMIs;
2463 for (
auto &KV : IPLS->SearchOrder) {
2464 auto &JD = *KV.first;
2465 auto JDLookupFlags = KV.second;
2467 dbgs() <<
"Visiting \"" << JD.getName() <<
"\" (" << JDLookupFlags
2468 <<
") with lookup set " << IPLS->LookupSet <<
":\n";
2471 auto Err = IPLS->LookupSet.forEachWithRemoval(
2472 [&](
const SymbolStringPtr &Name,
2475 dbgs() <<
" Attempting to match \"" <<
Name <<
"\" ("
2476 << SymLookupFlags <<
")... ";
2481 auto SymI = JD.Symbols.find(Name);
2482 if (SymI == JD.Symbols.end()) {
2489 if (!SymI->second.getFlags().isExported() &&
2501 if (SymI->second.getFlags().hasMaterializationSideEffectsOnly() &&
2505 "required, but symbol is has-side-effects-only\n";
2513 if (SymI->second.getFlags().hasError()) {
2515 auto FailedSymbolsMap = std::make_shared<SymbolDependenceMap>();
2516 (*FailedSymbolsMap)[&JD] = {
Name};
2525 if (SymI->second.getState() >= Q->getRequiredState()) {
2527 <<
"matched, symbol already in required state\n");
2528 Q->notifySymbolMetRequiredState(Name, SymI->second.getSymbol());
2533 Q->addQueryDependence(JD, Name);
2541 if (SymI->second.hasMaterializerAttached()) {
2542 assert(SymI->second.getAddress() == ExecutorAddr() &&
2543 "Symbol not resolved but already has address?");
2544 auto UMII = JD.UnmaterializedInfos.find(Name);
2545 assert(UMII != JD.UnmaterializedInfos.end() &&
2546 "Lazy symbol should have UnmaterializedInfo");
2548 auto UMI = UMII->second;
2549 assert(UMI->MU &&
"Materializer should not be null");
2550 assert(UMI->RT &&
"Tracker should not be null");
2552 dbgs() <<
"matched, preparing to dispatch MU@" << UMI->MU.get()
2553 <<
" (" << UMI->MU->getName() <<
")\n";
2558 for (
auto &KV : UMI->MU->getSymbols()) {
2559 auto SymK = JD.Symbols.find(KV.first);
2560 assert(SymK != JD.Symbols.end() &&
2561 "No entry for symbol covered by MaterializationUnit");
2562 SymK->second.setMaterializerAttached(
false);
2564 JD.UnmaterializedInfos.erase(KV.first);
2568 CollectedUMIs[&JD].push_back(std::move(UMI));
2576 "By this line the symbol should be materializing");
2577 auto &
MI = JD.MaterializingInfos[
Name];
2579 Q->addQueryDependence(JD, Name);
2584 JD.shrinkMaterializationInfoMemory();
2590 dbgs() <<
"Lookup failed. Detaching query and replacing MUs.\n";
2597 for (
auto &KV : CollectedUMIs) {
2598 auto &JD = *KV.first;
2599 for (
auto &UMI : KV.second)
2600 for (
auto &KV2 : UMI->MU->getSymbols()) {
2601 assert(!JD.UnmaterializedInfos.count(KV2.first) &&
2602 "Unexpected materializer in map");
2603 auto SymI = JD.Symbols.find(KV2.first);
2604 assert(SymI != JD.Symbols.end() &&
"Missing symbol entry");
2606 "Can not replace symbol that is not materializing");
2607 assert(!SymI->second.hasMaterializerAttached() &&
2608 "MaterializerAttached flag should not be set");
2609 SymI->second.setMaterializerAttached(
true);
2610 JD.UnmaterializedInfos[KV2.first] = UMI;
2618 LLVM_DEBUG(
dbgs() <<
"Stripping unmatched weakly-referenced symbols\n");
2619 IPLS->LookupSet.forEachWithRemoval(
2622 Q->dropSymbol(Name);
2628 if (!IPLS->LookupSet.empty()) {
2631 IPLS->LookupSet.getSymbolNames());
2635 QueryComplete = Q->isComplete();
2638 dbgs() <<
"Query successfully "
2639 << (QueryComplete ?
"completed" :
"lodged") <<
"\n";
2643 if (!CollectedUMIs.empty()) {
2644 std::lock_guard<std::recursive_mutex> Lock(OutstandingMUsMutex);
2647 for (
auto &KV : CollectedUMIs) {
2649 auto &JD = *KV.first;
2650 dbgs() <<
" For " << JD.getName() <<
": Adding " << KV.second.size()
2653 for (
auto &UMI : KV.second) {
2654 auto MR = createMaterializationResponsibility(
2655 *UMI->RT, std::move(UMI->MU->SymbolFlags),
2656 std::move(UMI->MU->InitSymbol));
2657 OutstandingMUs.push_back(
2658 std::make_pair(std::move(UMI->MU), std::move(MR)));
2664 if (RegisterDependencies && !Q->QueryRegistrations.empty()) {
2666 RegisterDependencies(Q->QueryRegistrations);
2676 Q->handleFailed(std::move(LodgingErr));
2680 if (QueryComplete) {
2682 Q->handleComplete(*
this);
2685 dispatchOutstandingMUs();
2688void ExecutionSession::OL_completeLookupFlags(
2689 std::unique_ptr<InProgressLookupState> IPLS,
2690 unique_function<
void(Expected<SymbolFlagsMap>)> OnComplete) {
2694 dbgs() <<
"Entering OL_completeLookupFlags:\n"
2695 <<
" Lookup kind: " << IPLS->K <<
"\n"
2696 <<
" Search order: " << IPLS->SearchOrder
2697 <<
", Current index = " << IPLS->CurSearchOrderIndex
2698 << (IPLS->NewJITDylib ?
" (entering new JITDylib)" :
"") <<
"\n"
2699 <<
" Lookup set: " << IPLS->LookupSet <<
"\n"
2700 <<
" Definition generator candidates: "
2701 << IPLS->DefGeneratorCandidates <<
"\n"
2702 <<
" Definition generator non-candidates: "
2703 << IPLS->DefGeneratorNonCandidates <<
"\n";
2709 for (
auto &KV : IPLS->SearchOrder) {
2710 auto &JD = *KV.first;
2711 auto JDLookupFlags = KV.second;
2713 dbgs() <<
"Visiting \"" << JD.getName() <<
"\" (" << JDLookupFlags
2714 <<
") with lookup set " << IPLS->LookupSet <<
":\n";
2717 IPLS->LookupSet.forEachWithRemoval([&](
const SymbolStringPtr &Name,
2720 dbgs() <<
" Attempting to match \"" <<
Name <<
"\" ("
2721 << SymLookupFlags <<
")... ";
2726 auto SymI = JD.Symbols.find(Name);
2727 if (SymI == JD.Symbols.end()) {
2733 if (!SymI->second.getFlags().isExported() &&
2740 dbgs() <<
"matched, \"" <<
Name <<
"\" -> " << SymI->second.getFlags()
2749 IPLS->LookupSet.remove_if(
2754 if (!IPLS->LookupSet.empty()) {
2757 IPLS->LookupSet.getSymbolNames());
2766 OnComplete(std::move(
Result));
2769void ExecutionSession::OL_destroyMaterializationResponsibility(
2772 assert(MR.SymbolFlags.empty() &&
2773 "All symbols should have been explicitly materialized or failed");
2774 MR.JD.unlinkMaterializationResponsibility(MR);
2779 return MR.JD.getRequestedSymbols(MR.SymbolFlags);
2785 dbgs() <<
"In " << MR.JD.getName() <<
" resolving " <<
Symbols <<
"\n";
2788 for (
auto &KV : Symbols) {
2789 auto I = MR.SymbolFlags.find(KV.first);
2790 assert(
I != MR.SymbolFlags.end() &&
2791 "Resolving symbol outside this responsibility set");
2792 assert(!
I->second.hasMaterializationSideEffectsOnly() &&
2793 "Can't resolve materialization-side-effects-only symbol");
2796 assert((KV.second.getFlags() & WeakOrCommon) &&
2797 "Common symbols must be resolved as common or weak");
2798 assert((KV.second.getFlags() & ~WeakOrCommon) ==
2800 "Resolving symbol with incorrect flags");
2802 assert(KV.second.getFlags() ==
I->second &&
2803 "Resolving symbol with incorrect flags");
2807 return MR.JD.resolve(MR, Symbols);
2811ExecutionSession::IL_getSymbolState(
JITDylib *JD,
2813 if (JD->State != JITDylib::Open)
2814 return WaitingOnGraph::ExternalState::Failed;
2816 auto I = JD->Symbols.find_as(Name);
2819 if (
I == JD->Symbols.end())
2820 return WaitingOnGraph::ExternalState::Failed;
2822 if (
I->second.getFlags().hasError())
2823 return WaitingOnGraph::ExternalState::Failed;
2826 return WaitingOnGraph::ExternalState::Ready;
2828 return WaitingOnGraph::ExternalState::None;
2831template <
typename UpdateSymbolFn,
typename UpdateQueryFn>
2832void ExecutionSession::IL_collectQueries(
2833 JITDylib::AsynchronousSymbolQuerySet &Qs,
2835 UpdateSymbolFn &&UpdateSymbol, UpdateQueryFn &&UpdateQuery) {
2837 for (
auto &[JD, Symbols] : QualifiedSymbols) {
2842 assert(JD->State == JITDylib::Open &&
2843 "WaitingOnGraph includes definition in defunct JITDylib");
2844 for (
auto &Symbol : Symbols) {
2846 auto I = JD->Symbols.find_as(Symbol);
2847 assert(
I != JD->Symbols.end() &&
2848 "Failed Symbol missing from JD symbol table");
2850 UpdateSymbol(Entry);
2853 auto J = JD->MaterializingInfos.find_as(Symbol);
2854 if (J != JD->MaterializingInfos.end()) {
2855 for (
auto &Q : J->second.takeAllPendingQueries()) {
2856 UpdateQuery(*Q, *JD, Symbol, Entry);
2857 Qs.insert(std::move(Q));
2859 JD->MaterializingInfos.erase(J);
2865Expected<ExecutionSession::EmitQueries>
2867 WaitingOnGraph::SimplifyResult SR) {
2869 if (MR.RT->isDefunct())
2872 auto &TargetJD = MR.getTargetJITDylib();
2873 if (TargetJD.State != JITDylib::Open)
2878#ifdef EXPENSIVE_CHECKS
2879 verifySessionState(
"entering ExecutionSession::IL_emit");
2882 auto ER = G.emit(std::move(SR),
2883 [
this](
JITDylib *JD, NonOwningSymbolStringPtr Name) {
2884 return IL_getSymbolState(JD, Name);
2890 for (
auto &SN : ER.Failed)
2892 EQ.Failed, SN->defs(),
2893 [](JITDylib::SymbolTableEntry &
E) {
2894 E.setFlags(E.getFlags() = JITSymbolFlags::HasError);
2896 [&](AsynchronousSymbolQuery &Q,
JITDylib &JD,
2897 NonOwningSymbolStringPtr Name, JITDylib::SymbolTableEntry &
E) {
2898 auto &FS = EQ.FailedSymsForQuery[&Q];
2900 FS = std::make_shared<SymbolDependenceMap>();
2901 (*FS)[&JD].insert(SymbolStringPtr(Name));
2904 for (
auto &FQ :
EQ.Failed)
2907 for (
auto &SN : ER.Ready)
2909 EQ.Completed, SN->defs(),
2910 [](JITDylib::SymbolTableEntry &
E) { E.setState(SymbolState::Ready); },
2911 [](AsynchronousSymbolQuery &Q,
JITDylib &JD,
2912 NonOwningSymbolStringPtr Name, JITDylib::SymbolTableEntry &
E) {
2913 Q.notifySymbolMetRequiredState(SymbolStringPtr(Name), E.getSymbol());
2918 for (
auto it =
EQ.Completed.begin(), end =
EQ.Completed.end(); it != end;) {
2919 if ((*it)->isComplete()) {
2922 it =
EQ.Completed.erase(it);
2926#ifdef EXPENSIVE_CHECKS
2927 verifySessionState(
"exiting ExecutionSession::IL_emit");
2930 return std::move(
EQ);
2933Error ExecutionSession::OL_notifyEmitted(
2937 dbgs() <<
"In " << MR.JD.getName() <<
" emitting " << MR.SymbolFlags
2939 if (!DepGroups.empty()) {
2940 dbgs() <<
" Initial dependencies:\n";
2941 for (
auto &SDG : DepGroups) {
2942 dbgs() <<
" Symbols: " << SDG.Symbols
2943 <<
", Dependencies: " << SDG.Dependencies <<
"\n";
2950 for (
auto &DG : DepGroups) {
2951 for (
auto &Sym : DG.Symbols) {
2952 assert(MR.SymbolFlags.count(Sym) &&
2953 "DG contains dependence for symbol outside this MR");
2954 assert(Visited.insert(Sym).second &&
2955 "DG contains duplicate entries for Name");
2960 std::vector<std::unique_ptr<WaitingOnGraph::SuperNode>> SNs;
2963 auto &JDResidual = Residual[&MR.getTargetJITDylib()];
2964 for (
auto &[Name, Flags] : MR.getSymbols())
2965 JDResidual.insert(NonOwningSymbolStringPtr(Name));
2967 for (
auto &SDG : DepGroups) {
2969 assert(!SDG.Symbols.empty());
2970 auto &JDDefs = Defs[&MR.getTargetJITDylib()];
2971 for (
auto &Def : SDG.Symbols) {
2972 JDDefs.insert(NonOwningSymbolStringPtr(Def));
2973 JDResidual.erase(NonOwningSymbolStringPtr(Def));
2976 if (!SDG.Dependencies.empty()) {
2977 for (
auto &[JD, Syms] : SDG.Dependencies) {
2978 auto &JDDeps = Deps[JD];
2979 for (
auto &Dep : Syms)
2980 JDDeps.insert(NonOwningSymbolStringPtr(Dep));
2983 SNs.push_back(std::make_unique<WaitingOnGraph::SuperNode>(
2984 std::move(Defs), std::move(Deps)));
2986 if (!JDResidual.empty())
2987 SNs.push_back(std::make_unique<WaitingOnGraph::SuperNode>(
2994 dbgs() <<
" Simplified dependencies:\n";
2995 for (
auto &SN : SR.superNodes()) {
2998 std::vector<JITDylib *> JDs;
2999 for (
auto &[JD,
_] :
C)
3002 return LHS->getName() <
RHS->getName();
3008 std::vector<NonOwningSymbolStringPtr> Names(Elems.begin(), Elems.end());
3010 const NonOwningSymbolStringPtr &
RHS) {
3016 dbgs() <<
" Defs: {";
3017 for (
auto *JD : SortedLibs(SN->defs())) {
3018 dbgs() <<
" (" << JD->getName() <<
", [";
3019 for (
auto &Sym : SortedNames(SN->defs()[JD]))
3020 dbgs() <<
" " << Sym;
3023 dbgs() <<
" }, Deps: {";
3024 for (
auto *JD : SortedLibs(SN->deps())) {
3025 dbgs() <<
" (" << JD->getName() <<
", [";
3026 for (
auto &Sym : SortedNames(SN->deps()[JD]))
3027 dbgs() <<
" " << Sym;
3038 return EmitQueries.takeError();
3046 for (
auto &FQ : EmitQueries->Failed) {
3048 assert(EmitQueries->FailedSymsForQuery.count(FQ.get()) &&
3049 "Missing failed symbols for query");
3050 auto FailedSyms = std::move(EmitQueries->FailedSymsForQuery[FQ.get()]);
3051 for (
auto &[JD, Syms] : *FailedSyms) {
3052 auto &BadDepsForJD = BadDeps[JD];
3053 for (
auto &Sym : Syms)
3054 BadDepsForJD.insert(Sym);
3057 std::move(FailedSyms)));
3061 for (
auto &UQ : EmitQueries->Completed)
3062 UQ->handleComplete(*
this);
3065 if (!BadDeps.empty()) {
3071 for (
auto &[Name, Flags] : MR.getSymbols())
3073 MR.SymbolFlags.clear();
3076 std::move(BadDeps),
"dependencies removed or in error state");
3079 MR.SymbolFlags.
clear();
3083Error ExecutionSession::OL_defineMaterializing(
3087 dbgs() <<
"In " << MR.JD.getName() <<
" defining materializing symbols "
3088 << NewSymbolFlags <<
"\n";
3090 if (
auto AcceptedDefs =
3091 MR.JD.defineMaterializing(MR, std::move(NewSymbolFlags))) {
3093 for (
auto &KV : *AcceptedDefs)
3094 MR.SymbolFlags.insert(KV);
3097 return AcceptedDefs.takeError();
3100std::pair<JITDylib::AsynchronousSymbolQuerySet,
3101 std::shared_ptr<SymbolDependenceMap>>
3102ExecutionSession::IL_failSymbols(
JITDylib &JD,
3105#ifdef EXPENSIVE_CHECKS
3106 verifySessionState(
"entering ExecutionSession::IL_failSymbols");
3109 JITDylib::AsynchronousSymbolQuerySet FailedQueries;
3110 auto Fail = [&](
JITDylib *FailJD, NonOwningSymbolStringPtr FailSym) {
3111 auto I = FailJD->Symbols.find_as(FailSym);
3112 assert(
I != FailJD->Symbols.end());
3114 auto J = FailJD->MaterializingInfos.find_as(FailSym);
3115 if (J != FailJD->MaterializingInfos.end()) {
3116 for (
auto &Q : J->second.takeAllPendingQueries())
3117 FailedQueries.insert(std::move(Q));
3118 FailJD->MaterializingInfos.erase(J);
3122 auto FailedSymbolsMap = std::make_shared<SymbolDependenceMap>();
3125 auto &FailedSymsForJD = (*FailedSymbolsMap)[&JD];
3126 for (
auto &Sym : SymbolsToFail) {
3127 FailedSymsForJD.insert(Sym);
3128 Fail(&JD, NonOwningSymbolStringPtr(Sym));
3133 auto &JDToFail = ToFail[&JD];
3134 for (
auto &Sym : SymbolsToFail)
3135 JDToFail.insert(NonOwningSymbolStringPtr(Sym));
3137 auto FailedSNs = G.fail(ToFail);
3139 for (
auto &SN : FailedSNs) {
3140 for (
auto &[FailJD, Defs] : SN->defs()) {
3141 auto &FailedSymsForFailJD = (*FailedSymbolsMap)[FailJD];
3142 for (
auto &Def : Defs) {
3143 FailedSymsForFailJD.insert(SymbolStringPtr(Def));
3150 for (
auto &Q : FailedQueries)
3153#ifdef EXPENSIVE_CHECKS
3154 verifySessionState(
"exiting ExecutionSession::IL_failSymbols");
3157 return std::make_pair(std::move(FailedQueries), std::move(FailedSymbolsMap));
3163 dbgs() <<
"In " << MR.JD.getName() <<
" failing materialization for "
3164 << MR.SymbolFlags <<
"\n";
3167 if (MR.SymbolFlags.empty())
3171 for (
auto &[Name, Flags] : MR.SymbolFlags)
3172 SymbolsToFail.push_back(Name);
3173 MR.SymbolFlags.clear();
3175 JITDylib::AsynchronousSymbolQuerySet FailedQueries;
3176 std::shared_ptr<SymbolDependenceMap> FailedSymbols;
3180 if (MR.RT->isDefunct())
3181 return std::pair<JITDylib::AsynchronousSymbolQuerySet,
3182 std::shared_ptr<SymbolDependenceMap>>();
3183 return IL_failSymbols(MR.getTargetJITDylib(), SymbolsToFail);
3186 for (
auto &Q : FailedQueries) {
3194 std::unique_ptr<MaterializationUnit> MU) {
3195 for (
auto &KV : MU->getSymbols()) {
3196 assert(MR.SymbolFlags.count(KV.first) &&
3197 "Replacing definition outside this responsibility set");
3198 MR.SymbolFlags.erase(KV.first);
3201 if (MU->getInitializerSymbol() == MR.InitSymbol)
3202 MR.InitSymbol =
nullptr;
3204 LLVM_DEBUG(MR.JD.getExecutionSession().runSessionLocked([&]() {
3205 dbgs() <<
"In " << MR.JD.getName() <<
" replacing symbols with " << *MU
3209 return MR.JD.replace(MR, std::move(MU));
3212Expected<std::unique_ptr<MaterializationResponsibility>>
3216 SymbolStringPtr DelegatedInitSymbol;
3219 for (
auto &Name : Symbols) {
3220 auto I = MR.SymbolFlags.find(Name);
3221 assert(
I != MR.SymbolFlags.end() &&
3222 "Symbol is not tracked by this MaterializationResponsibility "
3225 DelegatedFlags[
Name] = std::move(
I->second);
3226 if (Name == MR.InitSymbol)
3227 std::swap(MR.InitSymbol, DelegatedInitSymbol);
3229 MR.SymbolFlags.erase(
I);
3232 return MR.JD.delegate(MR, std::move(DelegatedFlags),
3233 std::move(DelegatedInitSymbol));
3237void ExecutionSession::dumpDispatchInfo(
Task &
T) {
3239 dbgs() <<
"Dispatching: ";
3240 T.printDescription(
dbgs());
for(const MachineOperand &MO :llvm::drop_begin(OldMI.operands(), Desc.getNumOperands()))
aarch64 falkor hwpf fix Falkor HW Prefetch Fix Late Phase
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static StringRef getName(Value *V)
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
const T & front() const
front - Get the first element.
bool empty() const
empty - Check if the array is empty.
iterator find(const_arg_type_t< KeyT > Val)
bool erase(const KeyT &Val)
iterator find_as(const LookupKeyT &Val)
Alternate version of find() which allows a different, and possibly less expensive,...
size_type count(const_arg_type_t< KeyT > Val) const
Return 1 if the specified key is in the map, 0 otherwise.
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Implements a dense probed hash-table based set.
Helper for Errors used as out-parameters.
Lightweight error class with error context and mandatory checking.
static ErrorSuccess success()
Create a success value.
Tagged union holding either a T or a Error.
reference get()
Returns a reference to the stored T value.
bool hasMaterializationSideEffectsOnly() const
Returns true if this symbol is a materialization-side-effects-only symbol.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
std::pair< iterator, bool > insert(const ValueT &V)
void reserve(size_t Size)
Grow the DenseSet so that it can contain at least NumEntries items before resizing again.
void insert_range(Range &&R)
size_type count(const_arg_type_t< ValueT > V) const
Return 1 if the specified key is in the set, 0 otherwise.
const std::string & getName() const
Get the name for this JITLinkDylib.
A symbol query that returns results via a callback when results are ready.
LLVM_ABI AsynchronousSymbolQuery(const SymbolLookupSet &Symbols, SymbolState RequiredState, SymbolsResolvedCallback NotifyComplete)
Create a query for the given symbols.
LLVM_ABI void notifySymbolMetRequiredState(const SymbolStringPtr &Name, ExecutorSymbolDef Sym)
Notify the query that a requested symbol has reached the required state.
Definition generators can be attached to JITDylibs to generate new definitions for otherwise unresolv...
virtual ~DefinitionGenerator()
An ExecutionSession represents a running JIT program.
LLVM_ABI void runJITDispatchHandler(SendResultFunction SendResult, ExecutorAddr HandlerFnTagAddr, shared::WrapperFunctionBuffer ArgBytes)
Run a registered jit-side wrapper function.
LLVM_ABI Error endSession()
End the session.
void reportError(Error Err)
Report a error for this execution session.
LLVM_ABI void lookupFlags(LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet Symbols, unique_function< void(Expected< SymbolFlagsMap >)> OnComplete)
Search the given JITDylibs to find the flags associated with each of the given symbols.
SymbolStringPtr intern(StringRef SymName)
Add a symbol name to the SymbolStringPool and return a pointer to it.
LLVM_ABI JITDylib * getJITDylibByName(StringRef Name)
Return a pointer to the "name" JITDylib.
LLVM_ABI JITDylib & createBareJITDylib(std::string Name)
Add a new bare JITDylib to this ExecutionSession.
std::shared_ptr< SymbolStringPool > getSymbolStringPool()
Get the SymbolStringPool for this instance.
LLVM_ABI void lookup(LookupKind K, const JITDylibSearchOrder &SearchOrder, SymbolLookupSet Symbols, SymbolState RequiredState, SymbolsResolvedCallback NotifyComplete, RegisterDependenciesFunction RegisterDependencies)
Search the given JITDylibs for the given symbols.
LLVM_ABI Error registerJITDispatchHandlers(JITDylib &JD, JITDispatchHandlerAssociationMap WFs)
For each tag symbol name, associate the corresponding AsyncHandlerWrapperFunction with the address of...
LLVM_ABI void registerResourceManager(ResourceManager &RM)
Register the given ResourceManager with this ExecutionSession.
LLVM_ABI ~ExecutionSession()
Destroy an ExecutionSession.
LLVM_ABI void deregisterResourceManager(ResourceManager &RM)
Deregister the given ResourceManager with this ExecutionSession.
LLVM_ABI ExecutionSession(std::unique_ptr< ExecutorProcessControl > EPC)
Construct an ExecutionSession with the given ExecutorProcessControl object.
decltype(auto) runSessionLocked(Func &&F)
Run the given lambda with the session mutex locked.
LLVM_ABI void dump(raw_ostream &OS)
Dump the state of all the JITDylibs in this session.
unique_function< void(shared::WrapperFunctionBuffer)> SendResultFunction
Send a result to the remote.
LLVM_ABI Error removeJITDylibs(std::vector< JITDylibSP > JDsToRemove)
Removes the given JITDylibs from the ExecutionSession.
LLVM_ABI Expected< JITDylib & > createJITDylib(std::string Name)
Add a new JITDylib to this ExecutionSession.
void dispatchTask(std::unique_ptr< Task > T)
Materialize the given unit.
DenseMap< SymbolStringPtr, JITDispatchHandlerFunction > JITDispatchHandlerAssociationMap
A map associating tag names with asynchronous wrapper function implementations in the JIT.
Represents an address in the executor process.
Represents a defining location for a JIT symbol.
const JITSymbolFlags & getFlags() const
FailedToMaterialize(std::shared_ptr< SymbolStringPool > SSP, std::shared_ptr< SymbolDependenceMap > Symbols)
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
~FailedToMaterialize() override
void log(raw_ostream &OS) const override
Print an error message to an output stream.
InProgressFullLookupState(LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet LookupSet, SymbolState RequiredState, std::shared_ptr< AsynchronousSymbolQuery > Q, RegisterDependenciesFunction RegisterDependencies)
void complete(std::unique_ptr< InProgressLookupState > IPLS) override
void fail(Error Err) override
void complete(std::unique_ptr< InProgressLookupState > IPLS) override
void fail(Error Err) override
InProgressLookupFlagsState(LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet LookupSet, unique_function< void(Expected< SymbolFlagsMap >)> OnComplete)
virtual ~InProgressLookupState()=default
SymbolLookupSet DefGeneratorCandidates
JITDylibSearchOrder SearchOrder
std::vector< std::weak_ptr< DefinitionGenerator > > CurDefGeneratorStack
size_t CurSearchOrderIndex
SymbolLookupSet LookupSet
virtual void complete(std::unique_ptr< InProgressLookupState > IPLS)=0
InProgressLookupState(LookupKind K, JITDylibSearchOrder SearchOrder, SymbolLookupSet LookupSet, SymbolState RequiredState)
SymbolState RequiredState
SymbolLookupSet DefGeneratorNonCandidates
virtual void fail(Error Err)=0
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
void log(raw_ostream &OS) const override
Print an error message to an output stream.
Represents a JIT'd dynamic library.
LLVM_ABI Error remove(const SymbolNameSet &Names)
Tries to remove the given symbols.
LLVM_ABI Error clear()
Calls remove on all trackers currently associated with this JITDylib.
LLVM_ABI void dump(raw_ostream &OS)
Dump current JITDylib state to OS.
LLVM_ABI void replaceInLinkOrder(JITDylib &OldJD, JITDylib &NewJD, JITDylibLookupFlags JDLookupFlags=JITDylibLookupFlags::MatchExportedSymbolsOnly)
Replace OldJD with NewJD in the link order if OldJD is present.
Error define(std::unique_ptr< MaterializationUnitType > &&MU, ResourceTrackerSP RT=nullptr)
Define all symbols provided by the materialization unit to be part of this JITDylib.
ExecutionSession & getExecutionSession() const
Get a reference to the ExecutionSession for this JITDylib.
LLVM_ABI void addToLinkOrder(const JITDylibSearchOrder &NewLinks)
Append the given JITDylibSearchOrder to the link order for this JITDylib (discarding any elements alr...
LLVM_ABI ResourceTrackerSP createResourceTracker()
Create a resource tracker for this JITDylib.
LLVM_ABI void removeFromLinkOrder(JITDylib &JD)
Remove the given JITDylib from the link order for this JITDylib if it is present.
LLVM_ABI void setLinkOrder(JITDylibSearchOrder NewSearchOrder, bool LinkAgainstThisJITDylibFirst=true)
Set the link order to be used when fixing up definitions in JITDylib.
LLVM_ABI Expected< std::vector< JITDylibSP > > getReverseDFSLinkOrder()
Rteurn this JITDylib and its transitive dependencies in reverse DFS order based on linkage relationsh...
LLVM_ABI ResourceTrackerSP getDefaultResourceTracker()
Get the default resource tracker for this JITDylib.
JITDylib(const JITDylib &)=delete
LLVM_ABI void removeGenerator(DefinitionGenerator &G)
Remove a definition generator from this JITDylib.
LLVM_ABI Expected< std::vector< JITDylibSP > > getDFSLinkOrder()
Return this JITDylib and its transitive dependencies in DFS order based on linkage relationships.
Wraps state for a lookup-in-progress.
LLVM_ABI void continueLookup(Error Err)
Continue the lookup.
LLVM_ABI LookupState & operator=(LookupState &&)
void printDescription(raw_ostream &OS) override
Tracks responsibility for materialization, and mediates interactions between MaterializationUnits and...
void printDescription(raw_ostream &OS) override
~MaterializationTask() override
A MaterializationUnit represents a set of symbol definitions that can be materialized as a group,...
MaterializationUnit(Interface I)
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
void log(raw_ostream &OS) const override
Print an error message to an output stream.
Non-owning SymbolStringPool entry pointer.
StringRef getName() const override
Return the name of this materialization unit.
ReExportsMaterializationUnit(JITDylib *SourceJD, JITDylibLookupFlags SourceJDLookupFlags, SymbolAliasMap Aliases)
SourceJD is allowed to be nullptr, in which case the source JITDylib is taken to be whatever JITDylib...
std::function< bool(SymbolStringPtr)> SymbolPredicate
Error tryToGenerate(LookupState &LS, LookupKind K, JITDylib &JD, JITDylibLookupFlags JDLookupFlags, const SymbolLookupSet &LookupSet) override
DefinitionGenerators should override this method to insert new definitions into the parent JITDylib.
ReexportsGenerator(JITDylib &SourceJD, JITDylibLookupFlags SourceJDLookupFlags, SymbolPredicate Allow=SymbolPredicate())
Create a reexports generator.
Listens for ResourceTracker operations.
virtual ~ResourceManager()
ResourceTrackerDefunct(ResourceTrackerSP RT)
void log(raw_ostream &OS) const override
Print an error message to an output stream.
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
API to remove / transfer ownership of JIT resources.
JITDylib & getJITDylib() const
Return the JITDylib targeted by this tracker.
LLVM_ABI void transferTo(ResourceTracker &DstRT)
Transfer all resources associated with this key to the given tracker, which must target the same JITD...
LLVM_ABI ~ResourceTracker()
ResourceTracker(const ResourceTracker &)=delete
LLVM_ABI Error remove()
Remove all resources associated with this key.
LLVM_ABI void lookupAsync(LookupAsyncOnCompleteFn OnComplete) const
unique_function< void(Expected< ExecutorSymbolDef >)> LookupAsyncOnCompleteFn
A set of symbols to look up, each associated with a SymbolLookupFlags value.
static SymbolLookupSet fromMapKeys(const DenseMap< SymbolStringPtr, ValT > &M, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)
Construct a SymbolLookupSet from DenseMap keys.
Pointer to a pooled string representing a symbol name.
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
void log(raw_ostream &OS) const override
Print an error message to an output stream.
SymbolsCouldNotBeRemoved(std::shared_ptr< SymbolStringPool > SSP, SymbolNameSet Symbols)
void log(raw_ostream &OS) const override
Print an error message to an output stream.
SymbolsNotFound(std::shared_ptr< SymbolStringPool > SSP, SymbolNameSet Symbols)
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
Represents an abstract task for ORC to run.
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
void log(raw_ostream &OS) const override
Print an error message to an output stream.
void log(raw_ostream &OS) const override
Print an error message to an output stream.
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
UnsatisfiedSymbolDependencies(std::shared_ptr< SymbolStringPool > SSP, JITDylibSP JD, SymbolNameSet FailedSymbols, SymbolDependenceMap BadDeps, std::string Explanation)
DenseSet< ElementId > ElementSet
DenseMap< ContainerId, ElementSet > ContainerElementsMap
static SimplifyResult simplify(std::vector< std::unique_ptr< SuperNode > > SNs)
C++ wrapper function buffer: Same as CWrapperFunctionBuffer but auto-releases memory.
size_t size() const
Returns the size of the data contained in this instance.
static WrapperFunctionBuffer createOutOfBandError(const char *Msg)
Create an out-of-band error by copying the given string.
char * data()
Get a pointer to the data contained in this instance.
A raw_ostream that writes to a file descriptor.
This class implements an extremely fast bulk output stream that can only output to a stream.
unique_function is a type-erasing functor similar to std::function.
@ C
The default llvm calling convention, compatible with C.
JITDylibSearchOrder makeJITDylibSearchOrder(ArrayRef< JITDylib * > JDs, JITDylibLookupFlags Flags=JITDylibLookupFlags::MatchExportedSymbolsOnly)
Convenience function for creating a search order from an ArrayRef of JITDylib*, all with the same fla...
std::vector< std::pair< JITDylib *, JITDylibLookupFlags > > JITDylibSearchOrder
A list of (JITDylib*, JITDylibLookupFlags) pairs to be used as a search order during symbol lookup.
IntrusiveRefCntPtr< JITDylib > JITDylibSP
IntrusiveRefCntPtr< ResourceTracker > ResourceTrackerSP
@ MissingSymbolDefinitions
@ UnexpectedSymbolDefinitions
std::unique_ptr< ReExportsMaterializationUnit > symbolAliases(SymbolAliasMap Aliases)
Create a ReExportsMaterializationUnit with the given aliases.
std::function< void(const SymbolDependenceMap &)> RegisterDependenciesFunction
Callback to register the dependencies for a given query.
SymbolLookupFlags
Lookup flags that apply to each symbol in a lookup.
std::unique_ptr< ReExportsMaterializationUnit > reexports(JITDylib &SourceJD, SymbolAliasMap Aliases, JITDylibLookupFlags SourceJDLookupFlags=JITDylibLookupFlags::MatchExportedSymbolsOnly)
Create a materialization unit for re-exporting symbols from another JITDylib with alternative names/f...
LLVM_ABI Expected< SymbolAliasMap > buildSimpleReexportsAliasMap(JITDylib &SourceJD, const SymbolNameSet &Symbols)
Build a SymbolAliasMap for the common case where you want to re-export symbols from another JITDylib ...
JITDylibLookupFlags
Lookup flags that apply to each dylib in the search order for a lookup.
@ MatchExportedSymbolsOnly
DenseMap< SymbolStringPtr, ExecutorSymbolDef > SymbolMap
A map from symbol names (as SymbolStringPtrs) to JITSymbols (address/flags pairs).
LookupKind
Describes the kind of lookup being performed.
LLVM_ABI RegisterDependenciesFunction NoDependenciesToRegister
This can be used as the value for a RegisterDependenciesFunction if there are no dependants to regist...
std::vector< SymbolStringPtr > SymbolNameVector
A vector of symbol names.
DenseMap< JITDylib *, SymbolNameSet > SymbolDependenceMap
A map from JITDylibs to sets of symbols.
DenseSet< SymbolStringPtr > SymbolNameSet
A set of symbol names (represented by SymbolStringPtrs for.
SymbolState
Represents the state that a symbol has reached during materialization.
@ Materializing
Added to the symbol table, never queried.
@ NeverSearched
No symbol should be in this state.
@ Ready
Emitted to memory, but waiting on transitive dependencies.
@ Resolved
Queried, materialization begun.
DenseMap< SymbolStringPtr, SymbolAliasMapEntry > SymbolAliasMap
A map of Symbols to (Symbol, Flags) pairs.
LLVM_ABI std::error_code orcError(OrcErrorCode ErrCode)
unique_function< void(Expected< SymbolMap >)> SymbolsResolvedCallback
Callback to notify client that symbols have been resolved.
DenseMap< SymbolStringPtr, JITSymbolFlags > SymbolFlagsMap
A map from symbol names (as SymbolStringPtrs) to JITSymbolFlags.
This is an optimization pass for GlobalISel generic memory operations.
auto find(R &&Range, const T &Val)
Provide wrappers to std::find which take ranges instead of having to pass begin/end explicitly.
LLVM_ABI std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
auto formatv(bool Validate, const char *Fmt, Ts &&...Vals)
auto reverse(ContainerTy &&C)
Error joinErrors(Error E1, Error E2)
Concatenate errors.
void sort(IteratorTy Start, IteratorTy End)
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
FunctionAddr VTableAddr Count
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Error make_error(ArgTs &&... Args)
Make a Error instance representing failure using the given error info type.
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
auto lower_bound(R &&Range, T &&Value)
Provide wrappers to std::lower_bound which take ranges instead of having to pass begin/end explicitly...
ArrayRef(const T &OneElt) -> ArrayRef< T >
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
auto find_if(R &&Range, UnaryPredicate P)
Provide wrappers to std::find_if which take ranges instead of having to pass begin/end explicitly.
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Implement std::hash so that hash_code can be used in STL containers.
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.