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" 177206d7a5SAdam Nemet #include "llvm/Analysis/ScalarEvolutionExpander.h" 180456327cSAdam Nemet #include "llvm/Analysis/ValueTracking.h" 190456327cSAdam Nemet #include "llvm/IR/DiagnosticInfo.h" 200456327cSAdam Nemet #include "llvm/IR/Dominators.h" 217206d7a5SAdam Nemet #include "llvm/IR/IRBuilder.h" 220456327cSAdam Nemet #include "llvm/Support/Debug.h" 230456327cSAdam Nemet #include "llvm/Transforms/Utils/VectorUtils.h" 240456327cSAdam Nemet using namespace llvm; 250456327cSAdam Nemet 26339f42b3SAdam Nemet #define DEBUG_TYPE "loop-accesses" 270456327cSAdam Nemet 28f219c647SAdam Nemet static cl::opt<unsigned, true> 29f219c647SAdam Nemet VectorizationFactor("force-vector-width", cl::Hidden, 30f219c647SAdam Nemet cl::desc("Sets the SIMD width. Zero is autoselect."), 31f219c647SAdam Nemet cl::location(VectorizerParams::VectorizationFactor)); 321d862af7SAdam Nemet unsigned VectorizerParams::VectorizationFactor; 33f219c647SAdam Nemet 34f219c647SAdam Nemet static cl::opt<unsigned, true> 35f219c647SAdam Nemet VectorizationInterleave("force-vector-interleave", cl::Hidden, 36f219c647SAdam Nemet cl::desc("Sets the vectorization interleave count. " 37f219c647SAdam Nemet "Zero is autoselect."), 38f219c647SAdam Nemet cl::location( 39f219c647SAdam Nemet VectorizerParams::VectorizationInterleave)); 401d862af7SAdam Nemet unsigned VectorizerParams::VectorizationInterleave; 41f219c647SAdam Nemet 421d862af7SAdam Nemet static cl::opt<unsigned, true> RuntimeMemoryCheckThreshold( 431d862af7SAdam Nemet "runtime-memory-check-threshold", cl::Hidden, 441d862af7SAdam Nemet cl::desc("When performing memory disambiguation checks at runtime do not " 451d862af7SAdam Nemet "generate more than this number of comparisons (default = 8)."), 461d862af7SAdam Nemet cl::location(VectorizerParams::RuntimeMemoryCheckThreshold), cl::init(8)); 471d862af7SAdam Nemet unsigned VectorizerParams::RuntimeMemoryCheckThreshold; 48f219c647SAdam Nemet 49f219c647SAdam Nemet /// Maximum SIMD width. 50f219c647SAdam Nemet const unsigned VectorizerParams::MaxVectorWidth = 64; 51f219c647SAdam Nemet 52f219c647SAdam Nemet bool VectorizerParams::isInterleaveForced() { 53f219c647SAdam Nemet return ::VectorizationInterleave.getNumOccurrences() > 0; 54f219c647SAdam Nemet } 55f219c647SAdam Nemet 562bd6e984SAdam Nemet void LoopAccessReport::emitAnalysis(const LoopAccessReport &Message, 570456327cSAdam Nemet const Function *TheFunction, 58339f42b3SAdam Nemet const Loop *TheLoop, 59339f42b3SAdam Nemet const char *PassName) { 600456327cSAdam Nemet DebugLoc DL = TheLoop->getStartLoc(); 613e87634fSAdam Nemet if (const Instruction *I = Message.getInstr()) 620456327cSAdam Nemet DL = I->getDebugLoc(); 63339f42b3SAdam Nemet emitOptimizationRemarkAnalysis(TheFunction->getContext(), PassName, 640456327cSAdam Nemet *TheFunction, DL, Message.str()); 650456327cSAdam Nemet } 660456327cSAdam Nemet 670456327cSAdam Nemet Value *llvm::stripIntegerCast(Value *V) { 680456327cSAdam Nemet if (CastInst *CI = dyn_cast<CastInst>(V)) 690456327cSAdam Nemet if (CI->getOperand(0)->getType()->isIntegerTy()) 700456327cSAdam Nemet return CI->getOperand(0); 710456327cSAdam Nemet return V; 720456327cSAdam Nemet } 730456327cSAdam Nemet 740456327cSAdam Nemet const SCEV *llvm::replaceSymbolicStrideSCEV(ScalarEvolution *SE, 758bc61df9SAdam Nemet const ValueToValueMap &PtrToStride, 760456327cSAdam Nemet Value *Ptr, Value *OrigPtr) { 770456327cSAdam Nemet 780456327cSAdam Nemet const SCEV *OrigSCEV = SE->getSCEV(Ptr); 790456327cSAdam Nemet 800456327cSAdam Nemet // If there is an entry in the map return the SCEV of the pointer with the 810456327cSAdam Nemet // symbolic stride replaced by one. 828bc61df9SAdam Nemet ValueToValueMap::const_iterator SI = 838bc61df9SAdam Nemet PtrToStride.find(OrigPtr ? OrigPtr : Ptr); 840456327cSAdam Nemet if (SI != PtrToStride.end()) { 850456327cSAdam Nemet Value *StrideVal = SI->second; 860456327cSAdam Nemet 870456327cSAdam Nemet // Strip casts. 880456327cSAdam Nemet StrideVal = stripIntegerCast(StrideVal); 890456327cSAdam Nemet 900456327cSAdam Nemet // Replace symbolic stride by one. 910456327cSAdam Nemet Value *One = ConstantInt::get(StrideVal->getType(), 1); 920456327cSAdam Nemet ValueToValueMap RewriteMap; 930456327cSAdam Nemet RewriteMap[StrideVal] = One; 940456327cSAdam Nemet 950456327cSAdam Nemet const SCEV *ByOne = 960456327cSAdam Nemet SCEVParameterRewriter::rewrite(OrigSCEV, *SE, RewriteMap, true); 97339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Replacing SCEV: " << *OrigSCEV << " by: " << *ByOne 980456327cSAdam Nemet << "\n"); 990456327cSAdam Nemet return ByOne; 1000456327cSAdam Nemet } 1010456327cSAdam Nemet 1020456327cSAdam Nemet // Otherwise, just return the SCEV of the original pointer. 1030456327cSAdam Nemet return SE->getSCEV(Ptr); 1040456327cSAdam Nemet } 1050456327cSAdam Nemet 1068bc61df9SAdam Nemet void LoopAccessInfo::RuntimePointerCheck::insert( 1078bc61df9SAdam Nemet ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr, unsigned DepSetId, 1088bc61df9SAdam Nemet unsigned ASId, const ValueToValueMap &Strides) { 1090456327cSAdam Nemet // Get the stride replaced scev. 1100456327cSAdam Nemet const SCEV *Sc = replaceSymbolicStrideSCEV(SE, Strides, Ptr); 1110456327cSAdam Nemet const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Sc); 1120456327cSAdam Nemet assert(AR && "Invalid addrec expression"); 1130456327cSAdam Nemet const SCEV *Ex = SE->getBackedgeTakenCount(Lp); 1140456327cSAdam Nemet const SCEV *ScEnd = AR->evaluateAtIteration(Ex, *SE); 1150456327cSAdam Nemet Pointers.push_back(Ptr); 1160456327cSAdam Nemet Starts.push_back(AR->getStart()); 1170456327cSAdam Nemet Ends.push_back(ScEnd); 1180456327cSAdam Nemet IsWritePtr.push_back(WritePtr); 1190456327cSAdam Nemet DependencySetId.push_back(DepSetId); 1200456327cSAdam Nemet AliasSetId.push_back(ASId); 1210456327cSAdam Nemet } 1220456327cSAdam Nemet 123a8945b77SAdam Nemet bool LoopAccessInfo::RuntimePointerCheck::needsChecking(unsigned I, 124a8945b77SAdam Nemet unsigned J) const { 125a8945b77SAdam Nemet // No need to check if two readonly pointers intersect. 126a8945b77SAdam Nemet if (!IsWritePtr[I] && !IsWritePtr[J]) 127a8945b77SAdam Nemet return false; 128a8945b77SAdam Nemet 129a8945b77SAdam Nemet // Only need to check pointers between two different dependency sets. 130a8945b77SAdam Nemet if (DependencySetId[I] == DependencySetId[J]) 131a8945b77SAdam Nemet return false; 132a8945b77SAdam Nemet 133a8945b77SAdam Nemet // Only need to check pointers in the same alias set. 134a8945b77SAdam Nemet if (AliasSetId[I] != AliasSetId[J]) 135a8945b77SAdam Nemet return false; 136a8945b77SAdam Nemet 137a8945b77SAdam Nemet return true; 138a8945b77SAdam Nemet } 139a8945b77SAdam Nemet 140e91cc6efSAdam Nemet void LoopAccessInfo::RuntimePointerCheck::print(raw_ostream &OS, 141e91cc6efSAdam Nemet unsigned Depth) const { 142e91cc6efSAdam Nemet unsigned NumPointers = Pointers.size(); 143e91cc6efSAdam Nemet if (NumPointers == 0) 144e91cc6efSAdam Nemet return; 145e91cc6efSAdam Nemet 146e91cc6efSAdam Nemet OS.indent(Depth) << "Run-time memory checks:\n"; 147e91cc6efSAdam Nemet unsigned N = 0; 148e91cc6efSAdam Nemet for (unsigned I = 0; I < NumPointers; ++I) 149e91cc6efSAdam Nemet for (unsigned J = I + 1; J < NumPointers; ++J) 150e91cc6efSAdam Nemet if (needsChecking(I, J)) { 151e91cc6efSAdam Nemet OS.indent(Depth) << N++ << ":\n"; 152e91cc6efSAdam Nemet OS.indent(Depth + 2) << *Pointers[I] << "\n"; 153e91cc6efSAdam Nemet OS.indent(Depth + 2) << *Pointers[J] << "\n"; 154e91cc6efSAdam Nemet } 155e91cc6efSAdam Nemet } 156e91cc6efSAdam Nemet 1570456327cSAdam Nemet namespace { 1580456327cSAdam Nemet /// \brief Analyses memory accesses in a loop. 1590456327cSAdam Nemet /// 1600456327cSAdam Nemet /// Checks whether run time pointer checks are needed and builds sets for data 1610456327cSAdam Nemet /// dependence checking. 1620456327cSAdam Nemet class AccessAnalysis { 1630456327cSAdam Nemet public: 1640456327cSAdam Nemet /// \brief Read or write access location. 1650456327cSAdam Nemet typedef PointerIntPair<Value *, 1, bool> MemAccessInfo; 1660456327cSAdam Nemet typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet; 1670456327cSAdam Nemet 168*dee666bcSAdam Nemet AccessAnalysis(const DataLayout &Dl, AliasAnalysis *AA, 169*dee666bcSAdam Nemet MemoryDepChecker::DepCandidates &DA) 170a28d91d8SMehdi Amini : DL(Dl), AST(*AA), DepCands(DA), IsRTCheckNeeded(false) {} 1710456327cSAdam Nemet 1720456327cSAdam Nemet /// \brief Register a load and whether it is only read from. 1730456327cSAdam Nemet void addLoad(AliasAnalysis::Location &Loc, bool IsReadOnly) { 1740456327cSAdam Nemet Value *Ptr = const_cast<Value*>(Loc.Ptr); 1750456327cSAdam Nemet AST.add(Ptr, AliasAnalysis::UnknownSize, Loc.AATags); 1760456327cSAdam Nemet Accesses.insert(MemAccessInfo(Ptr, false)); 1770456327cSAdam Nemet if (IsReadOnly) 1780456327cSAdam Nemet ReadOnlyPtr.insert(Ptr); 1790456327cSAdam Nemet } 1800456327cSAdam Nemet 1810456327cSAdam Nemet /// \brief Register a store. 1820456327cSAdam Nemet void addStore(AliasAnalysis::Location &Loc) { 1830456327cSAdam Nemet Value *Ptr = const_cast<Value*>(Loc.Ptr); 1840456327cSAdam Nemet AST.add(Ptr, AliasAnalysis::UnknownSize, Loc.AATags); 1850456327cSAdam Nemet Accesses.insert(MemAccessInfo(Ptr, true)); 1860456327cSAdam Nemet } 1870456327cSAdam Nemet 1880456327cSAdam Nemet /// \brief Check whether we can check the pointers at runtime for 1890456327cSAdam Nemet /// non-intersection. 19030f16e16SAdam Nemet bool canCheckPtrAtRT(LoopAccessInfo::RuntimePointerCheck &RtCheck, 1918bc61df9SAdam Nemet unsigned &NumComparisons, ScalarEvolution *SE, 1928bc61df9SAdam Nemet Loop *TheLoop, const ValueToValueMap &Strides, 1930456327cSAdam Nemet bool ShouldCheckStride = false); 1940456327cSAdam Nemet 1950456327cSAdam Nemet /// \brief Goes over all memory accesses, checks whether a RT check is needed 1960456327cSAdam Nemet /// and builds sets of dependent accesses. 1970456327cSAdam Nemet void buildDependenceSets() { 1980456327cSAdam Nemet processMemAccesses(); 1990456327cSAdam Nemet } 2000456327cSAdam Nemet 2010456327cSAdam Nemet bool isRTCheckNeeded() { return IsRTCheckNeeded; } 2020456327cSAdam Nemet 2030456327cSAdam Nemet bool isDependencyCheckNeeded() { return !CheckDeps.empty(); } 2040456327cSAdam Nemet void resetDepChecks() { CheckDeps.clear(); } 2050456327cSAdam Nemet 2060456327cSAdam Nemet MemAccessInfoSet &getDependenciesToCheck() { return CheckDeps; } 2070456327cSAdam Nemet 2080456327cSAdam Nemet private: 2090456327cSAdam Nemet typedef SetVector<MemAccessInfo> PtrAccessSet; 2100456327cSAdam Nemet 2110456327cSAdam Nemet /// \brief Go over all memory access and check whether runtime pointer checks 2120456327cSAdam Nemet /// are needed /// and build sets of dependency check candidates. 2130456327cSAdam Nemet void processMemAccesses(); 2140456327cSAdam Nemet 2150456327cSAdam Nemet /// Set of all accesses. 2160456327cSAdam Nemet PtrAccessSet Accesses; 2170456327cSAdam Nemet 218a28d91d8SMehdi Amini const DataLayout &DL; 219a28d91d8SMehdi Amini 2200456327cSAdam Nemet /// Set of accesses that need a further dependence check. 2210456327cSAdam Nemet MemAccessInfoSet CheckDeps; 2220456327cSAdam Nemet 2230456327cSAdam Nemet /// Set of pointers that are read only. 2240456327cSAdam Nemet SmallPtrSet<Value*, 16> ReadOnlyPtr; 2250456327cSAdam Nemet 2260456327cSAdam Nemet /// An alias set tracker to partition the access set by underlying object and 2270456327cSAdam Nemet //intrinsic property (such as TBAA metadata). 2280456327cSAdam Nemet AliasSetTracker AST; 2290456327cSAdam Nemet 2300456327cSAdam Nemet /// Sets of potentially dependent accesses - members of one set share an 2310456327cSAdam Nemet /// underlying pointer. The set "CheckDeps" identfies which sets really need a 2320456327cSAdam Nemet /// dependence check. 233*dee666bcSAdam Nemet MemoryDepChecker::DepCandidates &DepCands; 2340456327cSAdam Nemet 2350456327cSAdam Nemet bool IsRTCheckNeeded; 2360456327cSAdam Nemet }; 2370456327cSAdam Nemet 2380456327cSAdam Nemet } // end anonymous namespace 2390456327cSAdam Nemet 2400456327cSAdam Nemet /// \brief Check whether a pointer can participate in a runtime bounds check. 2418bc61df9SAdam Nemet static bool hasComputableBounds(ScalarEvolution *SE, 2428bc61df9SAdam Nemet const ValueToValueMap &Strides, Value *Ptr) { 2430456327cSAdam Nemet const SCEV *PtrScev = replaceSymbolicStrideSCEV(SE, Strides, Ptr); 2440456327cSAdam Nemet const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev); 2450456327cSAdam Nemet if (!AR) 2460456327cSAdam Nemet return false; 2470456327cSAdam Nemet 2480456327cSAdam Nemet return AR->isAffine(); 2490456327cSAdam Nemet } 2500456327cSAdam Nemet 2510456327cSAdam Nemet /// \brief Check the stride of the pointer and ensure that it does not wrap in 2520456327cSAdam Nemet /// the address space. 253a28d91d8SMehdi Amini static int isStridedPtr(ScalarEvolution *SE, Value *Ptr, const Loop *Lp, 254a28d91d8SMehdi Amini const ValueToValueMap &StridesMap); 2550456327cSAdam Nemet 2560456327cSAdam Nemet bool AccessAnalysis::canCheckPtrAtRT( 2578bc61df9SAdam Nemet LoopAccessInfo::RuntimePointerCheck &RtCheck, unsigned &NumComparisons, 2588bc61df9SAdam Nemet ScalarEvolution *SE, Loop *TheLoop, const ValueToValueMap &StridesMap, 2598bc61df9SAdam Nemet bool ShouldCheckStride) { 2600456327cSAdam Nemet // Find pointers with computable bounds. We are going to use this information 2610456327cSAdam Nemet // to place a runtime bound check. 2620456327cSAdam Nemet bool CanDoRT = true; 2630456327cSAdam Nemet 2640456327cSAdam Nemet bool IsDepCheckNeeded = isDependencyCheckNeeded(); 2650456327cSAdam Nemet NumComparisons = 0; 2660456327cSAdam Nemet 2670456327cSAdam Nemet // We assign a consecutive id to access from different alias sets. 2680456327cSAdam Nemet // Accesses between different groups doesn't need to be checked. 2690456327cSAdam Nemet unsigned ASId = 1; 2700456327cSAdam Nemet for (auto &AS : AST) { 2710456327cSAdam Nemet unsigned NumReadPtrChecks = 0; 2720456327cSAdam Nemet unsigned NumWritePtrChecks = 0; 2730456327cSAdam Nemet 2740456327cSAdam Nemet // We assign consecutive id to access from different dependence sets. 2750456327cSAdam Nemet // Accesses within the same set don't need a runtime check. 2760456327cSAdam Nemet unsigned RunningDepId = 1; 2770456327cSAdam Nemet DenseMap<Value *, unsigned> DepSetId; 2780456327cSAdam Nemet 2790456327cSAdam Nemet for (auto A : AS) { 2800456327cSAdam Nemet Value *Ptr = A.getValue(); 2810456327cSAdam Nemet bool IsWrite = Accesses.count(MemAccessInfo(Ptr, true)); 2820456327cSAdam Nemet MemAccessInfo Access(Ptr, IsWrite); 2830456327cSAdam Nemet 2840456327cSAdam Nemet if (IsWrite) 2850456327cSAdam Nemet ++NumWritePtrChecks; 2860456327cSAdam Nemet else 2870456327cSAdam Nemet ++NumReadPtrChecks; 2880456327cSAdam Nemet 2890456327cSAdam Nemet if (hasComputableBounds(SE, StridesMap, Ptr) && 290a28d91d8SMehdi Amini // When we run after a failing dependency check we have to make sure 291a28d91d8SMehdi Amini // we don't have wrapping pointers. 2920456327cSAdam Nemet (!ShouldCheckStride || 293a28d91d8SMehdi Amini isStridedPtr(SE, Ptr, TheLoop, StridesMap) == 1)) { 2940456327cSAdam Nemet // The id of the dependence set. 2950456327cSAdam Nemet unsigned DepId; 2960456327cSAdam Nemet 2970456327cSAdam Nemet if (IsDepCheckNeeded) { 2980456327cSAdam Nemet Value *Leader = DepCands.getLeaderValue(Access).getPointer(); 2990456327cSAdam Nemet unsigned &LeaderId = DepSetId[Leader]; 3000456327cSAdam Nemet if (!LeaderId) 3010456327cSAdam Nemet LeaderId = RunningDepId++; 3020456327cSAdam Nemet DepId = LeaderId; 3030456327cSAdam Nemet } else 3040456327cSAdam Nemet // Each access has its own dependence set. 3050456327cSAdam Nemet DepId = RunningDepId++; 3060456327cSAdam Nemet 3070456327cSAdam Nemet RtCheck.insert(SE, TheLoop, Ptr, IsWrite, DepId, ASId, StridesMap); 3080456327cSAdam Nemet 309339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a runtime check ptr:" << *Ptr << '\n'); 3100456327cSAdam Nemet } else { 3110456327cSAdam Nemet CanDoRT = false; 3120456327cSAdam Nemet } 3130456327cSAdam Nemet } 3140456327cSAdam Nemet 3150456327cSAdam Nemet if (IsDepCheckNeeded && CanDoRT && RunningDepId == 2) 3160456327cSAdam Nemet NumComparisons += 0; // Only one dependence set. 3170456327cSAdam Nemet else { 3180456327cSAdam Nemet NumComparisons += (NumWritePtrChecks * (NumReadPtrChecks + 3190456327cSAdam Nemet NumWritePtrChecks - 1)); 3200456327cSAdam Nemet } 3210456327cSAdam Nemet 3220456327cSAdam Nemet ++ASId; 3230456327cSAdam Nemet } 3240456327cSAdam Nemet 3250456327cSAdam Nemet // If the pointers that we would use for the bounds comparison have different 3260456327cSAdam Nemet // address spaces, assume the values aren't directly comparable, so we can't 3270456327cSAdam Nemet // use them for the runtime check. We also have to assume they could 3280456327cSAdam Nemet // overlap. In the future there should be metadata for whether address spaces 3290456327cSAdam Nemet // are disjoint. 3300456327cSAdam Nemet unsigned NumPointers = RtCheck.Pointers.size(); 3310456327cSAdam Nemet for (unsigned i = 0; i < NumPointers; ++i) { 3320456327cSAdam Nemet for (unsigned j = i + 1; j < NumPointers; ++j) { 3330456327cSAdam Nemet // Only need to check pointers between two different dependency sets. 3340456327cSAdam Nemet if (RtCheck.DependencySetId[i] == RtCheck.DependencySetId[j]) 3350456327cSAdam Nemet continue; 3360456327cSAdam Nemet // Only need to check pointers in the same alias set. 3370456327cSAdam Nemet if (RtCheck.AliasSetId[i] != RtCheck.AliasSetId[j]) 3380456327cSAdam Nemet continue; 3390456327cSAdam Nemet 3400456327cSAdam Nemet Value *PtrI = RtCheck.Pointers[i]; 3410456327cSAdam Nemet Value *PtrJ = RtCheck.Pointers[j]; 3420456327cSAdam Nemet 3430456327cSAdam Nemet unsigned ASi = PtrI->getType()->getPointerAddressSpace(); 3440456327cSAdam Nemet unsigned ASj = PtrJ->getType()->getPointerAddressSpace(); 3450456327cSAdam Nemet if (ASi != ASj) { 346339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Runtime check would require comparison between" 3470456327cSAdam Nemet " different address spaces\n"); 3480456327cSAdam Nemet return false; 3490456327cSAdam Nemet } 3500456327cSAdam Nemet } 3510456327cSAdam Nemet } 3520456327cSAdam Nemet 3530456327cSAdam Nemet return CanDoRT; 3540456327cSAdam Nemet } 3550456327cSAdam Nemet 3560456327cSAdam Nemet void AccessAnalysis::processMemAccesses() { 3570456327cSAdam Nemet // We process the set twice: first we process read-write pointers, last we 3580456327cSAdam Nemet // process read-only pointers. This allows us to skip dependence tests for 3590456327cSAdam Nemet // read-only pointers. 3600456327cSAdam Nemet 361339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Processing memory accesses...\n"); 3620456327cSAdam Nemet DEBUG(dbgs() << " AST: "; AST.dump()); 363339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Accesses:\n"); 3640456327cSAdam Nemet DEBUG({ 3650456327cSAdam Nemet for (auto A : Accesses) 3660456327cSAdam Nemet dbgs() << "\t" << *A.getPointer() << " (" << 3670456327cSAdam Nemet (A.getInt() ? "write" : (ReadOnlyPtr.count(A.getPointer()) ? 3680456327cSAdam Nemet "read-only" : "read")) << ")\n"; 3690456327cSAdam Nemet }); 3700456327cSAdam Nemet 3710456327cSAdam Nemet // The AliasSetTracker has nicely partitioned our pointers by metadata 3720456327cSAdam Nemet // compatibility and potential for underlying-object overlap. As a result, we 3730456327cSAdam Nemet // only need to check for potential pointer dependencies within each alias 3740456327cSAdam Nemet // set. 3750456327cSAdam Nemet for (auto &AS : AST) { 3760456327cSAdam Nemet // Note that both the alias-set tracker and the alias sets themselves used 3770456327cSAdam Nemet // linked lists internally and so the iteration order here is deterministic 3780456327cSAdam Nemet // (matching the original instruction order within each set). 3790456327cSAdam Nemet 3800456327cSAdam Nemet bool SetHasWrite = false; 3810456327cSAdam Nemet 3820456327cSAdam Nemet // Map of pointers to last access encountered. 3830456327cSAdam Nemet typedef DenseMap<Value*, MemAccessInfo> UnderlyingObjToAccessMap; 3840456327cSAdam Nemet UnderlyingObjToAccessMap ObjToLastAccess; 3850456327cSAdam Nemet 3860456327cSAdam Nemet // Set of access to check after all writes have been processed. 3870456327cSAdam Nemet PtrAccessSet DeferredAccesses; 3880456327cSAdam Nemet 3890456327cSAdam Nemet // Iterate over each alias set twice, once to process read/write pointers, 3900456327cSAdam Nemet // and then to process read-only pointers. 3910456327cSAdam Nemet for (int SetIteration = 0; SetIteration < 2; ++SetIteration) { 3920456327cSAdam Nemet bool UseDeferred = SetIteration > 0; 3930456327cSAdam Nemet PtrAccessSet &S = UseDeferred ? DeferredAccesses : Accesses; 3940456327cSAdam Nemet 3950456327cSAdam Nemet for (auto AV : AS) { 3960456327cSAdam Nemet Value *Ptr = AV.getValue(); 3970456327cSAdam Nemet 3980456327cSAdam Nemet // For a single memory access in AliasSetTracker, Accesses may contain 3990456327cSAdam Nemet // both read and write, and they both need to be handled for CheckDeps. 4000456327cSAdam Nemet for (auto AC : S) { 4010456327cSAdam Nemet if (AC.getPointer() != Ptr) 4020456327cSAdam Nemet continue; 4030456327cSAdam Nemet 4040456327cSAdam Nemet bool IsWrite = AC.getInt(); 4050456327cSAdam Nemet 4060456327cSAdam Nemet // If we're using the deferred access set, then it contains only 4070456327cSAdam Nemet // reads. 4080456327cSAdam Nemet bool IsReadOnlyPtr = ReadOnlyPtr.count(Ptr) && !IsWrite; 4090456327cSAdam Nemet if (UseDeferred && !IsReadOnlyPtr) 4100456327cSAdam Nemet continue; 4110456327cSAdam Nemet // Otherwise, the pointer must be in the PtrAccessSet, either as a 4120456327cSAdam Nemet // read or a write. 4130456327cSAdam Nemet assert(((IsReadOnlyPtr && UseDeferred) || IsWrite || 4140456327cSAdam Nemet S.count(MemAccessInfo(Ptr, false))) && 4150456327cSAdam Nemet "Alias-set pointer not in the access set?"); 4160456327cSAdam Nemet 4170456327cSAdam Nemet MemAccessInfo Access(Ptr, IsWrite); 4180456327cSAdam Nemet DepCands.insert(Access); 4190456327cSAdam Nemet 4200456327cSAdam Nemet // Memorize read-only pointers for later processing and skip them in 4210456327cSAdam Nemet // the first round (they need to be checked after we have seen all 4220456327cSAdam Nemet // write pointers). Note: we also mark pointer that are not 4230456327cSAdam Nemet // consecutive as "read-only" pointers (so that we check 4240456327cSAdam Nemet // "a[b[i]] +="). Hence, we need the second check for "!IsWrite". 4250456327cSAdam Nemet if (!UseDeferred && IsReadOnlyPtr) { 4260456327cSAdam Nemet DeferredAccesses.insert(Access); 4270456327cSAdam Nemet continue; 4280456327cSAdam Nemet } 4290456327cSAdam Nemet 4300456327cSAdam Nemet // If this is a write - check other reads and writes for conflicts. If 4310456327cSAdam Nemet // this is a read only check other writes for conflicts (but only if 4320456327cSAdam Nemet // there is no other write to the ptr - this is an optimization to 4330456327cSAdam Nemet // catch "a[i] = a[i] + " without having to do a dependence check). 4340456327cSAdam Nemet if ((IsWrite || IsReadOnlyPtr) && SetHasWrite) { 4350456327cSAdam Nemet CheckDeps.insert(Access); 4360456327cSAdam Nemet IsRTCheckNeeded = true; 4370456327cSAdam Nemet } 4380456327cSAdam Nemet 4390456327cSAdam Nemet if (IsWrite) 4400456327cSAdam Nemet SetHasWrite = true; 4410456327cSAdam Nemet 4420456327cSAdam Nemet // Create sets of pointers connected by a shared alias set and 4430456327cSAdam Nemet // underlying object. 4440456327cSAdam Nemet typedef SmallVector<Value *, 16> ValueVector; 4450456327cSAdam Nemet ValueVector TempObjects; 4460456327cSAdam Nemet GetUnderlyingObjects(Ptr, TempObjects, DL); 4470456327cSAdam Nemet for (Value *UnderlyingObj : TempObjects) { 4480456327cSAdam Nemet UnderlyingObjToAccessMap::iterator Prev = 4490456327cSAdam Nemet ObjToLastAccess.find(UnderlyingObj); 4500456327cSAdam Nemet if (Prev != ObjToLastAccess.end()) 4510456327cSAdam Nemet DepCands.unionSets(Access, Prev->second); 4520456327cSAdam Nemet 4530456327cSAdam Nemet ObjToLastAccess[UnderlyingObj] = Access; 4540456327cSAdam Nemet } 4550456327cSAdam Nemet } 4560456327cSAdam Nemet } 4570456327cSAdam Nemet } 4580456327cSAdam Nemet } 4590456327cSAdam Nemet } 4600456327cSAdam Nemet 4610456327cSAdam Nemet static bool isInBoundsGep(Value *Ptr) { 4620456327cSAdam Nemet if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr)) 4630456327cSAdam Nemet return GEP->isInBounds(); 4640456327cSAdam Nemet return false; 4650456327cSAdam Nemet } 4660456327cSAdam Nemet 4670456327cSAdam Nemet /// \brief Check whether the access through \p Ptr has a constant stride. 468a28d91d8SMehdi Amini static int isStridedPtr(ScalarEvolution *SE, Value *Ptr, const Loop *Lp, 469a28d91d8SMehdi Amini const ValueToValueMap &StridesMap) { 4700456327cSAdam Nemet const Type *Ty = Ptr->getType(); 4710456327cSAdam Nemet assert(Ty->isPointerTy() && "Unexpected non-ptr"); 4720456327cSAdam Nemet 4730456327cSAdam Nemet // Make sure that the pointer does not point to aggregate types. 4740456327cSAdam Nemet const PointerType *PtrTy = cast<PointerType>(Ty); 4750456327cSAdam Nemet if (PtrTy->getElementType()->isAggregateType()) { 476339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Not a pointer to a scalar type" 477339f42b3SAdam Nemet << *Ptr << "\n"); 4780456327cSAdam Nemet return 0; 4790456327cSAdam Nemet } 4800456327cSAdam Nemet 4810456327cSAdam Nemet const SCEV *PtrScev = replaceSymbolicStrideSCEV(SE, StridesMap, Ptr); 4820456327cSAdam Nemet 4830456327cSAdam Nemet const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev); 4840456327cSAdam Nemet if (!AR) { 485339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Not an AddRecExpr pointer " 48604d4163eSAdam Nemet << *Ptr << " SCEV: " << *PtrScev << "\n"); 4870456327cSAdam Nemet return 0; 4880456327cSAdam Nemet } 4890456327cSAdam Nemet 4900456327cSAdam Nemet // The accesss function must stride over the innermost loop. 4910456327cSAdam Nemet if (Lp != AR->getLoop()) { 492339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Not striding over innermost loop " << 49304d4163eSAdam Nemet *Ptr << " SCEV: " << *PtrScev << "\n"); 4940456327cSAdam Nemet } 4950456327cSAdam Nemet 4960456327cSAdam Nemet // The address calculation must not wrap. Otherwise, a dependence could be 4970456327cSAdam Nemet // inverted. 4980456327cSAdam Nemet // An inbounds getelementptr that is a AddRec with a unit stride 4990456327cSAdam Nemet // cannot wrap per definition. The unit stride requirement is checked later. 5000456327cSAdam Nemet // An getelementptr without an inbounds attribute and unit stride would have 5010456327cSAdam Nemet // to access the pointer value "0" which is undefined behavior in address 5020456327cSAdam Nemet // space 0, therefore we can also vectorize this case. 5030456327cSAdam Nemet bool IsInBoundsGEP = isInBoundsGep(Ptr); 5040456327cSAdam Nemet bool IsNoWrapAddRec = AR->getNoWrapFlags(SCEV::NoWrapMask); 5050456327cSAdam Nemet bool IsInAddressSpaceZero = PtrTy->getAddressSpace() == 0; 5060456327cSAdam Nemet if (!IsNoWrapAddRec && !IsInBoundsGEP && !IsInAddressSpaceZero) { 507339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Pointer may wrap in the address space " 5080456327cSAdam Nemet << *Ptr << " SCEV: " << *PtrScev << "\n"); 5090456327cSAdam Nemet return 0; 5100456327cSAdam Nemet } 5110456327cSAdam Nemet 5120456327cSAdam Nemet // Check the step is constant. 5130456327cSAdam Nemet const SCEV *Step = AR->getStepRecurrence(*SE); 5140456327cSAdam Nemet 5150456327cSAdam Nemet // Calculate the pointer stride and check if it is consecutive. 5160456327cSAdam Nemet const SCEVConstant *C = dyn_cast<SCEVConstant>(Step); 5170456327cSAdam Nemet if (!C) { 518339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Bad stride - Not a constant strided " << *Ptr << 51904d4163eSAdam Nemet " SCEV: " << *PtrScev << "\n"); 5200456327cSAdam Nemet return 0; 5210456327cSAdam Nemet } 5220456327cSAdam Nemet 523a28d91d8SMehdi Amini auto &DL = Lp->getHeader()->getModule()->getDataLayout(); 524a28d91d8SMehdi Amini int64_t Size = DL.getTypeAllocSize(PtrTy->getElementType()); 5250456327cSAdam Nemet const APInt &APStepVal = C->getValue()->getValue(); 5260456327cSAdam Nemet 5270456327cSAdam Nemet // Huge step value - give up. 5280456327cSAdam Nemet if (APStepVal.getBitWidth() > 64) 5290456327cSAdam Nemet return 0; 5300456327cSAdam Nemet 5310456327cSAdam Nemet int64_t StepVal = APStepVal.getSExtValue(); 5320456327cSAdam Nemet 5330456327cSAdam Nemet // Strided access. 5340456327cSAdam Nemet int64_t Stride = StepVal / Size; 5350456327cSAdam Nemet int64_t Rem = StepVal % Size; 5360456327cSAdam Nemet if (Rem) 5370456327cSAdam Nemet return 0; 5380456327cSAdam Nemet 5390456327cSAdam Nemet // If the SCEV could wrap but we have an inbounds gep with a unit stride we 5400456327cSAdam Nemet // know we can't "wrap around the address space". In case of address space 5410456327cSAdam Nemet // zero we know that this won't happen without triggering undefined behavior. 5420456327cSAdam Nemet if (!IsNoWrapAddRec && (IsInBoundsGEP || IsInAddressSpaceZero) && 5430456327cSAdam Nemet Stride != 1 && Stride != -1) 5440456327cSAdam Nemet return 0; 5450456327cSAdam Nemet 5460456327cSAdam Nemet return Stride; 5470456327cSAdam Nemet } 5480456327cSAdam Nemet 5490456327cSAdam Nemet bool MemoryDepChecker::couldPreventStoreLoadForward(unsigned Distance, 5500456327cSAdam Nemet unsigned TypeByteSize) { 5510456327cSAdam Nemet // If loads occur at a distance that is not a multiple of a feasible vector 5520456327cSAdam Nemet // factor store-load forwarding does not take place. 5530456327cSAdam Nemet // Positive dependences might cause troubles because vectorizing them might 5540456327cSAdam Nemet // prevent store-load forwarding making vectorized code run a lot slower. 5550456327cSAdam Nemet // a[i] = a[i-3] ^ a[i-8]; 5560456327cSAdam Nemet // The stores to a[i:i+1] don't align with the stores to a[i-3:i-2] and 5570456327cSAdam Nemet // hence on your typical architecture store-load forwarding does not take 5580456327cSAdam Nemet // place. Vectorizing in such cases does not make sense. 5590456327cSAdam Nemet // Store-load forwarding distance. 5600456327cSAdam Nemet const unsigned NumCyclesForStoreLoadThroughMemory = 8*TypeByteSize; 5610456327cSAdam Nemet // Maximum vector factor. 562f219c647SAdam Nemet unsigned MaxVFWithoutSLForwardIssues = 563f219c647SAdam Nemet VectorizerParams::MaxVectorWidth * TypeByteSize; 5640456327cSAdam Nemet if(MaxSafeDepDistBytes < MaxVFWithoutSLForwardIssues) 5650456327cSAdam Nemet MaxVFWithoutSLForwardIssues = MaxSafeDepDistBytes; 5660456327cSAdam Nemet 5670456327cSAdam Nemet for (unsigned vf = 2*TypeByteSize; vf <= MaxVFWithoutSLForwardIssues; 5680456327cSAdam Nemet vf *= 2) { 5690456327cSAdam Nemet if (Distance % vf && Distance / vf < NumCyclesForStoreLoadThroughMemory) { 5700456327cSAdam Nemet MaxVFWithoutSLForwardIssues = (vf >>=1); 5710456327cSAdam Nemet break; 5720456327cSAdam Nemet } 5730456327cSAdam Nemet } 5740456327cSAdam Nemet 5750456327cSAdam Nemet if (MaxVFWithoutSLForwardIssues< 2*TypeByteSize) { 576339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Distance " << Distance << 57704d4163eSAdam Nemet " that could cause a store-load forwarding conflict\n"); 5780456327cSAdam Nemet return true; 5790456327cSAdam Nemet } 5800456327cSAdam Nemet 5810456327cSAdam Nemet if (MaxVFWithoutSLForwardIssues < MaxSafeDepDistBytes && 582f219c647SAdam Nemet MaxVFWithoutSLForwardIssues != 583f219c647SAdam Nemet VectorizerParams::MaxVectorWidth * TypeByteSize) 5840456327cSAdam Nemet MaxSafeDepDistBytes = MaxVFWithoutSLForwardIssues; 5850456327cSAdam Nemet return false; 5860456327cSAdam Nemet } 5870456327cSAdam Nemet 5880456327cSAdam Nemet bool MemoryDepChecker::isDependent(const MemAccessInfo &A, unsigned AIdx, 5890456327cSAdam Nemet const MemAccessInfo &B, unsigned BIdx, 5908bc61df9SAdam Nemet const ValueToValueMap &Strides) { 5910456327cSAdam Nemet assert (AIdx < BIdx && "Must pass arguments in program order"); 5920456327cSAdam Nemet 5930456327cSAdam Nemet Value *APtr = A.getPointer(); 5940456327cSAdam Nemet Value *BPtr = B.getPointer(); 5950456327cSAdam Nemet bool AIsWrite = A.getInt(); 5960456327cSAdam Nemet bool BIsWrite = B.getInt(); 5970456327cSAdam Nemet 5980456327cSAdam Nemet // Two reads are independent. 5990456327cSAdam Nemet if (!AIsWrite && !BIsWrite) 6000456327cSAdam Nemet return false; 6010456327cSAdam Nemet 6020456327cSAdam Nemet // We cannot check pointers in different address spaces. 6030456327cSAdam Nemet if (APtr->getType()->getPointerAddressSpace() != 6040456327cSAdam Nemet BPtr->getType()->getPointerAddressSpace()) 6050456327cSAdam Nemet return true; 6060456327cSAdam Nemet 6070456327cSAdam Nemet const SCEV *AScev = replaceSymbolicStrideSCEV(SE, Strides, APtr); 6080456327cSAdam Nemet const SCEV *BScev = replaceSymbolicStrideSCEV(SE, Strides, BPtr); 6090456327cSAdam Nemet 610a28d91d8SMehdi Amini int StrideAPtr = isStridedPtr(SE, APtr, InnermostLoop, Strides); 611a28d91d8SMehdi Amini int StrideBPtr = isStridedPtr(SE, BPtr, InnermostLoop, Strides); 6120456327cSAdam Nemet 6130456327cSAdam Nemet const SCEV *Src = AScev; 6140456327cSAdam Nemet const SCEV *Sink = BScev; 6150456327cSAdam Nemet 6160456327cSAdam Nemet // If the induction step is negative we have to invert source and sink of the 6170456327cSAdam Nemet // dependence. 6180456327cSAdam Nemet if (StrideAPtr < 0) { 6190456327cSAdam Nemet //Src = BScev; 6200456327cSAdam Nemet //Sink = AScev; 6210456327cSAdam Nemet std::swap(APtr, BPtr); 6220456327cSAdam Nemet std::swap(Src, Sink); 6230456327cSAdam Nemet std::swap(AIsWrite, BIsWrite); 6240456327cSAdam Nemet std::swap(AIdx, BIdx); 6250456327cSAdam Nemet std::swap(StrideAPtr, StrideBPtr); 6260456327cSAdam Nemet } 6270456327cSAdam Nemet 6280456327cSAdam Nemet const SCEV *Dist = SE->getMinusSCEV(Sink, Src); 6290456327cSAdam Nemet 630339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Src Scev: " << *Src << "Sink Scev: " << *Sink 6310456327cSAdam Nemet << "(Induction step: " << StrideAPtr << ")\n"); 632339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Distance for " << *InstMap[AIdx] << " to " 6330456327cSAdam Nemet << *InstMap[BIdx] << ": " << *Dist << "\n"); 6340456327cSAdam Nemet 6350456327cSAdam Nemet // Need consecutive accesses. We don't want to vectorize 6360456327cSAdam Nemet // "A[B[i]] += ..." and similar code or pointer arithmetic that could wrap in 6370456327cSAdam Nemet // the address space. 6380456327cSAdam Nemet if (!StrideAPtr || !StrideBPtr || StrideAPtr != StrideBPtr){ 6390456327cSAdam Nemet DEBUG(dbgs() << "Non-consecutive pointer access\n"); 6400456327cSAdam Nemet return true; 6410456327cSAdam Nemet } 6420456327cSAdam Nemet 6430456327cSAdam Nemet const SCEVConstant *C = dyn_cast<SCEVConstant>(Dist); 6440456327cSAdam Nemet if (!C) { 645339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Dependence because of non-constant distance\n"); 6460456327cSAdam Nemet ShouldRetryWithRuntimeCheck = true; 6470456327cSAdam Nemet return true; 6480456327cSAdam Nemet } 6490456327cSAdam Nemet 6500456327cSAdam Nemet Type *ATy = APtr->getType()->getPointerElementType(); 6510456327cSAdam Nemet Type *BTy = BPtr->getType()->getPointerElementType(); 652a28d91d8SMehdi Amini auto &DL = InnermostLoop->getHeader()->getModule()->getDataLayout(); 653a28d91d8SMehdi Amini unsigned TypeByteSize = DL.getTypeAllocSize(ATy); 6540456327cSAdam Nemet 6550456327cSAdam Nemet // Negative distances are not plausible dependencies. 6560456327cSAdam Nemet const APInt &Val = C->getValue()->getValue(); 6570456327cSAdam Nemet if (Val.isNegative()) { 6580456327cSAdam Nemet bool IsTrueDataDependence = (AIsWrite && !BIsWrite); 6590456327cSAdam Nemet if (IsTrueDataDependence && 6600456327cSAdam Nemet (couldPreventStoreLoadForward(Val.abs().getZExtValue(), TypeByteSize) || 6610456327cSAdam Nemet ATy != BTy)) 6620456327cSAdam Nemet return true; 6630456327cSAdam Nemet 664339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Dependence is negative: NoDep\n"); 6650456327cSAdam Nemet return false; 6660456327cSAdam Nemet } 6670456327cSAdam Nemet 6680456327cSAdam Nemet // Write to the same location with the same size. 6690456327cSAdam Nemet // Could be improved to assert type sizes are the same (i32 == float, etc). 6700456327cSAdam Nemet if (Val == 0) { 6710456327cSAdam Nemet if (ATy == BTy) 6720456327cSAdam Nemet return false; 673339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Zero dependence difference but different types\n"); 6740456327cSAdam Nemet return true; 6750456327cSAdam Nemet } 6760456327cSAdam Nemet 6770456327cSAdam Nemet assert(Val.isStrictlyPositive() && "Expect a positive value"); 6780456327cSAdam Nemet 6790456327cSAdam Nemet if (ATy != BTy) { 68004d4163eSAdam Nemet DEBUG(dbgs() << 681339f42b3SAdam Nemet "LAA: ReadWrite-Write positive dependency with different types\n"); 6829cc0c399SAdam Nemet return true; 6830456327cSAdam Nemet } 6840456327cSAdam Nemet 6850456327cSAdam Nemet unsigned Distance = (unsigned) Val.getZExtValue(); 6860456327cSAdam Nemet 6870456327cSAdam Nemet // Bail out early if passed-in parameters make vectorization not feasible. 688f219c647SAdam Nemet unsigned ForcedFactor = (VectorizerParams::VectorizationFactor ? 689f219c647SAdam Nemet VectorizerParams::VectorizationFactor : 1); 690f219c647SAdam Nemet unsigned ForcedUnroll = (VectorizerParams::VectorizationInterleave ? 691f219c647SAdam Nemet VectorizerParams::VectorizationInterleave : 1); 6920456327cSAdam Nemet 6930456327cSAdam Nemet // The distance must be bigger than the size needed for a vectorized version 6940456327cSAdam Nemet // of the operation and the size of the vectorized operation must not be 6950456327cSAdam Nemet // bigger than the currrent maximum size. 6960456327cSAdam Nemet if (Distance < 2*TypeByteSize || 6970456327cSAdam Nemet 2*TypeByteSize > MaxSafeDepDistBytes || 6980456327cSAdam Nemet Distance < TypeByteSize * ForcedUnroll * ForcedFactor) { 699339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Failure because of Positive distance " 7000456327cSAdam Nemet << Val.getSExtValue() << '\n'); 7010456327cSAdam Nemet return true; 7020456327cSAdam Nemet } 7030456327cSAdam Nemet 7049cc0c399SAdam Nemet // Positive distance bigger than max vectorization factor. 7050456327cSAdam Nemet MaxSafeDepDistBytes = Distance < MaxSafeDepDistBytes ? 7060456327cSAdam Nemet Distance : MaxSafeDepDistBytes; 7070456327cSAdam Nemet 7080456327cSAdam Nemet bool IsTrueDataDependence = (!AIsWrite && BIsWrite); 7090456327cSAdam Nemet if (IsTrueDataDependence && 7100456327cSAdam Nemet couldPreventStoreLoadForward(Distance, TypeByteSize)) 7110456327cSAdam Nemet return true; 7120456327cSAdam Nemet 713339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Positive distance " << Val.getSExtValue() << 71404d4163eSAdam Nemet " with max VF = " << MaxSafeDepDistBytes / TypeByteSize << '\n'); 7150456327cSAdam Nemet 7160456327cSAdam Nemet return false; 7170456327cSAdam Nemet } 7180456327cSAdam Nemet 719*dee666bcSAdam Nemet bool MemoryDepChecker::areDepsSafe(DepCandidates &AccessSets, 7200456327cSAdam Nemet MemAccessInfoSet &CheckDeps, 7218bc61df9SAdam Nemet const ValueToValueMap &Strides) { 7220456327cSAdam Nemet 7230456327cSAdam Nemet MaxSafeDepDistBytes = -1U; 7240456327cSAdam Nemet while (!CheckDeps.empty()) { 7250456327cSAdam Nemet MemAccessInfo CurAccess = *CheckDeps.begin(); 7260456327cSAdam Nemet 7270456327cSAdam Nemet // Get the relevant memory access set. 7280456327cSAdam Nemet EquivalenceClasses<MemAccessInfo>::iterator I = 7290456327cSAdam Nemet AccessSets.findValue(AccessSets.getLeaderValue(CurAccess)); 7300456327cSAdam Nemet 7310456327cSAdam Nemet // Check accesses within this set. 7320456327cSAdam Nemet EquivalenceClasses<MemAccessInfo>::member_iterator AI, AE; 7330456327cSAdam Nemet AI = AccessSets.member_begin(I), AE = AccessSets.member_end(); 7340456327cSAdam Nemet 7350456327cSAdam Nemet // Check every access pair. 7360456327cSAdam Nemet while (AI != AE) { 7370456327cSAdam Nemet CheckDeps.erase(*AI); 7380456327cSAdam Nemet EquivalenceClasses<MemAccessInfo>::member_iterator OI = std::next(AI); 7390456327cSAdam Nemet while (OI != AE) { 7400456327cSAdam Nemet // Check every accessing instruction pair in program order. 7410456327cSAdam Nemet for (std::vector<unsigned>::iterator I1 = Accesses[*AI].begin(), 7420456327cSAdam Nemet I1E = Accesses[*AI].end(); I1 != I1E; ++I1) 7430456327cSAdam Nemet for (std::vector<unsigned>::iterator I2 = Accesses[*OI].begin(), 7440456327cSAdam Nemet I2E = Accesses[*OI].end(); I2 != I2E; ++I2) { 7450456327cSAdam Nemet if (*I1 < *I2 && isDependent(*AI, *I1, *OI, *I2, Strides)) 7460456327cSAdam Nemet return false; 7470456327cSAdam Nemet if (*I2 < *I1 && isDependent(*OI, *I2, *AI, *I1, Strides)) 7480456327cSAdam Nemet return false; 7490456327cSAdam Nemet } 7500456327cSAdam Nemet ++OI; 7510456327cSAdam Nemet } 7520456327cSAdam Nemet AI++; 7530456327cSAdam Nemet } 7540456327cSAdam Nemet } 7550456327cSAdam Nemet return true; 7560456327cSAdam Nemet } 7570456327cSAdam Nemet 758929c38e8SAdam Nemet bool LoopAccessInfo::canAnalyzeLoop() { 759929c38e8SAdam Nemet // We can only analyze innermost loops. 760929c38e8SAdam Nemet if (!TheLoop->empty()) { 7612bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() << "loop is not the innermost loop"); 762929c38e8SAdam Nemet return false; 763929c38e8SAdam Nemet } 764929c38e8SAdam Nemet 765929c38e8SAdam Nemet // We must have a single backedge. 766929c38e8SAdam Nemet if (TheLoop->getNumBackEdges() != 1) { 767929c38e8SAdam Nemet emitAnalysis( 7682bd6e984SAdam Nemet LoopAccessReport() << 769929c38e8SAdam Nemet "loop control flow is not understood by analyzer"); 770929c38e8SAdam Nemet return false; 771929c38e8SAdam Nemet } 772929c38e8SAdam Nemet 773929c38e8SAdam Nemet // We must have a single exiting block. 774929c38e8SAdam Nemet if (!TheLoop->getExitingBlock()) { 775929c38e8SAdam Nemet emitAnalysis( 7762bd6e984SAdam Nemet LoopAccessReport() << 777929c38e8SAdam Nemet "loop control flow is not understood by analyzer"); 778929c38e8SAdam Nemet return false; 779929c38e8SAdam Nemet } 780929c38e8SAdam Nemet 781929c38e8SAdam Nemet // We only handle bottom-tested loops, i.e. loop in which the condition is 782929c38e8SAdam Nemet // checked at the end of each iteration. With that we can assume that all 783929c38e8SAdam Nemet // instructions in the loop are executed the same number of times. 784929c38e8SAdam Nemet if (TheLoop->getExitingBlock() != TheLoop->getLoopLatch()) { 785929c38e8SAdam Nemet emitAnalysis( 7862bd6e984SAdam Nemet LoopAccessReport() << 787929c38e8SAdam Nemet "loop control flow is not understood by analyzer"); 788929c38e8SAdam Nemet return false; 789929c38e8SAdam Nemet } 790929c38e8SAdam Nemet 791929c38e8SAdam Nemet // We need to have a loop header. 792929c38e8SAdam Nemet DEBUG(dbgs() << "LAA: Found a loop: " << 793929c38e8SAdam Nemet TheLoop->getHeader()->getName() << '\n'); 794929c38e8SAdam Nemet 795929c38e8SAdam Nemet // ScalarEvolution needs to be able to find the exit count. 796929c38e8SAdam Nemet const SCEV *ExitCount = SE->getBackedgeTakenCount(TheLoop); 797929c38e8SAdam Nemet if (ExitCount == SE->getCouldNotCompute()) { 7982bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() << 799929c38e8SAdam Nemet "could not determine number of loop iterations"); 800929c38e8SAdam Nemet DEBUG(dbgs() << "LAA: SCEV could not compute the loop exit count.\n"); 801929c38e8SAdam Nemet return false; 802929c38e8SAdam Nemet } 803929c38e8SAdam Nemet 804929c38e8SAdam Nemet return true; 805929c38e8SAdam Nemet } 806929c38e8SAdam Nemet 8078bc61df9SAdam Nemet void LoopAccessInfo::analyzeLoop(const ValueToValueMap &Strides) { 8080456327cSAdam Nemet 8090456327cSAdam Nemet typedef SmallVector<Value*, 16> ValueVector; 8100456327cSAdam Nemet typedef SmallPtrSet<Value*, 16> ValueSet; 8110456327cSAdam Nemet 8120456327cSAdam Nemet // Holds the Load and Store *instructions*. 8130456327cSAdam Nemet ValueVector Loads; 8140456327cSAdam Nemet ValueVector Stores; 8150456327cSAdam Nemet 8160456327cSAdam Nemet // Holds all the different accesses in the loop. 8170456327cSAdam Nemet unsigned NumReads = 0; 8180456327cSAdam Nemet unsigned NumReadWrites = 0; 8190456327cSAdam Nemet 8200456327cSAdam Nemet PtrRtCheck.Pointers.clear(); 8210456327cSAdam Nemet PtrRtCheck.Need = false; 8220456327cSAdam Nemet 8230456327cSAdam Nemet const bool IsAnnotatedParallel = TheLoop->isAnnotatedParallel(); 8240456327cSAdam Nemet 8250456327cSAdam Nemet // For each block. 8260456327cSAdam Nemet for (Loop::block_iterator bb = TheLoop->block_begin(), 8270456327cSAdam Nemet be = TheLoop->block_end(); bb != be; ++bb) { 8280456327cSAdam Nemet 8290456327cSAdam Nemet // Scan the BB and collect legal loads and stores. 8300456327cSAdam Nemet for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e; 8310456327cSAdam Nemet ++it) { 8320456327cSAdam Nemet 8330456327cSAdam Nemet // If this is a load, save it. If this instruction can read from memory 8340456327cSAdam Nemet // but is not a load, then we quit. Notice that we don't handle function 8350456327cSAdam Nemet // calls that read or write. 8360456327cSAdam Nemet if (it->mayReadFromMemory()) { 8370456327cSAdam Nemet // Many math library functions read the rounding mode. We will only 8380456327cSAdam Nemet // vectorize a loop if it contains known function calls that don't set 8390456327cSAdam Nemet // the flag. Therefore, it is safe to ignore this read from memory. 8400456327cSAdam Nemet CallInst *Call = dyn_cast<CallInst>(it); 8410456327cSAdam Nemet if (Call && getIntrinsicIDForCall(Call, TLI)) 8420456327cSAdam Nemet continue; 8430456327cSAdam Nemet 8440456327cSAdam Nemet LoadInst *Ld = dyn_cast<LoadInst>(it); 8450456327cSAdam Nemet if (!Ld || (!Ld->isSimple() && !IsAnnotatedParallel)) { 8462bd6e984SAdam Nemet emitAnalysis(LoopAccessReport(Ld) 8470456327cSAdam Nemet << "read with atomic ordering or volatile read"); 848339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a non-simple load.\n"); 849436018c3SAdam Nemet CanVecMem = false; 850436018c3SAdam Nemet return; 8510456327cSAdam Nemet } 8520456327cSAdam Nemet NumLoads++; 8530456327cSAdam Nemet Loads.push_back(Ld); 8540456327cSAdam Nemet DepChecker.addAccess(Ld); 8550456327cSAdam Nemet continue; 8560456327cSAdam Nemet } 8570456327cSAdam Nemet 8580456327cSAdam Nemet // Save 'store' instructions. Abort if other instructions write to memory. 8590456327cSAdam Nemet if (it->mayWriteToMemory()) { 8600456327cSAdam Nemet StoreInst *St = dyn_cast<StoreInst>(it); 8610456327cSAdam Nemet if (!St) { 8622bd6e984SAdam Nemet emitAnalysis(LoopAccessReport(it) << 86304d4163eSAdam Nemet "instruction cannot be vectorized"); 864436018c3SAdam Nemet CanVecMem = false; 865436018c3SAdam Nemet return; 8660456327cSAdam Nemet } 8670456327cSAdam Nemet if (!St->isSimple() && !IsAnnotatedParallel) { 8682bd6e984SAdam Nemet emitAnalysis(LoopAccessReport(St) 8690456327cSAdam Nemet << "write with atomic ordering or volatile write"); 870339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a non-simple store.\n"); 871436018c3SAdam Nemet CanVecMem = false; 872436018c3SAdam Nemet return; 8730456327cSAdam Nemet } 8740456327cSAdam Nemet NumStores++; 8750456327cSAdam Nemet Stores.push_back(St); 8760456327cSAdam Nemet DepChecker.addAccess(St); 8770456327cSAdam Nemet } 8780456327cSAdam Nemet } // Next instr. 8790456327cSAdam Nemet } // Next block. 8800456327cSAdam Nemet 8810456327cSAdam Nemet // Now we have two lists that hold the loads and the stores. 8820456327cSAdam Nemet // Next, we find the pointers that they use. 8830456327cSAdam Nemet 8840456327cSAdam Nemet // Check if we see any stores. If there are no stores, then we don't 8850456327cSAdam Nemet // care if the pointers are *restrict*. 8860456327cSAdam Nemet if (!Stores.size()) { 887339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a read-only loop!\n"); 888436018c3SAdam Nemet CanVecMem = true; 889436018c3SAdam Nemet return; 8900456327cSAdam Nemet } 8910456327cSAdam Nemet 892*dee666bcSAdam Nemet MemoryDepChecker::DepCandidates DependentAccesses; 893a28d91d8SMehdi Amini AccessAnalysis Accesses(TheLoop->getHeader()->getModule()->getDataLayout(), 894a28d91d8SMehdi Amini AA, DependentAccesses); 8950456327cSAdam Nemet 8960456327cSAdam Nemet // Holds the analyzed pointers. We don't want to call GetUnderlyingObjects 8970456327cSAdam Nemet // multiple times on the same object. If the ptr is accessed twice, once 8980456327cSAdam Nemet // for read and once for write, it will only appear once (on the write 8990456327cSAdam Nemet // list). This is okay, since we are going to check for conflicts between 9000456327cSAdam Nemet // writes and between reads and writes, but not between reads and reads. 9010456327cSAdam Nemet ValueSet Seen; 9020456327cSAdam Nemet 9030456327cSAdam Nemet ValueVector::iterator I, IE; 9040456327cSAdam Nemet for (I = Stores.begin(), IE = Stores.end(); I != IE; ++I) { 9050456327cSAdam Nemet StoreInst *ST = cast<StoreInst>(*I); 9060456327cSAdam Nemet Value* Ptr = ST->getPointerOperand(); 9070456327cSAdam Nemet 9080456327cSAdam Nemet if (isUniform(Ptr)) { 9090456327cSAdam Nemet emitAnalysis( 9102bd6e984SAdam Nemet LoopAccessReport(ST) 9110456327cSAdam Nemet << "write to a loop invariant address could not be vectorized"); 912339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: We don't allow storing to uniform addresses\n"); 913436018c3SAdam Nemet CanVecMem = false; 914436018c3SAdam Nemet return; 9150456327cSAdam Nemet } 9160456327cSAdam Nemet 9170456327cSAdam Nemet // If we did *not* see this pointer before, insert it to the read-write 9180456327cSAdam Nemet // list. At this phase it is only a 'write' list. 9190456327cSAdam Nemet if (Seen.insert(Ptr).second) { 9200456327cSAdam Nemet ++NumReadWrites; 9210456327cSAdam Nemet 9220456327cSAdam Nemet AliasAnalysis::Location Loc = AA->getLocation(ST); 9230456327cSAdam Nemet // The TBAA metadata could have a control dependency on the predication 9240456327cSAdam Nemet // condition, so we cannot rely on it when determining whether or not we 9250456327cSAdam Nemet // need runtime pointer checks. 92601abb2c3SAdam Nemet if (blockNeedsPredication(ST->getParent(), TheLoop, DT)) 9270456327cSAdam Nemet Loc.AATags.TBAA = nullptr; 9280456327cSAdam Nemet 9290456327cSAdam Nemet Accesses.addStore(Loc); 9300456327cSAdam Nemet } 9310456327cSAdam Nemet } 9320456327cSAdam Nemet 9330456327cSAdam Nemet if (IsAnnotatedParallel) { 93404d4163eSAdam Nemet DEBUG(dbgs() 935339f42b3SAdam Nemet << "LAA: A loop annotated parallel, ignore memory dependency " 9360456327cSAdam Nemet << "checks.\n"); 937436018c3SAdam Nemet CanVecMem = true; 938436018c3SAdam Nemet return; 9390456327cSAdam Nemet } 9400456327cSAdam Nemet 9410456327cSAdam Nemet for (I = Loads.begin(), IE = Loads.end(); I != IE; ++I) { 9420456327cSAdam Nemet LoadInst *LD = cast<LoadInst>(*I); 9430456327cSAdam Nemet Value* Ptr = LD->getPointerOperand(); 9440456327cSAdam Nemet // If we did *not* see this pointer before, insert it to the 9450456327cSAdam Nemet // read list. If we *did* see it before, then it is already in 9460456327cSAdam Nemet // the read-write list. This allows us to vectorize expressions 9470456327cSAdam Nemet // such as A[i] += x; Because the address of A[i] is a read-write 9480456327cSAdam Nemet // pointer. This only works if the index of A[i] is consecutive. 9490456327cSAdam Nemet // If the address of i is unknown (for example A[B[i]]) then we may 9500456327cSAdam Nemet // read a few words, modify, and write a few words, and some of the 9510456327cSAdam Nemet // words may be written to the same address. 9520456327cSAdam Nemet bool IsReadOnlyPtr = false; 953a28d91d8SMehdi Amini if (Seen.insert(Ptr).second || !isStridedPtr(SE, Ptr, TheLoop, Strides)) { 9540456327cSAdam Nemet ++NumReads; 9550456327cSAdam Nemet IsReadOnlyPtr = true; 9560456327cSAdam Nemet } 9570456327cSAdam Nemet 9580456327cSAdam Nemet AliasAnalysis::Location Loc = AA->getLocation(LD); 9590456327cSAdam Nemet // The TBAA metadata could have a control dependency on the predication 9600456327cSAdam Nemet // condition, so we cannot rely on it when determining whether or not we 9610456327cSAdam Nemet // need runtime pointer checks. 96201abb2c3SAdam Nemet if (blockNeedsPredication(LD->getParent(), TheLoop, DT)) 9630456327cSAdam Nemet Loc.AATags.TBAA = nullptr; 9640456327cSAdam Nemet 9650456327cSAdam Nemet Accesses.addLoad(Loc, IsReadOnlyPtr); 9660456327cSAdam Nemet } 9670456327cSAdam Nemet 9680456327cSAdam Nemet // If we write (or read-write) to a single destination and there are no 9690456327cSAdam Nemet // other reads in this loop then is it safe to vectorize. 9700456327cSAdam Nemet if (NumReadWrites == 1 && NumReads == 0) { 971339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Found a write-only loop!\n"); 972436018c3SAdam Nemet CanVecMem = true; 973436018c3SAdam Nemet return; 9740456327cSAdam Nemet } 9750456327cSAdam Nemet 9760456327cSAdam Nemet // Build dependence sets and check whether we need a runtime pointer bounds 9770456327cSAdam Nemet // check. 9780456327cSAdam Nemet Accesses.buildDependenceSets(); 9790456327cSAdam Nemet bool NeedRTCheck = Accesses.isRTCheckNeeded(); 9800456327cSAdam Nemet 9810456327cSAdam Nemet // Find pointers with computable bounds. We are going to use this information 9820456327cSAdam Nemet // to place a runtime bound check. 9830456327cSAdam Nemet unsigned NumComparisons = 0; 9840456327cSAdam Nemet bool CanDoRT = false; 9850456327cSAdam Nemet if (NeedRTCheck) 9860456327cSAdam Nemet CanDoRT = Accesses.canCheckPtrAtRT(PtrRtCheck, NumComparisons, SE, TheLoop, 9870456327cSAdam Nemet Strides); 9880456327cSAdam Nemet 989339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: We need to do " << NumComparisons << 99004d4163eSAdam Nemet " pointer comparisons.\n"); 9910456327cSAdam Nemet 9920456327cSAdam Nemet // If we only have one set of dependences to check pointers among we don't 9930456327cSAdam Nemet // need a runtime check. 9940456327cSAdam Nemet if (NumComparisons == 0 && NeedRTCheck) 9950456327cSAdam Nemet NeedRTCheck = false; 9960456327cSAdam Nemet 9970456327cSAdam Nemet // Check that we did not collect too many pointers or found an unsizeable 9980456327cSAdam Nemet // pointer. 9991d862af7SAdam Nemet if (!CanDoRT || NumComparisons > RuntimeMemoryCheckThreshold) { 10000456327cSAdam Nemet PtrRtCheck.reset(); 10010456327cSAdam Nemet CanDoRT = false; 10020456327cSAdam Nemet } 10030456327cSAdam Nemet 10040456327cSAdam Nemet if (CanDoRT) { 1005339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: We can perform a memory runtime check if needed.\n"); 10060456327cSAdam Nemet } 10070456327cSAdam Nemet 10080456327cSAdam Nemet if (NeedRTCheck && !CanDoRT) { 10092bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() << "cannot identify array bounds"); 1010339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: We can't vectorize because we can't find " << 101104d4163eSAdam Nemet "the array bounds.\n"); 10120456327cSAdam Nemet PtrRtCheck.reset(); 1013436018c3SAdam Nemet CanVecMem = false; 1014436018c3SAdam Nemet return; 10150456327cSAdam Nemet } 10160456327cSAdam Nemet 10170456327cSAdam Nemet PtrRtCheck.Need = NeedRTCheck; 10180456327cSAdam Nemet 1019436018c3SAdam Nemet CanVecMem = true; 10200456327cSAdam Nemet if (Accesses.isDependencyCheckNeeded()) { 1021339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Checking memory dependencies\n"); 10220456327cSAdam Nemet CanVecMem = DepChecker.areDepsSafe( 10230456327cSAdam Nemet DependentAccesses, Accesses.getDependenciesToCheck(), Strides); 10240456327cSAdam Nemet MaxSafeDepDistBytes = DepChecker.getMaxSafeDepDistBytes(); 10250456327cSAdam Nemet 10260456327cSAdam Nemet if (!CanVecMem && DepChecker.shouldRetryWithRuntimeCheck()) { 1027339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Retrying with memory checks\n"); 10280456327cSAdam Nemet NeedRTCheck = true; 10290456327cSAdam Nemet 10300456327cSAdam Nemet // Clear the dependency checks. We assume they are not needed. 10310456327cSAdam Nemet Accesses.resetDepChecks(); 10320456327cSAdam Nemet 10330456327cSAdam Nemet PtrRtCheck.reset(); 10340456327cSAdam Nemet PtrRtCheck.Need = true; 10350456327cSAdam Nemet 10360456327cSAdam Nemet CanDoRT = Accesses.canCheckPtrAtRT(PtrRtCheck, NumComparisons, SE, 10370456327cSAdam Nemet TheLoop, Strides, true); 10380456327cSAdam Nemet // Check that we did not collect too many pointers or found an unsizeable 10390456327cSAdam Nemet // pointer. 10401d862af7SAdam Nemet if (!CanDoRT || NumComparisons > RuntimeMemoryCheckThreshold) { 10410456327cSAdam Nemet if (!CanDoRT && NumComparisons > 0) 10422bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() 10430456327cSAdam Nemet << "cannot check memory dependencies at runtime"); 10440456327cSAdam Nemet else 10452bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() 10460456327cSAdam Nemet << NumComparisons << " exceeds limit of " 10471d862af7SAdam Nemet << RuntimeMemoryCheckThreshold 10480456327cSAdam Nemet << " dependent memory operations checked at runtime"); 1049339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Can't vectorize with memory checks\n"); 10500456327cSAdam Nemet PtrRtCheck.reset(); 1051436018c3SAdam Nemet CanVecMem = false; 1052436018c3SAdam Nemet return; 10530456327cSAdam Nemet } 10540456327cSAdam Nemet 10550456327cSAdam Nemet CanVecMem = true; 10560456327cSAdam Nemet } 10570456327cSAdam Nemet } 10580456327cSAdam Nemet 10590456327cSAdam Nemet if (!CanVecMem) 10602bd6e984SAdam Nemet emitAnalysis(LoopAccessReport() << 106104d4163eSAdam Nemet "unsafe dependent memory operations in loop"); 10620456327cSAdam Nemet 1063339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: We" << (NeedRTCheck ? "" : " don't") << 106404d4163eSAdam Nemet " need a runtime memory check.\n"); 10650456327cSAdam Nemet } 10660456327cSAdam Nemet 106701abb2c3SAdam Nemet bool LoopAccessInfo::blockNeedsPredication(BasicBlock *BB, Loop *TheLoop, 106801abb2c3SAdam Nemet DominatorTree *DT) { 10690456327cSAdam Nemet assert(TheLoop->contains(BB) && "Unknown block used"); 10700456327cSAdam Nemet 10710456327cSAdam Nemet // Blocks that do not dominate the latch need predication. 10720456327cSAdam Nemet BasicBlock* Latch = TheLoop->getLoopLatch(); 10730456327cSAdam Nemet return !DT->dominates(BB, Latch); 10740456327cSAdam Nemet } 10750456327cSAdam Nemet 10762bd6e984SAdam Nemet void LoopAccessInfo::emitAnalysis(LoopAccessReport &Message) { 1077c922853bSAdam Nemet assert(!Report && "Multiple reports generated"); 1078c922853bSAdam Nemet Report = Message; 10790456327cSAdam Nemet } 10800456327cSAdam Nemet 108157ac766eSAdam Nemet bool LoopAccessInfo::isUniform(Value *V) const { 10820456327cSAdam Nemet return (SE->isLoopInvariant(SE->getSCEV(V), TheLoop)); 10830456327cSAdam Nemet } 10847206d7a5SAdam Nemet 10857206d7a5SAdam Nemet // FIXME: this function is currently a duplicate of the one in 10867206d7a5SAdam Nemet // LoopVectorize.cpp. 10877206d7a5SAdam Nemet static Instruction *getFirstInst(Instruction *FirstInst, Value *V, 10887206d7a5SAdam Nemet Instruction *Loc) { 10897206d7a5SAdam Nemet if (FirstInst) 10907206d7a5SAdam Nemet return FirstInst; 10917206d7a5SAdam Nemet if (Instruction *I = dyn_cast<Instruction>(V)) 10927206d7a5SAdam Nemet return I->getParent() == Loc->getParent() ? I : nullptr; 10937206d7a5SAdam Nemet return nullptr; 10947206d7a5SAdam Nemet } 10957206d7a5SAdam Nemet 10967206d7a5SAdam Nemet std::pair<Instruction *, Instruction *> 109757ac766eSAdam Nemet LoopAccessInfo::addRuntimeCheck(Instruction *Loc) const { 10987206d7a5SAdam Nemet Instruction *tnullptr = nullptr; 10997206d7a5SAdam Nemet if (!PtrRtCheck.Need) 11007206d7a5SAdam Nemet return std::pair<Instruction *, Instruction *>(tnullptr, tnullptr); 11017206d7a5SAdam Nemet 11027206d7a5SAdam Nemet unsigned NumPointers = PtrRtCheck.Pointers.size(); 11037206d7a5SAdam Nemet SmallVector<TrackingVH<Value> , 2> Starts; 11047206d7a5SAdam Nemet SmallVector<TrackingVH<Value> , 2> Ends; 11057206d7a5SAdam Nemet 11067206d7a5SAdam Nemet LLVMContext &Ctx = Loc->getContext(); 1107a28d91d8SMehdi Amini SCEVExpander Exp(*SE, DL, "induction"); 11087206d7a5SAdam Nemet Instruction *FirstInst = nullptr; 11097206d7a5SAdam Nemet 11107206d7a5SAdam Nemet for (unsigned i = 0; i < NumPointers; ++i) { 11117206d7a5SAdam Nemet Value *Ptr = PtrRtCheck.Pointers[i]; 11127206d7a5SAdam Nemet const SCEV *Sc = SE->getSCEV(Ptr); 11137206d7a5SAdam Nemet 11147206d7a5SAdam Nemet if (SE->isLoopInvariant(Sc, TheLoop)) { 1115339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Adding RT check for a loop invariant ptr:" << 111604d4163eSAdam Nemet *Ptr <<"\n"); 11177206d7a5SAdam Nemet Starts.push_back(Ptr); 11187206d7a5SAdam Nemet Ends.push_back(Ptr); 11197206d7a5SAdam Nemet } else { 1120339f42b3SAdam Nemet DEBUG(dbgs() << "LAA: Adding RT check for range:" << *Ptr << '\n'); 11217206d7a5SAdam Nemet unsigned AS = Ptr->getType()->getPointerAddressSpace(); 11227206d7a5SAdam Nemet 11237206d7a5SAdam Nemet // Use this type for pointer arithmetic. 11247206d7a5SAdam Nemet Type *PtrArithTy = Type::getInt8PtrTy(Ctx, AS); 11257206d7a5SAdam Nemet 11267206d7a5SAdam Nemet Value *Start = Exp.expandCodeFor(PtrRtCheck.Starts[i], PtrArithTy, Loc); 11277206d7a5SAdam Nemet Value *End = Exp.expandCodeFor(PtrRtCheck.Ends[i], PtrArithTy, Loc); 11287206d7a5SAdam Nemet Starts.push_back(Start); 11297206d7a5SAdam Nemet Ends.push_back(End); 11307206d7a5SAdam Nemet } 11317206d7a5SAdam Nemet } 11327206d7a5SAdam Nemet 11337206d7a5SAdam Nemet IRBuilder<> ChkBuilder(Loc); 11347206d7a5SAdam Nemet // Our instructions might fold to a constant. 11357206d7a5SAdam Nemet Value *MemoryRuntimeCheck = nullptr; 11367206d7a5SAdam Nemet for (unsigned i = 0; i < NumPointers; ++i) { 11377206d7a5SAdam Nemet for (unsigned j = i+1; j < NumPointers; ++j) { 1138a8945b77SAdam Nemet if (!PtrRtCheck.needsChecking(i, j)) 11397206d7a5SAdam Nemet continue; 11407206d7a5SAdam Nemet 11417206d7a5SAdam Nemet unsigned AS0 = Starts[i]->getType()->getPointerAddressSpace(); 11427206d7a5SAdam Nemet unsigned AS1 = Starts[j]->getType()->getPointerAddressSpace(); 11437206d7a5SAdam Nemet 11447206d7a5SAdam Nemet assert((AS0 == Ends[j]->getType()->getPointerAddressSpace()) && 11457206d7a5SAdam Nemet (AS1 == Ends[i]->getType()->getPointerAddressSpace()) && 11467206d7a5SAdam Nemet "Trying to bounds check pointers with different address spaces"); 11477206d7a5SAdam Nemet 11487206d7a5SAdam Nemet Type *PtrArithTy0 = Type::getInt8PtrTy(Ctx, AS0); 11497206d7a5SAdam Nemet Type *PtrArithTy1 = Type::getInt8PtrTy(Ctx, AS1); 11507206d7a5SAdam Nemet 11517206d7a5SAdam Nemet Value *Start0 = ChkBuilder.CreateBitCast(Starts[i], PtrArithTy0, "bc"); 11527206d7a5SAdam Nemet Value *Start1 = ChkBuilder.CreateBitCast(Starts[j], PtrArithTy1, "bc"); 11537206d7a5SAdam Nemet Value *End0 = ChkBuilder.CreateBitCast(Ends[i], PtrArithTy1, "bc"); 11547206d7a5SAdam Nemet Value *End1 = ChkBuilder.CreateBitCast(Ends[j], PtrArithTy0, "bc"); 11557206d7a5SAdam Nemet 11567206d7a5SAdam Nemet Value *Cmp0 = ChkBuilder.CreateICmpULE(Start0, End1, "bound0"); 11577206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, Cmp0, Loc); 11587206d7a5SAdam Nemet Value *Cmp1 = ChkBuilder.CreateICmpULE(Start1, End0, "bound1"); 11597206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, Cmp1, Loc); 11607206d7a5SAdam Nemet Value *IsConflict = ChkBuilder.CreateAnd(Cmp0, Cmp1, "found.conflict"); 11617206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, IsConflict, Loc); 11627206d7a5SAdam Nemet if (MemoryRuntimeCheck) { 11637206d7a5SAdam Nemet IsConflict = ChkBuilder.CreateOr(MemoryRuntimeCheck, IsConflict, 11647206d7a5SAdam Nemet "conflict.rdx"); 11657206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, IsConflict, Loc); 11667206d7a5SAdam Nemet } 11677206d7a5SAdam Nemet MemoryRuntimeCheck = IsConflict; 11687206d7a5SAdam Nemet } 11697206d7a5SAdam Nemet } 11707206d7a5SAdam Nemet 11717206d7a5SAdam Nemet // We have to do this trickery because the IRBuilder might fold the check to a 11727206d7a5SAdam Nemet // constant expression in which case there is no Instruction anchored in a 11737206d7a5SAdam Nemet // the block. 11747206d7a5SAdam Nemet Instruction *Check = BinaryOperator::CreateAnd(MemoryRuntimeCheck, 11757206d7a5SAdam Nemet ConstantInt::getTrue(Ctx)); 11767206d7a5SAdam Nemet ChkBuilder.Insert(Check, "memcheck.conflict"); 11777206d7a5SAdam Nemet FirstInst = getFirstInst(FirstInst, Check, Loc); 11787206d7a5SAdam Nemet return std::make_pair(FirstInst, Check); 11797206d7a5SAdam Nemet } 11803bfd93d7SAdam Nemet 11813bfd93d7SAdam Nemet LoopAccessInfo::LoopAccessInfo(Loop *L, ScalarEvolution *SE, 1182a28d91d8SMehdi Amini const DataLayout &DL, 11833bfd93d7SAdam Nemet const TargetLibraryInfo *TLI, AliasAnalysis *AA, 11848bc61df9SAdam Nemet DominatorTree *DT, 11858bc61df9SAdam Nemet const ValueToValueMap &Strides) 1186*dee666bcSAdam Nemet : DepChecker(SE, L), TheLoop(L), SE(SE), DL(DL), TLI(TLI), AA(AA), 1187*dee666bcSAdam Nemet DT(DT), NumLoads(0), NumStores(0), MaxSafeDepDistBytes(-1U), 1188*dee666bcSAdam Nemet CanVecMem(false) { 1189929c38e8SAdam Nemet if (canAnalyzeLoop()) 11903bfd93d7SAdam Nemet analyzeLoop(Strides); 11913bfd93d7SAdam Nemet } 11923bfd93d7SAdam Nemet 1193e91cc6efSAdam Nemet void LoopAccessInfo::print(raw_ostream &OS, unsigned Depth) const { 1194e91cc6efSAdam Nemet if (CanVecMem) { 1195e91cc6efSAdam Nemet if (PtrRtCheck.empty()) 1196e91cc6efSAdam Nemet OS.indent(Depth) << "Memory dependences are safe\n"; 1197e91cc6efSAdam Nemet else 1198e91cc6efSAdam Nemet OS.indent(Depth) << "Memory dependences are safe with run-time checks\n"; 1199e91cc6efSAdam Nemet } 1200e91cc6efSAdam Nemet 1201e91cc6efSAdam Nemet if (Report) 1202e91cc6efSAdam Nemet OS.indent(Depth) << "Report: " << Report->str() << "\n"; 1203e91cc6efSAdam Nemet 1204e91cc6efSAdam Nemet // FIXME: Print unsafe dependences 1205e91cc6efSAdam Nemet 1206e91cc6efSAdam Nemet // List the pair of accesses need run-time checks to prove independence. 1207e91cc6efSAdam Nemet PtrRtCheck.print(OS, Depth); 1208e91cc6efSAdam Nemet OS << "\n"; 1209e91cc6efSAdam Nemet } 1210e91cc6efSAdam Nemet 12118bc61df9SAdam Nemet const LoopAccessInfo & 12128bc61df9SAdam Nemet LoopAccessAnalysis::getInfo(Loop *L, const ValueToValueMap &Strides) { 12133bfd93d7SAdam Nemet auto &LAI = LoopAccessInfoMap[L]; 12143bfd93d7SAdam Nemet 12153bfd93d7SAdam Nemet #ifndef NDEBUG 12163bfd93d7SAdam Nemet assert((!LAI || LAI->NumSymbolicStrides == Strides.size()) && 12173bfd93d7SAdam Nemet "Symbolic strides changed for loop"); 12183bfd93d7SAdam Nemet #endif 12193bfd93d7SAdam Nemet 12203bfd93d7SAdam Nemet if (!LAI) { 1221a28d91d8SMehdi Amini const DataLayout &DL = L->getHeader()->getModule()->getDataLayout(); 12223bfd93d7SAdam Nemet LAI = llvm::make_unique<LoopAccessInfo>(L, SE, DL, TLI, AA, DT, Strides); 12233bfd93d7SAdam Nemet #ifndef NDEBUG 12243bfd93d7SAdam Nemet LAI->NumSymbolicStrides = Strides.size(); 12253bfd93d7SAdam Nemet #endif 12263bfd93d7SAdam Nemet } 12273bfd93d7SAdam Nemet return *LAI.get(); 12283bfd93d7SAdam Nemet } 12293bfd93d7SAdam Nemet 1230e91cc6efSAdam Nemet void LoopAccessAnalysis::print(raw_ostream &OS, const Module *M) const { 1231e91cc6efSAdam Nemet LoopAccessAnalysis &LAA = *const_cast<LoopAccessAnalysis *>(this); 1232e91cc6efSAdam Nemet 1233e91cc6efSAdam Nemet LoopInfo *LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo(); 1234e91cc6efSAdam Nemet ValueToValueMap NoSymbolicStrides; 1235e91cc6efSAdam Nemet 1236e91cc6efSAdam Nemet for (Loop *TopLevelLoop : *LI) 1237e91cc6efSAdam Nemet for (Loop *L : depth_first(TopLevelLoop)) { 1238e91cc6efSAdam Nemet OS.indent(2) << L->getHeader()->getName() << ":\n"; 1239e91cc6efSAdam Nemet auto &LAI = LAA.getInfo(L, NoSymbolicStrides); 1240e91cc6efSAdam Nemet LAI.print(OS, 4); 1241e91cc6efSAdam Nemet } 1242e91cc6efSAdam Nemet } 1243e91cc6efSAdam Nemet 12443bfd93d7SAdam Nemet bool LoopAccessAnalysis::runOnFunction(Function &F) { 12453bfd93d7SAdam Nemet SE = &getAnalysis<ScalarEvolution>(); 12463bfd93d7SAdam Nemet auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>(); 12473bfd93d7SAdam Nemet TLI = TLIP ? &TLIP->getTLI() : nullptr; 12483bfd93d7SAdam Nemet AA = &getAnalysis<AliasAnalysis>(); 12493bfd93d7SAdam Nemet DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 12503bfd93d7SAdam Nemet 12513bfd93d7SAdam Nemet return false; 12523bfd93d7SAdam Nemet } 12533bfd93d7SAdam Nemet 12543bfd93d7SAdam Nemet void LoopAccessAnalysis::getAnalysisUsage(AnalysisUsage &AU) const { 12553bfd93d7SAdam Nemet AU.addRequired<ScalarEvolution>(); 12563bfd93d7SAdam Nemet AU.addRequired<AliasAnalysis>(); 12573bfd93d7SAdam Nemet AU.addRequired<DominatorTreeWrapperPass>(); 1258e91cc6efSAdam Nemet AU.addRequired<LoopInfoWrapperPass>(); 12593bfd93d7SAdam Nemet 12603bfd93d7SAdam Nemet AU.setPreservesAll(); 12613bfd93d7SAdam Nemet } 12623bfd93d7SAdam Nemet 12633bfd93d7SAdam Nemet char LoopAccessAnalysis::ID = 0; 12643bfd93d7SAdam Nemet static const char laa_name[] = "Loop Access Analysis"; 12653bfd93d7SAdam Nemet #define LAA_NAME "loop-accesses" 12663bfd93d7SAdam Nemet 12673bfd93d7SAdam Nemet INITIALIZE_PASS_BEGIN(LoopAccessAnalysis, LAA_NAME, laa_name, false, true) 12683bfd93d7SAdam Nemet INITIALIZE_AG_DEPENDENCY(AliasAnalysis) 12693bfd93d7SAdam Nemet INITIALIZE_PASS_DEPENDENCY(ScalarEvolution) 12703bfd93d7SAdam Nemet INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 1271e91cc6efSAdam Nemet INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass) 12723bfd93d7SAdam Nemet INITIALIZE_PASS_END(LoopAccessAnalysis, LAA_NAME, laa_name, false, true) 12733bfd93d7SAdam Nemet 12743bfd93d7SAdam Nemet namespace llvm { 12753bfd93d7SAdam Nemet Pass *createLAAPass() { 12763bfd93d7SAdam Nemet return new LoopAccessAnalysis(); 12773bfd93d7SAdam Nemet } 12783bfd93d7SAdam Nemet } 1279