73#define DEBUG_TYPE "loop-accesses"
77 cl::desc(
"Sets the SIMD width. Zero is autoselect."),
83 cl::desc(
"Sets the vectorization interleave count. "
84 "Zero is autoselect."),
91 cl::desc(
"When performing memory disambiguation checks at runtime do not "
92 "generate more than this number of comparisons (default = 8)."),
99 cl::desc(
"Maximum number of comparisons done when trying to merge "
100 "runtime memory checks. (default = 100)"),
109 cl::desc(
"Maximum number of dependences collected by "
110 "loop-access analysis (default = 100)"),
126 cl::desc(
"Enable symbolic stride memory access versioning"));
131 "store-to-load-forwarding-conflict-detection",
cl::Hidden,
132 cl::desc(
"Enable conflict detection in loop-access analysis"),
137 cl::desc(
"Maximum recursion depth when finding forked SCEVs (default = 5)"),
142 cl::desc(
"Speculate that non-constant strides are unit in LAA"),
148 "Hoist inner loop runtime memory checks to outer loop if possible"),
153 return ::VectorizationInterleave.getNumOccurrences() > 0;
175 <<
" by: " << *Expr <<
"\n");
181 :
High(RtCheck.Pointers[Index].End),
Low(RtCheck.Pointers[Index].Start),
213 std::optional<ScalarEvolution::LoopGuards> &LoopGuards) {
219 bool CheckForNonNull;
220 Value *StartPtrV = StartPtr->getValue();
224 DL, CheckForNonNull,
nullptr);
228 if (DerefBytes && CheckForNonNull)
236 Instruction *CtxI = &*L->getHeader()->getFirstNonPHIIt();
237 if (
BasicBlock *LoopPred = L->getLoopPredecessor()) {
239 CtxI = LoopPred->getTerminator();
242 StartPtrV, Attribute::Dereferenceable, *AC,
251 DerefBytesSCEV = SE.
getUMaxExpr(DerefBytesSCEV, DerefRKSCEV);
256 if (DerefBytesSCEV->
isZero())
285 if (!DistToLastIter) {
306 const SCEV *MaxOffset;
307 if (IsKnownNonNegative) {
322 MaxOffset = StartOffset;
344 assert(AR->getLoop() == L &&
345 "trying to check for AddRec in different loop");
361static std::pair<const SCEV *, const SCEV *>
365 if (!PtrAdd || !PtrAdd->hasNoUnsignedWrap())
366 return {
nullptr,
nullptr};
369 return Op->getType()->isPointerTy();
372 return {
nullptr,
nullptr};
377 return {
nullptr,
nullptr};
383 return {
nullptr,
nullptr};
391 DenseMap<std::pair<const SCEV *, const SCEV *>,
394 std::optional<ScalarEvolution::LoopGuards> &LoopGuards) {
405 const Loop *Lp,
const SCEV *PtrExpr,
const SCEV *EltSizeSCEV,
407 DenseMap<std::pair<const SCEV *, const SCEV *>,
410 std::optional<ScalarEvolution::LoopGuards> &LoopGuards) {
411 std::pair<const SCEV *, const SCEV *> *PtrBoundsPair;
414 {{PtrExpr, EltSizeSCEV},
418 PtrBoundsPair = &Iter->second;
426 ScStart = ScEnd = PtrExpr;
428 ScStart = AR->getStart();
434 ScEnd = AR->evaluateAtIteration(BTC, *SE);
444 DT, AC, LoopGuards)) {
445 ScEnd = AR->evaluateAtIteration(MaxBTC, *SE);
454 const SCEV *Step = AR->getStepRecurrence(*SE);
459 if (CStep->getValue()->isNegative())
482 std::pair<const SCEV *, const SCEV *> Res = {ScStart, ScEnd};
484 *PtrBoundsPair = Res;
491 Type *AccessTy,
bool WritePtr,
492 unsigned DepSetId,
unsigned ASId,
498 Lp, PtrExpr, AccessTy, BTC, SymbolicMaxBTC, PSE.
getSE(),
499 &DC.getPointerBounds(), DC.getDT(), DC.getAC(), LoopGuards);
502 "must be able to compute both start and end expressions");
503 Pointers.emplace_back(Ptr, ScStart, ScEnd, WritePtr, DepSetId, ASId, PtrExpr,
507bool RuntimePointerChecking::tryToCreateDiffCheck(
530 if (AccSrc.
size() != 1 || AccSink.
size() != 1)
534 if (AccSink[0] < AccSrc[0])
538 const SCEV *SrcStart;
539 const SCEV *SinkStart;
541 if (!
match(Src->Expr,
560 std::max(
DL.getTypeAllocSize(SrcTy),
DL.getTypeAllocSize(DstTy));
586 const Loop *StartARLoop = SrcStartAR->getLoop();
587 if (StartARLoop == SinkStartAR->getLoop() &&
592 SrcStartAR->getStepRecurrence(*SE) !=
593 SinkStartAR->getStepRecurrence(*SE)) {
594 LLVM_DEBUG(
dbgs() <<
"LAA: Not creating diff runtime check, since these "
595 "cannot be hoisted out of the outer loop\n");
601 <<
"SrcStart: " << *SrcStartInt <<
'\n'
602 <<
"SinkStartInt: " << *SinkStartInt <<
'\n');
603 DiffChecks.emplace_back(SrcStartInt, SinkStartInt, AllocSize,
604 Src->NeedsFreeze ||
Sink->NeedsFreeze);
609 SmallVector<RuntimePointerCheck, 4> Checks;
617 CanUseDiffCheck = CanUseDiffCheck && tryToCreateDiffCheck(CGI, CGJ);
618 Checks.emplace_back(&CGI, &CGJ);
627 assert(Checks.empty() &&
"Checks is not empty");
628 groupChecks(DepCands);
634 for (
const auto &
I : M.Members)
635 for (
const auto &J :
N.Members)
648 return Diff->isNegative() ? J :
I;
655 RtCheck.
Pointers[Index].PointerValue->getType()->getPointerAddressSpace(),
656 RtCheck.
Pointers[Index].NeedsFreeze, *RtCheck.SE);
660 const SCEV *End,
unsigned AS,
664 "all pointers in a checking group must be in the same address space");
690void RuntimePointerChecking::groupChecks(
732 unsigned TotalComparisons = 0;
735 for (
unsigned Index = 0; Index <
Pointers.size(); ++Index)
736 PositionMap[
Pointers[Index].PointerValue].push_back(Index);
769 auto PointerI = PositionMap.
find(M.getPointer());
772 if (PointerI == PositionMap.
end())
774 for (
unsigned Pointer : PointerI->second) {
791 if (Group.addPointer(Pointer, *
this)) {
801 Groups.emplace_back(Pointer, *
this);
814 return (PtrToPartition[PtrIdx1] != -1 &&
815 PtrToPartition[PtrIdx1] == PtrToPartition[PtrIdx2]);
838 for (
const auto &[Idx, CG] :
enumerate(CheckingGroups))
839 PtrIndices[&CG] = Idx;
845 unsigned Depth)
const {
848 for (
const auto &[Check1, Check2] : Checks) {
849 const auto &
First = Check1->Members, &Second = Check2->Members;
851 OS.
indent(
Depth + 2) <<
"Comparing group GRP" << PtrIndices.at(Check1)
853 for (
unsigned K :
First)
855 OS.
indent(
Depth + 2) <<
"Against group GRP" << PtrIndices.at(Check2)
857 for (
unsigned K : Second)
870 OS.
indent(
Depth + 2) <<
"Group GRP" << PtrIndices.at(&CG) <<
":\n";
871 OS.
indent(
Depth + 4) <<
"(Low: " << *CG.Low <<
" High: " << *CG.High
873 for (
unsigned Member : CG.Members) {
885class AccessAnalysis {
887 using MemAccessInfo =
894 : TheLoop(TheLoop), BAA(*
AA), AST(BAA), LI(LI), DT(DT), DepCands(DA),
895 PSE(PSE), LoopAliasScopes(LoopAliasScopes) {
897 BAA.enableCrossIterationMode();
903 AST.add(adjustLoc(
Loc));
904 Accesses[MemAccessInfo(Ptr,
false)].insert(AccessTy);
906 ReadOnlyPtr.insert(Ptr);
910 void addStore(
const MemoryLocation &Loc,
Type *AccessTy) {
912 AST.add(adjustLoc(Loc));
913 Accesses[MemAccessInfo(Ptr,
true)].insert(AccessTy);
923 bool createCheckForAccess(RuntimePointerChecking &RtCheck,
926 DenseMap<Value *, unsigned> &DepSetId,
927 Loop *TheLoop,
unsigned &RunningDepId,
928 unsigned ASId,
bool Assume);
939 bool canCheckPtrAtRT(RuntimePointerChecking &RtCheck,
Loop *TheLoop,
941 Value *&UncomputablePtr,
bool AllowPartial,
942 const MemoryDepChecker &DepChecker);
946 void buildDependenceSets();
953 bool isDependencyCheckNeeded()
const {
return !CheckDeps.empty(); }
956 void resetDepChecks(MemoryDepChecker &DepChecker) {
964 using PtrAccessMap = MapVector<MemAccessInfo, SmallSetVector<Type *, 1>>;
968 MemoryLocation adjustLoc(MemoryLocation Loc)
const {
978 MDNode *adjustAliasScopeList(MDNode *ScopeList)
const {
985 return LoopAliasScopes.contains(cast<MDNode>(Scope));
1003 SmallPtrSet<Value*, 16> ReadOnlyPtr;
1010 AliasSetTracker AST;
1030 bool IsRTCheckAnalysisNeeded =
false;
1033 PredicatedScalarEvolution &PSE;
1035 DenseMap<Value *, SmallVector<const Value *, 16>> UnderlyingObjects;
1039 SmallPtrSetImpl<MDNode *> &LoopAliasScopes;
1044std::optional<int64_t>
1049 LLVM_DEBUG(
dbgs() <<
"LAA: Bad stride - Scalable object: " << *AccessTy
1051 return std::nullopt;
1057 dbgs() <<
"LAA: Bad stride - Not striding over innermost loop ";
1059 dbgs() << *Ptr <<
" ";
1061 dbgs() <<
"SCEV: " << *AR <<
"\n";
1063 return std::nullopt;
1070 const APInt *APStepVal;
1073 dbgs() <<
"LAA: Bad stride - Not a constant strided ";
1075 dbgs() << *Ptr <<
" ";
1076 dbgs() <<
"SCEV: " << *AR <<
"\n";
1078 return std::nullopt;
1082 TypeSize AllocSize =
DL.getTypeAllocSize(AccessTy);
1086 std::optional<int64_t> StepVal = APStepVal->
trySExtValue();
1088 return std::nullopt;
1091 return *StepVal %
Size ? std::nullopt : std::make_optional(*StepVal /
Size);
1100 std::optional<int64_t> Stride = std::nullopt,
1115 GEP &&
GEP->hasNoUnsignedSignedWrap()) {
1118 if (L->getHeader() == L->getLoopLatch() ||
1120 if (getLoadStorePointerOperand(U) != GEP)
1122 BasicBlock *UserBB = cast<Instruction>(U)->getParent();
1123 if (!L->contains(UserBB))
1125 return !LoopAccessInfo::blockNeedsPredication(UserBB, L, &DT);
1138 (Stride == 1 || Stride == -1))
1142 if (Ptr && Predicates) {
1149 <<
"LAA: Pointer: " << *Ptr <<
"\n"
1150 <<
"LAA: SCEV: " << *AR <<
"\n"
1151 <<
"LAA: Added an overflow assumption\n");
1164 while (!WorkList.
empty()) {
1166 if (!Visited.
insert(Ptr).second)
1172 if (PN && InnermostLoop.
contains(PN->getParent()) &&
1173 PN->getParent() != InnermostLoop.
getHeader()) {
1218 auto GetBinOpExpr = [&SE](
unsigned Opcode,
const SCEV *L,
const SCEV *R) {
1220 case Instruction::Add:
1222 case Instruction::Sub:
1230 unsigned Opcode =
I->getOpcode();
1232 case Instruction::GetElementPtr: {
1234 Type *SourceTy =
GEP->getSourceElementType();
1237 if (
I->getNumOperands() != 2 || SourceTy->
isVectorTy()) {
1247 bool NeedsFreeze =
any_of(BaseScevs, UndefPoisonCheck) ||
1248 any_of(OffsetScevs, UndefPoisonCheck);
1253 if (OffsetScevs.
size() == 2 && BaseScevs.
size() == 1)
1255 else if (BaseScevs.
size() == 2 && OffsetScevs.
size() == 1)
1258 ScevList.emplace_back(Scev, NeedsFreeze);
1269 for (
auto [
B, O] :
zip(BaseScevs, OffsetScevs)) {
1280 case Instruction::Select: {
1287 if (ChildScevs.
size() == 2)
1293 case Instruction::PHI: {
1298 if (
I->getNumOperands() == 2) {
1302 if (ChildScevs.
size() == 2)
1308 case Instruction::Add:
1309 case Instruction::Sub: {
1317 any_of(LScevs, UndefPoisonCheck) ||
any_of(RScevs, UndefPoisonCheck);
1322 if (LScevs.
size() == 2 && RScevs.
size() == 1)
1324 else if (RScevs.
size() == 2 && LScevs.
size() == 1)
1327 ScevList.emplace_back(Scev, NeedsFreeze);
1331 for (
auto [L, R] :
zip(LScevs, RScevs))
1332 ScevList.emplace_back(GetBinOpExpr(Opcode,
get<0>(L),
get<0>(R)),
1338 LLVM_DEBUG(
dbgs() <<
"ForkedPtr unhandled instruction: " << *
I <<
"\n");
1348 Loop *TheLoop,
unsigned &RunningDepId,
1349 unsigned ASId,
bool Assume) {
1357 "Must have some runtime-check pointer candidates");
1361 auto IsLoopInvariantOrAR =
1366 if (RTCheckPtrs.
size() == 2 &&
all_of(RTCheckPtrs, IsLoopInvariantOrAR)) {
1367 LLVM_DEBUG(
dbgs() <<
"LAA: Found forked pointer: " << *Ptr <<
"\n";
1369 <<
"\t(" << Idx <<
") " << *Q.getPointer() <<
"\n");
1377 for (
auto &
P : RTCheckPtrs) {
1396 if (RTCheckPtrs.size() == 1) {
1405 if (!
isNoWrap(PSE, AR, RTCheckPtrs.size() == 1 ? Ptr :
nullptr, AccessTy,
1406 TheLoop, DT, std::nullopt,
1407 Assume ? &Predicates :
nullptr))
1412 for (
const auto &[PtrExpr, NeedsFreeze] : RTCheckPtrs) {
1418 unsigned &LeaderId = DepSetId[Leader];
1420 LeaderId = RunningDepId++;
1424 DepId = RunningDepId++;
1426 bool IsWrite =
Access.getInt();
1427 RtCheck.
insert(TheLoop, Ptr, PtrExpr, AccessTy, IsWrite, DepId, ASId, PSE,
1429 LLVM_DEBUG(
dbgs() <<
"LAA: Found a runtime check ptr:" << *Ptr <<
'\n');
1438 Value *&UncomputablePtr,
bool AllowPartial,
1442 bool CanDoRT =
true;
1444 bool MayNeedRTCheck =
false;
1445 if (!IsRTCheckAnalysisNeeded)
return true;
1453 for (
const auto &Dep : *Deps) {
1457 "Should only skip safe dependences");
1461 Instruction *Dst = Dep.getDestination(DepChecker);
1473 for (
const auto &AS : AST) {
1474 int NumReadPtrChecks = 0;
1475 int NumWritePtrChecks = 0;
1476 bool CanDoAliasSetRT =
true;
1478 auto ASPointers = AS.getPointers();
1482 unsigned RunningDepId = 1;
1490 for (
const Value *ConstPtr : ASPointers) {
1492 bool IsWrite =
Accesses.contains(MemAccessInfo(Ptr,
true));
1494 ++NumWritePtrChecks;
1502 if (NumWritePtrChecks == 0 ||
1503 (NumWritePtrChecks == 1 && NumReadPtrChecks == 0)) {
1504 assert((ASPointers.size() <= 1 ||
1506 [
this](
const Value *Ptr) {
1507 MemAccessInfo AccessWrite(
const_cast<Value *
>(Ptr),
1509 return !DepCands.
contains(AccessWrite);
1511 "Can only skip updating CanDoRT below, if all entries in AS "
1512 "are reads or there is at most 1 entry");
1516 for (
auto &
Access : AccessInfos) {
1518 if (!createCheckForAccess(RtCheck,
Access, AccessTy, StridesMap,
1519 DepSetId, TheLoop, RunningDepId, ASId,
1522 << *
Access.getPointer() <<
'\n');
1524 CanDoAliasSetRT =
false;
1538 bool NeedsAliasSetRTCheck = RunningDepId > 2 || !Retries.
empty();
1542 if (NeedsAliasSetRTCheck && !CanDoAliasSetRT) {
1546 CanDoAliasSetRT =
true;
1547 for (
const auto &[
Access, AccessTy] : Retries) {
1548 if (!createCheckForAccess(RtCheck,
Access, AccessTy, StridesMap,
1549 DepSetId, TheLoop, RunningDepId, ASId,
1551 CanDoAliasSetRT =
false;
1552 UncomputablePtr =
Access.getPointer();
1559 CanDoRT &= CanDoAliasSetRT;
1560 MayNeedRTCheck |= NeedsAliasSetRTCheck;
1569 unsigned NumPointers = RtCheck.
Pointers.size();
1570 for (
unsigned i = 0; i < NumPointers; ++i) {
1571 for (
unsigned j = i + 1;
j < NumPointers; ++
j) {
1573 if (RtCheck.
Pointers[i].DependencySetId ==
1574 RtCheck.
Pointers[j].DependencySetId)
1587 dbgs() <<
"LAA: Runtime check would require comparison between"
1588 " different address spaces\n");
1594 if (MayNeedRTCheck && (CanDoRT || AllowPartial))
1598 <<
" pointer comparisons.\n");
1605 bool CanDoRTIfNeeded = !RtCheck.
Need || CanDoRT;
1606 assert(CanDoRTIfNeeded == (CanDoRT || !MayNeedRTCheck) &&
1607 "CanDoRTIfNeeded depends on RtCheck.Need");
1608 if (!CanDoRTIfNeeded && !AllowPartial)
1610 return CanDoRTIfNeeded;
1613void AccessAnalysis::buildDependenceSets() {
1623 dbgs() <<
"\t" << *
A.getPointer() <<
" ("
1626 : (ReadOnlyPtr.contains(
A.getPointer()) ?
"read-only"
1635 for (
const auto &AS : AST) {
1636 bool AliasSetHasWrite =
false;
1640 using UnderlyingObjToAccessMap =
1642 UnderlyingObjToAccessMap ObjToLastAccess;
1645 PtrAccessMap DeferredAccesses;
1650 auto ProcessAccesses = [&](
bool UseDeferred) {
1651 PtrAccessMap &S = UseDeferred ? DeferredAccesses :
Accesses;
1656 for (
const Value *ConstPtr : AS.getPointers()) {
1661 for (
auto [AccessPtr, IsWrite] : S.keys()) {
1662 if (AccessPtr != Ptr)
1667 bool IsReadOnlyPtr = ReadOnlyPtr.contains(Ptr) && !IsWrite;
1668 if (UseDeferred && !IsReadOnlyPtr)
1672 assert(((IsReadOnlyPtr && UseDeferred) || IsWrite ||
1673 S.contains(MemAccessInfo(Ptr,
false))) &&
1674 "Alias-set pointer not in the access set?");
1676 MemAccessInfo
Access(Ptr, IsWrite);
1684 if (!UseDeferred && IsReadOnlyPtr) {
1687 DeferredAccesses.insert({
Access, {}});
1695 if ((IsWrite || IsReadOnlyPtr) && AliasSetHasWrite) {
1696 CheckDeps.push_back(
Access);
1697 IsRTCheckAnalysisNeeded =
true;
1701 AliasSetHasWrite =
true;
1709 <<
"Underlying objects for pointer " << *Ptr <<
"\n");
1710 for (
const Value *UnderlyingObj : UOs) {
1719 auto [It,
Inserted] = ObjToLastAccess.try_emplace(
1734 ProcessAccesses(
false);
1735 ProcessAccesses(
true);
1740std::optional<int64_t>
1752 if (Predicates && !AR) {
1758 LLVM_DEBUG(
dbgs() <<
"LAA: Bad stride - Not an AddRecExpr pointer " << *Ptr
1759 <<
" SCEV: " << *PtrScev <<
"\n");
1760 return std::nullopt;
1763 std::optional<int64_t> Stride =
1765 if (!ShouldCheckWrap || !Stride)
1768 if (
isNoWrap(PSE, AR, Ptr, AccessTy, Lp, DT, Stride, Predicates))
1772 dbgs() <<
"LAA: Bad stride - Pointer may wrap in the address space "
1773 << *Ptr <<
" SCEV: " << *AR <<
"\n");
1774 return std::nullopt;
1783 bool Assume,
bool ShouldCheckWrap) {
1785 std::optional<int64_t> Stride =
1786 getPtrStride(PSE, AccessTy, Ptr, Lp, DT, StridesMap, ShouldCheckWrap,
1787 Assume ? &Predicates :
nullptr);
1797 assert(PtrA && PtrB &&
"Expected non-nullptr pointers.");
1805 return std::nullopt;
1812 return std::nullopt;
1813 unsigned IdxWidth =
DL.getIndexSizeInBits(ASA);
1815 APInt OffsetA(IdxWidth, 0), OffsetB(IdxWidth, 0);
1821 std::optional<int64_t> Val;
1822 if (PtrA1 == PtrB1) {
1829 return std::nullopt;
1831 IdxWidth =
DL.getIndexSizeInBits(ASA);
1832 OffsetA = OffsetA.sextOrTrunc(IdxWidth);
1841 std::optional<APInt> Diff =
1844 return std::nullopt;
1845 Val = Diff->trySExtValue();
1849 return std::nullopt;
1851 int64_t
Size =
DL.getTypeStoreSize(ElemTyA);
1852 int64_t Dist = *Val /
Size;
1856 if (!StrictCheck || Dist *
Size == Val)
1858 return std::nullopt;
1865 VL, [](
const Value *V) {
return V->getType()->isPointerTy(); }) &&
1866 "Expected list of pointer operands.");
1869 Value *Ptr0 = VL[0];
1871 using DistOrdPair = std::pair<int64_t, unsigned>;
1873 std::set<DistOrdPair,
decltype(Compare)> Offsets(Compare);
1874 Offsets.emplace(0, 0);
1875 bool IsConsecutive =
true;
1877 std::optional<int64_t> Diff =
1885 auto [It, IsInserted] = Offsets.emplace(
Offset, Idx);
1889 IsConsecutive &= std::next(It) == Offsets.end();
1891 SortedIndices.
clear();
1892 if (!IsConsecutive) {
1895 for (
auto [Idx, Off] :
enumerate(Offsets))
1896 SortedIndices[Idx] = Off.second;
1910 std::optional<int64_t> Diff =
1919 Accesses[MemAccessInfo(Ptr, true)].push_back(AccessIdx);
1920 InstMap.push_back(SI);
1927 [
this, LI](
Value *Ptr) {
1928 Accesses[MemAccessInfo(Ptr, false)].push_back(AccessIdx);
1929 InstMap.push_back(LI);
1995bool MemoryDepChecker::couldPreventStoreLoadForward(uint64_t Distance,
1996 uint64_t TypeByteSize,
1997 unsigned CommonStride) {
2009 uint64_t MaxVFWithoutSLForwardIssuesPowerOf2 =
2011 MaxStoreLoadForwardSafeDistanceInBits);
2015 for (uint64_t VF = 2 * TypeByteSize;
2016 VF <= MaxVFWithoutSLForwardIssuesPowerOf2; VF *= 2) {
2018 MaxVFWithoutSLForwardIssuesPowerOf2 = (VF >> 1);
2023 if (MaxVFWithoutSLForwardIssuesPowerOf2 < 2 * TypeByteSize) {
2025 dbgs() <<
"LAA: Distance " << Distance
2026 <<
" that could cause a store-load forwarding conflict\n");
2031 MaxVFWithoutSLForwardIssuesPowerOf2 <
2032 MaxStoreLoadForwardSafeDistanceInBits &&
2033 MaxVFWithoutSLForwardIssuesPowerOf2 !=
2036 bit_floor(MaxVFWithoutSLForwardIssuesPowerOf2 / CommonStride);
2037 uint64_t MaxVFInBits = MaxVF * TypeByteSize * 8;
2038 MaxStoreLoadForwardSafeDistanceInBits =
2039 std::min(MaxStoreLoadForwardSafeDistanceInBits, MaxVFInBits);
2043 dbgs() <<
"LAA: strided access with Distance " << Distance
2044 <<
" that could cause a store-load forwarding conflict\n");
2069 const SCEV &MaxBTC,
const SCEV &Dist,
2092 const SCEV *CastedDist = &Dist;
2093 const SCEV *CastedProduct = Product;
2100 if (DistTypeSizeBits > ProductTypeSizeBits)
2125 assert(Stride > 1 &&
"The stride must be greater than 1");
2126 assert(TypeByteSize > 0 &&
"The type size in byte must be non-zero");
2127 assert(Distance > 0 &&
"The distance must be non-zero");
2130 if (Distance % TypeByteSize)
2149 return Distance % Stride;
2152bool MemoryDepChecker::areAccessesCompletelyBeforeOrAfter(
const SCEV *Src,
2156 const SCEV *BTC = PSE.getBackedgeTakenCount();
2157 const SCEV *SymbolicMaxBTC = PSE.getSymbolicMaxBackedgeTakenCount();
2158 ScalarEvolution &SE = *PSE.getSE();
2159 const auto &[SrcStart_, SrcEnd_] =
2161 &SE, &PointerBounds, DT, AC, LoopGuards);
2165 const auto &[SinkStart_, SinkEnd_] =
2167 &SE, &PointerBounds, DT, AC, LoopGuards);
2186 MemoryDepChecker::DepDistanceStrideAndSizeInfo>
2187MemoryDepChecker::getDependenceDistanceStrideAndSize(
2188 const AccessAnalysis::MemAccessInfo &
A, Instruction *AInst,
2189 const AccessAnalysis::MemAccessInfo &
B, Instruction *BInst) {
2190 const auto &
DL = InnermostLoop->getHeader()->getDataLayout();
2191 auto &SE = *PSE.getSE();
2192 const auto &[APtr, AIsWrite] =
A;
2193 const auto &[BPtr, BIsWrite] =
B;
2196 if (!AIsWrite && !BIsWrite)
2203 if (APtr->getType()->getPointerAddressSpace() !=
2204 BPtr->getType()->getPointerAddressSpace())
2208 std::optional<int64_t> StrideAPtr =
2209 getPtrStride(PSE, ATy, APtr, InnermostLoop, *DT, SymbolicStrides,
2211 std::optional<int64_t> StrideBPtr =
2212 getPtrStride(PSE, BTy, BPtr, InnermostLoop, *DT, SymbolicStrides,
2214 PSE.addPredicates(Predicates);
2216 const SCEV *Src = PSE.getSCEV(APtr);
2217 const SCEV *
Sink = PSE.getSCEV(BPtr);
2222 if (StrideAPtr && *StrideAPtr < 0) {
2231 LLVM_DEBUG(
dbgs() <<
"LAA: Src Scev: " << *Src <<
"Sink Scev: " << *Sink
2233 LLVM_DEBUG(
dbgs() <<
"LAA: Distance for " << *AInst <<
" to " << *BInst
2234 <<
": " << *Dist <<
"\n");
2243 if (!StrideAPtr || !StrideBPtr) {
2244 LLVM_DEBUG(
dbgs() <<
"Pointer access with non-constant stride\n");
2248 int64_t StrideAPtrInt = *StrideAPtr;
2249 int64_t StrideBPtrInt = *StrideBPtr;
2250 LLVM_DEBUG(
dbgs() <<
"LAA: Src induction step: " << StrideAPtrInt
2251 <<
" Sink induction step: " << StrideBPtrInt <<
"\n");
2254 if (!StrideAPtrInt || !StrideBPtrInt) {
2257 if (!StrideAPtrInt && !StrideBPtrInt && Dist->
isZero())
2265 if ((StrideAPtrInt > 0) != (StrideBPtrInt > 0)) {
2267 dbgs() <<
"Pointer access with strides in different directions\n");
2271 TypeSize AStoreSz =
DL.getTypeStoreSize(ATy);
2272 TypeSize BStoreSz =
DL.getTypeStoreSize(BTy);
2278 uint64_t TypeByteSize = (AStoreSz == BStoreSz) ? BSz : 0;
2283 uint64_t MaxStride = std::max(StrideAScaled, StrideBScaled);
2285 std::optional<uint64_t> CommonStride;
2286 if (StrideAScaled == StrideBScaled)
2287 CommonStride = StrideAScaled;
2292 ShouldRetryWithRuntimeChecks |= StrideAPtrInt == StrideBPtrInt;
2300 return DepDistanceStrideAndSizeInfo(Dist, MaxStride, CommonStride,
2301 TypeByteSize, AIsWrite, BIsWrite);
2305MemoryDepChecker::isDependent(
const MemAccessInfo &
A,
unsigned AIdx,
2307 assert(AIdx < BIdx &&
"Must pass arguments in program order");
2312 auto CheckCompletelyBeforeOrAfter = [&]() {
2313 auto *APtr =
A.getPointer();
2314 auto *BPtr =
B.getPointer();
2317 const SCEV *Src = PSE.getSCEV(APtr);
2318 const SCEV *
Sink = PSE.getSCEV(BPtr);
2319 return areAccessesCompletelyBeforeOrAfter(Src, ATy, Sink, BTy);
2325 getDependenceDistanceStrideAndSize(
A, InstMap[AIdx],
B, InstMap[BIdx]);
2326 if (std::holds_alternative<Dependence::DepType>(Res)) {
2328 CheckCompletelyBeforeOrAfter())
2330 return std::get<Dependence::DepType>(Res);
2333 auto &[Dist, MaxStride, CommonStride, TypeByteSize, AIsWrite, BIsWrite] =
2334 std::get<DepDistanceStrideAndSizeInfo>(Res);
2335 bool HasSameSize = TypeByteSize > 0;
2337 ScalarEvolution &SE = *PSE.getSE();
2338 auto &
DL = InnermostLoop->getHeader()->getDataLayout();
2347 DL, SE, *(PSE.getSymbolicMaxBackedgeTakenCount()), *Dist, MaxStride))
2350 const APInt *APDist =
nullptr;
2355 LLVM_DEBUG(
dbgs() <<
"LAA: Constant distance does not fit in 64 bits.\n");
2365 if (ConstDist > 0 && CommonStride && CommonStride > 1 && HasSameSize &&
2384 LLVM_DEBUG(
dbgs() <<
"LAA: possibly zero dependence difference but "
2385 "different type sizes\n");
2389 bool IsTrueDataDependence = (AIsWrite && !BIsWrite);
2404 couldPreventStoreLoadForward(ConstDist, TypeByteSize)) {
2406 dbgs() <<
"LAA: Forward but may prevent st->ld forwarding\n");
2415 std::optional<int64_t> MinDistanceOpt =
2417 if (!MinDistanceOpt) {
2418 LLVM_DEBUG(
dbgs() <<
"LAA: Minimum distance does not fit in 64 bits.\n");
2421 int64_t MinDistance = *MinDistanceOpt;
2423 if (MinDistance <= 0) {
2429 if (CheckCompletelyBeforeOrAfter())
2431 LLVM_DEBUG(
dbgs() <<
"LAA: ReadWrite-Write positive dependency with "
2432 "different type sizes\n");
2436 unsigned MinForcedFactor =
2441 unsigned MinNumIter = std::max(MinForcedFactor * ForcedUnroll, 2U);
2476 uint64_t MinDistanceNeeded = MaxStride * (MinNumIter - 1) + TypeByteSize;
2477 if (MinDistanceNeeded >
static_cast<uint64_t>(MinDistance)) {
2486 LLVM_DEBUG(
dbgs() <<
"LAA: Failure because of positive minimum distance "
2487 << MinDistance <<
'\n');
2493 if (MinDistanceNeeded > MinDepDistBytes) {
2495 << MinDistanceNeeded <<
" size in bytes\n");
2500 std::min(
static_cast<uint64_t>(MinDistance), MinDepDistBytes);
2502 bool IsTrueDataDependence = (!AIsWrite && BIsWrite);
2504 couldPreventStoreLoadForward(MinDistance, TypeByteSize, *CommonStride))
2507 uint64_t MaxVF = MinDepDistBytes / MaxStride;
2508 LLVM_DEBUG(
dbgs() <<
"LAA: Positive min distance " << MinDistance
2509 <<
" with max VF = " << MaxVF <<
'\n');
2511 uint64_t MaxVFInBits = MaxVF * TypeByteSize * 8;
2512 if (!ConstDist && MaxVFInBits < MaxTargetVectorWidthInBits) {
2521 if (CheckCompletelyBeforeOrAfter())
2524 MaxSafeVectorWidthInBits = std::min(MaxSafeVectorWidthInBits, MaxVFInBits);
2531 MinDepDistBytes = -1;
2546 bool AIIsWrite = AI->getInt();
2550 (AIIsWrite ? AI : std::next(AI));
2553 auto &Acc = Accesses[*AI];
2554 for (std::vector<unsigned>::iterator I1 = Acc.begin(), I1E = Acc.end();
2559 for (std::vector<unsigned>::iterator
2560 I2 = (OI == AI ? std::next(I1) : Accesses[*OI].begin()),
2561 I2E = (OI == AI ? I1E : Accesses[*OI].end());
2563 auto A = std::make_pair(&*AI, *I1);
2564 auto B = std::make_pair(&*OI, *I2);
2571 isDependent(*
A.first,
A.second, *
B.first,
B.second);
2578 if (RecordDependences) {
2580 Dependences.emplace_back(
A.second,
B.second,
Type);
2583 RecordDependences =
false;
2584 Dependences.clear();
2586 <<
"Too many dependences, stopped recording\n");
2598 LLVM_DEBUG(
dbgs() <<
"Total Dependences: " << Dependences.size() <<
"\n");
2605 auto I = Accesses.find(
Access);
2607 if (
I != Accesses.end()) {
2608 transform(
I->second, std::back_inserter(Insts),
2609 [&](
unsigned Idx) { return this->InstMap[Idx]; });
2621 "ForwardButPreventsForwarding",
2623 "BackwardVectorizable",
2624 "BackwardVectorizableButPreventsForwarding"};
2634bool LoopAccessInfo::canAnalyzeLoop() {
2643 recordAnalysis(
"NotInnerMostLoop") <<
"loop is not the innermost loop";
2650 dbgs() <<
"LAA: loop control flow is not understood by analyzer\n");
2651 recordAnalysis(
"CFGNotUnderstood")
2652 <<
"loop control flow is not understood by analyzer";
2661 recordAnalysis(
"CantComputeNumberOfIterations")
2662 <<
"could not determine number of loop iterations";
2663 LLVM_DEBUG(
dbgs() <<
"LAA: SCEV could not compute the loop exit count.\n");
2672bool LoopAccessInfo::analyzeLoop(AAResults *AA,
const LoopInfo *LI,
2673 const TargetLibraryInfo *TLI,
2674 DominatorTree *DT) {
2678 SmallPtrSet<MDNode *, 8> LoopAliasScopes;
2681 unsigned NumReads = 0;
2682 unsigned NumReadWrites = 0;
2684 bool HasComplexMemInst =
false;
2687 HasConvergentOp =
false;
2689 PtrRtChecking->Pointers.
clear();
2690 PtrRtChecking->Need =
false;
2694 const bool EnableMemAccessVersioningOfLoop =
2700 LoopBlocksRPO RPOT(TheLoop);
2706 for (BasicBlock *BB : RPOT) {
2709 for (Instruction &
I : *BB) {
2712 HasConvergentOp =
true;
2717 if (HasComplexMemInst && HasConvergentOp)
2721 if (HasComplexMemInst)
2726 for (
Metadata *
Op : Decl->getScopeList()->operands())
2739 if (
I.mayReadFromMemory()) {
2740 auto hasPointerArgs = [](CallBase *CB) {
2742 return Arg->getType()->isPointerTy();
2755 recordAnalysis(
"CantVectorizeInstruction", &
I)
2756 <<
"instruction cannot be vectorized";
2757 HasComplexMemInst =
true;
2760 if (!Ld->isSimple() && !IsAnnotatedParallel) {
2761 recordAnalysis(
"NonSimpleLoad", Ld)
2762 <<
"read with atomic ordering or volatile read";
2764 HasComplexMemInst =
true;
2770 if (EnableMemAccessVersioningOfLoop)
2771 collectStridedAccess(Ld);
2776 if (
I.mayWriteToMemory()) {
2779 recordAnalysis(
"CantVectorizeInstruction", &
I)
2780 <<
"instruction cannot be vectorized";
2781 HasComplexMemInst =
true;
2784 if (!St->isSimple() && !IsAnnotatedParallel) {
2785 recordAnalysis(
"NonSimpleStore", St)
2786 <<
"write with atomic ordering or volatile write";
2788 HasComplexMemInst =
true;
2794 if (EnableMemAccessVersioningOfLoop)
2795 collectStridedAccess(St);
2800 if (HasComplexMemInst)
2808 if (!Stores.
size()) {
2814 AccessAnalysis
Accesses(TheLoop, AA, LI, *DT, DepCands, *PSE,
2822 SmallSet<std::pair<Value *, Type *>, 16> Seen;
2826 SmallPtrSet<Value *, 16> UniformStores;
2828 for (StoreInst *ST : Stores) {
2829 Value *Ptr =
ST->getPointerOperand();
2831 if (isInvariant(Ptr)) {
2833 StoresToInvariantAddresses.push_back(ST);
2834 HasStoreStoreDependenceInvolvingLoopInvariantAddress |=
2835 !UniformStores.
insert(Ptr).second;
2841 if (Seen.
insert({Ptr, AccessTy}).second) {
2848 if (blockNeedsPredication(
ST->getParent(), TheLoop, DT))
2854 [&Accesses, AccessTy, Loc](
Value *Ptr) {
2855 MemoryLocation NewLoc = Loc.getWithNewPtr(Ptr);
2856 Accesses.addStore(NewLoc, AccessTy);
2861 if (IsAnnotatedParallel) {
2863 dbgs() <<
"LAA: A loop annotated parallel, ignore memory dependency "
2868 for (LoadInst *LD : Loads) {
2869 Value *Ptr =
LD->getPointerOperand();
2878 bool IsReadOnlyPtr =
false;
2880 if (Seen.
insert({Ptr, AccessTy}).second ||
2881 !
getPtrStride(*PSE, AccessTy, Ptr, TheLoop, *DT, SymbolicStrides,
false,
2884 IsReadOnlyPtr =
true;
2890 LLVM_DEBUG(
dbgs() <<
"LAA: Found an unsafe dependency between a uniform "
2891 "load and uniform store to the same address!\n");
2892 HasLoadStoreDependenceInvolvingLoopInvariantAddress =
true;
2899 if (blockNeedsPredication(
LD->getParent(), TheLoop, DT))
2905 [&Accesses, AccessTy, Loc, IsReadOnlyPtr](
Value *Ptr) {
2906 MemoryLocation NewLoc = Loc.getWithNewPtr(Ptr);
2907 Accesses.addLoad(NewLoc, AccessTy, IsReadOnlyPtr);
2914 if (NumReadWrites == 1 && NumReads == 0) {
2921 Accesses.buildDependenceSets();
2925 Value *UncomputablePtr =
nullptr;
2926 HasCompletePtrRtChecking =
2927 Accesses.canCheckPtrAtRT(*PtrRtChecking, TheLoop, SymbolicStrides,
2928 UncomputablePtr, AllowPartial, getDepChecker());
2929 if (!HasCompletePtrRtChecking) {
2931 recordAnalysis(
"CantIdentifyArrayBounds",
I)
2932 <<
"cannot identify array bounds";
2933 LLVM_DEBUG(
dbgs() <<
"LAA: We can't vectorize because we can't find "
2934 <<
"the array bounds.\n");
2939 dbgs() <<
"LAA: May be able to perform a memory runtime check if needed.\n");
2941 bool DepsAreSafe =
true;
2942 if (Accesses.isDependencyCheckNeeded()) {
2945 DepChecker->
areDepsSafe(DepCands, Accesses.getDependenciesToCheck());
2950 PtrRtChecking->reset();
2951 PtrRtChecking->Need =
true;
2953 UncomputablePtr =
nullptr;
2954 HasCompletePtrRtChecking = Accesses.canCheckPtrAtRT(
2955 *PtrRtChecking, TheLoop, SymbolicStrides, UncomputablePtr,
2956 AllowPartial, getDepChecker());
2959 if (!HasCompletePtrRtChecking) {
2961 recordAnalysis(
"CantCheckMemDepsAtRunTime",
I)
2962 <<
"cannot check memory dependencies at runtime";
2963 LLVM_DEBUG(
dbgs() <<
"LAA: Can't vectorize with memory checks\n");
2968 Accesses.resetDepChecks(*DepChecker);
2978 for (
const auto &Dep : *Deps) {
2982 Instruction *Dst = Dep.getDestination(*DepChecker);
2984 HasLoadStoreDependenceInvolvingLoopInvariantAddress =
true;
2987 "Expected both to be stores");
2988 HasStoreStoreDependenceInvolvingLoopInvariantAddress =
true;
2993 if (HasConvergentOp) {
2994 recordAnalysis(
"CantInsertRuntimeCheckWithConvergent")
2995 <<
"cannot add control dependency to convergent operation";
2996 LLVM_DEBUG(
dbgs() <<
"LAA: We can't vectorize because a runtime check "
2997 "would be needed with a convergent operation\n");
3003 dbgs() <<
"LAA: No unsafe dependent memory operations in loop. We"
3004 << (PtrRtChecking->Need ?
"" :
" don't")
3005 <<
" need runtime memory checks.\n");
3009 emitUnsafeDependenceRemark();
3013void LoopAccessInfo::emitUnsafeDependenceRemark() {
3014 const auto *Deps = getDepChecker().getDependences();
3022 if (Found == Deps->end())
3024 MemoryDepChecker::Dependence Dep = *Found;
3026 LLVM_DEBUG(
dbgs() <<
"LAA: unsafe dependent memory operations in loop\n");
3029 bool HasForcedDistribution =
3032 const std::string
Info =
3033 HasForcedDistribution
3034 ?
"unsafe dependent memory operations in loop."
3035 :
"unsafe dependent memory operations in loop. Use "
3036 "#pragma clang loop distribute(enable) to allow loop distribution "
3037 "to attempt to isolate the offending operations into a separate "
3039 OptimizationRemarkAnalysis &
R =
3048 R <<
"\nBackward loop carried data dependence.";
3051 R <<
"\nForward loop carried data dependence that prevents "
3052 "store-to-load forwarding.";
3055 R <<
"\nBackward loop carried data dependence that prevents "
3056 "store-to-load forwarding.";
3059 R <<
"\nUnsafe indirect dependence.";
3062 R <<
"\nUnsafe dependence on loop-invariant address.";
3065 R <<
"\nUnknown data dependence.";
3069 if (Instruction *
I = Dep.
getSource(getDepChecker())) {
3072 SourceLoc = DD->getDebugLoc();
3074 R <<
" Memory location is the same as accessed at "
3075 <<
ore::NV(
"Location", SourceLoc);
3080 const Loop *TheLoop,
3082 assert(TheLoop->contains(BB) &&
"Unknown block used");
3085 const BasicBlock *Latch = TheLoop->getLoopLatch();
3086 assert(Latch &&
"Loop expected to have a single latch.");
3092 assert(!Report &&
"Multiple reports generated");
3098 CodeRegion =
I->getParent();
3101 if (
I->getDebugLoc())
3102 DL =
I->getDebugLoc();
3105 Report = std::make_unique<OptimizationRemarkAnalysis>(
DEBUG_TYPE, RemarkName,
3111 auto *SE = PSE->getSE();
3112 if (TheLoop->isLoopInvariant(V))
3129 for (
const Use &U :
GEP->operands()) {
3151 Value *OrigPtr = Ptr;
3159 V =
C->getOperand();
3182void LoopAccessInfo::collectStridedAccess(
Value *MemAccess) {
3200 LLVM_DEBUG(
dbgs() <<
"LAA: Found a strided access that is a candidate for "
3202 LLVM_DEBUG(
dbgs() <<
" Ptr: " << *Ptr <<
" Stride: " << *StrideExpr <<
"\n");
3205 LLVM_DEBUG(
dbgs() <<
" Chose not to due to -laa-speculate-unit-stride\n");
3222 const SCEV *MaxBTC = PSE->getSymbolicMaxBackedgeTakenCount();
3230 const SCEV *CastedStride = StrideExpr;
3231 const SCEV *CastedBECount = MaxBTC;
3232 ScalarEvolution *SE = PSE->getSE();
3233 if (BETypeSizeBits >= StrideTypeSizeBits)
3237 const SCEV *StrideMinusBETaken = SE->
getMinusSCEV(CastedStride, CastedBECount);
3243 dbgs() <<
"LAA: Stride>=TripCount; No point in versioning as the "
3244 "Stride==1 predicate will imply that the loop executes "
3248 LLVM_DEBUG(
dbgs() <<
"LAA: Found a strided access that we can version.\n");
3252 const SCEV *StrideBase = StrideExpr;
3254 StrideBase =
C->getOperand();
3256 "users of the map rely on the stride being loop invariant");
3266 PtrRtChecking(nullptr), TheLoop(L), AllowPartial(AllowPartial) {
3267 unsigned MaxTargetVectorWidthInBits = std::numeric_limits<unsigned>::max();
3268 if (
TTI && !
TTI->enableScalableVectorization())
3271 MaxTargetVectorWidthInBits =
3274 DepChecker = std::make_unique<MemoryDepChecker>(
3275 *PSE, AC, DT, L, SymbolicStrides, MaxTargetVectorWidthInBits, LoopGuards);
3277 std::make_unique<RuntimePointerChecking>(*DepChecker, SE, LoopGuards);
3278 if (canAnalyzeLoop())
3279 CanVecMem = analyzeLoop(
AA, LI, TLI, DT);
3284 OS.
indent(
Depth) <<
"Memory dependences are safe";
3287 OS <<
" with a maximum safe vector width of "
3291 OS <<
", with a maximum safe store-load forward width of " << SLDist
3294 if (PtrRtChecking->Need)
3295 OS <<
" with run-time checks";
3299 if (HasConvergentOp)
3300 OS.
indent(
Depth) <<
"Has convergent operation in loop\n";
3303 OS.
indent(
Depth) <<
"Report: " << Report->getMsg() <<
"\n";
3305 if (
auto *Dependences = DepChecker->getDependences()) {
3307 for (
const auto &Dep : *Dependences) {
3308 Dep.
print(OS,
Depth + 2, DepChecker->getMemoryInstructions());
3312 OS.
indent(
Depth) <<
"Too many dependences, not recorded\n";
3315 PtrRtChecking->print(OS,
Depth);
3316 if (PtrRtChecking->Need && !HasCompletePtrRtChecking)
3317 OS.
indent(
Depth) <<
"Generated run-time checks are incomplete\n";
3321 <<
"Non vectorizable stores to invariant address were "
3322 << (HasStoreStoreDependenceInvolvingLoopInvariantAddress ||
3323 HasLoadStoreDependenceInvolvingLoopInvariantAddress
3326 <<
"found in loop.\n";
3329 PSE->getPredicate().print(OS,
Depth);
3334 PSE->print(OS,
Depth);
3338 bool AllowPartial) {
3339 const auto &[It, Inserted] = LoopAccessInfoMap.try_emplace(&L);
3343 if (Inserted || It->second->hasAllowPartial() != AllowPartial)
3344 It->second = std::make_unique<LoopAccessInfo>(&L, &SE, TTI, TLI, &AA, &DT,
3345 &LI, AC, AllowPartial);
3354 LoopAccessInfoMap.remove_if([](
const auto &Entry) {
3355 const auto &LAI = Entry.second;
3356 return !(LAI->getRuntimePointerChecking()->getChecks().empty() &&
3357 LAI->getPSE().getPredicate().isAlwaysTrue());
3363 FunctionAnalysisManager::Invalidator &Inv) {
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
DXIL Forward Handle Accesses
This file defines the DenseMap class.
Generic implementation of equivalence classes through the use Tarjan's efficient union-find algorithm...
This header defines various interfaces for pass management in LLVM.
static cl::opt< unsigned > MaxDependences("max-dependences", cl::Hidden, cl::desc("Maximum number of dependences collected by " "loop-access analysis (default = 100)"), cl::init(100))
We collect dependences up to this threshold.
static cl::opt< bool > EnableForwardingConflictDetection("store-to-load-forwarding-conflict-detection", cl::Hidden, cl::desc("Enable conflict detection in loop-access analysis"), cl::init(true))
Enable store-to-load forwarding conflict detection.
static void findForkedSCEVs(ScalarEvolution *SE, const Loop *L, Value *Ptr, SmallVectorImpl< PointerIntPair< const SCEV *, 1, bool > > &ScevList, unsigned Depth)
static const SCEV * mulSCEVNoOverflow(const SCEV *A, const SCEV *B, ScalarEvolution &SE)
Returns A * B, if it is guaranteed not to unsigned wrap.
static bool isNoWrap(PredicatedScalarEvolution &PSE, const SCEVAddRecExpr *AR, Value *Ptr, Type *AccessTy, const Loop *L, const DominatorTree &DT, std::optional< int64_t > Stride=std::nullopt, SmallVectorImpl< const SCEVPredicate * > *Predicates=nullptr)
Check whether AR is a non-wrapping AddRec.
static cl::opt< unsigned > MemoryCheckMergeThreshold("memory-check-merge-threshold", cl::Hidden, cl::desc("Maximum number of comparisons done when trying to merge " "runtime memory checks. (default = 100)"), cl::init(100))
The maximum iterations used to merge memory checks.
static const SCEV * getStrideFromPointer(Value *Ptr, ScalarEvolution *SE, Loop *Lp)
Get the stride of a pointer access in a loop.
static bool isKnownNonDecreasingInLoop(const SCEV *S, const Loop *L, ScalarEvolution &SE)
Return true if S is known to be monotonically non-decreasing (in the unsigned sense,...
static cl::opt< ElementCount, true > VectorizationFactor("force-vector-width", cl::Hidden, cl::desc("Sets the SIMD width. Zero is autoselect."), cl::location(VectorizerParams::VectorizationFactor))
static bool evaluatePtrAddRecAtMaxBTCWillNotWrap(const SCEVAddRecExpr *AR, const SCEV *MaxBTC, const SCEV *EltSize, ScalarEvolution &SE, const DataLayout &DL, DominatorTree *DT, AssumptionCache *AC, std::optional< ScalarEvolution::LoopGuards > &LoopGuards)
Return true, if evaluating AR at MaxBTC cannot wrap, because AR at MaxBTC is guaranteed inbounds of t...
static cl::opt< unsigned, true > VectorizationInterleave("force-vector-interleave", cl::Hidden, cl::desc("Sets the vectorization interleave count. " "Zero is autoselect."), cl::location(VectorizerParams::VectorizationInterleave))
static cl::opt< bool, true > HoistRuntimeChecks("hoist-runtime-checks", cl::Hidden, cl::desc("Hoist inner loop runtime memory checks to outer loop if possible"), cl::location(VectorizerParams::HoistRuntimeChecks), cl::init(true))
static DenseMap< const RuntimeCheckingPtrGroup *, unsigned > getPtrToIdxMap(ArrayRef< RuntimeCheckingPtrGroup > CheckingGroups)
Assign each RuntimeCheckingPtrGroup pointer an index for stable UTC output.
static cl::opt< unsigned, true > RuntimeMemoryCheckThreshold("runtime-memory-check-threshold", cl::Hidden, cl::desc("When performing memory disambiguation checks at runtime do not " "generate more than this number of comparisons (default = 8)."), cl::location(VectorizerParams::RuntimeMemoryCheckThreshold), cl::init(8))
static void visitPointers(Value *StartPtr, const Loop &InnermostLoop, function_ref< void(Value *)> AddPointer)
static bool isSafeDependenceDistance(const DataLayout &DL, ScalarEvolution &SE, const SCEV &MaxBTC, const SCEV &Dist, uint64_t MaxStride)
Given a dependence-distance Dist between two memory accesses, that have strides in the same direction...
static std::pair< const SCEV *, const SCEV * > getNonAffineMonotonicBounds(const Loop *Lp, const SCEV *PtrExpr, ScalarEvolution *SE)
Try to bound a loop-variant pointer that is not an affine AddRec.
static bool areStridedAccessesIndependent(uint64_t Distance, uint64_t Stride, uint64_t TypeByteSize)
Check the dependence for two accesses with the same stride Stride.
static const SCEV * getMinFromExprs(const SCEV *I, const SCEV *J, ScalarEvolution *SE)
Compare I and J and return the minimum.
static Value * getLoopVariantGEPOperand(Value *Ptr, ScalarEvolution *SE, Loop *Lp)
If Ptr is a GEP, which has a loop-variant operand, return that operand.
static cl::opt< unsigned > MaxForkedSCEVDepth("max-forked-scev-depth", cl::Hidden, cl::desc("Maximum recursion depth when finding forked SCEVs (default = 5)"), cl::init(5))
static cl::opt< bool > SpeculateUnitStride("laa-speculate-unit-stride", cl::Hidden, cl::desc("Speculate that non-constant strides are unit in LAA"), cl::init(true))
static cl::opt< bool > EnableMemAccessVersioning("enable-mem-access-versioning", cl::init(true), cl::Hidden, cl::desc("Enable symbolic stride memory access versioning"))
This enables versioning on the strides of symbolically striding memory accesses in code like the foll...
static const SCEV * addSCEVNoOverflow(const SCEV *A, const SCEV *B, ScalarEvolution &SE)
Returns A + B, if it is guaranteed not to unsigned wrap.
This header provides classes for managing per-loop analyses.
This file provides utility analysis objects describing memory locations.
FunctionAnalysisManager FAM
This file defines the PointerIntPair class.
This file implements a set that has insertion order iteration characteristics.
This file defines the SmallPtrSet class.
This file defines the SmallSet class.
This file defines the SmallVector class.
static SymbolRef::Type getType(const Symbol *Sym)
static const X86InstrFMA3Group Groups[]
A manager for alias analyses.
Class for arbitrary precision integers.
std::optional< uint64_t > tryZExtValue() const
Get zero extended value if possible.
APInt abs() const
Get the absolute value.
LLVM_ABI APInt sextOrTrunc(unsigned width) const
Sign extend or truncate to width.
std::optional< int64_t > trySExtValue() const
Get sign extended value if possible.
This templated class represents "all analyses that operate over <aparticular IR unit>" (e....
Represent a constant reference to an array (0 or more elements consecutively in memory),...
size_t size() const
Get the array size.
bool empty() const
Check if the array is empty.
A function analysis which provides an AssumptionCache.
A cache of @llvm.assume calls within a function.
LLVM Basic Block Representation.
const Function * getParent() const
Return the enclosing method, or null if none.
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this basic block belongs to.
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
bool isConvergent() const
Determine if the invoke is convergent.
@ ICMP_UGE
unsigned greater or equal
@ ICMP_SGE
signed greater or equal
@ ICMP_ULE
unsigned less or equal
static LLVM_ABI Constant * getIntToPtr(Constant *C, Type *Ty, bool OnlyIfReduced=false)
static LLVM_ABI Constant * getAllOnesValue(Type *Ty)
A parsed version of the target data layout string in and methods for querying it.
ValueT lookup(const_arg_type_t< KeyT > Val) const
Return the entry for the specified key, or a default constructed value if no such entry exists.
iterator find(const_arg_type_t< KeyT > Val)
Analysis pass which computes a DominatorTree.
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
LLVM_ABI bool dominates(const BasicBlock *BB, const Use &U) const
Return true if the (end of the) basic block BB dominates the use U.
iterator_range< member_iterator > members(const ECValue &ECV) const
bool contains(const ElemTy &V) const
Returns true if V is contained an equivalence class.
const ECValue & insert(const ElemTy &Data)
Insert a new value into the union/find set, ignoring the request if the value already exists.
member_iterator member_end() const
const ElemTy & getLeaderValue(const ElemTy &V) const
Return the leader for the specified value that is in the set.
member_iterator findLeader(const ElemTy &V) const
Given a value in the set, return a member iterator for the equivalence class it is in.
void eraseClass(const ElemTy &V)
Erase the class containing V, i.e.
member_iterator unionSets(const ElemTy &V1, const ElemTy &V2)
Merge the two equivalence sets for the specified values, inserting them if they do not already exist ...
bool hasOptSize() const
Optimize this function for size (-Os) or minimum size (-Oz).
PointerType * getType() const
Global values are always pointers.
An instruction for reading from memory.
Value * getPointerOperand()
static constexpr LocationSize beforeOrAfterPointer()
Any location before or after the base pointer (but still within the underlying object).
This analysis provides dependence information for the memory accesses of a loop.
LLVM_ABI Result run(Function &F, FunctionAnalysisManager &AM)
LLVM_ABI bool invalidate(Function &F, const PreservedAnalyses &PA, FunctionAnalysisManager::Invalidator &Inv)
LLVM_ABI const LoopAccessInfo & getInfo(Loop &L, bool AllowPartial=false)
Drive the analysis of memory accesses in the loop.
const MemoryDepChecker & getDepChecker() const
the Memory Dependence Checker which can determine the loop-independent and loop-carried dependences b...
LLVM_ABI bool isInvariant(Value *V) const
Returns true if value V is loop invariant.
LLVM_ABI void print(raw_ostream &OS, unsigned Depth=0) const
Print the information about the memory accesses in the loop.
static LLVM_ABI bool blockNeedsPredication(const BasicBlock *BB, const Loop *TheLoop, const DominatorTree *DT)
Return true if the block BB needs to be predicated in order for the loop to be vectorized.
LLVM_ABI LoopAccessInfo(Loop *L, ScalarEvolution *SE, const TargetTransformInfo *TTI, const TargetLibraryInfo *TLI, AAResults *AA, DominatorTree *DT, LoopInfo *LI, AssumptionCache *AC, bool AllowPartial=false)
Analysis pass that exposes the LoopInfo for a function.
bool contains(const LoopT *L) const
Return true if the specified loop is contained within this loop.
bool isInnermost() const
Return true if the loop does not contain any (natural) loops.
unsigned getNumBackEdges() const
Calculate the number of back edges to the loop header.
BlockT * getHeader() const
LoopT * getParentLoop() const
Return the parent loop if it exists or nullptr for top level loops.
Represents a single loop in the control flow graph.
std::string getLocStr() const
Return a string containing the debug location of the loop (file name + line number if present,...
bool isAnnotatedParallel() const
Returns true if the loop is annotated parallel.
DebugLoc getStartLoc() const
Return the debug location of the start of this loop.
ArrayRef< MDOperand > operands() const
Checks memory dependences among accesses to the same underlying object to determine whether there vec...
ArrayRef< unsigned > getOrderForAccess(Value *Ptr, bool IsWrite) const
Return the program order indices for the access location (Ptr, IsWrite).
bool isSafeForAnyStoreLoadForwardDistances() const
Return true if there are no store-load forwarding dependencies.
LLVM_ABI bool areDepsSafe(const DepCandidates &AccessSets, ArrayRef< MemAccessInfo > CheckDeps)
Check whether the dependencies between the accesses are safe, and records the dependence information ...
bool isSafeForAnyVectorWidth() const
Return true if the number of elements that are safe to operate on simultaneously is not bounded.
static bool isStoreLoadForwardingConflict(uint64_t Distance, uint64_t VectorStoreSize, uint64_t TypeByteSize, uint64_t LoadElementSize=0)
Returns true if a memory dependence at byte distance Distance between a store (with element size Type...
PointerIntPair< Value *, 1, bool > MemAccessInfo
EquivalenceClasses< MemAccessInfo > DepCandidates
Set of potential dependent memory accesses.
bool shouldRetryWithRuntimeChecks() const
In same cases when the dependency check fails we can still vectorize the loop with a dynamic array ac...
const Loop * getInnermostLoop() const
uint64_t getMaxSafeVectorWidthInBits() const
Return the number of elements that are safe to operate on simultaneously, multiplied by the size of t...
bool isSafeForVectorization() const
No memory dependence was encountered that would inhibit vectorization.
const SmallVectorImpl< Dependence > * getDependences() const
Returns the memory dependences.
LLVM_ABI SmallVector< Instruction *, 4 > getInstructionsForAccess(Value *Ptr, bool isWrite) const
Find the set of instructions that read or write via Ptr.
VectorizationSafetyStatus
Type to keep track of the status of the dependence check.
@ PossiblySafeWithRtChecks
LLVM_ABI void addAccess(StoreInst *SI)
Register the location (instructions are given increasing numbers) of a write access.
uint64_t getStoreLoadForwardSafeDistanceInBits() const
Return safe power-of-2 number of elements, which do not prevent store-load forwarding,...
Representation for a specific memory location.
static LLVM_ABI MemoryLocation get(const LoadInst *LI)
Return a location with information about the memory reference by the given instruction.
LocationSize Size
The maximum size of the location, in address-units, or UnknownSize if the size is not known.
AAMDNodes AATags
The metadata nodes which describes the aliasing of the location (each member is null if that kind of ...
const Value * Ptr
The address of the start of the location.
PointerIntPair - This class implements a pair of a pointer and small integer.
An interface layer with SCEV used to manage how we see SCEV expressions for values in the context of ...
LLVM_ABI void addPredicate(const SCEVPredicate &Pred)
Adds a new predicate.
ScalarEvolution * getSE() const
Returns the ScalarEvolution analysis used.
LLVM_ABI bool hasNoOverflow(Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags)
Returns true if we've statically proved that V doesn't wrap.
LLVM_ABI const SCEVAddRecExpr * getAsAddRec(Value *V, SmallVectorImpl< const SCEVPredicate * > *WrapPredsAdded=nullptr)
Attempts to produce an AddRecExpr for V by adding additional SCEV predicates.
LLVM_ABI void addPredicates(ArrayRef< const SCEVPredicate * > Preds)
Adds all predicates in Preds.
LLVM_ABI const SCEV * getBackedgeTakenCount()
Get the (predicated) backedge count for the analyzed loop.
LLVM_ABI const SCEV * getSymbolicMaxBackedgeTakenCount()
Get the (predicated) symbolic max backedge count for the analyzed loop.
LLVM_ABI const SCEV * getSCEV(Value *V)
Returns the SCEV expression of V, in the context of the current SCEV predicate.
A set of analyses that are preserved following a run of a transformation pass.
PreservedAnalysisChecker getChecker() const
Build a checker for this PreservedAnalyses and the specified analysis type.
Holds information about the memory runtime legality checks to verify that a group of pointers do not ...
bool Need
This flag indicates if we need to add the runtime check.
void reset()
Reset the state of the pointer runtime information.
unsigned getNumberOfChecks() const
Returns the number of run-time checks required according to needsChecking.
LLVM_ABI void printChecks(raw_ostream &OS, const SmallVectorImpl< RuntimePointerCheck > &Checks, unsigned Depth=0) const
Print Checks.
LLVM_ABI bool needsChecking(const RuntimeCheckingPtrGroup &M, const RuntimeCheckingPtrGroup &N) const
Decide if we need to add a check between two groups of pointers, according to needsChecking.
LLVM_ABI void print(raw_ostream &OS, unsigned Depth=0) const
Print the list run-time memory checks necessary.
SmallVector< RuntimeCheckingPtrGroup, 2 > CheckingGroups
Holds a partitioning of pointers into "check groups".
friend struct RuntimeCheckingPtrGroup
static LLVM_ABI bool arePointersInSamePartition(const SmallVectorImpl< int > &PtrToPartition, unsigned PtrIdx1, unsigned PtrIdx2)
Check if pointers are in the same partition.
LLVM_ABI void generateChecks(MemoryDepChecker::DepCandidates &DepCands)
Generate the checks and store it.
SmallVector< PointerInfo, 2 > Pointers
Information about the pointers that may require checking.
LLVM_ABI void insert(Loop *Lp, Value *Ptr, const SCEV *PtrExpr, Type *AccessTy, bool WritePtr, unsigned DepSetId, unsigned ASId, PredicatedScalarEvolution &PSE, bool NeedsFreeze)
Insert a pointer and calculate the start and end SCEVs.
This node represents a polynomial recurrence on the trip count of the specified loop.
bool isAffine() const
Return true if this represents an expression A + B*x where A and B are loop invariant values.
const Loop * getLoop() const
SCEVUse getStepRecurrence(ScalarEvolution &SE) const
Constructs and returns the recurrence indicating how much this expression steps by.
This class represents a constant integer value.
ConstantInt * getValue() const
const APInt & getAPInt() const
NoWrapFlags getNoWrapFlags(NoWrapFlags Mask=NoWrapMask) const
This means that we are dealing with an entirely unknown SCEV value, and only represent it as its LLVM...
IncrementWrapFlags
Similar to SCEV::NoWrapFlags, but with slightly different semantics for FlagNUSW.
static SCEVWrapPredicate::IncrementWrapFlags clearFlags(SCEVWrapPredicate::IncrementWrapFlags Flags, SCEVWrapPredicate::IncrementWrapFlags OffFlags)
Convenient IncrementWrapFlags manipulation methods.
static SCEVWrapPredicate::IncrementWrapFlags getImpliedFlags(const SCEVAddRecExpr *AR, ScalarEvolution &SE)
Returns the set of SCEVWrapPredicate no wrap flags implied by a SCEVAddRecExpr.
This class represents an analyzed expression in the program.
static constexpr auto NoWrapMask
LLVM_ABI bool isZero() const
Return true if the expression is a constant zero.
Type * getType() const
Return the LLVM type of this SCEV expression.
SCEVTypes getSCEVType() const
Analysis pass that exposes the ScalarEvolution for a function.
static LLVM_ABI LoopGuards collect(const Loop *L, ScalarEvolution &SE)
Collect rewrite map for loop guards for loop L, together with flags indicating if NUW and NSW can be ...
The main scalar evolution driver.
const SCEV * getConstantMaxBackedgeTakenCount(const Loop *L)
When successful, this returns a SCEVConstant that is greater than or equal to (i.e.
LLVM_ABI bool isKnownNonNegative(const SCEV *S)
Test if the given expression is known to be non-negative.
LLVM_ABI const SCEV * getNegativeSCEV(const SCEV *V, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap)
Return the SCEV object corresponding to -V.
LLVM_ABI const SCEV * getZeroExtendExpr(SCEVUse Op, Type *Ty, unsigned Depth=0)
LLVM_ABI Type * getWiderType(Type *Ty1, Type *Ty2) const
LLVM_ABI const SCEV * getAbsExpr(const SCEV *Op, bool IsNSW)
LLVM_ABI bool isKnownNonPositive(const SCEV *S)
Test if the given expression is known to be non-positive.
LLVM_ABI bool isKnownNegative(const SCEV *S)
Test if the given expression is known to be negative.
LLVM_ABI const SCEV * getSCEVAtScope(const SCEV *S, const Loop *L)
Return a SCEV expression for the specified value at the specified scope in the program.
LLVM_ABI bool willNotOverflow(Instruction::BinaryOps BinOp, bool Signed, const SCEV *LHS, const SCEV *RHS, const Instruction *CtxI=nullptr)
Is operation BinOp between LHS and RHS provably does not have a signed/unsigned overflow (Signed)?
LLVM_ABI const SCEVPredicate * getEqualPredicate(const SCEV *LHS, const SCEV *RHS)
LLVM_ABI const SCEV * getConstant(ConstantInt *V)
LLVM_ABI const SCEV * getSCEV(Value *V)
Return a SCEV expression for the full generality of the specified expression.
LLVM_ABI const SCEV * getMinusSCEV(SCEVUse LHS, SCEVUse RHS, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Return LHS-RHS.
LLVM_ABI const SCEV * getNoopOrSignExtend(const SCEV *V, Type *Ty)
Return a SCEV corresponding to a conversion of the input value to the specified type.
const SCEV * getOne(Type *Ty)
Return a SCEV for the constant 1 of a specific type.
LLVM_ABI bool isLoopInvariant(const SCEV *S, const Loop *L)
Return true if the value of the given SCEV is unchanging in the specified loop.
LLVM_ABI bool isKnownPositive(const SCEV *S)
Test if the given expression is known to be positive.
LLVM_ABI bool isSCEVable(Type *Ty) const
Test if values of the given type are analyzable within the SCEV framework.
LLVM_ABI Type * getEffectiveSCEVType(Type *Ty) const
Return a type with the same bitwidth as the given type and which represents how SCEV will treat the g...
APInt getSignedRangeMin(const SCEV *S)
Determine the min of the signed range for a particular SCEV.
LLVM_ABI const SCEV * getUMaxExpr(SCEVUse LHS, SCEVUse RHS)
@ MonotonicallyIncreasing
LLVM_ABI const SCEV * getStoreSizeOfExpr(Type *IntTy, Type *StoreTy)
Return an expression for the store size of StoreTy that is type IntTy.
LLVM_ABI const SCEVPredicate * getWrapPredicate(const SCEVAddRecExpr *AR, SCEVWrapPredicate::IncrementWrapFlags AddedFlags)
LLVM_ABI const SCEV * getNoopOrZeroExtend(const SCEV *V, Type *Ty)
Return a SCEV corresponding to a conversion of the input value to the specified type.
LLVM_ABI std::optional< MonotonicPredicateType > getMonotonicPredicateType(const SCEVAddRecExpr *LHS, ICmpInst::Predicate Pred)
If, for all loop invariant X, the predicate "LHS `Pred` X" is monotonically increasing or decreasing,...
LLVM_ABI const SCEV * getCouldNotCompute()
LLVM_ABI const SCEV * getMulExpr(SmallVectorImpl< SCEVUse > &Ops, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Get a canonical multiply expression, or something simpler if possible.
LLVM_ABI const SCEV * getPointerBase(const SCEV *V)
Transitively follow the chain of pointer-type operands until reaching a SCEV that does not have a sin...
LLVM_ABI const SCEV * getAddExpr(SmallVectorImpl< SCEVUse > &Ops, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Get a canonical add expression, or something simpler if possible.
LLVM_ABI bool isKnownPredicate(CmpPredicate Pred, SCEVUse LHS, SCEVUse RHS)
Test if the given expression is known to satisfy the condition described by Pred, LHS,...
LLVM_ABI const SCEV * applyLoopGuards(const SCEV *Expr, const Loop *L)
Try to apply information from loop guards for L to Expr.
LLVM_ABI const SCEV * getPtrToAddrExpr(const SCEV *Op)
LLVM_ABI const SCEVAddRecExpr * convertSCEVToAddRecWithPredicates(const SCEV *S, const Loop *L, SmallVectorImpl< const SCEVPredicate * > &Preds)
Tries to convert the S expression to an AddRec expression, adding additional predicates to Preds as r...
LLVM_ABI const SCEV * getSizeOfExpr(Type *IntTy, TypeSize Size)
Return an expression for a TypeSize.
LLVM_ABI std::optional< APInt > computeConstantDifference(const SCEV *LHS, const SCEV *RHS)
Compute LHS - RHS and returns the result as an APInt if it is a constant, and std::nullopt if it isn'...
LLVM_ABI std::pair< const SCEV *, const SCEV * > SplitIntoInitAndPostInc(const Loop *L, const SCEV *S)
Splits SCEV expression S into two SCEVs.
LLVM_ABI const SCEV * getUMinExpr(SCEVUse LHS, SCEVUse RHS, bool Sequential=false)
LLVM_ABI const SCEV * getTruncateOrSignExtend(const SCEV *V, Type *Ty, unsigned Depth=0)
Return a SCEV corresponding to a conversion of the input value to the specified type.
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
bool contains(ConstPtrType Ptr) const
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
bool contains(const T &V) const
Check if the SmallSet contains the given element.
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
reference emplace_back(ArgTypes &&... Args)
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
An instruction for storing to memory.
Represent a constant reference to a string, i.e.
Analysis pass providing the TargetTransformInfo.
Analysis pass providing the TargetLibraryInfo.
Provides information about what library functions are available for the current target.
The instances of the Type class are immutable: once they are created, they are never changed.
bool isVectorTy() const
True if this is an instance of VectorType.
bool isPointerTy() const
True if this is an instance of PointerType.
LLVM_ABI unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
A Use represents the edge between a Value definition and its users.
static SmallVector< VFInfo, 8 > getMappings(const CallInst &CI)
Retrieve all the VFInfo instances associated to the CallInst CI.
LLVM Value Representation.
Type * getType() const
All values are typed, get the type of this value.
LLVM_ABI const Value * stripAndAccumulateConstantOffsets(const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const
Accumulate the constant offset this value has compared to a base pointer.
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
LLVM_ABI uint64_t getPointerDereferenceableBytes(const DataLayout &DL, bool &CanBeNull, bool *CanBeFreed) const
Returns the number of bytes known to be dereferenceable for the pointer value.
constexpr ScalarTy getFixedValue() const
An efficient, type-erasing, non-owning reference to a callable.
This class implements an extremely fast bulk output stream that can only output to a stream.
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Abstract Attribute helper functions.
bool match(Val *V, const Pattern &P)
bind_cst_ty m_scev_APInt(const APInt *&C)
Match an SCEV constant and bind it to an APInt.
is_undef_or_poison m_scev_UndefOrPoison()
Match an SCEVUnknown wrapping undef or poison.
specificloop_ty m_SpecificLoop(const Loop *L)
match_bind< const SCEVMulExpr > m_scev_Mul(const SCEVMulExpr *&V)
specificscev_ty m_scev_Specific(const SCEV *S)
Match if we have a specific specified SCEV.
SCEVAffineAddRec_match< Op0_t, Op1_t, match_isa< const Loop > > m_scev_AffineAddRec(const Op0_t &Op0, const Op1_t &Op1)
initializer< Ty > init(const Ty &Val)
LocationClass< Ty > location(Ty &L)
DiagnosticInfoOptimizationBase::Argument NV
friend class Instruction
Iterator for Instructions in a `BasicBlock.
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ABI std::pair< const SCEV *, const SCEV * > getStartAndEndForAccess(const Loop *Lp, const SCEV *PtrExpr, Type *AccessTy, const SCEV *BTC, const SCEV *MaxBTC, ScalarEvolution *SE, DenseMap< std::pair< const SCEV *, const SCEV * >, std::pair< const SCEV *, const SCEV * > > *PointerBounds, DominatorTree *DT, AssumptionCache *AC, std::optional< ScalarEvolution::LoopGuards > &LoopGuards)
Calculate Start and End points of memory access using exact backedge taken count BTC if computable or...
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
detail::zippy< detail::zip_shortest, T, U, Args... > zip(T &&t, U &&u, Args &&...args)
zip iterator for two or more iteratable types.
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
LLVM_ABI RetainedKnowledge getKnowledgeForValue(const Value *V, ArrayRef< Attribute::AttrKind > AttrKinds, AssumptionCache &AC, function_ref< bool(RetainedKnowledge, Instruction *, const CallBase::BundleOpInfo *)> Filter=[](auto...) { return true;})
Return a valid Knowledge associated to the Value V if its Attribute kind is in AttrKinds and it match...
LLVM_ABI bool isValidAssumeForContext(const Instruction *I, const Instruction *CxtI, const DominatorTree *DT=nullptr, bool AllowEphemerals=false)
Return true if it is valid to use the assumptions provided by an assume intrinsic,...
LLVM_ABI bool getBooleanLoopAttribute(const Loop *TheLoop, StringRef Name)
Returns true if Name is applied to TheLoop and enabled.
LLVM_ABI Intrinsic::ID getVectorIntrinsicIDForCall(const CallInst *CI, const TargetLibraryInfo *TLI)
Returns intrinsic ID for call.
auto enumerate(FirstRange &&First, RestRanges &&...Rest)
Given two or more input ranges, returns a new range whose values are tuples (A, B,...
unsigned getPointerAddressSpace(const Type *T)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
const Value * getLoadStorePointerOperand(const Value *V)
A helper function that returns the pointer operand of a load or store instruction.
auto dyn_cast_if_present(const Y &Val)
dyn_cast_if_present<X> - Functionally identical to dyn_cast, except that a null (or none in the case ...
LLVM_ABI const SCEV * replaceSymbolicStrideSCEV(PredicatedScalarEvolution &PSE, const SymbolicStrideMap &PtrToStride, Value *Ptr)
Return the SCEV corresponding to a pointer with the symbolic stride replaced with constant one,...
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
LLVM_ABI std::optional< int64_t > getPtrStride(PredicatedScalarEvolution &PSE, Type *AccessTy, Value *Ptr, const Loop *Lp, const DominatorTree &DT, const SymbolicStrideMap &StridesMap=SymbolicStrideMap(), bool ShouldCheckWrap=true, SmallVectorImpl< const SCEVPredicate * > *Predicates=nullptr)
If the pointer has a constant stride return it in units of the access type size.
const Value * getPointerOperand(const Value *V)
A helper function that returns the pointer operand of a load, store or GEP instruction.
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Value
auto dyn_cast_or_null(const Y &Val)
OutputIt transform(R &&Range, OutputIt d_first, UnaryFunction F)
Wrapper function around std::transform to apply a function to a range and store the result elsewhere.
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
decltype(auto) get(const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &Pair)
DenseMap< Value *, const SCEVUnknown * > SymbolicStrideMap
Maps a pointer to its symbolic (non-constant) stride.
LLVM_ABI bool NullPointerIsDefined(const Function *F, unsigned AS=0)
Check whether null pointer dereferencing is considered undefined behavior for a given function or an ...
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
LLVM_ABI std::optional< int64_t > getPointersDiff(Type *ElemTyA, Value *PtrA, Type *ElemTyB, Value *PtrB, const DataLayout &DL, ScalarEvolution &SE, bool StrictCheck=false, bool CheckType=true)
Returns the distance between the pointers PtrA and PtrB iff they are compatible and it is possible to...
LLVM_ABI bool sortPtrAccesses(ArrayRef< Value * > VL, Type *ElemTy, const DataLayout &DL, ScalarEvolution &SE, SmallVectorImpl< unsigned > &SortedIndices)
Attempt to sort the pointers in VL and return the sorted indices in SortedIndices,...
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
LLVM_ABI bool isConsecutiveAccess(Value *A, Value *B, const DataLayout &DL, ScalarEvolution &SE, bool CheckType=true)
Returns true if the memory operations A and B are consecutive.
DWARFExpression::Operation Op
LLVM_ABI bool isGuaranteedNotToBeUndefOrPoison(const Value *V, AssumptionCache *AC=nullptr, const Instruction *CtxI=nullptr, const DominatorTree *DT=nullptr, unsigned Depth=0)
Return true if this function can prove that V does not have undef bits and is never poison.
ArrayRef(const T &OneElt) -> ArrayRef< T >
constexpr U AbsoluteValue(T X)
Return the absolute value of a signed integer, converted to the corresponding unsigned integer type.
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
auto find_if(R &&Range, UnaryPredicate P)
Provide wrappers to std::find_if which take ranges instead of having to pass begin/end explicitly.
Type * getLoadStoreType(const Value *I)
A helper function that returns the type of a load or store instruction.
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
LLVM_ABI std::optional< int64_t > getStrideFromAddRec(const SCEVAddRecExpr *AR, const Loop *Lp, Type *AccessTy, Value *Ptr, PredicatedScalarEvolution &PSE)
If AR is an affine AddRec for Lp with a constant step, return the step in units of AccessTy's allocat...
T bit_floor(T Value)
Returns the largest integral power of two no greater than Value if Value is nonzero.
LLVM_ABI void getUnderlyingObjects(const Value *V, SmallVectorImpl< const Value * > &Objects, const LoopInfo *LI=nullptr, unsigned MaxLookup=MaxLookupSearchDepth)
This method is similar to getUnderlyingObject except that it can look through phi and select instruct...
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.
IR Values for the lower and upper bounds of a pointer evolution.
MDNode * Scope
The tag for alias scope specification (used with noalias).
MDNode * TBAA
The tag for type-based alias analysis.
MDNode * NoAlias
The tag specifying the noalias scope.
A special type used by analysis passes to provide an address that identifies that particular analysis...
Instruction * getDestination(const MemoryDepChecker &DepChecker) const
Return the destination instruction of the dependence.
DepType Type
The type of the dependence.
unsigned Destination
Index of the destination of the dependence in the InstMap vector.
LLVM_ABI bool isPossiblyBackward() const
May be a lexically backward dependence type (includes Unknown).
Instruction * getSource(const MemoryDepChecker &DepChecker) const
Return the source instruction of the dependence.
LLVM_ABI bool isForward() const
Lexically forward dependence.
LLVM_ABI bool isBackward() const
Lexically backward dependence.
LLVM_ABI void print(raw_ostream &OS, unsigned Depth, const SmallVectorImpl< Instruction * > &Instrs) const
Print the dependence.
unsigned Source
Index of the source of the dependence in the InstMap vector.
DepType
The type of the dependence.
@ BackwardVectorizableButPreventsForwarding
@ ForwardButPreventsForwarding
static LLVM_ABI const char * DepName[]
String version of the types.
static LLVM_ABI VectorizationSafetyStatus isSafeForVectorization(DepType Type)
Dependence types that don't prevent vectorization.
Represent one information held inside an operand bundle of an llvm.assume.
unsigned AddressSpace
Address space of the involved pointers.
LLVM_ABI bool addPointer(unsigned Index, const RuntimePointerChecking &RtCheck)
Tries to add the pointer recorded in RtCheck at index Index to this pointer checking group.
bool NeedsFreeze
Whether the pointer needs to be frozen after expansion, e.g.
LLVM_ABI RuntimeCheckingPtrGroup(unsigned Index, const RuntimePointerChecking &RtCheck)
Create a new pointer checking group containing a single pointer, with index Index in RtCheck.
const SCEV * High
The SCEV expression which represents the upper bound of all the pointers in this group.
SmallVector< unsigned, 2 > Members
Indices of all the pointers that constitute this grouping.
const SCEV * Low
The SCEV expression which represents the lower bound of all the pointers in this group.
bool IsWritePtr
Holds the information if this pointer is used for writing to memory.
unsigned DependencySetId
Holds the id of the set of pointers that could be dependent because of a shared underlying object.
unsigned AliasSetId
Holds the id of the disjoint alias set to which this pointer belongs.
static LLVM_ABI const unsigned MaxVectorWidth
Maximum SIMD width.
static LLVM_ABI unsigned RuntimeMemoryCheckThreshold
\When performing memory disambiguation checks at runtime do not make more than this number of compari...
static LLVM_ABI bool isInterleaveForced()
True if force-vector-interleave was specified by the user.
static LLVM_ABI unsigned VectorizationInterleave
Interleave factor as overridden by the user.
static LLVM_ABI ElementCount VectorizationFactor
VF as overridden by the user.
static LLVM_ABI bool HoistRuntimeChecks
Function object to check whether the first component of a container supported by std::get (like std::...