10456327cSAdam Nemet //===- LoopAccessAnalysis.cpp - Loop Access Analysis Implementation --------==// 20456327cSAdam Nemet // 30456327cSAdam Nemet // The LLVM Compiler Infrastructure 40456327cSAdam Nemet // 50456327cSAdam Nemet // This file is distributed under the University of Illinois Open Source 60456327cSAdam Nemet // License. See LICENSE.TXT for details. 70456327cSAdam Nemet // 80456327cSAdam Nemet //===----------------------------------------------------------------------===// 90456327cSAdam Nemet // 100456327cSAdam Nemet // The implementation for the loop memory dependence that was originally 110456327cSAdam Nemet // developed for the loop vectorizer. 120456327cSAdam Nemet // 130456327cSAdam Nemet //===----------------------------------------------------------------------===// 140456327cSAdam Nemet 150456327cSAdam Nemet #include "llvm/Analysis/LoopAccessAnalysis.h" 160456327cSAdam Nemet #include "llvm/Analysis/LoopInfo.h" 178a021317SXinliang David Li #include "llvm/Analysis/LoopPassManager.h" 185b3a5cf6SAdam Nemet #include "llvm/Analysis/OptimizationDiagnosticInfo.h" 197206d7a5SAdam Nemet #include "llvm/Analysis/ScalarEvolutionExpander.h" 20799003bfSBenjamin Kramer #include "llvm/Analysis/TargetLibraryInfo.h" 210456327cSAdam Nemet #include "llvm/Analysis/ValueTracking.h" 22f45594c9SAdam Nemet #include "llvm/Analysis/VectorUtils.h" 230456327cSAdam Nemet #include "llvm/IR/Dominators.h" 247206d7a5SAdam Nemet #include "llvm/IR/IRBuilder.h" 258a021317SXinliang David Li #include "llvm/IR/PassManager.h" 260456327cSAdam Nemet #include "llvm/Support/Debug.h" 27799003bfSBenjamin Kramer #include "llvm/Support/raw_ostream.h" 280456327cSAdam Nemet using namespace llvm; 290456327cSAdam Nemet 30339f42b3SAdam Nemet #define DEBUG_TYPE "loop-accesses" 310456327cSAdam Nemet 32f219c647SAdam Nemet static cl::opt<unsigned, true> 33f219c647SAdam Nemet VectorizationFactor("force-vector-width", cl::Hidden, 34f219c647SAdam Nemet cl::desc("Sets the SIMD width. Zero is autoselect."), 35f219c647SAdam Nemet cl::location(VectorizerParams::VectorizationFactor)); 361d862af7SAdam Nemet unsigned VectorizerParams::VectorizationFactor; 37f219c647SAdam Nemet 38f219c647SAdam Nemet static cl::opt<unsigned, true> 39f219c647SAdam Nemet VectorizationInterleave("force-vector-interleave", cl::Hidden, 40f219c647SAdam Nemet cl::desc("Sets the vectorization interleave count. " 41f219c647SAdam Nemet "Zero is autoselect."), 42f219c647SAdam Nemet cl::location( 43f219c647SAdam Nemet VectorizerParams::VectorizationInterleave)); 441d862af7SAdam Nemet unsigned VectorizerParams::VectorizationInterleave; 45f219c647SAdam Nemet 461d862af7SAdam Nemet static cl::opt<unsigned, true> RuntimeMemoryCheckThreshold( 471d862af7SAdam Nemet "runtime-memory-check-threshold", cl::Hidden, 481d862af7SAdam Nemet cl::desc("When performing memory disambiguation checks at runtime do not " 491d862af7SAdam Nemet "generate more than this number of comparisons (default = 8)."), 501d862af7SAdam Nemet cl::location(VectorizerParams::RuntimeMemoryCheckThreshold), cl::init(8)); 511d862af7SAdam Nemet unsigned VectorizerParams::RuntimeMemoryCheckThreshold; 52f219c647SAdam Nemet 531b6b50a9SSilviu Baranga /// \brief The maximum iterations used to merge memory checks 541b6b50a9SSilviu Baranga static cl::opt<unsigned> MemoryCheckMergeThreshold( 551b6b50a9SSilviu Baranga "memory-check-merge-threshold", cl::Hidden, 561b6b50a9SSilviu Baranga cl::desc("Maximum number of comparisons done when trying to merge " 571b6b50a9SSilviu Baranga "runtime memory checks. (default = 100)"), 581b6b50a9SSilviu Baranga cl::init(100)); 591b6b50a9SSilviu Baranga 60f219c647SAdam Nemet /// Maximum SIMD width. 61f219c647SAdam Nemet const unsigned VectorizerParams::MaxVectorWidth = 64; 62f219c647SAdam Nemet 63a2df750fSAdam Nemet /// \brief We collect dependences up to this threshold. 64a2df750fSAdam Nemet static cl::opt<unsigned> 65a2df750fSAdam Nemet MaxDependences("max-dependences", cl::Hidden, 66a2df750fSAdam Nemet cl::desc("Maximum number of dependences collected by " 679c926579SAdam Nemet "loop-access analysis (default = 100)"), 689c926579SAdam Nemet cl::init(100)); 699c926579SAdam Nemet 70a9f09c62SAdam Nemet /// This enables versioning on the strides of symbolically striding memory 71a9f09c62SAdam Nemet /// accesses in code like the following. 72a9f09c62SAdam Nemet /// for (i = 0; i < N; ++i) 73a9f09c62SAdam Nemet /// A[i * Stride1] += B[i * Stride2] ... 74a9f09c62SAdam Nemet /// 75a9f09c62SAdam Nemet /// Will be roughly translated to 76a9f09c62SAdam Nemet /// if (Stride1 == 1 && Stride2 == 1) { 77a9f09c62SAdam Nemet /// for (i = 0; i < N; i+=4) 78a9f09c62SAdam Nemet /// A[i:i+3] += ... 79a9f09c62SAdam Nemet /// } else 80a9f09c62SAdam Nemet /// ... 81a9f09c62SAdam Nemet static cl::opt<bool> EnableMemAccessVersioning( 82a9f09c62SAdam Nemet "enable-mem-access-versioning", cl::init(true), cl::Hidden, 83a9f09c62SAdam Nemet cl::desc("Enable symbolic stride memory access versioning")); 84a9f09c62SAdam Nemet 8537ec5f91SMatthew Simpson /// \brief Enable store-to-load forwarding conflict detection. This option can 8637ec5f91SMatthew Simpson /// be disabled for correctness testing. 8737ec5f91SMatthew Simpson static cl::opt<bool> EnableForwardingConflictDetection( 8837ec5f91SMatthew Simpson "store-to-load-forwarding-conflict-detection", cl::Hidden, 89a250dc9fSMatthew Simpson cl::desc("Enable conflict detection in loop-access analysis"), 90a250dc9fSMatthew Simpson cl::init(true)); 91a250dc9fSMatthew Simpson 92f219c647SAdam Nemet bool VectorizerParams::isInterleaveForced() { 93f219c647SAdam Nemet return ::VectorizationInterleave.getNumOccurrences() > 0; 94f219c647SAdam Nemet } 95f219c647SAdam Nemet 962bd6e984SAdam Nemet void LoopAccessReport::emitAnalysis(const LoopAccessReport &Message, 975b3a5cf6SAdam Nemet const Loop *TheLoop, const char *PassName, 985b3a5cf6SAdam Nemet OptimizationRemarkEmitter &ORE) { 990456327cSAdam Nemet DebugLoc DL = TheLoop->getStartLoc(); 1005b3a5cf6SAdam Nemet const Value *V = TheLoop->getHeader(); 1015b3a5cf6SAdam Nemet if (const Instruction *I = Message.getInstr()) { 1020456327cSAdam Nemet DL = I->getDebugLoc(); 1035b3a5cf6SAdam Nemet V = I->getParent(); 1045b3a5cf6SAdam Nemet } 1055b3a5cf6SAdam Nemet ORE.emitOptimizationRemarkAnalysis(PassName, DL, V, Message.str()); 1060456327cSAdam Nemet } 1070456327cSAdam Nemet 1080456327cSAdam Nemet Value *llvm::stripIntegerCast(Value *V) { 1098b401013SDavid Majnemer if (auto *CI = dyn_cast<CastInst>(V)) 1100456327cSAdam Nemet if (CI->getOperand(0)->getType()->isIntegerTy()) 1110456327cSAdam Nemet return CI->getOperand(0); 1120456327cSAdam Nemet return V; 1130456327cSAdam Nemet } 1140456327cSAdam Nemet 1159cd9a7e3SSilviu Baranga const SCEV *llvm::replaceSymbolicStrideSCEV(PredicatedScalarEvolution &PSE, 1168bc61df9SAdam Nemet const ValueToValueMap &PtrToStride, 1170456327cSAdam Nemet Value *Ptr, Value *OrigPtr) { 1189cd9a7e3SSilviu Baranga const SCEV *OrigSCEV = PSE.getSCEV(Ptr); 1190456327cSAdam Nemet 1200456327cSAdam Nemet // If there is an entry in the map return the SCEV of the pointer with the 1210456327cSAdam Nemet // symbolic stride replaced by one. 1228bc61df9SAdam Nemet ValueToValueMap::const_iterator SI = 1238bc61df9SAdam Nemet PtrToStride.find(OrigPtr ? OrigPtr : Ptr); 1240456327cSAdam Nemet if (SI != PtrToStride.end()) { 1250456327cSAdam Nemet Value *StrideVal = SI->second; 1260456327cSAdam Nemet 1270456327cSAdam Nemet // Strip casts. 1280456327cSAdam Nemet StrideVal = stripIntegerCast(StrideVal); 1290456327cSAdam Nemet 1300456327cSAdam Nemet // Replace symbolic stride by one. 1310456327cSAdam Nemet Value *One = ConstantInt::get(StrideVal->getType(), 1); 1320456327cSAdam Nemet ValueToValueMap RewriteMap; 1330456327cSAdam Nemet RewriteMap[StrideVal] = One; 1340456327cSAdam Nemet 1359cd9a7e3SSilviu Baranga ScalarEvolution *SE = PSE.getSE(); 136e3c0534bSSilviu Baranga const auto *U = cast<SCEVUnknown>(SE->getSCEV(StrideVal)); 137e3c0534bSSilviu Baranga const auto *CT = 138e3c0534bSSilviu Baranga static_cast<const SCEVConstant *>(SE->getOne(StrideVal->getType())); 139e3c0534bSSilviu Baranga 1409cd9a7e3SSilviu Baranga PSE.addPredicate(*SE->getEqualPredicate(U, CT)); 1419cd9a7e3SSilviu Baranga auto *Expr = PSE.getSCEV(Ptr); 142e3c0534bSSilviu Baranga 1439cd9a7e3SSilviu Baranga DEBUG(dbgs() << "LAA: Replacing SCEV: " << *OrigSCEV << " by: " << *Expr 1440456327cSAdam Nemet << "\n"); 1459cd9a7e3SSilviu Baranga return Expr; 1460456327cSAdam Nemet } 1470456327cSAdam Nemet 1480456327cSAdam Nemet // Otherwise, just return the SCEV of the original pointer. 149e3c0534bSSilviu Baranga return OrigSCEV; 1500456327cSAdam Nemet } 1510456327cSAdam Nemet 1527cdebac0SAdam Nemet void RuntimePointerChecking::insert(Loop *Lp, Value *Ptr, bool WritePtr, 1537cdebac0SAdam Nemet unsigned DepSetId, unsigned ASId, 154e3c0534bSSilviu Baranga const ValueToValueMap &Strides, 1559cd9a7e3SSilviu Baranga PredicatedScalarEvolution &PSE) { 1560456327cSAdam Nemet // Get the stride replaced scev. 1579cd9a7e3SSilviu Baranga const SCEV *Sc = replaceSymbolicStrideSCEV(PSE, Strides, Ptr); 158279784ffSAdam Nemet ScalarEvolution *SE = PSE.getSE(); 159279784ffSAdam Nemet 160279784ffSAdam Nemet const SCEV *ScStart; 161279784ffSAdam Nemet const SCEV *ScEnd; 162279784ffSAdam Nemet 16359a65504SAdam Nemet if (SE->isLoopInvariant(Sc, Lp)) 164279784ffSAdam Nemet ScStart = ScEnd = Sc; 165279784ffSAdam Nemet else { 1660456327cSAdam Nemet const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Sc); 1670456327cSAdam Nemet assert(AR && "Invalid addrec expression"); 1686f444dfdSSilviu Baranga const SCEV *Ex = PSE.getBackedgeTakenCount(); 1690e5804a6SSilviu Baranga 170279784ffSAdam Nemet ScStart = AR->getStart(); 171279784ffSAdam Nemet ScEnd = AR->evaluateAtIteration(Ex, *SE); 1720e5804a6SSilviu Baranga const SCEV *Step = AR->getStepRecurrence(*SE); 1730e5804a6SSilviu Baranga 1740e5804a6SSilviu Baranga // For expressions with negative step, the upper bound is ScStart and the 1750e5804a6SSilviu Baranga // lower bound is ScEnd. 1768b401013SDavid Majnemer if (const auto *CStep = dyn_cast<SCEVConstant>(Step)) { 1770e5804a6SSilviu Baranga if (CStep->getValue()->isNegative()) 1780e5804a6SSilviu Baranga std::swap(ScStart, ScEnd); 1790e5804a6SSilviu Baranga } else { 1800e5804a6SSilviu Baranga // Fallback case: the step is not constant, but the we can still 1810e5804a6SSilviu Baranga // get the upper and lower bounds of the interval by using min/max 1820e5804a6SSilviu Baranga // expressions. 1830e5804a6SSilviu Baranga ScStart = SE->getUMinExpr(ScStart, ScEnd); 1840e5804a6SSilviu Baranga ScEnd = SE->getUMaxExpr(AR->getStart(), ScEnd); 1850e5804a6SSilviu Baranga } 186279784ffSAdam Nemet } 1870e5804a6SSilviu Baranga 1880e5804a6SSilviu Baranga Pointers.emplace_back(Ptr, ScStart, ScEnd, WritePtr, DepSetId, ASId, Sc); 1891b6b50a9SSilviu Baranga } 1901b6b50a9SSilviu Baranga 191bbe1f1deSAdam Nemet SmallVector<RuntimePointerChecking::PointerCheck, 4> 19238530887SAdam Nemet RuntimePointerChecking::generateChecks() const { 193bbe1f1deSAdam Nemet SmallVector<PointerCheck, 4> Checks; 194bbe1f1deSAdam Nemet 1957c52e052SAdam Nemet for (unsigned I = 0; I < CheckingGroups.size(); ++I) { 1967c52e052SAdam Nemet for (unsigned J = I + 1; J < CheckingGroups.size(); ++J) { 1977c52e052SAdam Nemet const RuntimePointerChecking::CheckingPtrGroup &CGI = CheckingGroups[I]; 1987c52e052SAdam Nemet const RuntimePointerChecking::CheckingPtrGroup &CGJ = CheckingGroups[J]; 199bbe1f1deSAdam Nemet 20038530887SAdam Nemet if (needsChecking(CGI, CGJ)) 201bbe1f1deSAdam Nemet Checks.push_back(std::make_pair(&CGI, &CGJ)); 202bbe1f1deSAdam Nemet } 203bbe1f1deSAdam Nemet } 204bbe1f1deSAdam Nemet return Checks; 205bbe1f1deSAdam Nemet } 206bbe1f1deSAdam Nemet 20715840393SAdam Nemet void RuntimePointerChecking::generateChecks( 20815840393SAdam Nemet MemoryDepChecker::DepCandidates &DepCands, bool UseDependencies) { 20915840393SAdam Nemet assert(Checks.empty() && "Checks is not empty"); 21015840393SAdam Nemet groupChecks(DepCands, UseDependencies); 21115840393SAdam Nemet Checks = generateChecks(); 21215840393SAdam Nemet } 21315840393SAdam Nemet 214651a5a24SAdam Nemet bool RuntimePointerChecking::needsChecking(const CheckingPtrGroup &M, 215651a5a24SAdam Nemet const CheckingPtrGroup &N) const { 2161b6b50a9SSilviu Baranga for (unsigned I = 0, EI = M.Members.size(); EI != I; ++I) 2171b6b50a9SSilviu Baranga for (unsigned J = 0, EJ = N.Members.size(); EJ != J; ++J) 218651a5a24SAdam Nemet if (needsChecking(M.Members[I], N.Members[J])) 2191b6b50a9SSilviu Baranga return true; 2201b6b50a9SSilviu Baranga return false; 2211b6b50a9SSilviu Baranga } 2221b6b50a9SSilviu Baranga 2231b6b50a9SSilviu Baranga /// Compare \p I and \p J and return the minimum. 2241b6b50a9SSilviu Baranga /// Return nullptr in case we couldn't find an answer. 2251b6b50a9SSilviu Baranga static const SCEV *getMinFromExprs(const SCEV *I, const SCEV *J, 2261b6b50a9SSilviu Baranga ScalarEvolution *SE) { 2271b6b50a9SSilviu Baranga const SCEV *Diff = SE->getMinusSCEV(J, I); 2281b6b50a9SSilviu Baranga const SCEVConstant *C = dyn_cast<const SCEVConstant>(Diff); 2291b6b50a9SSilviu Baranga 2301b6b50a9SSilviu Baranga if (!C) 2311b6b50a9SSilviu Baranga return nullptr; 2321b6b50a9SSilviu Baranga if (C->getValue()->isNegative()) 2331b6b50a9SSilviu Baranga return J; 2341b6b50a9SSilviu Baranga return I; 2351b6b50a9SSilviu Baranga } 2361b6b50a9SSilviu Baranga 2377cdebac0SAdam Nemet bool RuntimePointerChecking::CheckingPtrGroup::addPointer(unsigned Index) { 2389f7dedc3SAdam Nemet const SCEV *Start = RtCheck.Pointers[Index].Start; 2399f7dedc3SAdam Nemet const SCEV *End = RtCheck.Pointers[Index].End; 2409f7dedc3SAdam Nemet 2411b6b50a9SSilviu Baranga // Compare the starts and ends with the known minimum and maximum 2421b6b50a9SSilviu Baranga // of this set. We need to know how we compare against the min/max 2431b6b50a9SSilviu Baranga // of the set in order to be able to emit memchecks. 2449f7dedc3SAdam Nemet const SCEV *Min0 = getMinFromExprs(Start, Low, RtCheck.SE); 2451b6b50a9SSilviu Baranga if (!Min0) 2461b6b50a9SSilviu Baranga return false; 2471b6b50a9SSilviu Baranga 2489f7dedc3SAdam Nemet const SCEV *Min1 = getMinFromExprs(End, High, RtCheck.SE); 2491b6b50a9SSilviu Baranga if (!Min1) 2501b6b50a9SSilviu Baranga return false; 2511b6b50a9SSilviu Baranga 2521b6b50a9SSilviu Baranga // Update the low bound expression if we've found a new min value. 2539f7dedc3SAdam Nemet if (Min0 == Start) 2549f7dedc3SAdam Nemet Low = Start; 2551b6b50a9SSilviu Baranga 2561b6b50a9SSilviu Baranga // Update the high bound expression if we've found a new max value. 2579f7dedc3SAdam Nemet if (Min1 != End) 2589f7dedc3SAdam Nemet High = End; 2591b6b50a9SSilviu Baranga 2601b6b50a9SSilviu Baranga Members.push_back(Index); 2611b6b50a9SSilviu Baranga return true; 2621b6b50a9SSilviu Baranga } 2631b6b50a9SSilviu Baranga 2647cdebac0SAdam Nemet void RuntimePointerChecking::groupChecks( 2657cdebac0SAdam Nemet MemoryDepChecker::DepCandidates &DepCands, bool UseDependencies) { 2661b6b50a9SSilviu Baranga // We build the groups from dependency candidates equivalence classes 2671b6b50a9SSilviu Baranga // because: 2681b6b50a9SSilviu Baranga // - We know that pointers in the same equivalence class share 2691b6b50a9SSilviu Baranga // the same underlying object and therefore there is a chance 2701b6b50a9SSilviu Baranga // that we can compare pointers 2711b6b50a9SSilviu Baranga // - We wouldn't be able to merge two pointers for which we need 2721b6b50a9SSilviu Baranga // to emit a memcheck. The classes in DepCands are already 2731b6b50a9SSilviu Baranga // conveniently built such that no two pointers in the same 2741b6b50a9SSilviu Baranga // class need checking against each other. 2751b6b50a9SSilviu Baranga 2761b6b50a9SSilviu Baranga // We use the following (greedy) algorithm to construct the groups 2771b6b50a9SSilviu Baranga // For every pointer in the equivalence class: 2781b6b50a9SSilviu Baranga // For each existing group: 2791b6b50a9SSilviu Baranga // - if the difference between this pointer and the min/max bounds 2801b6b50a9SSilviu Baranga // of the group is a constant, then make the pointer part of the 2811b6b50a9SSilviu Baranga // group and update the min/max bounds of that group as required. 2821b6b50a9SSilviu Baranga 2831b6b50a9SSilviu Baranga CheckingGroups.clear(); 2841b6b50a9SSilviu Baranga 28548250600SSilviu Baranga // If we need to check two pointers to the same underlying object 28648250600SSilviu Baranga // with a non-constant difference, we shouldn't perform any pointer 28748250600SSilviu Baranga // grouping with those pointers. This is because we can easily get 28848250600SSilviu Baranga // into cases where the resulting check would return false, even when 28948250600SSilviu Baranga // the accesses are safe. 29048250600SSilviu Baranga // 29148250600SSilviu Baranga // The following example shows this: 29248250600SSilviu Baranga // for (i = 0; i < 1000; ++i) 29348250600SSilviu Baranga // a[5000 + i * m] = a[i] + a[i + 9000] 29448250600SSilviu Baranga // 29548250600SSilviu Baranga // Here grouping gives a check of (5000, 5000 + 1000 * m) against 29648250600SSilviu Baranga // (0, 10000) which is always false. However, if m is 1, there is no 29748250600SSilviu Baranga // dependence. Not grouping the checks for a[i] and a[i + 9000] allows 29848250600SSilviu Baranga // us to perform an accurate check in this case. 29948250600SSilviu Baranga // 30048250600SSilviu Baranga // The above case requires that we have an UnknownDependence between 30148250600SSilviu Baranga // accesses to the same underlying object. This cannot happen unless 30248250600SSilviu Baranga // ShouldRetryWithRuntimeCheck is set, and therefore UseDependencies 30348250600SSilviu Baranga // is also false. In this case we will use the fallback path and create 30448250600SSilviu Baranga // separate checking groups for all pointers. 30548250600SSilviu Baranga 3061b6b50a9SSilviu Baranga // If we don't have the dependency partitions, construct a new 30748250600SSilviu Baranga // checking pointer group for each pointer. This is also required 30848250600SSilviu Baranga // for correctness, because in this case we can have checking between 30948250600SSilviu Baranga // pointers to the same underlying object. 3101b6b50a9SSilviu Baranga if (!UseDependencies) { 3111b6b50a9SSilviu Baranga for (unsigned I = 0; I < Pointers.size(); ++I) 3121b6b50a9SSilviu Baranga CheckingGroups.push_back(CheckingPtrGroup(I, *this)); 3131b6b50a9SSilviu Baranga return; 3141b6b50a9SSilviu Baranga } 3151b6b50a9SSilviu Baranga 3161b6b50a9SSilviu Baranga unsigned TotalComparisons = 0; 3171b6b50a9SSilviu Baranga 3181b6b50a9SSilviu Baranga DenseMap<Value *, unsigned> PositionMap; 3199f7dedc3SAdam Nemet for (unsigned Index = 0; Index < Pointers.size(); ++Index) 3209f7dedc3SAdam Nemet PositionMap[Pointers[Index].PointerValue] = Index; 3211b6b50a9SSilviu Baranga 322ce3877fcSSilviu Baranga // We need to keep track of what pointers we've already seen so we 323ce3877fcSSilviu Baranga // don't process them twice. 324ce3877fcSSilviu Baranga SmallSet<unsigned, 2> Seen; 325ce3877fcSSilviu Baranga 326e4b9f507SSanjay Patel // Go through all equivalence classes, get the "pointer check groups" 327ce3877fcSSilviu Baranga // and add them to the overall solution. We use the order in which accesses 328ce3877fcSSilviu Baranga // appear in 'Pointers' to enforce determinism. 329ce3877fcSSilviu Baranga for (unsigned I = 0; I < Pointers.size(); ++I) { 330ce3877fcSSilviu Baranga // We've seen this pointer before, and therefore already processed 331ce3877fcSSilviu Baranga // its equivalence class. 332ce3877fcSSilviu Baranga if (Seen.count(I)) 3331b6b50a9SSilviu Baranga continue; 3341b6b50a9SSilviu Baranga 3359f7dedc3SAdam Nemet MemoryDepChecker::MemAccessInfo Access(Pointers[I].PointerValue, 3369f7dedc3SAdam Nemet Pointers[I].IsWritePtr); 3371b6b50a9SSilviu Baranga 338ce3877fcSSilviu Baranga SmallVector<CheckingPtrGroup, 2> Groups; 339ce3877fcSSilviu Baranga auto LeaderI = DepCands.findValue(DepCands.getLeaderValue(Access)); 340ce3877fcSSilviu Baranga 341a647c30fSSilviu Baranga // Because DepCands is constructed by visiting accesses in the order in 342a647c30fSSilviu Baranga // which they appear in alias sets (which is deterministic) and the 343a647c30fSSilviu Baranga // iteration order within an equivalence class member is only dependent on 344a647c30fSSilviu Baranga // the order in which unions and insertions are performed on the 345a647c30fSSilviu Baranga // equivalence class, the iteration order is deterministic. 346ce3877fcSSilviu Baranga for (auto MI = DepCands.member_begin(LeaderI), ME = DepCands.member_end(); 3471b6b50a9SSilviu Baranga MI != ME; ++MI) { 3481b6b50a9SSilviu Baranga unsigned Pointer = PositionMap[MI->getPointer()]; 3491b6b50a9SSilviu Baranga bool Merged = false; 350ce3877fcSSilviu Baranga // Mark this pointer as seen. 351ce3877fcSSilviu Baranga Seen.insert(Pointer); 3521b6b50a9SSilviu Baranga 3531b6b50a9SSilviu Baranga // Go through all the existing sets and see if we can find one 3541b6b50a9SSilviu Baranga // which can include this pointer. 3551b6b50a9SSilviu Baranga for (CheckingPtrGroup &Group : Groups) { 3561b6b50a9SSilviu Baranga // Don't perform more than a certain amount of comparisons. 3571b6b50a9SSilviu Baranga // This should limit the cost of grouping the pointers to something 3581b6b50a9SSilviu Baranga // reasonable. If we do end up hitting this threshold, the algorithm 3591b6b50a9SSilviu Baranga // will create separate groups for all remaining pointers. 3601b6b50a9SSilviu Baranga if (TotalComparisons > MemoryCheckMergeThreshold) 3611b6b50a9SSilviu Baranga break; 3621b6b50a9SSilviu Baranga 3631b6b50a9SSilviu Baranga TotalComparisons++; 3641b6b50a9SSilviu Baranga 3651b6b50a9SSilviu Baranga if (Group.addPointer(Pointer)) { 3661b6b50a9SSilviu Baranga Merged = true; 3671b6b50a9SSilviu Baranga break; 3681b6b50a9SSilviu Baranga } 3691b6b50a9SSilviu Baranga } 3701b6b50a9SSilviu Baranga 3711b6b50a9SSilviu Baranga if (!Merged) 3721b6b50a9SSilviu Baranga // We couldn't add this pointer to any existing set or the threshold 3731b6b50a9SSilviu Baranga // for the number of comparisons has been reached. Create a new group 3741b6b50a9SSilviu Baranga // to hold the current pointer. 3751b6b50a9SSilviu Baranga Groups.push_back(CheckingPtrGroup(Pointer, *this)); 3761b6b50a9SSilviu Baranga } 3771b6b50a9SSilviu Baranga 3781b6b50a9SSilviu Baranga // We've computed the grouped checks for this partition. 3791b6b50a9SSilviu Baranga // Save the results and continue with the next one. 3801b6b50a9SSilviu Baranga std::copy(Groups.begin(), Groups.end(), std::back_inserter(CheckingGroups)); 3811b6b50a9SSilviu Baranga } 3820456327cSAdam Nemet } 3830456327cSAdam Nemet 384041e6debSAdam Nemet bool RuntimePointerChecking::arePointersInSamePartition( 385041e6debSAdam Nemet const SmallVectorImpl<int> &PtrToPartition, unsigned PtrIdx1, 386041e6debSAdam Nemet unsigned PtrIdx2) { 387041e6debSAdam Nemet return (PtrToPartition[PtrIdx1] != -1 && 388041e6debSAdam Nemet PtrToPartition[PtrIdx1] == PtrToPartition[PtrIdx2]); 389041e6debSAdam Nemet } 390041e6debSAdam Nemet 391651a5a24SAdam Nemet bool RuntimePointerChecking::needsChecking(unsigned I, unsigned J) const { 3929f7dedc3SAdam Nemet const PointerInfo &PointerI = Pointers[I]; 3939f7dedc3SAdam Nemet const PointerInfo &PointerJ = Pointers[J]; 3949f7dedc3SAdam Nemet 395a8945b77SAdam Nemet // No need to check if two readonly pointers intersect. 3969f7dedc3SAdam Nemet if (!PointerI.IsWritePtr && !PointerJ.IsWritePtr) 397a8945b77SAdam Nemet return false; 398a8945b77SAdam Nemet 399a8945b77SAdam Nemet // Only need to check pointers between two different dependency sets. 4009f7dedc3SAdam Nemet if (PointerI.DependencySetId == PointerJ.DependencySetId) 401a8945b77SAdam Nemet return false; 402a8945b77SAdam Nemet 403a8945b77SAdam Nemet // Only need to check pointers in the same alias set. 4049f7dedc3SAdam Nemet if (PointerI.AliasSetId != PointerJ.AliasSetId) 405a8945b77SAdam Nemet return false; 406a8945b77SAdam Nemet 407a8945b77SAdam Nemet return true; 408a8945b77SAdam Nemet } 409a8945b77SAdam Nemet 41054f0b83eSAdam Nemet void RuntimePointerChecking::printChecks( 41154f0b83eSAdam Nemet raw_ostream &OS, const SmallVectorImpl<PointerCheck> &Checks, 41254f0b83eSAdam Nemet unsigned Depth) const { 41354f0b83eSAdam Nemet unsigned N = 0; 41454f0b83eSAdam Nemet for (const auto &Check : Checks) { 41554f0b83eSAdam Nemet const auto &First = Check.first->Members, &Second = Check.second->Members; 41654f0b83eSAdam Nemet 41754f0b83eSAdam Nemet OS.indent(Depth) << "Check " << N++ << ":\n"; 41854f0b83eSAdam Nemet 41954f0b83eSAdam Nemet OS.indent(Depth + 2) << "Comparing group (" << Check.first << "):\n"; 42054f0b83eSAdam Nemet for (unsigned K = 0; K < First.size(); ++K) 42154f0b83eSAdam Nemet OS.indent(Depth + 2) << *Pointers[First[K]].PointerValue << "\n"; 42254f0b83eSAdam Nemet 42354f0b83eSAdam Nemet OS.indent(Depth + 2) << "Against group (" << Check.second << "):\n"; 42454f0b83eSAdam Nemet for (unsigned K = 0; K < Second.size(); ++K) 42554f0b83eSAdam Nemet OS.indent(Depth + 2) << *Pointers[Second[K]].PointerValue << "\n"; 42654f0b83eSAdam Nemet } 42754f0b83eSAdam Nemet } 42854f0b83eSAdam Nemet 4293a91e947SAdam Nemet void RuntimePointerChecking::print(raw_ostream &OS, unsigned Depth) const { 430e91cc6efSAdam Nemet 431e91cc6efSAdam Nemet OS.indent(Depth) << "Run-time memory checks:\n"; 43215840393SAdam Nemet printChecks(OS, Checks, Depth); 4331b6b50a9SSilviu Baranga 4341b6b50a9SSilviu Baranga OS.indent(Depth) << "Grouped accesses:\n"; 4351b6b50a9SSilviu Baranga for (unsigned I = 0; I < CheckingGroups.size(); ++I) { 43654f0b83eSAdam Nemet const auto &CG = CheckingGroups[I]; 43754f0b83eSAdam Nemet 43854f0b83eSAdam Nemet OS.indent(Depth + 2) << "Group " << &CG << ":\n"; 43954f0b83eSAdam Nemet OS.indent(Depth + 4) << "(Low: " << *CG.Low << " High: " << *CG.High 44054f0b83eSAdam Nemet << ")\n"; 44154f0b83eSAdam Nemet for (unsigned J = 0; J < CG.Members.size(); ++J) { 44254f0b83eSAdam Nemet OS.indent(Depth + 6) << "Member: " << *Pointers[CG.Members[J]].Expr 4431b6b50a9SSilviu Baranga << "\n"; 4441b6b50a9SSilviu Baranga } 445e91cc6efSAdam Nemet } 446e91cc6efSAdam Nemet } 447e91cc6efSAdam Nemet 4480456327cSAdam Nemet namespace { 4490456327cSAdam Nemet /// \brief Analyses memory accesses in a loop. 4500456327cSAdam Nemet /// 4510456327cSAdam Nemet /// Checks whether run time pointer checks are needed and builds sets for data 4520456327cSAdam Nemet /// dependence checking. 4530456327cSAdam Nemet class AccessAnalysis { 4540456327cSAdam Nemet public: 4550456327cSAdam Nemet /// \brief Read or write access location. 4560456327cSAdam Nemet typedef PointerIntPair<Value *, 1, bool> MemAccessInfo; 4570456327cSAdam Nemet typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet; 4580456327cSAdam Nemet 459e2b885c4SAdam Nemet AccessAnalysis(const DataLayout &Dl, AliasAnalysis *AA, LoopInfo *LI, 4609cd9a7e3SSilviu Baranga MemoryDepChecker::DepCandidates &DA, 4619cd9a7e3SSilviu Baranga PredicatedScalarEvolution &PSE) 462e3c0534bSSilviu Baranga : DL(Dl), AST(*AA), LI(LI), DepCands(DA), IsRTCheckAnalysisNeeded(false), 4639cd9a7e3SSilviu Baranga PSE(PSE) {} 4640456327cSAdam Nemet 4650456327cSAdam Nemet /// \brief Register a load and whether it is only read from. 466ac80dc75SChandler Carruth void addLoad(MemoryLocation &Loc, bool IsReadOnly) { 4670456327cSAdam Nemet Value *Ptr = const_cast<Value*>(Loc.Ptr); 468ecbd1682SChandler Carruth AST.add(Ptr, MemoryLocation::UnknownSize, Loc.AATags); 4690456327cSAdam Nemet Accesses.insert(MemAccessInfo(Ptr, false)); 4700456327cSAdam Nemet if (IsReadOnly) 4710456327cSAdam Nemet ReadOnlyPtr.insert(Ptr); 4720456327cSAdam Nemet } 4730456327cSAdam Nemet 4740456327cSAdam Nemet /// \brief Register a store. 475ac80dc75SChandler Carruth void addStore(MemoryLocation &Loc) { 4760456327cSAdam Nemet Value *Ptr = const_cast<Value*>(Loc.Ptr); 477ecbd1682SChandler Carruth AST.add(Ptr, MemoryLocation::UnknownSize, Loc.AATags); 4780456327cSAdam Nemet Accesses.insert(MemAccessInfo(Ptr, true)); 4790456327cSAdam Nemet } 4800456327cSAdam Nemet 4810456327cSAdam Nemet /// \brief Check whether we can check the pointers at runtime for 482ee61474aSAdam Nemet /// non-intersection. 483ee61474aSAdam Nemet /// 484ee61474aSAdam Nemet /// Returns true if we need no check or if we do and we can generate them 485ee61474aSAdam Nemet /// (i.e. the pointers have computable bounds). 4867cdebac0SAdam Nemet bool canCheckPtrAtRT(RuntimePointerChecking &RtCheck, ScalarEvolution *SE, 4877cdebac0SAdam Nemet Loop *TheLoop, const ValueToValueMap &Strides, 4889f02c586SAndrey Turetskiy bool ShouldCheckWrap = false); 4890456327cSAdam Nemet 4900456327cSAdam Nemet /// \brief Goes over all memory accesses, checks whether a RT check is needed 4910456327cSAdam Nemet /// and builds sets of dependent accesses. 4920456327cSAdam Nemet void buildDependenceSets() { 4930456327cSAdam Nemet processMemAccesses(); 4940456327cSAdam Nemet } 4950456327cSAdam Nemet 4965dc3b2cfSAdam Nemet /// \brief Initial processing of memory accesses determined that we need to 4975dc3b2cfSAdam Nemet /// perform dependency checking. 4985dc3b2cfSAdam Nemet /// 4995dc3b2cfSAdam Nemet /// Note that this can later be cleared if we retry memcheck analysis without 5005dc3b2cfSAdam Nemet /// dependency checking (i.e. ShouldRetryWithRuntimeCheck). 5010456327cSAdam Nemet bool isDependencyCheckNeeded() { return !CheckDeps.empty(); } 502df3dc5b9SAdam Nemet 503df3dc5b9SAdam Nemet /// We decided that no dependence analysis would be used. Reset the state. 504df3dc5b9SAdam Nemet void resetDepChecks(MemoryDepChecker &DepChecker) { 505df3dc5b9SAdam Nemet CheckDeps.clear(); 506a2df750fSAdam Nemet DepChecker.clearDependences(); 507df3dc5b9SAdam Nemet } 5080456327cSAdam Nemet 5090456327cSAdam Nemet MemAccessInfoSet &getDependenciesToCheck() { return CheckDeps; } 5100456327cSAdam Nemet 5110456327cSAdam Nemet private: 5120456327cSAdam Nemet typedef SetVector<MemAccessInfo> PtrAccessSet; 5130456327cSAdam Nemet 5140456327cSAdam Nemet /// \brief Go over all memory access and check whether runtime pointer checks 515b41d2d3fSAdam Nemet /// are needed and build sets of dependency check candidates. 5160456327cSAdam Nemet void processMemAccesses(); 5170456327cSAdam Nemet 5180456327cSAdam Nemet /// Set of all accesses. 5190456327cSAdam Nemet PtrAccessSet Accesses; 5200456327cSAdam Nemet 521a28d91d8SMehdi Amini const DataLayout &DL; 522a28d91d8SMehdi Amini 5230456327cSAdam Nemet /// Set of accesses that need a further dependence check. 5240456327cSAdam Nemet MemAccessInfoSet CheckDeps; 5250456327cSAdam Nemet 5260456327cSAdam Nemet /// Set of pointers that are read only. 5270456327cSAdam Nemet SmallPtrSet<Value*, 16> ReadOnlyPtr; 5280456327cSAdam Nemet 5290456327cSAdam Nemet /// An alias set tracker to partition the access set by underlying object and 5300456327cSAdam Nemet //intrinsic property (such as TBAA metadata). 5310456327cSAdam Nemet AliasSetTracker AST; 5320456327cSAdam Nemet 533e2b885c4SAdam Nemet LoopInfo *LI; 534e2b885c4SAdam Nemet 5350456327cSAdam Nemet /// Sets of potentially dependent accesses - members of one set share an 5360456327cSAdam Nemet /// underlying pointer. The set "CheckDeps" identfies which sets really need a 5370456327cSAdam Nemet /// dependence check. 538dee666bcSAdam Nemet MemoryDepChecker::DepCandidates &DepCands; 5390456327cSAdam Nemet 5405dc3b2cfSAdam Nemet /// \brief Initial processing of memory accesses determined that we may need 5415dc3b2cfSAdam Nemet /// to add memchecks. Perform the analysis to determine the necessary checks. 5425dc3b2cfSAdam Nemet /// 5435dc3b2cfSAdam Nemet /// Note that, this is different from isDependencyCheckNeeded. When we retry 5445dc3b2cfSAdam Nemet /// memcheck analysis without dependency checking 5455dc3b2cfSAdam Nemet /// (i.e. ShouldRetryWithRuntimeCheck), isDependencyCheckNeeded is cleared 5465dc3b2cfSAdam Nemet /// while this remains set if we have potentially dependent accesses. 5475dc3b2cfSAdam Nemet bool IsRTCheckAnalysisNeeded; 548e3c0534bSSilviu Baranga 549e3c0534bSSilviu Baranga /// The SCEV predicate containing all the SCEV-related assumptions. 5509cd9a7e3SSilviu Baranga PredicatedScalarEvolution &PSE; 5510456327cSAdam Nemet }; 5520456327cSAdam Nemet 5530456327cSAdam Nemet } // end anonymous namespace 5540456327cSAdam Nemet 5550456327cSAdam Nemet /// \brief Check whether a pointer can participate in a runtime bounds check. 5569cd9a7e3SSilviu Baranga static bool hasComputableBounds(PredicatedScalarEvolution &PSE, 557e3c0534bSSilviu Baranga const ValueToValueMap &Strides, Value *Ptr, 5589cd9a7e3SSilviu Baranga Loop *L) { 5599cd9a7e3SSilviu Baranga const SCEV *PtrScev = replaceSymbolicStrideSCEV(PSE, Strides, Ptr); 560279784ffSAdam Nemet 561279784ffSAdam Nemet // The bounds for loop-invariant pointer is trivial. 562279784ffSAdam Nemet if (PSE.getSE()->isLoopInvariant(PtrScev, L)) 563279784ffSAdam Nemet return true; 564279784ffSAdam Nemet 5650456327cSAdam Nemet const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev); 5660456327cSAdam Nemet if (!AR) 5670456327cSAdam Nemet return false; 5680456327cSAdam Nemet 5690456327cSAdam Nemet return AR->isAffine(); 5700456327cSAdam Nemet } 5710456327cSAdam Nemet 5729f02c586SAndrey Turetskiy /// \brief Check whether a pointer address cannot wrap. 5739f02c586SAndrey Turetskiy static bool isNoWrap(PredicatedScalarEvolution &PSE, 5749f02c586SAndrey Turetskiy const ValueToValueMap &Strides, Value *Ptr, Loop *L) { 5759f02c586SAndrey Turetskiy const SCEV *PtrScev = PSE.getSCEV(Ptr); 5769f02c586SAndrey Turetskiy if (PSE.getSE()->isLoopInvariant(PtrScev, L)) 5779f02c586SAndrey Turetskiy return true; 5789f02c586SAndrey Turetskiy 5797afb46d3SDavid Majnemer int64_t Stride = getPtrStride(PSE, Ptr, L, Strides); 5809f02c586SAndrey Turetskiy return Stride == 1; 5819f02c586SAndrey Turetskiy } 5829f02c586SAndrey Turetskiy 5837cdebac0SAdam Nemet bool AccessAnalysis::canCheckPtrAtRT(RuntimePointerChecking &RtCheck, 5847cdebac0SAdam Nemet ScalarEvolution *SE, Loop *TheLoop, 5857cdebac0SAdam Nemet const ValueToValueMap &StridesMap, 5869f02c586SAndrey Turetskiy bool ShouldCheckWrap) { 5870456327cSAdam Nemet // Find pointers with computable bounds. We are going to use this information 5880456327cSAdam Nemet // to place a runtime bound check. 5890456327cSAdam Nemet bool CanDoRT = true; 5900456327cSAdam Nemet 591ee61474aSAdam Nemet bool NeedRTCheck = false; 5925dc3b2cfSAdam Nemet if (!IsRTCheckAnalysisNeeded) return true; 59398a13719SSilviu Baranga 5940456327cSAdam Nemet bool IsDepCheckNeeded = isDependencyCheckNeeded(); 5950456327cSAdam Nemet 5960456327cSAdam Nemet // We assign a consecutive id to access from different alias sets. 5970456327cSAdam Nemet // Accesses between different groups doesn't need to be checked. 5980456327cSAdam Nemet unsigned ASId = 1; 5990456327cSAdam Nemet for (auto &AS : AST) { 600424edc6cSAdam Nemet int NumReadPtrChecks = 0; 601424edc6cSAdam Nemet int NumWritePtrChecks = 0; 602424edc6cSAdam Nemet 6030456327cSAdam Nemet // We assign consecutive id to access from different dependence sets. 6040456327cSAdam Nemet // Accesses within the same set don't need a runtime check. 6050456327cSAdam Nemet unsigned RunningDepId = 1; 6060456327cSAdam Nemet DenseMap<Value *, unsigned> DepSetId; 6070456327cSAdam Nemet 6080456327cSAdam Nemet for (auto A : AS) { 6090456327cSAdam Nemet Value *Ptr = A.getValue(); 6100456327cSAdam Nemet bool IsWrite = Accesses.count(MemAccessInfo(Ptr, true)); 6110456327cSAdam Nemet MemAccessInfo Access(Ptr, IsWrite); 6120456327cSAdam Nemet 613424edc6cSAdam Nemet if (IsWrite) 614424edc6cSAdam Nemet ++NumWritePtrChecks; 615424edc6cSAdam Nemet else 616424edc6cSAdam Nemet ++NumReadPtrChecks; 617424edc6cSAdam Nemet 6189cd9a7e3SSilviu Baranga if (hasComputableBounds(PSE, StridesMap, Ptr, TheLoop) && 619a28d91d8SMehdi Amini // When we run after a failing dependency check we have to make sure 620a28d91d8SMehdi Amini // we don't have wrapping pointers. 6219f02c586SAndrey Turetskiy (!ShouldCheckWrap || isNoWrap(PSE, StridesMap, Ptr, TheLoop))) { 6220456327cSAdam Nemet // The id of the dependence set. 6230456327cSAdam Nemet unsigned DepId; 6240456327cSAdam Nemet 6250456327cSAdam Nemet if (IsDepCheckNeeded) { 6260456327cSAdam Nemet Value *Leader = DepCands.getLeaderValue(Access).getPointer(); 6270456327cSAdam Nemet unsigned &LeaderId = DepSetId[Leader]; 6280456327cSAdam Nemet if (!LeaderId) 6290456327cSAdam Nemet LeaderId = RunningDepId++; 6300456327cSAdam Nemet DepId = LeaderId; 6310456327cSAdam Nemet } else 6320456327cSAdam Nemet // Each access has its own dependence set. 6330456327cSAdam Nemet DepId = RunningDepId++; 6340456327cSAdam Nemet 6359cd9a7e3SSilviu Baranga RtCheck.insert(TheLoop, Ptr, IsWrite, DepId, ASId, StridesMap, PSE); 6360456327cSAdam Nemet 637339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a runtime check ptr:" << *Ptr << '\n'); 6380456327cSAdam Nemet } else { 639f10ca278SAdam Nemet DEBUG(dbgs() << "LAA: Can't find bounds for ptr:" << *Ptr << '\n'); 6400456327cSAdam Nemet CanDoRT = false; 6410456327cSAdam Nemet } 6420456327cSAdam Nemet } 6430456327cSAdam Nemet 644424edc6cSAdam Nemet // If we have at least two writes or one write and a read then we need to 645424edc6cSAdam Nemet // check them. But there is no need to checks if there is only one 646424edc6cSAdam Nemet // dependence set for this alias set. 647424edc6cSAdam Nemet // 648424edc6cSAdam Nemet // Note that this function computes CanDoRT and NeedRTCheck independently. 649424edc6cSAdam Nemet // For example CanDoRT=false, NeedRTCheck=false means that we have a pointer 650424edc6cSAdam Nemet // for which we couldn't find the bounds but we don't actually need to emit 651424edc6cSAdam Nemet // any checks so it does not matter. 652424edc6cSAdam Nemet if (!(IsDepCheckNeeded && CanDoRT && RunningDepId == 2)) 653424edc6cSAdam Nemet NeedRTCheck |= (NumWritePtrChecks >= 2 || (NumReadPtrChecks >= 1 && 654424edc6cSAdam Nemet NumWritePtrChecks >= 1)); 655424edc6cSAdam Nemet 6560456327cSAdam Nemet ++ASId; 6570456327cSAdam Nemet } 6580456327cSAdam Nemet 6590456327cSAdam Nemet // If the pointers that we would use for the bounds comparison have different 6600456327cSAdam Nemet // address spaces, assume the values aren't directly comparable, so we can't 6610456327cSAdam Nemet // use them for the runtime check. We also have to assume they could 6620456327cSAdam Nemet // overlap. In the future there should be metadata for whether address spaces 6630456327cSAdam Nemet // are disjoint. 6640456327cSAdam Nemet unsigned NumPointers = RtCheck.Pointers.size(); 6650456327cSAdam Nemet for (unsigned i = 0; i < NumPointers; ++i) { 6660456327cSAdam Nemet for (unsigned j = i + 1; j < NumPointers; ++j) { 6670456327cSAdam Nemet // Only need to check pointers between two different dependency sets. 6689f7dedc3SAdam Nemet if (RtCheck.Pointers[i].DependencySetId == 6699f7dedc3SAdam Nemet RtCheck.Pointers[j].DependencySetId) 6700456327cSAdam Nemet continue; 6710456327cSAdam Nemet // Only need to check pointers in the same alias set. 6729f7dedc3SAdam Nemet if (RtCheck.Pointers[i].AliasSetId != RtCheck.Pointers[j].AliasSetId) 6730456327cSAdam Nemet continue; 6740456327cSAdam Nemet 6759f7dedc3SAdam Nemet Value *PtrI = RtCheck.Pointers[i].PointerValue; 6769f7dedc3SAdam Nemet Value *PtrJ = RtCheck.Pointers[j].PointerValue; 6770456327cSAdam Nemet 6780456327cSAdam Nemet unsigned ASi = PtrI->getType()->getPointerAddressSpace(); 6790456327cSAdam Nemet unsigned ASj = PtrJ->getType()->getPointerAddressSpace(); 6800456327cSAdam Nemet if (ASi != ASj) { 681339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Runtime check would require comparison between" 6820456327cSAdam Nemet " different address spaces\n"); 6830456327cSAdam Nemet return false; 6840456327cSAdam Nemet } 6850456327cSAdam Nemet } 6860456327cSAdam Nemet } 6870456327cSAdam Nemet 6881b6b50a9SSilviu Baranga if (NeedRTCheck && CanDoRT) 68915840393SAdam Nemet RtCheck.generateChecks(DepCands, IsDepCheckNeeded); 6901b6b50a9SSilviu Baranga 691155e8741SAdam Nemet DEBUG(dbgs() << "LAA: We need to do " << RtCheck.getNumberOfChecks() 692ee61474aSAdam Nemet << " pointer comparisons.\n"); 693ee61474aSAdam Nemet 694ee61474aSAdam Nemet RtCheck.Need = NeedRTCheck; 695ee61474aSAdam Nemet 696ee61474aSAdam Nemet bool CanDoRTIfNeeded = !NeedRTCheck || CanDoRT; 697ee61474aSAdam Nemet if (!CanDoRTIfNeeded) 698ee61474aSAdam Nemet RtCheck.reset(); 699ee61474aSAdam Nemet return CanDoRTIfNeeded; 7000456327cSAdam Nemet } 7010456327cSAdam Nemet 7020456327cSAdam Nemet void AccessAnalysis::processMemAccesses() { 7030456327cSAdam Nemet // We process the set twice: first we process read-write pointers, last we 7040456327cSAdam Nemet // process read-only pointers. This allows us to skip dependence tests for 7050456327cSAdam Nemet // read-only pointers. 7060456327cSAdam Nemet 707339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Processing memory accesses...\n"); 7080456327cSAdam Nemet DEBUG(dbgs() << " AST: "; AST.dump()); 7099c926579SAdam Nemet DEBUG(dbgs() << "LAA: Accesses(" << Accesses.size() << "):\n"); 7100456327cSAdam Nemet DEBUG({ 7110456327cSAdam Nemet for (auto A : Accesses) 7120456327cSAdam Nemet dbgs() << "\t" << *A.getPointer() << " (" << 7130456327cSAdam Nemet (A.getInt() ? "write" : (ReadOnlyPtr.count(A.getPointer()) ? 7140456327cSAdam Nemet "read-only" : "read")) << ")\n"; 7150456327cSAdam Nemet }); 7160456327cSAdam Nemet 7170456327cSAdam Nemet // The AliasSetTracker has nicely partitioned our pointers by metadata 7180456327cSAdam Nemet // compatibility and potential for underlying-object overlap. As a result, we 7190456327cSAdam Nemet // only need to check for potential pointer dependencies within each alias 7200456327cSAdam Nemet // set. 7210456327cSAdam Nemet for (auto &AS : AST) { 7220456327cSAdam Nemet // Note that both the alias-set tracker and the alias sets themselves used 7230456327cSAdam Nemet // linked lists internally and so the iteration order here is deterministic 7240456327cSAdam Nemet // (matching the original instruction order within each set). 7250456327cSAdam Nemet 7260456327cSAdam Nemet bool SetHasWrite = false; 7270456327cSAdam Nemet 7280456327cSAdam Nemet // Map of pointers to last access encountered. 7290456327cSAdam Nemet typedef DenseMap<Value*, MemAccessInfo> UnderlyingObjToAccessMap; 7300456327cSAdam Nemet UnderlyingObjToAccessMap ObjToLastAccess; 7310456327cSAdam Nemet 7320456327cSAdam Nemet // Set of access to check after all writes have been processed. 7330456327cSAdam Nemet PtrAccessSet DeferredAccesses; 7340456327cSAdam Nemet 7350456327cSAdam Nemet // Iterate over each alias set twice, once to process read/write pointers, 7360456327cSAdam Nemet // and then to process read-only pointers. 7370456327cSAdam Nemet for (int SetIteration = 0; SetIteration < 2; ++SetIteration) { 7380456327cSAdam Nemet bool UseDeferred = SetIteration > 0; 7390456327cSAdam Nemet PtrAccessSet &S = UseDeferred ? DeferredAccesses : Accesses; 7400456327cSAdam Nemet 7410456327cSAdam Nemet for (auto AV : AS) { 7420456327cSAdam Nemet Value *Ptr = AV.getValue(); 7430456327cSAdam Nemet 7440456327cSAdam Nemet // For a single memory access in AliasSetTracker, Accesses may contain 7450456327cSAdam Nemet // both read and write, and they both need to be handled for CheckDeps. 7460456327cSAdam Nemet for (auto AC : S) { 7470456327cSAdam Nemet if (AC.getPointer() != Ptr) 7480456327cSAdam Nemet continue; 7490456327cSAdam Nemet 7500456327cSAdam Nemet bool IsWrite = AC.getInt(); 7510456327cSAdam Nemet 7520456327cSAdam Nemet // If we're using the deferred access set, then it contains only 7530456327cSAdam Nemet // reads. 7540456327cSAdam Nemet bool IsReadOnlyPtr = ReadOnlyPtr.count(Ptr) && !IsWrite; 7550456327cSAdam Nemet if (UseDeferred && !IsReadOnlyPtr) 7560456327cSAdam Nemet continue; 7570456327cSAdam Nemet // Otherwise, the pointer must be in the PtrAccessSet, either as a 7580456327cSAdam Nemet // read or a write. 7590456327cSAdam Nemet assert(((IsReadOnlyPtr && UseDeferred) || IsWrite || 7600456327cSAdam Nemet S.count(MemAccessInfo(Ptr, false))) && 7610456327cSAdam Nemet "Alias-set pointer not in the access set?"); 7620456327cSAdam Nemet 7630456327cSAdam Nemet MemAccessInfo Access(Ptr, IsWrite); 7640456327cSAdam Nemet DepCands.insert(Access); 7650456327cSAdam Nemet 7660456327cSAdam Nemet // Memorize read-only pointers for later processing and skip them in 7670456327cSAdam Nemet // the first round (they need to be checked after we have seen all 7680456327cSAdam Nemet // write pointers). Note: we also mark pointer that are not 7690456327cSAdam Nemet // consecutive as "read-only" pointers (so that we check 7700456327cSAdam Nemet // "a[b[i]] +="). Hence, we need the second check for "!IsWrite". 7710456327cSAdam Nemet if (!UseDeferred && IsReadOnlyPtr) { 7720456327cSAdam Nemet DeferredAccesses.insert(Access); 7730456327cSAdam Nemet continue; 7740456327cSAdam Nemet } 7750456327cSAdam Nemet 7760456327cSAdam Nemet // If this is a write - check other reads and writes for conflicts. If 7770456327cSAdam Nemet // this is a read only check other writes for conflicts (but only if 7780456327cSAdam Nemet // there is no other write to the ptr - this is an optimization to 7790456327cSAdam Nemet // catch "a[i] = a[i] + " without having to do a dependence check). 7800456327cSAdam Nemet if ((IsWrite || IsReadOnlyPtr) && SetHasWrite) { 7810456327cSAdam Nemet CheckDeps.insert(Access); 7825dc3b2cfSAdam Nemet IsRTCheckAnalysisNeeded = true; 7830456327cSAdam Nemet } 7840456327cSAdam Nemet 7850456327cSAdam Nemet if (IsWrite) 7860456327cSAdam Nemet SetHasWrite = true; 7870456327cSAdam Nemet 7880456327cSAdam Nemet // Create sets of pointers connected by a shared alias set and 7890456327cSAdam Nemet // underlying object. 7900456327cSAdam Nemet typedef SmallVector<Value *, 16> ValueVector; 7910456327cSAdam Nemet ValueVector TempObjects; 792e2b885c4SAdam Nemet 793e2b885c4SAdam Nemet GetUnderlyingObjects(Ptr, TempObjects, DL, LI); 794e2b885c4SAdam Nemet DEBUG(dbgs() << "Underlying objects for pointer " << *Ptr << "\n"); 7950456327cSAdam Nemet for (Value *UnderlyingObj : TempObjects) { 796afd13519SMehdi Amini // nullptr never alias, don't join sets for pointer that have "null" 797afd13519SMehdi Amini // in their UnderlyingObjects list. 798afd13519SMehdi Amini if (isa<ConstantPointerNull>(UnderlyingObj)) 799afd13519SMehdi Amini continue; 800afd13519SMehdi Amini 8010456327cSAdam Nemet UnderlyingObjToAccessMap::iterator Prev = 8020456327cSAdam Nemet ObjToLastAccess.find(UnderlyingObj); 8030456327cSAdam Nemet if (Prev != ObjToLastAccess.end()) 8040456327cSAdam Nemet DepCands.unionSets(Access, Prev->second); 8050456327cSAdam Nemet 8060456327cSAdam Nemet ObjToLastAccess[UnderlyingObj] = Access; 807e2b885c4SAdam Nemet DEBUG(dbgs() << " " << *UnderlyingObj << "\n"); 8080456327cSAdam Nemet } 8090456327cSAdam Nemet } 8100456327cSAdam Nemet } 8110456327cSAdam Nemet } 8120456327cSAdam Nemet } 8130456327cSAdam Nemet } 8140456327cSAdam Nemet 8150456327cSAdam Nemet static bool isInBoundsGep(Value *Ptr) { 8160456327cSAdam Nemet if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr)) 8170456327cSAdam Nemet return GEP->isInBounds(); 8180456327cSAdam Nemet return false; 8190456327cSAdam Nemet } 8200456327cSAdam Nemet 821c4866d29SAdam Nemet /// \brief Return true if an AddRec pointer \p Ptr is unsigned non-wrapping, 822c4866d29SAdam Nemet /// i.e. monotonically increasing/decreasing. 823c4866d29SAdam Nemet static bool isNoWrapAddRec(Value *Ptr, const SCEVAddRecExpr *AR, 824ea63a7f5SSilviu Baranga PredicatedScalarEvolution &PSE, const Loop *L) { 825c4866d29SAdam Nemet // FIXME: This should probably only return true for NUW. 826c4866d29SAdam Nemet if (AR->getNoWrapFlags(SCEV::NoWrapMask)) 827c4866d29SAdam Nemet return true; 828c4866d29SAdam Nemet 829c4866d29SAdam Nemet // Scalar evolution does not propagate the non-wrapping flags to values that 830c4866d29SAdam Nemet // are derived from a non-wrapping induction variable because non-wrapping 831c4866d29SAdam Nemet // could be flow-sensitive. 832c4866d29SAdam Nemet // 833c4866d29SAdam Nemet // Look through the potentially overflowing instruction to try to prove 834c4866d29SAdam Nemet // non-wrapping for the *specific* value of Ptr. 835c4866d29SAdam Nemet 836c4866d29SAdam Nemet // The arithmetic implied by an inbounds GEP can't overflow. 837c4866d29SAdam Nemet auto *GEP = dyn_cast<GetElementPtrInst>(Ptr); 838c4866d29SAdam Nemet if (!GEP || !GEP->isInBounds()) 839c4866d29SAdam Nemet return false; 840c4866d29SAdam Nemet 841c4866d29SAdam Nemet // Make sure there is only one non-const index and analyze that. 842c4866d29SAdam Nemet Value *NonConstIndex = nullptr; 8438b401013SDavid Majnemer for (Value *Index : make_range(GEP->idx_begin(), GEP->idx_end())) 8448b401013SDavid Majnemer if (!isa<ConstantInt>(Index)) { 845c4866d29SAdam Nemet if (NonConstIndex) 846c4866d29SAdam Nemet return false; 8478b401013SDavid Majnemer NonConstIndex = Index; 848c4866d29SAdam Nemet } 849c4866d29SAdam Nemet if (!NonConstIndex) 850c4866d29SAdam Nemet // The recurrence is on the pointer, ignore for now. 851c4866d29SAdam Nemet return false; 852c4866d29SAdam Nemet 853c4866d29SAdam Nemet // The index in GEP is signed. It is non-wrapping if it's derived from a NSW 854c4866d29SAdam Nemet // AddRec using a NSW operation. 855c4866d29SAdam Nemet if (auto *OBO = dyn_cast<OverflowingBinaryOperator>(NonConstIndex)) 856c4866d29SAdam Nemet if (OBO->hasNoSignedWrap() && 857c4866d29SAdam Nemet // Assume constant for other the operand so that the AddRec can be 858c4866d29SAdam Nemet // easily found. 859c4866d29SAdam Nemet isa<ConstantInt>(OBO->getOperand(1))) { 860ea63a7f5SSilviu Baranga auto *OpScev = PSE.getSCEV(OBO->getOperand(0)); 861c4866d29SAdam Nemet 862c4866d29SAdam Nemet if (auto *OpAR = dyn_cast<SCEVAddRecExpr>(OpScev)) 863c4866d29SAdam Nemet return OpAR->getLoop() == L && OpAR->getNoWrapFlags(SCEV::FlagNSW); 864c4866d29SAdam Nemet } 865c4866d29SAdam Nemet 866c4866d29SAdam Nemet return false; 867c4866d29SAdam Nemet } 868c4866d29SAdam Nemet 8690456327cSAdam Nemet /// \brief Check whether the access through \p Ptr has a constant stride. 8707afb46d3SDavid Majnemer int64_t llvm::getPtrStride(PredicatedScalarEvolution &PSE, Value *Ptr, 871ea63a7f5SSilviu Baranga const Loop *Lp, const ValueToValueMap &StridesMap, 8725e21c94fSElena Demikhovsky bool Assume) { 873e3dcce97SCraig Topper Type *Ty = Ptr->getType(); 8740456327cSAdam Nemet assert(Ty->isPointerTy() && "Unexpected non-ptr"); 8750456327cSAdam Nemet 8760456327cSAdam Nemet // Make sure that the pointer does not point to aggregate types. 877e3dcce97SCraig Topper auto *PtrTy = cast<PointerType>(Ty); 8780456327cSAdam Nemet if (PtrTy->getElementType()->isAggregateType()) { 879ea63a7f5SSilviu Baranga DEBUG(dbgs() << "LAA: Bad stride - Not a pointer to a scalar type" << *Ptr 880ea63a7f5SSilviu Baranga << "\n"); 8810456327cSAdam Nemet return 0; 8820456327cSAdam Nemet } 8830456327cSAdam Nemet 8849cd9a7e3SSilviu Baranga const SCEV *PtrScev = replaceSymbolicStrideSCEV(PSE, StridesMap, Ptr); 8850456327cSAdam Nemet 8860456327cSAdam Nemet const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev); 887ea63a7f5SSilviu Baranga if (Assume && !AR) 888d68ed854SSilviu Baranga AR = PSE.getAsAddRec(Ptr); 889ea63a7f5SSilviu Baranga 8900456327cSAdam Nemet if (!AR) { 891ea63a7f5SSilviu Baranga DEBUG(dbgs() << "LAA: Bad stride - Not an AddRecExpr pointer " << *Ptr 892ea63a7f5SSilviu Baranga << " SCEV: " << *PtrScev << "\n"); 8930456327cSAdam Nemet return 0; 8940456327cSAdam Nemet } 8950456327cSAdam Nemet 8960456327cSAdam Nemet // The accesss function must stride over the innermost loop. 8970456327cSAdam Nemet if (Lp != AR->getLoop()) { 898339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Not striding over innermost loop " << 899ea63a7f5SSilviu Baranga *Ptr << " SCEV: " << *AR << "\n"); 900a02ce98bSKyle Butt return 0; 9010456327cSAdam Nemet } 9020456327cSAdam Nemet 9030456327cSAdam Nemet // The address calculation must not wrap. Otherwise, a dependence could be 9040456327cSAdam Nemet // inverted. 9050456327cSAdam Nemet // An inbounds getelementptr that is a AddRec with a unit stride 9060456327cSAdam Nemet // cannot wrap per definition. The unit stride requirement is checked later. 9070456327cSAdam Nemet // An getelementptr without an inbounds attribute and unit stride would have 9080456327cSAdam Nemet // to access the pointer value "0" which is undefined behavior in address 9090456327cSAdam Nemet // space 0, therefore we can also vectorize this case. 9100456327cSAdam Nemet bool IsInBoundsGEP = isInBoundsGep(Ptr); 9115e21c94fSElena Demikhovsky bool IsNoWrapAddRec = 912ea63a7f5SSilviu Baranga PSE.hasNoOverflow(Ptr, SCEVWrapPredicate::IncrementNUSW) || 913ea63a7f5SSilviu Baranga isNoWrapAddRec(Ptr, AR, PSE, Lp); 9140456327cSAdam Nemet bool IsInAddressSpaceZero = PtrTy->getAddressSpace() == 0; 9150456327cSAdam Nemet if (!IsNoWrapAddRec && !IsInBoundsGEP && !IsInAddressSpaceZero) { 916ea63a7f5SSilviu Baranga if (Assume) { 917ea63a7f5SSilviu Baranga PSE.setNoOverflow(Ptr, SCEVWrapPredicate::IncrementNUSW); 918ea63a7f5SSilviu Baranga IsNoWrapAddRec = true; 919ea63a7f5SSilviu Baranga DEBUG(dbgs() << "LAA: Pointer may wrap in the address space:\n" 920ea63a7f5SSilviu Baranga << "LAA: Pointer: " << *Ptr << "\n" 921ea63a7f5SSilviu Baranga << "LAA: SCEV: " << *AR << "\n" 922ea63a7f5SSilviu Baranga << "LAA: Added an overflow assumption\n"); 923ea63a7f5SSilviu Baranga } else { 924339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Pointer may wrap in the address space " 925ea63a7f5SSilviu Baranga << *Ptr << " SCEV: " << *AR << "\n"); 9260456327cSAdam Nemet return 0; 9270456327cSAdam Nemet } 928ea63a7f5SSilviu Baranga } 9290456327cSAdam Nemet 9300456327cSAdam Nemet // Check the step is constant. 9319cd9a7e3SSilviu Baranga const SCEV *Step = AR->getStepRecurrence(*PSE.getSE()); 9320456327cSAdam Nemet 933943befedSAdam Nemet // Calculate the pointer stride and check if it is constant. 9340456327cSAdam Nemet const SCEVConstant *C = dyn_cast<SCEVConstant>(Step); 9350456327cSAdam Nemet if (!C) { 936339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Not a constant strided " << *Ptr << 937ea63a7f5SSilviu Baranga " SCEV: " << *AR << "\n"); 9380456327cSAdam Nemet return 0; 9390456327cSAdam Nemet } 9400456327cSAdam Nemet 941a28d91d8SMehdi Amini auto &DL = Lp->getHeader()->getModule()->getDataLayout(); 942a28d91d8SMehdi Amini int64_t Size = DL.getTypeAllocSize(PtrTy->getElementType()); 9430de2feceSSanjoy Das const APInt &APStepVal = C->getAPInt(); 9440456327cSAdam Nemet 9450456327cSAdam Nemet // Huge step value - give up. 9460456327cSAdam Nemet if (APStepVal.getBitWidth() > 64) 9470456327cSAdam Nemet return 0; 9480456327cSAdam Nemet 9490456327cSAdam Nemet int64_t StepVal = APStepVal.getSExtValue(); 9500456327cSAdam Nemet 9510456327cSAdam Nemet // Strided access. 9520456327cSAdam Nemet int64_t Stride = StepVal / Size; 9530456327cSAdam Nemet int64_t Rem = StepVal % Size; 9540456327cSAdam Nemet if (Rem) 9550456327cSAdam Nemet return 0; 9560456327cSAdam Nemet 9570456327cSAdam Nemet // If the SCEV could wrap but we have an inbounds gep with a unit stride we 9580456327cSAdam Nemet // know we can't "wrap around the address space". In case of address space 9590456327cSAdam Nemet // zero we know that this won't happen without triggering undefined behavior. 9600456327cSAdam Nemet if (!IsNoWrapAddRec && (IsInBoundsGEP || IsInAddressSpaceZero) && 961ea63a7f5SSilviu Baranga Stride != 1 && Stride != -1) { 962ea63a7f5SSilviu Baranga if (Assume) { 963ea63a7f5SSilviu Baranga // We can avoid this case by adding a run-time check. 964ea63a7f5SSilviu Baranga DEBUG(dbgs() << "LAA: Non unit strided pointer which is not either " 965ea63a7f5SSilviu Baranga << "inbouds or in address space 0 may wrap:\n" 966ea63a7f5SSilviu Baranga << "LAA: Pointer: " << *Ptr << "\n" 967ea63a7f5SSilviu Baranga << "LAA: SCEV: " << *AR << "\n" 968ea63a7f5SSilviu Baranga << "LAA: Added an overflow assumption\n"); 969ea63a7f5SSilviu Baranga PSE.setNoOverflow(Ptr, SCEVWrapPredicate::IncrementNUSW); 970ea63a7f5SSilviu Baranga } else 9710456327cSAdam Nemet return 0; 972ea63a7f5SSilviu Baranga } 9730456327cSAdam Nemet 9740456327cSAdam Nemet return Stride; 9750456327cSAdam Nemet } 9760456327cSAdam Nemet 977f1c00a22SHaicheng Wu /// Take the pointer operand from the Load/Store instruction. 978f1c00a22SHaicheng Wu /// Returns NULL if this is not a valid Load/Store instruction. 979f1c00a22SHaicheng Wu static Value *getPointerOperand(Value *I) { 9808b401013SDavid Majnemer if (auto *LI = dyn_cast<LoadInst>(I)) 981f1c00a22SHaicheng Wu return LI->getPointerOperand(); 9828b401013SDavid Majnemer if (auto *SI = dyn_cast<StoreInst>(I)) 983f1c00a22SHaicheng Wu return SI->getPointerOperand(); 984f1c00a22SHaicheng Wu return nullptr; 985f1c00a22SHaicheng Wu } 986f1c00a22SHaicheng Wu 987f1c00a22SHaicheng Wu /// Take the address space operand from the Load/Store instruction. 988f1c00a22SHaicheng Wu /// Returns -1 if this is not a valid Load/Store instruction. 989f1c00a22SHaicheng Wu static unsigned getAddressSpaceOperand(Value *I) { 990f1c00a22SHaicheng Wu if (LoadInst *L = dyn_cast<LoadInst>(I)) 991f1c00a22SHaicheng Wu return L->getPointerAddressSpace(); 992f1c00a22SHaicheng Wu if (StoreInst *S = dyn_cast<StoreInst>(I)) 993f1c00a22SHaicheng Wu return S->getPointerAddressSpace(); 994f1c00a22SHaicheng Wu return -1; 995f1c00a22SHaicheng Wu } 996f1c00a22SHaicheng Wu 997f1c00a22SHaicheng Wu /// Returns true if the memory operations \p A and \p B are consecutive. 998f1c00a22SHaicheng Wu bool llvm::isConsecutiveAccess(Value *A, Value *B, const DataLayout &DL, 999f1c00a22SHaicheng Wu ScalarEvolution &SE, bool CheckType) { 1000f1c00a22SHaicheng Wu Value *PtrA = getPointerOperand(A); 1001f1c00a22SHaicheng Wu Value *PtrB = getPointerOperand(B); 1002f1c00a22SHaicheng Wu unsigned ASA = getAddressSpaceOperand(A); 1003f1c00a22SHaicheng Wu unsigned ASB = getAddressSpaceOperand(B); 1004f1c00a22SHaicheng Wu 1005f1c00a22SHaicheng Wu // Check that the address spaces match and that the pointers are valid. 1006f1c00a22SHaicheng Wu if (!PtrA || !PtrB || (ASA != ASB)) 1007f1c00a22SHaicheng Wu return false; 1008f1c00a22SHaicheng Wu 1009f1c00a22SHaicheng Wu // Make sure that A and B are different pointers. 1010f1c00a22SHaicheng Wu if (PtrA == PtrB) 1011f1c00a22SHaicheng Wu return false; 1012f1c00a22SHaicheng Wu 1013f1c00a22SHaicheng Wu // Make sure that A and B have the same type if required. 1014f1c00a22SHaicheng Wu if(CheckType && PtrA->getType() != PtrB->getType()) 1015f1c00a22SHaicheng Wu return false; 1016f1c00a22SHaicheng Wu 1017f1c00a22SHaicheng Wu unsigned PtrBitWidth = DL.getPointerSizeInBits(ASA); 1018f1c00a22SHaicheng Wu Type *Ty = cast<PointerType>(PtrA->getType())->getElementType(); 1019f1c00a22SHaicheng Wu APInt Size(PtrBitWidth, DL.getTypeStoreSize(Ty)); 1020f1c00a22SHaicheng Wu 1021f1c00a22SHaicheng Wu APInt OffsetA(PtrBitWidth, 0), OffsetB(PtrBitWidth, 0); 1022f1c00a22SHaicheng Wu PtrA = PtrA->stripAndAccumulateInBoundsConstantOffsets(DL, OffsetA); 1023f1c00a22SHaicheng Wu PtrB = PtrB->stripAndAccumulateInBoundsConstantOffsets(DL, OffsetB); 1024f1c00a22SHaicheng Wu 1025f1c00a22SHaicheng Wu // OffsetDelta = OffsetB - OffsetA; 1026f1c00a22SHaicheng Wu const SCEV *OffsetSCEVA = SE.getConstant(OffsetA); 1027f1c00a22SHaicheng Wu const SCEV *OffsetSCEVB = SE.getConstant(OffsetB); 1028f1c00a22SHaicheng Wu const SCEV *OffsetDeltaSCEV = SE.getMinusSCEV(OffsetSCEVB, OffsetSCEVA); 1029f1c00a22SHaicheng Wu const SCEVConstant *OffsetDeltaC = dyn_cast<SCEVConstant>(OffsetDeltaSCEV); 1030f1c00a22SHaicheng Wu const APInt &OffsetDelta = OffsetDeltaC->getAPInt(); 1031f1c00a22SHaicheng Wu // Check if they are based on the same pointer. That makes the offsets 1032f1c00a22SHaicheng Wu // sufficient. 1033f1c00a22SHaicheng Wu if (PtrA == PtrB) 1034f1c00a22SHaicheng Wu return OffsetDelta == Size; 1035f1c00a22SHaicheng Wu 1036f1c00a22SHaicheng Wu // Compute the necessary base pointer delta to have the necessary final delta 1037f1c00a22SHaicheng Wu // equal to the size. 1038f1c00a22SHaicheng Wu // BaseDelta = Size - OffsetDelta; 1039f1c00a22SHaicheng Wu const SCEV *SizeSCEV = SE.getConstant(Size); 1040f1c00a22SHaicheng Wu const SCEV *BaseDelta = SE.getMinusSCEV(SizeSCEV, OffsetDeltaSCEV); 1041f1c00a22SHaicheng Wu 1042f1c00a22SHaicheng Wu // Otherwise compute the distance with SCEV between the base pointers. 1043f1c00a22SHaicheng Wu const SCEV *PtrSCEVA = SE.getSCEV(PtrA); 1044f1c00a22SHaicheng Wu const SCEV *PtrSCEVB = SE.getSCEV(PtrB); 1045f1c00a22SHaicheng Wu const SCEV *X = SE.getAddExpr(PtrSCEVA, BaseDelta); 1046f1c00a22SHaicheng Wu return X == PtrSCEVB; 1047f1c00a22SHaicheng Wu } 1048f1c00a22SHaicheng Wu 10499c926579SAdam Nemet bool MemoryDepChecker::Dependence::isSafeForVectorization(DepType Type) { 10509c926579SAdam Nemet switch (Type) { 10519c926579SAdam Nemet case NoDep: 10529c926579SAdam Nemet case Forward: 10539c926579SAdam Nemet case BackwardVectorizable: 10549c926579SAdam Nemet return true; 10559c926579SAdam Nemet 10569c926579SAdam Nemet case Unknown: 10579c926579SAdam Nemet case ForwardButPreventsForwarding: 10589c926579SAdam Nemet case Backward: 10599c926579SAdam Nemet case BackwardVectorizableButPreventsForwarding: 10609c926579SAdam Nemet return false; 10619c926579SAdam Nemet } 1062d388e930SDavid Majnemer llvm_unreachable("unexpected DepType!"); 10639c926579SAdam Nemet } 10649c926579SAdam Nemet 1065397f5829SAdam Nemet bool MemoryDepChecker::Dependence::isBackward() const { 10669c926579SAdam Nemet switch (Type) { 10679c926579SAdam Nemet case NoDep: 10689c926579SAdam Nemet case Forward: 10699c926579SAdam Nemet case ForwardButPreventsForwarding: 1070397f5829SAdam Nemet case Unknown: 10719c926579SAdam Nemet return false; 10729c926579SAdam Nemet 10739c926579SAdam Nemet case BackwardVectorizable: 10749c926579SAdam Nemet case Backward: 10759c926579SAdam Nemet case BackwardVectorizableButPreventsForwarding: 10769c926579SAdam Nemet return true; 10779c926579SAdam Nemet } 1078d388e930SDavid Majnemer llvm_unreachable("unexpected DepType!"); 10799c926579SAdam Nemet } 10809c926579SAdam Nemet 1081397f5829SAdam Nemet bool MemoryDepChecker::Dependence::isPossiblyBackward() const { 1082397f5829SAdam Nemet return isBackward() || Type == Unknown; 1083397f5829SAdam Nemet } 1084397f5829SAdam Nemet 1085397f5829SAdam Nemet bool MemoryDepChecker::Dependence::isForward() const { 1086397f5829SAdam Nemet switch (Type) { 1087397f5829SAdam Nemet case Forward: 1088397f5829SAdam Nemet case ForwardButPreventsForwarding: 1089397f5829SAdam Nemet return true; 1090397f5829SAdam Nemet 1091397f5829SAdam Nemet case NoDep: 1092397f5829SAdam Nemet case Unknown: 1093397f5829SAdam Nemet case BackwardVectorizable: 1094397f5829SAdam Nemet case Backward: 1095397f5829SAdam Nemet case BackwardVectorizableButPreventsForwarding: 1096397f5829SAdam Nemet return false; 1097397f5829SAdam Nemet } 1098397f5829SAdam Nemet llvm_unreachable("unexpected DepType!"); 1099397f5829SAdam Nemet } 1100397f5829SAdam Nemet 11017afb46d3SDavid Majnemer bool MemoryDepChecker::couldPreventStoreLoadForward(uint64_t Distance, 11027afb46d3SDavid Majnemer uint64_t TypeByteSize) { 11030456327cSAdam Nemet // If loads occur at a distance that is not a multiple of a feasible vector 11040456327cSAdam Nemet // factor store-load forwarding does not take place. 11050456327cSAdam Nemet // Positive dependences might cause troubles because vectorizing them might 11060456327cSAdam Nemet // prevent store-load forwarding making vectorized code run a lot slower. 11070456327cSAdam Nemet // a[i] = a[i-3] ^ a[i-8]; 11080456327cSAdam Nemet // The stores to a[i:i+1] don't align with the stores to a[i-3:i-2] and 11090456327cSAdam Nemet // hence on your typical architecture store-load forwarding does not take 11100456327cSAdam Nemet // place. Vectorizing in such cases does not make sense. 11110456327cSAdam Nemet // Store-load forwarding distance. 1112884d313bSAdam Nemet 1113884d313bSAdam Nemet // After this many iterations store-to-load forwarding conflicts should not 1114884d313bSAdam Nemet // cause any slowdowns. 11157afb46d3SDavid Majnemer const uint64_t NumItersForStoreLoadThroughMemory = 8 * TypeByteSize; 11160456327cSAdam Nemet // Maximum vector factor. 11177afb46d3SDavid Majnemer uint64_t MaxVFWithoutSLForwardIssues = std::min( 11182c34ab51SAdam Nemet VectorizerParams::MaxVectorWidth * TypeByteSize, MaxSafeDepDistBytes); 11190456327cSAdam Nemet 1120884d313bSAdam Nemet // Compute the smallest VF at which the store and load would be misaligned. 11217afb46d3SDavid Majnemer for (uint64_t VF = 2 * TypeByteSize; VF <= MaxVFWithoutSLForwardIssues; 11229b5852aeSAdam Nemet VF *= 2) { 1123884d313bSAdam Nemet // If the number of vector iteration between the store and the load are 1124884d313bSAdam Nemet // small we could incur conflicts. 1125884d313bSAdam Nemet if (Distance % VF && Distance / VF < NumItersForStoreLoadThroughMemory) { 11269b5852aeSAdam Nemet MaxVFWithoutSLForwardIssues = (VF >>= 1); 11270456327cSAdam Nemet break; 11280456327cSAdam Nemet } 11290456327cSAdam Nemet } 11300456327cSAdam Nemet 11310456327cSAdam Nemet if (MaxVFWithoutSLForwardIssues < 2 * TypeByteSize) { 11329b5852aeSAdam Nemet DEBUG(dbgs() << "LAA: Distance " << Distance 11339b5852aeSAdam Nemet << " that could cause a store-load forwarding conflict\n"); 11340456327cSAdam Nemet return true; 11350456327cSAdam Nemet } 11360456327cSAdam Nemet 11370456327cSAdam Nemet if (MaxVFWithoutSLForwardIssues < MaxSafeDepDistBytes && 1138f219c647SAdam Nemet MaxVFWithoutSLForwardIssues != 1139f219c647SAdam Nemet VectorizerParams::MaxVectorWidth * TypeByteSize) 11400456327cSAdam Nemet MaxSafeDepDistBytes = MaxVFWithoutSLForwardIssues; 11410456327cSAdam Nemet return false; 11420456327cSAdam Nemet } 11430456327cSAdam Nemet 1144751004a6SHao Liu /// \brief Check the dependence for two accesses with the same stride \p Stride. 1145751004a6SHao Liu /// \p Distance is the positive distance and \p TypeByteSize is type size in 1146751004a6SHao Liu /// bytes. 1147751004a6SHao Liu /// 1148751004a6SHao Liu /// \returns true if they are independent. 11497afb46d3SDavid Majnemer static bool areStridedAccessesIndependent(uint64_t Distance, uint64_t Stride, 11507afb46d3SDavid Majnemer uint64_t TypeByteSize) { 1151751004a6SHao Liu assert(Stride > 1 && "The stride must be greater than 1"); 1152751004a6SHao Liu assert(TypeByteSize > 0 && "The type size in byte must be non-zero"); 1153751004a6SHao Liu assert(Distance > 0 && "The distance must be non-zero"); 1154751004a6SHao Liu 1155751004a6SHao Liu // Skip if the distance is not multiple of type byte size. 1156751004a6SHao Liu if (Distance % TypeByteSize) 1157751004a6SHao Liu return false; 1158751004a6SHao Liu 11597afb46d3SDavid Majnemer uint64_t ScaledDist = Distance / TypeByteSize; 1160751004a6SHao Liu 1161751004a6SHao Liu // No dependence if the scaled distance is not multiple of the stride. 1162751004a6SHao Liu // E.g. 1163751004a6SHao Liu // for (i = 0; i < 1024 ; i += 4) 1164751004a6SHao Liu // A[i+2] = A[i] + 1; 1165751004a6SHao Liu // 1166751004a6SHao Liu // Two accesses in memory (scaled distance is 2, stride is 4): 1167751004a6SHao Liu // | A[0] | | | | A[4] | | | | 1168751004a6SHao Liu // | | | A[2] | | | | A[6] | | 1169751004a6SHao Liu // 1170751004a6SHao Liu // E.g. 1171751004a6SHao Liu // for (i = 0; i < 1024 ; i += 3) 1172751004a6SHao Liu // A[i+4] = A[i] + 1; 1173751004a6SHao Liu // 1174751004a6SHao Liu // Two accesses in memory (scaled distance is 4, stride is 3): 1175751004a6SHao Liu // | A[0] | | | A[3] | | | A[6] | | | 1176751004a6SHao Liu // | | | | | A[4] | | | A[7] | | 1177751004a6SHao Liu return ScaledDist % Stride; 1178751004a6SHao Liu } 1179751004a6SHao Liu 11809c926579SAdam Nemet MemoryDepChecker::Dependence::DepType 11819c926579SAdam Nemet MemoryDepChecker::isDependent(const MemAccessInfo &A, unsigned AIdx, 11820456327cSAdam Nemet const MemAccessInfo &B, unsigned BIdx, 11838bc61df9SAdam Nemet const ValueToValueMap &Strides) { 11840456327cSAdam Nemet assert (AIdx < BIdx && "Must pass arguments in program order"); 11850456327cSAdam Nemet 11860456327cSAdam Nemet Value *APtr = A.getPointer(); 11870456327cSAdam Nemet Value *BPtr = B.getPointer(); 11880456327cSAdam Nemet bool AIsWrite = A.getInt(); 11890456327cSAdam Nemet bool BIsWrite = B.getInt(); 11900456327cSAdam Nemet 11910456327cSAdam Nemet // Two reads are independent. 11920456327cSAdam Nemet if (!AIsWrite && !BIsWrite) 11939c926579SAdam Nemet return Dependence::NoDep; 11940456327cSAdam Nemet 11950456327cSAdam Nemet // We cannot check pointers in different address spaces. 11960456327cSAdam Nemet if (APtr->getType()->getPointerAddressSpace() != 11970456327cSAdam Nemet BPtr->getType()->getPointerAddressSpace()) 11989c926579SAdam Nemet return Dependence::Unknown; 11990456327cSAdam Nemet 12007afb46d3SDavid Majnemer int64_t StrideAPtr = getPtrStride(PSE, APtr, InnermostLoop, Strides, true); 12017afb46d3SDavid Majnemer int64_t StrideBPtr = getPtrStride(PSE, BPtr, InnermostLoop, Strides, true); 12020456327cSAdam Nemet 1203adf4b739SSilviu Baranga const SCEV *Src = PSE.getSCEV(APtr); 1204adf4b739SSilviu Baranga const SCEV *Sink = PSE.getSCEV(BPtr); 12050456327cSAdam Nemet 12060456327cSAdam Nemet // If the induction step is negative we have to invert source and sink of the 12070456327cSAdam Nemet // dependence. 12080456327cSAdam Nemet if (StrideAPtr < 0) { 12090456327cSAdam Nemet std::swap(APtr, BPtr); 12100456327cSAdam Nemet std::swap(Src, Sink); 12110456327cSAdam Nemet std::swap(AIsWrite, BIsWrite); 12120456327cSAdam Nemet std::swap(AIdx, BIdx); 12130456327cSAdam Nemet std::swap(StrideAPtr, StrideBPtr); 12140456327cSAdam Nemet } 12150456327cSAdam Nemet 12169cd9a7e3SSilviu Baranga const SCEV *Dist = PSE.getSE()->getMinusSCEV(Sink, Src); 12170456327cSAdam Nemet 1218339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Src Scev: " << *Src << "Sink Scev: " << *Sink 12190456327cSAdam Nemet << "(Induction step: " << StrideAPtr << ")\n"); 1220339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Distance for " << *InstMap[AIdx] << " to " 12210456327cSAdam Nemet << *InstMap[BIdx] << ": " << *Dist << "\n"); 12220456327cSAdam Nemet 1223943befedSAdam Nemet // Need accesses with constant stride. We don't want to vectorize 12240456327cSAdam Nemet // "A[B[i]] += ..." and similar code or pointer arithmetic that could wrap in 12250456327cSAdam Nemet // the address space. 12260456327cSAdam Nemet if (!StrideAPtr || !StrideBPtr || StrideAPtr != StrideBPtr){ 1227943befedSAdam Nemet DEBUG(dbgs() << "Pointer access with non-constant stride\n"); 12289c926579SAdam Nemet return Dependence::Unknown; 12290456327cSAdam Nemet } 12300456327cSAdam Nemet 12310456327cSAdam Nemet const SCEVConstant *C = dyn_cast<SCEVConstant>(Dist); 12320456327cSAdam Nemet if (!C) { 1233339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Dependence because of non-constant distance\n"); 12340456327cSAdam Nemet ShouldRetryWithRuntimeCheck = true; 12359c926579SAdam Nemet return Dependence::Unknown; 12360456327cSAdam Nemet } 12370456327cSAdam Nemet 12380456327cSAdam Nemet Type *ATy = APtr->getType()->getPointerElementType(); 12390456327cSAdam Nemet Type *BTy = BPtr->getType()->getPointerElementType(); 1240a28d91d8SMehdi Amini auto &DL = InnermostLoop->getHeader()->getModule()->getDataLayout(); 12417afb46d3SDavid Majnemer uint64_t TypeByteSize = DL.getTypeAllocSize(ATy); 12420456327cSAdam Nemet 12430de2feceSSanjoy Das const APInt &Val = C->getAPInt(); 12446feebe98SMatthew Simpson int64_t Distance = Val.getSExtValue(); 12457afb46d3SDavid Majnemer uint64_t Stride = std::abs(StrideAPtr); 12466feebe98SMatthew Simpson 12476feebe98SMatthew Simpson // Attempt to prove strided accesses independent. 12486feebe98SMatthew Simpson if (std::abs(Distance) > 0 && Stride > 1 && ATy == BTy && 12496feebe98SMatthew Simpson areStridedAccessesIndependent(std::abs(Distance), Stride, TypeByteSize)) { 12506feebe98SMatthew Simpson DEBUG(dbgs() << "LAA: Strided accesses are independent\n"); 12516feebe98SMatthew Simpson return Dependence::NoDep; 12526feebe98SMatthew Simpson } 12536feebe98SMatthew Simpson 12546feebe98SMatthew Simpson // Negative distances are not plausible dependencies. 12550456327cSAdam Nemet if (Val.isNegative()) { 12560456327cSAdam Nemet bool IsTrueDataDependence = (AIsWrite && !BIsWrite); 125737ec5f91SMatthew Simpson if (IsTrueDataDependence && EnableForwardingConflictDetection && 12580456327cSAdam Nemet (couldPreventStoreLoadForward(Val.abs().getZExtValue(), TypeByteSize) || 1259b8486e5aSAdam Nemet ATy != BTy)) { 1260b8486e5aSAdam Nemet DEBUG(dbgs() << "LAA: Forward but may prevent st->ld forwarding\n"); 12619c926579SAdam Nemet return Dependence::ForwardButPreventsForwarding; 1262b8486e5aSAdam Nemet } 12630456327cSAdam Nemet 1264724ab223SAdam Nemet DEBUG(dbgs() << "LAA: Dependence is negative\n"); 12659c926579SAdam Nemet return Dependence::Forward; 12660456327cSAdam Nemet } 12670456327cSAdam Nemet 12680456327cSAdam Nemet // Write to the same location with the same size. 12690456327cSAdam Nemet // Could be improved to assert type sizes are the same (i32 == float, etc). 12700456327cSAdam Nemet if (Val == 0) { 12710456327cSAdam Nemet if (ATy == BTy) 1272d7037c56SAdam Nemet return Dependence::Forward; 1273339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Zero dependence difference but different types\n"); 12749c926579SAdam Nemet return Dependence::Unknown; 12750456327cSAdam Nemet } 12760456327cSAdam Nemet 12770456327cSAdam Nemet assert(Val.isStrictlyPositive() && "Expect a positive value"); 12780456327cSAdam Nemet 12790456327cSAdam Nemet if (ATy != BTy) { 128004d4163eSAdam Nemet DEBUG(dbgs() << 1281339f42b3SAdam Nemet "LAA: ReadWrite-Write positive dependency with different types\n"); 12829c926579SAdam Nemet return Dependence::Unknown; 12830456327cSAdam Nemet } 12840456327cSAdam Nemet 12850456327cSAdam Nemet // Bail out early if passed-in parameters make vectorization not feasible. 1286f219c647SAdam Nemet unsigned ForcedFactor = (VectorizerParams::VectorizationFactor ? 1287f219c647SAdam Nemet VectorizerParams::VectorizationFactor : 1); 1288f219c647SAdam Nemet unsigned ForcedUnroll = (VectorizerParams::VectorizationInterleave ? 1289f219c647SAdam Nemet VectorizerParams::VectorizationInterleave : 1); 1290751004a6SHao Liu // The minimum number of iterations for a vectorized/unrolled version. 1291751004a6SHao Liu unsigned MinNumIter = std::max(ForcedFactor * ForcedUnroll, 2U); 12920456327cSAdam Nemet 1293751004a6SHao Liu // It's not vectorizable if the distance is smaller than the minimum distance 1294751004a6SHao Liu // needed for a vectroized/unrolled version. Vectorizing one iteration in 1295751004a6SHao Liu // front needs TypeByteSize * Stride. Vectorizing the last iteration needs 1296751004a6SHao Liu // TypeByteSize (No need to plus the last gap distance). 1297751004a6SHao Liu // 1298751004a6SHao Liu // E.g. Assume one char is 1 byte in memory and one int is 4 bytes. 1299751004a6SHao Liu // foo(int *A) { 1300751004a6SHao Liu // int *B = (int *)((char *)A + 14); 1301751004a6SHao Liu // for (i = 0 ; i < 1024 ; i += 2) 1302751004a6SHao Liu // B[i] = A[i] + 1; 1303751004a6SHao Liu // } 1304751004a6SHao Liu // 1305751004a6SHao Liu // Two accesses in memory (stride is 2): 1306751004a6SHao Liu // | A[0] | | A[2] | | A[4] | | A[6] | | 1307751004a6SHao Liu // | B[0] | | B[2] | | B[4] | 1308751004a6SHao Liu // 1309751004a6SHao Liu // Distance needs for vectorizing iterations except the last iteration: 1310751004a6SHao Liu // 4 * 2 * (MinNumIter - 1). Distance needs for the last iteration: 4. 1311751004a6SHao Liu // So the minimum distance needed is: 4 * 2 * (MinNumIter - 1) + 4. 1312751004a6SHao Liu // 1313751004a6SHao Liu // If MinNumIter is 2, it is vectorizable as the minimum distance needed is 1314751004a6SHao Liu // 12, which is less than distance. 1315751004a6SHao Liu // 1316751004a6SHao Liu // If MinNumIter is 4 (Say if a user forces the vectorization factor to be 4), 1317751004a6SHao Liu // the minimum distance needed is 28, which is greater than distance. It is 1318751004a6SHao Liu // not safe to do vectorization. 13197afb46d3SDavid Majnemer uint64_t MinDistanceNeeded = 1320751004a6SHao Liu TypeByteSize * Stride * (MinNumIter - 1) + TypeByteSize; 13217afb46d3SDavid Majnemer if (MinDistanceNeeded > static_cast<uint64_t>(Distance)) { 1322751004a6SHao Liu DEBUG(dbgs() << "LAA: Failure because of positive distance " << Distance 1323751004a6SHao Liu << '\n'); 1324751004a6SHao Liu return Dependence::Backward; 1325751004a6SHao Liu } 1326751004a6SHao Liu 1327751004a6SHao Liu // Unsafe if the minimum distance needed is greater than max safe distance. 1328751004a6SHao Liu if (MinDistanceNeeded > MaxSafeDepDistBytes) { 1329751004a6SHao Liu DEBUG(dbgs() << "LAA: Failure because it needs at least " 1330751004a6SHao Liu << MinDistanceNeeded << " size in bytes"); 13319c926579SAdam Nemet return Dependence::Backward; 13320456327cSAdam Nemet } 13330456327cSAdam Nemet 13349cc0c399SAdam Nemet // Positive distance bigger than max vectorization factor. 1335751004a6SHao Liu // FIXME: Should use max factor instead of max distance in bytes, which could 1336751004a6SHao Liu // not handle different types. 1337751004a6SHao Liu // E.g. Assume one char is 1 byte in memory and one int is 4 bytes. 1338751004a6SHao Liu // void foo (int *A, char *B) { 1339751004a6SHao Liu // for (unsigned i = 0; i < 1024; i++) { 1340751004a6SHao Liu // A[i+2] = A[i] + 1; 1341751004a6SHao Liu // B[i+2] = B[i] + 1; 1342751004a6SHao Liu // } 1343751004a6SHao Liu // } 1344751004a6SHao Liu // 1345751004a6SHao Liu // This case is currently unsafe according to the max safe distance. If we 1346751004a6SHao Liu // analyze the two accesses on array B, the max safe dependence distance 1347751004a6SHao Liu // is 2. Then we analyze the accesses on array A, the minimum distance needed 1348751004a6SHao Liu // is 8, which is less than 2 and forbidden vectorization, But actually 1349751004a6SHao Liu // both A and B could be vectorized by 2 iterations. 1350751004a6SHao Liu MaxSafeDepDistBytes = 13517afb46d3SDavid Majnemer std::min(static_cast<uint64_t>(Distance), MaxSafeDepDistBytes); 13520456327cSAdam Nemet 13530456327cSAdam Nemet bool IsTrueDataDependence = (!AIsWrite && BIsWrite); 135437ec5f91SMatthew Simpson if (IsTrueDataDependence && EnableForwardingConflictDetection && 13550456327cSAdam Nemet couldPreventStoreLoadForward(Distance, TypeByteSize)) 13569c926579SAdam Nemet return Dependence::BackwardVectorizableButPreventsForwarding; 13570456327cSAdam Nemet 1358751004a6SHao Liu DEBUG(dbgs() << "LAA: Positive distance " << Val.getSExtValue() 1359751004a6SHao Liu << " with max VF = " 1360751004a6SHao Liu << MaxSafeDepDistBytes / (TypeByteSize * Stride) << '\n'); 13610456327cSAdam Nemet 13629c926579SAdam Nemet return Dependence::BackwardVectorizable; 13630456327cSAdam Nemet } 13640456327cSAdam Nemet 1365dee666bcSAdam Nemet bool MemoryDepChecker::areDepsSafe(DepCandidates &AccessSets, 13660456327cSAdam Nemet MemAccessInfoSet &CheckDeps, 13678bc61df9SAdam Nemet const ValueToValueMap &Strides) { 13680456327cSAdam Nemet 13697afb46d3SDavid Majnemer MaxSafeDepDistBytes = -1; 13700456327cSAdam Nemet while (!CheckDeps.empty()) { 13710456327cSAdam Nemet MemAccessInfo CurAccess = *CheckDeps.begin(); 13720456327cSAdam Nemet 13730456327cSAdam Nemet // Get the relevant memory access set. 13740456327cSAdam Nemet EquivalenceClasses<MemAccessInfo>::iterator I = 13750456327cSAdam Nemet AccessSets.findValue(AccessSets.getLeaderValue(CurAccess)); 13760456327cSAdam Nemet 13770456327cSAdam Nemet // Check accesses within this set. 13787a083814SRichard Trieu EquivalenceClasses<MemAccessInfo>::member_iterator AI = 13797a083814SRichard Trieu AccessSets.member_begin(I); 13807a083814SRichard Trieu EquivalenceClasses<MemAccessInfo>::member_iterator AE = 13817a083814SRichard Trieu AccessSets.member_end(); 13820456327cSAdam Nemet 13830456327cSAdam Nemet // Check every access pair. 13840456327cSAdam Nemet while (AI != AE) { 13850456327cSAdam Nemet CheckDeps.erase(*AI); 13860456327cSAdam Nemet EquivalenceClasses<MemAccessInfo>::member_iterator OI = std::next(AI); 13870456327cSAdam Nemet while (OI != AE) { 13880456327cSAdam Nemet // Check every accessing instruction pair in program order. 13890456327cSAdam Nemet for (std::vector<unsigned>::iterator I1 = Accesses[*AI].begin(), 13900456327cSAdam Nemet I1E = Accesses[*AI].end(); I1 != I1E; ++I1) 13910456327cSAdam Nemet for (std::vector<unsigned>::iterator I2 = Accesses[*OI].begin(), 13920456327cSAdam Nemet I2E = Accesses[*OI].end(); I2 != I2E; ++I2) { 13939c926579SAdam Nemet auto A = std::make_pair(&*AI, *I1); 13949c926579SAdam Nemet auto B = std::make_pair(&*OI, *I2); 13959c926579SAdam Nemet 13969c926579SAdam Nemet assert(*I1 != *I2); 13979c926579SAdam Nemet if (*I1 > *I2) 13989c926579SAdam Nemet std::swap(A, B); 13999c926579SAdam Nemet 14009c926579SAdam Nemet Dependence::DepType Type = 14019c926579SAdam Nemet isDependent(*A.first, A.second, *B.first, B.second, Strides); 14029c926579SAdam Nemet SafeForVectorization &= Dependence::isSafeForVectorization(Type); 14039c926579SAdam Nemet 1404a2df750fSAdam Nemet // Gather dependences unless we accumulated MaxDependences 14059c926579SAdam Nemet // dependences. In that case return as soon as we find the first 14069c926579SAdam Nemet // unsafe dependence. This puts a limit on this quadratic 14079c926579SAdam Nemet // algorithm. 1408a2df750fSAdam Nemet if (RecordDependences) { 1409a2df750fSAdam Nemet if (Type != Dependence::NoDep) 1410a2df750fSAdam Nemet Dependences.push_back(Dependence(A.second, B.second, Type)); 14119c926579SAdam Nemet 1412a2df750fSAdam Nemet if (Dependences.size() >= MaxDependences) { 1413a2df750fSAdam Nemet RecordDependences = false; 1414a2df750fSAdam Nemet Dependences.clear(); 14159c926579SAdam Nemet DEBUG(dbgs() << "Too many dependences, stopped recording\n"); 14169c926579SAdam Nemet } 14179c926579SAdam Nemet } 1418a2df750fSAdam Nemet if (!RecordDependences && !SafeForVectorization) 14190456327cSAdam Nemet return false; 14200456327cSAdam Nemet } 14210456327cSAdam Nemet ++OI; 14220456327cSAdam Nemet } 14230456327cSAdam Nemet AI++; 14240456327cSAdam Nemet } 14250456327cSAdam Nemet } 14269c926579SAdam Nemet 1427a2df750fSAdam Nemet DEBUG(dbgs() << "Total Dependences: " << Dependences.size() << "\n"); 14289c926579SAdam Nemet return SafeForVectorization; 14290456327cSAdam Nemet } 14300456327cSAdam Nemet 1431ec1e2bb6SAdam Nemet SmallVector<Instruction *, 4> 1432ec1e2bb6SAdam Nemet MemoryDepChecker::getInstructionsForAccess(Value *Ptr, bool isWrite) const { 1433ec1e2bb6SAdam Nemet MemAccessInfo Access(Ptr, isWrite); 1434ec1e2bb6SAdam Nemet auto &IndexVector = Accesses.find(Access)->second; 1435ec1e2bb6SAdam Nemet 1436ec1e2bb6SAdam Nemet SmallVector<Instruction *, 4> Insts; 1437ec1e2bb6SAdam Nemet std::transform(IndexVector.begin(), IndexVector.end(), 1438ec1e2bb6SAdam Nemet std::back_inserter(Insts), 1439ec1e2bb6SAdam Nemet [&](unsigned Idx) { return this->InstMap[Idx]; }); 1440ec1e2bb6SAdam Nemet return Insts; 1441ec1e2bb6SAdam Nemet } 1442ec1e2bb6SAdam Nemet 144358913d65SAdam Nemet const char *MemoryDepChecker::Dependence::DepName[] = { 144458913d65SAdam Nemet "NoDep", "Unknown", "Forward", "ForwardButPreventsForwarding", "Backward", 144558913d65SAdam Nemet "BackwardVectorizable", "BackwardVectorizableButPreventsForwarding"}; 144658913d65SAdam Nemet 144758913d65SAdam Nemet void MemoryDepChecker::Dependence::print( 144858913d65SAdam Nemet raw_ostream &OS, unsigned Depth, 144958913d65SAdam Nemet const SmallVectorImpl<Instruction *> &Instrs) const { 145058913d65SAdam Nemet OS.indent(Depth) << DepName[Type] << ":\n"; 145158913d65SAdam Nemet OS.indent(Depth + 2) << *Instrs[Source] << " -> \n"; 145258913d65SAdam Nemet OS.indent(Depth + 2) << *Instrs[Destination] << "\n"; 145358913d65SAdam Nemet } 145458913d65SAdam Nemet 1455929c38e8SAdam Nemet bool LoopAccessInfo::canAnalyzeLoop() { 14568dcb3b6aSAdam Nemet // We need to have a loop header. 1457d8968f09SAdam Nemet DEBUG(dbgs() << "LAA: Found a loop in " 1458d8968f09SAdam Nemet << TheLoop->getHeader()->getParent()->getName() << ": " 1459d8968f09SAdam Nemet << TheLoop->getHeader()->getName() << '\n'); 14608dcb3b6aSAdam Nemet 1461929c38e8SAdam Nemet // We can only analyze innermost loops. 1462929c38e8SAdam Nemet if (!TheLoop->empty()) { 14638dcb3b6aSAdam Nemet DEBUG(dbgs() << "LAA: loop is not the innermost loop\n"); 14642bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() << "loop is not the innermost loop"); 1465929c38e8SAdam Nemet return false; 1466929c38e8SAdam Nemet } 1467929c38e8SAdam Nemet 1468929c38e8SAdam Nemet // We must have a single backedge. 1469929c38e8SAdam Nemet if (TheLoop->getNumBackEdges() != 1) { 14708dcb3b6aSAdam Nemet DEBUG(dbgs() << "LAA: loop control flow is not understood by analyzer\n"); 1471929c38e8SAdam Nemet emitAnalysis( 14722bd6e984SAdam Nemet LoopAccessReport() << 1473929c38e8SAdam Nemet "loop control flow is not understood by analyzer"); 1474929c38e8SAdam Nemet return false; 1475929c38e8SAdam Nemet } 1476929c38e8SAdam Nemet 1477929c38e8SAdam Nemet // We must have a single exiting block. 1478929c38e8SAdam Nemet if (!TheLoop->getExitingBlock()) { 14798dcb3b6aSAdam Nemet DEBUG(dbgs() << "LAA: loop control flow is not understood by analyzer\n"); 1480929c38e8SAdam Nemet emitAnalysis( 14812bd6e984SAdam Nemet LoopAccessReport() << 1482929c38e8SAdam Nemet "loop control flow is not understood by analyzer"); 1483929c38e8SAdam Nemet return false; 1484929c38e8SAdam Nemet } 1485929c38e8SAdam Nemet 1486929c38e8SAdam Nemet // We only handle bottom-tested loops, i.e. loop in which the condition is 1487929c38e8SAdam Nemet // checked at the end of each iteration. With that we can assume that all 1488929c38e8SAdam Nemet // instructions in the loop are executed the same number of times. 1489929c38e8SAdam Nemet if (TheLoop->getExitingBlock() != TheLoop->getLoopLatch()) { 14908dcb3b6aSAdam Nemet DEBUG(dbgs() << "LAA: loop control flow is not understood by analyzer\n"); 1491929c38e8SAdam Nemet emitAnalysis( 14922bd6e984SAdam Nemet LoopAccessReport() << 1493929c38e8SAdam Nemet "loop control flow is not understood by analyzer"); 1494929c38e8SAdam Nemet return false; 1495929c38e8SAdam Nemet } 1496929c38e8SAdam Nemet 1497929c38e8SAdam Nemet // ScalarEvolution needs to be able to find the exit count. 149894734eefSXinliang David Li const SCEV *ExitCount = PSE->getBackedgeTakenCount(); 149994734eefSXinliang David Li if (ExitCount == PSE->getSE()->getCouldNotCompute()) { 15009cd9a7e3SSilviu Baranga emitAnalysis(LoopAccessReport() 15019cd9a7e3SSilviu Baranga << "could not determine number of loop iterations"); 1502929c38e8SAdam Nemet DEBUG(dbgs() << "LAA: SCEV could not compute the loop exit count.\n"); 1503929c38e8SAdam Nemet return false; 1504929c38e8SAdam Nemet } 1505929c38e8SAdam Nemet 1506929c38e8SAdam Nemet return true; 1507929c38e8SAdam Nemet } 1508929c38e8SAdam Nemet 1509b49d9a56SAdam Nemet void LoopAccessInfo::analyzeLoop(AliasAnalysis *AA, LoopInfo *LI, 15107da74abfSAdam Nemet const TargetLibraryInfo *TLI, 15117da74abfSAdam Nemet DominatorTree *DT) { 15120456327cSAdam Nemet typedef SmallPtrSet<Value*, 16> ValueSet; 15130456327cSAdam Nemet 1514e3e3b994SMatthew Simpson // Holds the Load and Store instructions. 1515e3e3b994SMatthew Simpson SmallVector<LoadInst *, 16> Loads; 1516e3e3b994SMatthew Simpson SmallVector<StoreInst *, 16> Stores; 15170456327cSAdam Nemet 15180456327cSAdam Nemet // Holds all the different accesses in the loop. 15190456327cSAdam Nemet unsigned NumReads = 0; 15200456327cSAdam Nemet unsigned NumReadWrites = 0; 15210456327cSAdam Nemet 1522ce030acbSXinliang David Li PtrRtChecking->Pointers.clear(); 1523ce030acbSXinliang David Li PtrRtChecking->Need = false; 15240456327cSAdam Nemet 15250456327cSAdam Nemet const bool IsAnnotatedParallel = TheLoop->isAnnotatedParallel(); 15260456327cSAdam Nemet 15270456327cSAdam Nemet // For each block. 15288b401013SDavid Majnemer for (BasicBlock *BB : TheLoop->blocks()) { 15290456327cSAdam Nemet // Scan the BB and collect legal loads and stores. 15308b401013SDavid Majnemer for (Instruction &I : *BB) { 15310456327cSAdam Nemet // If this is a load, save it. If this instruction can read from memory 15320456327cSAdam Nemet // but is not a load, then we quit. Notice that we don't handle function 15330456327cSAdam Nemet // calls that read or write. 15348b401013SDavid Majnemer if (I.mayReadFromMemory()) { 15350456327cSAdam Nemet // Many math library functions read the rounding mode. We will only 15360456327cSAdam Nemet // vectorize a loop if it contains known function calls that don't set 15370456327cSAdam Nemet // the flag. Therefore, it is safe to ignore this read from memory. 15388b401013SDavid Majnemer auto *Call = dyn_cast<CallInst>(&I); 1539b4b27230SDavid Majnemer if (Call && getVectorIntrinsicIDForCall(Call, TLI)) 15400456327cSAdam Nemet continue; 15410456327cSAdam Nemet 15429b3cf604SMichael Zolotukhin // If the function has an explicit vectorized counterpart, we can safely 15439b3cf604SMichael Zolotukhin // assume that it can be vectorized. 15449b3cf604SMichael Zolotukhin if (Call && !Call->isNoBuiltin() && Call->getCalledFunction() && 15459b3cf604SMichael Zolotukhin TLI->isFunctionVectorizable(Call->getCalledFunction()->getName())) 15469b3cf604SMichael Zolotukhin continue; 15479b3cf604SMichael Zolotukhin 15488b401013SDavid Majnemer auto *Ld = dyn_cast<LoadInst>(&I); 15490456327cSAdam Nemet if (!Ld || (!Ld->isSimple() && !IsAnnotatedParallel)) { 15502bd6e984SAdam Nemet emitAnalysis(LoopAccessReport(Ld) 15510456327cSAdam Nemet << "read with atomic ordering or volatile read"); 1552339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a non-simple load.\n"); 1553436018c3SAdam Nemet CanVecMem = false; 1554436018c3SAdam Nemet return; 15550456327cSAdam Nemet } 15560456327cSAdam Nemet NumLoads++; 15570456327cSAdam Nemet Loads.push_back(Ld); 1558ce030acbSXinliang David Li DepChecker->addAccess(Ld); 1559a9f09c62SAdam Nemet if (EnableMemAccessVersioning) 1560c953bb99SAdam Nemet collectStridedAccess(Ld); 15610456327cSAdam Nemet continue; 15620456327cSAdam Nemet } 15630456327cSAdam Nemet 15640456327cSAdam Nemet // Save 'store' instructions. Abort if other instructions write to memory. 15658b401013SDavid Majnemer if (I.mayWriteToMemory()) { 15668b401013SDavid Majnemer auto *St = dyn_cast<StoreInst>(&I); 15670456327cSAdam Nemet if (!St) { 15688b401013SDavid Majnemer emitAnalysis(LoopAccessReport(St) 15698b401013SDavid Majnemer << "instruction cannot be vectorized"); 1570436018c3SAdam Nemet CanVecMem = false; 1571436018c3SAdam Nemet return; 15720456327cSAdam Nemet } 15730456327cSAdam Nemet if (!St->isSimple() && !IsAnnotatedParallel) { 15742bd6e984SAdam Nemet emitAnalysis(LoopAccessReport(St) 15750456327cSAdam Nemet << "write with atomic ordering or volatile write"); 1576339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a non-simple store.\n"); 1577436018c3SAdam Nemet CanVecMem = false; 1578436018c3SAdam Nemet return; 15790456327cSAdam Nemet } 15800456327cSAdam Nemet NumStores++; 15810456327cSAdam Nemet Stores.push_back(St); 1582ce030acbSXinliang David Li DepChecker->addAccess(St); 1583a9f09c62SAdam Nemet if (EnableMemAccessVersioning) 1584c953bb99SAdam Nemet collectStridedAccess(St); 15850456327cSAdam Nemet } 15860456327cSAdam Nemet } // Next instr. 15870456327cSAdam Nemet } // Next block. 15880456327cSAdam Nemet 15890456327cSAdam Nemet // Now we have two lists that hold the loads and the stores. 15900456327cSAdam Nemet // Next, we find the pointers that they use. 15910456327cSAdam Nemet 15920456327cSAdam Nemet // Check if we see any stores. If there are no stores, then we don't 15930456327cSAdam Nemet // care if the pointers are *restrict*. 15940456327cSAdam Nemet if (!Stores.size()) { 1595339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a read-only loop!\n"); 1596436018c3SAdam Nemet CanVecMem = true; 1597436018c3SAdam Nemet return; 15980456327cSAdam Nemet } 15990456327cSAdam Nemet 1600dee666bcSAdam Nemet MemoryDepChecker::DepCandidates DependentAccesses; 1601a28d91d8SMehdi Amini AccessAnalysis Accesses(TheLoop->getHeader()->getModule()->getDataLayout(), 160294734eefSXinliang David Li AA, LI, DependentAccesses, *PSE); 16030456327cSAdam Nemet 16040456327cSAdam Nemet // Holds the analyzed pointers. We don't want to call GetUnderlyingObjects 16050456327cSAdam Nemet // multiple times on the same object. If the ptr is accessed twice, once 16060456327cSAdam Nemet // for read and once for write, it will only appear once (on the write 16070456327cSAdam Nemet // list). This is okay, since we are going to check for conflicts between 16080456327cSAdam Nemet // writes and between reads and writes, but not between reads and reads. 16090456327cSAdam Nemet ValueSet Seen; 16100456327cSAdam Nemet 1611e3e3b994SMatthew Simpson for (StoreInst *ST : Stores) { 16120456327cSAdam Nemet Value *Ptr = ST->getPointerOperand(); 1613ce48250fSAdam Nemet // Check for store to loop invariant address. 1614ce48250fSAdam Nemet StoreToLoopInvariantAddress |= isUniform(Ptr); 16150456327cSAdam Nemet // If we did *not* see this pointer before, insert it to the read-write 16160456327cSAdam Nemet // list. At this phase it is only a 'write' list. 16170456327cSAdam Nemet if (Seen.insert(Ptr).second) { 16180456327cSAdam Nemet ++NumReadWrites; 16190456327cSAdam Nemet 1620ac80dc75SChandler Carruth MemoryLocation Loc = MemoryLocation::get(ST); 16210456327cSAdam Nemet // The TBAA metadata could have a control dependency on the predication 16220456327cSAdam Nemet // condition, so we cannot rely on it when determining whether or not we 16230456327cSAdam Nemet // need runtime pointer checks. 162401abb2c3SAdam Nemet if (blockNeedsPredication(ST->getParent(), TheLoop, DT)) 16250456327cSAdam Nemet Loc.AATags.TBAA = nullptr; 16260456327cSAdam Nemet 16270456327cSAdam Nemet Accesses.addStore(Loc); 16280456327cSAdam Nemet } 16290456327cSAdam Nemet } 16300456327cSAdam Nemet 16310456327cSAdam Nemet if (IsAnnotatedParallel) { 163204d4163eSAdam Nemet DEBUG(dbgs() 1633339f42b3SAdam Nemet << "LAA: A loop annotated parallel, ignore memory dependency " 16340456327cSAdam Nemet << "checks.\n"); 1635436018c3SAdam Nemet CanVecMem = true; 1636436018c3SAdam Nemet return; 16370456327cSAdam Nemet } 16380456327cSAdam Nemet 1639e3e3b994SMatthew Simpson for (LoadInst *LD : Loads) { 16400456327cSAdam Nemet Value *Ptr = LD->getPointerOperand(); 16410456327cSAdam Nemet // If we did *not* see this pointer before, insert it to the 16420456327cSAdam Nemet // read list. If we *did* see it before, then it is already in 16430456327cSAdam Nemet // the read-write list. This allows us to vectorize expressions 16440456327cSAdam Nemet // such as A[i] += x; Because the address of A[i] is a read-write 16450456327cSAdam Nemet // pointer. This only works if the index of A[i] is consecutive. 16460456327cSAdam Nemet // If the address of i is unknown (for example A[B[i]]) then we may 16470456327cSAdam Nemet // read a few words, modify, and write a few words, and some of the 16480456327cSAdam Nemet // words may be written to the same address. 16490456327cSAdam Nemet bool IsReadOnlyPtr = false; 1650139ffba3SAdam Nemet if (Seen.insert(Ptr).second || 165194734eefSXinliang David Li !getPtrStride(*PSE, Ptr, TheLoop, SymbolicStrides)) { 16520456327cSAdam Nemet ++NumReads; 16530456327cSAdam Nemet IsReadOnlyPtr = true; 16540456327cSAdam Nemet } 16550456327cSAdam Nemet 1656ac80dc75SChandler Carruth MemoryLocation Loc = MemoryLocation::get(LD); 16570456327cSAdam Nemet // The TBAA metadata could have a control dependency on the predication 16580456327cSAdam Nemet // condition, so we cannot rely on it when determining whether or not we 16590456327cSAdam Nemet // need runtime pointer checks. 166001abb2c3SAdam Nemet if (blockNeedsPredication(LD->getParent(), TheLoop, DT)) 16610456327cSAdam Nemet Loc.AATags.TBAA = nullptr; 16620456327cSAdam Nemet 16630456327cSAdam Nemet Accesses.addLoad(Loc, IsReadOnlyPtr); 16640456327cSAdam Nemet } 16650456327cSAdam Nemet 16660456327cSAdam Nemet // If we write (or read-write) to a single destination and there are no 16670456327cSAdam Nemet // other reads in this loop then is it safe to vectorize. 16680456327cSAdam Nemet if (NumReadWrites == 1 && NumReads == 0) { 1669339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a write-only loop!\n"); 1670436018c3SAdam Nemet CanVecMem = true; 1671436018c3SAdam Nemet return; 16720456327cSAdam Nemet } 16730456327cSAdam Nemet 16740456327cSAdam Nemet // Build dependence sets and check whether we need a runtime pointer bounds 16750456327cSAdam Nemet // check. 16760456327cSAdam Nemet Accesses.buildDependenceSets(); 16770456327cSAdam Nemet 16780456327cSAdam Nemet // Find pointers with computable bounds. We are going to use this information 16790456327cSAdam Nemet // to place a runtime bound check. 168094734eefSXinliang David Li bool CanDoRTIfNeeded = Accesses.canCheckPtrAtRT(*PtrRtChecking, PSE->getSE(), 1681139ffba3SAdam Nemet TheLoop, SymbolicStrides); 1682ee61474aSAdam Nemet if (!CanDoRTIfNeeded) { 16832bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() << "cannot identify array bounds"); 1684ee61474aSAdam Nemet DEBUG(dbgs() << "LAA: We can't vectorize because we can't find " 1685ee61474aSAdam Nemet << "the array bounds.\n"); 1686436018c3SAdam Nemet CanVecMem = false; 1687436018c3SAdam Nemet return; 16880456327cSAdam Nemet } 16890456327cSAdam Nemet 1690ee61474aSAdam Nemet DEBUG(dbgs() << "LAA: We can perform a memory runtime check if needed.\n"); 16910456327cSAdam Nemet 1692436018c3SAdam Nemet CanVecMem = true; 16930456327cSAdam Nemet if (Accesses.isDependencyCheckNeeded()) { 1694339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Checking memory dependencies\n"); 1695ce030acbSXinliang David Li CanVecMem = DepChecker->areDepsSafe( 1696139ffba3SAdam Nemet DependentAccesses, Accesses.getDependenciesToCheck(), SymbolicStrides); 1697ce030acbSXinliang David Li MaxSafeDepDistBytes = DepChecker->getMaxSafeDepDistBytes(); 16980456327cSAdam Nemet 1699ce030acbSXinliang David Li if (!CanVecMem && DepChecker->shouldRetryWithRuntimeCheck()) { 1700339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Retrying with memory checks\n"); 17010456327cSAdam Nemet 17020456327cSAdam Nemet // Clear the dependency checks. We assume they are not needed. 1703ce030acbSXinliang David Li Accesses.resetDepChecks(*DepChecker); 17040456327cSAdam Nemet 1705ce030acbSXinliang David Li PtrRtChecking->reset(); 1706ce030acbSXinliang David Li PtrRtChecking->Need = true; 17070456327cSAdam Nemet 170894734eefSXinliang David Li auto *SE = PSE->getSE(); 1709ce030acbSXinliang David Li CanDoRTIfNeeded = Accesses.canCheckPtrAtRT(*PtrRtChecking, SE, TheLoop, 1710139ffba3SAdam Nemet SymbolicStrides, true); 171198a13719SSilviu Baranga 1712949e91a6SAdam Nemet // Check that we found the bounds for the pointer. 1713ee61474aSAdam Nemet if (!CanDoRTIfNeeded) { 17142bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() 17150456327cSAdam Nemet << "cannot check memory dependencies at runtime"); 1716b6dc76ffSAdam Nemet DEBUG(dbgs() << "LAA: Can't vectorize with memory checks\n"); 1717b6dc76ffSAdam Nemet CanVecMem = false; 1718b6dc76ffSAdam Nemet return; 1719b6dc76ffSAdam Nemet } 1720b6dc76ffSAdam Nemet 17210456327cSAdam Nemet CanVecMem = true; 17220456327cSAdam Nemet } 17230456327cSAdam Nemet } 17240456327cSAdam Nemet 17254bb90a71SAdam Nemet if (CanVecMem) 17264bb90a71SAdam Nemet DEBUG(dbgs() << "LAA: No unsafe dependent memory operations in loop. We" 1727ce030acbSXinliang David Li << (PtrRtChecking->Need ? "" : " don't") 17280f67c6c1SAdam Nemet << " need runtime memory checks.\n"); 17294bb90a71SAdam Nemet else { 17300a77dfadSAdam Nemet emitAnalysis( 17310a77dfadSAdam Nemet LoopAccessReport() 17320a77dfadSAdam Nemet << "unsafe dependent memory operations in loop. Use " 17330a77dfadSAdam Nemet "#pragma loop distribute(enable) to allow loop distribution " 17340a77dfadSAdam Nemet "to attempt to isolate the offending operations into a separate " 17350a77dfadSAdam Nemet "loop"); 17364bb90a71SAdam Nemet DEBUG(dbgs() << "LAA: unsafe dependent memory operations in loop\n"); 17374bb90a71SAdam Nemet } 17380456327cSAdam Nemet } 17390456327cSAdam Nemet 174001abb2c3SAdam Nemet bool LoopAccessInfo::blockNeedsPredication(BasicBlock *BB, Loop *TheLoop, 174101abb2c3SAdam Nemet DominatorTree *DT) { 17420456327cSAdam Nemet assert(TheLoop->contains(BB) && "Unknown block used"); 17430456327cSAdam Nemet 17440456327cSAdam Nemet // Blocks that do not dominate the latch need predication. 17450456327cSAdam Nemet BasicBlock* Latch = TheLoop->getLoopLatch(); 17460456327cSAdam Nemet return !DT->dominates(BB, Latch); 17470456327cSAdam Nemet } 17480456327cSAdam Nemet 17492bd6e984SAdam Nemet void LoopAccessInfo::emitAnalysis(LoopAccessReport &Message) { 1750c922853bSAdam Nemet assert(!Report && "Multiple reports generated"); 1751c922853bSAdam Nemet Report = Message; 17520456327cSAdam Nemet } 17530456327cSAdam Nemet 175457ac766eSAdam Nemet bool LoopAccessInfo::isUniform(Value *V) const { 1755*3ceac2bbSMichael Kuperstein auto *SE = PSE->getSE(); 1756*3ceac2bbSMichael Kuperstein // Since we rely on SCEV for uniformity, if the type is not SCEVable, it is 1757*3ceac2bbSMichael Kuperstein // never considered uniform. 1758*3ceac2bbSMichael Kuperstein // TODO: Is this really what we want? Even without FP SCEV, we may want some 1759*3ceac2bbSMichael Kuperstein // trivially loop-invariant FP values to be considered uniform. 1760*3ceac2bbSMichael Kuperstein if (!SE->isSCEVable(V->getType())) 1761*3ceac2bbSMichael Kuperstein return false; 1762*3ceac2bbSMichael Kuperstein return (SE->isLoopInvariant(SE->getSCEV(V), TheLoop)); 17630456327cSAdam Nemet } 17647206d7a5SAdam Nemet 17657206d7a5SAdam Nemet // FIXME: this function is currently a duplicate of the one in 17667206d7a5SAdam Nemet // LoopVectorize.cpp. 17677206d7a5SAdam Nemet static Instruction *getFirstInst(Instruction *FirstInst, Value *V, 17687206d7a5SAdam Nemet Instruction *Loc) { 17697206d7a5SAdam Nemet if (FirstInst) 17707206d7a5SAdam Nemet return FirstInst; 17717206d7a5SAdam Nemet if (Instruction *I = dyn_cast<Instruction>(V)) 17727206d7a5SAdam Nemet return I->getParent() == Loc->getParent() ? I : nullptr; 17737206d7a5SAdam Nemet return nullptr; 17747206d7a5SAdam Nemet } 17757206d7a5SAdam Nemet 1776039b1042SBenjamin Kramer namespace { 17774e533ef7SAdam Nemet /// \brief IR Values for the lower and upper bounds of a pointer evolution. We 17784e533ef7SAdam Nemet /// need to use value-handles because SCEV expansion can invalidate previously 17794e533ef7SAdam Nemet /// expanded values. Thus expansion of a pointer can invalidate the bounds for 17804e533ef7SAdam Nemet /// a previous one. 17811da7df37SAdam Nemet struct PointerBounds { 17824e533ef7SAdam Nemet TrackingVH<Value> Start; 17834e533ef7SAdam Nemet TrackingVH<Value> End; 17841da7df37SAdam Nemet }; 1785039b1042SBenjamin Kramer } // end anonymous namespace 17867206d7a5SAdam Nemet 17871da7df37SAdam Nemet /// \brief Expand code for the lower and upper bound of the pointer group \p CG 17881da7df37SAdam Nemet /// in \p TheLoop. \return the values for the bounds. 17891da7df37SAdam Nemet static PointerBounds 17901da7df37SAdam Nemet expandBounds(const RuntimePointerChecking::CheckingPtrGroup *CG, Loop *TheLoop, 17911da7df37SAdam Nemet Instruction *Loc, SCEVExpander &Exp, ScalarEvolution *SE, 17921da7df37SAdam Nemet const RuntimePointerChecking &PtrRtChecking) { 17931da7df37SAdam Nemet Value *Ptr = PtrRtChecking.Pointers[CG->Members[0]].PointerValue; 17947206d7a5SAdam Nemet const SCEV *Sc = SE->getSCEV(Ptr); 17957206d7a5SAdam Nemet 17967206d7a5SAdam Nemet if (SE->isLoopInvariant(Sc, TheLoop)) { 17971b6b50a9SSilviu Baranga DEBUG(dbgs() << "LAA: Adding RT check for a loop invariant ptr:" << *Ptr 17981b6b50a9SSilviu Baranga << "\n"); 17991da7df37SAdam Nemet return {Ptr, Ptr}; 18007206d7a5SAdam Nemet } else { 18017206d7a5SAdam Nemet unsigned AS = Ptr->getType()->getPointerAddressSpace(); 18021da7df37SAdam Nemet LLVMContext &Ctx = Loc->getContext(); 18037206d7a5SAdam Nemet 18047206d7a5SAdam Nemet // Use this type for pointer arithmetic. 18057206d7a5SAdam Nemet Type *PtrArithTy = Type::getInt8PtrTy(Ctx, AS); 18061b6b50a9SSilviu Baranga Value *Start = nullptr, *End = nullptr; 18077206d7a5SAdam Nemet 18081b6b50a9SSilviu Baranga DEBUG(dbgs() << "LAA: Adding RT check for range:\n"); 18091da7df37SAdam Nemet Start = Exp.expandCodeFor(CG->Low, PtrArithTy, Loc); 18101da7df37SAdam Nemet End = Exp.expandCodeFor(CG->High, PtrArithTy, Loc); 18111da7df37SAdam Nemet DEBUG(dbgs() << "Start: " << *CG->Low << " End: " << *CG->High << "\n"); 18121da7df37SAdam Nemet return {Start, End}; 18137206d7a5SAdam Nemet } 18147206d7a5SAdam Nemet } 18157206d7a5SAdam Nemet 18161da7df37SAdam Nemet /// \brief Turns a collection of checks into a collection of expanded upper and 18171da7df37SAdam Nemet /// lower bounds for both pointers in the check. 18181da7df37SAdam Nemet static SmallVector<std::pair<PointerBounds, PointerBounds>, 4> expandBounds( 18191da7df37SAdam Nemet const SmallVectorImpl<RuntimePointerChecking::PointerCheck> &PointerChecks, 18201da7df37SAdam Nemet Loop *L, Instruction *Loc, ScalarEvolution *SE, SCEVExpander &Exp, 18211da7df37SAdam Nemet const RuntimePointerChecking &PtrRtChecking) { 18221da7df37SAdam Nemet SmallVector<std::pair<PointerBounds, PointerBounds>, 4> ChecksWithBounds; 18231da7df37SAdam Nemet 18241da7df37SAdam Nemet // Here we're relying on the SCEV Expander's cache to only emit code for the 18251da7df37SAdam Nemet // same bounds once. 18261da7df37SAdam Nemet std::transform( 18271da7df37SAdam Nemet PointerChecks.begin(), PointerChecks.end(), 18281da7df37SAdam Nemet std::back_inserter(ChecksWithBounds), 18291da7df37SAdam Nemet [&](const RuntimePointerChecking::PointerCheck &Check) { 183094abbbd6SNAKAMURA Takumi PointerBounds 183194abbbd6SNAKAMURA Takumi First = expandBounds(Check.first, L, Loc, Exp, SE, PtrRtChecking), 183294abbbd6SNAKAMURA Takumi Second = expandBounds(Check.second, L, Loc, Exp, SE, PtrRtChecking); 183394abbbd6SNAKAMURA Takumi return std::make_pair(First, Second); 18341da7df37SAdam Nemet }); 18351da7df37SAdam Nemet 18361da7df37SAdam Nemet return ChecksWithBounds; 18371da7df37SAdam Nemet } 18381da7df37SAdam Nemet 18395b0a4795SAdam Nemet std::pair<Instruction *, Instruction *> LoopAccessInfo::addRuntimeChecks( 18401da7df37SAdam Nemet Instruction *Loc, 18411da7df37SAdam Nemet const SmallVectorImpl<RuntimePointerChecking::PointerCheck> &PointerChecks) 18421da7df37SAdam Nemet const { 18431824e411SAdam Nemet const DataLayout &DL = TheLoop->getHeader()->getModule()->getDataLayout(); 184494734eefSXinliang David Li auto *SE = PSE->getSE(); 18451824e411SAdam Nemet SCEVExpander Exp(*SE, DL, "induction"); 18461da7df37SAdam Nemet auto ExpandedChecks = 1847ce030acbSXinliang David Li expandBounds(PointerChecks, TheLoop, Loc, SE, Exp, *PtrRtChecking); 18481da7df37SAdam Nemet 18491da7df37SAdam Nemet LLVMContext &Ctx = Loc->getContext(); 18501da7df37SAdam Nemet Instruction *FirstInst = nullptr; 18517206d7a5SAdam Nemet IRBuilder<> ChkBuilder(Loc); 18527206d7a5SAdam Nemet // Our instructions might fold to a constant. 18537206d7a5SAdam Nemet Value *MemoryRuntimeCheck = nullptr; 18541b6b50a9SSilviu Baranga 18551da7df37SAdam Nemet for (const auto &Check : ExpandedChecks) { 18561da7df37SAdam Nemet const PointerBounds &A = Check.first, &B = Check.second; 1857cdb791cdSAdam Nemet // Check if two pointers (A and B) conflict where conflict is computed as: 1858cdb791cdSAdam Nemet // start(A) <= end(B) && start(B) <= end(A) 18591da7df37SAdam Nemet unsigned AS0 = A.Start->getType()->getPointerAddressSpace(); 18601da7df37SAdam Nemet unsigned AS1 = B.Start->getType()->getPointerAddressSpace(); 18617206d7a5SAdam Nemet 18621da7df37SAdam Nemet assert((AS0 == B.End->getType()->getPointerAddressSpace()) && 18631da7df37SAdam Nemet (AS1 == A.End->getType()->getPointerAddressSpace()) && 18647206d7a5SAdam Nemet "Trying to bounds check pointers with different address spaces"); 18657206d7a5SAdam Nemet 18667206d7a5SAdam Nemet Type *PtrArithTy0 = Type::getInt8PtrTy(Ctx, AS0); 18677206d7a5SAdam Nemet Type *PtrArithTy1 = Type::getInt8PtrTy(Ctx, AS1); 18687206d7a5SAdam Nemet 18691da7df37SAdam Nemet Value *Start0 = ChkBuilder.CreateBitCast(A.Start, PtrArithTy0, "bc"); 18701da7df37SAdam Nemet Value *Start1 = ChkBuilder.CreateBitCast(B.Start, PtrArithTy1, "bc"); 18711da7df37SAdam Nemet Value *End0 = ChkBuilder.CreateBitCast(A.End, PtrArithTy1, "bc"); 18721da7df37SAdam Nemet Value *End1 = ChkBuilder.CreateBitCast(B.End, PtrArithTy0, "bc"); 18737206d7a5SAdam Nemet 18747206d7a5SAdam Nemet Value *Cmp0 = ChkBuilder.CreateICmpULE(Start0, End1, "bound0"); 18757206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, Cmp0, Loc); 18767206d7a5SAdam Nemet Value *Cmp1 = ChkBuilder.CreateICmpULE(Start1, End0, "bound1"); 18777206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, Cmp1, Loc); 18787206d7a5SAdam Nemet Value *IsConflict = ChkBuilder.CreateAnd(Cmp0, Cmp1, "found.conflict"); 18797206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, IsConflict, Loc); 18807206d7a5SAdam Nemet if (MemoryRuntimeCheck) { 18811da7df37SAdam Nemet IsConflict = 18821da7df37SAdam Nemet ChkBuilder.CreateOr(MemoryRuntimeCheck, IsConflict, "conflict.rdx"); 18837206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, IsConflict, Loc); 18847206d7a5SAdam Nemet } 18857206d7a5SAdam Nemet MemoryRuntimeCheck = IsConflict; 18867206d7a5SAdam Nemet } 18877206d7a5SAdam Nemet 188890fec840SAdam Nemet if (!MemoryRuntimeCheck) 188990fec840SAdam Nemet return std::make_pair(nullptr, nullptr); 189090fec840SAdam Nemet 18917206d7a5SAdam Nemet // We have to do this trickery because the IRBuilder might fold the check to a 18927206d7a5SAdam Nemet // constant expression in which case there is no Instruction anchored in a 18937206d7a5SAdam Nemet // the block. 18947206d7a5SAdam Nemet Instruction *Check = BinaryOperator::CreateAnd(MemoryRuntimeCheck, 18957206d7a5SAdam Nemet ConstantInt::getTrue(Ctx)); 18967206d7a5SAdam Nemet ChkBuilder.Insert(Check, "memcheck.conflict"); 18977206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, Check, Loc); 18987206d7a5SAdam Nemet return std::make_pair(FirstInst, Check); 18997206d7a5SAdam Nemet } 19003bfd93d7SAdam Nemet 19015b0a4795SAdam Nemet std::pair<Instruction *, Instruction *> 19025b0a4795SAdam Nemet LoopAccessInfo::addRuntimeChecks(Instruction *Loc) const { 1903ce030acbSXinliang David Li if (!PtrRtChecking->Need) 19041da7df37SAdam Nemet return std::make_pair(nullptr, nullptr); 19051da7df37SAdam Nemet 1906ce030acbSXinliang David Li return addRuntimeChecks(Loc, PtrRtChecking->getChecks()); 19071da7df37SAdam Nemet } 19081da7df37SAdam Nemet 1909c953bb99SAdam Nemet void LoopAccessInfo::collectStridedAccess(Value *MemAccess) { 1910c953bb99SAdam Nemet Value *Ptr = nullptr; 1911c953bb99SAdam Nemet if (LoadInst *LI = dyn_cast<LoadInst>(MemAccess)) 1912c953bb99SAdam Nemet Ptr = LI->getPointerOperand(); 1913c953bb99SAdam Nemet else if (StoreInst *SI = dyn_cast<StoreInst>(MemAccess)) 1914c953bb99SAdam Nemet Ptr = SI->getPointerOperand(); 1915c953bb99SAdam Nemet else 1916c953bb99SAdam Nemet return; 1917c953bb99SAdam Nemet 191894734eefSXinliang David Li Value *Stride = getStrideFromPointer(Ptr, PSE->getSE(), TheLoop); 1919c953bb99SAdam Nemet if (!Stride) 1920c953bb99SAdam Nemet return; 1921c953bb99SAdam Nemet 1922c953bb99SAdam Nemet DEBUG(dbgs() << "LAA: Found a strided access that we can version"); 1923c953bb99SAdam Nemet DEBUG(dbgs() << " Ptr: " << *Ptr << " Stride: " << *Stride << "\n"); 1924c953bb99SAdam Nemet SymbolicStrides[Ptr] = Stride; 1925c953bb99SAdam Nemet StrideSet.insert(Stride); 1926c953bb99SAdam Nemet } 1927c953bb99SAdam Nemet 19283bfd93d7SAdam Nemet LoopAccessInfo::LoopAccessInfo(Loop *L, ScalarEvolution *SE, 19293bfd93d7SAdam Nemet const TargetLibraryInfo *TLI, AliasAnalysis *AA, 1930a9f09c62SAdam Nemet DominatorTree *DT, LoopInfo *LI) 193194734eefSXinliang David Li : PSE(llvm::make_unique<PredicatedScalarEvolution>(*SE, *L)), 1932ce030acbSXinliang David Li PtrRtChecking(llvm::make_unique<RuntimePointerChecking>(SE)), 193394734eefSXinliang David Li DepChecker(llvm::make_unique<MemoryDepChecker>(*PSE, L)), TheLoop(L), 19347da74abfSAdam Nemet NumLoads(0), NumStores(0), MaxSafeDepDistBytes(-1), CanVecMem(false), 19357da74abfSAdam Nemet StoreToLoopInvariantAddress(false) { 1936929c38e8SAdam Nemet if (canAnalyzeLoop()) 19377da74abfSAdam Nemet analyzeLoop(AA, LI, TLI, DT); 19383bfd93d7SAdam Nemet } 19393bfd93d7SAdam Nemet 1940e91cc6efSAdam Nemet void LoopAccessInfo::print(raw_ostream &OS, unsigned Depth) const { 1941e91cc6efSAdam Nemet if (CanVecMem) { 19424ad38b63SAdam Nemet OS.indent(Depth) << "Memory dependences are safe"; 19437afb46d3SDavid Majnemer if (MaxSafeDepDistBytes != -1ULL) 1944c62e554eSAdam Nemet OS << " with a maximum dependence distance of " << MaxSafeDepDistBytes 1945c62e554eSAdam Nemet << " bytes"; 1946ce030acbSXinliang David Li if (PtrRtChecking->Need) 19474ad38b63SAdam Nemet OS << " with run-time checks"; 19484ad38b63SAdam Nemet OS << "\n"; 1949e91cc6efSAdam Nemet } 1950e91cc6efSAdam Nemet 1951e91cc6efSAdam Nemet if (Report) 1952e91cc6efSAdam Nemet OS.indent(Depth) << "Report: " << Report->str() << "\n"; 1953e91cc6efSAdam Nemet 1954ce030acbSXinliang David Li if (auto *Dependences = DepChecker->getDependences()) { 1955a2df750fSAdam Nemet OS.indent(Depth) << "Dependences:\n"; 1956a2df750fSAdam Nemet for (auto &Dep : *Dependences) { 1957ce030acbSXinliang David Li Dep.print(OS, Depth + 2, DepChecker->getMemoryInstructions()); 195858913d65SAdam Nemet OS << "\n"; 195958913d65SAdam Nemet } 196058913d65SAdam Nemet } else 1961a2df750fSAdam Nemet OS.indent(Depth) << "Too many dependences, not recorded\n"; 1962e91cc6efSAdam Nemet 1963e91cc6efSAdam Nemet // List the pair of accesses need run-time checks to prove independence. 1964ce030acbSXinliang David Li PtrRtChecking->print(OS, Depth); 1965e91cc6efSAdam Nemet OS << "\n"; 1966c3384320SAdam Nemet 1967c3384320SAdam Nemet OS.indent(Depth) << "Store to invariant address was " 1968c3384320SAdam Nemet << (StoreToLoopInvariantAddress ? "" : "not ") 1969c3384320SAdam Nemet << "found in loop.\n"; 1970e3c0534bSSilviu Baranga 1971e3c0534bSSilviu Baranga OS.indent(Depth) << "SCEV assumptions:\n"; 197294734eefSXinliang David Li PSE->getUnionPredicate().print(OS, Depth); 1973b77365b5SSilviu Baranga 1974b77365b5SSilviu Baranga OS << "\n"; 1975b77365b5SSilviu Baranga 1976b77365b5SSilviu Baranga OS.indent(Depth) << "Expressions re-written:\n"; 197794734eefSXinliang David Li PSE->print(OS, Depth); 1978e91cc6efSAdam Nemet } 1979e91cc6efSAdam Nemet 19807853c1ddSXinliang David Li const LoopAccessInfo &LoopAccessLegacyAnalysis::getInfo(Loop *L) { 19813bfd93d7SAdam Nemet auto &LAI = LoopAccessInfoMap[L]; 19823bfd93d7SAdam Nemet 19831824e411SAdam Nemet if (!LAI) 19841824e411SAdam Nemet LAI = llvm::make_unique<LoopAccessInfo>(L, SE, TLI, AA, DT, LI); 19851824e411SAdam Nemet 19863bfd93d7SAdam Nemet return *LAI.get(); 19873bfd93d7SAdam Nemet } 19883bfd93d7SAdam Nemet 19897853c1ddSXinliang David Li void LoopAccessLegacyAnalysis::print(raw_ostream &OS, const Module *M) const { 19907853c1ddSXinliang David Li LoopAccessLegacyAnalysis &LAA = *const_cast<LoopAccessLegacyAnalysis *>(this); 1991ecde1c7fSXinliang David Li 1992e91cc6efSAdam Nemet for (Loop *TopLevelLoop : *LI) 1993e91cc6efSAdam Nemet for (Loop *L : depth_first(TopLevelLoop)) { 1994e91cc6efSAdam Nemet OS.indent(2) << L->getHeader()->getName() << ":\n"; 1995bdbc5227SAdam Nemet auto &LAI = LAA.getInfo(L); 1996e91cc6efSAdam Nemet LAI.print(OS, 4); 1997e91cc6efSAdam Nemet } 1998e91cc6efSAdam Nemet } 1999e91cc6efSAdam Nemet 20007853c1ddSXinliang David Li bool LoopAccessLegacyAnalysis::runOnFunction(Function &F) { 2001ecde1c7fSXinliang David Li SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE(); 20023bfd93d7SAdam Nemet auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>(); 2003ecde1c7fSXinliang David Li TLI = TLIP ? &TLIP->getTLI() : nullptr; 2004ecde1c7fSXinliang David Li AA = &getAnalysis<AAResultsWrapperPass>().getAAResults(); 2005ecde1c7fSXinliang David Li DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 2006ecde1c7fSXinliang David Li LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo(); 20073bfd93d7SAdam Nemet 20083bfd93d7SAdam Nemet return false; 20093bfd93d7SAdam Nemet } 20103bfd93d7SAdam Nemet 20117853c1ddSXinliang David Li void LoopAccessLegacyAnalysis::getAnalysisUsage(AnalysisUsage &AU) const { 20122f1fd165SChandler Carruth AU.addRequired<ScalarEvolutionWrapperPass>(); 20137b560d40SChandler Carruth AU.addRequired<AAResultsWrapperPass>(); 20143bfd93d7SAdam Nemet AU.addRequired<DominatorTreeWrapperPass>(); 2015e91cc6efSAdam Nemet AU.addRequired<LoopInfoWrapperPass>(); 20163bfd93d7SAdam Nemet 20173bfd93d7SAdam Nemet AU.setPreservesAll(); 20183bfd93d7SAdam Nemet } 20193bfd93d7SAdam Nemet 20207853c1ddSXinliang David Li char LoopAccessLegacyAnalysis::ID = 0; 20213bfd93d7SAdam Nemet static const char laa_name[] = "Loop Access Analysis"; 20223bfd93d7SAdam Nemet #define LAA_NAME "loop-accesses" 20233bfd93d7SAdam Nemet 20247853c1ddSXinliang David Li INITIALIZE_PASS_BEGIN(LoopAccessLegacyAnalysis, LAA_NAME, laa_name, false, true) 20257b560d40SChandler Carruth INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass) 20262f1fd165SChandler Carruth INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass) 20273bfd93d7SAdam Nemet INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 2028e91cc6efSAdam Nemet INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass) 20297853c1ddSXinliang David Li INITIALIZE_PASS_END(LoopAccessLegacyAnalysis, LAA_NAME, laa_name, false, true) 20303bfd93d7SAdam Nemet 203107e08fa3SXinliang David Li char LoopAccessAnalysis::PassID; 20328a021317SXinliang David Li 203307e08fa3SXinliang David Li LoopAccessInfo LoopAccessAnalysis::run(Loop &L, AnalysisManager<Loop> &AM) { 2034284b0324SSean Silva const AnalysisManager<Function> &FAM = 2035284b0324SSean Silva AM.getResult<FunctionAnalysisManagerLoopProxy>(L).getManager(); 20368a021317SXinliang David Li Function &F = *L.getHeader()->getParent(); 2037284b0324SSean Silva auto *SE = FAM.getCachedResult<ScalarEvolutionAnalysis>(F); 20388a021317SXinliang David Li auto *TLI = FAM.getCachedResult<TargetLibraryAnalysis>(F); 2039284b0324SSean Silva auto *AA = FAM.getCachedResult<AAManager>(F); 2040284b0324SSean Silva auto *DT = FAM.getCachedResult<DominatorTreeAnalysis>(F); 2041284b0324SSean Silva auto *LI = FAM.getCachedResult<LoopAnalysis>(F); 2042284b0324SSean Silva if (!SE) 2043284b0324SSean Silva report_fatal_error( 2044284b0324SSean Silva "ScalarEvolution must have been cached at a higher level"); 2045284b0324SSean Silva if (!AA) 2046284b0324SSean Silva report_fatal_error("AliasAnalysis must have been cached at a higher level"); 2047284b0324SSean Silva if (!DT) 2048284b0324SSean Silva report_fatal_error("DominatorTree must have been cached at a higher level"); 2049284b0324SSean Silva if (!LI) 2050284b0324SSean Silva report_fatal_error("LoopInfo must have been cached at a higher level"); 20511824e411SAdam Nemet return LoopAccessInfo(&L, SE, TLI, AA, DT, LI); 20528a021317SXinliang David Li } 20538a021317SXinliang David Li 20548a021317SXinliang David Li PreservedAnalyses LoopAccessInfoPrinterPass::run(Loop &L, 20558a021317SXinliang David Li AnalysisManager<Loop> &AM) { 20568a021317SXinliang David Li Function &F = *L.getHeader()->getParent(); 205707e08fa3SXinliang David Li auto &LAI = AM.getResult<LoopAccessAnalysis>(L); 20588a021317SXinliang David Li OS << "Loop access info in function '" << F.getName() << "':\n"; 20598a021317SXinliang David Li OS.indent(2) << L.getHeader()->getName() << ":\n"; 20608a021317SXinliang David Li LAI.print(OS, 4); 20618a021317SXinliang David Li return PreservedAnalyses::all(); 20628a021317SXinliang David Li } 20638a021317SXinliang David Li 20643bfd93d7SAdam Nemet namespace llvm { 20653bfd93d7SAdam Nemet Pass *createLAAPass() { 20667853c1ddSXinliang David Li return new LoopAccessLegacyAnalysis(); 20673bfd93d7SAdam Nemet } 20683bfd93d7SAdam Nemet } 2069