[LAA] Remove unused pointer partition argument from print(), NFC
[oota-llvm.git] / lib / Analysis / LoopAccessAnalysis.cpp
1 //===- LoopAccessAnalysis.cpp - Loop Access Analysis Implementation --------==//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // The implementation for the loop memory dependence that was originally
11 // developed for the loop vectorizer.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Analysis/LoopAccessAnalysis.h"
16 #include "llvm/Analysis/LoopInfo.h"
17 #include "llvm/Analysis/ScalarEvolutionExpander.h"
18 #include "llvm/Analysis/TargetLibraryInfo.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/IR/DiagnosticInfo.h"
21 #include "llvm/IR/Dominators.h"
22 #include "llvm/IR/IRBuilder.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Analysis/VectorUtils.h"
26 using namespace llvm;
27
28 #define DEBUG_TYPE "loop-accesses"
29
30 static cl::opt<unsigned, true>
31 VectorizationFactor("force-vector-width", cl::Hidden,
32                     cl::desc("Sets the SIMD width. Zero is autoselect."),
33                     cl::location(VectorizerParams::VectorizationFactor));
34 unsigned VectorizerParams::VectorizationFactor;
35
36 static cl::opt<unsigned, true>
37 VectorizationInterleave("force-vector-interleave", cl::Hidden,
38                         cl::desc("Sets the vectorization interleave count. "
39                                  "Zero is autoselect."),
40                         cl::location(
41                             VectorizerParams::VectorizationInterleave));
42 unsigned VectorizerParams::VectorizationInterleave;
43
44 static cl::opt<unsigned, true> RuntimeMemoryCheckThreshold(
45     "runtime-memory-check-threshold", cl::Hidden,
46     cl::desc("When performing memory disambiguation checks at runtime do not "
47              "generate more than this number of comparisons (default = 8)."),
48     cl::location(VectorizerParams::RuntimeMemoryCheckThreshold), cl::init(8));
49 unsigned VectorizerParams::RuntimeMemoryCheckThreshold;
50
51 /// \brief The maximum iterations used to merge memory checks
52 static cl::opt<unsigned> MemoryCheckMergeThreshold(
53     "memory-check-merge-threshold", cl::Hidden,
54     cl::desc("Maximum number of comparisons done when trying to merge "
55              "runtime memory checks. (default = 100)"),
56     cl::init(100));
57
58 /// Maximum SIMD width.
59 const unsigned VectorizerParams::MaxVectorWidth = 64;
60
61 /// \brief We collect interesting dependences up to this threshold.
62 static cl::opt<unsigned> MaxInterestingDependence(
63     "max-interesting-dependences", cl::Hidden,
64     cl::desc("Maximum number of interesting dependences collected by "
65              "loop-access analysis (default = 100)"),
66     cl::init(100));
67
68 bool VectorizerParams::isInterleaveForced() {
69   return ::VectorizationInterleave.getNumOccurrences() > 0;
70 }
71
72 void LoopAccessReport::emitAnalysis(const LoopAccessReport &Message,
73                                     const Function *TheFunction,
74                                     const Loop *TheLoop,
75                                     const char *PassName) {
76   DebugLoc DL = TheLoop->getStartLoc();
77   if (const Instruction *I = Message.getInstr())
78     DL = I->getDebugLoc();
79   emitOptimizationRemarkAnalysis(TheFunction->getContext(), PassName,
80                                  *TheFunction, DL, Message.str());
81 }
82
83 Value *llvm::stripIntegerCast(Value *V) {
84   if (CastInst *CI = dyn_cast<CastInst>(V))
85     if (CI->getOperand(0)->getType()->isIntegerTy())
86       return CI->getOperand(0);
87   return V;
88 }
89
90 const SCEV *llvm::replaceSymbolicStrideSCEV(ScalarEvolution *SE,
91                                             const ValueToValueMap &PtrToStride,
92                                             Value *Ptr, Value *OrigPtr) {
93
94   const SCEV *OrigSCEV = SE->getSCEV(Ptr);
95
96   // If there is an entry in the map return the SCEV of the pointer with the
97   // symbolic stride replaced by one.
98   ValueToValueMap::const_iterator SI =
99       PtrToStride.find(OrigPtr ? OrigPtr : Ptr);
100   if (SI != PtrToStride.end()) {
101     Value *StrideVal = SI->second;
102
103     // Strip casts.
104     StrideVal = stripIntegerCast(StrideVal);
105
106     // Replace symbolic stride by one.
107     Value *One = ConstantInt::get(StrideVal->getType(), 1);
108     ValueToValueMap RewriteMap;
109     RewriteMap[StrideVal] = One;
110
111     const SCEV *ByOne =
112         SCEVParameterRewriter::rewrite(OrigSCEV, *SE, RewriteMap, true);
113     DEBUG(dbgs() << "LAA: Replacing SCEV: " << *OrigSCEV << " by: " << *ByOne
114                  << "\n");
115     return ByOne;
116   }
117
118   // Otherwise, just return the SCEV of the original pointer.
119   return SE->getSCEV(Ptr);
120 }
121
122 void RuntimePointerChecking::insert(Loop *Lp, Value *Ptr, bool WritePtr,
123                                     unsigned DepSetId, unsigned ASId,
124                                     const ValueToValueMap &Strides) {
125   // Get the stride replaced scev.
126   const SCEV *Sc = replaceSymbolicStrideSCEV(SE, Strides, Ptr);
127   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Sc);
128   assert(AR && "Invalid addrec expression");
129   const SCEV *Ex = SE->getBackedgeTakenCount(Lp);
130
131   const SCEV *ScStart = AR->getStart();
132   const SCEV *ScEnd = AR->evaluateAtIteration(Ex, *SE);
133   const SCEV *Step = AR->getStepRecurrence(*SE);
134
135   // For expressions with negative step, the upper bound is ScStart and the
136   // lower bound is ScEnd.
137   if (const SCEVConstant *CStep = dyn_cast<const SCEVConstant>(Step)) {
138     if (CStep->getValue()->isNegative())
139       std::swap(ScStart, ScEnd);
140   } else {
141     // Fallback case: the step is not constant, but the we can still
142     // get the upper and lower bounds of the interval by using min/max
143     // expressions.
144     ScStart = SE->getUMinExpr(ScStart, ScEnd);
145     ScEnd = SE->getUMaxExpr(AR->getStart(), ScEnd);
146   }
147
148   Pointers.emplace_back(Ptr, ScStart, ScEnd, WritePtr, DepSetId, ASId, Sc);
149 }
150
151 SmallVector<RuntimePointerChecking::PointerCheck, 4>
152 RuntimePointerChecking::generateChecks(
153     const SmallVectorImpl<int> *PtrPartition) const {
154   SmallVector<PointerCheck, 4> Checks;
155
156   for (unsigned I = 0; I < CheckingGroups.size(); ++I) {
157     for (unsigned J = I + 1; J < CheckingGroups.size(); ++J) {
158       const RuntimePointerChecking::CheckingPtrGroup &CGI = CheckingGroups[I];
159       const RuntimePointerChecking::CheckingPtrGroup &CGJ = CheckingGroups[J];
160
161       if (needsChecking(CGI, CGJ, PtrPartition))
162         Checks.push_back(std::make_pair(&CGI, &CGJ));
163     }
164   }
165   return Checks;
166 }
167
168 bool RuntimePointerChecking::needsChecking(
169     const CheckingPtrGroup &M, const CheckingPtrGroup &N,
170     const SmallVectorImpl<int> *PtrPartition) const {
171   for (unsigned I = 0, EI = M.Members.size(); EI != I; ++I)
172     for (unsigned J = 0, EJ = N.Members.size(); EJ != J; ++J)
173       if (needsChecking(M.Members[I], N.Members[J], PtrPartition))
174         return true;
175   return false;
176 }
177
178 /// Compare \p I and \p J and return the minimum.
179 /// Return nullptr in case we couldn't find an answer.
180 static const SCEV *getMinFromExprs(const SCEV *I, const SCEV *J,
181                                    ScalarEvolution *SE) {
182   const SCEV *Diff = SE->getMinusSCEV(J, I);
183   const SCEVConstant *C = dyn_cast<const SCEVConstant>(Diff);
184
185   if (!C)
186     return nullptr;
187   if (C->getValue()->isNegative())
188     return J;
189   return I;
190 }
191
192 bool RuntimePointerChecking::CheckingPtrGroup::addPointer(unsigned Index) {
193   const SCEV *Start = RtCheck.Pointers[Index].Start;
194   const SCEV *End = RtCheck.Pointers[Index].End;
195
196   // Compare the starts and ends with the known minimum and maximum
197   // of this set. We need to know how we compare against the min/max
198   // of the set in order to be able to emit memchecks.
199   const SCEV *Min0 = getMinFromExprs(Start, Low, RtCheck.SE);
200   if (!Min0)
201     return false;
202
203   const SCEV *Min1 = getMinFromExprs(End, High, RtCheck.SE);
204   if (!Min1)
205     return false;
206
207   // Update the low bound  expression if we've found a new min value.
208   if (Min0 == Start)
209     Low = Start;
210
211   // Update the high bound expression if we've found a new max value.
212   if (Min1 != End)
213     High = End;
214
215   Members.push_back(Index);
216   return true;
217 }
218
219 void RuntimePointerChecking::groupChecks(
220     MemoryDepChecker::DepCandidates &DepCands, bool UseDependencies) {
221   // We build the groups from dependency candidates equivalence classes
222   // because:
223   //    - We know that pointers in the same equivalence class share
224   //      the same underlying object and therefore there is a chance
225   //      that we can compare pointers
226   //    - We wouldn't be able to merge two pointers for which we need
227   //      to emit a memcheck. The classes in DepCands are already
228   //      conveniently built such that no two pointers in the same
229   //      class need checking against each other.
230
231   // We use the following (greedy) algorithm to construct the groups
232   // For every pointer in the equivalence class:
233   //   For each existing group:
234   //   - if the difference between this pointer and the min/max bounds
235   //     of the group is a constant, then make the pointer part of the
236   //     group and update the min/max bounds of that group as required.
237
238   CheckingGroups.clear();
239
240   // If we need to check two pointers to the same underlying object
241   // with a non-constant difference, we shouldn't perform any pointer
242   // grouping with those pointers. This is because we can easily get
243   // into cases where the resulting check would return false, even when
244   // the accesses are safe.
245   //
246   // The following example shows this:
247   // for (i = 0; i < 1000; ++i)
248   //   a[5000 + i * m] = a[i] + a[i + 9000]
249   //
250   // Here grouping gives a check of (5000, 5000 + 1000 * m) against
251   // (0, 10000) which is always false. However, if m is 1, there is no
252   // dependence. Not grouping the checks for a[i] and a[i + 9000] allows
253   // us to perform an accurate check in this case.
254   //
255   // The above case requires that we have an UnknownDependence between
256   // accesses to the same underlying object. This cannot happen unless
257   // ShouldRetryWithRuntimeCheck is set, and therefore UseDependencies
258   // is also false. In this case we will use the fallback path and create
259   // separate checking groups for all pointers.
260  
261   // If we don't have the dependency partitions, construct a new
262   // checking pointer group for each pointer. This is also required
263   // for correctness, because in this case we can have checking between
264   // pointers to the same underlying object.
265   if (!UseDependencies) {
266     for (unsigned I = 0; I < Pointers.size(); ++I)
267       CheckingGroups.push_back(CheckingPtrGroup(I, *this));
268     return;
269   }
270
271   unsigned TotalComparisons = 0;
272
273   DenseMap<Value *, unsigned> PositionMap;
274   for (unsigned Index = 0; Index < Pointers.size(); ++Index)
275     PositionMap[Pointers[Index].PointerValue] = Index;
276
277   // We need to keep track of what pointers we've already seen so we
278   // don't process them twice.
279   SmallSet<unsigned, 2> Seen;
280
281   // Go through all equivalence classes, get the the "pointer check groups"
282   // and add them to the overall solution. We use the order in which accesses
283   // appear in 'Pointers' to enforce determinism.
284   for (unsigned I = 0; I < Pointers.size(); ++I) {
285     // We've seen this pointer before, and therefore already processed
286     // its equivalence class.
287     if (Seen.count(I))
288       continue;
289
290     MemoryDepChecker::MemAccessInfo Access(Pointers[I].PointerValue,
291                                            Pointers[I].IsWritePtr);
292
293     SmallVector<CheckingPtrGroup, 2> Groups;
294     auto LeaderI = DepCands.findValue(DepCands.getLeaderValue(Access));
295
296     // Because DepCands is constructed by visiting accesses in the order in
297     // which they appear in alias sets (which is deterministic) and the
298     // iteration order within an equivalence class member is only dependent on
299     // the order in which unions and insertions are performed on the
300     // equivalence class, the iteration order is deterministic.
301     for (auto MI = DepCands.member_begin(LeaderI), ME = DepCands.member_end();
302          MI != ME; ++MI) {
303       unsigned Pointer = PositionMap[MI->getPointer()];
304       bool Merged = false;
305       // Mark this pointer as seen.
306       Seen.insert(Pointer);
307
308       // Go through all the existing sets and see if we can find one
309       // which can include this pointer.
310       for (CheckingPtrGroup &Group : Groups) {
311         // Don't perform more than a certain amount of comparisons.
312         // This should limit the cost of grouping the pointers to something
313         // reasonable.  If we do end up hitting this threshold, the algorithm
314         // will create separate groups for all remaining pointers.
315         if (TotalComparisons > MemoryCheckMergeThreshold)
316           break;
317
318         TotalComparisons++;
319
320         if (Group.addPointer(Pointer)) {
321           Merged = true;
322           break;
323         }
324       }
325
326       if (!Merged)
327         // We couldn't add this pointer to any existing set or the threshold
328         // for the number of comparisons has been reached. Create a new group
329         // to hold the current pointer.
330         Groups.push_back(CheckingPtrGroup(Pointer, *this));
331     }
332
333     // We've computed the grouped checks for this partition.
334     // Save the results and continue with the next one.
335     std::copy(Groups.begin(), Groups.end(), std::back_inserter(CheckingGroups));
336   }
337 }
338
339 bool RuntimePointerChecking::arePointersInSamePartition(
340     const SmallVectorImpl<int> &PtrToPartition, unsigned PtrIdx1,
341     unsigned PtrIdx2) {
342   return (PtrToPartition[PtrIdx1] != -1 &&
343           PtrToPartition[PtrIdx1] == PtrToPartition[PtrIdx2]);
344 }
345
346 bool RuntimePointerChecking::needsChecking(
347     unsigned I, unsigned J, const SmallVectorImpl<int> *PtrPartition) const {
348   const PointerInfo &PointerI = Pointers[I];
349   const PointerInfo &PointerJ = Pointers[J];
350
351   // No need to check if two readonly pointers intersect.
352   if (!PointerI.IsWritePtr && !PointerJ.IsWritePtr)
353     return false;
354
355   // Only need to check pointers between two different dependency sets.
356   if (PointerI.DependencySetId == PointerJ.DependencySetId)
357     return false;
358
359   // Only need to check pointers in the same alias set.
360   if (PointerI.AliasSetId != PointerJ.AliasSetId)
361     return false;
362
363   // If PtrPartition is set omit checks between pointers of the same partition.
364   if (PtrPartition && arePointersInSamePartition(*PtrPartition, I, J))
365     return false;
366
367   return true;
368 }
369
370 void RuntimePointerChecking::printChecks(
371     raw_ostream &OS, const SmallVectorImpl<PointerCheck> &Checks,
372     unsigned Depth) const {
373   unsigned N = 0;
374   for (const auto &Check : Checks) {
375     const auto &First = Check.first->Members, &Second = Check.second->Members;
376
377     OS.indent(Depth) << "Check " << N++ << ":\n";
378
379     OS.indent(Depth + 2) << "Comparing group (" << Check.first << "):\n";
380     for (unsigned K = 0; K < First.size(); ++K)
381       OS.indent(Depth + 2) << *Pointers[First[K]].PointerValue << "\n";
382
383     OS.indent(Depth + 2) << "Against group (" << Check.second << "):\n";
384     for (unsigned K = 0; K < Second.size(); ++K)
385       OS.indent(Depth + 2) << *Pointers[Second[K]].PointerValue << "\n";
386   }
387 }
388
389 void RuntimePointerChecking::print(raw_ostream &OS, unsigned Depth) const {
390
391   OS.indent(Depth) << "Run-time memory checks:\n";
392   printChecks(OS, generateChecks(), Depth);
393
394   OS.indent(Depth) << "Grouped accesses:\n";
395   for (unsigned I = 0; I < CheckingGroups.size(); ++I) {
396     const auto &CG = CheckingGroups[I];
397
398     OS.indent(Depth + 2) << "Group " << &CG << ":\n";
399     OS.indent(Depth + 4) << "(Low: " << *CG.Low << " High: " << *CG.High
400                          << ")\n";
401     for (unsigned J = 0; J < CG.Members.size(); ++J) {
402       OS.indent(Depth + 6) << "Member: " << *Pointers[CG.Members[J]].Expr
403                            << "\n";
404     }
405   }
406 }
407
408 unsigned RuntimePointerChecking::getNumberOfChecks(
409     const SmallVectorImpl<int> *PtrPartition) const {
410
411   unsigned NumPartitions = CheckingGroups.size();
412   unsigned CheckCount = 0;
413
414   for (unsigned I = 0; I < NumPartitions; ++I)
415     for (unsigned J = I + 1; J < NumPartitions; ++J)
416       if (needsChecking(CheckingGroups[I], CheckingGroups[J], PtrPartition))
417         CheckCount++;
418   return CheckCount;
419 }
420
421 namespace {
422 /// \brief Analyses memory accesses in a loop.
423 ///
424 /// Checks whether run time pointer checks are needed and builds sets for data
425 /// dependence checking.
426 class AccessAnalysis {
427 public:
428   /// \brief Read or write access location.
429   typedef PointerIntPair<Value *, 1, bool> MemAccessInfo;
430   typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet;
431
432   AccessAnalysis(const DataLayout &Dl, AliasAnalysis *AA, LoopInfo *LI,
433                  MemoryDepChecker::DepCandidates &DA)
434       : DL(Dl), AST(*AA), LI(LI), DepCands(DA),
435         IsRTCheckAnalysisNeeded(false) {}
436
437   /// \brief Register a load  and whether it is only read from.
438   void addLoad(MemoryLocation &Loc, bool IsReadOnly) {
439     Value *Ptr = const_cast<Value*>(Loc.Ptr);
440     AST.add(Ptr, MemoryLocation::UnknownSize, Loc.AATags);
441     Accesses.insert(MemAccessInfo(Ptr, false));
442     if (IsReadOnly)
443       ReadOnlyPtr.insert(Ptr);
444   }
445
446   /// \brief Register a store.
447   void addStore(MemoryLocation &Loc) {
448     Value *Ptr = const_cast<Value*>(Loc.Ptr);
449     AST.add(Ptr, MemoryLocation::UnknownSize, Loc.AATags);
450     Accesses.insert(MemAccessInfo(Ptr, true));
451   }
452
453   /// \brief Check whether we can check the pointers at runtime for
454   /// non-intersection.
455   ///
456   /// Returns true if we need no check or if we do and we can generate them
457   /// (i.e. the pointers have computable bounds).
458   bool canCheckPtrAtRT(RuntimePointerChecking &RtCheck, ScalarEvolution *SE,
459                        Loop *TheLoop, const ValueToValueMap &Strides,
460                        bool ShouldCheckStride = false);
461
462   /// \brief Goes over all memory accesses, checks whether a RT check is needed
463   /// and builds sets of dependent accesses.
464   void buildDependenceSets() {
465     processMemAccesses();
466   }
467
468   /// \brief Initial processing of memory accesses determined that we need to
469   /// perform dependency checking.
470   ///
471   /// Note that this can later be cleared if we retry memcheck analysis without
472   /// dependency checking (i.e. ShouldRetryWithRuntimeCheck).
473   bool isDependencyCheckNeeded() { return !CheckDeps.empty(); }
474
475   /// We decided that no dependence analysis would be used.  Reset the state.
476   void resetDepChecks(MemoryDepChecker &DepChecker) {
477     CheckDeps.clear();
478     DepChecker.clearInterestingDependences();
479   }
480
481   MemAccessInfoSet &getDependenciesToCheck() { return CheckDeps; }
482
483 private:
484   typedef SetVector<MemAccessInfo> PtrAccessSet;
485
486   /// \brief Go over all memory access and check whether runtime pointer checks
487   /// are needed and build sets of dependency check candidates.
488   void processMemAccesses();
489
490   /// Set of all accesses.
491   PtrAccessSet Accesses;
492
493   const DataLayout &DL;
494
495   /// Set of accesses that need a further dependence check.
496   MemAccessInfoSet CheckDeps;
497
498   /// Set of pointers that are read only.
499   SmallPtrSet<Value*, 16> ReadOnlyPtr;
500
501   /// An alias set tracker to partition the access set by underlying object and
502   //intrinsic property (such as TBAA metadata).
503   AliasSetTracker AST;
504
505   LoopInfo *LI;
506
507   /// Sets of potentially dependent accesses - members of one set share an
508   /// underlying pointer. The set "CheckDeps" identfies which sets really need a
509   /// dependence check.
510   MemoryDepChecker::DepCandidates &DepCands;
511
512   /// \brief Initial processing of memory accesses determined that we may need
513   /// to add memchecks.  Perform the analysis to determine the necessary checks.
514   ///
515   /// Note that, this is different from isDependencyCheckNeeded.  When we retry
516   /// memcheck analysis without dependency checking
517   /// (i.e. ShouldRetryWithRuntimeCheck), isDependencyCheckNeeded is cleared
518   /// while this remains set if we have potentially dependent accesses.
519   bool IsRTCheckAnalysisNeeded;
520 };
521
522 } // end anonymous namespace
523
524 /// \brief Check whether a pointer can participate in a runtime bounds check.
525 static bool hasComputableBounds(ScalarEvolution *SE,
526                                 const ValueToValueMap &Strides, Value *Ptr) {
527   const SCEV *PtrScev = replaceSymbolicStrideSCEV(SE, Strides, Ptr);
528   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
529   if (!AR)
530     return false;
531
532   return AR->isAffine();
533 }
534
535 bool AccessAnalysis::canCheckPtrAtRT(RuntimePointerChecking &RtCheck,
536                                      ScalarEvolution *SE, Loop *TheLoop,
537                                      const ValueToValueMap &StridesMap,
538                                      bool ShouldCheckStride) {
539   // Find pointers with computable bounds. We are going to use this information
540   // to place a runtime bound check.
541   bool CanDoRT = true;
542
543   bool NeedRTCheck = false;
544   if (!IsRTCheckAnalysisNeeded) return true;
545
546   bool IsDepCheckNeeded = isDependencyCheckNeeded();
547
548   // We assign a consecutive id to access from different alias sets.
549   // Accesses between different groups doesn't need to be checked.
550   unsigned ASId = 1;
551   for (auto &AS : AST) {
552     int NumReadPtrChecks = 0;
553     int NumWritePtrChecks = 0;
554
555     // We assign consecutive id to access from different dependence sets.
556     // Accesses within the same set don't need a runtime check.
557     unsigned RunningDepId = 1;
558     DenseMap<Value *, unsigned> DepSetId;
559
560     for (auto A : AS) {
561       Value *Ptr = A.getValue();
562       bool IsWrite = Accesses.count(MemAccessInfo(Ptr, true));
563       MemAccessInfo Access(Ptr, IsWrite);
564
565       if (IsWrite)
566         ++NumWritePtrChecks;
567       else
568         ++NumReadPtrChecks;
569
570       if (hasComputableBounds(SE, StridesMap, Ptr) &&
571           // When we run after a failing dependency check we have to make sure
572           // we don't have wrapping pointers.
573           (!ShouldCheckStride ||
574            isStridedPtr(SE, Ptr, TheLoop, StridesMap) == 1)) {
575         // The id of the dependence set.
576         unsigned DepId;
577
578         if (IsDepCheckNeeded) {
579           Value *Leader = DepCands.getLeaderValue(Access).getPointer();
580           unsigned &LeaderId = DepSetId[Leader];
581           if (!LeaderId)
582             LeaderId = RunningDepId++;
583           DepId = LeaderId;
584         } else
585           // Each access has its own dependence set.
586           DepId = RunningDepId++;
587
588         RtCheck.insert(TheLoop, Ptr, IsWrite, DepId, ASId, StridesMap);
589
590         DEBUG(dbgs() << "LAA: Found a runtime check ptr:" << *Ptr << '\n');
591       } else {
592         DEBUG(dbgs() << "LAA: Can't find bounds for ptr:" << *Ptr << '\n');
593         CanDoRT = false;
594       }
595     }
596
597     // If we have at least two writes or one write and a read then we need to
598     // check them.  But there is no need to checks if there is only one
599     // dependence set for this alias set.
600     //
601     // Note that this function computes CanDoRT and NeedRTCheck independently.
602     // For example CanDoRT=false, NeedRTCheck=false means that we have a pointer
603     // for which we couldn't find the bounds but we don't actually need to emit
604     // any checks so it does not matter.
605     if (!(IsDepCheckNeeded && CanDoRT && RunningDepId == 2))
606       NeedRTCheck |= (NumWritePtrChecks >= 2 || (NumReadPtrChecks >= 1 &&
607                                                  NumWritePtrChecks >= 1));
608
609     ++ASId;
610   }
611
612   // If the pointers that we would use for the bounds comparison have different
613   // address spaces, assume the values aren't directly comparable, so we can't
614   // use them for the runtime check. We also have to assume they could
615   // overlap. In the future there should be metadata for whether address spaces
616   // are disjoint.
617   unsigned NumPointers = RtCheck.Pointers.size();
618   for (unsigned i = 0; i < NumPointers; ++i) {
619     for (unsigned j = i + 1; j < NumPointers; ++j) {
620       // Only need to check pointers between two different dependency sets.
621       if (RtCheck.Pointers[i].DependencySetId ==
622           RtCheck.Pointers[j].DependencySetId)
623        continue;
624       // Only need to check pointers in the same alias set.
625       if (RtCheck.Pointers[i].AliasSetId != RtCheck.Pointers[j].AliasSetId)
626         continue;
627
628       Value *PtrI = RtCheck.Pointers[i].PointerValue;
629       Value *PtrJ = RtCheck.Pointers[j].PointerValue;
630
631       unsigned ASi = PtrI->getType()->getPointerAddressSpace();
632       unsigned ASj = PtrJ->getType()->getPointerAddressSpace();
633       if (ASi != ASj) {
634         DEBUG(dbgs() << "LAA: Runtime check would require comparison between"
635                        " different address spaces\n");
636         return false;
637       }
638     }
639   }
640
641   if (NeedRTCheck && CanDoRT)
642     RtCheck.groupChecks(DepCands, IsDepCheckNeeded);
643
644   DEBUG(dbgs() << "LAA: We need to do " << RtCheck.getNumberOfChecks(nullptr)
645                << " pointer comparisons.\n");
646
647   RtCheck.Need = NeedRTCheck;
648
649   bool CanDoRTIfNeeded = !NeedRTCheck || CanDoRT;
650   if (!CanDoRTIfNeeded)
651     RtCheck.reset();
652   return CanDoRTIfNeeded;
653 }
654
655 void AccessAnalysis::processMemAccesses() {
656   // We process the set twice: first we process read-write pointers, last we
657   // process read-only pointers. This allows us to skip dependence tests for
658   // read-only pointers.
659
660   DEBUG(dbgs() << "LAA: Processing memory accesses...\n");
661   DEBUG(dbgs() << "  AST: "; AST.dump());
662   DEBUG(dbgs() << "LAA:   Accesses(" << Accesses.size() << "):\n");
663   DEBUG({
664     for (auto A : Accesses)
665       dbgs() << "\t" << *A.getPointer() << " (" <<
666                 (A.getInt() ? "write" : (ReadOnlyPtr.count(A.getPointer()) ?
667                                          "read-only" : "read")) << ")\n";
668   });
669
670   // The AliasSetTracker has nicely partitioned our pointers by metadata
671   // compatibility and potential for underlying-object overlap. As a result, we
672   // only need to check for potential pointer dependencies within each alias
673   // set.
674   for (auto &AS : AST) {
675     // Note that both the alias-set tracker and the alias sets themselves used
676     // linked lists internally and so the iteration order here is deterministic
677     // (matching the original instruction order within each set).
678
679     bool SetHasWrite = false;
680
681     // Map of pointers to last access encountered.
682     typedef DenseMap<Value*, MemAccessInfo> UnderlyingObjToAccessMap;
683     UnderlyingObjToAccessMap ObjToLastAccess;
684
685     // Set of access to check after all writes have been processed.
686     PtrAccessSet DeferredAccesses;
687
688     // Iterate over each alias set twice, once to process read/write pointers,
689     // and then to process read-only pointers.
690     for (int SetIteration = 0; SetIteration < 2; ++SetIteration) {
691       bool UseDeferred = SetIteration > 0;
692       PtrAccessSet &S = UseDeferred ? DeferredAccesses : Accesses;
693
694       for (auto AV : AS) {
695         Value *Ptr = AV.getValue();
696
697         // For a single memory access in AliasSetTracker, Accesses may contain
698         // both read and write, and they both need to be handled for CheckDeps.
699         for (auto AC : S) {
700           if (AC.getPointer() != Ptr)
701             continue;
702
703           bool IsWrite = AC.getInt();
704
705           // If we're using the deferred access set, then it contains only
706           // reads.
707           bool IsReadOnlyPtr = ReadOnlyPtr.count(Ptr) && !IsWrite;
708           if (UseDeferred && !IsReadOnlyPtr)
709             continue;
710           // Otherwise, the pointer must be in the PtrAccessSet, either as a
711           // read or a write.
712           assert(((IsReadOnlyPtr && UseDeferred) || IsWrite ||
713                   S.count(MemAccessInfo(Ptr, false))) &&
714                  "Alias-set pointer not in the access set?");
715
716           MemAccessInfo Access(Ptr, IsWrite);
717           DepCands.insert(Access);
718
719           // Memorize read-only pointers for later processing and skip them in
720           // the first round (they need to be checked after we have seen all
721           // write pointers). Note: we also mark pointer that are not
722           // consecutive as "read-only" pointers (so that we check
723           // "a[b[i]] +="). Hence, we need the second check for "!IsWrite".
724           if (!UseDeferred && IsReadOnlyPtr) {
725             DeferredAccesses.insert(Access);
726             continue;
727           }
728
729           // If this is a write - check other reads and writes for conflicts. If
730           // this is a read only check other writes for conflicts (but only if
731           // there is no other write to the ptr - this is an optimization to
732           // catch "a[i] = a[i] + " without having to do a dependence check).
733           if ((IsWrite || IsReadOnlyPtr) && SetHasWrite) {
734             CheckDeps.insert(Access);
735             IsRTCheckAnalysisNeeded = true;
736           }
737
738           if (IsWrite)
739             SetHasWrite = true;
740
741           // Create sets of pointers connected by a shared alias set and
742           // underlying object.
743           typedef SmallVector<Value *, 16> ValueVector;
744           ValueVector TempObjects;
745
746           GetUnderlyingObjects(Ptr, TempObjects, DL, LI);
747           DEBUG(dbgs() << "Underlying objects for pointer " << *Ptr << "\n");
748           for (Value *UnderlyingObj : TempObjects) {
749             UnderlyingObjToAccessMap::iterator Prev =
750                 ObjToLastAccess.find(UnderlyingObj);
751             if (Prev != ObjToLastAccess.end())
752               DepCands.unionSets(Access, Prev->second);
753
754             ObjToLastAccess[UnderlyingObj] = Access;
755             DEBUG(dbgs() << "  " << *UnderlyingObj << "\n");
756           }
757         }
758       }
759     }
760   }
761 }
762
763 static bool isInBoundsGep(Value *Ptr) {
764   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr))
765     return GEP->isInBounds();
766   return false;
767 }
768
769 /// \brief Return true if an AddRec pointer \p Ptr is unsigned non-wrapping,
770 /// i.e. monotonically increasing/decreasing.
771 static bool isNoWrapAddRec(Value *Ptr, const SCEVAddRecExpr *AR,
772                            ScalarEvolution *SE, const Loop *L) {
773   // FIXME: This should probably only return true for NUW.
774   if (AR->getNoWrapFlags(SCEV::NoWrapMask))
775     return true;
776
777   // Scalar evolution does not propagate the non-wrapping flags to values that
778   // are derived from a non-wrapping induction variable because non-wrapping
779   // could be flow-sensitive.
780   //
781   // Look through the potentially overflowing instruction to try to prove
782   // non-wrapping for the *specific* value of Ptr.
783
784   // The arithmetic implied by an inbounds GEP can't overflow.
785   auto *GEP = dyn_cast<GetElementPtrInst>(Ptr);
786   if (!GEP || !GEP->isInBounds())
787     return false;
788
789   // Make sure there is only one non-const index and analyze that.
790   Value *NonConstIndex = nullptr;
791   for (auto Index = GEP->idx_begin(); Index != GEP->idx_end(); ++Index)
792     if (!isa<ConstantInt>(*Index)) {
793       if (NonConstIndex)
794         return false;
795       NonConstIndex = *Index;
796     }
797   if (!NonConstIndex)
798     // The recurrence is on the pointer, ignore for now.
799     return false;
800
801   // The index in GEP is signed.  It is non-wrapping if it's derived from a NSW
802   // AddRec using a NSW operation.
803   if (auto *OBO = dyn_cast<OverflowingBinaryOperator>(NonConstIndex))
804     if (OBO->hasNoSignedWrap() &&
805         // Assume constant for other the operand so that the AddRec can be
806         // easily found.
807         isa<ConstantInt>(OBO->getOperand(1))) {
808       auto *OpScev = SE->getSCEV(OBO->getOperand(0));
809
810       if (auto *OpAR = dyn_cast<SCEVAddRecExpr>(OpScev))
811         return OpAR->getLoop() == L && OpAR->getNoWrapFlags(SCEV::FlagNSW);
812     }
813
814   return false;
815 }
816
817 /// \brief Check whether the access through \p Ptr has a constant stride.
818 int llvm::isStridedPtr(ScalarEvolution *SE, Value *Ptr, const Loop *Lp,
819                        const ValueToValueMap &StridesMap) {
820   Type *Ty = Ptr->getType();
821   assert(Ty->isPointerTy() && "Unexpected non-ptr");
822
823   // Make sure that the pointer does not point to aggregate types.
824   auto *PtrTy = cast<PointerType>(Ty);
825   if (PtrTy->getElementType()->isAggregateType()) {
826     DEBUG(dbgs() << "LAA: Bad stride - Not a pointer to a scalar type"
827           << *Ptr << "\n");
828     return 0;
829   }
830
831   const SCEV *PtrScev = replaceSymbolicStrideSCEV(SE, StridesMap, Ptr);
832
833   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
834   if (!AR) {
835     DEBUG(dbgs() << "LAA: Bad stride - Not an AddRecExpr pointer "
836           << *Ptr << " SCEV: " << *PtrScev << "\n");
837     return 0;
838   }
839
840   // The accesss function must stride over the innermost loop.
841   if (Lp != AR->getLoop()) {
842     DEBUG(dbgs() << "LAA: Bad stride - Not striding over innermost loop " <<
843           *Ptr << " SCEV: " << *PtrScev << "\n");
844   }
845
846   // The address calculation must not wrap. Otherwise, a dependence could be
847   // inverted.
848   // An inbounds getelementptr that is a AddRec with a unit stride
849   // cannot wrap per definition. The unit stride requirement is checked later.
850   // An getelementptr without an inbounds attribute and unit stride would have
851   // to access the pointer value "0" which is undefined behavior in address
852   // space 0, therefore we can also vectorize this case.
853   bool IsInBoundsGEP = isInBoundsGep(Ptr);
854   bool IsNoWrapAddRec = isNoWrapAddRec(Ptr, AR, SE, Lp);
855   bool IsInAddressSpaceZero = PtrTy->getAddressSpace() == 0;
856   if (!IsNoWrapAddRec && !IsInBoundsGEP && !IsInAddressSpaceZero) {
857     DEBUG(dbgs() << "LAA: Bad stride - Pointer may wrap in the address space "
858           << *Ptr << " SCEV: " << *PtrScev << "\n");
859     return 0;
860   }
861
862   // Check the step is constant.
863   const SCEV *Step = AR->getStepRecurrence(*SE);
864
865   // Calculate the pointer stride and check if it is constant.
866   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
867   if (!C) {
868     DEBUG(dbgs() << "LAA: Bad stride - Not a constant strided " << *Ptr <<
869           " SCEV: " << *PtrScev << "\n");
870     return 0;
871   }
872
873   auto &DL = Lp->getHeader()->getModule()->getDataLayout();
874   int64_t Size = DL.getTypeAllocSize(PtrTy->getElementType());
875   const APInt &APStepVal = C->getValue()->getValue();
876
877   // Huge step value - give up.
878   if (APStepVal.getBitWidth() > 64)
879     return 0;
880
881   int64_t StepVal = APStepVal.getSExtValue();
882
883   // Strided access.
884   int64_t Stride = StepVal / Size;
885   int64_t Rem = StepVal % Size;
886   if (Rem)
887     return 0;
888
889   // If the SCEV could wrap but we have an inbounds gep with a unit stride we
890   // know we can't "wrap around the address space". In case of address space
891   // zero we know that this won't happen without triggering undefined behavior.
892   if (!IsNoWrapAddRec && (IsInBoundsGEP || IsInAddressSpaceZero) &&
893       Stride != 1 && Stride != -1)
894     return 0;
895
896   return Stride;
897 }
898
899 bool MemoryDepChecker::Dependence::isSafeForVectorization(DepType Type) {
900   switch (Type) {
901   case NoDep:
902   case Forward:
903   case BackwardVectorizable:
904     return true;
905
906   case Unknown:
907   case ForwardButPreventsForwarding:
908   case Backward:
909   case BackwardVectorizableButPreventsForwarding:
910     return false;
911   }
912   llvm_unreachable("unexpected DepType!");
913 }
914
915 bool MemoryDepChecker::Dependence::isInterestingDependence(DepType Type) {
916   switch (Type) {
917   case NoDep:
918   case Forward:
919     return false;
920
921   case BackwardVectorizable:
922   case Unknown:
923   case ForwardButPreventsForwarding:
924   case Backward:
925   case BackwardVectorizableButPreventsForwarding:
926     return true;
927   }
928   llvm_unreachable("unexpected DepType!");
929 }
930
931 bool MemoryDepChecker::Dependence::isPossiblyBackward() const {
932   switch (Type) {
933   case NoDep:
934   case Forward:
935   case ForwardButPreventsForwarding:
936     return false;
937
938   case Unknown:
939   case BackwardVectorizable:
940   case Backward:
941   case BackwardVectorizableButPreventsForwarding:
942     return true;
943   }
944   llvm_unreachable("unexpected DepType!");
945 }
946
947 bool MemoryDepChecker::couldPreventStoreLoadForward(unsigned Distance,
948                                                     unsigned TypeByteSize) {
949   // If loads occur at a distance that is not a multiple of a feasible vector
950   // factor store-load forwarding does not take place.
951   // Positive dependences might cause troubles because vectorizing them might
952   // prevent store-load forwarding making vectorized code run a lot slower.
953   //   a[i] = a[i-3] ^ a[i-8];
954   //   The stores to a[i:i+1] don't align with the stores to a[i-3:i-2] and
955   //   hence on your typical architecture store-load forwarding does not take
956   //   place. Vectorizing in such cases does not make sense.
957   // Store-load forwarding distance.
958   const unsigned NumCyclesForStoreLoadThroughMemory = 8*TypeByteSize;
959   // Maximum vector factor.
960   unsigned MaxVFWithoutSLForwardIssues =
961     VectorizerParams::MaxVectorWidth * TypeByteSize;
962   if(MaxSafeDepDistBytes < MaxVFWithoutSLForwardIssues)
963     MaxVFWithoutSLForwardIssues = MaxSafeDepDistBytes;
964
965   for (unsigned vf = 2*TypeByteSize; vf <= MaxVFWithoutSLForwardIssues;
966        vf *= 2) {
967     if (Distance % vf && Distance / vf < NumCyclesForStoreLoadThroughMemory) {
968       MaxVFWithoutSLForwardIssues = (vf >>=1);
969       break;
970     }
971   }
972
973   if (MaxVFWithoutSLForwardIssues< 2*TypeByteSize) {
974     DEBUG(dbgs() << "LAA: Distance " << Distance <<
975           " that could cause a store-load forwarding conflict\n");
976     return true;
977   }
978
979   if (MaxVFWithoutSLForwardIssues < MaxSafeDepDistBytes &&
980       MaxVFWithoutSLForwardIssues !=
981       VectorizerParams::MaxVectorWidth * TypeByteSize)
982     MaxSafeDepDistBytes = MaxVFWithoutSLForwardIssues;
983   return false;
984 }
985
986 /// \brief Check the dependence for two accesses with the same stride \p Stride.
987 /// \p Distance is the positive distance and \p TypeByteSize is type size in
988 /// bytes.
989 ///
990 /// \returns true if they are independent.
991 static bool areStridedAccessesIndependent(unsigned Distance, unsigned Stride,
992                                           unsigned TypeByteSize) {
993   assert(Stride > 1 && "The stride must be greater than 1");
994   assert(TypeByteSize > 0 && "The type size in byte must be non-zero");
995   assert(Distance > 0 && "The distance must be non-zero");
996
997   // Skip if the distance is not multiple of type byte size.
998   if (Distance % TypeByteSize)
999     return false;
1000
1001   unsigned ScaledDist = Distance / TypeByteSize;
1002
1003   // No dependence if the scaled distance is not multiple of the stride.
1004   // E.g.
1005   //      for (i = 0; i < 1024 ; i += 4)
1006   //        A[i+2] = A[i] + 1;
1007   //
1008   // Two accesses in memory (scaled distance is 2, stride is 4):
1009   //     | A[0] |      |      |      | A[4] |      |      |      |
1010   //     |      |      | A[2] |      |      |      | A[6] |      |
1011   //
1012   // E.g.
1013   //      for (i = 0; i < 1024 ; i += 3)
1014   //        A[i+4] = A[i] + 1;
1015   //
1016   // Two accesses in memory (scaled distance is 4, stride is 3):
1017   //     | A[0] |      |      | A[3] |      |      | A[6] |      |      |
1018   //     |      |      |      |      | A[4] |      |      | A[7] |      |
1019   return ScaledDist % Stride;
1020 }
1021
1022 MemoryDepChecker::Dependence::DepType
1023 MemoryDepChecker::isDependent(const MemAccessInfo &A, unsigned AIdx,
1024                               const MemAccessInfo &B, unsigned BIdx,
1025                               const ValueToValueMap &Strides) {
1026   assert (AIdx < BIdx && "Must pass arguments in program order");
1027
1028   Value *APtr = A.getPointer();
1029   Value *BPtr = B.getPointer();
1030   bool AIsWrite = A.getInt();
1031   bool BIsWrite = B.getInt();
1032
1033   // Two reads are independent.
1034   if (!AIsWrite && !BIsWrite)
1035     return Dependence::NoDep;
1036
1037   // We cannot check pointers in different address spaces.
1038   if (APtr->getType()->getPointerAddressSpace() !=
1039       BPtr->getType()->getPointerAddressSpace())
1040     return Dependence::Unknown;
1041
1042   const SCEV *AScev = replaceSymbolicStrideSCEV(SE, Strides, APtr);
1043   const SCEV *BScev = replaceSymbolicStrideSCEV(SE, Strides, BPtr);
1044
1045   int StrideAPtr = isStridedPtr(SE, APtr, InnermostLoop, Strides);
1046   int StrideBPtr = isStridedPtr(SE, BPtr, InnermostLoop, Strides);
1047
1048   const SCEV *Src = AScev;
1049   const SCEV *Sink = BScev;
1050
1051   // If the induction step is negative we have to invert source and sink of the
1052   // dependence.
1053   if (StrideAPtr < 0) {
1054     //Src = BScev;
1055     //Sink = AScev;
1056     std::swap(APtr, BPtr);
1057     std::swap(Src, Sink);
1058     std::swap(AIsWrite, BIsWrite);
1059     std::swap(AIdx, BIdx);
1060     std::swap(StrideAPtr, StrideBPtr);
1061   }
1062
1063   const SCEV *Dist = SE->getMinusSCEV(Sink, Src);
1064
1065   DEBUG(dbgs() << "LAA: Src Scev: " << *Src << "Sink Scev: " << *Sink
1066         << "(Induction step: " << StrideAPtr <<  ")\n");
1067   DEBUG(dbgs() << "LAA: Distance for " << *InstMap[AIdx] << " to "
1068         << *InstMap[BIdx] << ": " << *Dist << "\n");
1069
1070   // Need accesses with constant stride. We don't want to vectorize
1071   // "A[B[i]] += ..." and similar code or pointer arithmetic that could wrap in
1072   // the address space.
1073   if (!StrideAPtr || !StrideBPtr || StrideAPtr != StrideBPtr){
1074     DEBUG(dbgs() << "Pointer access with non-constant stride\n");
1075     return Dependence::Unknown;
1076   }
1077
1078   const SCEVConstant *C = dyn_cast<SCEVConstant>(Dist);
1079   if (!C) {
1080     DEBUG(dbgs() << "LAA: Dependence because of non-constant distance\n");
1081     ShouldRetryWithRuntimeCheck = true;
1082     return Dependence::Unknown;
1083   }
1084
1085   Type *ATy = APtr->getType()->getPointerElementType();
1086   Type *BTy = BPtr->getType()->getPointerElementType();
1087   auto &DL = InnermostLoop->getHeader()->getModule()->getDataLayout();
1088   unsigned TypeByteSize = DL.getTypeAllocSize(ATy);
1089
1090   // Negative distances are not plausible dependencies.
1091   const APInt &Val = C->getValue()->getValue();
1092   if (Val.isNegative()) {
1093     bool IsTrueDataDependence = (AIsWrite && !BIsWrite);
1094     if (IsTrueDataDependence &&
1095         (couldPreventStoreLoadForward(Val.abs().getZExtValue(), TypeByteSize) ||
1096          ATy != BTy))
1097       return Dependence::ForwardButPreventsForwarding;
1098
1099     DEBUG(dbgs() << "LAA: Dependence is negative: NoDep\n");
1100     return Dependence::Forward;
1101   }
1102
1103   // Write to the same location with the same size.
1104   // Could be improved to assert type sizes are the same (i32 == float, etc).
1105   if (Val == 0) {
1106     if (ATy == BTy)
1107       return Dependence::NoDep;
1108     DEBUG(dbgs() << "LAA: Zero dependence difference but different types\n");
1109     return Dependence::Unknown;
1110   }
1111
1112   assert(Val.isStrictlyPositive() && "Expect a positive value");
1113
1114   if (ATy != BTy) {
1115     DEBUG(dbgs() <<
1116           "LAA: ReadWrite-Write positive dependency with different types\n");
1117     return Dependence::Unknown;
1118   }
1119
1120   unsigned Distance = (unsigned) Val.getZExtValue();
1121
1122   unsigned Stride = std::abs(StrideAPtr);
1123   if (Stride > 1 &&
1124       areStridedAccessesIndependent(Distance, Stride, TypeByteSize)) {
1125     DEBUG(dbgs() << "LAA: Strided accesses are independent\n");
1126     return Dependence::NoDep;
1127   }
1128
1129   // Bail out early if passed-in parameters make vectorization not feasible.
1130   unsigned ForcedFactor = (VectorizerParams::VectorizationFactor ?
1131                            VectorizerParams::VectorizationFactor : 1);
1132   unsigned ForcedUnroll = (VectorizerParams::VectorizationInterleave ?
1133                            VectorizerParams::VectorizationInterleave : 1);
1134   // The minimum number of iterations for a vectorized/unrolled version.
1135   unsigned MinNumIter = std::max(ForcedFactor * ForcedUnroll, 2U);
1136
1137   // It's not vectorizable if the distance is smaller than the minimum distance
1138   // needed for a vectroized/unrolled version. Vectorizing one iteration in
1139   // front needs TypeByteSize * Stride. Vectorizing the last iteration needs
1140   // TypeByteSize (No need to plus the last gap distance).
1141   //
1142   // E.g. Assume one char is 1 byte in memory and one int is 4 bytes.
1143   //      foo(int *A) {
1144   //        int *B = (int *)((char *)A + 14);
1145   //        for (i = 0 ; i < 1024 ; i += 2)
1146   //          B[i] = A[i] + 1;
1147   //      }
1148   //
1149   // Two accesses in memory (stride is 2):
1150   //     | A[0] |      | A[2] |      | A[4] |      | A[6] |      |
1151   //                              | B[0] |      | B[2] |      | B[4] |
1152   //
1153   // Distance needs for vectorizing iterations except the last iteration:
1154   // 4 * 2 * (MinNumIter - 1). Distance needs for the last iteration: 4.
1155   // So the minimum distance needed is: 4 * 2 * (MinNumIter - 1) + 4.
1156   //
1157   // If MinNumIter is 2, it is vectorizable as the minimum distance needed is
1158   // 12, which is less than distance.
1159   //
1160   // If MinNumIter is 4 (Say if a user forces the vectorization factor to be 4),
1161   // the minimum distance needed is 28, which is greater than distance. It is
1162   // not safe to do vectorization.
1163   unsigned MinDistanceNeeded =
1164       TypeByteSize * Stride * (MinNumIter - 1) + TypeByteSize;
1165   if (MinDistanceNeeded > Distance) {
1166     DEBUG(dbgs() << "LAA: Failure because of positive distance " << Distance
1167                  << '\n');
1168     return Dependence::Backward;
1169   }
1170
1171   // Unsafe if the minimum distance needed is greater than max safe distance.
1172   if (MinDistanceNeeded > MaxSafeDepDistBytes) {
1173     DEBUG(dbgs() << "LAA: Failure because it needs at least "
1174                  << MinDistanceNeeded << " size in bytes");
1175     return Dependence::Backward;
1176   }
1177
1178   // Positive distance bigger than max vectorization factor.
1179   // FIXME: Should use max factor instead of max distance in bytes, which could
1180   // not handle different types.
1181   // E.g. Assume one char is 1 byte in memory and one int is 4 bytes.
1182   //      void foo (int *A, char *B) {
1183   //        for (unsigned i = 0; i < 1024; i++) {
1184   //          A[i+2] = A[i] + 1;
1185   //          B[i+2] = B[i] + 1;
1186   //        }
1187   //      }
1188   //
1189   // This case is currently unsafe according to the max safe distance. If we
1190   // analyze the two accesses on array B, the max safe dependence distance
1191   // is 2. Then we analyze the accesses on array A, the minimum distance needed
1192   // is 8, which is less than 2 and forbidden vectorization, But actually
1193   // both A and B could be vectorized by 2 iterations.
1194   MaxSafeDepDistBytes =
1195       Distance < MaxSafeDepDistBytes ? Distance : MaxSafeDepDistBytes;
1196
1197   bool IsTrueDataDependence = (!AIsWrite && BIsWrite);
1198   if (IsTrueDataDependence &&
1199       couldPreventStoreLoadForward(Distance, TypeByteSize))
1200     return Dependence::BackwardVectorizableButPreventsForwarding;
1201
1202   DEBUG(dbgs() << "LAA: Positive distance " << Val.getSExtValue()
1203                << " with max VF = "
1204                << MaxSafeDepDistBytes / (TypeByteSize * Stride) << '\n');
1205
1206   return Dependence::BackwardVectorizable;
1207 }
1208
1209 bool MemoryDepChecker::areDepsSafe(DepCandidates &AccessSets,
1210                                    MemAccessInfoSet &CheckDeps,
1211                                    const ValueToValueMap &Strides) {
1212
1213   MaxSafeDepDistBytes = -1U;
1214   while (!CheckDeps.empty()) {
1215     MemAccessInfo CurAccess = *CheckDeps.begin();
1216
1217     // Get the relevant memory access set.
1218     EquivalenceClasses<MemAccessInfo>::iterator I =
1219       AccessSets.findValue(AccessSets.getLeaderValue(CurAccess));
1220
1221     // Check accesses within this set.
1222     EquivalenceClasses<MemAccessInfo>::member_iterator AI, AE;
1223     AI = AccessSets.member_begin(I), AE = AccessSets.member_end();
1224
1225     // Check every access pair.
1226     while (AI != AE) {
1227       CheckDeps.erase(*AI);
1228       EquivalenceClasses<MemAccessInfo>::member_iterator OI = std::next(AI);
1229       while (OI != AE) {
1230         // Check every accessing instruction pair in program order.
1231         for (std::vector<unsigned>::iterator I1 = Accesses[*AI].begin(),
1232              I1E = Accesses[*AI].end(); I1 != I1E; ++I1)
1233           for (std::vector<unsigned>::iterator I2 = Accesses[*OI].begin(),
1234                I2E = Accesses[*OI].end(); I2 != I2E; ++I2) {
1235             auto A = std::make_pair(&*AI, *I1);
1236             auto B = std::make_pair(&*OI, *I2);
1237
1238             assert(*I1 != *I2);
1239             if (*I1 > *I2)
1240               std::swap(A, B);
1241
1242             Dependence::DepType Type =
1243                 isDependent(*A.first, A.second, *B.first, B.second, Strides);
1244             SafeForVectorization &= Dependence::isSafeForVectorization(Type);
1245
1246             // Gather dependences unless we accumulated MaxInterestingDependence
1247             // dependences.  In that case return as soon as we find the first
1248             // unsafe dependence.  This puts a limit on this quadratic
1249             // algorithm.
1250             if (RecordInterestingDependences) {
1251               if (Dependence::isInterestingDependence(Type))
1252                 InterestingDependences.push_back(
1253                     Dependence(A.second, B.second, Type));
1254
1255               if (InterestingDependences.size() >= MaxInterestingDependence) {
1256                 RecordInterestingDependences = false;
1257                 InterestingDependences.clear();
1258                 DEBUG(dbgs() << "Too many dependences, stopped recording\n");
1259               }
1260             }
1261             if (!RecordInterestingDependences && !SafeForVectorization)
1262               return false;
1263           }
1264         ++OI;
1265       }
1266       AI++;
1267     }
1268   }
1269
1270   DEBUG(dbgs() << "Total Interesting Dependences: "
1271                << InterestingDependences.size() << "\n");
1272   return SafeForVectorization;
1273 }
1274
1275 SmallVector<Instruction *, 4>
1276 MemoryDepChecker::getInstructionsForAccess(Value *Ptr, bool isWrite) const {
1277   MemAccessInfo Access(Ptr, isWrite);
1278   auto &IndexVector = Accesses.find(Access)->second;
1279
1280   SmallVector<Instruction *, 4> Insts;
1281   std::transform(IndexVector.begin(), IndexVector.end(),
1282                  std::back_inserter(Insts),
1283                  [&](unsigned Idx) { return this->InstMap[Idx]; });
1284   return Insts;
1285 }
1286
1287 const char *MemoryDepChecker::Dependence::DepName[] = {
1288     "NoDep", "Unknown", "Forward", "ForwardButPreventsForwarding", "Backward",
1289     "BackwardVectorizable", "BackwardVectorizableButPreventsForwarding"};
1290
1291 void MemoryDepChecker::Dependence::print(
1292     raw_ostream &OS, unsigned Depth,
1293     const SmallVectorImpl<Instruction *> &Instrs) const {
1294   OS.indent(Depth) << DepName[Type] << ":\n";
1295   OS.indent(Depth + 2) << *Instrs[Source] << " -> \n";
1296   OS.indent(Depth + 2) << *Instrs[Destination] << "\n";
1297 }
1298
1299 bool LoopAccessInfo::canAnalyzeLoop() {
1300   // We need to have a loop header.
1301   DEBUG(dbgs() << "LAA: Found a loop: " <<
1302         TheLoop->getHeader()->getName() << '\n');
1303
1304     // We can only analyze innermost loops.
1305   if (!TheLoop->empty()) {
1306     DEBUG(dbgs() << "LAA: loop is not the innermost loop\n");
1307     emitAnalysis(LoopAccessReport() << "loop is not the innermost loop");
1308     return false;
1309   }
1310
1311   // We must have a single backedge.
1312   if (TheLoop->getNumBackEdges() != 1) {
1313     DEBUG(dbgs() << "LAA: loop control flow is not understood by analyzer\n");
1314     emitAnalysis(
1315         LoopAccessReport() <<
1316         "loop control flow is not understood by analyzer");
1317     return false;
1318   }
1319
1320   // We must have a single exiting block.
1321   if (!TheLoop->getExitingBlock()) {
1322     DEBUG(dbgs() << "LAA: loop control flow is not understood by analyzer\n");
1323     emitAnalysis(
1324         LoopAccessReport() <<
1325         "loop control flow is not understood by analyzer");
1326     return false;
1327   }
1328
1329   // We only handle bottom-tested loops, i.e. loop in which the condition is
1330   // checked at the end of each iteration. With that we can assume that all
1331   // instructions in the loop are executed the same number of times.
1332   if (TheLoop->getExitingBlock() != TheLoop->getLoopLatch()) {
1333     DEBUG(dbgs() << "LAA: loop control flow is not understood by analyzer\n");
1334     emitAnalysis(
1335         LoopAccessReport() <<
1336         "loop control flow is not understood by analyzer");
1337     return false;
1338   }
1339
1340   // ScalarEvolution needs to be able to find the exit count.
1341   const SCEV *ExitCount = SE->getBackedgeTakenCount(TheLoop);
1342   if (ExitCount == SE->getCouldNotCompute()) {
1343     emitAnalysis(LoopAccessReport() <<
1344                  "could not determine number of loop iterations");
1345     DEBUG(dbgs() << "LAA: SCEV could not compute the loop exit count.\n");
1346     return false;
1347   }
1348
1349   return true;
1350 }
1351
1352 void LoopAccessInfo::analyzeLoop(const ValueToValueMap &Strides) {
1353
1354   typedef SmallVector<Value*, 16> ValueVector;
1355   typedef SmallPtrSet<Value*, 16> ValueSet;
1356
1357   // Holds the Load and Store *instructions*.
1358   ValueVector Loads;
1359   ValueVector Stores;
1360
1361   // Holds all the different accesses in the loop.
1362   unsigned NumReads = 0;
1363   unsigned NumReadWrites = 0;
1364
1365   PtrRtChecking.Pointers.clear();
1366   PtrRtChecking.Need = false;
1367
1368   const bool IsAnnotatedParallel = TheLoop->isAnnotatedParallel();
1369
1370   // For each block.
1371   for (Loop::block_iterator bb = TheLoop->block_begin(),
1372        be = TheLoop->block_end(); bb != be; ++bb) {
1373
1374     // Scan the BB and collect legal loads and stores.
1375     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
1376          ++it) {
1377
1378       // If this is a load, save it. If this instruction can read from memory
1379       // but is not a load, then we quit. Notice that we don't handle function
1380       // calls that read or write.
1381       if (it->mayReadFromMemory()) {
1382         // Many math library functions read the rounding mode. We will only
1383         // vectorize a loop if it contains known function calls that don't set
1384         // the flag. Therefore, it is safe to ignore this read from memory.
1385         CallInst *Call = dyn_cast<CallInst>(it);
1386         if (Call && getIntrinsicIDForCall(Call, TLI))
1387           continue;
1388
1389         // If the function has an explicit vectorized counterpart, we can safely
1390         // assume that it can be vectorized.
1391         if (Call && !Call->isNoBuiltin() && Call->getCalledFunction() &&
1392             TLI->isFunctionVectorizable(Call->getCalledFunction()->getName()))
1393           continue;
1394
1395         LoadInst *Ld = dyn_cast<LoadInst>(it);
1396         if (!Ld || (!Ld->isSimple() && !IsAnnotatedParallel)) {
1397           emitAnalysis(LoopAccessReport(Ld)
1398                        << "read with atomic ordering or volatile read");
1399           DEBUG(dbgs() << "LAA: Found a non-simple load.\n");
1400           CanVecMem = false;
1401           return;
1402         }
1403         NumLoads++;
1404         Loads.push_back(Ld);
1405         DepChecker.addAccess(Ld);
1406         continue;
1407       }
1408
1409       // Save 'store' instructions. Abort if other instructions write to memory.
1410       if (it->mayWriteToMemory()) {
1411         StoreInst *St = dyn_cast<StoreInst>(it);
1412         if (!St) {
1413           emitAnalysis(LoopAccessReport(it) <<
1414                        "instruction cannot be vectorized");
1415           CanVecMem = false;
1416           return;
1417         }
1418         if (!St->isSimple() && !IsAnnotatedParallel) {
1419           emitAnalysis(LoopAccessReport(St)
1420                        << "write with atomic ordering or volatile write");
1421           DEBUG(dbgs() << "LAA: Found a non-simple store.\n");
1422           CanVecMem = false;
1423           return;
1424         }
1425         NumStores++;
1426         Stores.push_back(St);
1427         DepChecker.addAccess(St);
1428       }
1429     } // Next instr.
1430   } // Next block.
1431
1432   // Now we have two lists that hold the loads and the stores.
1433   // Next, we find the pointers that they use.
1434
1435   // Check if we see any stores. If there are no stores, then we don't
1436   // care if the pointers are *restrict*.
1437   if (!Stores.size()) {
1438     DEBUG(dbgs() << "LAA: Found a read-only loop!\n");
1439     CanVecMem = true;
1440     return;
1441   }
1442
1443   MemoryDepChecker::DepCandidates DependentAccesses;
1444   AccessAnalysis Accesses(TheLoop->getHeader()->getModule()->getDataLayout(),
1445                           AA, LI, DependentAccesses);
1446
1447   // Holds the analyzed pointers. We don't want to call GetUnderlyingObjects
1448   // multiple times on the same object. If the ptr is accessed twice, once
1449   // for read and once for write, it will only appear once (on the write
1450   // list). This is okay, since we are going to check for conflicts between
1451   // writes and between reads and writes, but not between reads and reads.
1452   ValueSet Seen;
1453
1454   ValueVector::iterator I, IE;
1455   for (I = Stores.begin(), IE = Stores.end(); I != IE; ++I) {
1456     StoreInst *ST = cast<StoreInst>(*I);
1457     Value* Ptr = ST->getPointerOperand();
1458     // Check for store to loop invariant address.
1459     StoreToLoopInvariantAddress |= isUniform(Ptr);
1460     // If we did *not* see this pointer before, insert it to  the read-write
1461     // list. At this phase it is only a 'write' list.
1462     if (Seen.insert(Ptr).second) {
1463       ++NumReadWrites;
1464
1465       MemoryLocation Loc = MemoryLocation::get(ST);
1466       // The TBAA metadata could have a control dependency on the predication
1467       // condition, so we cannot rely on it when determining whether or not we
1468       // need runtime pointer checks.
1469       if (blockNeedsPredication(ST->getParent(), TheLoop, DT))
1470         Loc.AATags.TBAA = nullptr;
1471
1472       Accesses.addStore(Loc);
1473     }
1474   }
1475
1476   if (IsAnnotatedParallel) {
1477     DEBUG(dbgs()
1478           << "LAA: A loop annotated parallel, ignore memory dependency "
1479           << "checks.\n");
1480     CanVecMem = true;
1481     return;
1482   }
1483
1484   for (I = Loads.begin(), IE = Loads.end(); I != IE; ++I) {
1485     LoadInst *LD = cast<LoadInst>(*I);
1486     Value* Ptr = LD->getPointerOperand();
1487     // If we did *not* see this pointer before, insert it to the
1488     // read list. If we *did* see it before, then it is already in
1489     // the read-write list. This allows us to vectorize expressions
1490     // such as A[i] += x;  Because the address of A[i] is a read-write
1491     // pointer. This only works if the index of A[i] is consecutive.
1492     // If the address of i is unknown (for example A[B[i]]) then we may
1493     // read a few words, modify, and write a few words, and some of the
1494     // words may be written to the same address.
1495     bool IsReadOnlyPtr = false;
1496     if (Seen.insert(Ptr).second || !isStridedPtr(SE, Ptr, TheLoop, Strides)) {
1497       ++NumReads;
1498       IsReadOnlyPtr = true;
1499     }
1500
1501     MemoryLocation Loc = MemoryLocation::get(LD);
1502     // The TBAA metadata could have a control dependency on the predication
1503     // condition, so we cannot rely on it when determining whether or not we
1504     // need runtime pointer checks.
1505     if (blockNeedsPredication(LD->getParent(), TheLoop, DT))
1506       Loc.AATags.TBAA = nullptr;
1507
1508     Accesses.addLoad(Loc, IsReadOnlyPtr);
1509   }
1510
1511   // If we write (or read-write) to a single destination and there are no
1512   // other reads in this loop then is it safe to vectorize.
1513   if (NumReadWrites == 1 && NumReads == 0) {
1514     DEBUG(dbgs() << "LAA: Found a write-only loop!\n");
1515     CanVecMem = true;
1516     return;
1517   }
1518
1519   // Build dependence sets and check whether we need a runtime pointer bounds
1520   // check.
1521   Accesses.buildDependenceSets();
1522
1523   // Find pointers with computable bounds. We are going to use this information
1524   // to place a runtime bound check.
1525   bool CanDoRTIfNeeded =
1526       Accesses.canCheckPtrAtRT(PtrRtChecking, SE, TheLoop, Strides);
1527   if (!CanDoRTIfNeeded) {
1528     emitAnalysis(LoopAccessReport() << "cannot identify array bounds");
1529     DEBUG(dbgs() << "LAA: We can't vectorize because we can't find "
1530                  << "the array bounds.\n");
1531     CanVecMem = false;
1532     return;
1533   }
1534
1535   DEBUG(dbgs() << "LAA: We can perform a memory runtime check if needed.\n");
1536
1537   CanVecMem = true;
1538   if (Accesses.isDependencyCheckNeeded()) {
1539     DEBUG(dbgs() << "LAA: Checking memory dependencies\n");
1540     CanVecMem = DepChecker.areDepsSafe(
1541         DependentAccesses, Accesses.getDependenciesToCheck(), Strides);
1542     MaxSafeDepDistBytes = DepChecker.getMaxSafeDepDistBytes();
1543
1544     if (!CanVecMem && DepChecker.shouldRetryWithRuntimeCheck()) {
1545       DEBUG(dbgs() << "LAA: Retrying with memory checks\n");
1546
1547       // Clear the dependency checks. We assume they are not needed.
1548       Accesses.resetDepChecks(DepChecker);
1549
1550       PtrRtChecking.reset();
1551       PtrRtChecking.Need = true;
1552
1553       CanDoRTIfNeeded =
1554           Accesses.canCheckPtrAtRT(PtrRtChecking, SE, TheLoop, Strides, true);
1555
1556       // Check that we found the bounds for the pointer.
1557       if (!CanDoRTIfNeeded) {
1558         emitAnalysis(LoopAccessReport()
1559                      << "cannot check memory dependencies at runtime");
1560         DEBUG(dbgs() << "LAA: Can't vectorize with memory checks\n");
1561         CanVecMem = false;
1562         return;
1563       }
1564
1565       CanVecMem = true;
1566     }
1567   }
1568
1569   if (CanVecMem)
1570     DEBUG(dbgs() << "LAA: No unsafe dependent memory operations in loop.  We"
1571                  << (PtrRtChecking.Need ? "" : " don't")
1572                  << " need runtime memory checks.\n");
1573   else {
1574     emitAnalysis(LoopAccessReport() <<
1575                  "unsafe dependent memory operations in loop");
1576     DEBUG(dbgs() << "LAA: unsafe dependent memory operations in loop\n");
1577   }
1578 }
1579
1580 bool LoopAccessInfo::blockNeedsPredication(BasicBlock *BB, Loop *TheLoop,
1581                                            DominatorTree *DT)  {
1582   assert(TheLoop->contains(BB) && "Unknown block used");
1583
1584   // Blocks that do not dominate the latch need predication.
1585   BasicBlock* Latch = TheLoop->getLoopLatch();
1586   return !DT->dominates(BB, Latch);
1587 }
1588
1589 void LoopAccessInfo::emitAnalysis(LoopAccessReport &Message) {
1590   assert(!Report && "Multiple reports generated");
1591   Report = Message;
1592 }
1593
1594 bool LoopAccessInfo::isUniform(Value *V) const {
1595   return (SE->isLoopInvariant(SE->getSCEV(V), TheLoop));
1596 }
1597
1598 // FIXME: this function is currently a duplicate of the one in
1599 // LoopVectorize.cpp.
1600 static Instruction *getFirstInst(Instruction *FirstInst, Value *V,
1601                                  Instruction *Loc) {
1602   if (FirstInst)
1603     return FirstInst;
1604   if (Instruction *I = dyn_cast<Instruction>(V))
1605     return I->getParent() == Loc->getParent() ? I : nullptr;
1606   return nullptr;
1607 }
1608
1609 /// \brief IR Values for the lower and upper bounds of a pointer evolution.
1610 struct PointerBounds {
1611   Value *Start;
1612   Value *End;
1613 };
1614
1615 /// \brief Expand code for the lower and upper bound of the pointer group \p CG
1616 /// in \p TheLoop.  \return the values for the bounds.
1617 static PointerBounds
1618 expandBounds(const RuntimePointerChecking::CheckingPtrGroup *CG, Loop *TheLoop,
1619              Instruction *Loc, SCEVExpander &Exp, ScalarEvolution *SE,
1620              const RuntimePointerChecking &PtrRtChecking) {
1621   Value *Ptr = PtrRtChecking.Pointers[CG->Members[0]].PointerValue;
1622   const SCEV *Sc = SE->getSCEV(Ptr);
1623
1624   if (SE->isLoopInvariant(Sc, TheLoop)) {
1625     DEBUG(dbgs() << "LAA: Adding RT check for a loop invariant ptr:" << *Ptr
1626                  << "\n");
1627     return {Ptr, Ptr};
1628   } else {
1629     unsigned AS = Ptr->getType()->getPointerAddressSpace();
1630     LLVMContext &Ctx = Loc->getContext();
1631
1632     // Use this type for pointer arithmetic.
1633     Type *PtrArithTy = Type::getInt8PtrTy(Ctx, AS);
1634     Value *Start = nullptr, *End = nullptr;
1635
1636     DEBUG(dbgs() << "LAA: Adding RT check for range:\n");
1637     Start = Exp.expandCodeFor(CG->Low, PtrArithTy, Loc);
1638     End = Exp.expandCodeFor(CG->High, PtrArithTy, Loc);
1639     DEBUG(dbgs() << "Start: " << *CG->Low << " End: " << *CG->High << "\n");
1640     return {Start, End};
1641   }
1642 }
1643
1644 /// \brief Turns a collection of checks into a collection of expanded upper and
1645 /// lower bounds for both pointers in the check.
1646 static SmallVector<std::pair<PointerBounds, PointerBounds>, 4> expandBounds(
1647     const SmallVectorImpl<RuntimePointerChecking::PointerCheck> &PointerChecks,
1648     Loop *L, Instruction *Loc, ScalarEvolution *SE, SCEVExpander &Exp,
1649     const RuntimePointerChecking &PtrRtChecking) {
1650   SmallVector<std::pair<PointerBounds, PointerBounds>, 4> ChecksWithBounds;
1651
1652   // Here we're relying on the SCEV Expander's cache to only emit code for the
1653   // same bounds once.
1654   std::transform(
1655       PointerChecks.begin(), PointerChecks.end(),
1656       std::back_inserter(ChecksWithBounds),
1657       [&](const RuntimePointerChecking::PointerCheck &Check) {
1658         PointerBounds
1659           First = expandBounds(Check.first, L, Loc, Exp, SE, PtrRtChecking),
1660           Second = expandBounds(Check.second, L, Loc, Exp, SE, PtrRtChecking);
1661         return std::make_pair(First, Second);
1662       });
1663
1664   return ChecksWithBounds;
1665 }
1666
1667 std::pair<Instruction *, Instruction *> LoopAccessInfo::addRuntimeCheck(
1668     Instruction *Loc,
1669     const SmallVectorImpl<RuntimePointerChecking::PointerCheck> &PointerChecks)
1670     const {
1671
1672   SCEVExpander Exp(*SE, DL, "induction");
1673   auto ExpandedChecks =
1674       expandBounds(PointerChecks, TheLoop, Loc, SE, Exp, PtrRtChecking);
1675
1676   LLVMContext &Ctx = Loc->getContext();
1677   Instruction *FirstInst = nullptr;
1678   IRBuilder<> ChkBuilder(Loc);
1679   // Our instructions might fold to a constant.
1680   Value *MemoryRuntimeCheck = nullptr;
1681
1682   for (const auto &Check : ExpandedChecks) {
1683     const PointerBounds &A = Check.first, &B = Check.second;
1684     unsigned AS0 = A.Start->getType()->getPointerAddressSpace();
1685     unsigned AS1 = B.Start->getType()->getPointerAddressSpace();
1686
1687     assert((AS0 == B.End->getType()->getPointerAddressSpace()) &&
1688            (AS1 == A.End->getType()->getPointerAddressSpace()) &&
1689            "Trying to bounds check pointers with different address spaces");
1690
1691     Type *PtrArithTy0 = Type::getInt8PtrTy(Ctx, AS0);
1692     Type *PtrArithTy1 = Type::getInt8PtrTy(Ctx, AS1);
1693
1694     Value *Start0 = ChkBuilder.CreateBitCast(A.Start, PtrArithTy0, "bc");
1695     Value *Start1 = ChkBuilder.CreateBitCast(B.Start, PtrArithTy1, "bc");
1696     Value *End0 =   ChkBuilder.CreateBitCast(A.End,   PtrArithTy1, "bc");
1697     Value *End1 =   ChkBuilder.CreateBitCast(B.End,   PtrArithTy0, "bc");
1698
1699     Value *Cmp0 = ChkBuilder.CreateICmpULE(Start0, End1, "bound0");
1700     FirstInst = getFirstInst(FirstInst, Cmp0, Loc);
1701     Value *Cmp1 = ChkBuilder.CreateICmpULE(Start1, End0, "bound1");
1702     FirstInst = getFirstInst(FirstInst, Cmp1, Loc);
1703     Value *IsConflict = ChkBuilder.CreateAnd(Cmp0, Cmp1, "found.conflict");
1704     FirstInst = getFirstInst(FirstInst, IsConflict, Loc);
1705     if (MemoryRuntimeCheck) {
1706       IsConflict =
1707           ChkBuilder.CreateOr(MemoryRuntimeCheck, IsConflict, "conflict.rdx");
1708       FirstInst = getFirstInst(FirstInst, IsConflict, Loc);
1709     }
1710     MemoryRuntimeCheck = IsConflict;
1711   }
1712
1713   if (!MemoryRuntimeCheck)
1714     return std::make_pair(nullptr, nullptr);
1715
1716   // We have to do this trickery because the IRBuilder might fold the check to a
1717   // constant expression in which case there is no Instruction anchored in a
1718   // the block.
1719   Instruction *Check = BinaryOperator::CreateAnd(MemoryRuntimeCheck,
1720                                                  ConstantInt::getTrue(Ctx));
1721   ChkBuilder.Insert(Check, "memcheck.conflict");
1722   FirstInst = getFirstInst(FirstInst, Check, Loc);
1723   return std::make_pair(FirstInst, Check);
1724 }
1725
1726 std::pair<Instruction *, Instruction *> LoopAccessInfo::addRuntimeCheck(
1727     Instruction *Loc) const {
1728   if (!PtrRtChecking.Need)
1729     return std::make_pair(nullptr, nullptr);
1730
1731   return addRuntimeCheck(Loc, PtrRtChecking.generateChecks());
1732 }
1733
1734 LoopAccessInfo::LoopAccessInfo(Loop *L, ScalarEvolution *SE,
1735                                const DataLayout &DL,
1736                                const TargetLibraryInfo *TLI, AliasAnalysis *AA,
1737                                DominatorTree *DT, LoopInfo *LI,
1738                                const ValueToValueMap &Strides)
1739     : PtrRtChecking(SE), DepChecker(SE, L), TheLoop(L), SE(SE), DL(DL),
1740       TLI(TLI), AA(AA), DT(DT), LI(LI), NumLoads(0), NumStores(0),
1741       MaxSafeDepDistBytes(-1U), CanVecMem(false),
1742       StoreToLoopInvariantAddress(false) {
1743   if (canAnalyzeLoop())
1744     analyzeLoop(Strides);
1745 }
1746
1747 void LoopAccessInfo::print(raw_ostream &OS, unsigned Depth) const {
1748   if (CanVecMem) {
1749     if (PtrRtChecking.Need)
1750       OS.indent(Depth) << "Memory dependences are safe with run-time checks\n";
1751     else
1752       OS.indent(Depth) << "Memory dependences are safe\n";
1753   }
1754
1755   if (Report)
1756     OS.indent(Depth) << "Report: " << Report->str() << "\n";
1757
1758   if (auto *InterestingDependences = DepChecker.getInterestingDependences()) {
1759     OS.indent(Depth) << "Interesting Dependences:\n";
1760     for (auto &Dep : *InterestingDependences) {
1761       Dep.print(OS, Depth + 2, DepChecker.getMemoryInstructions());
1762       OS << "\n";
1763     }
1764   } else
1765     OS.indent(Depth) << "Too many interesting dependences, not recorded\n";
1766
1767   // List the pair of accesses need run-time checks to prove independence.
1768   PtrRtChecking.print(OS, Depth);
1769   OS << "\n";
1770
1771   OS.indent(Depth) << "Store to invariant address was "
1772                    << (StoreToLoopInvariantAddress ? "" : "not ")
1773                    << "found in loop.\n";
1774 }
1775
1776 const LoopAccessInfo &
1777 LoopAccessAnalysis::getInfo(Loop *L, const ValueToValueMap &Strides) {
1778   auto &LAI = LoopAccessInfoMap[L];
1779
1780 #ifndef NDEBUG
1781   assert((!LAI || LAI->NumSymbolicStrides == Strides.size()) &&
1782          "Symbolic strides changed for loop");
1783 #endif
1784
1785   if (!LAI) {
1786     const DataLayout &DL = L->getHeader()->getModule()->getDataLayout();
1787     LAI = llvm::make_unique<LoopAccessInfo>(L, SE, DL, TLI, AA, DT, LI,
1788                                             Strides);
1789 #ifndef NDEBUG
1790     LAI->NumSymbolicStrides = Strides.size();
1791 #endif
1792   }
1793   return *LAI.get();
1794 }
1795
1796 void LoopAccessAnalysis::print(raw_ostream &OS, const Module *M) const {
1797   LoopAccessAnalysis &LAA = *const_cast<LoopAccessAnalysis *>(this);
1798
1799   ValueToValueMap NoSymbolicStrides;
1800
1801   for (Loop *TopLevelLoop : *LI)
1802     for (Loop *L : depth_first(TopLevelLoop)) {
1803       OS.indent(2) << L->getHeader()->getName() << ":\n";
1804       auto &LAI = LAA.getInfo(L, NoSymbolicStrides);
1805       LAI.print(OS, 4);
1806     }
1807 }
1808
1809 bool LoopAccessAnalysis::runOnFunction(Function &F) {
1810   SE = &getAnalysis<ScalarEvolution>();
1811   auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
1812   TLI = TLIP ? &TLIP->getTLI() : nullptr;
1813   AA = &getAnalysis<AliasAnalysis>();
1814   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1815   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
1816
1817   return false;
1818 }
1819
1820 void LoopAccessAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
1821     AU.addRequired<ScalarEvolution>();
1822     AU.addRequired<AliasAnalysis>();
1823     AU.addRequired<DominatorTreeWrapperPass>();
1824     AU.addRequired<LoopInfoWrapperPass>();
1825
1826     AU.setPreservesAll();
1827 }
1828
1829 char LoopAccessAnalysis::ID = 0;
1830 static const char laa_name[] = "Loop Access Analysis";
1831 #define LAA_NAME "loop-accesses"
1832
1833 INITIALIZE_PASS_BEGIN(LoopAccessAnalysis, LAA_NAME, laa_name, false, true)
1834 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
1835 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
1836 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
1837 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
1838 INITIALIZE_PASS_END(LoopAccessAnalysis, LAA_NAME, laa_name, false, true)
1839
1840 namespace llvm {
1841   Pass *createLAAPass() {
1842     return new LoopAccessAnalysis();
1843   }
1844 }