[PM] Split the LoopInfo object apart from the legacy pass, creating
[oota-llvm.git] / lib / Transforms / Vectorize / LoopVectorize.cpp
1 //===- LoopVectorize.cpp - A Loop Vectorizer ------------------------------===//
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 // This is the LLVM loop vectorizer. This pass modifies 'vectorizable' loops
11 // and generates target-independent LLVM-IR.
12 // The vectorizer uses the TargetTransformInfo analysis to estimate the costs
13 // of instructions in order to estimate the profitability of vectorization.
14 //
15 // The loop vectorizer combines consecutive loop iterations into a single
16 // 'wide' iteration. After this transformation the index is incremented
17 // by the SIMD vector width, and not by one.
18 //
19 // This pass has three parts:
20 // 1. The main loop pass that drives the different parts.
21 // 2. LoopVectorizationLegality - A unit that checks for the legality
22 //    of the vectorization.
23 // 3. InnerLoopVectorizer - A unit that performs the actual
24 //    widening of instructions.
25 // 4. LoopVectorizationCostModel - A unit that checks for the profitability
26 //    of vectorization. It decides on the optimal vector width, which
27 //    can be one, if vectorization is not profitable.
28 //
29 //===----------------------------------------------------------------------===//
30 //
31 // The reduction-variable vectorization is based on the paper:
32 //  D. Nuzman and R. Henderson. Multi-platform Auto-vectorization.
33 //
34 // Variable uniformity checks are inspired by:
35 //  Karrenberg, R. and Hack, S. Whole Function Vectorization.
36 //
37 // Other ideas/concepts are from:
38 //  A. Zaks and D. Nuzman. Autovectorization in GCC-two years later.
39 //
40 //  S. Maleki, Y. Gao, M. Garzaran, T. Wong and D. Padua.  An Evaluation of
41 //  Vectorizing Compilers.
42 //
43 //===----------------------------------------------------------------------===//
44
45 #include "llvm/Transforms/Vectorize.h"
46 #include "llvm/ADT/DenseMap.h"
47 #include "llvm/ADT/EquivalenceClasses.h"
48 #include "llvm/ADT/Hashing.h"
49 #include "llvm/ADT/MapVector.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallSet.h"
53 #include "llvm/ADT/SmallVector.h"
54 #include "llvm/ADT/Statistic.h"
55 #include "llvm/ADT/StringExtras.h"
56 #include "llvm/Analysis/AliasAnalysis.h"
57 #include "llvm/Analysis/AliasSetTracker.h"
58 #include "llvm/Analysis/AssumptionCache.h"
59 #include "llvm/Analysis/BlockFrequencyInfo.h"
60 #include "llvm/Analysis/CodeMetrics.h"
61 #include "llvm/Analysis/LoopInfo.h"
62 #include "llvm/Analysis/LoopIterator.h"
63 #include "llvm/Analysis/LoopPass.h"
64 #include "llvm/Analysis/ScalarEvolution.h"
65 #include "llvm/Analysis/ScalarEvolutionExpander.h"
66 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
67 #include "llvm/Analysis/TargetTransformInfo.h"
68 #include "llvm/Analysis/ValueTracking.h"
69 #include "llvm/IR/Constants.h"
70 #include "llvm/IR/DataLayout.h"
71 #include "llvm/IR/DebugInfo.h"
72 #include "llvm/IR/DerivedTypes.h"
73 #include "llvm/IR/DiagnosticInfo.h"
74 #include "llvm/IR/Dominators.h"
75 #include "llvm/IR/Function.h"
76 #include "llvm/IR/IRBuilder.h"
77 #include "llvm/IR/Instructions.h"
78 #include "llvm/IR/IntrinsicInst.h"
79 #include "llvm/IR/LLVMContext.h"
80 #include "llvm/IR/Module.h"
81 #include "llvm/IR/PatternMatch.h"
82 #include "llvm/IR/Type.h"
83 #include "llvm/IR/Value.h"
84 #include "llvm/IR/ValueHandle.h"
85 #include "llvm/IR/Verifier.h"
86 #include "llvm/Pass.h"
87 #include "llvm/Support/BranchProbability.h"
88 #include "llvm/Support/CommandLine.h"
89 #include "llvm/Support/Debug.h"
90 #include "llvm/Support/raw_ostream.h"
91 #include "llvm/Transforms/Scalar.h"
92 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
93 #include "llvm/Transforms/Utils/Local.h"
94 #include "llvm/Transforms/Utils/VectorUtils.h"
95 #include <algorithm>
96 #include <map>
97 #include <tuple>
98
99 using namespace llvm;
100 using namespace llvm::PatternMatch;
101
102 #define LV_NAME "loop-vectorize"
103 #define DEBUG_TYPE LV_NAME
104
105 STATISTIC(LoopsVectorized, "Number of loops vectorized");
106 STATISTIC(LoopsAnalyzed, "Number of loops analyzed for vectorization");
107
108 static cl::opt<unsigned>
109 VectorizationFactor("force-vector-width", cl::init(0), cl::Hidden,
110                     cl::desc("Sets the SIMD width. Zero is autoselect."));
111
112 static cl::opt<unsigned>
113 VectorizationInterleave("force-vector-interleave", cl::init(0), cl::Hidden,
114                     cl::desc("Sets the vectorization interleave count. "
115                              "Zero is autoselect."));
116
117 static cl::opt<bool>
118 EnableIfConversion("enable-if-conversion", cl::init(true), cl::Hidden,
119                    cl::desc("Enable if-conversion during vectorization."));
120
121 /// We don't vectorize loops with a known constant trip count below this number.
122 static cl::opt<unsigned>
123 TinyTripCountVectorThreshold("vectorizer-min-trip-count", cl::init(16),
124                              cl::Hidden,
125                              cl::desc("Don't vectorize loops with a constant "
126                                       "trip count that is smaller than this "
127                                       "value."));
128
129 /// This enables versioning on the strides of symbolically striding memory
130 /// accesses in code like the following.
131 ///   for (i = 0; i < N; ++i)
132 ///     A[i * Stride1] += B[i * Stride2] ...
133 ///
134 /// Will be roughly translated to
135 ///    if (Stride1 == 1 && Stride2 == 1) {
136 ///      for (i = 0; i < N; i+=4)
137 ///       A[i:i+3] += ...
138 ///    } else
139 ///      ...
140 static cl::opt<bool> EnableMemAccessVersioning(
141     "enable-mem-access-versioning", cl::init(true), cl::Hidden,
142     cl::desc("Enable symblic stride memory access versioning"));
143
144 /// We don't unroll loops with a known constant trip count below this number.
145 static const unsigned TinyTripCountUnrollThreshold = 128;
146
147 /// When performing memory disambiguation checks at runtime do not make more
148 /// than this number of comparisons.
149 static const unsigned RuntimeMemoryCheckThreshold = 8;
150
151 /// Maximum simd width.
152 static const unsigned MaxVectorWidth = 64;
153
154 static cl::opt<unsigned> ForceTargetNumScalarRegs(
155     "force-target-num-scalar-regs", cl::init(0), cl::Hidden,
156     cl::desc("A flag that overrides the target's number of scalar registers."));
157
158 static cl::opt<unsigned> ForceTargetNumVectorRegs(
159     "force-target-num-vector-regs", cl::init(0), cl::Hidden,
160     cl::desc("A flag that overrides the target's number of vector registers."));
161
162 /// Maximum vectorization interleave count.
163 static const unsigned MaxInterleaveFactor = 16;
164
165 static cl::opt<unsigned> ForceTargetMaxScalarInterleaveFactor(
166     "force-target-max-scalar-interleave", cl::init(0), cl::Hidden,
167     cl::desc("A flag that overrides the target's max interleave factor for "
168              "scalar loops."));
169
170 static cl::opt<unsigned> ForceTargetMaxVectorInterleaveFactor(
171     "force-target-max-vector-interleave", cl::init(0), cl::Hidden,
172     cl::desc("A flag that overrides the target's max interleave factor for "
173              "vectorized loops."));
174
175 static cl::opt<unsigned> ForceTargetInstructionCost(
176     "force-target-instruction-cost", cl::init(0), cl::Hidden,
177     cl::desc("A flag that overrides the target's expected cost for "
178              "an instruction to a single constant value. Mostly "
179              "useful for getting consistent testing."));
180
181 static cl::opt<unsigned> SmallLoopCost(
182     "small-loop-cost", cl::init(20), cl::Hidden,
183     cl::desc("The cost of a loop that is considered 'small' by the unroller."));
184
185 static cl::opt<bool> LoopVectorizeWithBlockFrequency(
186     "loop-vectorize-with-block-frequency", cl::init(false), cl::Hidden,
187     cl::desc("Enable the use of the block frequency analysis to access PGO "
188              "heuristics minimizing code growth in cold regions and being more "
189              "aggressive in hot regions."));
190
191 // Runtime unroll loops for load/store throughput.
192 static cl::opt<bool> EnableLoadStoreRuntimeUnroll(
193     "enable-loadstore-runtime-unroll", cl::init(true), cl::Hidden,
194     cl::desc("Enable runtime unrolling until load/store ports are saturated"));
195
196 /// The number of stores in a loop that are allowed to need predication.
197 static cl::opt<unsigned> NumberOfStoresToPredicate(
198     "vectorize-num-stores-pred", cl::init(1), cl::Hidden,
199     cl::desc("Max number of stores to be predicated behind an if."));
200
201 static cl::opt<bool> EnableIndVarRegisterHeur(
202     "enable-ind-var-reg-heur", cl::init(true), cl::Hidden,
203     cl::desc("Count the induction variable only once when unrolling"));
204
205 static cl::opt<bool> EnableCondStoresVectorization(
206     "enable-cond-stores-vec", cl::init(false), cl::Hidden,
207     cl::desc("Enable if predication of stores during vectorization."));
208
209 static cl::opt<unsigned> MaxNestedScalarReductionUF(
210     "max-nested-scalar-reduction-unroll", cl::init(2), cl::Hidden,
211     cl::desc("The maximum unroll factor to use when unrolling a scalar "
212              "reduction in a nested loop."));
213
214 namespace {
215
216 // Forward declarations.
217 class LoopVectorizationLegality;
218 class LoopVectorizationCostModel;
219 class LoopVectorizeHints;
220
221 /// Optimization analysis message produced during vectorization. Messages inform
222 /// the user why vectorization did not occur.
223 class Report {
224   std::string Message;
225   raw_string_ostream Out;
226   Instruction *Instr;
227
228 public:
229   Report(Instruction *I = nullptr) : Out(Message), Instr(I) {
230     Out << "loop not vectorized: ";
231   }
232
233   template <typename A> Report &operator<<(const A &Value) {
234     Out << Value;
235     return *this;
236   }
237
238   Instruction *getInstr() { return Instr; }
239
240   std::string &str() { return Out.str(); }
241   operator Twine() { return Out.str(); }
242 };
243
244 /// InnerLoopVectorizer vectorizes loops which contain only one basic
245 /// block to a specified vectorization factor (VF).
246 /// This class performs the widening of scalars into vectors, or multiple
247 /// scalars. This class also implements the following features:
248 /// * It inserts an epilogue loop for handling loops that don't have iteration
249 ///   counts that are known to be a multiple of the vectorization factor.
250 /// * It handles the code generation for reduction variables.
251 /// * Scalarization (implementation using scalars) of un-vectorizable
252 ///   instructions.
253 /// InnerLoopVectorizer does not perform any vectorization-legality
254 /// checks, and relies on the caller to check for the different legality
255 /// aspects. The InnerLoopVectorizer relies on the
256 /// LoopVectorizationLegality class to provide information about the induction
257 /// and reduction variables that were found to a given vectorization factor.
258 class InnerLoopVectorizer {
259 public:
260   InnerLoopVectorizer(Loop *OrigLoop, ScalarEvolution *SE, LoopInfo *LI,
261                       DominatorTree *DT, const DataLayout *DL,
262                       const TargetLibraryInfo *TLI, unsigned VecWidth,
263                       unsigned UnrollFactor)
264       : OrigLoop(OrigLoop), SE(SE), LI(LI), DT(DT), DL(DL), TLI(TLI),
265         VF(VecWidth), UF(UnrollFactor), Builder(SE->getContext()),
266         Induction(nullptr), OldInduction(nullptr), WidenMap(UnrollFactor),
267         Legal(nullptr) {}
268
269   // Perform the actual loop widening (vectorization).
270   void vectorize(LoopVectorizationLegality *L) {
271     Legal = L;
272     // Create a new empty loop. Unlink the old loop and connect the new one.
273     createEmptyLoop();
274     // Widen each instruction in the old loop to a new one in the new loop.
275     // Use the Legality module to find the induction and reduction variables.
276     vectorizeLoop();
277     // Register the new loop and update the analysis passes.
278     updateAnalysis();
279   }
280
281   virtual ~InnerLoopVectorizer() {}
282
283 protected:
284   /// A small list of PHINodes.
285   typedef SmallVector<PHINode*, 4> PhiVector;
286   /// When we unroll loops we have multiple vector values for each scalar.
287   /// This data structure holds the unrolled and vectorized values that
288   /// originated from one scalar instruction.
289   typedef SmallVector<Value*, 2> VectorParts;
290
291   // When we if-convert we need create edge masks. We have to cache values so
292   // that we don't end up with exponential recursion/IR.
293   typedef DenseMap<std::pair<BasicBlock*, BasicBlock*>,
294                    VectorParts> EdgeMaskCache;
295
296   /// \brief Add code that checks at runtime if the accessed arrays overlap.
297   ///
298   /// Returns a pair of instructions where the first element is the first
299   /// instruction generated in possibly a sequence of instructions and the
300   /// second value is the final comparator value or NULL if no check is needed.
301   std::pair<Instruction *, Instruction *> addRuntimeCheck(Instruction *Loc);
302
303   /// \brief Add checks for strides that where assumed to be 1.
304   ///
305   /// Returns the last check instruction and the first check instruction in the
306   /// pair as (first, last).
307   std::pair<Instruction *, Instruction *> addStrideCheck(Instruction *Loc);
308
309   /// Create an empty loop, based on the loop ranges of the old loop.
310   void createEmptyLoop();
311   /// Copy and widen the instructions from the old loop.
312   virtual void vectorizeLoop();
313
314   /// \brief The Loop exit block may have single value PHI nodes where the
315   /// incoming value is 'Undef'. While vectorizing we only handled real values
316   /// that were defined inside the loop. Here we fix the 'undef case'.
317   /// See PR14725.
318   void fixLCSSAPHIs();
319
320   /// A helper function that computes the predicate of the block BB, assuming
321   /// that the header block of the loop is set to True. It returns the *entry*
322   /// mask for the block BB.
323   VectorParts createBlockInMask(BasicBlock *BB);
324   /// A helper function that computes the predicate of the edge between SRC
325   /// and DST.
326   VectorParts createEdgeMask(BasicBlock *Src, BasicBlock *Dst);
327
328   /// A helper function to vectorize a single BB within the innermost loop.
329   void vectorizeBlockInLoop(BasicBlock *BB, PhiVector *PV);
330
331   /// Vectorize a single PHINode in a block. This method handles the induction
332   /// variable canonicalization. It supports both VF = 1 for unrolled loops and
333   /// arbitrary length vectors.
334   void widenPHIInstruction(Instruction *PN, VectorParts &Entry,
335                            unsigned UF, unsigned VF, PhiVector *PV);
336
337   /// Insert the new loop to the loop hierarchy and pass manager
338   /// and update the analysis passes.
339   void updateAnalysis();
340
341   /// This instruction is un-vectorizable. Implement it as a sequence
342   /// of scalars. If \p IfPredicateStore is true we need to 'hide' each
343   /// scalarized instruction behind an if block predicated on the control
344   /// dependence of the instruction.
345   virtual void scalarizeInstruction(Instruction *Instr,
346                                     bool IfPredicateStore=false);
347
348   /// Vectorize Load and Store instructions,
349   virtual void vectorizeMemoryInstruction(Instruction *Instr);
350
351   /// Create a broadcast instruction. This method generates a broadcast
352   /// instruction (shuffle) for loop invariant values and for the induction
353   /// value. If this is the induction variable then we extend it to N, N+1, ...
354   /// this is needed because each iteration in the loop corresponds to a SIMD
355   /// element.
356   virtual Value *getBroadcastInstrs(Value *V);
357
358   /// This function adds 0, 1, 2 ... to each vector element, starting at zero.
359   /// If Negate is set then negative numbers are added e.g. (0, -1, -2, ...).
360   /// The sequence starts at StartIndex.
361   virtual Value *getConsecutiveVector(Value* Val, int StartIdx, bool Negate);
362
363   /// When we go over instructions in the basic block we rely on previous
364   /// values within the current basic block or on loop invariant values.
365   /// When we widen (vectorize) values we place them in the map. If the values
366   /// are not within the map, they have to be loop invariant, so we simply
367   /// broadcast them into a vector.
368   VectorParts &getVectorValue(Value *V);
369
370   /// Generate a shuffle sequence that will reverse the vector Vec.
371   virtual Value *reverseVector(Value *Vec);
372
373   /// This is a helper class that holds the vectorizer state. It maps scalar
374   /// instructions to vector instructions. When the code is 'unrolled' then
375   /// then a single scalar value is mapped to multiple vector parts. The parts
376   /// are stored in the VectorPart type.
377   struct ValueMap {
378     /// C'tor.  UnrollFactor controls the number of vectors ('parts') that
379     /// are mapped.
380     ValueMap(unsigned UnrollFactor) : UF(UnrollFactor) {}
381
382     /// \return True if 'Key' is saved in the Value Map.
383     bool has(Value *Key) const { return MapStorage.count(Key); }
384
385     /// Initializes a new entry in the map. Sets all of the vector parts to the
386     /// save value in 'Val'.
387     /// \return A reference to a vector with splat values.
388     VectorParts &splat(Value *Key, Value *Val) {
389       VectorParts &Entry = MapStorage[Key];
390       Entry.assign(UF, Val);
391       return Entry;
392     }
393
394     ///\return A reference to the value that is stored at 'Key'.
395     VectorParts &get(Value *Key) {
396       VectorParts &Entry = MapStorage[Key];
397       if (Entry.empty())
398         Entry.resize(UF);
399       assert(Entry.size() == UF);
400       return Entry;
401     }
402
403   private:
404     /// The unroll factor. Each entry in the map stores this number of vector
405     /// elements.
406     unsigned UF;
407
408     /// Map storage. We use std::map and not DenseMap because insertions to a
409     /// dense map invalidates its iterators.
410     std::map<Value *, VectorParts> MapStorage;
411   };
412
413   /// The original loop.
414   Loop *OrigLoop;
415   /// Scev analysis to use.
416   ScalarEvolution *SE;
417   /// Loop Info.
418   LoopInfo *LI;
419   /// Dominator Tree.
420   DominatorTree *DT;
421   /// Alias Analysis.
422   AliasAnalysis *AA;
423   /// Data Layout.
424   const DataLayout *DL;
425   /// Target Library Info.
426   const TargetLibraryInfo *TLI;
427
428   /// The vectorization SIMD factor to use. Each vector will have this many
429   /// vector elements.
430   unsigned VF;
431
432 protected:
433   /// The vectorization unroll factor to use. Each scalar is vectorized to this
434   /// many different vector instructions.
435   unsigned UF;
436
437   /// The builder that we use
438   IRBuilder<> Builder;
439
440   // --- Vectorization state ---
441
442   /// The vector-loop preheader.
443   BasicBlock *LoopVectorPreHeader;
444   /// The scalar-loop preheader.
445   BasicBlock *LoopScalarPreHeader;
446   /// Middle Block between the vector and the scalar.
447   BasicBlock *LoopMiddleBlock;
448   ///The ExitBlock of the scalar loop.
449   BasicBlock *LoopExitBlock;
450   ///The vector loop body.
451   SmallVector<BasicBlock *, 4> LoopVectorBody;
452   ///The scalar loop body.
453   BasicBlock *LoopScalarBody;
454   /// A list of all bypass blocks. The first block is the entry of the loop.
455   SmallVector<BasicBlock *, 4> LoopBypassBlocks;
456
457   /// The new Induction variable which was added to the new block.
458   PHINode *Induction;
459   /// The induction variable of the old basic block.
460   PHINode *OldInduction;
461   /// Holds the extended (to the widest induction type) start index.
462   Value *ExtendedIdx;
463   /// Maps scalars to widened vectors.
464   ValueMap WidenMap;
465   EdgeMaskCache MaskCache;
466
467   LoopVectorizationLegality *Legal;
468 };
469
470 class InnerLoopUnroller : public InnerLoopVectorizer {
471 public:
472   InnerLoopUnroller(Loop *OrigLoop, ScalarEvolution *SE, LoopInfo *LI,
473                     DominatorTree *DT, const DataLayout *DL,
474                     const TargetLibraryInfo *TLI, unsigned UnrollFactor) :
475     InnerLoopVectorizer(OrigLoop, SE, LI, DT, DL, TLI, 1, UnrollFactor) { }
476
477 private:
478   void scalarizeInstruction(Instruction *Instr,
479                             bool IfPredicateStore = false) override;
480   void vectorizeMemoryInstruction(Instruction *Instr) override;
481   Value *getBroadcastInstrs(Value *V) override;
482   Value *getConsecutiveVector(Value* Val, int StartIdx, bool Negate) override;
483   Value *reverseVector(Value *Vec) override;
484 };
485
486 /// \brief Look for a meaningful debug location on the instruction or it's
487 /// operands.
488 static Instruction *getDebugLocFromInstOrOperands(Instruction *I) {
489   if (!I)
490     return I;
491
492   DebugLoc Empty;
493   if (I->getDebugLoc() != Empty)
494     return I;
495
496   for (User::op_iterator OI = I->op_begin(), OE = I->op_end(); OI != OE; ++OI) {
497     if (Instruction *OpInst = dyn_cast<Instruction>(*OI))
498       if (OpInst->getDebugLoc() != Empty)
499         return OpInst;
500   }
501
502   return I;
503 }
504
505 /// \brief Set the debug location in the builder using the debug location in the
506 /// instruction.
507 static void setDebugLocFromInst(IRBuilder<> &B, const Value *Ptr) {
508   if (const Instruction *Inst = dyn_cast_or_null<Instruction>(Ptr))
509     B.SetCurrentDebugLocation(Inst->getDebugLoc());
510   else
511     B.SetCurrentDebugLocation(DebugLoc());
512 }
513
514 #ifndef NDEBUG
515 /// \return string containing a file name and a line # for the given loop.
516 static std::string getDebugLocString(const Loop *L) {
517   std::string Result;
518   if (L) {
519     raw_string_ostream OS(Result);
520     const DebugLoc LoopDbgLoc = L->getStartLoc();
521     if (!LoopDbgLoc.isUnknown())
522       LoopDbgLoc.print(L->getHeader()->getContext(), OS);
523     else
524       // Just print the module name.
525       OS << L->getHeader()->getParent()->getParent()->getModuleIdentifier();
526     OS.flush();
527   }
528   return Result;
529 }
530 #endif
531
532 /// \brief Propagate known metadata from one instruction to another.
533 static void propagateMetadata(Instruction *To, const Instruction *From) {
534   SmallVector<std::pair<unsigned, MDNode *>, 4> Metadata;
535   From->getAllMetadataOtherThanDebugLoc(Metadata);
536
537   for (auto M : Metadata) {
538     unsigned Kind = M.first;
539
540     // These are safe to transfer (this is safe for TBAA, even when we
541     // if-convert, because should that metadata have had a control dependency
542     // on the condition, and thus actually aliased with some other
543     // non-speculated memory access when the condition was false, this would be
544     // caught by the runtime overlap checks).
545     if (Kind != LLVMContext::MD_tbaa &&
546         Kind != LLVMContext::MD_alias_scope &&
547         Kind != LLVMContext::MD_noalias &&
548         Kind != LLVMContext::MD_fpmath)
549       continue;
550
551     To->setMetadata(Kind, M.second);
552   }
553 }
554
555 /// \brief Propagate known metadata from one instruction to a vector of others.
556 static void propagateMetadata(SmallVectorImpl<Value *> &To, const Instruction *From) {
557   for (Value *V : To)
558     if (Instruction *I = dyn_cast<Instruction>(V))
559       propagateMetadata(I, From);
560 }
561
562 /// LoopVectorizationLegality checks if it is legal to vectorize a loop, and
563 /// to what vectorization factor.
564 /// This class does not look at the profitability of vectorization, only the
565 /// legality. This class has two main kinds of checks:
566 /// * Memory checks - The code in canVectorizeMemory checks if vectorization
567 ///   will change the order of memory accesses in a way that will change the
568 ///   correctness of the program.
569 /// * Scalars checks - The code in canVectorizeInstrs and canVectorizeMemory
570 /// checks for a number of different conditions, such as the availability of a
571 /// single induction variable, that all types are supported and vectorize-able,
572 /// etc. This code reflects the capabilities of InnerLoopVectorizer.
573 /// This class is also used by InnerLoopVectorizer for identifying
574 /// induction variable and the different reduction variables.
575 class LoopVectorizationLegality {
576 public:
577   unsigned NumLoads;
578   unsigned NumStores;
579   unsigned NumPredStores;
580
581   LoopVectorizationLegality(Loop *L, ScalarEvolution *SE, const DataLayout *DL,
582                             DominatorTree *DT, TargetLibraryInfo *TLI,
583                             AliasAnalysis *AA, Function *F,
584                             const TargetTransformInfo *TTI)
585       : NumLoads(0), NumStores(0), NumPredStores(0), TheLoop(L), SE(SE), DL(DL),
586         DT(DT), TLI(TLI), AA(AA), TheFunction(F), TTI(TTI), Induction(nullptr),
587         WidestIndTy(nullptr), HasFunNoNaNAttr(false), MaxSafeDepDistBytes(-1U) {
588   }
589
590   /// This enum represents the kinds of reductions that we support.
591   enum ReductionKind {
592     RK_NoReduction, ///< Not a reduction.
593     RK_IntegerAdd,  ///< Sum of integers.
594     RK_IntegerMult, ///< Product of integers.
595     RK_IntegerOr,   ///< Bitwise or logical OR of numbers.
596     RK_IntegerAnd,  ///< Bitwise or logical AND of numbers.
597     RK_IntegerXor,  ///< Bitwise or logical XOR of numbers.
598     RK_IntegerMinMax, ///< Min/max implemented in terms of select(cmp()).
599     RK_FloatAdd,    ///< Sum of floats.
600     RK_FloatMult,   ///< Product of floats.
601     RK_FloatMinMax  ///< Min/max implemented in terms of select(cmp()).
602   };
603
604   /// This enum represents the kinds of inductions that we support.
605   enum InductionKind {
606     IK_NoInduction,         ///< Not an induction variable.
607     IK_IntInduction,        ///< Integer induction variable. Step = 1.
608     IK_ReverseIntInduction, ///< Reverse int induction variable. Step = -1.
609     IK_PtrInduction,        ///< Pointer induction var. Step = sizeof(elem).
610     IK_ReversePtrInduction  ///< Reverse ptr indvar. Step = - sizeof(elem).
611   };
612
613   // This enum represents the kind of minmax reduction.
614   enum MinMaxReductionKind {
615     MRK_Invalid,
616     MRK_UIntMin,
617     MRK_UIntMax,
618     MRK_SIntMin,
619     MRK_SIntMax,
620     MRK_FloatMin,
621     MRK_FloatMax
622   };
623
624   /// This struct holds information about reduction variables.
625   struct ReductionDescriptor {
626     ReductionDescriptor() : StartValue(nullptr), LoopExitInstr(nullptr),
627       Kind(RK_NoReduction), MinMaxKind(MRK_Invalid) {}
628
629     ReductionDescriptor(Value *Start, Instruction *Exit, ReductionKind K,
630                         MinMaxReductionKind MK)
631         : StartValue(Start), LoopExitInstr(Exit), Kind(K), MinMaxKind(MK) {}
632
633     // The starting value of the reduction.
634     // It does not have to be zero!
635     TrackingVH<Value> StartValue;
636     // The instruction who's value is used outside the loop.
637     Instruction *LoopExitInstr;
638     // The kind of the reduction.
639     ReductionKind Kind;
640     // If this a min/max reduction the kind of reduction.
641     MinMaxReductionKind MinMaxKind;
642   };
643
644   /// This POD struct holds information about a potential reduction operation.
645   struct ReductionInstDesc {
646     ReductionInstDesc(bool IsRedux, Instruction *I) :
647       IsReduction(IsRedux), PatternLastInst(I), MinMaxKind(MRK_Invalid) {}
648
649     ReductionInstDesc(Instruction *I, MinMaxReductionKind K) :
650       IsReduction(true), PatternLastInst(I), MinMaxKind(K) {}
651
652     // Is this instruction a reduction candidate.
653     bool IsReduction;
654     // The last instruction in a min/max pattern (select of the select(icmp())
655     // pattern), or the current reduction instruction otherwise.
656     Instruction *PatternLastInst;
657     // If this is a min/max pattern the comparison predicate.
658     MinMaxReductionKind MinMaxKind;
659   };
660
661   /// This struct holds information about the memory runtime legality
662   /// check that a group of pointers do not overlap.
663   struct RuntimePointerCheck {
664     RuntimePointerCheck() : Need(false) {}
665
666     /// Reset the state of the pointer runtime information.
667     void reset() {
668       Need = false;
669       Pointers.clear();
670       Starts.clear();
671       Ends.clear();
672       IsWritePtr.clear();
673       DependencySetId.clear();
674       AliasSetId.clear();
675     }
676
677     /// Insert a pointer and calculate the start and end SCEVs.
678     void insert(ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr,
679                 unsigned DepSetId, unsigned ASId, ValueToValueMap &Strides);
680
681     /// This flag indicates if we need to add the runtime check.
682     bool Need;
683     /// Holds the pointers that we need to check.
684     SmallVector<TrackingVH<Value>, 2> Pointers;
685     /// Holds the pointer value at the beginning of the loop.
686     SmallVector<const SCEV*, 2> Starts;
687     /// Holds the pointer value at the end of the loop.
688     SmallVector<const SCEV*, 2> Ends;
689     /// Holds the information if this pointer is used for writing to memory.
690     SmallVector<bool, 2> IsWritePtr;
691     /// Holds the id of the set of pointers that could be dependent because of a
692     /// shared underlying object.
693     SmallVector<unsigned, 2> DependencySetId;
694     /// Holds the id of the disjoint alias set to which this pointer belongs.
695     SmallVector<unsigned, 2> AliasSetId;
696   };
697
698   /// A struct for saving information about induction variables.
699   struct InductionInfo {
700     InductionInfo(Value *Start, InductionKind K) : StartValue(Start), IK(K) {}
701     InductionInfo() : StartValue(nullptr), IK(IK_NoInduction) {}
702     /// Start value.
703     TrackingVH<Value> StartValue;
704     /// Induction kind.
705     InductionKind IK;
706   };
707
708   /// ReductionList contains the reduction descriptors for all
709   /// of the reductions that were found in the loop.
710   typedef DenseMap<PHINode*, ReductionDescriptor> ReductionList;
711
712   /// InductionList saves induction variables and maps them to the
713   /// induction descriptor.
714   typedef MapVector<PHINode*, InductionInfo> InductionList;
715
716   /// Returns true if it is legal to vectorize this loop.
717   /// This does not mean that it is profitable to vectorize this
718   /// loop, only that it is legal to do so.
719   bool canVectorize();
720
721   /// Returns the Induction variable.
722   PHINode *getInduction() { return Induction; }
723
724   /// Returns the reduction variables found in the loop.
725   ReductionList *getReductionVars() { return &Reductions; }
726
727   /// Returns the induction variables found in the loop.
728   InductionList *getInductionVars() { return &Inductions; }
729
730   /// Returns the widest induction type.
731   Type *getWidestInductionType() { return WidestIndTy; }
732
733   /// Returns True if V is an induction variable in this loop.
734   bool isInductionVariable(const Value *V);
735
736   /// Return true if the block BB needs to be predicated in order for the loop
737   /// to be vectorized.
738   bool blockNeedsPredication(BasicBlock *BB);
739
740   /// Check if this  pointer is consecutive when vectorizing. This happens
741   /// when the last index of the GEP is the induction variable, or that the
742   /// pointer itself is an induction variable.
743   /// This check allows us to vectorize A[idx] into a wide load/store.
744   /// Returns:
745   /// 0 - Stride is unknown or non-consecutive.
746   /// 1 - Address is consecutive.
747   /// -1 - Address is consecutive, and decreasing.
748   int isConsecutivePtr(Value *Ptr);
749
750   /// Returns true if the value V is uniform within the loop.
751   bool isUniform(Value *V);
752
753   /// Returns true if this instruction will remain scalar after vectorization.
754   bool isUniformAfterVectorization(Instruction* I) { return Uniforms.count(I); }
755
756   /// Returns the information that we collected about runtime memory check.
757   RuntimePointerCheck *getRuntimePointerCheck() { return &PtrRtCheck; }
758
759   /// This function returns the identity element (or neutral element) for
760   /// the operation K.
761   static Constant *getReductionIdentity(ReductionKind K, Type *Tp);
762
763   unsigned getMaxSafeDepDistBytes() { return MaxSafeDepDistBytes; }
764
765   bool hasStride(Value *V) { return StrideSet.count(V); }
766   bool mustCheckStrides() { return !StrideSet.empty(); }
767   SmallPtrSet<Value *, 8>::iterator strides_begin() {
768     return StrideSet.begin();
769   }
770   SmallPtrSet<Value *, 8>::iterator strides_end() { return StrideSet.end(); }
771
772   /// Returns true if the target machine supports masked store operation
773   /// for the given \p DataType and kind of access to \p Ptr.
774   bool isLegalMaskedStore(Type *DataType, Value *Ptr) {
775     return TTI->isLegalMaskedStore(DataType, isConsecutivePtr(Ptr));
776   }
777   /// Returns true if the target machine supports masked load operation
778   /// for the given \p DataType and kind of access to \p Ptr.
779   bool isLegalMaskedLoad(Type *DataType, Value *Ptr) {
780     return TTI->isLegalMaskedLoad(DataType, isConsecutivePtr(Ptr));
781   }
782   /// Returns true if vector representation of the instruction \p I
783   /// requires mask.
784   bool isMaskRequired(const Instruction* I) {
785     return (MaskedOp.count(I) != 0);
786   }
787 private:
788   /// Check if a single basic block loop is vectorizable.
789   /// At this point we know that this is a loop with a constant trip count
790   /// and we only need to check individual instructions.
791   bool canVectorizeInstrs();
792
793   /// When we vectorize loops we may change the order in which
794   /// we read and write from memory. This method checks if it is
795   /// legal to vectorize the code, considering only memory constrains.
796   /// Returns true if the loop is vectorizable
797   bool canVectorizeMemory();
798
799   /// Return true if we can vectorize this loop using the IF-conversion
800   /// transformation.
801   bool canVectorizeWithIfConvert();
802
803   /// Collect the variables that need to stay uniform after vectorization.
804   void collectLoopUniforms();
805
806   /// Return true if all of the instructions in the block can be speculatively
807   /// executed. \p SafePtrs is a list of addresses that are known to be legal
808   /// and we know that we can read from them without segfault.
809   bool blockCanBePredicated(BasicBlock *BB, SmallPtrSetImpl<Value *> &SafePtrs);
810
811   /// Returns True, if 'Phi' is the kind of reduction variable for type
812   /// 'Kind'. If this is a reduction variable, it adds it to ReductionList.
813   bool AddReductionVar(PHINode *Phi, ReductionKind Kind);
814   /// Returns a struct describing if the instruction 'I' can be a reduction
815   /// variable of type 'Kind'. If the reduction is a min/max pattern of
816   /// select(icmp()) this function advances the instruction pointer 'I' from the
817   /// compare instruction to the select instruction and stores this pointer in
818   /// 'PatternLastInst' member of the returned struct.
819   ReductionInstDesc isReductionInstr(Instruction *I, ReductionKind Kind,
820                                      ReductionInstDesc &Desc);
821   /// Returns true if the instruction is a Select(ICmp(X, Y), X, Y) instruction
822   /// pattern corresponding to a min(X, Y) or max(X, Y).
823   static ReductionInstDesc isMinMaxSelectCmpPattern(Instruction *I,
824                                                     ReductionInstDesc &Prev);
825   /// Returns the induction kind of Phi. This function may return NoInduction
826   /// if the PHI is not an induction variable.
827   InductionKind isInductionVariable(PHINode *Phi);
828
829   /// \brief Collect memory access with loop invariant strides.
830   ///
831   /// Looks for accesses like "a[i * StrideA]" where "StrideA" is loop
832   /// invariant.
833   void collectStridedAccess(Value *LoadOrStoreInst);
834
835   /// Report an analysis message to assist the user in diagnosing loops that are
836   /// not vectorized.
837   void emitAnalysis(Report &Message) {
838     DebugLoc DL = TheLoop->getStartLoc();
839     if (Instruction *I = Message.getInstr())
840       DL = I->getDebugLoc();
841     emitOptimizationRemarkAnalysis(TheFunction->getContext(), DEBUG_TYPE,
842                                    *TheFunction, DL, Message.str());
843   }
844
845   /// The loop that we evaluate.
846   Loop *TheLoop;
847   /// Scev analysis.
848   ScalarEvolution *SE;
849   /// DataLayout analysis.
850   const DataLayout *DL;
851   /// Dominators.
852   DominatorTree *DT;
853   /// Target Library Info.
854   TargetLibraryInfo *TLI;
855   /// Alias analysis.
856   AliasAnalysis *AA;
857   /// Parent function
858   Function *TheFunction;
859   /// Target Transform Info
860   const TargetTransformInfo *TTI;
861
862   //  ---  vectorization state --- //
863
864   /// Holds the integer induction variable. This is the counter of the
865   /// loop.
866   PHINode *Induction;
867   /// Holds the reduction variables.
868   ReductionList Reductions;
869   /// Holds all of the induction variables that we found in the loop.
870   /// Notice that inductions don't need to start at zero and that induction
871   /// variables can be pointers.
872   InductionList Inductions;
873   /// Holds the widest induction type encountered.
874   Type *WidestIndTy;
875
876   /// Allowed outside users. This holds the reduction
877   /// vars which can be accessed from outside the loop.
878   SmallPtrSet<Value*, 4> AllowedExit;
879   /// This set holds the variables which are known to be uniform after
880   /// vectorization.
881   SmallPtrSet<Instruction*, 4> Uniforms;
882   /// We need to check that all of the pointers in this list are disjoint
883   /// at runtime.
884   RuntimePointerCheck PtrRtCheck;
885   /// Can we assume the absence of NaNs.
886   bool HasFunNoNaNAttr;
887
888   unsigned MaxSafeDepDistBytes;
889
890   ValueToValueMap Strides;
891   SmallPtrSet<Value *, 8> StrideSet;
892   
893   /// While vectorizing these instructions we have to generate a
894   /// call to the appropriate masked intrinsic
895   SmallPtrSet<const Instruction*, 8> MaskedOp;
896 };
897
898 /// LoopVectorizationCostModel - estimates the expected speedups due to
899 /// vectorization.
900 /// In many cases vectorization is not profitable. This can happen because of
901 /// a number of reasons. In this class we mainly attempt to predict the
902 /// expected speedup/slowdowns due to the supported instruction set. We use the
903 /// TargetTransformInfo to query the different backends for the cost of
904 /// different operations.
905 class LoopVectorizationCostModel {
906 public:
907   LoopVectorizationCostModel(Loop *L, ScalarEvolution *SE, LoopInfo *LI,
908                              LoopVectorizationLegality *Legal,
909                              const TargetTransformInfo &TTI,
910                              const DataLayout *DL, const TargetLibraryInfo *TLI,
911                              AssumptionCache *AC, const Function *F,
912                              const LoopVectorizeHints *Hints)
913       : TheLoop(L), SE(SE), LI(LI), Legal(Legal), TTI(TTI), DL(DL), TLI(TLI),
914         TheFunction(F), Hints(Hints) {
915     CodeMetrics::collectEphemeralValues(L, AC, EphValues);
916   }
917
918   /// Information about vectorization costs
919   struct VectorizationFactor {
920     unsigned Width; // Vector width with best cost
921     unsigned Cost; // Cost of the loop with that width
922   };
923   /// \return The most profitable vectorization factor and the cost of that VF.
924   /// This method checks every power of two up to VF. If UserVF is not ZERO
925   /// then this vectorization factor will be selected if vectorization is
926   /// possible.
927   VectorizationFactor selectVectorizationFactor(bool OptForSize);
928
929   /// \return The size (in bits) of the widest type in the code that
930   /// needs to be vectorized. We ignore values that remain scalar such as
931   /// 64 bit loop indices.
932   unsigned getWidestType();
933
934   /// \return The most profitable unroll factor.
935   /// If UserUF is non-zero then this method finds the best unroll-factor
936   /// based on register pressure and other parameters.
937   /// VF and LoopCost are the selected vectorization factor and the cost of the
938   /// selected VF.
939   unsigned selectUnrollFactor(bool OptForSize, unsigned VF, unsigned LoopCost);
940
941   /// \brief A struct that represents some properties of the register usage
942   /// of a loop.
943   struct RegisterUsage {
944     /// Holds the number of loop invariant values that are used in the loop.
945     unsigned LoopInvariantRegs;
946     /// Holds the maximum number of concurrent live intervals in the loop.
947     unsigned MaxLocalUsers;
948     /// Holds the number of instructions in the loop.
949     unsigned NumInstructions;
950   };
951
952   /// \return  information about the register usage of the loop.
953   RegisterUsage calculateRegisterUsage();
954
955 private:
956   /// Returns the expected execution cost. The unit of the cost does
957   /// not matter because we use the 'cost' units to compare different
958   /// vector widths. The cost that is returned is *not* normalized by
959   /// the factor width.
960   unsigned expectedCost(unsigned VF);
961
962   /// Returns the execution time cost of an instruction for a given vector
963   /// width. Vector width of one means scalar.
964   unsigned getInstructionCost(Instruction *I, unsigned VF);
965
966   /// A helper function for converting Scalar types to vector types.
967   /// If the incoming type is void, we return void. If the VF is 1, we return
968   /// the scalar type.
969   static Type* ToVectorTy(Type *Scalar, unsigned VF);
970
971   /// Returns whether the instruction is a load or store and will be a emitted
972   /// as a vector operation.
973   bool isConsecutiveLoadOrStore(Instruction *I);
974
975   /// Report an analysis message to assist the user in diagnosing loops that are
976   /// not vectorized.
977   void emitAnalysis(Report &Message) {
978     DebugLoc DL = TheLoop->getStartLoc();
979     if (Instruction *I = Message.getInstr())
980       DL = I->getDebugLoc();
981     emitOptimizationRemarkAnalysis(TheFunction->getContext(), DEBUG_TYPE,
982                                    *TheFunction, DL, Message.str());
983   }
984
985   /// Values used only by @llvm.assume calls.
986   SmallPtrSet<const Value *, 32> EphValues;
987
988   /// The loop that we evaluate.
989   Loop *TheLoop;
990   /// Scev analysis.
991   ScalarEvolution *SE;
992   /// Loop Info analysis.
993   LoopInfo *LI;
994   /// Vectorization legality.
995   LoopVectorizationLegality *Legal;
996   /// Vector target information.
997   const TargetTransformInfo &TTI;
998   /// Target data layout information.
999   const DataLayout *DL;
1000   /// Target Library Info.
1001   const TargetLibraryInfo *TLI;
1002   const Function *TheFunction;
1003   // Loop Vectorize Hint.
1004   const LoopVectorizeHints *Hints;
1005 };
1006
1007 /// Utility class for getting and setting loop vectorizer hints in the form
1008 /// of loop metadata.
1009 /// This class keeps a number of loop annotations locally (as member variables)
1010 /// and can, upon request, write them back as metadata on the loop. It will
1011 /// initially scan the loop for existing metadata, and will update the local
1012 /// values based on information in the loop.
1013 /// We cannot write all values to metadata, as the mere presence of some info,
1014 /// for example 'force', means a decision has been made. So, we need to be
1015 /// careful NOT to add them if the user hasn't specifically asked so.
1016 class LoopVectorizeHints {
1017   enum HintKind {
1018     HK_WIDTH,
1019     HK_UNROLL,
1020     HK_FORCE
1021   };
1022
1023   /// Hint - associates name and validation with the hint value.
1024   struct Hint {
1025     const char * Name;
1026     unsigned Value; // This may have to change for non-numeric values.
1027     HintKind Kind;
1028
1029     Hint(const char * Name, unsigned Value, HintKind Kind)
1030       : Name(Name), Value(Value), Kind(Kind) { }
1031
1032     bool validate(unsigned Val) {
1033       switch (Kind) {
1034       case HK_WIDTH:
1035         return isPowerOf2_32(Val) && Val <= MaxVectorWidth;
1036       case HK_UNROLL:
1037         return isPowerOf2_32(Val) && Val <= MaxInterleaveFactor;
1038       case HK_FORCE:
1039         return (Val <= 1);
1040       }
1041       return false;
1042     }
1043   };
1044
1045   /// Vectorization width.
1046   Hint Width;
1047   /// Vectorization interleave factor.
1048   Hint Interleave;
1049   /// Vectorization forced
1050   Hint Force;
1051
1052   /// Return the loop metadata prefix.
1053   static StringRef Prefix() { return "llvm.loop."; }
1054
1055 public:
1056   enum ForceKind {
1057     FK_Undefined = -1, ///< Not selected.
1058     FK_Disabled = 0,   ///< Forcing disabled.
1059     FK_Enabled = 1,    ///< Forcing enabled.
1060   };
1061
1062   LoopVectorizeHints(const Loop *L, bool DisableInterleaving)
1063       : Width("vectorize.width", VectorizationFactor, HK_WIDTH),
1064         Interleave("interleave.count", DisableInterleaving, HK_UNROLL),
1065         Force("vectorize.enable", FK_Undefined, HK_FORCE),
1066         TheLoop(L) {
1067     // Populate values with existing loop metadata.
1068     getHintsFromMetadata();
1069
1070     // force-vector-interleave overrides DisableInterleaving.
1071     if (VectorizationInterleave.getNumOccurrences() > 0)
1072       Interleave.Value = VectorizationInterleave;
1073
1074     DEBUG(if (DisableInterleaving && Interleave.Value == 1) dbgs()
1075           << "LV: Interleaving disabled by the pass manager\n");
1076   }
1077
1078   /// Mark the loop L as already vectorized by setting the width to 1.
1079   void setAlreadyVectorized() {
1080     Width.Value = Interleave.Value = 1;
1081     Hint Hints[] = {Width, Interleave};
1082     writeHintsToMetadata(Hints);
1083   }
1084
1085   /// Dumps all the hint information.
1086   std::string emitRemark() const {
1087     Report R;
1088     if (Force.Value == LoopVectorizeHints::FK_Disabled)
1089       R << "vectorization is explicitly disabled";
1090     else {
1091       R << "use -Rpass-analysis=loop-vectorize for more info";
1092       if (Force.Value == LoopVectorizeHints::FK_Enabled) {
1093         R << " (Force=true";
1094         if (Width.Value != 0)
1095           R << ", Vector Width=" << Width.Value;
1096         if (Interleave.Value != 0)
1097           R << ", Interleave Count=" << Interleave.Value;
1098         R << ")";
1099       }
1100     }
1101
1102     return R.str();
1103   }
1104
1105   unsigned getWidth() const { return Width.Value; }
1106   unsigned getInterleave() const { return Interleave.Value; }
1107   enum ForceKind getForce() const { return (ForceKind)Force.Value; }
1108
1109 private:
1110   /// Find hints specified in the loop metadata and update local values.
1111   void getHintsFromMetadata() {
1112     MDNode *LoopID = TheLoop->getLoopID();
1113     if (!LoopID)
1114       return;
1115
1116     // First operand should refer to the loop id itself.
1117     assert(LoopID->getNumOperands() > 0 && "requires at least one operand");
1118     assert(LoopID->getOperand(0) == LoopID && "invalid loop id");
1119
1120     for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
1121       const MDString *S = nullptr;
1122       SmallVector<Metadata *, 4> Args;
1123
1124       // The expected hint is either a MDString or a MDNode with the first
1125       // operand a MDString.
1126       if (const MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i))) {
1127         if (!MD || MD->getNumOperands() == 0)
1128           continue;
1129         S = dyn_cast<MDString>(MD->getOperand(0));
1130         for (unsigned i = 1, ie = MD->getNumOperands(); i < ie; ++i)
1131           Args.push_back(MD->getOperand(i));
1132       } else {
1133         S = dyn_cast<MDString>(LoopID->getOperand(i));
1134         assert(Args.size() == 0 && "too many arguments for MDString");
1135       }
1136
1137       if (!S)
1138         continue;
1139
1140       // Check if the hint starts with the loop metadata prefix.
1141       StringRef Name = S->getString();
1142       if (Args.size() == 1)
1143         setHint(Name, Args[0]);
1144     }
1145   }
1146
1147   /// Checks string hint with one operand and set value if valid.
1148   void setHint(StringRef Name, Metadata *Arg) {
1149     if (!Name.startswith(Prefix()))
1150       return;
1151     Name = Name.substr(Prefix().size(), StringRef::npos);
1152
1153     const ConstantInt *C = mdconst::dyn_extract<ConstantInt>(Arg);
1154     if (!C) return;
1155     unsigned Val = C->getZExtValue();
1156
1157     Hint *Hints[] = {&Width, &Interleave, &Force};
1158     for (auto H : Hints) {
1159       if (Name == H->Name) {
1160         if (H->validate(Val))
1161           H->Value = Val;
1162         else
1163           DEBUG(dbgs() << "LV: ignoring invalid hint '" << Name << "'\n");
1164         break;
1165       }
1166     }
1167   }
1168
1169   /// Create a new hint from name / value pair.
1170   MDNode *createHintMetadata(StringRef Name, unsigned V) const {
1171     LLVMContext &Context = TheLoop->getHeader()->getContext();
1172     Metadata *MDs[] = {MDString::get(Context, Name),
1173                        ConstantAsMetadata::get(
1174                            ConstantInt::get(Type::getInt32Ty(Context), V))};
1175     return MDNode::get(Context, MDs);
1176   }
1177
1178   /// Matches metadata with hint name.
1179   bool matchesHintMetadataName(MDNode *Node, ArrayRef<Hint> HintTypes) {
1180     MDString* Name = dyn_cast<MDString>(Node->getOperand(0));
1181     if (!Name)
1182       return false;
1183
1184     for (auto H : HintTypes)
1185       if (Name->getString().endswith(H.Name))
1186         return true;
1187     return false;
1188   }
1189
1190   /// Sets current hints into loop metadata, keeping other values intact.
1191   void writeHintsToMetadata(ArrayRef<Hint> HintTypes) {
1192     if (HintTypes.size() == 0)
1193       return;
1194
1195     // Reserve the first element to LoopID (see below).
1196     SmallVector<Metadata *, 4> MDs(1);
1197     // If the loop already has metadata, then ignore the existing operands.
1198     MDNode *LoopID = TheLoop->getLoopID();
1199     if (LoopID) {
1200       for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
1201         MDNode *Node = cast<MDNode>(LoopID->getOperand(i));
1202         // If node in update list, ignore old value.
1203         if (!matchesHintMetadataName(Node, HintTypes))
1204           MDs.push_back(Node);
1205       }
1206     }
1207
1208     // Now, add the missing hints.
1209     for (auto H : HintTypes)
1210       MDs.push_back(createHintMetadata(Twine(Prefix(), H.Name).str(), H.Value));
1211
1212     // Replace current metadata node with new one.
1213     LLVMContext &Context = TheLoop->getHeader()->getContext();
1214     MDNode *NewLoopID = MDNode::get(Context, MDs);
1215     // Set operand 0 to refer to the loop id itself.
1216     NewLoopID->replaceOperandWith(0, NewLoopID);
1217
1218     TheLoop->setLoopID(NewLoopID);
1219   }
1220
1221   /// The loop these hints belong to.
1222   const Loop *TheLoop;
1223 };
1224
1225 static void emitMissedWarning(Function *F, Loop *L,
1226                               const LoopVectorizeHints &LH) {
1227   emitOptimizationRemarkMissed(F->getContext(), DEBUG_TYPE, *F,
1228                                L->getStartLoc(), LH.emitRemark());
1229
1230   if (LH.getForce() == LoopVectorizeHints::FK_Enabled) {
1231     if (LH.getWidth() != 1)
1232       emitLoopVectorizeWarning(
1233           F->getContext(), *F, L->getStartLoc(),
1234           "failed explicitly specified loop vectorization");
1235     else if (LH.getInterleave() != 1)
1236       emitLoopInterleaveWarning(
1237           F->getContext(), *F, L->getStartLoc(),
1238           "failed explicitly specified loop interleaving");
1239   }
1240 }
1241
1242 static void addInnerLoop(Loop &L, SmallVectorImpl<Loop *> &V) {
1243   if (L.empty())
1244     return V.push_back(&L);
1245
1246   for (Loop *InnerL : L)
1247     addInnerLoop(*InnerL, V);
1248 }
1249
1250 /// The LoopVectorize Pass.
1251 struct LoopVectorize : public FunctionPass {
1252   /// Pass identification, replacement for typeid
1253   static char ID;
1254
1255   explicit LoopVectorize(bool NoUnrolling = false, bool AlwaysVectorize = true)
1256     : FunctionPass(ID),
1257       DisableUnrolling(NoUnrolling),
1258       AlwaysVectorize(AlwaysVectorize) {
1259     initializeLoopVectorizePass(*PassRegistry::getPassRegistry());
1260   }
1261
1262   ScalarEvolution *SE;
1263   const DataLayout *DL;
1264   LoopInfo *LI;
1265   TargetTransformInfo *TTI;
1266   DominatorTree *DT;
1267   BlockFrequencyInfo *BFI;
1268   TargetLibraryInfo *TLI;
1269   AliasAnalysis *AA;
1270   AssumptionCache *AC;
1271   bool DisableUnrolling;
1272   bool AlwaysVectorize;
1273
1274   BlockFrequency ColdEntryFreq;
1275
1276   bool runOnFunction(Function &F) override {
1277     SE = &getAnalysis<ScalarEvolution>();
1278     DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
1279     DL = DLP ? &DLP->getDataLayout() : nullptr;
1280     LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
1281     TTI = &getAnalysis<TargetTransformInfo>();
1282     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1283     BFI = &getAnalysis<BlockFrequencyInfo>();
1284     auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
1285     TLI = TLIP ? &TLIP->getTLI() : nullptr;
1286     AA = &getAnalysis<AliasAnalysis>();
1287     AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
1288
1289     // Compute some weights outside of the loop over the loops. Compute this
1290     // using a BranchProbability to re-use its scaling math.
1291     const BranchProbability ColdProb(1, 5); // 20%
1292     ColdEntryFreq = BlockFrequency(BFI->getEntryFreq()) * ColdProb;
1293
1294     // If the target claims to have no vector registers don't attempt
1295     // vectorization.
1296     if (!TTI->getNumberOfRegisters(true))
1297       return false;
1298
1299     if (!DL) {
1300       DEBUG(dbgs() << "\nLV: Not vectorizing " << F.getName()
1301                    << ": Missing data layout\n");
1302       return false;
1303     }
1304
1305     // Build up a worklist of inner-loops to vectorize. This is necessary as
1306     // the act of vectorizing or partially unrolling a loop creates new loops
1307     // and can invalidate iterators across the loops.
1308     SmallVector<Loop *, 8> Worklist;
1309
1310     for (Loop *L : *LI)
1311       addInnerLoop(*L, Worklist);
1312
1313     LoopsAnalyzed += Worklist.size();
1314
1315     // Now walk the identified inner loops.
1316     bool Changed = false;
1317     while (!Worklist.empty())
1318       Changed |= processLoop(Worklist.pop_back_val());
1319
1320     // Process each loop nest in the function.
1321     return Changed;
1322   }
1323
1324   bool processLoop(Loop *L) {
1325     assert(L->empty() && "Only process inner loops.");
1326
1327 #ifndef NDEBUG
1328     const std::string DebugLocStr = getDebugLocString(L);
1329 #endif /* NDEBUG */
1330
1331     DEBUG(dbgs() << "\nLV: Checking a loop in \""
1332                  << L->getHeader()->getParent()->getName() << "\" from "
1333                  << DebugLocStr << "\n");
1334
1335     LoopVectorizeHints Hints(L, DisableUnrolling);
1336
1337     DEBUG(dbgs() << "LV: Loop hints:"
1338                  << " force="
1339                  << (Hints.getForce() == LoopVectorizeHints::FK_Disabled
1340                          ? "disabled"
1341                          : (Hints.getForce() == LoopVectorizeHints::FK_Enabled
1342                                 ? "enabled"
1343                                 : "?")) << " width=" << Hints.getWidth()
1344                  << " unroll=" << Hints.getInterleave() << "\n");
1345
1346     // Function containing loop
1347     Function *F = L->getHeader()->getParent();
1348
1349     // Looking at the diagnostic output is the only way to determine if a loop
1350     // was vectorized (other than looking at the IR or machine code), so it
1351     // is important to generate an optimization remark for each loop. Most of
1352     // these messages are generated by emitOptimizationRemarkAnalysis. Remarks
1353     // generated by emitOptimizationRemark and emitOptimizationRemarkMissed are
1354     // less verbose reporting vectorized loops and unvectorized loops that may
1355     // benefit from vectorization, respectively.
1356
1357     if (Hints.getForce() == LoopVectorizeHints::FK_Disabled) {
1358       DEBUG(dbgs() << "LV: Not vectorizing: #pragma vectorize disable.\n");
1359       emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F,
1360                                      L->getStartLoc(), Hints.emitRemark());
1361       return false;
1362     }
1363
1364     if (!AlwaysVectorize && Hints.getForce() != LoopVectorizeHints::FK_Enabled) {
1365       DEBUG(dbgs() << "LV: Not vectorizing: No #pragma vectorize enable.\n");
1366       emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F,
1367                                      L->getStartLoc(), Hints.emitRemark());
1368       return false;
1369     }
1370
1371     if (Hints.getWidth() == 1 && Hints.getInterleave() == 1) {
1372       DEBUG(dbgs() << "LV: Not vectorizing: Disabled/already vectorized.\n");
1373       emitOptimizationRemarkAnalysis(
1374           F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1375           "loop not vectorized: vector width and interleave count are "
1376           "explicitly set to 1");
1377       return false;
1378     }
1379
1380     // Check the loop for a trip count threshold:
1381     // do not vectorize loops with a tiny trip count.
1382     const unsigned TC = SE->getSmallConstantTripCount(L);
1383     if (TC > 0u && TC < TinyTripCountVectorThreshold) {
1384       DEBUG(dbgs() << "LV: Found a loop with a very small trip count. "
1385                    << "This loop is not worth vectorizing.");
1386       if (Hints.getForce() == LoopVectorizeHints::FK_Enabled)
1387         DEBUG(dbgs() << " But vectorizing was explicitly forced.\n");
1388       else {
1389         DEBUG(dbgs() << "\n");
1390         emitOptimizationRemarkAnalysis(
1391             F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1392             "vectorization is not beneficial and is not explicitly forced");
1393         return false;
1394       }
1395     }
1396
1397     // Check if it is legal to vectorize the loop.
1398     LoopVectorizationLegality LVL(L, SE, DL, DT, TLI, AA, F, TTI);
1399     if (!LVL.canVectorize()) {
1400       DEBUG(dbgs() << "LV: Not vectorizing: Cannot prove legality.\n");
1401       emitMissedWarning(F, L, Hints);
1402       return false;
1403     }
1404
1405     // Use the cost model.
1406     LoopVectorizationCostModel CM(L, SE, LI, &LVL, *TTI, DL, TLI, AC, F,
1407                                   &Hints);
1408
1409     // Check the function attributes to find out if this function should be
1410     // optimized for size.
1411     bool OptForSize = Hints.getForce() != LoopVectorizeHints::FK_Enabled &&
1412                       F->hasFnAttribute(Attribute::OptimizeForSize);
1413
1414     // Compute the weighted frequency of this loop being executed and see if it
1415     // is less than 20% of the function entry baseline frequency. Note that we
1416     // always have a canonical loop here because we think we *can* vectoriez.
1417     // FIXME: This is hidden behind a flag due to pervasive problems with
1418     // exactly what block frequency models.
1419     if (LoopVectorizeWithBlockFrequency) {
1420       BlockFrequency LoopEntryFreq = BFI->getBlockFreq(L->getLoopPreheader());
1421       if (Hints.getForce() != LoopVectorizeHints::FK_Enabled &&
1422           LoopEntryFreq < ColdEntryFreq)
1423         OptForSize = true;
1424     }
1425
1426     // Check the function attributes to see if implicit floats are allowed.a
1427     // FIXME: This check doesn't seem possibly correct -- what if the loop is
1428     // an integer loop and the vector instructions selected are purely integer
1429     // vector instructions?
1430     if (F->hasFnAttribute(Attribute::NoImplicitFloat)) {
1431       DEBUG(dbgs() << "LV: Can't vectorize when the NoImplicitFloat"
1432             "attribute is used.\n");
1433       emitOptimizationRemarkAnalysis(
1434           F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1435           "loop not vectorized due to NoImplicitFloat attribute");
1436       emitMissedWarning(F, L, Hints);
1437       return false;
1438     }
1439
1440     // Select the optimal vectorization factor.
1441     const LoopVectorizationCostModel::VectorizationFactor VF =
1442         CM.selectVectorizationFactor(OptForSize);
1443
1444     // Select the unroll factor.
1445     const unsigned UF =
1446         CM.selectUnrollFactor(OptForSize, VF.Width, VF.Cost);
1447
1448     DEBUG(dbgs() << "LV: Found a vectorizable loop (" << VF.Width << ") in "
1449                  << DebugLocStr << '\n');
1450     DEBUG(dbgs() << "LV: Unroll Factor is " << UF << '\n');
1451
1452     if (VF.Width == 1) {
1453       DEBUG(dbgs() << "LV: Vectorization is possible but not beneficial\n");
1454
1455       if (UF == 1) {
1456         emitOptimizationRemarkAnalysis(
1457             F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1458             "not beneficial to vectorize and user disabled interleaving");
1459         return false;
1460       }
1461       DEBUG(dbgs() << "LV: Trying to at least unroll the loops.\n");
1462
1463       // Report the unrolling decision.
1464       emitOptimizationRemark(F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1465                              Twine("unrolled with interleaving factor " +
1466                                    Twine(UF) +
1467                                    " (vectorization not beneficial)"));
1468
1469       // We decided not to vectorize, but we may want to unroll.
1470
1471       InnerLoopUnroller Unroller(L, SE, LI, DT, DL, TLI, UF);
1472       Unroller.vectorize(&LVL);
1473     } else {
1474       // If we decided that it is *legal* to vectorize the loop then do it.
1475       InnerLoopVectorizer LB(L, SE, LI, DT, DL, TLI, VF.Width, UF);
1476       LB.vectorize(&LVL);
1477       ++LoopsVectorized;
1478
1479       // Report the vectorization decision.
1480       emitOptimizationRemark(
1481           F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1482           Twine("vectorized loop (vectorization factor: ") + Twine(VF.Width) +
1483               ", unrolling interleave factor: " + Twine(UF) + ")");
1484     }
1485
1486     // Mark the loop as already vectorized to avoid vectorizing again.
1487     Hints.setAlreadyVectorized();
1488
1489     DEBUG(verifyFunction(*L->getHeader()->getParent()));
1490     return true;
1491   }
1492
1493   void getAnalysisUsage(AnalysisUsage &AU) const override {
1494     AU.addRequired<AssumptionCacheTracker>();
1495     AU.addRequiredID(LoopSimplifyID);
1496     AU.addRequiredID(LCSSAID);
1497     AU.addRequired<BlockFrequencyInfo>();
1498     AU.addRequired<DominatorTreeWrapperPass>();
1499     AU.addRequired<LoopInfoWrapperPass>();
1500     AU.addRequired<ScalarEvolution>();
1501     AU.addRequired<TargetTransformInfo>();
1502     AU.addRequired<AliasAnalysis>();
1503     AU.addPreserved<LoopInfoWrapperPass>();
1504     AU.addPreserved<DominatorTreeWrapperPass>();
1505     AU.addPreserved<AliasAnalysis>();
1506   }
1507
1508 };
1509
1510 } // end anonymous namespace
1511
1512 //===----------------------------------------------------------------------===//
1513 // Implementation of LoopVectorizationLegality, InnerLoopVectorizer and
1514 // LoopVectorizationCostModel.
1515 //===----------------------------------------------------------------------===//
1516
1517 static Value *stripIntegerCast(Value *V) {
1518   if (CastInst *CI = dyn_cast<CastInst>(V))
1519     if (CI->getOperand(0)->getType()->isIntegerTy())
1520       return CI->getOperand(0);
1521   return V;
1522 }
1523
1524 ///\brief Replaces the symbolic stride in a pointer SCEV expression by one.
1525 ///
1526 /// If \p OrigPtr is not null, use it to look up the stride value instead of
1527 /// \p Ptr.
1528 static const SCEV *replaceSymbolicStrideSCEV(ScalarEvolution *SE,
1529                                              ValueToValueMap &PtrToStride,
1530                                              Value *Ptr, Value *OrigPtr = nullptr) {
1531
1532   const SCEV *OrigSCEV = SE->getSCEV(Ptr);
1533
1534   // If there is an entry in the map return the SCEV of the pointer with the
1535   // symbolic stride replaced by one.
1536   ValueToValueMap::iterator SI = PtrToStride.find(OrigPtr ? OrigPtr : Ptr);
1537   if (SI != PtrToStride.end()) {
1538     Value *StrideVal = SI->second;
1539
1540     // Strip casts.
1541     StrideVal = stripIntegerCast(StrideVal);
1542
1543     // Replace symbolic stride by one.
1544     Value *One = ConstantInt::get(StrideVal->getType(), 1);
1545     ValueToValueMap RewriteMap;
1546     RewriteMap[StrideVal] = One;
1547
1548     const SCEV *ByOne =
1549         SCEVParameterRewriter::rewrite(OrigSCEV, *SE, RewriteMap, true);
1550     DEBUG(dbgs() << "LV: Replacing SCEV: " << *OrigSCEV << " by: " << *ByOne
1551                  << "\n");
1552     return ByOne;
1553   }
1554
1555   // Otherwise, just return the SCEV of the original pointer.
1556   return SE->getSCEV(Ptr);
1557 }
1558
1559 void LoopVectorizationLegality::RuntimePointerCheck::insert(
1560     ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr, unsigned DepSetId,
1561     unsigned ASId, ValueToValueMap &Strides) {
1562   // Get the stride replaced scev.
1563   const SCEV *Sc = replaceSymbolicStrideSCEV(SE, Strides, Ptr);
1564   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Sc);
1565   assert(AR && "Invalid addrec expression");
1566   const SCEV *Ex = SE->getBackedgeTakenCount(Lp);
1567   const SCEV *ScEnd = AR->evaluateAtIteration(Ex, *SE);
1568   Pointers.push_back(Ptr);
1569   Starts.push_back(AR->getStart());
1570   Ends.push_back(ScEnd);
1571   IsWritePtr.push_back(WritePtr);
1572   DependencySetId.push_back(DepSetId);
1573   AliasSetId.push_back(ASId);
1574 }
1575
1576 Value *InnerLoopVectorizer::getBroadcastInstrs(Value *V) {
1577   // We need to place the broadcast of invariant variables outside the loop.
1578   Instruction *Instr = dyn_cast<Instruction>(V);
1579   bool NewInstr =
1580       (Instr && std::find(LoopVectorBody.begin(), LoopVectorBody.end(),
1581                           Instr->getParent()) != LoopVectorBody.end());
1582   bool Invariant = OrigLoop->isLoopInvariant(V) && !NewInstr;
1583
1584   // Place the code for broadcasting invariant variables in the new preheader.
1585   IRBuilder<>::InsertPointGuard Guard(Builder);
1586   if (Invariant)
1587     Builder.SetInsertPoint(LoopVectorPreHeader->getTerminator());
1588
1589   // Broadcast the scalar into all locations in the vector.
1590   Value *Shuf = Builder.CreateVectorSplat(VF, V, "broadcast");
1591
1592   return Shuf;
1593 }
1594
1595 Value *InnerLoopVectorizer::getConsecutiveVector(Value* Val, int StartIdx,
1596                                                  bool Negate) {
1597   assert(Val->getType()->isVectorTy() && "Must be a vector");
1598   assert(Val->getType()->getScalarType()->isIntegerTy() &&
1599          "Elem must be an integer");
1600   // Create the types.
1601   Type *ITy = Val->getType()->getScalarType();
1602   VectorType *Ty = cast<VectorType>(Val->getType());
1603   int VLen = Ty->getNumElements();
1604   SmallVector<Constant*, 8> Indices;
1605
1606   // Create a vector of consecutive numbers from zero to VF.
1607   for (int i = 0; i < VLen; ++i) {
1608     int64_t Idx = Negate ? (-i) : i;
1609     Indices.push_back(ConstantInt::get(ITy, StartIdx + Idx, Negate));
1610   }
1611
1612   // Add the consecutive indices to the vector value.
1613   Constant *Cv = ConstantVector::get(Indices);
1614   assert(Cv->getType() == Val->getType() && "Invalid consecutive vec");
1615   return Builder.CreateAdd(Val, Cv, "induction");
1616 }
1617
1618 /// \brief Find the operand of the GEP that should be checked for consecutive
1619 /// stores. This ignores trailing indices that have no effect on the final
1620 /// pointer.
1621 static unsigned getGEPInductionOperand(const DataLayout *DL,
1622                                        const GetElementPtrInst *Gep) {
1623   unsigned LastOperand = Gep->getNumOperands() - 1;
1624   unsigned GEPAllocSize = DL->getTypeAllocSize(
1625       cast<PointerType>(Gep->getType()->getScalarType())->getElementType());
1626
1627   // Walk backwards and try to peel off zeros.
1628   while (LastOperand > 1 && match(Gep->getOperand(LastOperand), m_Zero())) {
1629     // Find the type we're currently indexing into.
1630     gep_type_iterator GEPTI = gep_type_begin(Gep);
1631     std::advance(GEPTI, LastOperand - 1);
1632
1633     // If it's a type with the same allocation size as the result of the GEP we
1634     // can peel off the zero index.
1635     if (DL->getTypeAllocSize(*GEPTI) != GEPAllocSize)
1636       break;
1637     --LastOperand;
1638   }
1639
1640   return LastOperand;
1641 }
1642
1643 int LoopVectorizationLegality::isConsecutivePtr(Value *Ptr) {
1644   assert(Ptr->getType()->isPointerTy() && "Unexpected non-ptr");
1645   // Make sure that the pointer does not point to structs.
1646   if (Ptr->getType()->getPointerElementType()->isAggregateType())
1647     return 0;
1648
1649   // If this value is a pointer induction variable we know it is consecutive.
1650   PHINode *Phi = dyn_cast_or_null<PHINode>(Ptr);
1651   if (Phi && Inductions.count(Phi)) {
1652     InductionInfo II = Inductions[Phi];
1653     if (IK_PtrInduction == II.IK)
1654       return 1;
1655     else if (IK_ReversePtrInduction == II.IK)
1656       return -1;
1657   }
1658
1659   GetElementPtrInst *Gep = dyn_cast_or_null<GetElementPtrInst>(Ptr);
1660   if (!Gep)
1661     return 0;
1662
1663   unsigned NumOperands = Gep->getNumOperands();
1664   Value *GpPtr = Gep->getPointerOperand();
1665   // If this GEP value is a consecutive pointer induction variable and all of
1666   // the indices are constant then we know it is consecutive. We can
1667   Phi = dyn_cast<PHINode>(GpPtr);
1668   if (Phi && Inductions.count(Phi)) {
1669
1670     // Make sure that the pointer does not point to structs.
1671     PointerType *GepPtrType = cast<PointerType>(GpPtr->getType());
1672     if (GepPtrType->getElementType()->isAggregateType())
1673       return 0;
1674
1675     // Make sure that all of the index operands are loop invariant.
1676     for (unsigned i = 1; i < NumOperands; ++i)
1677       if (!SE->isLoopInvariant(SE->getSCEV(Gep->getOperand(i)), TheLoop))
1678         return 0;
1679
1680     InductionInfo II = Inductions[Phi];
1681     if (IK_PtrInduction == II.IK)
1682       return 1;
1683     else if (IK_ReversePtrInduction == II.IK)
1684       return -1;
1685   }
1686
1687   unsigned InductionOperand = getGEPInductionOperand(DL, Gep);
1688
1689   // Check that all of the gep indices are uniform except for our induction
1690   // operand.
1691   for (unsigned i = 0; i != NumOperands; ++i)
1692     if (i != InductionOperand &&
1693         !SE->isLoopInvariant(SE->getSCEV(Gep->getOperand(i)), TheLoop))
1694       return 0;
1695
1696   // We can emit wide load/stores only if the last non-zero index is the
1697   // induction variable.
1698   const SCEV *Last = nullptr;
1699   if (!Strides.count(Gep))
1700     Last = SE->getSCEV(Gep->getOperand(InductionOperand));
1701   else {
1702     // Because of the multiplication by a stride we can have a s/zext cast.
1703     // We are going to replace this stride by 1 so the cast is safe to ignore.
1704     //
1705     //  %indvars.iv = phi i64 [ 0, %entry ], [ %indvars.iv.next, %for.body ]
1706     //  %0 = trunc i64 %indvars.iv to i32
1707     //  %mul = mul i32 %0, %Stride1
1708     //  %idxprom = zext i32 %mul to i64  << Safe cast.
1709     //  %arrayidx = getelementptr inbounds i32* %B, i64 %idxprom
1710     //
1711     Last = replaceSymbolicStrideSCEV(SE, Strides,
1712                                      Gep->getOperand(InductionOperand), Gep);
1713     if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(Last))
1714       Last =
1715           (C->getSCEVType() == scSignExtend || C->getSCEVType() == scZeroExtend)
1716               ? C->getOperand()
1717               : Last;
1718   }
1719   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Last)) {
1720     const SCEV *Step = AR->getStepRecurrence(*SE);
1721
1722     // The memory is consecutive because the last index is consecutive
1723     // and all other indices are loop invariant.
1724     if (Step->isOne())
1725       return 1;
1726     if (Step->isAllOnesValue())
1727       return -1;
1728   }
1729
1730   return 0;
1731 }
1732
1733 bool LoopVectorizationLegality::isUniform(Value *V) {
1734   return (SE->isLoopInvariant(SE->getSCEV(V), TheLoop));
1735 }
1736
1737 InnerLoopVectorizer::VectorParts&
1738 InnerLoopVectorizer::getVectorValue(Value *V) {
1739   assert(V != Induction && "The new induction variable should not be used.");
1740   assert(!V->getType()->isVectorTy() && "Can't widen a vector");
1741
1742   // If we have a stride that is replaced by one, do it here.
1743   if (Legal->hasStride(V))
1744     V = ConstantInt::get(V->getType(), 1);
1745
1746   // If we have this scalar in the map, return it.
1747   if (WidenMap.has(V))
1748     return WidenMap.get(V);
1749
1750   // If this scalar is unknown, assume that it is a constant or that it is
1751   // loop invariant. Broadcast V and save the value for future uses.
1752   Value *B = getBroadcastInstrs(V);
1753   return WidenMap.splat(V, B);
1754 }
1755
1756 Value *InnerLoopVectorizer::reverseVector(Value *Vec) {
1757   assert(Vec->getType()->isVectorTy() && "Invalid type");
1758   SmallVector<Constant*, 8> ShuffleMask;
1759   for (unsigned i = 0; i < VF; ++i)
1760     ShuffleMask.push_back(Builder.getInt32(VF - i - 1));
1761
1762   return Builder.CreateShuffleVector(Vec, UndefValue::get(Vec->getType()),
1763                                      ConstantVector::get(ShuffleMask),
1764                                      "reverse");
1765 }
1766
1767 void InnerLoopVectorizer::vectorizeMemoryInstruction(Instruction *Instr) {
1768   // Attempt to issue a wide load.
1769   LoadInst *LI = dyn_cast<LoadInst>(Instr);
1770   StoreInst *SI = dyn_cast<StoreInst>(Instr);
1771
1772   assert((LI || SI) && "Invalid Load/Store instruction");
1773
1774   Type *ScalarDataTy = LI ? LI->getType() : SI->getValueOperand()->getType();
1775   Type *DataTy = VectorType::get(ScalarDataTy, VF);
1776   Value *Ptr = LI ? LI->getPointerOperand() : SI->getPointerOperand();
1777   unsigned Alignment = LI ? LI->getAlignment() : SI->getAlignment();
1778   // An alignment of 0 means target abi alignment. We need to use the scalar's
1779   // target abi alignment in such a case.
1780   if (!Alignment)
1781     Alignment = DL->getABITypeAlignment(ScalarDataTy);
1782   unsigned AddressSpace = Ptr->getType()->getPointerAddressSpace();
1783   unsigned ScalarAllocatedSize = DL->getTypeAllocSize(ScalarDataTy);
1784   unsigned VectorElementSize = DL->getTypeStoreSize(DataTy)/VF;
1785
1786   if (SI && Legal->blockNeedsPredication(SI->getParent()) &&
1787       !Legal->isMaskRequired(SI))
1788     return scalarizeInstruction(Instr, true);
1789
1790   if (ScalarAllocatedSize != VectorElementSize)
1791     return scalarizeInstruction(Instr);
1792
1793   // If the pointer is loop invariant or if it is non-consecutive,
1794   // scalarize the load.
1795   int ConsecutiveStride = Legal->isConsecutivePtr(Ptr);
1796   bool Reverse = ConsecutiveStride < 0;
1797   bool UniformLoad = LI && Legal->isUniform(Ptr);
1798   if (!ConsecutiveStride || UniformLoad)
1799     return scalarizeInstruction(Instr);
1800
1801   Constant *Zero = Builder.getInt32(0);
1802   VectorParts &Entry = WidenMap.get(Instr);
1803
1804   // Handle consecutive loads/stores.
1805   GetElementPtrInst *Gep = dyn_cast<GetElementPtrInst>(Ptr);
1806   if (Gep && Legal->isInductionVariable(Gep->getPointerOperand())) {
1807     setDebugLocFromInst(Builder, Gep);
1808     Value *PtrOperand = Gep->getPointerOperand();
1809     Value *FirstBasePtr = getVectorValue(PtrOperand)[0];
1810     FirstBasePtr = Builder.CreateExtractElement(FirstBasePtr, Zero);
1811
1812     // Create the new GEP with the new induction variable.
1813     GetElementPtrInst *Gep2 = cast<GetElementPtrInst>(Gep->clone());
1814     Gep2->setOperand(0, FirstBasePtr);
1815     Gep2->setName("gep.indvar.base");
1816     Ptr = Builder.Insert(Gep2);
1817   } else if (Gep) {
1818     setDebugLocFromInst(Builder, Gep);
1819     assert(SE->isLoopInvariant(SE->getSCEV(Gep->getPointerOperand()),
1820                                OrigLoop) && "Base ptr must be invariant");
1821
1822     // The last index does not have to be the induction. It can be
1823     // consecutive and be a function of the index. For example A[I+1];
1824     unsigned NumOperands = Gep->getNumOperands();
1825     unsigned InductionOperand = getGEPInductionOperand(DL, Gep);
1826     // Create the new GEP with the new induction variable.
1827     GetElementPtrInst *Gep2 = cast<GetElementPtrInst>(Gep->clone());
1828
1829     for (unsigned i = 0; i < NumOperands; ++i) {
1830       Value *GepOperand = Gep->getOperand(i);
1831       Instruction *GepOperandInst = dyn_cast<Instruction>(GepOperand);
1832
1833       // Update last index or loop invariant instruction anchored in loop.
1834       if (i == InductionOperand ||
1835           (GepOperandInst && OrigLoop->contains(GepOperandInst))) {
1836         assert((i == InductionOperand ||
1837                SE->isLoopInvariant(SE->getSCEV(GepOperandInst), OrigLoop)) &&
1838                "Must be last index or loop invariant");
1839
1840         VectorParts &GEPParts = getVectorValue(GepOperand);
1841         Value *Index = GEPParts[0];
1842         Index = Builder.CreateExtractElement(Index, Zero);
1843         Gep2->setOperand(i, Index);
1844         Gep2->setName("gep.indvar.idx");
1845       }
1846     }
1847     Ptr = Builder.Insert(Gep2);
1848   } else {
1849     // Use the induction element ptr.
1850     assert(isa<PHINode>(Ptr) && "Invalid induction ptr");
1851     setDebugLocFromInst(Builder, Ptr);
1852     VectorParts &PtrVal = getVectorValue(Ptr);
1853     Ptr = Builder.CreateExtractElement(PtrVal[0], Zero);
1854   }
1855
1856   VectorParts Mask = createBlockInMask(Instr->getParent());
1857   // Handle Stores:
1858   if (SI) {
1859     assert(!Legal->isUniform(SI->getPointerOperand()) &&
1860            "We do not allow storing to uniform addresses");
1861     setDebugLocFromInst(Builder, SI);
1862     // We don't want to update the value in the map as it might be used in
1863     // another expression. So don't use a reference type for "StoredVal".
1864     VectorParts StoredVal = getVectorValue(SI->getValueOperand());
1865     
1866     for (unsigned Part = 0; Part < UF; ++Part) {
1867       // Calculate the pointer for the specific unroll-part.
1868       Value *PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(Part * VF));
1869
1870       if (Reverse) {
1871         // If we store to reverse consecutive memory locations then we need
1872         // to reverse the order of elements in the stored value.
1873         StoredVal[Part] = reverseVector(StoredVal[Part]);
1874         // If the address is consecutive but reversed, then the
1875         // wide store needs to start at the last vector element.
1876         PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(-Part * VF));
1877         PartPtr = Builder.CreateGEP(PartPtr, Builder.getInt32(1 - VF));
1878       }
1879
1880       Value *VecPtr = Builder.CreateBitCast(PartPtr,
1881                                             DataTy->getPointerTo(AddressSpace));
1882
1883       Instruction *NewSI;
1884       if (Legal->isMaskRequired(SI))
1885         NewSI = Builder.CreateMaskedStore(StoredVal[Part], VecPtr, Alignment,
1886                                           Mask[Part]);
1887       else 
1888         NewSI = Builder.CreateAlignedStore(StoredVal[Part], VecPtr, Alignment);
1889       propagateMetadata(NewSI, SI);
1890     }
1891     return;
1892   }
1893
1894   // Handle loads.
1895   assert(LI && "Must have a load instruction");
1896   setDebugLocFromInst(Builder, LI);
1897   for (unsigned Part = 0; Part < UF; ++Part) {
1898     // Calculate the pointer for the specific unroll-part.
1899     Value *PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(Part * VF));
1900
1901     if (Reverse) {
1902       // If the address is consecutive but reversed, then the
1903       // wide load needs to start at the last vector element.
1904       PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(-Part * VF));
1905       PartPtr = Builder.CreateGEP(PartPtr, Builder.getInt32(1 - VF));
1906     }
1907
1908     Instruction* NewLI;
1909     Value *VecPtr = Builder.CreateBitCast(PartPtr,
1910                                           DataTy->getPointerTo(AddressSpace));
1911     if (Legal->isMaskRequired(LI))
1912       NewLI = Builder.CreateMaskedLoad(VecPtr, Alignment, Mask[Part],
1913                                        UndefValue::get(DataTy),
1914                                        "wide.masked.load");
1915     else
1916       NewLI = Builder.CreateAlignedLoad(VecPtr, Alignment, "wide.load");
1917     propagateMetadata(NewLI, LI);
1918     Entry[Part] = Reverse ? reverseVector(NewLI) :  NewLI;
1919   }
1920 }
1921
1922 void InnerLoopVectorizer::scalarizeInstruction(Instruction *Instr, bool IfPredicateStore) {
1923   assert(!Instr->getType()->isAggregateType() && "Can't handle vectors");
1924   // Holds vector parameters or scalars, in case of uniform vals.
1925   SmallVector<VectorParts, 4> Params;
1926
1927   setDebugLocFromInst(Builder, Instr);
1928
1929   // Find all of the vectorized parameters.
1930   for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
1931     Value *SrcOp = Instr->getOperand(op);
1932
1933     // If we are accessing the old induction variable, use the new one.
1934     if (SrcOp == OldInduction) {
1935       Params.push_back(getVectorValue(SrcOp));
1936       continue;
1937     }
1938
1939     // Try using previously calculated values.
1940     Instruction *SrcInst = dyn_cast<Instruction>(SrcOp);
1941
1942     // If the src is an instruction that appeared earlier in the basic block
1943     // then it should already be vectorized.
1944     if (SrcInst && OrigLoop->contains(SrcInst)) {
1945       assert(WidenMap.has(SrcInst) && "Source operand is unavailable");
1946       // The parameter is a vector value from earlier.
1947       Params.push_back(WidenMap.get(SrcInst));
1948     } else {
1949       // The parameter is a scalar from outside the loop. Maybe even a constant.
1950       VectorParts Scalars;
1951       Scalars.append(UF, SrcOp);
1952       Params.push_back(Scalars);
1953     }
1954   }
1955
1956   assert(Params.size() == Instr->getNumOperands() &&
1957          "Invalid number of operands");
1958
1959   // Does this instruction return a value ?
1960   bool IsVoidRetTy = Instr->getType()->isVoidTy();
1961
1962   Value *UndefVec = IsVoidRetTy ? nullptr :
1963     UndefValue::get(VectorType::get(Instr->getType(), VF));
1964   // Create a new entry in the WidenMap and initialize it to Undef or Null.
1965   VectorParts &VecResults = WidenMap.splat(Instr, UndefVec);
1966
1967   Instruction *InsertPt = Builder.GetInsertPoint();
1968   BasicBlock *IfBlock = Builder.GetInsertBlock();
1969   BasicBlock *CondBlock = nullptr;
1970
1971   VectorParts Cond;
1972   Loop *VectorLp = nullptr;
1973   if (IfPredicateStore) {
1974     assert(Instr->getParent()->getSinglePredecessor() &&
1975            "Only support single predecessor blocks");
1976     Cond = createEdgeMask(Instr->getParent()->getSinglePredecessor(),
1977                           Instr->getParent());
1978     VectorLp = LI->getLoopFor(IfBlock);
1979     assert(VectorLp && "Must have a loop for this block");
1980   }
1981
1982   // For each vector unroll 'part':
1983   for (unsigned Part = 0; Part < UF; ++Part) {
1984     // For each scalar that we create:
1985     for (unsigned Width = 0; Width < VF; ++Width) {
1986
1987       // Start if-block.
1988       Value *Cmp = nullptr;
1989       if (IfPredicateStore) {
1990         Cmp = Builder.CreateExtractElement(Cond[Part], Builder.getInt32(Width));
1991         Cmp = Builder.CreateICmp(ICmpInst::ICMP_EQ, Cmp, ConstantInt::get(Cmp->getType(), 1));
1992         CondBlock = IfBlock->splitBasicBlock(InsertPt, "cond.store");
1993         LoopVectorBody.push_back(CondBlock);
1994         VectorLp->addBasicBlockToLoop(CondBlock, LI->getBase());
1995         // Update Builder with newly created basic block.
1996         Builder.SetInsertPoint(InsertPt);
1997       }
1998
1999       Instruction *Cloned = Instr->clone();
2000       if (!IsVoidRetTy)
2001         Cloned->setName(Instr->getName() + ".cloned");
2002       // Replace the operands of the cloned instructions with extracted scalars.
2003       for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
2004         Value *Op = Params[op][Part];
2005         // Param is a vector. Need to extract the right lane.
2006         if (Op->getType()->isVectorTy())
2007           Op = Builder.CreateExtractElement(Op, Builder.getInt32(Width));
2008         Cloned->setOperand(op, Op);
2009       }
2010
2011       // Place the cloned scalar in the new loop.
2012       Builder.Insert(Cloned);
2013
2014       // If the original scalar returns a value we need to place it in a vector
2015       // so that future users will be able to use it.
2016       if (!IsVoidRetTy)
2017         VecResults[Part] = Builder.CreateInsertElement(VecResults[Part], Cloned,
2018                                                        Builder.getInt32(Width));
2019       // End if-block.
2020       if (IfPredicateStore) {
2021          BasicBlock *NewIfBlock = CondBlock->splitBasicBlock(InsertPt, "else");
2022          LoopVectorBody.push_back(NewIfBlock);
2023          VectorLp->addBasicBlockToLoop(NewIfBlock, LI->getBase());
2024          Builder.SetInsertPoint(InsertPt);
2025          Instruction *OldBr = IfBlock->getTerminator();
2026          BranchInst::Create(CondBlock, NewIfBlock, Cmp, OldBr);
2027          OldBr->eraseFromParent();
2028          IfBlock = NewIfBlock;
2029       }
2030     }
2031   }
2032 }
2033
2034 static Instruction *getFirstInst(Instruction *FirstInst, Value *V,
2035                                  Instruction *Loc) {
2036   if (FirstInst)
2037     return FirstInst;
2038   if (Instruction *I = dyn_cast<Instruction>(V))
2039     return I->getParent() == Loc->getParent() ? I : nullptr;
2040   return nullptr;
2041 }
2042
2043 std::pair<Instruction *, Instruction *>
2044 InnerLoopVectorizer::addStrideCheck(Instruction *Loc) {
2045   Instruction *tnullptr = nullptr;
2046   if (!Legal->mustCheckStrides())
2047     return std::pair<Instruction *, Instruction *>(tnullptr, tnullptr);
2048
2049   IRBuilder<> ChkBuilder(Loc);
2050
2051   // Emit checks.
2052   Value *Check = nullptr;
2053   Instruction *FirstInst = nullptr;
2054   for (SmallPtrSet<Value *, 8>::iterator SI = Legal->strides_begin(),
2055                                          SE = Legal->strides_end();
2056        SI != SE; ++SI) {
2057     Value *Ptr = stripIntegerCast(*SI);
2058     Value *C = ChkBuilder.CreateICmpNE(Ptr, ConstantInt::get(Ptr->getType(), 1),
2059                                        "stride.chk");
2060     // Store the first instruction we create.
2061     FirstInst = getFirstInst(FirstInst, C, Loc);
2062     if (Check)
2063       Check = ChkBuilder.CreateOr(Check, C);
2064     else
2065       Check = C;
2066   }
2067
2068   // We have to do this trickery because the IRBuilder might fold the check to a
2069   // constant expression in which case there is no Instruction anchored in a
2070   // the block.
2071   LLVMContext &Ctx = Loc->getContext();
2072   Instruction *TheCheck =
2073       BinaryOperator::CreateAnd(Check, ConstantInt::getTrue(Ctx));
2074   ChkBuilder.Insert(TheCheck, "stride.not.one");
2075   FirstInst = getFirstInst(FirstInst, TheCheck, Loc);
2076
2077   return std::make_pair(FirstInst, TheCheck);
2078 }
2079
2080 std::pair<Instruction *, Instruction *>
2081 InnerLoopVectorizer::addRuntimeCheck(Instruction *Loc) {
2082   LoopVectorizationLegality::RuntimePointerCheck *PtrRtCheck =
2083   Legal->getRuntimePointerCheck();
2084
2085   Instruction *tnullptr = nullptr;
2086   if (!PtrRtCheck->Need)
2087     return std::pair<Instruction *, Instruction *>(tnullptr, tnullptr);
2088
2089   unsigned NumPointers = PtrRtCheck->Pointers.size();
2090   SmallVector<TrackingVH<Value> , 2> Starts;
2091   SmallVector<TrackingVH<Value> , 2> Ends;
2092
2093   LLVMContext &Ctx = Loc->getContext();
2094   SCEVExpander Exp(*SE, "induction");
2095   Instruction *FirstInst = nullptr;
2096
2097   for (unsigned i = 0; i < NumPointers; ++i) {
2098     Value *Ptr = PtrRtCheck->Pointers[i];
2099     const SCEV *Sc = SE->getSCEV(Ptr);
2100
2101     if (SE->isLoopInvariant(Sc, OrigLoop)) {
2102       DEBUG(dbgs() << "LV: Adding RT check for a loop invariant ptr:" <<
2103             *Ptr <<"\n");
2104       Starts.push_back(Ptr);
2105       Ends.push_back(Ptr);
2106     } else {
2107       DEBUG(dbgs() << "LV: Adding RT check for range:" << *Ptr << '\n');
2108       unsigned AS = Ptr->getType()->getPointerAddressSpace();
2109
2110       // Use this type for pointer arithmetic.
2111       Type *PtrArithTy = Type::getInt8PtrTy(Ctx, AS);
2112
2113       Value *Start = Exp.expandCodeFor(PtrRtCheck->Starts[i], PtrArithTy, Loc);
2114       Value *End = Exp.expandCodeFor(PtrRtCheck->Ends[i], PtrArithTy, Loc);
2115       Starts.push_back(Start);
2116       Ends.push_back(End);
2117     }
2118   }
2119
2120   IRBuilder<> ChkBuilder(Loc);
2121   // Our instructions might fold to a constant.
2122   Value *MemoryRuntimeCheck = nullptr;
2123   for (unsigned i = 0; i < NumPointers; ++i) {
2124     for (unsigned j = i+1; j < NumPointers; ++j) {
2125       // No need to check if two readonly pointers intersect.
2126       if (!PtrRtCheck->IsWritePtr[i] && !PtrRtCheck->IsWritePtr[j])
2127         continue;
2128
2129       // Only need to check pointers between two different dependency sets.
2130       if (PtrRtCheck->DependencySetId[i] == PtrRtCheck->DependencySetId[j])
2131        continue;
2132       // Only need to check pointers in the same alias set.
2133       if (PtrRtCheck->AliasSetId[i] != PtrRtCheck->AliasSetId[j])
2134         continue;
2135
2136       unsigned AS0 = Starts[i]->getType()->getPointerAddressSpace();
2137       unsigned AS1 = Starts[j]->getType()->getPointerAddressSpace();
2138
2139       assert((AS0 == Ends[j]->getType()->getPointerAddressSpace()) &&
2140              (AS1 == Ends[i]->getType()->getPointerAddressSpace()) &&
2141              "Trying to bounds check pointers with different address spaces");
2142
2143       Type *PtrArithTy0 = Type::getInt8PtrTy(Ctx, AS0);
2144       Type *PtrArithTy1 = Type::getInt8PtrTy(Ctx, AS1);
2145
2146       Value *Start0 = ChkBuilder.CreateBitCast(Starts[i], PtrArithTy0, "bc");
2147       Value *Start1 = ChkBuilder.CreateBitCast(Starts[j], PtrArithTy1, "bc");
2148       Value *End0 =   ChkBuilder.CreateBitCast(Ends[i],   PtrArithTy1, "bc");
2149       Value *End1 =   ChkBuilder.CreateBitCast(Ends[j],   PtrArithTy0, "bc");
2150
2151       Value *Cmp0 = ChkBuilder.CreateICmpULE(Start0, End1, "bound0");
2152       FirstInst = getFirstInst(FirstInst, Cmp0, Loc);
2153       Value *Cmp1 = ChkBuilder.CreateICmpULE(Start1, End0, "bound1");
2154       FirstInst = getFirstInst(FirstInst, Cmp1, Loc);
2155       Value *IsConflict = ChkBuilder.CreateAnd(Cmp0, Cmp1, "found.conflict");
2156       FirstInst = getFirstInst(FirstInst, IsConflict, Loc);
2157       if (MemoryRuntimeCheck) {
2158         IsConflict = ChkBuilder.CreateOr(MemoryRuntimeCheck, IsConflict,
2159                                          "conflict.rdx");
2160         FirstInst = getFirstInst(FirstInst, IsConflict, Loc);
2161       }
2162       MemoryRuntimeCheck = IsConflict;
2163     }
2164   }
2165
2166   // We have to do this trickery because the IRBuilder might fold the check to a
2167   // constant expression in which case there is no Instruction anchored in a
2168   // the block.
2169   Instruction *Check = BinaryOperator::CreateAnd(MemoryRuntimeCheck,
2170                                                  ConstantInt::getTrue(Ctx));
2171   ChkBuilder.Insert(Check, "memcheck.conflict");
2172   FirstInst = getFirstInst(FirstInst, Check, Loc);
2173   return std::make_pair(FirstInst, Check);
2174 }
2175
2176 void InnerLoopVectorizer::createEmptyLoop() {
2177   /*
2178    In this function we generate a new loop. The new loop will contain
2179    the vectorized instructions while the old loop will continue to run the
2180    scalar remainder.
2181
2182        [ ] <-- Back-edge taken count overflow check.
2183     /   |
2184    /    v
2185   |    [ ] <-- vector loop bypass (may consist of multiple blocks).
2186   |  /  |
2187   | /   v
2188   ||   [ ]     <-- vector pre header.
2189   ||    |
2190   ||    v
2191   ||   [  ] \
2192   ||   [  ]_|   <-- vector loop.
2193   ||    |
2194   | \   v
2195   |   >[ ]   <--- middle-block.
2196   |  /  |
2197   | /   v
2198   -|- >[ ]     <--- new preheader.
2199    |    |
2200    |    v
2201    |   [ ] \
2202    |   [ ]_|   <-- old scalar loop to handle remainder.
2203     \   |
2204      \  v
2205       >[ ]     <-- exit block.
2206    ...
2207    */
2208
2209   BasicBlock *OldBasicBlock = OrigLoop->getHeader();
2210   BasicBlock *BypassBlock = OrigLoop->getLoopPreheader();
2211   BasicBlock *ExitBlock = OrigLoop->getExitBlock();
2212   assert(BypassBlock && "Invalid loop structure");
2213   assert(ExitBlock && "Must have an exit block");
2214
2215   // Some loops have a single integer induction variable, while other loops
2216   // don't. One example is c++ iterators that often have multiple pointer
2217   // induction variables. In the code below we also support a case where we
2218   // don't have a single induction variable.
2219   OldInduction = Legal->getInduction();
2220   Type *IdxTy = Legal->getWidestInductionType();
2221
2222   // Find the loop boundaries.
2223   const SCEV *ExitCount = SE->getBackedgeTakenCount(OrigLoop);
2224   assert(ExitCount != SE->getCouldNotCompute() && "Invalid loop count");
2225
2226   // The exit count might have the type of i64 while the phi is i32. This can
2227   // happen if we have an induction variable that is sign extended before the
2228   // compare. The only way that we get a backedge taken count is that the
2229   // induction variable was signed and as such will not overflow. In such a case
2230   // truncation is legal.
2231   if (ExitCount->getType()->getPrimitiveSizeInBits() >
2232       IdxTy->getPrimitiveSizeInBits())
2233     ExitCount = SE->getTruncateOrNoop(ExitCount, IdxTy);
2234
2235   const SCEV *BackedgeTakeCount = SE->getNoopOrZeroExtend(ExitCount, IdxTy);
2236   // Get the total trip count from the count by adding 1.
2237   ExitCount = SE->getAddExpr(BackedgeTakeCount,
2238                              SE->getConstant(BackedgeTakeCount->getType(), 1));
2239
2240   // Expand the trip count and place the new instructions in the preheader.
2241   // Notice that the pre-header does not change, only the loop body.
2242   SCEVExpander Exp(*SE, "induction");
2243
2244   // We need to test whether the backedge-taken count is uint##_max. Adding one
2245   // to it will cause overflow and an incorrect loop trip count in the vector
2246   // body. In case of overflow we want to directly jump to the scalar remainder
2247   // loop.
2248   Value *BackedgeCount =
2249       Exp.expandCodeFor(BackedgeTakeCount, BackedgeTakeCount->getType(),
2250                         BypassBlock->getTerminator());
2251   if (BackedgeCount->getType()->isPointerTy())
2252     BackedgeCount = CastInst::CreatePointerCast(BackedgeCount, IdxTy,
2253                                                 "backedge.ptrcnt.to.int",
2254                                                 BypassBlock->getTerminator());
2255   Instruction *CheckBCOverflow =
2256       CmpInst::Create(Instruction::ICmp, CmpInst::ICMP_EQ, BackedgeCount,
2257                       Constant::getAllOnesValue(BackedgeCount->getType()),
2258                       "backedge.overflow", BypassBlock->getTerminator());
2259
2260   // The loop index does not have to start at Zero. Find the original start
2261   // value from the induction PHI node. If we don't have an induction variable
2262   // then we know that it starts at zero.
2263   Builder.SetInsertPoint(BypassBlock->getTerminator());
2264   Value *StartIdx = ExtendedIdx = OldInduction ?
2265     Builder.CreateZExt(OldInduction->getIncomingValueForBlock(BypassBlock),
2266                        IdxTy):
2267     ConstantInt::get(IdxTy, 0);
2268
2269   // We need an instruction to anchor the overflow check on. StartIdx needs to
2270   // be defined before the overflow check branch. Because the scalar preheader
2271   // is going to merge the start index and so the overflow branch block needs to
2272   // contain a definition of the start index.
2273   Instruction *OverflowCheckAnchor = BinaryOperator::CreateAdd(
2274       StartIdx, ConstantInt::get(IdxTy, 0), "overflow.check.anchor",
2275       BypassBlock->getTerminator());
2276
2277   // Count holds the overall loop count (N).
2278   Value *Count = Exp.expandCodeFor(ExitCount, ExitCount->getType(),
2279                                    BypassBlock->getTerminator());
2280
2281   LoopBypassBlocks.push_back(BypassBlock);
2282
2283   // Split the single block loop into the two loop structure described above.
2284   BasicBlock *VectorPH =
2285   BypassBlock->splitBasicBlock(BypassBlock->getTerminator(), "vector.ph");
2286   BasicBlock *VecBody =
2287   VectorPH->splitBasicBlock(VectorPH->getTerminator(), "vector.body");
2288   BasicBlock *MiddleBlock =
2289   VecBody->splitBasicBlock(VecBody->getTerminator(), "middle.block");
2290   BasicBlock *ScalarPH =
2291   MiddleBlock->splitBasicBlock(MiddleBlock->getTerminator(), "scalar.ph");
2292
2293   // Create and register the new vector loop.
2294   Loop* Lp = new Loop();
2295   Loop *ParentLoop = OrigLoop->getParentLoop();
2296
2297   // Insert the new loop into the loop nest and register the new basic blocks
2298   // before calling any utilities such as SCEV that require valid LoopInfo.
2299   if (ParentLoop) {
2300     ParentLoop->addChildLoop(Lp);
2301     ParentLoop->addBasicBlockToLoop(ScalarPH, LI->getBase());
2302     ParentLoop->addBasicBlockToLoop(VectorPH, LI->getBase());
2303     ParentLoop->addBasicBlockToLoop(MiddleBlock, LI->getBase());
2304   } else {
2305     LI->addTopLevelLoop(Lp);
2306   }
2307   Lp->addBasicBlockToLoop(VecBody, LI->getBase());
2308
2309   // Use this IR builder to create the loop instructions (Phi, Br, Cmp)
2310   // inside the loop.
2311   Builder.SetInsertPoint(VecBody->getFirstNonPHI());
2312
2313   // Generate the induction variable.
2314   setDebugLocFromInst(Builder, getDebugLocFromInstOrOperands(OldInduction));
2315   Induction = Builder.CreatePHI(IdxTy, 2, "index");
2316   // The loop step is equal to the vectorization factor (num of SIMD elements)
2317   // times the unroll factor (num of SIMD instructions).
2318   Constant *Step = ConstantInt::get(IdxTy, VF * UF);
2319
2320   // This is the IR builder that we use to add all of the logic for bypassing
2321   // the new vector loop.
2322   IRBuilder<> BypassBuilder(BypassBlock->getTerminator());
2323   setDebugLocFromInst(BypassBuilder,
2324                       getDebugLocFromInstOrOperands(OldInduction));
2325
2326   // We may need to extend the index in case there is a type mismatch.
2327   // We know that the count starts at zero and does not overflow.
2328   if (Count->getType() != IdxTy) {
2329     // The exit count can be of pointer type. Convert it to the correct
2330     // integer type.
2331     if (ExitCount->getType()->isPointerTy())
2332       Count = BypassBuilder.CreatePointerCast(Count, IdxTy, "ptrcnt.to.int");
2333     else
2334       Count = BypassBuilder.CreateZExtOrTrunc(Count, IdxTy, "cnt.cast");
2335   }
2336
2337   // Add the start index to the loop count to get the new end index.
2338   Value *IdxEnd = BypassBuilder.CreateAdd(Count, StartIdx, "end.idx");
2339
2340   // Now we need to generate the expression for N - (N % VF), which is
2341   // the part that the vectorized body will execute.
2342   Value *R = BypassBuilder.CreateURem(Count, Step, "n.mod.vf");
2343   Value *CountRoundDown = BypassBuilder.CreateSub(Count, R, "n.vec");
2344   Value *IdxEndRoundDown = BypassBuilder.CreateAdd(CountRoundDown, StartIdx,
2345                                                      "end.idx.rnd.down");
2346
2347   // Now, compare the new count to zero. If it is zero skip the vector loop and
2348   // jump to the scalar loop.
2349   Value *Cmp =
2350       BypassBuilder.CreateICmpEQ(IdxEndRoundDown, StartIdx, "cmp.zero");
2351
2352   BasicBlock *LastBypassBlock = BypassBlock;
2353
2354   // Generate code to check that the loops trip count that we computed by adding
2355   // one to the backedge-taken count will not overflow.
2356   {
2357     auto PastOverflowCheck =
2358         std::next(BasicBlock::iterator(OverflowCheckAnchor));
2359     BasicBlock *CheckBlock =
2360       LastBypassBlock->splitBasicBlock(PastOverflowCheck, "overflow.checked");
2361     if (ParentLoop)
2362       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
2363     LoopBypassBlocks.push_back(CheckBlock);
2364     Instruction *OldTerm = LastBypassBlock->getTerminator();
2365     BranchInst::Create(ScalarPH, CheckBlock, CheckBCOverflow, OldTerm);
2366     OldTerm->eraseFromParent();
2367     LastBypassBlock = CheckBlock;
2368   }
2369
2370   // Generate the code to check that the strides we assumed to be one are really
2371   // one. We want the new basic block to start at the first instruction in a
2372   // sequence of instructions that form a check.
2373   Instruction *StrideCheck;
2374   Instruction *FirstCheckInst;
2375   std::tie(FirstCheckInst, StrideCheck) =
2376       addStrideCheck(LastBypassBlock->getTerminator());
2377   if (StrideCheck) {
2378     // Create a new block containing the stride check.
2379     BasicBlock *CheckBlock =
2380         LastBypassBlock->splitBasicBlock(FirstCheckInst, "vector.stridecheck");
2381     if (ParentLoop)
2382       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
2383     LoopBypassBlocks.push_back(CheckBlock);
2384
2385     // Replace the branch into the memory check block with a conditional branch
2386     // for the "few elements case".
2387     Instruction *OldTerm = LastBypassBlock->getTerminator();
2388     BranchInst::Create(MiddleBlock, CheckBlock, Cmp, OldTerm);
2389     OldTerm->eraseFromParent();
2390
2391     Cmp = StrideCheck;
2392     LastBypassBlock = CheckBlock;
2393   }
2394
2395   // Generate the code that checks in runtime if arrays overlap. We put the
2396   // checks into a separate block to make the more common case of few elements
2397   // faster.
2398   Instruction *MemRuntimeCheck;
2399   std::tie(FirstCheckInst, MemRuntimeCheck) =
2400       addRuntimeCheck(LastBypassBlock->getTerminator());
2401   if (MemRuntimeCheck) {
2402     // Create a new block containing the memory check.
2403     BasicBlock *CheckBlock =
2404         LastBypassBlock->splitBasicBlock(MemRuntimeCheck, "vector.memcheck");
2405     if (ParentLoop)
2406       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
2407     LoopBypassBlocks.push_back(CheckBlock);
2408
2409     // Replace the branch into the memory check block with a conditional branch
2410     // for the "few elements case".
2411     Instruction *OldTerm = LastBypassBlock->getTerminator();
2412     BranchInst::Create(MiddleBlock, CheckBlock, Cmp, OldTerm);
2413     OldTerm->eraseFromParent();
2414
2415     Cmp = MemRuntimeCheck;
2416     LastBypassBlock = CheckBlock;
2417   }
2418
2419   LastBypassBlock->getTerminator()->eraseFromParent();
2420   BranchInst::Create(MiddleBlock, VectorPH, Cmp,
2421                      LastBypassBlock);
2422
2423   // We are going to resume the execution of the scalar loop.
2424   // Go over all of the induction variables that we found and fix the
2425   // PHIs that are left in the scalar version of the loop.
2426   // The starting values of PHI nodes depend on the counter of the last
2427   // iteration in the vectorized loop.
2428   // If we come from a bypass edge then we need to start from the original
2429   // start value.
2430
2431   // This variable saves the new starting index for the scalar loop.
2432   PHINode *ResumeIndex = nullptr;
2433   LoopVectorizationLegality::InductionList::iterator I, E;
2434   LoopVectorizationLegality::InductionList *List = Legal->getInductionVars();
2435   // Set builder to point to last bypass block.
2436   BypassBuilder.SetInsertPoint(LoopBypassBlocks.back()->getTerminator());
2437   for (I = List->begin(), E = List->end(); I != E; ++I) {
2438     PHINode *OrigPhi = I->first;
2439     LoopVectorizationLegality::InductionInfo II = I->second;
2440
2441     Type *ResumeValTy = (OrigPhi == OldInduction) ? IdxTy : OrigPhi->getType();
2442     PHINode *ResumeVal = PHINode::Create(ResumeValTy, 2, "resume.val",
2443                                          MiddleBlock->getTerminator());
2444     // We might have extended the type of the induction variable but we need a
2445     // truncated version for the scalar loop.
2446     PHINode *TruncResumeVal = (OrigPhi == OldInduction) ?
2447       PHINode::Create(OrigPhi->getType(), 2, "trunc.resume.val",
2448                       MiddleBlock->getTerminator()) : nullptr;
2449
2450     // Create phi nodes to merge from the  backedge-taken check block.
2451     PHINode *BCResumeVal = PHINode::Create(ResumeValTy, 3, "bc.resume.val",
2452                                            ScalarPH->getTerminator());
2453     BCResumeVal->addIncoming(ResumeVal, MiddleBlock);
2454
2455     PHINode *BCTruncResumeVal = nullptr;
2456     if (OrigPhi == OldInduction) {
2457       BCTruncResumeVal =
2458           PHINode::Create(OrigPhi->getType(), 2, "bc.trunc.resume.val",
2459                           ScalarPH->getTerminator());
2460       BCTruncResumeVal->addIncoming(TruncResumeVal, MiddleBlock);
2461     }
2462
2463     Value *EndValue = nullptr;
2464     switch (II.IK) {
2465     case LoopVectorizationLegality::IK_NoInduction:
2466       llvm_unreachable("Unknown induction");
2467     case LoopVectorizationLegality::IK_IntInduction: {
2468       // Handle the integer induction counter.
2469       assert(OrigPhi->getType()->isIntegerTy() && "Invalid type");
2470
2471       // We have the canonical induction variable.
2472       if (OrigPhi == OldInduction) {
2473         // Create a truncated version of the resume value for the scalar loop,
2474         // we might have promoted the type to a larger width.
2475         EndValue =
2476           BypassBuilder.CreateTrunc(IdxEndRoundDown, OrigPhi->getType());
2477         // The new PHI merges the original incoming value, in case of a bypass,
2478         // or the value at the end of the vectorized loop.
2479         for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2480           TruncResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[I]);
2481         TruncResumeVal->addIncoming(EndValue, VecBody);
2482
2483         BCTruncResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[0]);
2484
2485         // We know what the end value is.
2486         EndValue = IdxEndRoundDown;
2487         // We also know which PHI node holds it.
2488         ResumeIndex = ResumeVal;
2489         break;
2490       }
2491
2492       // Not the canonical induction variable - add the vector loop count to the
2493       // start value.
2494       Value *CRD = BypassBuilder.CreateSExtOrTrunc(CountRoundDown,
2495                                                    II.StartValue->getType(),
2496                                                    "cast.crd");
2497       EndValue = BypassBuilder.CreateAdd(CRD, II.StartValue , "ind.end");
2498       break;
2499     }
2500     case LoopVectorizationLegality::IK_ReverseIntInduction: {
2501       // Convert the CountRoundDown variable to the PHI size.
2502       Value *CRD = BypassBuilder.CreateSExtOrTrunc(CountRoundDown,
2503                                                    II.StartValue->getType(),
2504                                                    "cast.crd");
2505       // Handle reverse integer induction counter.
2506       EndValue = BypassBuilder.CreateSub(II.StartValue, CRD, "rev.ind.end");
2507       break;
2508     }
2509     case LoopVectorizationLegality::IK_PtrInduction: {
2510       // For pointer induction variables, calculate the offset using
2511       // the end index.
2512       EndValue = BypassBuilder.CreateGEP(II.StartValue, CountRoundDown,
2513                                          "ptr.ind.end");
2514       break;
2515     }
2516     case LoopVectorizationLegality::IK_ReversePtrInduction: {
2517       // The value at the end of the loop for the reverse pointer is calculated
2518       // by creating a GEP with a negative index starting from the start value.
2519       Value *Zero = ConstantInt::get(CountRoundDown->getType(), 0);
2520       Value *NegIdx = BypassBuilder.CreateSub(Zero, CountRoundDown,
2521                                               "rev.ind.end");
2522       EndValue = BypassBuilder.CreateGEP(II.StartValue, NegIdx,
2523                                          "rev.ptr.ind.end");
2524       break;
2525     }
2526     }// end of case
2527
2528     // The new PHI merges the original incoming value, in case of a bypass,
2529     // or the value at the end of the vectorized loop.
2530     for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I) {
2531       if (OrigPhi == OldInduction)
2532         ResumeVal->addIncoming(StartIdx, LoopBypassBlocks[I]);
2533       else
2534         ResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[I]);
2535     }
2536     ResumeVal->addIncoming(EndValue, VecBody);
2537
2538     // Fix the scalar body counter (PHI node).
2539     unsigned BlockIdx = OrigPhi->getBasicBlockIndex(ScalarPH);
2540
2541     // The old induction's phi node in the scalar body needs the truncated
2542     // value.
2543     if (OrigPhi == OldInduction) {
2544       BCResumeVal->addIncoming(StartIdx, LoopBypassBlocks[0]);
2545       OrigPhi->setIncomingValue(BlockIdx, BCTruncResumeVal);
2546     } else {
2547       BCResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[0]);
2548       OrigPhi->setIncomingValue(BlockIdx, BCResumeVal);
2549     }
2550   }
2551
2552   // If we are generating a new induction variable then we also need to
2553   // generate the code that calculates the exit value. This value is not
2554   // simply the end of the counter because we may skip the vectorized body
2555   // in case of a runtime check.
2556   if (!OldInduction){
2557     assert(!ResumeIndex && "Unexpected resume value found");
2558     ResumeIndex = PHINode::Create(IdxTy, 2, "new.indc.resume.val",
2559                                   MiddleBlock->getTerminator());
2560     for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2561       ResumeIndex->addIncoming(StartIdx, LoopBypassBlocks[I]);
2562     ResumeIndex->addIncoming(IdxEndRoundDown, VecBody);
2563   }
2564
2565   // Make sure that we found the index where scalar loop needs to continue.
2566   assert(ResumeIndex && ResumeIndex->getType()->isIntegerTy() &&
2567          "Invalid resume Index");
2568
2569   // Add a check in the middle block to see if we have completed
2570   // all of the iterations in the first vector loop.
2571   // If (N - N%VF) == N, then we *don't* need to run the remainder.
2572   Value *CmpN = CmpInst::Create(Instruction::ICmp, CmpInst::ICMP_EQ, IdxEnd,
2573                                 ResumeIndex, "cmp.n",
2574                                 MiddleBlock->getTerminator());
2575
2576   BranchInst::Create(ExitBlock, ScalarPH, CmpN, MiddleBlock->getTerminator());
2577   // Remove the old terminator.
2578   MiddleBlock->getTerminator()->eraseFromParent();
2579
2580   // Create i+1 and fill the PHINode.
2581   Value *NextIdx = Builder.CreateAdd(Induction, Step, "index.next");
2582   Induction->addIncoming(StartIdx, VectorPH);
2583   Induction->addIncoming(NextIdx, VecBody);
2584   // Create the compare.
2585   Value *ICmp = Builder.CreateICmpEQ(NextIdx, IdxEndRoundDown);
2586   Builder.CreateCondBr(ICmp, MiddleBlock, VecBody);
2587
2588   // Now we have two terminators. Remove the old one from the block.
2589   VecBody->getTerminator()->eraseFromParent();
2590
2591   // Get ready to start creating new instructions into the vectorized body.
2592   Builder.SetInsertPoint(VecBody->getFirstInsertionPt());
2593
2594   // Save the state.
2595   LoopVectorPreHeader = VectorPH;
2596   LoopScalarPreHeader = ScalarPH;
2597   LoopMiddleBlock = MiddleBlock;
2598   LoopExitBlock = ExitBlock;
2599   LoopVectorBody.push_back(VecBody);
2600   LoopScalarBody = OldBasicBlock;
2601
2602   LoopVectorizeHints Hints(Lp, true);
2603   Hints.setAlreadyVectorized();
2604 }
2605
2606 /// This function returns the identity element (or neutral element) for
2607 /// the operation K.
2608 Constant*
2609 LoopVectorizationLegality::getReductionIdentity(ReductionKind K, Type *Tp) {
2610   switch (K) {
2611   case RK_IntegerXor:
2612   case RK_IntegerAdd:
2613   case RK_IntegerOr:
2614     // Adding, Xoring, Oring zero to a number does not change it.
2615     return ConstantInt::get(Tp, 0);
2616   case RK_IntegerMult:
2617     // Multiplying a number by 1 does not change it.
2618     return ConstantInt::get(Tp, 1);
2619   case RK_IntegerAnd:
2620     // AND-ing a number with an all-1 value does not change it.
2621     return ConstantInt::get(Tp, -1, true);
2622   case  RK_FloatMult:
2623     // Multiplying a number by 1 does not change it.
2624     return ConstantFP::get(Tp, 1.0L);
2625   case  RK_FloatAdd:
2626     // Adding zero to a number does not change it.
2627     return ConstantFP::get(Tp, 0.0L);
2628   default:
2629     llvm_unreachable("Unknown reduction kind");
2630   }
2631 }
2632
2633 /// This function translates the reduction kind to an LLVM binary operator.
2634 static unsigned
2635 getReductionBinOp(LoopVectorizationLegality::ReductionKind Kind) {
2636   switch (Kind) {
2637     case LoopVectorizationLegality::RK_IntegerAdd:
2638       return Instruction::Add;
2639     case LoopVectorizationLegality::RK_IntegerMult:
2640       return Instruction::Mul;
2641     case LoopVectorizationLegality::RK_IntegerOr:
2642       return Instruction::Or;
2643     case LoopVectorizationLegality::RK_IntegerAnd:
2644       return Instruction::And;
2645     case LoopVectorizationLegality::RK_IntegerXor:
2646       return Instruction::Xor;
2647     case LoopVectorizationLegality::RK_FloatMult:
2648       return Instruction::FMul;
2649     case LoopVectorizationLegality::RK_FloatAdd:
2650       return Instruction::FAdd;
2651     case LoopVectorizationLegality::RK_IntegerMinMax:
2652       return Instruction::ICmp;
2653     case LoopVectorizationLegality::RK_FloatMinMax:
2654       return Instruction::FCmp;
2655     default:
2656       llvm_unreachable("Unknown reduction operation");
2657   }
2658 }
2659
2660 Value *createMinMaxOp(IRBuilder<> &Builder,
2661                       LoopVectorizationLegality::MinMaxReductionKind RK,
2662                       Value *Left,
2663                       Value *Right) {
2664   CmpInst::Predicate P = CmpInst::ICMP_NE;
2665   switch (RK) {
2666   default:
2667     llvm_unreachable("Unknown min/max reduction kind");
2668   case LoopVectorizationLegality::MRK_UIntMin:
2669     P = CmpInst::ICMP_ULT;
2670     break;
2671   case LoopVectorizationLegality::MRK_UIntMax:
2672     P = CmpInst::ICMP_UGT;
2673     break;
2674   case LoopVectorizationLegality::MRK_SIntMin:
2675     P = CmpInst::ICMP_SLT;
2676     break;
2677   case LoopVectorizationLegality::MRK_SIntMax:
2678     P = CmpInst::ICMP_SGT;
2679     break;
2680   case LoopVectorizationLegality::MRK_FloatMin:
2681     P = CmpInst::FCMP_OLT;
2682     break;
2683   case LoopVectorizationLegality::MRK_FloatMax:
2684     P = CmpInst::FCMP_OGT;
2685     break;
2686   }
2687
2688   Value *Cmp;
2689   if (RK == LoopVectorizationLegality::MRK_FloatMin ||
2690       RK == LoopVectorizationLegality::MRK_FloatMax)
2691     Cmp = Builder.CreateFCmp(P, Left, Right, "rdx.minmax.cmp");
2692   else
2693     Cmp = Builder.CreateICmp(P, Left, Right, "rdx.minmax.cmp");
2694
2695   Value *Select = Builder.CreateSelect(Cmp, Left, Right, "rdx.minmax.select");
2696   return Select;
2697 }
2698
2699 namespace {
2700 struct CSEDenseMapInfo {
2701   static bool canHandle(Instruction *I) {
2702     return isa<InsertElementInst>(I) || isa<ExtractElementInst>(I) ||
2703            isa<ShuffleVectorInst>(I) || isa<GetElementPtrInst>(I);
2704   }
2705   static inline Instruction *getEmptyKey() {
2706     return DenseMapInfo<Instruction *>::getEmptyKey();
2707   }
2708   static inline Instruction *getTombstoneKey() {
2709     return DenseMapInfo<Instruction *>::getTombstoneKey();
2710   }
2711   static unsigned getHashValue(Instruction *I) {
2712     assert(canHandle(I) && "Unknown instruction!");
2713     return hash_combine(I->getOpcode(), hash_combine_range(I->value_op_begin(),
2714                                                            I->value_op_end()));
2715   }
2716   static bool isEqual(Instruction *LHS, Instruction *RHS) {
2717     if (LHS == getEmptyKey() || RHS == getEmptyKey() ||
2718         LHS == getTombstoneKey() || RHS == getTombstoneKey())
2719       return LHS == RHS;
2720     return LHS->isIdenticalTo(RHS);
2721   }
2722 };
2723 }
2724
2725 /// \brief Check whether this block is a predicated block.
2726 /// Due to if predication of stores we might create a sequence of "if(pred) a[i]
2727 /// = ...;  " blocks. We start with one vectorized basic block. For every
2728 /// conditional block we split this vectorized block. Therefore, every second
2729 /// block will be a predicated one.
2730 static bool isPredicatedBlock(unsigned BlockNum) {
2731   return BlockNum % 2;
2732 }
2733
2734 ///\brief Perform cse of induction variable instructions.
2735 static void cse(SmallVector<BasicBlock *, 4> &BBs) {
2736   // Perform simple cse.
2737   SmallDenseMap<Instruction *, Instruction *, 4, CSEDenseMapInfo> CSEMap;
2738   for (unsigned i = 0, e = BBs.size(); i != e; ++i) {
2739     BasicBlock *BB = BBs[i];
2740     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;) {
2741       Instruction *In = I++;
2742
2743       if (!CSEDenseMapInfo::canHandle(In))
2744         continue;
2745
2746       // Check if we can replace this instruction with any of the
2747       // visited instructions.
2748       if (Instruction *V = CSEMap.lookup(In)) {
2749         In->replaceAllUsesWith(V);
2750         In->eraseFromParent();
2751         continue;
2752       }
2753       // Ignore instructions in conditional blocks. We create "if (pred) a[i] =
2754       // ...;" blocks for predicated stores. Every second block is a predicated
2755       // block.
2756       if (isPredicatedBlock(i))
2757         continue;
2758
2759       CSEMap[In] = In;
2760     }
2761   }
2762 }
2763
2764 /// \brief Adds a 'fast' flag to floating point operations.
2765 static Value *addFastMathFlag(Value *V) {
2766   if (isa<FPMathOperator>(V)){
2767     FastMathFlags Flags;
2768     Flags.setUnsafeAlgebra();
2769     cast<Instruction>(V)->setFastMathFlags(Flags);
2770   }
2771   return V;
2772 }
2773
2774 void InnerLoopVectorizer::vectorizeLoop() {
2775   //===------------------------------------------------===//
2776   //
2777   // Notice: any optimization or new instruction that go
2778   // into the code below should be also be implemented in
2779   // the cost-model.
2780   //
2781   //===------------------------------------------------===//
2782   Constant *Zero = Builder.getInt32(0);
2783
2784   // In order to support reduction variables we need to be able to vectorize
2785   // Phi nodes. Phi nodes have cycles, so we need to vectorize them in two
2786   // stages. First, we create a new vector PHI node with no incoming edges.
2787   // We use this value when we vectorize all of the instructions that use the
2788   // PHI. Next, after all of the instructions in the block are complete we
2789   // add the new incoming edges to the PHI. At this point all of the
2790   // instructions in the basic block are vectorized, so we can use them to
2791   // construct the PHI.
2792   PhiVector RdxPHIsToFix;
2793
2794   // Scan the loop in a topological order to ensure that defs are vectorized
2795   // before users.
2796   LoopBlocksDFS DFS(OrigLoop);
2797   DFS.perform(LI);
2798
2799   // Vectorize all of the blocks in the original loop.
2800   for (LoopBlocksDFS::RPOIterator bb = DFS.beginRPO(),
2801        be = DFS.endRPO(); bb != be; ++bb)
2802     vectorizeBlockInLoop(*bb, &RdxPHIsToFix);
2803
2804   // At this point every instruction in the original loop is widened to
2805   // a vector form. We are almost done. Now, we need to fix the PHI nodes
2806   // that we vectorized. The PHI nodes are currently empty because we did
2807   // not want to introduce cycles. Notice that the remaining PHI nodes
2808   // that we need to fix are reduction variables.
2809
2810   // Create the 'reduced' values for each of the induction vars.
2811   // The reduced values are the vector values that we scalarize and combine
2812   // after the loop is finished.
2813   for (PhiVector::iterator it = RdxPHIsToFix.begin(), e = RdxPHIsToFix.end();
2814        it != e; ++it) {
2815     PHINode *RdxPhi = *it;
2816     assert(RdxPhi && "Unable to recover vectorized PHI");
2817
2818     // Find the reduction variable descriptor.
2819     assert(Legal->getReductionVars()->count(RdxPhi) &&
2820            "Unable to find the reduction variable");
2821     LoopVectorizationLegality::ReductionDescriptor RdxDesc =
2822     (*Legal->getReductionVars())[RdxPhi];
2823
2824     setDebugLocFromInst(Builder, RdxDesc.StartValue);
2825
2826     // We need to generate a reduction vector from the incoming scalar.
2827     // To do so, we need to generate the 'identity' vector and override
2828     // one of the elements with the incoming scalar reduction. We need
2829     // to do it in the vector-loop preheader.
2830     Builder.SetInsertPoint(LoopBypassBlocks[1]->getTerminator());
2831
2832     // This is the vector-clone of the value that leaves the loop.
2833     VectorParts &VectorExit = getVectorValue(RdxDesc.LoopExitInstr);
2834     Type *VecTy = VectorExit[0]->getType();
2835
2836     // Find the reduction identity variable. Zero for addition, or, xor,
2837     // one for multiplication, -1 for And.
2838     Value *Identity;
2839     Value *VectorStart;
2840     if (RdxDesc.Kind == LoopVectorizationLegality::RK_IntegerMinMax ||
2841         RdxDesc.Kind == LoopVectorizationLegality::RK_FloatMinMax) {
2842       // MinMax reduction have the start value as their identify.
2843       if (VF == 1) {
2844         VectorStart = Identity = RdxDesc.StartValue;
2845       } else {
2846         VectorStart = Identity = Builder.CreateVectorSplat(VF,
2847                                                            RdxDesc.StartValue,
2848                                                            "minmax.ident");
2849       }
2850     } else {
2851       // Handle other reduction kinds:
2852       Constant *Iden =
2853       LoopVectorizationLegality::getReductionIdentity(RdxDesc.Kind,
2854                                                       VecTy->getScalarType());
2855       if (VF == 1) {
2856         Identity = Iden;
2857         // This vector is the Identity vector where the first element is the
2858         // incoming scalar reduction.
2859         VectorStart = RdxDesc.StartValue;
2860       } else {
2861         Identity = ConstantVector::getSplat(VF, Iden);
2862
2863         // This vector is the Identity vector where the first element is the
2864         // incoming scalar reduction.
2865         VectorStart = Builder.CreateInsertElement(Identity,
2866                                                   RdxDesc.StartValue, Zero);
2867       }
2868     }
2869
2870     // Fix the vector-loop phi.
2871
2872     // Reductions do not have to start at zero. They can start with
2873     // any loop invariant values.
2874     VectorParts &VecRdxPhi = WidenMap.get(RdxPhi);
2875     BasicBlock *Latch = OrigLoop->getLoopLatch();
2876     Value *LoopVal = RdxPhi->getIncomingValueForBlock(Latch);
2877     VectorParts &Val = getVectorValue(LoopVal);
2878     for (unsigned part = 0; part < UF; ++part) {
2879       // Make sure to add the reduction stat value only to the
2880       // first unroll part.
2881       Value *StartVal = (part == 0) ? VectorStart : Identity;
2882       cast<PHINode>(VecRdxPhi[part])->addIncoming(StartVal,
2883                                                   LoopVectorPreHeader);
2884       cast<PHINode>(VecRdxPhi[part])->addIncoming(Val[part],
2885                                                   LoopVectorBody.back());
2886     }
2887
2888     // Before each round, move the insertion point right between
2889     // the PHIs and the values we are going to write.
2890     // This allows us to write both PHINodes and the extractelement
2891     // instructions.
2892     Builder.SetInsertPoint(LoopMiddleBlock->getFirstInsertionPt());
2893
2894     VectorParts RdxParts;
2895     setDebugLocFromInst(Builder, RdxDesc.LoopExitInstr);
2896     for (unsigned part = 0; part < UF; ++part) {
2897       // This PHINode contains the vectorized reduction variable, or
2898       // the initial value vector, if we bypass the vector loop.
2899       VectorParts &RdxExitVal = getVectorValue(RdxDesc.LoopExitInstr);
2900       PHINode *NewPhi = Builder.CreatePHI(VecTy, 2, "rdx.vec.exit.phi");
2901       Value *StartVal = (part == 0) ? VectorStart : Identity;
2902       for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2903         NewPhi->addIncoming(StartVal, LoopBypassBlocks[I]);
2904       NewPhi->addIncoming(RdxExitVal[part],
2905                           LoopVectorBody.back());
2906       RdxParts.push_back(NewPhi);
2907     }
2908
2909     // Reduce all of the unrolled parts into a single vector.
2910     Value *ReducedPartRdx = RdxParts[0];
2911     unsigned Op = getReductionBinOp(RdxDesc.Kind);
2912     setDebugLocFromInst(Builder, ReducedPartRdx);
2913     for (unsigned part = 1; part < UF; ++part) {
2914       if (Op != Instruction::ICmp && Op != Instruction::FCmp)
2915         // Floating point operations had to be 'fast' to enable the reduction.
2916         ReducedPartRdx = addFastMathFlag(
2917             Builder.CreateBinOp((Instruction::BinaryOps)Op, RdxParts[part],
2918                                 ReducedPartRdx, "bin.rdx"));
2919       else
2920         ReducedPartRdx = createMinMaxOp(Builder, RdxDesc.MinMaxKind,
2921                                         ReducedPartRdx, RdxParts[part]);
2922     }
2923
2924     if (VF > 1) {
2925       // VF is a power of 2 so we can emit the reduction using log2(VF) shuffles
2926       // and vector ops, reducing the set of values being computed by half each
2927       // round.
2928       assert(isPowerOf2_32(VF) &&
2929              "Reduction emission only supported for pow2 vectors!");
2930       Value *TmpVec = ReducedPartRdx;
2931       SmallVector<Constant*, 32> ShuffleMask(VF, nullptr);
2932       for (unsigned i = VF; i != 1; i >>= 1) {
2933         // Move the upper half of the vector to the lower half.
2934         for (unsigned j = 0; j != i/2; ++j)
2935           ShuffleMask[j] = Builder.getInt32(i/2 + j);
2936
2937         // Fill the rest of the mask with undef.
2938         std::fill(&ShuffleMask[i/2], ShuffleMask.end(),
2939                   UndefValue::get(Builder.getInt32Ty()));
2940
2941         Value *Shuf =
2942         Builder.CreateShuffleVector(TmpVec,
2943                                     UndefValue::get(TmpVec->getType()),
2944                                     ConstantVector::get(ShuffleMask),
2945                                     "rdx.shuf");
2946
2947         if (Op != Instruction::ICmp && Op != Instruction::FCmp)
2948           // Floating point operations had to be 'fast' to enable the reduction.
2949           TmpVec = addFastMathFlag(Builder.CreateBinOp(
2950               (Instruction::BinaryOps)Op, TmpVec, Shuf, "bin.rdx"));
2951         else
2952           TmpVec = createMinMaxOp(Builder, RdxDesc.MinMaxKind, TmpVec, Shuf);
2953       }
2954
2955       // The result is in the first element of the vector.
2956       ReducedPartRdx = Builder.CreateExtractElement(TmpVec,
2957                                                     Builder.getInt32(0));
2958     }
2959
2960     // Create a phi node that merges control-flow from the backedge-taken check
2961     // block and the middle block.
2962     PHINode *BCBlockPhi = PHINode::Create(RdxPhi->getType(), 2, "bc.merge.rdx",
2963                                           LoopScalarPreHeader->getTerminator());
2964     BCBlockPhi->addIncoming(RdxDesc.StartValue, LoopBypassBlocks[0]);
2965     BCBlockPhi->addIncoming(ReducedPartRdx, LoopMiddleBlock);
2966
2967     // Now, we need to fix the users of the reduction variable
2968     // inside and outside of the scalar remainder loop.
2969     // We know that the loop is in LCSSA form. We need to update the
2970     // PHI nodes in the exit blocks.
2971     for (BasicBlock::iterator LEI = LoopExitBlock->begin(),
2972          LEE = LoopExitBlock->end(); LEI != LEE; ++LEI) {
2973       PHINode *LCSSAPhi = dyn_cast<PHINode>(LEI);
2974       if (!LCSSAPhi) break;
2975
2976       // All PHINodes need to have a single entry edge, or two if
2977       // we already fixed them.
2978       assert(LCSSAPhi->getNumIncomingValues() < 3 && "Invalid LCSSA PHI");
2979
2980       // We found our reduction value exit-PHI. Update it with the
2981       // incoming bypass edge.
2982       if (LCSSAPhi->getIncomingValue(0) == RdxDesc.LoopExitInstr) {
2983         // Add an edge coming from the bypass.
2984         LCSSAPhi->addIncoming(ReducedPartRdx, LoopMiddleBlock);
2985         break;
2986       }
2987     }// end of the LCSSA phi scan.
2988
2989     // Fix the scalar loop reduction variable with the incoming reduction sum
2990     // from the vector body and from the backedge value.
2991     int IncomingEdgeBlockIdx =
2992     (RdxPhi)->getBasicBlockIndex(OrigLoop->getLoopLatch());
2993     assert(IncomingEdgeBlockIdx >= 0 && "Invalid block index");
2994     // Pick the other block.
2995     int SelfEdgeBlockIdx = (IncomingEdgeBlockIdx ? 0 : 1);
2996     (RdxPhi)->setIncomingValue(SelfEdgeBlockIdx, BCBlockPhi);
2997     (RdxPhi)->setIncomingValue(IncomingEdgeBlockIdx, RdxDesc.LoopExitInstr);
2998   }// end of for each redux variable.
2999
3000   fixLCSSAPHIs();
3001
3002   // Remove redundant induction instructions.
3003   cse(LoopVectorBody);
3004 }
3005
3006 void InnerLoopVectorizer::fixLCSSAPHIs() {
3007   for (BasicBlock::iterator LEI = LoopExitBlock->begin(),
3008        LEE = LoopExitBlock->end(); LEI != LEE; ++LEI) {
3009     PHINode *LCSSAPhi = dyn_cast<PHINode>(LEI);
3010     if (!LCSSAPhi) break;
3011     if (LCSSAPhi->getNumIncomingValues() == 1)
3012       LCSSAPhi->addIncoming(UndefValue::get(LCSSAPhi->getType()),
3013                             LoopMiddleBlock);
3014   }
3015 }
3016
3017 InnerLoopVectorizer::VectorParts
3018 InnerLoopVectorizer::createEdgeMask(BasicBlock *Src, BasicBlock *Dst) {
3019   assert(std::find(pred_begin(Dst), pred_end(Dst), Src) != pred_end(Dst) &&
3020          "Invalid edge");
3021
3022   // Look for cached value.
3023   std::pair<BasicBlock*, BasicBlock*> Edge(Src, Dst);
3024   EdgeMaskCache::iterator ECEntryIt = MaskCache.find(Edge);
3025   if (ECEntryIt != MaskCache.end())
3026     return ECEntryIt->second;
3027
3028   VectorParts SrcMask = createBlockInMask(Src);
3029
3030   // The terminator has to be a branch inst!
3031   BranchInst *BI = dyn_cast<BranchInst>(Src->getTerminator());
3032   assert(BI && "Unexpected terminator found");
3033
3034   if (BI->isConditional()) {
3035     VectorParts EdgeMask = getVectorValue(BI->getCondition());
3036
3037     if (BI->getSuccessor(0) != Dst)
3038       for (unsigned part = 0; part < UF; ++part)
3039         EdgeMask[part] = Builder.CreateNot(EdgeMask[part]);
3040
3041     for (unsigned part = 0; part < UF; ++part)
3042       EdgeMask[part] = Builder.CreateAnd(EdgeMask[part], SrcMask[part]);
3043
3044     MaskCache[Edge] = EdgeMask;
3045     return EdgeMask;
3046   }
3047
3048   MaskCache[Edge] = SrcMask;
3049   return SrcMask;
3050 }
3051
3052 InnerLoopVectorizer::VectorParts
3053 InnerLoopVectorizer::createBlockInMask(BasicBlock *BB) {
3054   assert(OrigLoop->contains(BB) && "Block is not a part of a loop");
3055
3056   // Loop incoming mask is all-one.
3057   if (OrigLoop->getHeader() == BB) {
3058     Value *C = ConstantInt::get(IntegerType::getInt1Ty(BB->getContext()), 1);
3059     return getVectorValue(C);
3060   }
3061
3062   // This is the block mask. We OR all incoming edges, and with zero.
3063   Value *Zero = ConstantInt::get(IntegerType::getInt1Ty(BB->getContext()), 0);
3064   VectorParts BlockMask = getVectorValue(Zero);
3065
3066   // For each pred:
3067   for (pred_iterator it = pred_begin(BB), e = pred_end(BB); it != e; ++it) {
3068     VectorParts EM = createEdgeMask(*it, BB);
3069     for (unsigned part = 0; part < UF; ++part)
3070       BlockMask[part] = Builder.CreateOr(BlockMask[part], EM[part]);
3071   }
3072
3073   return BlockMask;
3074 }
3075
3076 void InnerLoopVectorizer::widenPHIInstruction(Instruction *PN,
3077                                               InnerLoopVectorizer::VectorParts &Entry,
3078                                               unsigned UF, unsigned VF, PhiVector *PV) {
3079   PHINode* P = cast<PHINode>(PN);
3080   // Handle reduction variables:
3081   if (Legal->getReductionVars()->count(P)) {
3082     for (unsigned part = 0; part < UF; ++part) {
3083       // This is phase one of vectorizing PHIs.
3084       Type *VecTy = (VF == 1) ? PN->getType() :
3085       VectorType::get(PN->getType(), VF);
3086       Entry[part] = PHINode::Create(VecTy, 2, "vec.phi",
3087                                     LoopVectorBody.back()-> getFirstInsertionPt());
3088     }
3089     PV->push_back(P);
3090     return;
3091   }
3092
3093   setDebugLocFromInst(Builder, P);
3094   // Check for PHI nodes that are lowered to vector selects.
3095   if (P->getParent() != OrigLoop->getHeader()) {
3096     // We know that all PHIs in non-header blocks are converted into
3097     // selects, so we don't have to worry about the insertion order and we
3098     // can just use the builder.
3099     // At this point we generate the predication tree. There may be
3100     // duplications since this is a simple recursive scan, but future
3101     // optimizations will clean it up.
3102
3103     unsigned NumIncoming = P->getNumIncomingValues();
3104
3105     // Generate a sequence of selects of the form:
3106     // SELECT(Mask3, In3,
3107     //      SELECT(Mask2, In2,
3108     //                   ( ...)))
3109     for (unsigned In = 0; In < NumIncoming; In++) {
3110       VectorParts Cond = createEdgeMask(P->getIncomingBlock(In),
3111                                         P->getParent());
3112       VectorParts &In0 = getVectorValue(P->getIncomingValue(In));
3113
3114       for (unsigned part = 0; part < UF; ++part) {
3115         // We might have single edge PHIs (blocks) - use an identity
3116         // 'select' for the first PHI operand.
3117         if (In == 0)
3118           Entry[part] = Builder.CreateSelect(Cond[part], In0[part],
3119                                              In0[part]);
3120         else
3121           // Select between the current value and the previous incoming edge
3122           // based on the incoming mask.
3123           Entry[part] = Builder.CreateSelect(Cond[part], In0[part],
3124                                              Entry[part], "predphi");
3125       }
3126     }
3127     return;
3128   }
3129
3130   // This PHINode must be an induction variable.
3131   // Make sure that we know about it.
3132   assert(Legal->getInductionVars()->count(P) &&
3133          "Not an induction variable");
3134
3135   LoopVectorizationLegality::InductionInfo II =
3136   Legal->getInductionVars()->lookup(P);
3137
3138   switch (II.IK) {
3139     case LoopVectorizationLegality::IK_NoInduction:
3140       llvm_unreachable("Unknown induction");
3141     case LoopVectorizationLegality::IK_IntInduction: {
3142       assert(P->getType() == II.StartValue->getType() && "Types must match");
3143       Type *PhiTy = P->getType();
3144       Value *Broadcasted;
3145       if (P == OldInduction) {
3146         // Handle the canonical induction variable. We might have had to
3147         // extend the type.
3148         Broadcasted = Builder.CreateTrunc(Induction, PhiTy);
3149       } else {
3150         // Handle other induction variables that are now based on the
3151         // canonical one.
3152         Value *NormalizedIdx = Builder.CreateSub(Induction, ExtendedIdx,
3153                                                  "normalized.idx");
3154         NormalizedIdx = Builder.CreateSExtOrTrunc(NormalizedIdx, PhiTy);
3155         Broadcasted = Builder.CreateAdd(II.StartValue, NormalizedIdx,
3156                                         "offset.idx");
3157       }
3158       Broadcasted = getBroadcastInstrs(Broadcasted);
3159       // After broadcasting the induction variable we need to make the vector
3160       // consecutive by adding 0, 1, 2, etc.
3161       for (unsigned part = 0; part < UF; ++part)
3162         Entry[part] = getConsecutiveVector(Broadcasted, VF * part, false);
3163       return;
3164     }
3165     case LoopVectorizationLegality::IK_ReverseIntInduction:
3166     case LoopVectorizationLegality::IK_PtrInduction:
3167     case LoopVectorizationLegality::IK_ReversePtrInduction:
3168       // Handle reverse integer and pointer inductions.
3169       Value *StartIdx = ExtendedIdx;
3170       // This is the normalized GEP that starts counting at zero.
3171       Value *NormalizedIdx = Builder.CreateSub(Induction, StartIdx,
3172                                                "normalized.idx");
3173
3174       // Handle the reverse integer induction variable case.
3175       if (LoopVectorizationLegality::IK_ReverseIntInduction == II.IK) {
3176         IntegerType *DstTy = cast<IntegerType>(II.StartValue->getType());
3177         Value *CNI = Builder.CreateSExtOrTrunc(NormalizedIdx, DstTy,
3178                                                "resize.norm.idx");
3179         Value *ReverseInd  = Builder.CreateSub(II.StartValue, CNI,
3180                                                "reverse.idx");
3181
3182         // This is a new value so do not hoist it out.
3183         Value *Broadcasted = getBroadcastInstrs(ReverseInd);
3184         // After broadcasting the induction variable we need to make the
3185         // vector consecutive by adding  ... -3, -2, -1, 0.
3186         for (unsigned part = 0; part < UF; ++part)
3187           Entry[part] = getConsecutiveVector(Broadcasted, -(int)VF * part,
3188                                              true);
3189         return;
3190       }
3191
3192       // Handle the pointer induction variable case.
3193       assert(P->getType()->isPointerTy() && "Unexpected type.");
3194
3195       // Is this a reverse induction ptr or a consecutive induction ptr.
3196       bool Reverse = (LoopVectorizationLegality::IK_ReversePtrInduction ==
3197                       II.IK);
3198
3199       // This is the vector of results. Notice that we don't generate
3200       // vector geps because scalar geps result in better code.
3201       for (unsigned part = 0; part < UF; ++part) {
3202         if (VF == 1) {
3203           int EltIndex = (part) * (Reverse ? -1 : 1);
3204           Constant *Idx = ConstantInt::get(Induction->getType(), EltIndex);
3205           Value *GlobalIdx;
3206           if (Reverse)
3207             GlobalIdx = Builder.CreateSub(Idx, NormalizedIdx, "gep.ridx");
3208           else
3209             GlobalIdx = Builder.CreateAdd(NormalizedIdx, Idx, "gep.idx");
3210
3211           Value *SclrGep = Builder.CreateGEP(II.StartValue, GlobalIdx,
3212                                              "next.gep");
3213           Entry[part] = SclrGep;
3214           continue;
3215         }
3216
3217         Value *VecVal = UndefValue::get(VectorType::get(P->getType(), VF));
3218         for (unsigned int i = 0; i < VF; ++i) {
3219           int EltIndex = (i + part * VF) * (Reverse ? -1 : 1);
3220           Constant *Idx = ConstantInt::get(Induction->getType(), EltIndex);
3221           Value *GlobalIdx;
3222           if (!Reverse)
3223             GlobalIdx = Builder.CreateAdd(NormalizedIdx, Idx, "gep.idx");
3224           else
3225             GlobalIdx = Builder.CreateSub(Idx, NormalizedIdx, "gep.ridx");
3226
3227           Value *SclrGep = Builder.CreateGEP(II.StartValue, GlobalIdx,
3228                                              "next.gep");
3229           VecVal = Builder.CreateInsertElement(VecVal, SclrGep,
3230                                                Builder.getInt32(i),
3231                                                "insert.gep");
3232         }
3233         Entry[part] = VecVal;
3234       }
3235       return;
3236   }
3237 }
3238
3239 void InnerLoopVectorizer::vectorizeBlockInLoop(BasicBlock *BB, PhiVector *PV) {
3240   // For each instruction in the old loop.
3241   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
3242     VectorParts &Entry = WidenMap.get(it);
3243     switch (it->getOpcode()) {
3244     case Instruction::Br:
3245       // Nothing to do for PHIs and BR, since we already took care of the
3246       // loop control flow instructions.
3247       continue;
3248     case Instruction::PHI:{
3249       // Vectorize PHINodes.
3250       widenPHIInstruction(it, Entry, UF, VF, PV);
3251       continue;
3252     }// End of PHI.
3253
3254     case Instruction::Add:
3255     case Instruction::FAdd:
3256     case Instruction::Sub:
3257     case Instruction::FSub:
3258     case Instruction::Mul:
3259     case Instruction::FMul:
3260     case Instruction::UDiv:
3261     case Instruction::SDiv:
3262     case Instruction::FDiv:
3263     case Instruction::URem:
3264     case Instruction::SRem:
3265     case Instruction::FRem:
3266     case Instruction::Shl:
3267     case Instruction::LShr:
3268     case Instruction::AShr:
3269     case Instruction::And:
3270     case Instruction::Or:
3271     case Instruction::Xor: {
3272       // Just widen binops.
3273       BinaryOperator *BinOp = dyn_cast<BinaryOperator>(it);
3274       setDebugLocFromInst(Builder, BinOp);
3275       VectorParts &A = getVectorValue(it->getOperand(0));
3276       VectorParts &B = getVectorValue(it->getOperand(1));
3277
3278       // Use this vector value for all users of the original instruction.
3279       for (unsigned Part = 0; Part < UF; ++Part) {
3280         Value *V = Builder.CreateBinOp(BinOp->getOpcode(), A[Part], B[Part]);
3281
3282         if (BinaryOperator *VecOp = dyn_cast<BinaryOperator>(V))
3283           VecOp->copyIRFlags(BinOp);
3284
3285         Entry[Part] = V;
3286       }
3287
3288       propagateMetadata(Entry, it);
3289       break;
3290     }
3291     case Instruction::Select: {
3292       // Widen selects.
3293       // If the selector is loop invariant we can create a select
3294       // instruction with a scalar condition. Otherwise, use vector-select.
3295       bool InvariantCond = SE->isLoopInvariant(SE->getSCEV(it->getOperand(0)),
3296                                                OrigLoop);
3297       setDebugLocFromInst(Builder, it);
3298
3299       // The condition can be loop invariant  but still defined inside the
3300       // loop. This means that we can't just use the original 'cond' value.
3301       // We have to take the 'vectorized' value and pick the first lane.
3302       // Instcombine will make this a no-op.
3303       VectorParts &Cond = getVectorValue(it->getOperand(0));
3304       VectorParts &Op0  = getVectorValue(it->getOperand(1));
3305       VectorParts &Op1  = getVectorValue(it->getOperand(2));
3306
3307       Value *ScalarCond = (VF == 1) ? Cond[0] :
3308         Builder.CreateExtractElement(Cond[0], Builder.getInt32(0));
3309
3310       for (unsigned Part = 0; Part < UF; ++Part) {
3311         Entry[Part] = Builder.CreateSelect(
3312           InvariantCond ? ScalarCond : Cond[Part],
3313           Op0[Part],
3314           Op1[Part]);
3315       }
3316
3317       propagateMetadata(Entry, it);
3318       break;
3319     }
3320
3321     case Instruction::ICmp:
3322     case Instruction::FCmp: {
3323       // Widen compares. Generate vector compares.
3324       bool FCmp = (it->getOpcode() == Instruction::FCmp);
3325       CmpInst *Cmp = dyn_cast<CmpInst>(it);
3326       setDebugLocFromInst(Builder, it);
3327       VectorParts &A = getVectorValue(it->getOperand(0));
3328       VectorParts &B = getVectorValue(it->getOperand(1));
3329       for (unsigned Part = 0; Part < UF; ++Part) {
3330         Value *C = nullptr;
3331         if (FCmp)
3332           C = Builder.CreateFCmp(Cmp->getPredicate(), A[Part], B[Part]);
3333         else
3334           C = Builder.CreateICmp(Cmp->getPredicate(), A[Part], B[Part]);
3335         Entry[Part] = C;
3336       }
3337
3338       propagateMetadata(Entry, it);
3339       break;
3340     }
3341
3342     case Instruction::Store:
3343     case Instruction::Load:
3344       vectorizeMemoryInstruction(it);
3345         break;
3346     case Instruction::ZExt:
3347     case Instruction::SExt:
3348     case Instruction::FPToUI:
3349     case Instruction::FPToSI:
3350     case Instruction::FPExt:
3351     case Instruction::PtrToInt:
3352     case Instruction::IntToPtr:
3353     case Instruction::SIToFP:
3354     case Instruction::UIToFP:
3355     case Instruction::Trunc:
3356     case Instruction::FPTrunc:
3357     case Instruction::BitCast: {
3358       CastInst *CI = dyn_cast<CastInst>(it);
3359       setDebugLocFromInst(Builder, it);
3360       /// Optimize the special case where the source is the induction
3361       /// variable. Notice that we can only optimize the 'trunc' case
3362       /// because: a. FP conversions lose precision, b. sext/zext may wrap,
3363       /// c. other casts depend on pointer size.
3364       if (CI->getOperand(0) == OldInduction &&
3365           it->getOpcode() == Instruction::Trunc) {
3366         Value *ScalarCast = Builder.CreateCast(CI->getOpcode(), Induction,
3367                                                CI->getType());
3368         Value *Broadcasted = getBroadcastInstrs(ScalarCast);
3369         for (unsigned Part = 0; Part < UF; ++Part)
3370           Entry[Part] = getConsecutiveVector(Broadcasted, VF * Part, false);
3371         propagateMetadata(Entry, it);
3372         break;
3373       }
3374       /// Vectorize casts.
3375       Type *DestTy = (VF == 1) ? CI->getType() :
3376                                  VectorType::get(CI->getType(), VF);
3377
3378       VectorParts &A = getVectorValue(it->getOperand(0));
3379       for (unsigned Part = 0; Part < UF; ++Part)
3380         Entry[Part] = Builder.CreateCast(CI->getOpcode(), A[Part], DestTy);
3381       propagateMetadata(Entry, it);
3382       break;
3383     }
3384
3385     case Instruction::Call: {
3386       // Ignore dbg intrinsics.
3387       if (isa<DbgInfoIntrinsic>(it))
3388         break;
3389       setDebugLocFromInst(Builder, it);
3390
3391       Module *M = BB->getParent()->getParent();
3392       CallInst *CI = cast<CallInst>(it);
3393       Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
3394       assert(ID && "Not an intrinsic call!");
3395       switch (ID) {
3396       case Intrinsic::assume:
3397       case Intrinsic::lifetime_end:
3398       case Intrinsic::lifetime_start:
3399         scalarizeInstruction(it);
3400         break;
3401       default:
3402         bool HasScalarOpd = hasVectorInstrinsicScalarOpd(ID, 1);
3403         for (unsigned Part = 0; Part < UF; ++Part) {
3404           SmallVector<Value *, 4> Args;
3405           for (unsigned i = 0, ie = CI->getNumArgOperands(); i != ie; ++i) {
3406             if (HasScalarOpd && i == 1) {
3407               Args.push_back(CI->getArgOperand(i));
3408               continue;
3409             }
3410             VectorParts &Arg = getVectorValue(CI->getArgOperand(i));
3411             Args.push_back(Arg[Part]);
3412           }
3413           Type *Tys[] = {CI->getType()};
3414           if (VF > 1)
3415             Tys[0] = VectorType::get(CI->getType()->getScalarType(), VF);
3416
3417           Function *F = Intrinsic::getDeclaration(M, ID, Tys);
3418           Entry[Part] = Builder.CreateCall(F, Args);
3419         }
3420
3421         propagateMetadata(Entry, it);
3422         break;
3423       }
3424       break;
3425     }
3426
3427     default:
3428       // All other instructions are unsupported. Scalarize them.
3429       scalarizeInstruction(it);
3430       break;
3431     }// end of switch.
3432   }// end of for_each instr.
3433 }
3434
3435 void InnerLoopVectorizer::updateAnalysis() {
3436   // Forget the original basic block.
3437   SE->forgetLoop(OrigLoop);
3438
3439   // Update the dominator tree information.
3440   assert(DT->properlyDominates(LoopBypassBlocks.front(), LoopExitBlock) &&
3441          "Entry does not dominate exit.");
3442
3443   for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
3444     DT->addNewBlock(LoopBypassBlocks[I], LoopBypassBlocks[I-1]);
3445   DT->addNewBlock(LoopVectorPreHeader, LoopBypassBlocks.back());
3446
3447   // Due to if predication of stores we might create a sequence of "if(pred)
3448   // a[i] = ...;  " blocks.
3449   for (unsigned i = 0, e = LoopVectorBody.size(); i != e; ++i) {
3450     if (i == 0)
3451       DT->addNewBlock(LoopVectorBody[0], LoopVectorPreHeader);
3452     else if (isPredicatedBlock(i)) {
3453       DT->addNewBlock(LoopVectorBody[i], LoopVectorBody[i-1]);
3454     } else {
3455       DT->addNewBlock(LoopVectorBody[i], LoopVectorBody[i-2]);
3456     }
3457   }
3458
3459   DT->addNewBlock(LoopMiddleBlock, LoopBypassBlocks[1]);
3460   DT->addNewBlock(LoopScalarPreHeader, LoopBypassBlocks[0]);
3461   DT->changeImmediateDominator(LoopScalarBody, LoopScalarPreHeader);
3462   DT->changeImmediateDominator(LoopExitBlock, LoopBypassBlocks[0]);
3463
3464   DEBUG(DT->verifyDomTree());
3465 }
3466
3467 /// \brief Check whether it is safe to if-convert this phi node.
3468 ///
3469 /// Phi nodes with constant expressions that can trap are not safe to if
3470 /// convert.
3471 static bool canIfConvertPHINodes(BasicBlock *BB) {
3472   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
3473     PHINode *Phi = dyn_cast<PHINode>(I);
3474     if (!Phi)
3475       return true;
3476     for (unsigned p = 0, e = Phi->getNumIncomingValues(); p != e; ++p)
3477       if (Constant *C = dyn_cast<Constant>(Phi->getIncomingValue(p)))
3478         if (C->canTrap())
3479           return false;
3480   }
3481   return true;
3482 }
3483
3484 bool LoopVectorizationLegality::canVectorizeWithIfConvert() {
3485   if (!EnableIfConversion) {
3486     emitAnalysis(Report() << "if-conversion is disabled");
3487     return false;
3488   }
3489
3490   assert(TheLoop->getNumBlocks() > 1 && "Single block loops are vectorizable");
3491
3492   // A list of pointers that we can safely read and write to.
3493   SmallPtrSet<Value *, 8> SafePointes;
3494
3495   // Collect safe addresses.
3496   for (Loop::block_iterator BI = TheLoop->block_begin(),
3497          BE = TheLoop->block_end(); BI != BE; ++BI) {
3498     BasicBlock *BB = *BI;
3499
3500     if (blockNeedsPredication(BB))
3501       continue;
3502
3503     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
3504       if (LoadInst *LI = dyn_cast<LoadInst>(I))
3505         SafePointes.insert(LI->getPointerOperand());
3506       else if (StoreInst *SI = dyn_cast<StoreInst>(I))
3507         SafePointes.insert(SI->getPointerOperand());
3508     }
3509   }
3510
3511   // Collect the blocks that need predication.
3512   BasicBlock *Header = TheLoop->getHeader();
3513   for (Loop::block_iterator BI = TheLoop->block_begin(),
3514          BE = TheLoop->block_end(); BI != BE; ++BI) {
3515     BasicBlock *BB = *BI;
3516
3517     // We don't support switch statements inside loops.
3518     if (!isa<BranchInst>(BB->getTerminator())) {
3519       emitAnalysis(Report(BB->getTerminator())
3520                    << "loop contains a switch statement");
3521       return false;
3522     }
3523
3524     // We must be able to predicate all blocks that need to be predicated.
3525     if (blockNeedsPredication(BB)) {
3526       if (!blockCanBePredicated(BB, SafePointes)) {
3527         emitAnalysis(Report(BB->getTerminator())
3528                      << "control flow cannot be substituted for a select");
3529         return false;
3530       }
3531     } else if (BB != Header && !canIfConvertPHINodes(BB)) {
3532       emitAnalysis(Report(BB->getTerminator())
3533                    << "control flow cannot be substituted for a select");
3534       return false;
3535     }
3536   }
3537
3538   // We can if-convert this loop.
3539   return true;
3540 }
3541
3542 bool LoopVectorizationLegality::canVectorize() {
3543   // We must have a loop in canonical form. Loops with indirectbr in them cannot
3544   // be canonicalized.
3545   if (!TheLoop->getLoopPreheader()) {
3546     emitAnalysis(
3547         Report() << "loop control flow is not understood by vectorizer");
3548     return false;
3549   }
3550
3551   // We can only vectorize innermost loops.
3552   if (!TheLoop->getSubLoopsVector().empty()) {
3553     emitAnalysis(Report() << "loop is not the innermost loop");
3554     return false;
3555   }
3556
3557   // We must have a single backedge.
3558   if (TheLoop->getNumBackEdges() != 1) {
3559     emitAnalysis(
3560         Report() << "loop control flow is not understood by vectorizer");
3561     return false;
3562   }
3563
3564   // We must have a single exiting block.
3565   if (!TheLoop->getExitingBlock()) {
3566     emitAnalysis(
3567         Report() << "loop control flow is not understood by vectorizer");
3568     return false;
3569   }
3570
3571   // We only handle bottom-tested loops, i.e. loop in which the condition is
3572   // checked at the end of each iteration. With that we can assume that all
3573   // instructions in the loop are executed the same number of times.
3574   if (TheLoop->getExitingBlock() != TheLoop->getLoopLatch()) {
3575     emitAnalysis(
3576         Report() << "loop control flow is not understood by vectorizer");
3577     return false;
3578   }
3579
3580   // We need to have a loop header.
3581   DEBUG(dbgs() << "LV: Found a loop: " <<
3582         TheLoop->getHeader()->getName() << '\n');
3583
3584   // Check if we can if-convert non-single-bb loops.
3585   unsigned NumBlocks = TheLoop->getNumBlocks();
3586   if (NumBlocks != 1 && !canVectorizeWithIfConvert()) {
3587     DEBUG(dbgs() << "LV: Can't if-convert the loop.\n");
3588     return false;
3589   }
3590
3591   // ScalarEvolution needs to be able to find the exit count.
3592   const SCEV *ExitCount = SE->getBackedgeTakenCount(TheLoop);
3593   if (ExitCount == SE->getCouldNotCompute()) {
3594     emitAnalysis(Report() << "could not determine number of loop iterations");
3595     DEBUG(dbgs() << "LV: SCEV could not compute the loop exit count.\n");
3596     return false;
3597   }
3598
3599   // Check if we can vectorize the instructions and CFG in this loop.
3600   if (!canVectorizeInstrs()) {
3601     DEBUG(dbgs() << "LV: Can't vectorize the instructions or CFG\n");
3602     return false;
3603   }
3604
3605   // Go over each instruction and look at memory deps.
3606   if (!canVectorizeMemory()) {
3607     DEBUG(dbgs() << "LV: Can't vectorize due to memory conflicts\n");
3608     return false;
3609   }
3610
3611   // Collect all of the variables that remain uniform after vectorization.
3612   collectLoopUniforms();
3613
3614   DEBUG(dbgs() << "LV: We can vectorize this loop" <<
3615         (PtrRtCheck.Need ? " (with a runtime bound check)" : "")
3616         <<"!\n");
3617
3618   // Okay! We can vectorize. At this point we don't have any other mem analysis
3619   // which may limit our maximum vectorization factor, so just return true with
3620   // no restrictions.
3621   return true;
3622 }
3623
3624 static Type *convertPointerToIntegerType(const DataLayout &DL, Type *Ty) {
3625   if (Ty->isPointerTy())
3626     return DL.getIntPtrType(Ty);
3627
3628   // It is possible that char's or short's overflow when we ask for the loop's
3629   // trip count, work around this by changing the type size.
3630   if (Ty->getScalarSizeInBits() < 32)
3631     return Type::getInt32Ty(Ty->getContext());
3632
3633   return Ty;
3634 }
3635
3636 static Type* getWiderType(const DataLayout &DL, Type *Ty0, Type *Ty1) {
3637   Ty0 = convertPointerToIntegerType(DL, Ty0);
3638   Ty1 = convertPointerToIntegerType(DL, Ty1);
3639   if (Ty0->getScalarSizeInBits() > Ty1->getScalarSizeInBits())
3640     return Ty0;
3641   return Ty1;
3642 }
3643
3644 /// \brief Check that the instruction has outside loop users and is not an
3645 /// identified reduction variable.
3646 static bool hasOutsideLoopUser(const Loop *TheLoop, Instruction *Inst,
3647                                SmallPtrSetImpl<Value *> &Reductions) {
3648   // Reduction instructions are allowed to have exit users. All other
3649   // instructions must not have external users.
3650   if (!Reductions.count(Inst))
3651     //Check that all of the users of the loop are inside the BB.
3652     for (User *U : Inst->users()) {
3653       Instruction *UI = cast<Instruction>(U);
3654       // This user may be a reduction exit value.
3655       if (!TheLoop->contains(UI)) {
3656         DEBUG(dbgs() << "LV: Found an outside user for : " << *UI << '\n');
3657         return true;
3658       }
3659     }
3660   return false;
3661 }
3662
3663 bool LoopVectorizationLegality::canVectorizeInstrs() {
3664   BasicBlock *PreHeader = TheLoop->getLoopPreheader();
3665   BasicBlock *Header = TheLoop->getHeader();
3666
3667   // Look for the attribute signaling the absence of NaNs.
3668   Function &F = *Header->getParent();
3669   if (F.hasFnAttribute("no-nans-fp-math"))
3670     HasFunNoNaNAttr = F.getAttributes().getAttribute(
3671       AttributeSet::FunctionIndex,
3672       "no-nans-fp-math").getValueAsString() == "true";
3673
3674   // For each block in the loop.
3675   for (Loop::block_iterator bb = TheLoop->block_begin(),
3676        be = TheLoop->block_end(); bb != be; ++bb) {
3677
3678     // Scan the instructions in the block and look for hazards.
3679     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
3680          ++it) {
3681
3682       if (PHINode *Phi = dyn_cast<PHINode>(it)) {
3683         Type *PhiTy = Phi->getType();
3684         // Check that this PHI type is allowed.
3685         if (!PhiTy->isIntegerTy() &&
3686             !PhiTy->isFloatingPointTy() &&
3687             !PhiTy->isPointerTy()) {
3688           emitAnalysis(Report(it)
3689                        << "loop control flow is not understood by vectorizer");
3690           DEBUG(dbgs() << "LV: Found an non-int non-pointer PHI.\n");
3691           return false;
3692         }
3693
3694         // If this PHINode is not in the header block, then we know that we
3695         // can convert it to select during if-conversion. No need to check if
3696         // the PHIs in this block are induction or reduction variables.
3697         if (*bb != Header) {
3698           // Check that this instruction has no outside users or is an
3699           // identified reduction value with an outside user.
3700           if (!hasOutsideLoopUser(TheLoop, it, AllowedExit))
3701             continue;
3702           emitAnalysis(Report(it) << "value could not be identified as "
3703                                      "an induction or reduction variable");
3704           return false;
3705         }
3706
3707         // We only allow if-converted PHIs with exactly two incoming values.
3708         if (Phi->getNumIncomingValues() != 2) {
3709           emitAnalysis(Report(it)
3710                        << "control flow not understood by vectorizer");
3711           DEBUG(dbgs() << "LV: Found an invalid PHI.\n");
3712           return false;
3713         }
3714
3715         // This is the value coming from the preheader.
3716         Value *StartValue = Phi->getIncomingValueForBlock(PreHeader);
3717         // Check if this is an induction variable.
3718         InductionKind IK = isInductionVariable(Phi);
3719
3720         if (IK_NoInduction != IK) {
3721           // Get the widest type.
3722           if (!WidestIndTy)
3723             WidestIndTy = convertPointerToIntegerType(*DL, PhiTy);
3724           else
3725             WidestIndTy = getWiderType(*DL, PhiTy, WidestIndTy);
3726
3727           // Int inductions are special because we only allow one IV.
3728           if (IK == IK_IntInduction) {
3729             // Use the phi node with the widest type as induction. Use the last
3730             // one if there are multiple (no good reason for doing this other
3731             // than it is expedient).
3732             if (!Induction || PhiTy == WidestIndTy)
3733               Induction = Phi;
3734           }
3735
3736           DEBUG(dbgs() << "LV: Found an induction variable.\n");
3737           Inductions[Phi] = InductionInfo(StartValue, IK);
3738
3739           // Until we explicitly handle the case of an induction variable with
3740           // an outside loop user we have to give up vectorizing this loop.
3741           if (hasOutsideLoopUser(TheLoop, it, AllowedExit)) {
3742             emitAnalysis(Report(it) << "use of induction value outside of the "
3743                                        "loop is not handled by vectorizer");
3744             return false;
3745           }
3746
3747           continue;
3748         }
3749
3750         if (AddReductionVar(Phi, RK_IntegerAdd)) {
3751           DEBUG(dbgs() << "LV: Found an ADD reduction PHI."<< *Phi <<"\n");
3752           continue;
3753         }
3754         if (AddReductionVar(Phi, RK_IntegerMult)) {
3755           DEBUG(dbgs() << "LV: Found a MUL reduction PHI."<< *Phi <<"\n");
3756           continue;
3757         }
3758         if (AddReductionVar(Phi, RK_IntegerOr)) {
3759           DEBUG(dbgs() << "LV: Found an OR reduction PHI."<< *Phi <<"\n");
3760           continue;
3761         }
3762         if (AddReductionVar(Phi, RK_IntegerAnd)) {
3763           DEBUG(dbgs() << "LV: Found an AND reduction PHI."<< *Phi <<"\n");
3764           continue;
3765         }
3766         if (AddReductionVar(Phi, RK_IntegerXor)) {
3767           DEBUG(dbgs() << "LV: Found a XOR reduction PHI."<< *Phi <<"\n");
3768           continue;
3769         }
3770         if (AddReductionVar(Phi, RK_IntegerMinMax)) {
3771           DEBUG(dbgs() << "LV: Found a MINMAX reduction PHI."<< *Phi <<"\n");
3772           continue;
3773         }
3774         if (AddReductionVar(Phi, RK_FloatMult)) {
3775           DEBUG(dbgs() << "LV: Found an FMult reduction PHI."<< *Phi <<"\n");
3776           continue;
3777         }
3778         if (AddReductionVar(Phi, RK_FloatAdd)) {
3779           DEBUG(dbgs() << "LV: Found an FAdd reduction PHI."<< *Phi <<"\n");
3780           continue;
3781         }
3782         if (AddReductionVar(Phi, RK_FloatMinMax)) {
3783           DEBUG(dbgs() << "LV: Found an float MINMAX reduction PHI."<< *Phi <<
3784                 "\n");
3785           continue;
3786         }
3787
3788         emitAnalysis(Report(it) << "value that could not be identified as "
3789                                    "reduction is used outside the loop");
3790         DEBUG(dbgs() << "LV: Found an unidentified PHI."<< *Phi <<"\n");
3791         return false;
3792       }// end of PHI handling
3793
3794       // We still don't handle functions. However, we can ignore dbg intrinsic
3795       // calls and we do handle certain intrinsic and libm functions.
3796       CallInst *CI = dyn_cast<CallInst>(it);
3797       if (CI && !getIntrinsicIDForCall(CI, TLI) && !isa<DbgInfoIntrinsic>(CI)) {
3798         emitAnalysis(Report(it) << "call instruction cannot be vectorized");
3799         DEBUG(dbgs() << "LV: Found a call site.\n");
3800         return false;
3801       }
3802
3803       // Intrinsics such as powi,cttz and ctlz are legal to vectorize if the
3804       // second argument is the same (i.e. loop invariant)
3805       if (CI &&
3806           hasVectorInstrinsicScalarOpd(getIntrinsicIDForCall(CI, TLI), 1)) {
3807         if (!SE->isLoopInvariant(SE->getSCEV(CI->getOperand(1)), TheLoop)) {
3808           emitAnalysis(Report(it)
3809                        << "intrinsic instruction cannot be vectorized");
3810           DEBUG(dbgs() << "LV: Found unvectorizable intrinsic " << *CI << "\n");
3811           return false;
3812         }
3813       }
3814
3815       // Check that the instruction return type is vectorizable.
3816       // Also, we can't vectorize extractelement instructions.
3817       if ((!VectorType::isValidElementType(it->getType()) &&
3818            !it->getType()->isVoidTy()) || isa<ExtractElementInst>(it)) {
3819         emitAnalysis(Report(it)
3820                      << "instruction return type cannot be vectorized");
3821         DEBUG(dbgs() << "LV: Found unvectorizable type.\n");
3822         return false;
3823       }
3824
3825       // Check that the stored type is vectorizable.
3826       if (StoreInst *ST = dyn_cast<StoreInst>(it)) {
3827         Type *T = ST->getValueOperand()->getType();
3828         if (!VectorType::isValidElementType(T)) {
3829           emitAnalysis(Report(ST) << "store instruction cannot be vectorized");
3830           return false;
3831         }
3832         if (EnableMemAccessVersioning)
3833           collectStridedAccess(ST);
3834       }
3835
3836       if (EnableMemAccessVersioning)
3837         if (LoadInst *LI = dyn_cast<LoadInst>(it))
3838           collectStridedAccess(LI);
3839
3840       // Reduction instructions are allowed to have exit users.
3841       // All other instructions must not have external users.
3842       if (hasOutsideLoopUser(TheLoop, it, AllowedExit)) {
3843         emitAnalysis(Report(it) << "value cannot be used outside the loop");
3844         return false;
3845       }
3846
3847     } // next instr.
3848
3849   }
3850
3851   if (!Induction) {
3852     DEBUG(dbgs() << "LV: Did not find one integer induction var.\n");
3853     if (Inductions.empty()) {
3854       emitAnalysis(Report()
3855                    << "loop induction variable could not be identified");
3856       return false;
3857     }
3858   }
3859
3860   return true;
3861 }
3862
3863 ///\brief Remove GEPs whose indices but the last one are loop invariant and
3864 /// return the induction operand of the gep pointer.
3865 static Value *stripGetElementPtr(Value *Ptr, ScalarEvolution *SE,
3866                                  const DataLayout *DL, Loop *Lp) {
3867   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr);
3868   if (!GEP)
3869     return Ptr;
3870
3871   unsigned InductionOperand = getGEPInductionOperand(DL, GEP);
3872
3873   // Check that all of the gep indices are uniform except for our induction
3874   // operand.
3875   for (unsigned i = 0, e = GEP->getNumOperands(); i != e; ++i)
3876     if (i != InductionOperand &&
3877         !SE->isLoopInvariant(SE->getSCEV(GEP->getOperand(i)), Lp))
3878       return Ptr;
3879   return GEP->getOperand(InductionOperand);
3880 }
3881
3882 ///\brief Look for a cast use of the passed value.
3883 static Value *getUniqueCastUse(Value *Ptr, Loop *Lp, Type *Ty) {
3884   Value *UniqueCast = nullptr;
3885   for (User *U : Ptr->users()) {
3886     CastInst *CI = dyn_cast<CastInst>(U);
3887     if (CI && CI->getType() == Ty) {
3888       if (!UniqueCast)
3889         UniqueCast = CI;
3890       else
3891         return nullptr;
3892     }
3893   }
3894   return UniqueCast;
3895 }
3896
3897 ///\brief Get the stride of a pointer access in a loop.
3898 /// Looks for symbolic strides "a[i*stride]". Returns the symbolic stride as a
3899 /// pointer to the Value, or null otherwise.
3900 static Value *getStrideFromPointer(Value *Ptr, ScalarEvolution *SE,
3901                                    const DataLayout *DL, Loop *Lp) {
3902   const PointerType *PtrTy = dyn_cast<PointerType>(Ptr->getType());
3903   if (!PtrTy || PtrTy->isAggregateType())
3904     return nullptr;
3905
3906   // Try to remove a gep instruction to make the pointer (actually index at this
3907   // point) easier analyzable. If OrigPtr is equal to Ptr we are analzying the
3908   // pointer, otherwise, we are analyzing the index.
3909   Value *OrigPtr = Ptr;
3910
3911   // The size of the pointer access.
3912   int64_t PtrAccessSize = 1;
3913
3914   Ptr = stripGetElementPtr(Ptr, SE, DL, Lp);
3915   const SCEV *V = SE->getSCEV(Ptr);
3916
3917   if (Ptr != OrigPtr)
3918     // Strip off casts.
3919     while (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(V))
3920       V = C->getOperand();
3921
3922   const SCEVAddRecExpr *S = dyn_cast<SCEVAddRecExpr>(V);
3923   if (!S)
3924     return nullptr;
3925
3926   V = S->getStepRecurrence(*SE);
3927   if (!V)
3928     return nullptr;
3929
3930   // Strip off the size of access multiplication if we are still analyzing the
3931   // pointer.
3932   if (OrigPtr == Ptr) {
3933     DL->getTypeAllocSize(PtrTy->getElementType());
3934     if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(V)) {
3935       if (M->getOperand(0)->getSCEVType() != scConstant)
3936         return nullptr;
3937
3938       const APInt &APStepVal =
3939           cast<SCEVConstant>(M->getOperand(0))->getValue()->getValue();
3940
3941       // Huge step value - give up.
3942       if (APStepVal.getBitWidth() > 64)
3943         return nullptr;
3944
3945       int64_t StepVal = APStepVal.getSExtValue();
3946       if (PtrAccessSize != StepVal)
3947         return nullptr;
3948       V = M->getOperand(1);
3949     }
3950   }
3951
3952   // Strip off casts.
3953   Type *StripedOffRecurrenceCast = nullptr;
3954   if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(V)) {
3955     StripedOffRecurrenceCast = C->getType();
3956     V = C->getOperand();
3957   }
3958
3959   // Look for the loop invariant symbolic value.
3960   const SCEVUnknown *U = dyn_cast<SCEVUnknown>(V);
3961   if (!U)
3962     return nullptr;
3963
3964   Value *Stride = U->getValue();
3965   if (!Lp->isLoopInvariant(Stride))
3966     return nullptr;
3967
3968   // If we have stripped off the recurrence cast we have to make sure that we
3969   // return the value that is used in this loop so that we can replace it later.
3970   if (StripedOffRecurrenceCast)
3971     Stride = getUniqueCastUse(Stride, Lp, StripedOffRecurrenceCast);
3972
3973   return Stride;
3974 }
3975
3976 void LoopVectorizationLegality::collectStridedAccess(Value *MemAccess) {
3977   Value *Ptr = nullptr;
3978   if (LoadInst *LI = dyn_cast<LoadInst>(MemAccess))
3979     Ptr = LI->getPointerOperand();
3980   else if (StoreInst *SI = dyn_cast<StoreInst>(MemAccess))
3981     Ptr = SI->getPointerOperand();
3982   else
3983     return;
3984
3985   Value *Stride = getStrideFromPointer(Ptr, SE, DL, TheLoop);
3986   if (!Stride)
3987     return;
3988
3989   DEBUG(dbgs() << "LV: Found a strided access that we can version");
3990   DEBUG(dbgs() << "  Ptr: " << *Ptr << " Stride: " << *Stride << "\n");
3991   Strides[Ptr] = Stride;
3992   StrideSet.insert(Stride);
3993 }
3994
3995 void LoopVectorizationLegality::collectLoopUniforms() {
3996   // We now know that the loop is vectorizable!
3997   // Collect variables that will remain uniform after vectorization.
3998   std::vector<Value*> Worklist;
3999   BasicBlock *Latch = TheLoop->getLoopLatch();
4000
4001   // Start with the conditional branch and walk up the block.
4002   Worklist.push_back(Latch->getTerminator()->getOperand(0));
4003
4004   // Also add all consecutive pointer values; these values will be uniform
4005   // after vectorization (and subsequent cleanup) and, until revectorization is
4006   // supported, all dependencies must also be uniform.
4007   for (Loop::block_iterator B = TheLoop->block_begin(),
4008        BE = TheLoop->block_end(); B != BE; ++B)
4009     for (BasicBlock::iterator I = (*B)->begin(), IE = (*B)->end();
4010          I != IE; ++I)
4011       if (I->getType()->isPointerTy() && isConsecutivePtr(I))
4012         Worklist.insert(Worklist.end(), I->op_begin(), I->op_end());
4013
4014   while (!Worklist.empty()) {
4015     Instruction *I = dyn_cast<Instruction>(Worklist.back());
4016     Worklist.pop_back();
4017
4018     // Look at instructions inside this loop.
4019     // Stop when reaching PHI nodes.
4020     // TODO: we need to follow values all over the loop, not only in this block.
4021     if (!I || !TheLoop->contains(I) || isa<PHINode>(I))
4022       continue;
4023
4024     // This is a known uniform.
4025     Uniforms.insert(I);
4026
4027     // Insert all operands.
4028     Worklist.insert(Worklist.end(), I->op_begin(), I->op_end());
4029   }
4030 }
4031
4032 namespace {
4033 /// \brief Analyses memory accesses in a loop.
4034 ///
4035 /// Checks whether run time pointer checks are needed and builds sets for data
4036 /// dependence checking.
4037 class AccessAnalysis {
4038 public:
4039   /// \brief Read or write access location.
4040   typedef PointerIntPair<Value *, 1, bool> MemAccessInfo;
4041   typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet;
4042
4043   /// \brief Set of potential dependent memory accesses.
4044   typedef EquivalenceClasses<MemAccessInfo> DepCandidates;
4045
4046   AccessAnalysis(const DataLayout *Dl, AliasAnalysis *AA, DepCandidates &DA) :
4047     DL(Dl), AST(*AA), DepCands(DA), IsRTCheckNeeded(false) {}
4048
4049   /// \brief Register a load  and whether it is only read from.
4050   void addLoad(AliasAnalysis::Location &Loc, bool IsReadOnly) {
4051     Value *Ptr = const_cast<Value*>(Loc.Ptr);
4052     AST.add(Ptr, AliasAnalysis::UnknownSize, Loc.AATags);
4053     Accesses.insert(MemAccessInfo(Ptr, false));
4054     if (IsReadOnly)
4055       ReadOnlyPtr.insert(Ptr);
4056   }
4057
4058   /// \brief Register a store.
4059   void addStore(AliasAnalysis::Location &Loc) {
4060     Value *Ptr = const_cast<Value*>(Loc.Ptr);
4061     AST.add(Ptr, AliasAnalysis::UnknownSize, Loc.AATags);
4062     Accesses.insert(MemAccessInfo(Ptr, true));
4063   }
4064
4065   /// \brief Check whether we can check the pointers at runtime for
4066   /// non-intersection.
4067   bool canCheckPtrAtRT(LoopVectorizationLegality::RuntimePointerCheck &RtCheck,
4068                        unsigned &NumComparisons, ScalarEvolution *SE,
4069                        Loop *TheLoop, ValueToValueMap &Strides,
4070                        bool ShouldCheckStride = false);
4071
4072   /// \brief Goes over all memory accesses, checks whether a RT check is needed
4073   /// and builds sets of dependent accesses.
4074   void buildDependenceSets() {
4075     processMemAccesses();
4076   }
4077
4078   bool isRTCheckNeeded() { return IsRTCheckNeeded; }
4079
4080   bool isDependencyCheckNeeded() { return !CheckDeps.empty(); }
4081   void resetDepChecks() { CheckDeps.clear(); }
4082
4083   MemAccessInfoSet &getDependenciesToCheck() { return CheckDeps; }
4084
4085 private:
4086   typedef SetVector<MemAccessInfo> PtrAccessSet;
4087
4088   /// \brief Go over all memory access and check whether runtime pointer checks
4089   /// are needed /// and build sets of dependency check candidates.
4090   void processMemAccesses();
4091
4092   /// Set of all accesses.
4093   PtrAccessSet Accesses;
4094
4095   /// Set of accesses that need a further dependence check.
4096   MemAccessInfoSet CheckDeps;
4097
4098   /// Set of pointers that are read only.
4099   SmallPtrSet<Value*, 16> ReadOnlyPtr;
4100
4101   const DataLayout *DL;
4102
4103   /// An alias set tracker to partition the access set by underlying object and
4104   //intrinsic property (such as TBAA metadata).
4105   AliasSetTracker AST;
4106
4107   /// Sets of potentially dependent accesses - members of one set share an
4108   /// underlying pointer. The set "CheckDeps" identfies which sets really need a
4109   /// dependence check.
4110   DepCandidates &DepCands;
4111
4112   bool IsRTCheckNeeded;
4113 };
4114
4115 } // end anonymous namespace
4116
4117 /// \brief Check whether a pointer can participate in a runtime bounds check.
4118 static bool hasComputableBounds(ScalarEvolution *SE, ValueToValueMap &Strides,
4119                                 Value *Ptr) {
4120   const SCEV *PtrScev = replaceSymbolicStrideSCEV(SE, Strides, Ptr);
4121   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
4122   if (!AR)
4123     return false;
4124
4125   return AR->isAffine();
4126 }
4127
4128 /// \brief Check the stride of the pointer and ensure that it does not wrap in
4129 /// the address space.
4130 static int isStridedPtr(ScalarEvolution *SE, const DataLayout *DL, Value *Ptr,
4131                         const Loop *Lp, ValueToValueMap &StridesMap);
4132
4133 bool AccessAnalysis::canCheckPtrAtRT(
4134     LoopVectorizationLegality::RuntimePointerCheck &RtCheck,
4135     unsigned &NumComparisons, ScalarEvolution *SE, Loop *TheLoop,
4136     ValueToValueMap &StridesMap, bool ShouldCheckStride) {
4137   // Find pointers with computable bounds. We are going to use this information
4138   // to place a runtime bound check.
4139   bool CanDoRT = true;
4140
4141   bool IsDepCheckNeeded = isDependencyCheckNeeded();
4142   NumComparisons = 0;
4143
4144   // We assign a consecutive id to access from different alias sets.
4145   // Accesses between different groups doesn't need to be checked.
4146   unsigned ASId = 1;
4147   for (auto &AS : AST) {
4148     unsigned NumReadPtrChecks = 0;
4149     unsigned NumWritePtrChecks = 0;
4150
4151     // We assign consecutive id to access from different dependence sets.
4152     // Accesses within the same set don't need a runtime check.
4153     unsigned RunningDepId = 1;
4154     DenseMap<Value *, unsigned> DepSetId;
4155
4156     for (auto A : AS) {
4157       Value *Ptr = A.getValue();
4158       bool IsWrite = Accesses.count(MemAccessInfo(Ptr, true));
4159       MemAccessInfo Access(Ptr, IsWrite);
4160
4161       if (IsWrite)
4162         ++NumWritePtrChecks;
4163       else
4164         ++NumReadPtrChecks;
4165
4166       if (hasComputableBounds(SE, StridesMap, Ptr) &&
4167           // When we run after a failing dependency check we have to make sure we
4168           // don't have wrapping pointers.
4169           (!ShouldCheckStride ||
4170            isStridedPtr(SE, DL, Ptr, TheLoop, StridesMap) == 1)) {
4171         // The id of the dependence set.
4172         unsigned DepId;
4173
4174         if (IsDepCheckNeeded) {
4175           Value *Leader = DepCands.getLeaderValue(Access).getPointer();
4176           unsigned &LeaderId = DepSetId[Leader];
4177           if (!LeaderId)
4178             LeaderId = RunningDepId++;
4179           DepId = LeaderId;
4180         } else
4181           // Each access has its own dependence set.
4182           DepId = RunningDepId++;
4183
4184         RtCheck.insert(SE, TheLoop, Ptr, IsWrite, DepId, ASId, StridesMap);
4185
4186         DEBUG(dbgs() << "LV: Found a runtime check ptr:" << *Ptr << '\n');
4187       } else {
4188         CanDoRT = false;
4189       }
4190     }
4191
4192     if (IsDepCheckNeeded && CanDoRT && RunningDepId == 2)
4193       NumComparisons += 0; // Only one dependence set.
4194     else {
4195       NumComparisons += (NumWritePtrChecks * (NumReadPtrChecks +
4196                                               NumWritePtrChecks - 1));
4197     }
4198
4199     ++ASId;
4200   }
4201
4202   // If the pointers that we would use for the bounds comparison have different
4203   // address spaces, assume the values aren't directly comparable, so we can't
4204   // use them for the runtime check. We also have to assume they could
4205   // overlap. In the future there should be metadata for whether address spaces
4206   // are disjoint.
4207   unsigned NumPointers = RtCheck.Pointers.size();
4208   for (unsigned i = 0; i < NumPointers; ++i) {
4209     for (unsigned j = i + 1; j < NumPointers; ++j) {
4210       // Only need to check pointers between two different dependency sets.
4211       if (RtCheck.DependencySetId[i] == RtCheck.DependencySetId[j])
4212        continue;
4213       // Only need to check pointers in the same alias set.
4214       if (RtCheck.AliasSetId[i] != RtCheck.AliasSetId[j])
4215         continue;
4216
4217       Value *PtrI = RtCheck.Pointers[i];
4218       Value *PtrJ = RtCheck.Pointers[j];
4219
4220       unsigned ASi = PtrI->getType()->getPointerAddressSpace();
4221       unsigned ASj = PtrJ->getType()->getPointerAddressSpace();
4222       if (ASi != ASj) {
4223         DEBUG(dbgs() << "LV: Runtime check would require comparison between"
4224                        " different address spaces\n");
4225         return false;
4226       }
4227     }
4228   }
4229
4230   return CanDoRT;
4231 }
4232
4233 void AccessAnalysis::processMemAccesses() {
4234   // We process the set twice: first we process read-write pointers, last we
4235   // process read-only pointers. This allows us to skip dependence tests for
4236   // read-only pointers.
4237
4238   DEBUG(dbgs() << "LV: Processing memory accesses...\n");
4239   DEBUG(dbgs() << "  AST: "; AST.dump());
4240   DEBUG(dbgs() << "LV:   Accesses:\n");
4241   DEBUG({
4242     for (auto A : Accesses)
4243       dbgs() << "\t" << *A.getPointer() << " (" <<
4244                 (A.getInt() ? "write" : (ReadOnlyPtr.count(A.getPointer()) ?
4245                                          "read-only" : "read")) << ")\n";
4246   });
4247
4248   // The AliasSetTracker has nicely partitioned our pointers by metadata
4249   // compatibility and potential for underlying-object overlap. As a result, we
4250   // only need to check for potential pointer dependencies within each alias
4251   // set.
4252   for (auto &AS : AST) {
4253     // Note that both the alias-set tracker and the alias sets themselves used
4254     // linked lists internally and so the iteration order here is deterministic
4255     // (matching the original instruction order within each set).
4256
4257     bool SetHasWrite = false;
4258
4259     // Map of pointers to last access encountered.
4260     typedef DenseMap<Value*, MemAccessInfo> UnderlyingObjToAccessMap;
4261     UnderlyingObjToAccessMap ObjToLastAccess;
4262
4263     // Set of access to check after all writes have been processed.
4264     PtrAccessSet DeferredAccesses;
4265
4266     // Iterate over each alias set twice, once to process read/write pointers,
4267     // and then to process read-only pointers.
4268     for (int SetIteration = 0; SetIteration < 2; ++SetIteration) {
4269       bool UseDeferred = SetIteration > 0;
4270       PtrAccessSet &S = UseDeferred ? DeferredAccesses : Accesses;
4271
4272       for (auto AV : AS) {
4273         Value *Ptr = AV.getValue();
4274
4275         // For a single memory access in AliasSetTracker, Accesses may contain
4276         // both read and write, and they both need to be handled for CheckDeps.
4277         for (auto AC : S) {
4278           if (AC.getPointer() != Ptr)
4279             continue;
4280
4281           bool IsWrite = AC.getInt();
4282
4283           // If we're using the deferred access set, then it contains only
4284           // reads.
4285           bool IsReadOnlyPtr = ReadOnlyPtr.count(Ptr) && !IsWrite;
4286           if (UseDeferred && !IsReadOnlyPtr)
4287             continue;
4288           // Otherwise, the pointer must be in the PtrAccessSet, either as a
4289           // read or a write.
4290           assert(((IsReadOnlyPtr && UseDeferred) || IsWrite ||
4291                   S.count(MemAccessInfo(Ptr, false))) &&
4292                  "Alias-set pointer not in the access set?");
4293
4294           MemAccessInfo Access(Ptr, IsWrite);
4295           DepCands.insert(Access);
4296
4297           // Memorize read-only pointers for later processing and skip them in
4298           // the first round (they need to be checked after we have seen all
4299           // write pointers). Note: we also mark pointer that are not
4300           // consecutive as "read-only" pointers (so that we check
4301           // "a[b[i]] +="). Hence, we need the second check for "!IsWrite".
4302           if (!UseDeferred && IsReadOnlyPtr) {
4303             DeferredAccesses.insert(Access);
4304             continue;
4305           }
4306
4307           // If this is a write - check other reads and writes for conflicts. If
4308           // this is a read only check other writes for conflicts (but only if
4309           // there is no other write to the ptr - this is an optimization to
4310           // catch "a[i] = a[i] + " without having to do a dependence check).
4311           if ((IsWrite || IsReadOnlyPtr) && SetHasWrite) {
4312             CheckDeps.insert(Access);
4313             IsRTCheckNeeded = true;
4314           }
4315
4316           if (IsWrite)
4317             SetHasWrite = true;
4318
4319           // Create sets of pointers connected by a shared alias set and
4320           // underlying object.
4321           typedef SmallVector<Value *, 16> ValueVector;
4322           ValueVector TempObjects;
4323           GetUnderlyingObjects(Ptr, TempObjects, DL);
4324           for (Value *UnderlyingObj : TempObjects) {
4325             UnderlyingObjToAccessMap::iterator Prev =
4326                 ObjToLastAccess.find(UnderlyingObj);
4327             if (Prev != ObjToLastAccess.end())
4328               DepCands.unionSets(Access, Prev->second);
4329
4330             ObjToLastAccess[UnderlyingObj] = Access;
4331           }
4332         }
4333       }
4334     }
4335   }
4336 }
4337
4338 namespace {
4339 /// \brief Checks memory dependences among accesses to the same underlying
4340 /// object to determine whether there vectorization is legal or not (and at
4341 /// which vectorization factor).
4342 ///
4343 /// This class works under the assumption that we already checked that memory
4344 /// locations with different underlying pointers are "must-not alias".
4345 /// We use the ScalarEvolution framework to symbolically evalutate access
4346 /// functions pairs. Since we currently don't restructure the loop we can rely
4347 /// on the program order of memory accesses to determine their safety.
4348 /// At the moment we will only deem accesses as safe for:
4349 ///  * A negative constant distance assuming program order.
4350 ///
4351 ///      Safe: tmp = a[i + 1];     OR     a[i + 1] = x;
4352 ///            a[i] = tmp;                y = a[i];
4353 ///
4354 ///   The latter case is safe because later checks guarantuee that there can't
4355 ///   be a cycle through a phi node (that is, we check that "x" and "y" is not
4356 ///   the same variable: a header phi can only be an induction or a reduction, a
4357 ///   reduction can't have a memory sink, an induction can't have a memory
4358 ///   source). This is important and must not be violated (or we have to
4359 ///   resort to checking for cycles through memory).
4360 ///
4361 ///  * A positive constant distance assuming program order that is bigger
4362 ///    than the biggest memory access.
4363 ///
4364 ///     tmp = a[i]        OR              b[i] = x
4365 ///     a[i+2] = tmp                      y = b[i+2];
4366 ///
4367 ///     Safe distance: 2 x sizeof(a[0]), and 2 x sizeof(b[0]), respectively.
4368 ///
4369 ///  * Zero distances and all accesses have the same size.
4370 ///
4371 class MemoryDepChecker {
4372 public:
4373   typedef PointerIntPair<Value *, 1, bool> MemAccessInfo;
4374   typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet;
4375
4376   MemoryDepChecker(ScalarEvolution *Se, const DataLayout *Dl, const Loop *L)
4377       : SE(Se), DL(Dl), InnermostLoop(L), AccessIdx(0),
4378         ShouldRetryWithRuntimeCheck(false) {}
4379
4380   /// \brief Register the location (instructions are given increasing numbers)
4381   /// of a write access.
4382   void addAccess(StoreInst *SI) {
4383     Value *Ptr = SI->getPointerOperand();
4384     Accesses[MemAccessInfo(Ptr, true)].push_back(AccessIdx);
4385     InstMap.push_back(SI);
4386     ++AccessIdx;
4387   }
4388
4389   /// \brief Register the location (instructions are given increasing numbers)
4390   /// of a write access.
4391   void addAccess(LoadInst *LI) {
4392     Value *Ptr = LI->getPointerOperand();
4393     Accesses[MemAccessInfo(Ptr, false)].push_back(AccessIdx);
4394     InstMap.push_back(LI);
4395     ++AccessIdx;
4396   }
4397
4398   /// \brief Check whether the dependencies between the accesses are safe.
4399   ///
4400   /// Only checks sets with elements in \p CheckDeps.
4401   bool areDepsSafe(AccessAnalysis::DepCandidates &AccessSets,
4402                    MemAccessInfoSet &CheckDeps, ValueToValueMap &Strides);
4403
4404   /// \brief The maximum number of bytes of a vector register we can vectorize
4405   /// the accesses safely with.
4406   unsigned getMaxSafeDepDistBytes() { return MaxSafeDepDistBytes; }
4407
4408   /// \brief In same cases when the dependency check fails we can still
4409   /// vectorize the loop with a dynamic array access check.
4410   bool shouldRetryWithRuntimeCheck() { return ShouldRetryWithRuntimeCheck; }
4411
4412 private:
4413   ScalarEvolution *SE;
4414   const DataLayout *DL;
4415   const Loop *InnermostLoop;
4416
4417   /// \brief Maps access locations (ptr, read/write) to program order.
4418   DenseMap<MemAccessInfo, std::vector<unsigned> > Accesses;
4419
4420   /// \brief Memory access instructions in program order.
4421   SmallVector<Instruction *, 16> InstMap;
4422
4423   /// \brief The program order index to be used for the next instruction.
4424   unsigned AccessIdx;
4425
4426   // We can access this many bytes in parallel safely.
4427   unsigned MaxSafeDepDistBytes;
4428
4429   /// \brief If we see a non-constant dependence distance we can still try to
4430   /// vectorize this loop with runtime checks.
4431   bool ShouldRetryWithRuntimeCheck;
4432
4433   /// \brief Check whether there is a plausible dependence between the two
4434   /// accesses.
4435   ///
4436   /// Access \p A must happen before \p B in program order. The two indices
4437   /// identify the index into the program order map.
4438   ///
4439   /// This function checks  whether there is a plausible dependence (or the
4440   /// absence of such can't be proved) between the two accesses. If there is a
4441   /// plausible dependence but the dependence distance is bigger than one
4442   /// element access it records this distance in \p MaxSafeDepDistBytes (if this
4443   /// distance is smaller than any other distance encountered so far).
4444   /// Otherwise, this function returns true signaling a possible dependence.
4445   bool isDependent(const MemAccessInfo &A, unsigned AIdx,
4446                    const MemAccessInfo &B, unsigned BIdx,
4447                    ValueToValueMap &Strides);
4448
4449   /// \brief Check whether the data dependence could prevent store-load
4450   /// forwarding.
4451   bool couldPreventStoreLoadForward(unsigned Distance, unsigned TypeByteSize);
4452 };
4453
4454 } // end anonymous namespace
4455
4456 static bool isInBoundsGep(Value *Ptr) {
4457   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr))
4458     return GEP->isInBounds();
4459   return false;
4460 }
4461
4462 /// \brief Check whether the access through \p Ptr has a constant stride.
4463 static int isStridedPtr(ScalarEvolution *SE, const DataLayout *DL, Value *Ptr,
4464                         const Loop *Lp, ValueToValueMap &StridesMap) {
4465   const Type *Ty = Ptr->getType();
4466   assert(Ty->isPointerTy() && "Unexpected non-ptr");
4467
4468   // Make sure that the pointer does not point to aggregate types.
4469   const PointerType *PtrTy = cast<PointerType>(Ty);
4470   if (PtrTy->getElementType()->isAggregateType()) {
4471     DEBUG(dbgs() << "LV: Bad stride - Not a pointer to a scalar type" << *Ptr <<
4472           "\n");
4473     return 0;
4474   }
4475
4476   const SCEV *PtrScev = replaceSymbolicStrideSCEV(SE, StridesMap, Ptr);
4477
4478   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
4479   if (!AR) {
4480     DEBUG(dbgs() << "LV: Bad stride - Not an AddRecExpr pointer "
4481           << *Ptr << " SCEV: " << *PtrScev << "\n");
4482     return 0;
4483   }
4484
4485   // The accesss function must stride over the innermost loop.
4486   if (Lp != AR->getLoop()) {
4487     DEBUG(dbgs() << "LV: Bad stride - Not striding over innermost loop " <<
4488           *Ptr << " SCEV: " << *PtrScev << "\n");
4489   }
4490
4491   // The address calculation must not wrap. Otherwise, a dependence could be
4492   // inverted.
4493   // An inbounds getelementptr that is a AddRec with a unit stride
4494   // cannot wrap per definition. The unit stride requirement is checked later.
4495   // An getelementptr without an inbounds attribute and unit stride would have
4496   // to access the pointer value "0" which is undefined behavior in address
4497   // space 0, therefore we can also vectorize this case.
4498   bool IsInBoundsGEP = isInBoundsGep(Ptr);
4499   bool IsNoWrapAddRec = AR->getNoWrapFlags(SCEV::NoWrapMask);
4500   bool IsInAddressSpaceZero = PtrTy->getAddressSpace() == 0;
4501   if (!IsNoWrapAddRec && !IsInBoundsGEP && !IsInAddressSpaceZero) {
4502     DEBUG(dbgs() << "LV: Bad stride - Pointer may wrap in the address space "
4503           << *Ptr << " SCEV: " << *PtrScev << "\n");
4504     return 0;
4505   }
4506
4507   // Check the step is constant.
4508   const SCEV *Step = AR->getStepRecurrence(*SE);
4509
4510   // Calculate the pointer stride and check if it is consecutive.
4511   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
4512   if (!C) {
4513     DEBUG(dbgs() << "LV: Bad stride - Not a constant strided " << *Ptr <<
4514           " SCEV: " << *PtrScev << "\n");
4515     return 0;
4516   }
4517
4518   int64_t Size = DL->getTypeAllocSize(PtrTy->getElementType());
4519   const APInt &APStepVal = C->getValue()->getValue();
4520
4521   // Huge step value - give up.
4522   if (APStepVal.getBitWidth() > 64)
4523     return 0;
4524
4525   int64_t StepVal = APStepVal.getSExtValue();
4526
4527   // Strided access.
4528   int64_t Stride = StepVal / Size;
4529   int64_t Rem = StepVal % Size;
4530   if (Rem)
4531     return 0;
4532
4533   // If the SCEV could wrap but we have an inbounds gep with a unit stride we
4534   // know we can't "wrap around the address space". In case of address space
4535   // zero we know that this won't happen without triggering undefined behavior.
4536   if (!IsNoWrapAddRec && (IsInBoundsGEP || IsInAddressSpaceZero) &&
4537       Stride != 1 && Stride != -1)
4538     return 0;
4539
4540   return Stride;
4541 }
4542
4543 bool MemoryDepChecker::couldPreventStoreLoadForward(unsigned Distance,
4544                                                     unsigned TypeByteSize) {
4545   // If loads occur at a distance that is not a multiple of a feasible vector
4546   // factor store-load forwarding does not take place.
4547   // Positive dependences might cause troubles because vectorizing them might
4548   // prevent store-load forwarding making vectorized code run a lot slower.
4549   //   a[i] = a[i-3] ^ a[i-8];
4550   //   The stores to a[i:i+1] don't align with the stores to a[i-3:i-2] and
4551   //   hence on your typical architecture store-load forwarding does not take
4552   //   place. Vectorizing in such cases does not make sense.
4553   // Store-load forwarding distance.
4554   const unsigned NumCyclesForStoreLoadThroughMemory = 8*TypeByteSize;
4555   // Maximum vector factor.
4556   unsigned MaxVFWithoutSLForwardIssues = MaxVectorWidth*TypeByteSize;
4557   if(MaxSafeDepDistBytes < MaxVFWithoutSLForwardIssues)
4558     MaxVFWithoutSLForwardIssues = MaxSafeDepDistBytes;
4559
4560   for (unsigned vf = 2*TypeByteSize; vf <= MaxVFWithoutSLForwardIssues;
4561        vf *= 2) {
4562     if (Distance % vf && Distance / vf < NumCyclesForStoreLoadThroughMemory) {
4563       MaxVFWithoutSLForwardIssues = (vf >>=1);
4564       break;
4565     }
4566   }
4567
4568   if (MaxVFWithoutSLForwardIssues< 2*TypeByteSize) {
4569     DEBUG(dbgs() << "LV: Distance " << Distance <<
4570           " that could cause a store-load forwarding conflict\n");
4571     return true;
4572   }
4573
4574   if (MaxVFWithoutSLForwardIssues < MaxSafeDepDistBytes &&
4575       MaxVFWithoutSLForwardIssues != MaxVectorWidth*TypeByteSize)
4576     MaxSafeDepDistBytes = MaxVFWithoutSLForwardIssues;
4577   return false;
4578 }
4579
4580 bool MemoryDepChecker::isDependent(const MemAccessInfo &A, unsigned AIdx,
4581                                    const MemAccessInfo &B, unsigned BIdx,
4582                                    ValueToValueMap &Strides) {
4583   assert (AIdx < BIdx && "Must pass arguments in program order");
4584
4585   Value *APtr = A.getPointer();
4586   Value *BPtr = B.getPointer();
4587   bool AIsWrite = A.getInt();
4588   bool BIsWrite = B.getInt();
4589
4590   // Two reads are independent.
4591   if (!AIsWrite && !BIsWrite)
4592     return false;
4593
4594   // We cannot check pointers in different address spaces.
4595   if (APtr->getType()->getPointerAddressSpace() !=
4596       BPtr->getType()->getPointerAddressSpace())
4597     return true;
4598
4599   const SCEV *AScev = replaceSymbolicStrideSCEV(SE, Strides, APtr);
4600   const SCEV *BScev = replaceSymbolicStrideSCEV(SE, Strides, BPtr);
4601
4602   int StrideAPtr = isStridedPtr(SE, DL, APtr, InnermostLoop, Strides);
4603   int StrideBPtr = isStridedPtr(SE, DL, BPtr, InnermostLoop, Strides);
4604
4605   const SCEV *Src = AScev;
4606   const SCEV *Sink = BScev;
4607
4608   // If the induction step is negative we have to invert source and sink of the
4609   // dependence.
4610   if (StrideAPtr < 0) {
4611     //Src = BScev;
4612     //Sink = AScev;
4613     std::swap(APtr, BPtr);
4614     std::swap(Src, Sink);
4615     std::swap(AIsWrite, BIsWrite);
4616     std::swap(AIdx, BIdx);
4617     std::swap(StrideAPtr, StrideBPtr);
4618   }
4619
4620   const SCEV *Dist = SE->getMinusSCEV(Sink, Src);
4621
4622   DEBUG(dbgs() << "LV: Src Scev: " << *Src << "Sink Scev: " << *Sink
4623         << "(Induction step: " << StrideAPtr <<  ")\n");
4624   DEBUG(dbgs() << "LV: Distance for " << *InstMap[AIdx] << " to "
4625         << *InstMap[BIdx] << ": " << *Dist << "\n");
4626
4627   // Need consecutive accesses. We don't want to vectorize
4628   // "A[B[i]] += ..." and similar code or pointer arithmetic that could wrap in
4629   // the address space.
4630   if (!StrideAPtr || !StrideBPtr || StrideAPtr != StrideBPtr){
4631     DEBUG(dbgs() << "Non-consecutive pointer access\n");
4632     return true;
4633   }
4634
4635   const SCEVConstant *C = dyn_cast<SCEVConstant>(Dist);
4636   if (!C) {
4637     DEBUG(dbgs() << "LV: Dependence because of non-constant distance\n");
4638     ShouldRetryWithRuntimeCheck = true;
4639     return true;
4640   }
4641
4642   Type *ATy = APtr->getType()->getPointerElementType();
4643   Type *BTy = BPtr->getType()->getPointerElementType();
4644   unsigned TypeByteSize = DL->getTypeAllocSize(ATy);
4645
4646   // Negative distances are not plausible dependencies.
4647   const APInt &Val = C->getValue()->getValue();
4648   if (Val.isNegative()) {
4649     bool IsTrueDataDependence = (AIsWrite && !BIsWrite);
4650     if (IsTrueDataDependence &&
4651         (couldPreventStoreLoadForward(Val.abs().getZExtValue(), TypeByteSize) ||
4652          ATy != BTy))
4653       return true;
4654
4655     DEBUG(dbgs() << "LV: Dependence is negative: NoDep\n");
4656     return false;
4657   }
4658
4659   // Write to the same location with the same size.
4660   // Could be improved to assert type sizes are the same (i32 == float, etc).
4661   if (Val == 0) {
4662     if (ATy == BTy)
4663       return false;
4664     DEBUG(dbgs() << "LV: Zero dependence difference but different types\n");
4665     return true;
4666   }
4667
4668   assert(Val.isStrictlyPositive() && "Expect a positive value");
4669
4670   // Positive distance bigger than max vectorization factor.
4671   if (ATy != BTy) {
4672     DEBUG(dbgs() <<
4673           "LV: ReadWrite-Write positive dependency with different types\n");
4674     return false;
4675   }
4676
4677   unsigned Distance = (unsigned) Val.getZExtValue();
4678
4679   // Bail out early if passed-in parameters make vectorization not feasible.
4680   unsigned ForcedFactor = VectorizationFactor ? VectorizationFactor : 1;
4681   unsigned ForcedUnroll = VectorizationInterleave ? VectorizationInterleave : 1;
4682
4683   // The distance must be bigger than the size needed for a vectorized version
4684   // of the operation and the size of the vectorized operation must not be
4685   // bigger than the currrent maximum size.
4686   if (Distance < 2*TypeByteSize ||
4687       2*TypeByteSize > MaxSafeDepDistBytes ||
4688       Distance < TypeByteSize * ForcedUnroll * ForcedFactor) {
4689     DEBUG(dbgs() << "LV: Failure because of Positive distance "
4690         << Val.getSExtValue() << '\n');
4691     return true;
4692   }
4693
4694   MaxSafeDepDistBytes = Distance < MaxSafeDepDistBytes ?
4695     Distance : MaxSafeDepDistBytes;
4696
4697   bool IsTrueDataDependence = (!AIsWrite && BIsWrite);
4698   if (IsTrueDataDependence &&
4699       couldPreventStoreLoadForward(Distance, TypeByteSize))
4700      return true;
4701
4702   DEBUG(dbgs() << "LV: Positive distance " << Val.getSExtValue() <<
4703         " with max VF = " << MaxSafeDepDistBytes / TypeByteSize << '\n');
4704
4705   return false;
4706 }
4707
4708 bool MemoryDepChecker::areDepsSafe(AccessAnalysis::DepCandidates &AccessSets,
4709                                    MemAccessInfoSet &CheckDeps,
4710                                    ValueToValueMap &Strides) {
4711
4712   MaxSafeDepDistBytes = -1U;
4713   while (!CheckDeps.empty()) {
4714     MemAccessInfo CurAccess = *CheckDeps.begin();
4715
4716     // Get the relevant memory access set.
4717     EquivalenceClasses<MemAccessInfo>::iterator I =
4718       AccessSets.findValue(AccessSets.getLeaderValue(CurAccess));
4719
4720     // Check accesses within this set.
4721     EquivalenceClasses<MemAccessInfo>::member_iterator AI, AE;
4722     AI = AccessSets.member_begin(I), AE = AccessSets.member_end();
4723
4724     // Check every access pair.
4725     while (AI != AE) {
4726       CheckDeps.erase(*AI);
4727       EquivalenceClasses<MemAccessInfo>::member_iterator OI = std::next(AI);
4728       while (OI != AE) {
4729         // Check every accessing instruction pair in program order.
4730         for (std::vector<unsigned>::iterator I1 = Accesses[*AI].begin(),
4731              I1E = Accesses[*AI].end(); I1 != I1E; ++I1)
4732           for (std::vector<unsigned>::iterator I2 = Accesses[*OI].begin(),
4733                I2E = Accesses[*OI].end(); I2 != I2E; ++I2) {
4734             if (*I1 < *I2 && isDependent(*AI, *I1, *OI, *I2, Strides))
4735               return false;
4736             if (*I2 < *I1 && isDependent(*OI, *I2, *AI, *I1, Strides))
4737               return false;
4738           }
4739         ++OI;
4740       }
4741       AI++;
4742     }
4743   }
4744   return true;
4745 }
4746
4747 bool LoopVectorizationLegality::canVectorizeMemory() {
4748
4749   typedef SmallVector<Value*, 16> ValueVector;
4750   typedef SmallPtrSet<Value*, 16> ValueSet;
4751
4752   // Holds the Load and Store *instructions*.
4753   ValueVector Loads;
4754   ValueVector Stores;
4755
4756   // Holds all the different accesses in the loop.
4757   unsigned NumReads = 0;
4758   unsigned NumReadWrites = 0;
4759
4760   PtrRtCheck.Pointers.clear();
4761   PtrRtCheck.Need = false;
4762
4763   const bool IsAnnotatedParallel = TheLoop->isAnnotatedParallel();
4764   MemoryDepChecker DepChecker(SE, DL, TheLoop);
4765
4766   // For each block.
4767   for (Loop::block_iterator bb = TheLoop->block_begin(),
4768        be = TheLoop->block_end(); bb != be; ++bb) {
4769
4770     // Scan the BB and collect legal loads and stores.
4771     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
4772          ++it) {
4773
4774       // If this is a load, save it. If this instruction can read from memory
4775       // but is not a load, then we quit. Notice that we don't handle function
4776       // calls that read or write.
4777       if (it->mayReadFromMemory()) {
4778         // Many math library functions read the rounding mode. We will only
4779         // vectorize a loop if it contains known function calls that don't set
4780         // the flag. Therefore, it is safe to ignore this read from memory.
4781         CallInst *Call = dyn_cast<CallInst>(it);
4782         if (Call && getIntrinsicIDForCall(Call, TLI))
4783           continue;
4784
4785         LoadInst *Ld = dyn_cast<LoadInst>(it);
4786         if (!Ld || (!Ld->isSimple() && !IsAnnotatedParallel)) {
4787           emitAnalysis(Report(Ld)
4788                        << "read with atomic ordering or volatile read");
4789           DEBUG(dbgs() << "LV: Found a non-simple load.\n");
4790           return false;
4791         }
4792         NumLoads++;
4793         Loads.push_back(Ld);
4794         DepChecker.addAccess(Ld);
4795         continue;
4796       }
4797
4798       // Save 'store' instructions. Abort if other instructions write to memory.
4799       if (it->mayWriteToMemory()) {
4800         StoreInst *St = dyn_cast<StoreInst>(it);
4801         if (!St) {
4802           emitAnalysis(Report(it) << "instruction cannot be vectorized");
4803           return false;
4804         }
4805         if (!St->isSimple() && !IsAnnotatedParallel) {
4806           emitAnalysis(Report(St)
4807                        << "write with atomic ordering or volatile write");
4808           DEBUG(dbgs() << "LV: Found a non-simple store.\n");
4809           return false;
4810         }
4811         NumStores++;
4812         Stores.push_back(St);
4813         DepChecker.addAccess(St);
4814       }
4815     } // Next instr.
4816   } // Next block.
4817
4818   // Now we have two lists that hold the loads and the stores.
4819   // Next, we find the pointers that they use.
4820
4821   // Check if we see any stores. If there are no stores, then we don't
4822   // care if the pointers are *restrict*.
4823   if (!Stores.size()) {
4824     DEBUG(dbgs() << "LV: Found a read-only loop!\n");
4825     return true;
4826   }
4827
4828   AccessAnalysis::DepCandidates DependentAccesses;
4829   AccessAnalysis Accesses(DL, AA, DependentAccesses);
4830
4831   // Holds the analyzed pointers. We don't want to call GetUnderlyingObjects
4832   // multiple times on the same object. If the ptr is accessed twice, once
4833   // for read and once for write, it will only appear once (on the write
4834   // list). This is okay, since we are going to check for conflicts between
4835   // writes and between reads and writes, but not between reads and reads.
4836   ValueSet Seen;
4837
4838   ValueVector::iterator I, IE;
4839   for (I = Stores.begin(), IE = Stores.end(); I != IE; ++I) {
4840     StoreInst *ST = cast<StoreInst>(*I);
4841     Value* Ptr = ST->getPointerOperand();
4842
4843     if (isUniform(Ptr)) {
4844       emitAnalysis(
4845           Report(ST)
4846           << "write to a loop invariant address could not be vectorized");
4847       DEBUG(dbgs() << "LV: We don't allow storing to uniform addresses\n");
4848       return false;
4849     }
4850
4851     // If we did *not* see this pointer before, insert it to  the read-write
4852     // list. At this phase it is only a 'write' list.
4853     if (Seen.insert(Ptr).second) {
4854       ++NumReadWrites;
4855
4856       AliasAnalysis::Location Loc = AA->getLocation(ST);
4857       // The TBAA metadata could have a control dependency on the predication
4858       // condition, so we cannot rely on it when determining whether or not we
4859       // need runtime pointer checks.
4860       if (blockNeedsPredication(ST->getParent()))
4861         Loc.AATags.TBAA = nullptr;
4862
4863       Accesses.addStore(Loc);
4864     }
4865   }
4866
4867   if (IsAnnotatedParallel) {
4868     DEBUG(dbgs()
4869           << "LV: A loop annotated parallel, ignore memory dependency "
4870           << "checks.\n");
4871     return true;
4872   }
4873
4874   for (I = Loads.begin(), IE = Loads.end(); I != IE; ++I) {
4875     LoadInst *LD = cast<LoadInst>(*I);
4876     Value* Ptr = LD->getPointerOperand();
4877     // If we did *not* see this pointer before, insert it to the
4878     // read list. If we *did* see it before, then it is already in
4879     // the read-write list. This allows us to vectorize expressions
4880     // such as A[i] += x;  Because the address of A[i] is a read-write
4881     // pointer. This only works if the index of A[i] is consecutive.
4882     // If the address of i is unknown (for example A[B[i]]) then we may
4883     // read a few words, modify, and write a few words, and some of the
4884     // words may be written to the same address.
4885     bool IsReadOnlyPtr = false;
4886     if (Seen.insert(Ptr).second ||
4887         !isStridedPtr(SE, DL, Ptr, TheLoop, Strides)) {
4888       ++NumReads;
4889       IsReadOnlyPtr = true;
4890     }
4891
4892     AliasAnalysis::Location Loc = AA->getLocation(LD);
4893     // The TBAA metadata could have a control dependency on the predication
4894     // condition, so we cannot rely on it when determining whether or not we
4895     // need runtime pointer checks.
4896     if (blockNeedsPredication(LD->getParent()))
4897       Loc.AATags.TBAA = nullptr;
4898
4899     Accesses.addLoad(Loc, IsReadOnlyPtr);
4900   }
4901
4902   // If we write (or read-write) to a single destination and there are no
4903   // other reads in this loop then is it safe to vectorize.
4904   if (NumReadWrites == 1 && NumReads == 0) {
4905     DEBUG(dbgs() << "LV: Found a write-only loop!\n");
4906     return true;
4907   }
4908
4909   // Build dependence sets and check whether we need a runtime pointer bounds
4910   // check.
4911   Accesses.buildDependenceSets();
4912   bool NeedRTCheck = Accesses.isRTCheckNeeded();
4913
4914   // Find pointers with computable bounds. We are going to use this information
4915   // to place a runtime bound check.
4916   unsigned NumComparisons = 0;
4917   bool CanDoRT = false;
4918   if (NeedRTCheck)
4919     CanDoRT = Accesses.canCheckPtrAtRT(PtrRtCheck, NumComparisons, SE, TheLoop,
4920                                        Strides);
4921
4922   DEBUG(dbgs() << "LV: We need to do " << NumComparisons <<
4923         " pointer comparisons.\n");
4924
4925   // If we only have one set of dependences to check pointers among we don't
4926   // need a runtime check.
4927   if (NumComparisons == 0 && NeedRTCheck)
4928     NeedRTCheck = false;
4929
4930   // Check that we did not collect too many pointers or found an unsizeable
4931   // pointer.
4932   if (!CanDoRT || NumComparisons > RuntimeMemoryCheckThreshold) {
4933     PtrRtCheck.reset();
4934     CanDoRT = false;
4935   }
4936
4937   if (CanDoRT) {
4938     DEBUG(dbgs() << "LV: We can perform a memory runtime check if needed.\n");
4939   }
4940
4941   if (NeedRTCheck && !CanDoRT) {
4942     emitAnalysis(Report() << "cannot identify array bounds");
4943     DEBUG(dbgs() << "LV: We can't vectorize because we can't find " <<
4944           "the array bounds.\n");
4945     PtrRtCheck.reset();
4946     return false;
4947   }
4948
4949   PtrRtCheck.Need = NeedRTCheck;
4950
4951   bool CanVecMem = true;
4952   if (Accesses.isDependencyCheckNeeded()) {
4953     DEBUG(dbgs() << "LV: Checking memory dependencies\n");
4954     CanVecMem = DepChecker.areDepsSafe(
4955         DependentAccesses, Accesses.getDependenciesToCheck(), Strides);
4956     MaxSafeDepDistBytes = DepChecker.getMaxSafeDepDistBytes();
4957
4958     if (!CanVecMem && DepChecker.shouldRetryWithRuntimeCheck()) {
4959       DEBUG(dbgs() << "LV: Retrying with memory checks\n");
4960       NeedRTCheck = true;
4961
4962       // Clear the dependency checks. We assume they are not needed.
4963       Accesses.resetDepChecks();
4964
4965       PtrRtCheck.reset();
4966       PtrRtCheck.Need = true;
4967
4968       CanDoRT = Accesses.canCheckPtrAtRT(PtrRtCheck, NumComparisons, SE,
4969                                          TheLoop, Strides, true);
4970       // Check that we did not collect too many pointers or found an unsizeable
4971       // pointer.
4972       if (!CanDoRT || NumComparisons > RuntimeMemoryCheckThreshold) {
4973         if (!CanDoRT && NumComparisons > 0)
4974           emitAnalysis(Report()
4975                        << "cannot check memory dependencies at runtime");
4976         else
4977           emitAnalysis(Report()
4978                        << NumComparisons << " exceeds limit of "
4979                        << RuntimeMemoryCheckThreshold
4980                        << " dependent memory operations checked at runtime");
4981         DEBUG(dbgs() << "LV: Can't vectorize with memory checks\n");
4982         PtrRtCheck.reset();
4983         return false;
4984       }
4985
4986       CanVecMem = true;
4987     }
4988   }
4989
4990   if (!CanVecMem)
4991     emitAnalysis(Report() << "unsafe dependent memory operations in loop");
4992
4993   DEBUG(dbgs() << "LV: We" << (NeedRTCheck ? "" : " don't") <<
4994         " need a runtime memory check.\n");
4995
4996   return CanVecMem;
4997 }
4998
4999 static bool hasMultipleUsesOf(Instruction *I,
5000                               SmallPtrSetImpl<Instruction *> &Insts) {
5001   unsigned NumUses = 0;
5002   for(User::op_iterator Use = I->op_begin(), E = I->op_end(); Use != E; ++Use) {
5003     if (Insts.count(dyn_cast<Instruction>(*Use)))
5004       ++NumUses;
5005     if (NumUses > 1)
5006       return true;
5007   }
5008
5009   return false;
5010 }
5011
5012 static bool areAllUsesIn(Instruction *I, SmallPtrSetImpl<Instruction *> &Set) {
5013   for(User::op_iterator Use = I->op_begin(), E = I->op_end(); Use != E; ++Use)
5014     if (!Set.count(dyn_cast<Instruction>(*Use)))
5015       return false;
5016   return true;
5017 }
5018
5019 bool LoopVectorizationLegality::AddReductionVar(PHINode *Phi,
5020                                                 ReductionKind Kind) {
5021   if (Phi->getNumIncomingValues() != 2)
5022     return false;
5023
5024   // Reduction variables are only found in the loop header block.
5025   if (Phi->getParent() != TheLoop->getHeader())
5026     return false;
5027
5028   // Obtain the reduction start value from the value that comes from the loop
5029   // preheader.
5030   Value *RdxStart = Phi->getIncomingValueForBlock(TheLoop->getLoopPreheader());
5031
5032   // ExitInstruction is the single value which is used outside the loop.
5033   // We only allow for a single reduction value to be used outside the loop.
5034   // This includes users of the reduction, variables (which form a cycle
5035   // which ends in the phi node).
5036   Instruction *ExitInstruction = nullptr;
5037   // Indicates that we found a reduction operation in our scan.
5038   bool FoundReduxOp = false;
5039
5040   // We start with the PHI node and scan for all of the users of this
5041   // instruction. All users must be instructions that can be used as reduction
5042   // variables (such as ADD). We must have a single out-of-block user. The cycle
5043   // must include the original PHI.
5044   bool FoundStartPHI = false;
5045
5046   // To recognize min/max patterns formed by a icmp select sequence, we store
5047   // the number of instruction we saw from the recognized min/max pattern,
5048   //  to make sure we only see exactly the two instructions.
5049   unsigned NumCmpSelectPatternInst = 0;
5050   ReductionInstDesc ReduxDesc(false, nullptr);
5051
5052   SmallPtrSet<Instruction *, 8> VisitedInsts;
5053   SmallVector<Instruction *, 8> Worklist;
5054   Worklist.push_back(Phi);
5055   VisitedInsts.insert(Phi);
5056
5057   // A value in the reduction can be used:
5058   //  - By the reduction:
5059   //      - Reduction operation:
5060   //        - One use of reduction value (safe).
5061   //        - Multiple use of reduction value (not safe).
5062   //      - PHI:
5063   //        - All uses of the PHI must be the reduction (safe).
5064   //        - Otherwise, not safe.
5065   //  - By one instruction outside of the loop (safe).
5066   //  - By further instructions outside of the loop (not safe).
5067   //  - By an instruction that is not part of the reduction (not safe).
5068   //    This is either:
5069   //      * An instruction type other than PHI or the reduction operation.
5070   //      * A PHI in the header other than the initial PHI.
5071   while (!Worklist.empty()) {
5072     Instruction *Cur = Worklist.back();
5073     Worklist.pop_back();
5074
5075     // No Users.
5076     // If the instruction has no users then this is a broken chain and can't be
5077     // a reduction variable.
5078     if (Cur->use_empty())
5079       return false;
5080
5081     bool IsAPhi = isa<PHINode>(Cur);
5082
5083     // A header PHI use other than the original PHI.
5084     if (Cur != Phi && IsAPhi && Cur->getParent() == Phi->getParent())
5085       return false;
5086
5087     // Reductions of instructions such as Div, and Sub is only possible if the
5088     // LHS is the reduction variable.
5089     if (!Cur->isCommutative() && !IsAPhi && !isa<SelectInst>(Cur) &&
5090         !isa<ICmpInst>(Cur) && !isa<FCmpInst>(Cur) &&
5091         !VisitedInsts.count(dyn_cast<Instruction>(Cur->getOperand(0))))
5092       return false;
5093
5094     // Any reduction instruction must be of one of the allowed kinds.
5095     ReduxDesc = isReductionInstr(Cur, Kind, ReduxDesc);
5096     if (!ReduxDesc.IsReduction)
5097       return false;
5098
5099     // A reduction operation must only have one use of the reduction value.
5100     if (!IsAPhi && Kind != RK_IntegerMinMax && Kind != RK_FloatMinMax &&
5101         hasMultipleUsesOf(Cur, VisitedInsts))
5102       return false;
5103
5104     // All inputs to a PHI node must be a reduction value.
5105     if(IsAPhi && Cur != Phi && !areAllUsesIn(Cur, VisitedInsts))
5106       return false;
5107
5108     if (Kind == RK_IntegerMinMax && (isa<ICmpInst>(Cur) ||
5109                                      isa<SelectInst>(Cur)))
5110       ++NumCmpSelectPatternInst;
5111     if (Kind == RK_FloatMinMax && (isa<FCmpInst>(Cur) ||
5112                                    isa<SelectInst>(Cur)))
5113       ++NumCmpSelectPatternInst;
5114
5115     // Check  whether we found a reduction operator.
5116     FoundReduxOp |= !IsAPhi;
5117
5118     // Process users of current instruction. Push non-PHI nodes after PHI nodes
5119     // onto the stack. This way we are going to have seen all inputs to PHI
5120     // nodes once we get to them.
5121     SmallVector<Instruction *, 8> NonPHIs;
5122     SmallVector<Instruction *, 8> PHIs;
5123     for (User *U : Cur->users()) {
5124       Instruction *UI = cast<Instruction>(U);
5125
5126       // Check if we found the exit user.
5127       BasicBlock *Parent = UI->getParent();
5128       if (!TheLoop->contains(Parent)) {
5129         // Exit if you find multiple outside users or if the header phi node is
5130         // being used. In this case the user uses the value of the previous
5131         // iteration, in which case we would loose "VF-1" iterations of the
5132         // reduction operation if we vectorize.
5133         if (ExitInstruction != nullptr || Cur == Phi)
5134           return false;
5135
5136         // The instruction used by an outside user must be the last instruction
5137         // before we feed back to the reduction phi. Otherwise, we loose VF-1
5138         // operations on the value.
5139         if (std::find(Phi->op_begin(), Phi->op_end(), Cur) == Phi->op_end())
5140          return false;
5141
5142         ExitInstruction = Cur;
5143         continue;
5144       }
5145
5146       // Process instructions only once (termination). Each reduction cycle
5147       // value must only be used once, except by phi nodes and min/max
5148       // reductions which are represented as a cmp followed by a select.
5149       ReductionInstDesc IgnoredVal(false, nullptr);
5150       if (VisitedInsts.insert(UI).second) {
5151         if (isa<PHINode>(UI))
5152           PHIs.push_back(UI);
5153         else
5154           NonPHIs.push_back(UI);
5155       } else if (!isa<PHINode>(UI) &&
5156                  ((!isa<FCmpInst>(UI) &&
5157                    !isa<ICmpInst>(UI) &&
5158                    !isa<SelectInst>(UI)) ||
5159                   !isMinMaxSelectCmpPattern(UI, IgnoredVal).IsReduction))
5160         return false;
5161
5162       // Remember that we completed the cycle.
5163       if (UI == Phi)
5164         FoundStartPHI = true;
5165     }
5166     Worklist.append(PHIs.begin(), PHIs.end());
5167     Worklist.append(NonPHIs.begin(), NonPHIs.end());
5168   }
5169
5170   // This means we have seen one but not the other instruction of the
5171   // pattern or more than just a select and cmp.
5172   if ((Kind == RK_IntegerMinMax || Kind == RK_FloatMinMax) &&
5173       NumCmpSelectPatternInst != 2)
5174     return false;
5175
5176   if (!FoundStartPHI || !FoundReduxOp || !ExitInstruction)
5177     return false;
5178
5179   // We found a reduction var if we have reached the original phi node and we
5180   // only have a single instruction with out-of-loop users.
5181
5182   // This instruction is allowed to have out-of-loop users.
5183   AllowedExit.insert(ExitInstruction);
5184
5185   // Save the description of this reduction variable.
5186   ReductionDescriptor RD(RdxStart, ExitInstruction, Kind,
5187                          ReduxDesc.MinMaxKind);
5188   Reductions[Phi] = RD;
5189   // We've ended the cycle. This is a reduction variable if we have an
5190   // outside user and it has a binary op.
5191
5192   return true;
5193 }
5194
5195 /// Returns true if the instruction is a Select(ICmp(X, Y), X, Y) instruction
5196 /// pattern corresponding to a min(X, Y) or max(X, Y).
5197 LoopVectorizationLegality::ReductionInstDesc
5198 LoopVectorizationLegality::isMinMaxSelectCmpPattern(Instruction *I,
5199                                                     ReductionInstDesc &Prev) {
5200
5201   assert((isa<ICmpInst>(I) || isa<FCmpInst>(I) || isa<SelectInst>(I)) &&
5202          "Expect a select instruction");
5203   Instruction *Cmp = nullptr;
5204   SelectInst *Select = nullptr;
5205
5206   // We must handle the select(cmp()) as a single instruction. Advance to the
5207   // select.
5208   if ((Cmp = dyn_cast<ICmpInst>(I)) || (Cmp = dyn_cast<FCmpInst>(I))) {
5209     if (!Cmp->hasOneUse() || !(Select = dyn_cast<SelectInst>(*I->user_begin())))
5210       return ReductionInstDesc(false, I);
5211     return ReductionInstDesc(Select, Prev.MinMaxKind);
5212   }
5213
5214   // Only handle single use cases for now.
5215   if (!(Select = dyn_cast<SelectInst>(I)))
5216     return ReductionInstDesc(false, I);
5217   if (!(Cmp = dyn_cast<ICmpInst>(I->getOperand(0))) &&
5218       !(Cmp = dyn_cast<FCmpInst>(I->getOperand(0))))
5219     return ReductionInstDesc(false, I);
5220   if (!Cmp->hasOneUse())
5221     return ReductionInstDesc(false, I);
5222
5223   Value *CmpLeft;
5224   Value *CmpRight;
5225
5226   // Look for a min/max pattern.
5227   if (m_UMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5228     return ReductionInstDesc(Select, MRK_UIntMin);
5229   else if (m_UMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5230     return ReductionInstDesc(Select, MRK_UIntMax);
5231   else if (m_SMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5232     return ReductionInstDesc(Select, MRK_SIntMax);
5233   else if (m_SMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5234     return ReductionInstDesc(Select, MRK_SIntMin);
5235   else if (m_OrdFMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5236     return ReductionInstDesc(Select, MRK_FloatMin);
5237   else if (m_OrdFMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5238     return ReductionInstDesc(Select, MRK_FloatMax);
5239   else if (m_UnordFMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5240     return ReductionInstDesc(Select, MRK_FloatMin);
5241   else if (m_UnordFMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
5242     return ReductionInstDesc(Select, MRK_FloatMax);
5243
5244   return ReductionInstDesc(false, I);
5245 }
5246
5247 LoopVectorizationLegality::ReductionInstDesc
5248 LoopVectorizationLegality::isReductionInstr(Instruction *I,
5249                                             ReductionKind Kind,
5250                                             ReductionInstDesc &Prev) {
5251   bool FP = I->getType()->isFloatingPointTy();
5252   bool FastMath = FP && I->hasUnsafeAlgebra();
5253   switch (I->getOpcode()) {
5254   default:
5255     return ReductionInstDesc(false, I);
5256   case Instruction::PHI:
5257       if (FP && (Kind != RK_FloatMult && Kind != RK_FloatAdd &&
5258                  Kind != RK_FloatMinMax))
5259         return ReductionInstDesc(false, I);
5260     return ReductionInstDesc(I, Prev.MinMaxKind);
5261   case Instruction::Sub:
5262   case Instruction::Add:
5263     return ReductionInstDesc(Kind == RK_IntegerAdd, I);
5264   case Instruction::Mul:
5265     return ReductionInstDesc(Kind == RK_IntegerMult, I);
5266   case Instruction::And:
5267     return ReductionInstDesc(Kind == RK_IntegerAnd, I);
5268   case Instruction::Or:
5269     return ReductionInstDesc(Kind == RK_IntegerOr, I);
5270   case Instruction::Xor:
5271     return ReductionInstDesc(Kind == RK_IntegerXor, I);
5272   case Instruction::FMul:
5273     return ReductionInstDesc(Kind == RK_FloatMult && FastMath, I);
5274   case Instruction::FSub:
5275   case Instruction::FAdd:
5276     return ReductionInstDesc(Kind == RK_FloatAdd && FastMath, I);
5277   case Instruction::FCmp:
5278   case Instruction::ICmp:
5279   case Instruction::Select:
5280     if (Kind != RK_IntegerMinMax &&
5281         (!HasFunNoNaNAttr || Kind != RK_FloatMinMax))
5282       return ReductionInstDesc(false, I);
5283     return isMinMaxSelectCmpPattern(I, Prev);
5284   }
5285 }
5286
5287 LoopVectorizationLegality::InductionKind
5288 LoopVectorizationLegality::isInductionVariable(PHINode *Phi) {
5289   Type *PhiTy = Phi->getType();
5290   // We only handle integer and pointer inductions variables.
5291   if (!PhiTy->isIntegerTy() && !PhiTy->isPointerTy())
5292     return IK_NoInduction;
5293
5294   // Check that the PHI is consecutive.
5295   const SCEV *PhiScev = SE->getSCEV(Phi);
5296   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PhiScev);
5297   if (!AR) {
5298     DEBUG(dbgs() << "LV: PHI is not a poly recurrence.\n");
5299     return IK_NoInduction;
5300   }
5301   const SCEV *Step = AR->getStepRecurrence(*SE);
5302
5303   // Integer inductions need to have a stride of one.
5304   if (PhiTy->isIntegerTy()) {
5305     if (Step->isOne())
5306       return IK_IntInduction;
5307     if (Step->isAllOnesValue())
5308       return IK_ReverseIntInduction;
5309     return IK_NoInduction;
5310   }
5311
5312   // Calculate the pointer stride and check if it is consecutive.
5313   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
5314   if (!C)
5315     return IK_NoInduction;
5316
5317   assert(PhiTy->isPointerTy() && "The PHI must be a pointer");
5318   Type *PointerElementType = PhiTy->getPointerElementType();
5319   // The pointer stride cannot be determined if the pointer element type is not
5320   // sized.
5321   if (!PointerElementType->isSized())
5322     return IK_NoInduction;
5323
5324   uint64_t Size = DL->getTypeAllocSize(PointerElementType);
5325   if (C->getValue()->equalsInt(Size))
5326     return IK_PtrInduction;
5327   else if (C->getValue()->equalsInt(0 - Size))
5328     return IK_ReversePtrInduction;
5329
5330   return IK_NoInduction;
5331 }
5332
5333 bool LoopVectorizationLegality::isInductionVariable(const Value *V) {
5334   Value *In0 = const_cast<Value*>(V);
5335   PHINode *PN = dyn_cast_or_null<PHINode>(In0);
5336   if (!PN)
5337     return false;
5338
5339   return Inductions.count(PN);
5340 }
5341
5342 bool LoopVectorizationLegality::blockNeedsPredication(BasicBlock *BB)  {
5343   assert(TheLoop->contains(BB) && "Unknown block used");
5344
5345   // Blocks that do not dominate the latch need predication.
5346   BasicBlock* Latch = TheLoop->getLoopLatch();
5347   return !DT->dominates(BB, Latch);
5348 }
5349
5350 bool LoopVectorizationLegality::blockCanBePredicated(BasicBlock *BB,
5351                                            SmallPtrSetImpl<Value *> &SafePtrs) {
5352   
5353   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
5354     // Check that we don't have a constant expression that can trap as operand.
5355     for (Instruction::op_iterator OI = it->op_begin(), OE = it->op_end();
5356          OI != OE; ++OI) {
5357       if (Constant *C = dyn_cast<Constant>(*OI))
5358         if (C->canTrap())
5359           return false;
5360     }
5361     // We might be able to hoist the load.
5362     if (it->mayReadFromMemory()) {
5363       LoadInst *LI = dyn_cast<LoadInst>(it);
5364       if (!LI)
5365         return false;
5366       if (!SafePtrs.count(LI->getPointerOperand())) {
5367         if (isLegalMaskedLoad(LI->getType(), LI->getPointerOperand())) {
5368           MaskedOp.insert(LI);
5369           continue;
5370         }
5371         return false;
5372       }
5373     }
5374
5375     // We don't predicate stores at the moment.
5376     if (it->mayWriteToMemory()) {
5377       StoreInst *SI = dyn_cast<StoreInst>(it);
5378       // We only support predication of stores in basic blocks with one
5379       // predecessor.
5380       if (!SI)
5381         return false;
5382
5383       bool isSafePtr = (SafePtrs.count(SI->getPointerOperand()) != 0);
5384       bool isSinglePredecessor = SI->getParent()->getSinglePredecessor();
5385       
5386       if (++NumPredStores > NumberOfStoresToPredicate || !isSafePtr ||
5387           !isSinglePredecessor) {
5388         // Build a masked store if it is legal for the target, otherwise scalarize
5389         // the block.
5390         bool isLegalMaskedOp =
5391           isLegalMaskedStore(SI->getValueOperand()->getType(),
5392                              SI->getPointerOperand());
5393         if (isLegalMaskedOp) {
5394           --NumPredStores;
5395           MaskedOp.insert(SI);
5396           continue;
5397         }
5398         return false;
5399       }
5400     }
5401     if (it->mayThrow())
5402       return false;
5403
5404     // The instructions below can trap.
5405     switch (it->getOpcode()) {
5406     default: continue;
5407     case Instruction::UDiv:
5408     case Instruction::SDiv:
5409     case Instruction::URem:
5410     case Instruction::SRem:
5411       return false;
5412     }
5413   }
5414
5415   return true;
5416 }
5417
5418 LoopVectorizationCostModel::VectorizationFactor
5419 LoopVectorizationCostModel::selectVectorizationFactor(bool OptForSize) {
5420   // Width 1 means no vectorize
5421   VectorizationFactor Factor = { 1U, 0U };
5422   if (OptForSize && Legal->getRuntimePointerCheck()->Need) {
5423     emitAnalysis(Report() << "runtime pointer checks needed. Enable vectorization of this loop with '#pragma clang loop vectorize(enable)' when compiling with -Os");
5424     DEBUG(dbgs() << "LV: Aborting. Runtime ptr check is required in Os.\n");
5425     return Factor;
5426   }
5427
5428   if (!EnableCondStoresVectorization && Legal->NumPredStores) {
5429     emitAnalysis(Report() << "store that is conditionally executed prevents vectorization");
5430     DEBUG(dbgs() << "LV: No vectorization. There are conditional stores.\n");
5431     return Factor;
5432   }
5433
5434   // Find the trip count.
5435   unsigned TC = SE->getSmallConstantTripCount(TheLoop);
5436   DEBUG(dbgs() << "LV: Found trip count: " << TC << '\n');
5437
5438   unsigned WidestType = getWidestType();
5439   unsigned WidestRegister = TTI.getRegisterBitWidth(true);
5440   unsigned MaxSafeDepDist = -1U;
5441   if (Legal->getMaxSafeDepDistBytes() != -1U)
5442     MaxSafeDepDist = Legal->getMaxSafeDepDistBytes() * 8;
5443   WidestRegister = ((WidestRegister < MaxSafeDepDist) ?
5444                     WidestRegister : MaxSafeDepDist);
5445   unsigned MaxVectorSize = WidestRegister / WidestType;
5446   DEBUG(dbgs() << "LV: The Widest type: " << WidestType << " bits.\n");
5447   DEBUG(dbgs() << "LV: The Widest register is: "
5448           << WidestRegister << " bits.\n");
5449
5450   if (MaxVectorSize == 0) {
5451     DEBUG(dbgs() << "LV: The target has no vector registers.\n");
5452     MaxVectorSize = 1;
5453   }
5454
5455   assert(MaxVectorSize <= 64 && "Did not expect to pack so many elements"
5456          " into one vector!");
5457
5458   unsigned VF = MaxVectorSize;
5459
5460   // If we optimize the program for size, avoid creating the tail loop.
5461   if (OptForSize) {
5462     // If we are unable to calculate the trip count then don't try to vectorize.
5463     if (TC < 2) {
5464       emitAnalysis(Report() << "unable to calculate the loop count due to complex control flow");
5465       DEBUG(dbgs() << "LV: Aborting. A tail loop is required in Os.\n");
5466       return Factor;
5467     }
5468
5469     // Find the maximum SIMD width that can fit within the trip count.
5470     VF = TC % MaxVectorSize;
5471
5472     if (VF == 0)
5473       VF = MaxVectorSize;
5474
5475     // If the trip count that we found modulo the vectorization factor is not
5476     // zero then we require a tail.
5477     if (VF < 2) {
5478       emitAnalysis(Report() << "cannot optimize for size and vectorize at the "
5479                                "same time. Enable vectorization of this loop "
5480                                "with '#pragma clang loop vectorize(enable)' "
5481                                "when compiling with -Os");
5482       DEBUG(dbgs() << "LV: Aborting. A tail loop is required in Os.\n");
5483       return Factor;
5484     }
5485   }
5486
5487   int UserVF = Hints->getWidth();
5488   if (UserVF != 0) {
5489     assert(isPowerOf2_32(UserVF) && "VF needs to be a power of two");
5490     DEBUG(dbgs() << "LV: Using user VF " << UserVF << ".\n");
5491
5492     Factor.Width = UserVF;
5493     return Factor;
5494   }
5495
5496   float Cost = expectedCost(1);
5497 #ifndef NDEBUG
5498   const float ScalarCost = Cost;
5499 #endif /* NDEBUG */
5500   unsigned Width = 1;
5501   DEBUG(dbgs() << "LV: Scalar loop costs: " << (int)ScalarCost << ".\n");
5502
5503   bool ForceVectorization = Hints->getForce() == LoopVectorizeHints::FK_Enabled;
5504   // Ignore scalar width, because the user explicitly wants vectorization.
5505   if (ForceVectorization && VF > 1) {
5506     Width = 2;
5507     Cost = expectedCost(Width) / (float)Width;
5508   }
5509
5510   for (unsigned i=2; i <= VF; i*=2) {
5511     // Notice that the vector loop needs to be executed less times, so
5512     // we need to divide the cost of the vector loops by the width of
5513     // the vector elements.
5514     float VectorCost = expectedCost(i) / (float)i;
5515     DEBUG(dbgs() << "LV: Vector loop of width " << i << " costs: " <<
5516           (int)VectorCost << ".\n");
5517     if (VectorCost < Cost) {
5518       Cost = VectorCost;
5519       Width = i;
5520     }
5521   }
5522
5523   DEBUG(if (ForceVectorization && Width > 1 && Cost >= ScalarCost) dbgs()
5524         << "LV: Vectorization seems to be not beneficial, "
5525         << "but was forced by a user.\n");
5526   DEBUG(dbgs() << "LV: Selecting VF: "<< Width << ".\n");
5527   Factor.Width = Width;
5528   Factor.Cost = Width * Cost;
5529   return Factor;
5530 }
5531
5532 unsigned LoopVectorizationCostModel::getWidestType() {
5533   unsigned MaxWidth = 8;
5534
5535   // For each block.
5536   for (Loop::block_iterator bb = TheLoop->block_begin(),
5537        be = TheLoop->block_end(); bb != be; ++bb) {
5538     BasicBlock *BB = *bb;
5539
5540     // For each instruction in the loop.
5541     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
5542       Type *T = it->getType();
5543
5544       // Ignore ephemeral values.
5545       if (EphValues.count(it))
5546         continue;
5547
5548       // Only examine Loads, Stores and PHINodes.
5549       if (!isa<LoadInst>(it) && !isa<StoreInst>(it) && !isa<PHINode>(it))
5550         continue;
5551
5552       // Examine PHI nodes that are reduction variables.
5553       if (PHINode *PN = dyn_cast<PHINode>(it))
5554         if (!Legal->getReductionVars()->count(PN))
5555           continue;
5556
5557       // Examine the stored values.
5558       if (StoreInst *ST = dyn_cast<StoreInst>(it))
5559         T = ST->getValueOperand()->getType();
5560
5561       // Ignore loaded pointer types and stored pointer types that are not
5562       // consecutive. However, we do want to take consecutive stores/loads of
5563       // pointer vectors into account.
5564       if (T->isPointerTy() && !isConsecutiveLoadOrStore(it))
5565         continue;
5566
5567       MaxWidth = std::max(MaxWidth,
5568                           (unsigned)DL->getTypeSizeInBits(T->getScalarType()));
5569     }
5570   }
5571
5572   return MaxWidth;
5573 }
5574
5575 unsigned
5576 LoopVectorizationCostModel::selectUnrollFactor(bool OptForSize,
5577                                                unsigned VF,
5578                                                unsigned LoopCost) {
5579
5580   // -- The unroll heuristics --
5581   // We unroll the loop in order to expose ILP and reduce the loop overhead.
5582   // There are many micro-architectural considerations that we can't predict
5583   // at this level. For example, frontend pressure (on decode or fetch) due to
5584   // code size, or the number and capabilities of the execution ports.
5585   //
5586   // We use the following heuristics to select the unroll factor:
5587   // 1. If the code has reductions, then we unroll in order to break the cross
5588   // iteration dependency.
5589   // 2. If the loop is really small, then we unroll in order to reduce the loop
5590   // overhead.
5591   // 3. We don't unroll if we think that we will spill registers to memory due
5592   // to the increased register pressure.
5593
5594   // Use the user preference, unless 'auto' is selected.
5595   int UserUF = Hints->getInterleave();
5596   if (UserUF != 0)
5597     return UserUF;
5598
5599   // When we optimize for size, we don't unroll.
5600   if (OptForSize)
5601     return 1;
5602
5603   // We used the distance for the unroll factor.
5604   if (Legal->getMaxSafeDepDistBytes() != -1U)
5605     return 1;
5606
5607   // Do not unroll loops with a relatively small trip count.
5608   unsigned TC = SE->getSmallConstantTripCount(TheLoop);
5609   if (TC > 1 && TC < TinyTripCountUnrollThreshold)
5610     return 1;
5611
5612   unsigned TargetNumRegisters = TTI.getNumberOfRegisters(VF > 1);
5613   DEBUG(dbgs() << "LV: The target has " << TargetNumRegisters <<
5614         " registers\n");
5615
5616   if (VF == 1) {
5617     if (ForceTargetNumScalarRegs.getNumOccurrences() > 0)
5618       TargetNumRegisters = ForceTargetNumScalarRegs;
5619   } else {
5620     if (ForceTargetNumVectorRegs.getNumOccurrences() > 0)
5621       TargetNumRegisters = ForceTargetNumVectorRegs;
5622   }
5623
5624   LoopVectorizationCostModel::RegisterUsage R = calculateRegisterUsage();
5625   // We divide by these constants so assume that we have at least one
5626   // instruction that uses at least one register.
5627   R.MaxLocalUsers = std::max(R.MaxLocalUsers, 1U);
5628   R.NumInstructions = std::max(R.NumInstructions, 1U);
5629
5630   // We calculate the unroll factor using the following formula.
5631   // Subtract the number of loop invariants from the number of available
5632   // registers. These registers are used by all of the unrolled instances.
5633   // Next, divide the remaining registers by the number of registers that is
5634   // required by the loop, in order to estimate how many parallel instances
5635   // fit without causing spills. All of this is rounded down if necessary to be
5636   // a power of two. We want power of two unroll factors to simplify any
5637   // addressing operations or alignment considerations.
5638   unsigned UF = PowerOf2Floor((TargetNumRegisters - R.LoopInvariantRegs) /
5639                               R.MaxLocalUsers);
5640
5641   // Don't count the induction variable as unrolled.
5642   if (EnableIndVarRegisterHeur)
5643     UF = PowerOf2Floor((TargetNumRegisters - R.LoopInvariantRegs - 1) /
5644                        std::max(1U, (R.MaxLocalUsers - 1)));
5645
5646   // Clamp the unroll factor ranges to reasonable factors.
5647   unsigned MaxInterleaveSize = TTI.getMaxInterleaveFactor();
5648
5649   // Check if the user has overridden the unroll max.
5650   if (VF == 1) {
5651     if (ForceTargetMaxScalarInterleaveFactor.getNumOccurrences() > 0)
5652       MaxInterleaveSize = ForceTargetMaxScalarInterleaveFactor;
5653   } else {
5654     if (ForceTargetMaxVectorInterleaveFactor.getNumOccurrences() > 0)
5655       MaxInterleaveSize = ForceTargetMaxVectorInterleaveFactor;
5656   }
5657
5658   // If we did not calculate the cost for VF (because the user selected the VF)
5659   // then we calculate the cost of VF here.
5660   if (LoopCost == 0)
5661     LoopCost = expectedCost(VF);
5662
5663   // Clamp the calculated UF to be between the 1 and the max unroll factor
5664   // that the target allows.
5665   if (UF > MaxInterleaveSize)
5666     UF = MaxInterleaveSize;
5667   else if (UF < 1)
5668     UF = 1;
5669
5670   // Unroll if we vectorized this loop and there is a reduction that could
5671   // benefit from unrolling.
5672   if (VF > 1 && Legal->getReductionVars()->size()) {
5673     DEBUG(dbgs() << "LV: Unrolling because of reductions.\n");
5674     return UF;
5675   }
5676
5677   // Note that if we've already vectorized the loop we will have done the
5678   // runtime check and so unrolling won't require further checks.
5679   bool UnrollingRequiresRuntimePointerCheck =
5680       (VF == 1 && Legal->getRuntimePointerCheck()->Need);
5681
5682   // We want to unroll small loops in order to reduce the loop overhead and
5683   // potentially expose ILP opportunities.
5684   DEBUG(dbgs() << "LV: Loop cost is " << LoopCost << '\n');
5685   if (!UnrollingRequiresRuntimePointerCheck &&
5686       LoopCost < SmallLoopCost) {
5687     // We assume that the cost overhead is 1 and we use the cost model
5688     // to estimate the cost of the loop and unroll until the cost of the
5689     // loop overhead is about 5% of the cost of the loop.
5690     unsigned SmallUF = std::min(UF, (unsigned)PowerOf2Floor(SmallLoopCost / LoopCost));
5691
5692     // Unroll until store/load ports (estimated by max unroll factor) are
5693     // saturated.
5694     unsigned StoresUF = UF / (Legal->NumStores ? Legal->NumStores : 1);
5695     unsigned LoadsUF = UF /  (Legal->NumLoads ? Legal->NumLoads : 1);
5696
5697     // If we have a scalar reduction (vector reductions are already dealt with
5698     // by this point), we can increase the critical path length if the loop
5699     // we're unrolling is inside another loop. Limit, by default to 2, so the
5700     // critical path only gets increased by one reduction operation.
5701     if (Legal->getReductionVars()->size() &&
5702         TheLoop->getLoopDepth() > 1) {
5703       unsigned F = static_cast<unsigned>(MaxNestedScalarReductionUF);
5704       SmallUF = std::min(SmallUF, F);
5705       StoresUF = std::min(StoresUF, F);
5706       LoadsUF = std::min(LoadsUF, F);
5707     }
5708
5709     if (EnableLoadStoreRuntimeUnroll && std::max(StoresUF, LoadsUF) > SmallUF) {
5710       DEBUG(dbgs() << "LV: Unrolling to saturate store or load ports.\n");
5711       return std::max(StoresUF, LoadsUF);
5712     }
5713
5714     DEBUG(dbgs() << "LV: Unrolling to reduce branch cost.\n");
5715     return SmallUF;
5716   }
5717
5718   DEBUG(dbgs() << "LV: Not Unrolling.\n");
5719   return 1;
5720 }
5721
5722 LoopVectorizationCostModel::RegisterUsage
5723 LoopVectorizationCostModel::calculateRegisterUsage() {
5724   // This function calculates the register usage by measuring the highest number
5725   // of values that are alive at a single location. Obviously, this is a very
5726   // rough estimation. We scan the loop in a topological order in order and
5727   // assign a number to each instruction. We use RPO to ensure that defs are
5728   // met before their users. We assume that each instruction that has in-loop
5729   // users starts an interval. We record every time that an in-loop value is
5730   // used, so we have a list of the first and last occurrences of each
5731   // instruction. Next, we transpose this data structure into a multi map that
5732   // holds the list of intervals that *end* at a specific location. This multi
5733   // map allows us to perform a linear search. We scan the instructions linearly
5734   // and record each time that a new interval starts, by placing it in a set.
5735   // If we find this value in the multi-map then we remove it from the set.
5736   // The max register usage is the maximum size of the set.
5737   // We also search for instructions that are defined outside the loop, but are
5738   // used inside the loop. We need this number separately from the max-interval
5739   // usage number because when we unroll, loop-invariant values do not take
5740   // more register.
5741   LoopBlocksDFS DFS(TheLoop);
5742   DFS.perform(LI);
5743
5744   RegisterUsage R;
5745   R.NumInstructions = 0;
5746
5747   // Each 'key' in the map opens a new interval. The values
5748   // of the map are the index of the 'last seen' usage of the
5749   // instruction that is the key.
5750   typedef DenseMap<Instruction*, unsigned> IntervalMap;
5751   // Maps instruction to its index.
5752   DenseMap<unsigned, Instruction*> IdxToInstr;
5753   // Marks the end of each interval.
5754   IntervalMap EndPoint;
5755   // Saves the list of instruction indices that are used in the loop.
5756   SmallSet<Instruction*, 8> Ends;
5757   // Saves the list of values that are used in the loop but are
5758   // defined outside the loop, such as arguments and constants.
5759   SmallPtrSet<Value*, 8> LoopInvariants;
5760
5761   unsigned Index = 0;
5762   for (LoopBlocksDFS::RPOIterator bb = DFS.beginRPO(),
5763        be = DFS.endRPO(); bb != be; ++bb) {
5764     R.NumInstructions += (*bb)->size();
5765     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
5766          ++it) {
5767       Instruction *I = it;
5768       IdxToInstr[Index++] = I;
5769
5770       // Save the end location of each USE.
5771       for (unsigned i = 0; i < I->getNumOperands(); ++i) {
5772         Value *U = I->getOperand(i);
5773         Instruction *Instr = dyn_cast<Instruction>(U);
5774
5775         // Ignore non-instruction values such as arguments, constants, etc.
5776         if (!Instr) continue;
5777
5778         // If this instruction is outside the loop then record it and continue.
5779         if (!TheLoop->contains(Instr)) {
5780           LoopInvariants.insert(Instr);
5781           continue;
5782         }
5783
5784         // Overwrite previous end points.
5785         EndPoint[Instr] = Index;
5786         Ends.insert(Instr);
5787       }
5788     }
5789   }
5790
5791   // Saves the list of intervals that end with the index in 'key'.
5792   typedef SmallVector<Instruction*, 2> InstrList;
5793   DenseMap<unsigned, InstrList> TransposeEnds;
5794
5795   // Transpose the EndPoints to a list of values that end at each index.
5796   for (IntervalMap::iterator it = EndPoint.begin(), e = EndPoint.end();
5797        it != e; ++it)
5798     TransposeEnds[it->second].push_back(it->first);
5799
5800   SmallSet<Instruction*, 8> OpenIntervals;
5801   unsigned MaxUsage = 0;
5802
5803
5804   DEBUG(dbgs() << "LV(REG): Calculating max register usage:\n");
5805   for (unsigned int i = 0; i < Index; ++i) {
5806     Instruction *I = IdxToInstr[i];
5807     // Ignore instructions that are never used within the loop.
5808     if (!Ends.count(I)) continue;
5809
5810     // Ignore ephemeral values.
5811     if (EphValues.count(I))
5812       continue;
5813
5814     // Remove all of the instructions that end at this location.
5815     InstrList &List = TransposeEnds[i];
5816     for (unsigned int j=0, e = List.size(); j < e; ++j)
5817       OpenIntervals.erase(List[j]);
5818
5819     // Count the number of live interals.
5820     MaxUsage = std::max(MaxUsage, OpenIntervals.size());
5821
5822     DEBUG(dbgs() << "LV(REG): At #" << i << " Interval # " <<
5823           OpenIntervals.size() << '\n');
5824
5825     // Add the current instruction to the list of open intervals.
5826     OpenIntervals.insert(I);
5827   }
5828
5829   unsigned Invariant = LoopInvariants.size();
5830   DEBUG(dbgs() << "LV(REG): Found max usage: " << MaxUsage << '\n');
5831   DEBUG(dbgs() << "LV(REG): Found invariant usage: " << Invariant << '\n');
5832   DEBUG(dbgs() << "LV(REG): LoopSize: " << R.NumInstructions << '\n');
5833
5834   R.LoopInvariantRegs = Invariant;
5835   R.MaxLocalUsers = MaxUsage;
5836   return R;
5837 }
5838
5839 unsigned LoopVectorizationCostModel::expectedCost(unsigned VF) {
5840   unsigned Cost = 0;
5841
5842   // For each block.
5843   for (Loop::block_iterator bb = TheLoop->block_begin(),
5844        be = TheLoop->block_end(); bb != be; ++bb) {
5845     unsigned BlockCost = 0;
5846     BasicBlock *BB = *bb;
5847
5848     // For each instruction in the old loop.
5849     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
5850       // Skip dbg intrinsics.
5851       if (isa<DbgInfoIntrinsic>(it))
5852         continue;
5853
5854       // Ignore ephemeral values.
5855       if (EphValues.count(it))
5856         continue;
5857
5858       unsigned C = getInstructionCost(it, VF);
5859
5860       // Check if we should override the cost.
5861       if (ForceTargetInstructionCost.getNumOccurrences() > 0)
5862         C = ForceTargetInstructionCost;
5863
5864       BlockCost += C;
5865       DEBUG(dbgs() << "LV: Found an estimated cost of " << C << " for VF " <<
5866             VF << " For instruction: " << *it << '\n');
5867     }
5868
5869     // We assume that if-converted blocks have a 50% chance of being executed.
5870     // When the code is scalar then some of the blocks are avoided due to CF.
5871     // When the code is vectorized we execute all code paths.
5872     if (VF == 1 && Legal->blockNeedsPredication(*bb))
5873       BlockCost /= 2;
5874
5875     Cost += BlockCost;
5876   }
5877
5878   return Cost;
5879 }
5880
5881 /// \brief Check whether the address computation for a non-consecutive memory
5882 /// access looks like an unlikely candidate for being merged into the indexing
5883 /// mode.
5884 ///
5885 /// We look for a GEP which has one index that is an induction variable and all
5886 /// other indices are loop invariant. If the stride of this access is also
5887 /// within a small bound we decide that this address computation can likely be
5888 /// merged into the addressing mode.
5889 /// In all other cases, we identify the address computation as complex.
5890 static bool isLikelyComplexAddressComputation(Value *Ptr,
5891                                               LoopVectorizationLegality *Legal,
5892                                               ScalarEvolution *SE,
5893                                               const Loop *TheLoop) {
5894   GetElementPtrInst *Gep = dyn_cast<GetElementPtrInst>(Ptr);
5895   if (!Gep)
5896     return true;
5897
5898   // We are looking for a gep with all loop invariant indices except for one
5899   // which should be an induction variable.
5900   unsigned NumOperands = Gep->getNumOperands();
5901   for (unsigned i = 1; i < NumOperands; ++i) {
5902     Value *Opd = Gep->getOperand(i);
5903     if (!SE->isLoopInvariant(SE->getSCEV(Opd), TheLoop) &&
5904         !Legal->isInductionVariable(Opd))
5905       return true;
5906   }
5907
5908   // Now we know we have a GEP ptr, %inv, %ind, %inv. Make sure that the step
5909   // can likely be merged into the address computation.
5910   unsigned MaxMergeDistance = 64;
5911
5912   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(SE->getSCEV(Ptr));
5913   if (!AddRec)
5914     return true;
5915
5916   // Check the step is constant.
5917   const SCEV *Step = AddRec->getStepRecurrence(*SE);
5918   // Calculate the pointer stride and check if it is consecutive.
5919   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
5920   if (!C)
5921     return true;
5922
5923   const APInt &APStepVal = C->getValue()->getValue();
5924
5925   // Huge step value - give up.
5926   if (APStepVal.getBitWidth() > 64)
5927     return true;
5928
5929   int64_t StepVal = APStepVal.getSExtValue();
5930
5931   return StepVal > MaxMergeDistance;
5932 }
5933
5934 static bool isStrideMul(Instruction *I, LoopVectorizationLegality *Legal) {
5935   if (Legal->hasStride(I->getOperand(0)) || Legal->hasStride(I->getOperand(1)))
5936     return true;
5937   return false;
5938 }
5939
5940 unsigned
5941 LoopVectorizationCostModel::getInstructionCost(Instruction *I, unsigned VF) {
5942   // If we know that this instruction will remain uniform, check the cost of
5943   // the scalar version.
5944   if (Legal->isUniformAfterVectorization(I))
5945     VF = 1;
5946
5947   Type *RetTy = I->getType();
5948   Type *VectorTy = ToVectorTy(RetTy, VF);
5949
5950   // TODO: We need to estimate the cost of intrinsic calls.
5951   switch (I->getOpcode()) {
5952   case Instruction::GetElementPtr:
5953     // We mark this instruction as zero-cost because the cost of GEPs in
5954     // vectorized code depends on whether the corresponding memory instruction
5955     // is scalarized or not. Therefore, we handle GEPs with the memory
5956     // instruction cost.
5957     return 0;
5958   case Instruction::Br: {
5959     return TTI.getCFInstrCost(I->getOpcode());
5960   }
5961   case Instruction::PHI:
5962     //TODO: IF-converted IFs become selects.
5963     return 0;
5964   case Instruction::Add:
5965   case Instruction::FAdd:
5966   case Instruction::Sub:
5967   case Instruction::FSub:
5968   case Instruction::Mul:
5969   case Instruction::FMul:
5970   case Instruction::UDiv:
5971   case Instruction::SDiv:
5972   case Instruction::FDiv:
5973   case Instruction::URem:
5974   case Instruction::SRem:
5975   case Instruction::FRem:
5976   case Instruction::Shl:
5977   case Instruction::LShr:
5978   case Instruction::AShr:
5979   case Instruction::And:
5980   case Instruction::Or:
5981   case Instruction::Xor: {
5982     // Since we will replace the stride by 1 the multiplication should go away.
5983     if (I->getOpcode() == Instruction::Mul && isStrideMul(I, Legal))
5984       return 0;
5985     // Certain instructions can be cheaper to vectorize if they have a constant
5986     // second vector operand. One example of this are shifts on x86.
5987     TargetTransformInfo::OperandValueKind Op1VK =
5988       TargetTransformInfo::OK_AnyValue;
5989     TargetTransformInfo::OperandValueKind Op2VK =
5990       TargetTransformInfo::OK_AnyValue;
5991     TargetTransformInfo::OperandValueProperties Op1VP =
5992         TargetTransformInfo::OP_None;
5993     TargetTransformInfo::OperandValueProperties Op2VP =
5994         TargetTransformInfo::OP_None;
5995     Value *Op2 = I->getOperand(1);
5996
5997     // Check for a splat of a constant or for a non uniform vector of constants.
5998     if (isa<ConstantInt>(Op2)) {
5999       ConstantInt *CInt = cast<ConstantInt>(Op2);
6000       if (CInt && CInt->getValue().isPowerOf2())
6001         Op2VP = TargetTransformInfo::OP_PowerOf2;
6002       Op2VK = TargetTransformInfo::OK_UniformConstantValue;
6003     } else if (isa<ConstantVector>(Op2) || isa<ConstantDataVector>(Op2)) {
6004       Op2VK = TargetTransformInfo::OK_NonUniformConstantValue;
6005       Constant *SplatValue = cast<Constant>(Op2)->getSplatValue();
6006       if (SplatValue) {
6007         ConstantInt *CInt = dyn_cast<ConstantInt>(SplatValue);
6008         if (CInt && CInt->getValue().isPowerOf2())
6009           Op2VP = TargetTransformInfo::OP_PowerOf2;
6010         Op2VK = TargetTransformInfo::OK_UniformConstantValue;
6011       }
6012     }
6013
6014     return TTI.getArithmeticInstrCost(I->getOpcode(), VectorTy, Op1VK, Op2VK,
6015                                       Op1VP, Op2VP);
6016   }
6017   case Instruction::Select: {
6018     SelectInst *SI = cast<SelectInst>(I);
6019     const SCEV *CondSCEV = SE->getSCEV(SI->getCondition());
6020     bool ScalarCond = (SE->isLoopInvariant(CondSCEV, TheLoop));
6021     Type *CondTy = SI->getCondition()->getType();
6022     if (!ScalarCond)
6023       CondTy = VectorType::get(CondTy, VF);
6024
6025     return TTI.getCmpSelInstrCost(I->getOpcode(), VectorTy, CondTy);
6026   }
6027   case Instruction::ICmp:
6028   case Instruction::FCmp: {
6029     Type *ValTy = I->getOperand(0)->getType();
6030     VectorTy = ToVectorTy(ValTy, VF);
6031     return TTI.getCmpSelInstrCost(I->getOpcode(), VectorTy);
6032   }
6033   case Instruction::Store:
6034   case Instruction::Load: {
6035     StoreInst *SI = dyn_cast<StoreInst>(I);
6036     LoadInst *LI = dyn_cast<LoadInst>(I);
6037     Type *ValTy = (SI ? SI->getValueOperand()->getType() :
6038                    LI->getType());
6039     VectorTy = ToVectorTy(ValTy, VF);
6040
6041     unsigned Alignment = SI ? SI->getAlignment() : LI->getAlignment();
6042     unsigned AS = SI ? SI->getPointerAddressSpace() :
6043       LI->getPointerAddressSpace();
6044     Value *Ptr = SI ? SI->getPointerOperand() : LI->getPointerOperand();
6045     // We add the cost of address computation here instead of with the gep
6046     // instruction because only here we know whether the operation is
6047     // scalarized.
6048     if (VF == 1)
6049       return TTI.getAddressComputationCost(VectorTy) +
6050         TTI.getMemoryOpCost(I->getOpcode(), VectorTy, Alignment, AS);
6051
6052     // Scalarized loads/stores.
6053     int ConsecutiveStride = Legal->isConsecutivePtr(Ptr);
6054     bool Reverse = ConsecutiveStride < 0;
6055     unsigned ScalarAllocatedSize = DL->getTypeAllocSize(ValTy);
6056     unsigned VectorElementSize = DL->getTypeStoreSize(VectorTy)/VF;
6057     if (!ConsecutiveStride || ScalarAllocatedSize != VectorElementSize) {
6058       bool IsComplexComputation =
6059         isLikelyComplexAddressComputation(Ptr, Legal, SE, TheLoop);
6060       unsigned Cost = 0;
6061       // The cost of extracting from the value vector and pointer vector.
6062       Type *PtrTy = ToVectorTy(Ptr->getType(), VF);
6063       for (unsigned i = 0; i < VF; ++i) {
6064         //  The cost of extracting the pointer operand.
6065         Cost += TTI.getVectorInstrCost(Instruction::ExtractElement, PtrTy, i);
6066         // In case of STORE, the cost of ExtractElement from the vector.
6067         // In case of LOAD, the cost of InsertElement into the returned
6068         // vector.
6069         Cost += TTI.getVectorInstrCost(SI ? Instruction::ExtractElement :
6070                                             Instruction::InsertElement,
6071                                             VectorTy, i);
6072       }
6073
6074       // The cost of the scalar loads/stores.
6075       Cost += VF * TTI.getAddressComputationCost(PtrTy, IsComplexComputation);
6076       Cost += VF * TTI.getMemoryOpCost(I->getOpcode(), ValTy->getScalarType(),
6077                                        Alignment, AS);
6078       return Cost;
6079     }
6080
6081     // Wide load/stores.
6082     unsigned Cost = TTI.getAddressComputationCost(VectorTy);
6083     Cost += TTI.getMemoryOpCost(I->getOpcode(), VectorTy, Alignment, AS);
6084
6085     if (Reverse)
6086       Cost += TTI.getShuffleCost(TargetTransformInfo::SK_Reverse,
6087                                   VectorTy, 0);
6088     return Cost;
6089   }
6090   case Instruction::ZExt:
6091   case Instruction::SExt:
6092   case Instruction::FPToUI:
6093   case Instruction::FPToSI:
6094   case Instruction::FPExt:
6095   case Instruction::PtrToInt:
6096   case Instruction::IntToPtr:
6097   case Instruction::SIToFP:
6098   case Instruction::UIToFP:
6099   case Instruction::Trunc:
6100   case Instruction::FPTrunc:
6101   case Instruction::BitCast: {
6102     // We optimize the truncation of induction variable.
6103     // The cost of these is the same as the scalar operation.
6104     if (I->getOpcode() == Instruction::Trunc &&
6105         Legal->isInductionVariable(I->getOperand(0)))
6106       return TTI.getCastInstrCost(I->getOpcode(), I->getType(),
6107                                   I->getOperand(0)->getType());
6108
6109     Type *SrcVecTy = ToVectorTy(I->getOperand(0)->getType(), VF);
6110     return TTI.getCastInstrCost(I->getOpcode(), VectorTy, SrcVecTy);
6111   }
6112   case Instruction::Call: {
6113     CallInst *CI = cast<CallInst>(I);
6114     Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
6115     assert(ID && "Not an intrinsic call!");
6116     Type *RetTy = ToVectorTy(CI->getType(), VF);
6117     SmallVector<Type*, 4> Tys;
6118     for (unsigned i = 0, ie = CI->getNumArgOperands(); i != ie; ++i)
6119       Tys.push_back(ToVectorTy(CI->getArgOperand(i)->getType(), VF));
6120     return TTI.getIntrinsicInstrCost(ID, RetTy, Tys);
6121   }
6122   default: {
6123     // We are scalarizing the instruction. Return the cost of the scalar
6124     // instruction, plus the cost of insert and extract into vector
6125     // elements, times the vector width.
6126     unsigned Cost = 0;
6127
6128     if (!RetTy->isVoidTy() && VF != 1) {
6129       unsigned InsCost = TTI.getVectorInstrCost(Instruction::InsertElement,
6130                                                 VectorTy);
6131       unsigned ExtCost = TTI.getVectorInstrCost(Instruction::ExtractElement,
6132                                                 VectorTy);
6133
6134       // The cost of inserting the results plus extracting each one of the
6135       // operands.
6136       Cost += VF * (InsCost + ExtCost * I->getNumOperands());
6137     }
6138
6139     // The cost of executing VF copies of the scalar instruction. This opcode
6140     // is unknown. Assume that it is the same as 'mul'.
6141     Cost += VF * TTI.getArithmeticInstrCost(Instruction::Mul, VectorTy);
6142     return Cost;
6143   }
6144   }// end of switch.
6145 }
6146
6147 Type* LoopVectorizationCostModel::ToVectorTy(Type *Scalar, unsigned VF) {
6148   if (Scalar->isVoidTy() || VF == 1)
6149     return Scalar;
6150   return VectorType::get(Scalar, VF);
6151 }
6152
6153 char LoopVectorize::ID = 0;
6154 static const char lv_name[] = "Loop Vectorization";
6155 INITIALIZE_PASS_BEGIN(LoopVectorize, LV_NAME, lv_name, false, false)
6156 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
6157 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
6158 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
6159 INITIALIZE_PASS_DEPENDENCY(BlockFrequencyInfo)
6160 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
6161 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
6162 INITIALIZE_PASS_DEPENDENCY(LCSSA)
6163 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
6164 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
6165 INITIALIZE_PASS_END(LoopVectorize, LV_NAME, lv_name, false, false)
6166
6167 namespace llvm {
6168   Pass *createLoopVectorizePass(bool NoUnrolling, bool AlwaysVectorize) {
6169     return new LoopVectorize(NoUnrolling, AlwaysVectorize);
6170   }
6171 }
6172
6173 bool LoopVectorizationCostModel::isConsecutiveLoadOrStore(Instruction *Inst) {
6174   // Check for a store.
6175   if (StoreInst *ST = dyn_cast<StoreInst>(Inst))
6176     return Legal->isConsecutivePtr(ST->getPointerOperand()) != 0;
6177
6178   // Check for a load.
6179   if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
6180     return Legal->isConsecutivePtr(LI->getPointerOperand()) != 0;
6181
6182   return false;
6183 }
6184
6185
6186 void InnerLoopUnroller::scalarizeInstruction(Instruction *Instr,
6187                                              bool IfPredicateStore) {
6188   assert(!Instr->getType()->isAggregateType() && "Can't handle vectors");
6189   // Holds vector parameters or scalars, in case of uniform vals.
6190   SmallVector<VectorParts, 4> Params;
6191
6192   setDebugLocFromInst(Builder, Instr);
6193
6194   // Find all of the vectorized parameters.
6195   for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
6196     Value *SrcOp = Instr->getOperand(op);
6197
6198     // If we are accessing the old induction variable, use the new one.
6199     if (SrcOp == OldInduction) {
6200       Params.push_back(getVectorValue(SrcOp));
6201       continue;
6202     }
6203
6204     // Try using previously calculated values.
6205     Instruction *SrcInst = dyn_cast<Instruction>(SrcOp);
6206
6207     // If the src is an instruction that appeared earlier in the basic block
6208     // then it should already be vectorized.
6209     if (SrcInst && OrigLoop->contains(SrcInst)) {
6210       assert(WidenMap.has(SrcInst) && "Source operand is unavailable");
6211       // The parameter is a vector value from earlier.
6212       Params.push_back(WidenMap.get(SrcInst));
6213     } else {
6214       // The parameter is a scalar from outside the loop. Maybe even a constant.
6215       VectorParts Scalars;
6216       Scalars.append(UF, SrcOp);
6217       Params.push_back(Scalars);
6218     }
6219   }
6220
6221   assert(Params.size() == Instr->getNumOperands() &&
6222          "Invalid number of operands");
6223
6224   // Does this instruction return a value ?
6225   bool IsVoidRetTy = Instr->getType()->isVoidTy();
6226
6227   Value *UndefVec = IsVoidRetTy ? nullptr :
6228   UndefValue::get(Instr->getType());
6229   // Create a new entry in the WidenMap and initialize it to Undef or Null.
6230   VectorParts &VecResults = WidenMap.splat(Instr, UndefVec);
6231
6232   Instruction *InsertPt = Builder.GetInsertPoint();
6233   BasicBlock *IfBlock = Builder.GetInsertBlock();
6234   BasicBlock *CondBlock = nullptr;
6235
6236   VectorParts Cond;
6237   Loop *VectorLp = nullptr;
6238   if (IfPredicateStore) {
6239     assert(Instr->getParent()->getSinglePredecessor() &&
6240            "Only support single predecessor blocks");
6241     Cond = createEdgeMask(Instr->getParent()->getSinglePredecessor(),
6242                           Instr->getParent());
6243     VectorLp = LI->getLoopFor(IfBlock);
6244     assert(VectorLp && "Must have a loop for this block");
6245   }
6246
6247   // For each vector unroll 'part':
6248   for (unsigned Part = 0; Part < UF; ++Part) {
6249     // For each scalar that we create:
6250
6251     // Start an "if (pred) a[i] = ..." block.
6252     Value *Cmp = nullptr;
6253     if (IfPredicateStore) {
6254       if (Cond[Part]->getType()->isVectorTy())
6255         Cond[Part] =
6256             Builder.CreateExtractElement(Cond[Part], Builder.getInt32(0));
6257       Cmp = Builder.CreateICmp(ICmpInst::ICMP_EQ, Cond[Part],
6258                                ConstantInt::get(Cond[Part]->getType(), 1));
6259       CondBlock = IfBlock->splitBasicBlock(InsertPt, "cond.store");
6260       LoopVectorBody.push_back(CondBlock);
6261       VectorLp->addBasicBlockToLoop(CondBlock, LI->getBase());
6262       // Update Builder with newly created basic block.
6263       Builder.SetInsertPoint(InsertPt);
6264     }
6265
6266     Instruction *Cloned = Instr->clone();
6267       if (!IsVoidRetTy)
6268         Cloned->setName(Instr->getName() + ".cloned");
6269       // Replace the operands of the cloned instructions with extracted scalars.
6270       for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
6271         Value *Op = Params[op][Part];
6272         Cloned->setOperand(op, Op);
6273       }
6274
6275       // Place the cloned scalar in the new loop.
6276       Builder.Insert(Cloned);
6277
6278       // If the original scalar returns a value we need to place it in a vector
6279       // so that future users will be able to use it.
6280       if (!IsVoidRetTy)
6281         VecResults[Part] = Cloned;
6282
6283     // End if-block.
6284       if (IfPredicateStore) {
6285         BasicBlock *NewIfBlock = CondBlock->splitBasicBlock(InsertPt, "else");
6286         LoopVectorBody.push_back(NewIfBlock);
6287         VectorLp->addBasicBlockToLoop(NewIfBlock, LI->getBase());
6288         Builder.SetInsertPoint(InsertPt);
6289         Instruction *OldBr = IfBlock->getTerminator();
6290         BranchInst::Create(CondBlock, NewIfBlock, Cmp, OldBr);
6291         OldBr->eraseFromParent();
6292         IfBlock = NewIfBlock;
6293       }
6294   }
6295 }
6296
6297 void InnerLoopUnroller::vectorizeMemoryInstruction(Instruction *Instr) {
6298   StoreInst *SI = dyn_cast<StoreInst>(Instr);
6299   bool IfPredicateStore = (SI && Legal->blockNeedsPredication(SI->getParent()));
6300
6301   return scalarizeInstruction(Instr, IfPredicateStore);
6302 }
6303
6304 Value *InnerLoopUnroller::reverseVector(Value *Vec) {
6305   return Vec;
6306 }
6307
6308 Value *InnerLoopUnroller::getBroadcastInstrs(Value *V) {
6309   return V;
6310 }
6311
6312 Value *InnerLoopUnroller::getConsecutiveVector(Value* Val, int StartIdx,
6313                                                bool Negate) {
6314   // When unrolling and the VF is 1, we only need to add a simple scalar.
6315   Type *ITy = Val->getType();
6316   assert(!ITy->isVectorTy() && "Val must be a scalar");
6317   Constant *C = ConstantInt::get(ITy, StartIdx, Negate);
6318   return Builder.CreateAdd(Val, C, "induction");
6319 }