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