No need to cache this unused variable.
[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/AssumptionTracker.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       : NumLoads(0), NumStores(0), NumPredStores(0), TheLoop(L), SE(SE), DL(DL),
585         DT(DT), TLI(TLI), AA(AA), TheFunction(F), Induction(nullptr),
586         WidestIndTy(nullptr), HasFunNoNaNAttr(false), MaxSafeDepDistBytes(-1U) {
587   }
588
589   /// This enum represents the kinds of reductions that we support.
590   enum ReductionKind {
591     RK_NoReduction, ///< Not a reduction.
592     RK_IntegerAdd,  ///< Sum of integers.
593     RK_IntegerMult, ///< Product of integers.
594     RK_IntegerOr,   ///< Bitwise or logical OR of numbers.
595     RK_IntegerAnd,  ///< Bitwise or logical AND of numbers.
596     RK_IntegerXor,  ///< Bitwise or logical XOR of numbers.
597     RK_IntegerMinMax, ///< Min/max implemented in terms of select(cmp()).
598     RK_FloatAdd,    ///< Sum of floats.
599     RK_FloatMult,   ///< Product of floats.
600     RK_FloatMinMax  ///< Min/max implemented in terms of select(cmp()).
601   };
602
603   /// This enum represents the kinds of inductions that we support.
604   enum InductionKind {
605     IK_NoInduction,         ///< Not an induction variable.
606     IK_IntInduction,        ///< Integer induction variable. Step = 1.
607     IK_ReverseIntInduction, ///< Reverse int induction variable. Step = -1.
608     IK_PtrInduction,        ///< Pointer induction var. Step = sizeof(elem).
609     IK_ReversePtrInduction  ///< Reverse ptr indvar. Step = - sizeof(elem).
610   };
611
612   // This enum represents the kind of minmax reduction.
613   enum MinMaxReductionKind {
614     MRK_Invalid,
615     MRK_UIntMin,
616     MRK_UIntMax,
617     MRK_SIntMin,
618     MRK_SIntMax,
619     MRK_FloatMin,
620     MRK_FloatMax
621   };
622
623   /// This struct holds information about reduction variables.
624   struct ReductionDescriptor {
625     ReductionDescriptor() : StartValue(nullptr), LoopExitInstr(nullptr),
626       Kind(RK_NoReduction), MinMaxKind(MRK_Invalid) {}
627
628     ReductionDescriptor(Value *Start, Instruction *Exit, ReductionKind K,
629                         MinMaxReductionKind MK)
630         : StartValue(Start), LoopExitInstr(Exit), Kind(K), MinMaxKind(MK) {}
631
632     // The starting value of the reduction.
633     // It does not have to be zero!
634     TrackingVH<Value> StartValue;
635     // The instruction who's value is used outside the loop.
636     Instruction *LoopExitInstr;
637     // The kind of the reduction.
638     ReductionKind Kind;
639     // If this a min/max reduction the kind of reduction.
640     MinMaxReductionKind MinMaxKind;
641   };
642
643   /// This POD struct holds information about a potential reduction operation.
644   struct ReductionInstDesc {
645     ReductionInstDesc(bool IsRedux, Instruction *I) :
646       IsReduction(IsRedux), PatternLastInst(I), MinMaxKind(MRK_Invalid) {}
647
648     ReductionInstDesc(Instruction *I, MinMaxReductionKind K) :
649       IsReduction(true), PatternLastInst(I), MinMaxKind(K) {}
650
651     // Is this instruction a reduction candidate.
652     bool IsReduction;
653     // The last instruction in a min/max pattern (select of the select(icmp())
654     // pattern), or the current reduction instruction otherwise.
655     Instruction *PatternLastInst;
656     // If this is a min/max pattern the comparison predicate.
657     MinMaxReductionKind MinMaxKind;
658   };
659
660   /// This struct holds information about the memory runtime legality
661   /// check that a group of pointers do not overlap.
662   struct RuntimePointerCheck {
663     RuntimePointerCheck() : Need(false) {}
664
665     /// Reset the state of the pointer runtime information.
666     void reset() {
667       Need = false;
668       Pointers.clear();
669       Starts.clear();
670       Ends.clear();
671       IsWritePtr.clear();
672       DependencySetId.clear();
673       AliasSetId.clear();
674     }
675
676     /// Insert a pointer and calculate the start and end SCEVs.
677     void insert(ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr,
678                 unsigned DepSetId, unsigned ASId, ValueToValueMap &Strides);
679
680     /// This flag indicates if we need to add the runtime check.
681     bool Need;
682     /// Holds the pointers that we need to check.
683     SmallVector<TrackingVH<Value>, 2> Pointers;
684     /// Holds the pointer value at the beginning of the loop.
685     SmallVector<const SCEV*, 2> Starts;
686     /// Holds the pointer value at the end of the loop.
687     SmallVector<const SCEV*, 2> Ends;
688     /// Holds the information if this pointer is used for writing to memory.
689     SmallVector<bool, 2> IsWritePtr;
690     /// Holds the id of the set of pointers that could be dependent because of a
691     /// shared underlying object.
692     SmallVector<unsigned, 2> DependencySetId;
693     /// Holds the id of the disjoint alias set to which this pointer belongs.
694     SmallVector<unsigned, 2> AliasSetId;
695   };
696
697   /// A struct for saving information about induction variables.
698   struct InductionInfo {
699     InductionInfo(Value *Start, InductionKind K) : StartValue(Start), IK(K) {}
700     InductionInfo() : StartValue(nullptr), IK(IK_NoInduction) {}
701     /// Start value.
702     TrackingVH<Value> StartValue;
703     /// Induction kind.
704     InductionKind IK;
705   };
706
707   /// ReductionList contains the reduction descriptors for all
708   /// of the reductions that were found in the loop.
709   typedef DenseMap<PHINode*, ReductionDescriptor> ReductionList;
710
711   /// InductionList saves induction variables and maps them to the
712   /// induction descriptor.
713   typedef MapVector<PHINode*, InductionInfo> InductionList;
714
715   /// Returns true if it is legal to vectorize this loop.
716   /// This does not mean that it is profitable to vectorize this
717   /// loop, only that it is legal to do so.
718   bool canVectorize();
719
720   /// Returns the Induction variable.
721   PHINode *getInduction() { return Induction; }
722
723   /// Returns the reduction variables found in the loop.
724   ReductionList *getReductionVars() { return &Reductions; }
725
726   /// Returns the induction variables found in the loop.
727   InductionList *getInductionVars() { return &Inductions; }
728
729   /// Returns the widest induction type.
730   Type *getWidestInductionType() { return WidestIndTy; }
731
732   /// Returns True if V is an induction variable in this loop.
733   bool isInductionVariable(const Value *V);
734
735   /// Return true if the block BB needs to be predicated in order for the loop
736   /// to be vectorized.
737   bool blockNeedsPredication(BasicBlock *BB);
738
739   /// Check if this  pointer is consecutive when vectorizing. This happens
740   /// when the last index of the GEP is the induction variable, or that the
741   /// pointer itself is an induction variable.
742   /// This check allows us to vectorize A[idx] into a wide load/store.
743   /// Returns:
744   /// 0 - Stride is unknown or non-consecutive.
745   /// 1 - Address is consecutive.
746   /// -1 - Address is consecutive, and decreasing.
747   int isConsecutivePtr(Value *Ptr);
748
749   /// Returns true if the value V is uniform within the loop.
750   bool isUniform(Value *V);
751
752   /// Returns true if this instruction will remain scalar after vectorization.
753   bool isUniformAfterVectorization(Instruction* I) { return Uniforms.count(I); }
754
755   /// Returns the information that we collected about runtime memory check.
756   RuntimePointerCheck *getRuntimePointerCheck() { return &PtrRtCheck; }
757
758   /// This function returns the identity element (or neutral element) for
759   /// the operation K.
760   static Constant *getReductionIdentity(ReductionKind K, Type *Tp);
761
762   unsigned getMaxSafeDepDistBytes() { return MaxSafeDepDistBytes; }
763
764   bool hasStride(Value *V) { return StrideSet.count(V); }
765   bool mustCheckStrides() { return !StrideSet.empty(); }
766   SmallPtrSet<Value *, 8>::iterator strides_begin() {
767     return StrideSet.begin();
768   }
769   SmallPtrSet<Value *, 8>::iterator strides_end() { return StrideSet.end(); }
770
771 private:
772   /// Check if a single basic block loop is vectorizable.
773   /// At this point we know that this is a loop with a constant trip count
774   /// and we only need to check individual instructions.
775   bool canVectorizeInstrs();
776
777   /// When we vectorize loops we may change the order in which
778   /// we read and write from memory. This method checks if it is
779   /// legal to vectorize the code, considering only memory constrains.
780   /// Returns true if the loop is vectorizable
781   bool canVectorizeMemory();
782
783   /// Return true if we can vectorize this loop using the IF-conversion
784   /// transformation.
785   bool canVectorizeWithIfConvert();
786
787   /// Collect the variables that need to stay uniform after vectorization.
788   void collectLoopUniforms();
789
790   /// Return true if all of the instructions in the block can be speculatively
791   /// executed. \p SafePtrs is a list of addresses that are known to be legal
792   /// and we know that we can read from them without segfault.
793   bool blockCanBePredicated(BasicBlock *BB, SmallPtrSetImpl<Value *> &SafePtrs);
794
795   /// Returns True, if 'Phi' is the kind of reduction variable for type
796   /// 'Kind'. If this is a reduction variable, it adds it to ReductionList.
797   bool AddReductionVar(PHINode *Phi, ReductionKind Kind);
798   /// Returns a struct describing if the instruction 'I' can be a reduction
799   /// variable of type 'Kind'. If the reduction is a min/max pattern of
800   /// select(icmp()) this function advances the instruction pointer 'I' from the
801   /// compare instruction to the select instruction and stores this pointer in
802   /// 'PatternLastInst' member of the returned struct.
803   ReductionInstDesc isReductionInstr(Instruction *I, ReductionKind Kind,
804                                      ReductionInstDesc &Desc);
805   /// Returns true if the instruction is a Select(ICmp(X, Y), X, Y) instruction
806   /// pattern corresponding to a min(X, Y) or max(X, Y).
807   static ReductionInstDesc isMinMaxSelectCmpPattern(Instruction *I,
808                                                     ReductionInstDesc &Prev);
809   /// Returns the induction kind of Phi. This function may return NoInduction
810   /// if the PHI is not an induction variable.
811   InductionKind isInductionVariable(PHINode *Phi);
812
813   /// \brief Collect memory access with loop invariant strides.
814   ///
815   /// Looks for accesses like "a[i * StrideA]" where "StrideA" is loop
816   /// invariant.
817   void collectStridedAcccess(Value *LoadOrStoreInst);
818
819   /// Report an analysis message to assist the user in diagnosing loops that are
820   /// not vectorized.
821   void emitAnalysis(Report &Message) {
822     DebugLoc DL = TheLoop->getStartLoc();
823     if (Instruction *I = Message.getInstr())
824       DL = I->getDebugLoc();
825     emitOptimizationRemarkAnalysis(TheFunction->getContext(), DEBUG_TYPE,
826                                    *TheFunction, DL, Message.str());
827   }
828
829   /// The loop that we evaluate.
830   Loop *TheLoop;
831   /// Scev analysis.
832   ScalarEvolution *SE;
833   /// DataLayout analysis.
834   const DataLayout *DL;
835   /// Dominators.
836   DominatorTree *DT;
837   /// Target Library Info.
838   TargetLibraryInfo *TLI;
839   /// Alias analysis.
840   AliasAnalysis *AA;
841   /// Parent function
842   Function *TheFunction;
843
844   //  ---  vectorization state --- //
845
846   /// Holds the integer induction variable. This is the counter of the
847   /// loop.
848   PHINode *Induction;
849   /// Holds the reduction variables.
850   ReductionList Reductions;
851   /// Holds all of the induction variables that we found in the loop.
852   /// Notice that inductions don't need to start at zero and that induction
853   /// variables can be pointers.
854   InductionList Inductions;
855   /// Holds the widest induction type encountered.
856   Type *WidestIndTy;
857
858   /// Allowed outside users. This holds the reduction
859   /// vars which can be accessed from outside the loop.
860   SmallPtrSet<Value*, 4> AllowedExit;
861   /// This set holds the variables which are known to be uniform after
862   /// vectorization.
863   SmallPtrSet<Instruction*, 4> Uniforms;
864   /// We need to check that all of the pointers in this list are disjoint
865   /// at runtime.
866   RuntimePointerCheck PtrRtCheck;
867   /// Can we assume the absence of NaNs.
868   bool HasFunNoNaNAttr;
869
870   unsigned MaxSafeDepDistBytes;
871
872   ValueToValueMap Strides;
873   SmallPtrSet<Value *, 8> StrideSet;
874 };
875
876 /// LoopVectorizationCostModel - estimates the expected speedups due to
877 /// vectorization.
878 /// In many cases vectorization is not profitable. This can happen because of
879 /// a number of reasons. In this class we mainly attempt to predict the
880 /// expected speedup/slowdowns due to the supported instruction set. We use the
881 /// TargetTransformInfo to query the different backends for the cost of
882 /// different operations.
883 class LoopVectorizationCostModel {
884 public:
885   LoopVectorizationCostModel(Loop *L, ScalarEvolution *SE, LoopInfo *LI,
886                              LoopVectorizationLegality *Legal,
887                              const TargetTransformInfo &TTI,
888                              const DataLayout *DL, const TargetLibraryInfo *TLI,
889                              AssumptionTracker *AT, const Function *F,
890                              const LoopVectorizeHints *Hints)
891       : TheLoop(L), SE(SE), LI(LI), Legal(Legal), TTI(TTI), DL(DL), TLI(TLI),
892         TheFunction(F), Hints(Hints) {
893     CodeMetrics::collectEphemeralValues(L, AT, EphValues);
894   }
895
896   /// Information about vectorization costs
897   struct VectorizationFactor {
898     unsigned Width; // Vector width with best cost
899     unsigned Cost; // Cost of the loop with that width
900   };
901   /// \return The most profitable vectorization factor and the cost of that VF.
902   /// This method checks every power of two up to VF. If UserVF is not ZERO
903   /// then this vectorization factor will be selected if vectorization is
904   /// possible.
905   VectorizationFactor selectVectorizationFactor(bool OptForSize);
906
907   /// \return The size (in bits) of the widest type in the code that
908   /// needs to be vectorized. We ignore values that remain scalar such as
909   /// 64 bit loop indices.
910   unsigned getWidestType();
911
912   /// \return The most profitable unroll factor.
913   /// If UserUF is non-zero then this method finds the best unroll-factor
914   /// based on register pressure and other parameters.
915   /// VF and LoopCost are the selected vectorization factor and the cost of the
916   /// selected VF.
917   unsigned selectUnrollFactor(bool OptForSize, unsigned VF, unsigned LoopCost);
918
919   /// \brief A struct that represents some properties of the register usage
920   /// of a loop.
921   struct RegisterUsage {
922     /// Holds the number of loop invariant values that are used in the loop.
923     unsigned LoopInvariantRegs;
924     /// Holds the maximum number of concurrent live intervals in the loop.
925     unsigned MaxLocalUsers;
926     /// Holds the number of instructions in the loop.
927     unsigned NumInstructions;
928   };
929
930   /// \return  information about the register usage of the loop.
931   RegisterUsage calculateRegisterUsage();
932
933 private:
934   /// Returns the expected execution cost. The unit of the cost does
935   /// not matter because we use the 'cost' units to compare different
936   /// vector widths. The cost that is returned is *not* normalized by
937   /// the factor width.
938   unsigned expectedCost(unsigned VF);
939
940   /// Returns the execution time cost of an instruction for a given vector
941   /// width. Vector width of one means scalar.
942   unsigned getInstructionCost(Instruction *I, unsigned VF);
943
944   /// A helper function for converting Scalar types to vector types.
945   /// If the incoming type is void, we return void. If the VF is 1, we return
946   /// the scalar type.
947   static Type* ToVectorTy(Type *Scalar, unsigned VF);
948
949   /// Returns whether the instruction is a load or store and will be a emitted
950   /// as a vector operation.
951   bool isConsecutiveLoadOrStore(Instruction *I);
952
953   /// Report an analysis message to assist the user in diagnosing loops that are
954   /// not vectorized.
955   void emitAnalysis(Report &Message) {
956     DebugLoc DL = TheLoop->getStartLoc();
957     if (Instruction *I = Message.getInstr())
958       DL = I->getDebugLoc();
959     emitOptimizationRemarkAnalysis(TheFunction->getContext(), DEBUG_TYPE,
960                                    *TheFunction, DL, Message.str());
961   }
962
963   /// Values used only by @llvm.assume calls.
964   SmallPtrSet<const Value *, 32> EphValues;
965
966   /// The loop that we evaluate.
967   Loop *TheLoop;
968   /// Scev analysis.
969   ScalarEvolution *SE;
970   /// Loop Info analysis.
971   LoopInfo *LI;
972   /// Vectorization legality.
973   LoopVectorizationLegality *Legal;
974   /// Vector target information.
975   const TargetTransformInfo &TTI;
976   /// Target data layout information.
977   const DataLayout *DL;
978   /// Target Library Info.
979   const TargetLibraryInfo *TLI;
980   const Function *TheFunction;
981   // Loop Vectorize Hint.
982   const LoopVectorizeHints *Hints;
983 };
984
985 /// Utility class for getting and setting loop vectorizer hints in the form
986 /// of loop metadata.
987 /// This class keeps a number of loop annotations locally (as member variables)
988 /// and can, upon request, write them back as metadata on the loop. It will
989 /// initially scan the loop for existing metadata, and will update the local
990 /// values based on information in the loop.
991 /// We cannot write all values to metadata, as the mere presence of some info,
992 /// for example 'force', means a decision has been made. So, we need to be
993 /// careful NOT to add them if the user hasn't specifically asked so.
994 class LoopVectorizeHints {
995   enum HintKind {
996     HK_WIDTH,
997     HK_UNROLL,
998     HK_FORCE
999   };
1000
1001   /// Hint - associates name and validation with the hint value.
1002   struct Hint {
1003     const char * Name;
1004     unsigned Value; // This may have to change for non-numeric values.
1005     HintKind Kind;
1006
1007     Hint(const char * Name, unsigned Value, HintKind Kind)
1008       : Name(Name), Value(Value), Kind(Kind) { }
1009
1010     bool validate(unsigned Val) {
1011       switch (Kind) {
1012       case HK_WIDTH:
1013         return isPowerOf2_32(Val) && Val <= MaxVectorWidth;
1014       case HK_UNROLL:
1015         return isPowerOf2_32(Val) && Val <= MaxInterleaveFactor;
1016       case HK_FORCE:
1017         return (Val <= 1);
1018       }
1019       return false;
1020     }
1021   };
1022
1023   /// Vectorization width.
1024   Hint Width;
1025   /// Vectorization interleave factor.
1026   Hint Interleave;
1027   /// Vectorization forced
1028   Hint Force;
1029   /// Array to help iterating through all hints.
1030   Hint *Hints[3]; // avoiding initialisation due to MSVC2012
1031
1032   /// Return the loop metadata prefix.
1033   static StringRef Prefix() { return "llvm.loop."; }
1034
1035 public:
1036   enum ForceKind {
1037     FK_Undefined = -1, ///< Not selected.
1038     FK_Disabled = 0,   ///< Forcing disabled.
1039     FK_Enabled = 1,    ///< Forcing enabled.
1040   };
1041
1042   LoopVectorizeHints(const Loop *L, bool DisableInterleaving)
1043       : Width("vectorize.width", VectorizationFactor, HK_WIDTH),
1044         Interleave("interleave.count", DisableInterleaving, HK_UNROLL),
1045         Force("vectorize.enable", FK_Undefined, HK_FORCE),
1046         TheLoop(L) {
1047     // FIXME: Move this up initialisation when MSVC requirement is 2013+
1048     Hints[0] = &Width;
1049     Hints[1] = &Interleave;
1050     Hints[2] = &Force;
1051
1052     // Populate values with existing loop metadata.
1053     getHintsFromMetadata();
1054
1055     // force-vector-interleave overrides DisableInterleaving.
1056     if (VectorizationInterleave.getNumOccurrences() > 0)
1057       Interleave.Value = VectorizationInterleave;
1058
1059     DEBUG(if (DisableInterleaving && Interleave.Value == 1) dbgs()
1060           << "LV: Interleaving disabled by the pass manager\n");
1061   }
1062
1063   /// Mark the loop L as already vectorized by setting the width to 1.
1064   void setAlreadyVectorized() {
1065     Width.Value = Interleave.Value = 1;
1066     // FIXME: Change all lines below for this when we can use MSVC 2013+
1067     //writeHintsToMetadata({ Width, Unroll });
1068     std::vector<Hint> hints;
1069     hints.reserve(2);
1070     hints.emplace_back(Width);
1071     hints.emplace_back(Interleave);
1072     writeHintsToMetadata(std::move(hints));
1073   }
1074
1075   /// Dumps all the hint information.
1076   std::string emitRemark() const {
1077     Report R;
1078     if (Force.Value == LoopVectorizeHints::FK_Disabled)
1079       R << "vectorization is explicitly disabled";
1080     else {
1081       R << "use -Rpass-analysis=loop-vectorize for more info";
1082       if (Force.Value == LoopVectorizeHints::FK_Enabled) {
1083         R << " (Force=true";
1084         if (Width.Value != 0)
1085           R << ", Vector Width=" << Width.Value;
1086         if (Interleave.Value != 0)
1087           R << ", Interleave Count=" << Interleave.Value;
1088         R << ")";
1089       }
1090     }
1091
1092     return R.str();
1093   }
1094
1095   unsigned getWidth() const { return Width.Value; }
1096   unsigned getInterleave() const { return Interleave.Value; }
1097   enum ForceKind getForce() const { return (ForceKind)Force.Value; }
1098
1099 private:
1100   /// Find hints specified in the loop metadata and update local values.
1101   void getHintsFromMetadata() {
1102     MDNode *LoopID = TheLoop->getLoopID();
1103     if (!LoopID)
1104       return;
1105
1106     // First operand should refer to the loop id itself.
1107     assert(LoopID->getNumOperands() > 0 && "requires at least one operand");
1108     assert(LoopID->getOperand(0) == LoopID && "invalid loop id");
1109
1110     for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
1111       const MDString *S = nullptr;
1112       SmallVector<Value*, 4> Args;
1113
1114       // The expected hint is either a MDString or a MDNode with the first
1115       // operand a MDString.
1116       if (const MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i))) {
1117         if (!MD || MD->getNumOperands() == 0)
1118           continue;
1119         S = dyn_cast<MDString>(MD->getOperand(0));
1120         for (unsigned i = 1, ie = MD->getNumOperands(); i < ie; ++i)
1121           Args.push_back(MD->getOperand(i));
1122       } else {
1123         S = dyn_cast<MDString>(LoopID->getOperand(i));
1124         assert(Args.size() == 0 && "too many arguments for MDString");
1125       }
1126
1127       if (!S)
1128         continue;
1129
1130       // Check if the hint starts with the loop metadata prefix.
1131       StringRef Name = S->getString();
1132       if (Args.size() == 1)
1133         setHint(Name, Args[0]);
1134     }
1135   }
1136
1137   /// Checks string hint with one operand and set value if valid.
1138   void setHint(StringRef Name, Value *Arg) {
1139     if (!Name.startswith(Prefix()))
1140       return;
1141     Name = Name.substr(Prefix().size(), StringRef::npos);
1142
1143     const ConstantInt *C = dyn_cast<ConstantInt>(Arg);
1144     if (!C) return;
1145     unsigned Val = C->getZExtValue();
1146
1147     for (auto H : Hints) {
1148       if (Name == H->Name) {
1149         if (H->validate(Val))
1150           H->Value = Val;
1151         else
1152           DEBUG(dbgs() << "LV: ignoring invalid hint '" << Name << "'\n");
1153         break;
1154       }
1155     }
1156   }
1157
1158   /// Create a new hint from name / value pair.
1159   MDNode *createHintMetadata(StringRef Name, unsigned V) const {
1160     LLVMContext &Context = TheLoop->getHeader()->getContext();
1161     SmallVector<Value*, 2> Vals;
1162     Vals.push_back(MDString::get(Context, Name));
1163     Vals.push_back(ConstantInt::get(Type::getInt32Ty(Context), V));
1164     return MDNode::get(Context, Vals);
1165   }
1166
1167   /// Matches metadata with hint name.
1168   bool matchesHintMetadataName(MDNode *Node, std::vector<Hint> &HintTypes) {
1169     MDString* Name = dyn_cast<MDString>(Node->getOperand(0));
1170     if (!Name)
1171       return false;
1172
1173     for (auto H : HintTypes)
1174       if (Name->getName().endswith(H.Name))
1175         return true;
1176     return false;
1177   }
1178
1179   /// Sets current hints into loop metadata, keeping other values intact.
1180   void writeHintsToMetadata(std::vector<Hint> HintTypes) {
1181     if (HintTypes.size() == 0)
1182       return;
1183
1184     // Reserve the first element to LoopID (see below).
1185     SmallVector<Value*, 4> Vals(1);
1186     // If the loop already has metadata, then ignore the existing operands.
1187     MDNode *LoopID = TheLoop->getLoopID();
1188     if (LoopID) {
1189       for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
1190         MDNode *Node = cast<MDNode>(LoopID->getOperand(i));
1191         // If node in update list, ignore old value.
1192         if (!matchesHintMetadataName(Node, HintTypes))
1193           Vals.push_back(Node);
1194       }
1195     }
1196
1197     // Now, add the missing hints.
1198     for (auto H : HintTypes)
1199       Vals.push_back(
1200           createHintMetadata(Twine(Prefix(), H.Name).str(), H.Value));
1201
1202     // Replace current metadata node with new one.
1203     LLVMContext &Context = TheLoop->getHeader()->getContext();
1204     MDNode *NewLoopID = MDNode::get(Context, Vals);
1205     // Set operand 0 to refer to the loop id itself.
1206     NewLoopID->replaceOperandWith(0, NewLoopID);
1207
1208     TheLoop->setLoopID(NewLoopID);
1209     if (LoopID)
1210       LoopID->replaceAllUsesWith(NewLoopID);
1211     LoopID = NewLoopID;
1212   }
1213
1214   /// The loop these hints belong to.
1215   const Loop *TheLoop;
1216 };
1217
1218 static void emitMissedWarning(Function *F, Loop *L,
1219                               const LoopVectorizeHints &LH) {
1220   emitOptimizationRemarkMissed(F->getContext(), DEBUG_TYPE, *F,
1221                                L->getStartLoc(), LH.emitRemark());
1222
1223   if (LH.getForce() == LoopVectorizeHints::FK_Enabled) {
1224     if (LH.getWidth() != 1)
1225       emitLoopVectorizeWarning(
1226           F->getContext(), *F, L->getStartLoc(),
1227           "failed explicitly specified loop vectorization");
1228     else if (LH.getInterleave() != 1)
1229       emitLoopInterleaveWarning(
1230           F->getContext(), *F, L->getStartLoc(),
1231           "failed explicitly specified loop interleaving");
1232   }
1233 }
1234
1235 static void addInnerLoop(Loop &L, SmallVectorImpl<Loop *> &V) {
1236   if (L.empty())
1237     return V.push_back(&L);
1238
1239   for (Loop *InnerL : L)
1240     addInnerLoop(*InnerL, V);
1241 }
1242
1243 /// The LoopVectorize Pass.
1244 struct LoopVectorize : public FunctionPass {
1245   /// Pass identification, replacement for typeid
1246   static char ID;
1247
1248   explicit LoopVectorize(bool NoUnrolling = false, bool AlwaysVectorize = true)
1249     : FunctionPass(ID),
1250       DisableUnrolling(NoUnrolling),
1251       AlwaysVectorize(AlwaysVectorize) {
1252     initializeLoopVectorizePass(*PassRegistry::getPassRegistry());
1253   }
1254
1255   ScalarEvolution *SE;
1256   const DataLayout *DL;
1257   LoopInfo *LI;
1258   TargetTransformInfo *TTI;
1259   DominatorTree *DT;
1260   BlockFrequencyInfo *BFI;
1261   TargetLibraryInfo *TLI;
1262   AliasAnalysis *AA;
1263   AssumptionTracker *AT;
1264   bool DisableUnrolling;
1265   bool AlwaysVectorize;
1266
1267   BlockFrequency ColdEntryFreq;
1268
1269   bool runOnFunction(Function &F) override {
1270     SE = &getAnalysis<ScalarEvolution>();
1271     DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
1272     DL = DLP ? &DLP->getDataLayout() : nullptr;
1273     LI = &getAnalysis<LoopInfo>();
1274     TTI = &getAnalysis<TargetTransformInfo>();
1275     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1276     BFI = &getAnalysis<BlockFrequencyInfo>();
1277     TLI = getAnalysisIfAvailable<TargetLibraryInfo>();
1278     AA = &getAnalysis<AliasAnalysis>();
1279     AT = &getAnalysis<AssumptionTracker>();
1280
1281     // Compute some weights outside of the loop over the loops. Compute this
1282     // using a BranchProbability to re-use its scaling math.
1283     const BranchProbability ColdProb(1, 5); // 20%
1284     ColdEntryFreq = BlockFrequency(BFI->getEntryFreq()) * ColdProb;
1285
1286     // If the target claims to have no vector registers don't attempt
1287     // vectorization.
1288     if (!TTI->getNumberOfRegisters(true))
1289       return false;
1290
1291     if (!DL) {
1292       DEBUG(dbgs() << "\nLV: Not vectorizing " << F.getName()
1293                    << ": Missing data layout\n");
1294       return false;
1295     }
1296
1297     // Build up a worklist of inner-loops to vectorize. This is necessary as
1298     // the act of vectorizing or partially unrolling a loop creates new loops
1299     // and can invalidate iterators across the loops.
1300     SmallVector<Loop *, 8> Worklist;
1301
1302     for (Loop *L : *LI)
1303       addInnerLoop(*L, Worklist);
1304
1305     LoopsAnalyzed += Worklist.size();
1306
1307     // Now walk the identified inner loops.
1308     bool Changed = false;
1309     while (!Worklist.empty())
1310       Changed |= processLoop(Worklist.pop_back_val());
1311
1312     // Process each loop nest in the function.
1313     return Changed;
1314   }
1315
1316   bool processLoop(Loop *L) {
1317     assert(L->empty() && "Only process inner loops.");
1318
1319 #ifndef NDEBUG
1320     const std::string DebugLocStr = getDebugLocString(L);
1321 #endif /* NDEBUG */
1322
1323     DEBUG(dbgs() << "\nLV: Checking a loop in \""
1324                  << L->getHeader()->getParent()->getName() << "\" from "
1325                  << DebugLocStr << "\n");
1326
1327     LoopVectorizeHints Hints(L, DisableUnrolling);
1328
1329     DEBUG(dbgs() << "LV: Loop hints:"
1330                  << " force="
1331                  << (Hints.getForce() == LoopVectorizeHints::FK_Disabled
1332                          ? "disabled"
1333                          : (Hints.getForce() == LoopVectorizeHints::FK_Enabled
1334                                 ? "enabled"
1335                                 : "?")) << " width=" << Hints.getWidth()
1336                  << " unroll=" << Hints.getInterleave() << "\n");
1337
1338     // Function containing loop
1339     Function *F = L->getHeader()->getParent();
1340
1341     // Looking at the diagnostic output is the only way to determine if a loop
1342     // was vectorized (other than looking at the IR or machine code), so it
1343     // is important to generate an optimization remark for each loop. Most of
1344     // these messages are generated by emitOptimizationRemarkAnalysis. Remarks
1345     // generated by emitOptimizationRemark and emitOptimizationRemarkMissed are
1346     // less verbose reporting vectorized loops and unvectorized loops that may
1347     // benefit from vectorization, respectively.
1348
1349     if (Hints.getForce() == LoopVectorizeHints::FK_Disabled) {
1350       DEBUG(dbgs() << "LV: Not vectorizing: #pragma vectorize disable.\n");
1351       emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F,
1352                                      L->getStartLoc(), Hints.emitRemark());
1353       return false;
1354     }
1355
1356     if (!AlwaysVectorize && Hints.getForce() != LoopVectorizeHints::FK_Enabled) {
1357       DEBUG(dbgs() << "LV: Not vectorizing: No #pragma vectorize enable.\n");
1358       emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F,
1359                                      L->getStartLoc(), Hints.emitRemark());
1360       return false;
1361     }
1362
1363     if (Hints.getWidth() == 1 && Hints.getInterleave() == 1) {
1364       DEBUG(dbgs() << "LV: Not vectorizing: Disabled/already vectorized.\n");
1365       emitOptimizationRemarkAnalysis(
1366           F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1367           "loop not vectorized: vector width and interleave count are "
1368           "explicitly set to 1");
1369       return false;
1370     }
1371
1372     // Check the loop for a trip count threshold:
1373     // do not vectorize loops with a tiny trip count.
1374     const unsigned TC = SE->getSmallConstantTripCount(L);
1375     if (TC > 0u && TC < TinyTripCountVectorThreshold) {
1376       DEBUG(dbgs() << "LV: Found a loop with a very small trip count. "
1377                    << "This loop is not worth vectorizing.");
1378       if (Hints.getForce() == LoopVectorizeHints::FK_Enabled)
1379         DEBUG(dbgs() << " But vectorizing was explicitly forced.\n");
1380       else {
1381         DEBUG(dbgs() << "\n");
1382         emitOptimizationRemarkAnalysis(
1383             F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1384             "vectorization is not beneficial and is not explicitly forced");
1385         return false;
1386       }
1387     }
1388
1389     // Check if it is legal to vectorize the loop.
1390     LoopVectorizationLegality LVL(L, SE, DL, DT, TLI, AA, F);
1391     if (!LVL.canVectorize()) {
1392       DEBUG(dbgs() << "LV: Not vectorizing: Cannot prove legality.\n");
1393       emitMissedWarning(F, L, Hints);
1394       return false;
1395     }
1396
1397     // Use the cost model.
1398     LoopVectorizationCostModel CM(L, SE, LI, &LVL, *TTI, DL, TLI, AT, F,
1399                                   &Hints);
1400
1401     // Check the function attributes to find out if this function should be
1402     // optimized for size.
1403     bool OptForSize = Hints.getForce() != LoopVectorizeHints::FK_Enabled &&
1404                       F->hasFnAttribute(Attribute::OptimizeForSize);
1405
1406     // Compute the weighted frequency of this loop being executed and see if it
1407     // is less than 20% of the function entry baseline frequency. Note that we
1408     // always have a canonical loop here because we think we *can* vectoriez.
1409     // FIXME: This is hidden behind a flag due to pervasive problems with
1410     // exactly what block frequency models.
1411     if (LoopVectorizeWithBlockFrequency) {
1412       BlockFrequency LoopEntryFreq = BFI->getBlockFreq(L->getLoopPreheader());
1413       if (Hints.getForce() != LoopVectorizeHints::FK_Enabled &&
1414           LoopEntryFreq < ColdEntryFreq)
1415         OptForSize = true;
1416     }
1417
1418     // Check the function attributes to see if implicit floats are allowed.a
1419     // FIXME: This check doesn't seem possibly correct -- what if the loop is
1420     // an integer loop and the vector instructions selected are purely integer
1421     // vector instructions?
1422     if (F->hasFnAttribute(Attribute::NoImplicitFloat)) {
1423       DEBUG(dbgs() << "LV: Can't vectorize when the NoImplicitFloat"
1424             "attribute is used.\n");
1425       emitOptimizationRemarkAnalysis(
1426           F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1427           "loop not vectorized due to NoImplicitFloat attribute");
1428       emitMissedWarning(F, L, Hints);
1429       return false;
1430     }
1431
1432     // Select the optimal vectorization factor.
1433     const LoopVectorizationCostModel::VectorizationFactor VF =
1434         CM.selectVectorizationFactor(OptForSize);
1435
1436     // Select the unroll factor.
1437     const unsigned UF =
1438         CM.selectUnrollFactor(OptForSize, VF.Width, VF.Cost);
1439
1440     DEBUG(dbgs() << "LV: Found a vectorizable loop (" << VF.Width << ") in "
1441                  << DebugLocStr << '\n');
1442     DEBUG(dbgs() << "LV: Unroll Factor is " << UF << '\n');
1443
1444     if (VF.Width == 1) {
1445       DEBUG(dbgs() << "LV: Vectorization is possible but not beneficial\n");
1446
1447       if (UF == 1) {
1448         emitOptimizationRemarkAnalysis(
1449             F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1450             "not beneficial to vectorize and user disabled interleaving");
1451         return false;
1452       }
1453       DEBUG(dbgs() << "LV: Trying to at least unroll the loops.\n");
1454
1455       // Report the unrolling decision.
1456       emitOptimizationRemark(F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1457                              Twine("unrolled with interleaving factor " +
1458                                    Twine(UF) +
1459                                    " (vectorization not beneficial)"));
1460
1461       // We decided not to vectorize, but we may want to unroll.
1462
1463       InnerLoopUnroller Unroller(L, SE, LI, DT, DL, TLI, UF);
1464       Unroller.vectorize(&LVL);
1465     } else {
1466       // If we decided that it is *legal* to vectorize the loop then do it.
1467       InnerLoopVectorizer LB(L, SE, LI, DT, DL, TLI, VF.Width, UF);
1468       LB.vectorize(&LVL);
1469       ++LoopsVectorized;
1470
1471       // Report the vectorization decision.
1472       emitOptimizationRemark(
1473           F->getContext(), DEBUG_TYPE, *F, L->getStartLoc(),
1474           Twine("vectorized loop (vectorization factor: ") + Twine(VF.Width) +
1475               ", unrolling interleave factor: " + Twine(UF) + ")");
1476     }
1477
1478     // Mark the loop as already vectorized to avoid vectorizing again.
1479     Hints.setAlreadyVectorized();
1480
1481     DEBUG(verifyFunction(*L->getHeader()->getParent()));
1482     return true;
1483   }
1484
1485   void getAnalysisUsage(AnalysisUsage &AU) const override {
1486     AU.addRequired<AssumptionTracker>();
1487     AU.addRequiredID(LoopSimplifyID);
1488     AU.addRequiredID(LCSSAID);
1489     AU.addRequired<BlockFrequencyInfo>();
1490     AU.addRequired<DominatorTreeWrapperPass>();
1491     AU.addRequired<LoopInfo>();
1492     AU.addRequired<ScalarEvolution>();
1493     AU.addRequired<TargetTransformInfo>();
1494     AU.addRequired<AliasAnalysis>();
1495     AU.addPreserved<LoopInfo>();
1496     AU.addPreserved<DominatorTreeWrapperPass>();
1497     AU.addPreserved<AliasAnalysis>();
1498   }
1499
1500 };
1501
1502 } // end anonymous namespace
1503
1504 //===----------------------------------------------------------------------===//
1505 // Implementation of LoopVectorizationLegality, InnerLoopVectorizer and
1506 // LoopVectorizationCostModel.
1507 //===----------------------------------------------------------------------===//
1508
1509 static Value *stripIntegerCast(Value *V) {
1510   if (CastInst *CI = dyn_cast<CastInst>(V))
1511     if (CI->getOperand(0)->getType()->isIntegerTy())
1512       return CI->getOperand(0);
1513   return V;
1514 }
1515
1516 ///\brief Replaces the symbolic stride in a pointer SCEV expression by one.
1517 ///
1518 /// If \p OrigPtr is not null, use it to look up the stride value instead of
1519 /// \p Ptr.
1520 static const SCEV *replaceSymbolicStrideSCEV(ScalarEvolution *SE,
1521                                              ValueToValueMap &PtrToStride,
1522                                              Value *Ptr, Value *OrigPtr = nullptr) {
1523
1524   const SCEV *OrigSCEV = SE->getSCEV(Ptr);
1525
1526   // If there is an entry in the map return the SCEV of the pointer with the
1527   // symbolic stride replaced by one.
1528   ValueToValueMap::iterator SI = PtrToStride.find(OrigPtr ? OrigPtr : Ptr);
1529   if (SI != PtrToStride.end()) {
1530     Value *StrideVal = SI->second;
1531
1532     // Strip casts.
1533     StrideVal = stripIntegerCast(StrideVal);
1534
1535     // Replace symbolic stride by one.
1536     Value *One = ConstantInt::get(StrideVal->getType(), 1);
1537     ValueToValueMap RewriteMap;
1538     RewriteMap[StrideVal] = One;
1539
1540     const SCEV *ByOne =
1541         SCEVParameterRewriter::rewrite(OrigSCEV, *SE, RewriteMap, true);
1542     DEBUG(dbgs() << "LV: Replacing SCEV: " << *OrigSCEV << " by: " << *ByOne
1543                  << "\n");
1544     return ByOne;
1545   }
1546
1547   // Otherwise, just return the SCEV of the original pointer.
1548   return SE->getSCEV(Ptr);
1549 }
1550
1551 void LoopVectorizationLegality::RuntimePointerCheck::insert(
1552     ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr, unsigned DepSetId,
1553     unsigned ASId, ValueToValueMap &Strides) {
1554   // Get the stride replaced scev.
1555   const SCEV *Sc = replaceSymbolicStrideSCEV(SE, Strides, Ptr);
1556   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Sc);
1557   assert(AR && "Invalid addrec expression");
1558   const SCEV *Ex = SE->getBackedgeTakenCount(Lp);
1559   const SCEV *ScEnd = AR->evaluateAtIteration(Ex, *SE);
1560   Pointers.push_back(Ptr);
1561   Starts.push_back(AR->getStart());
1562   Ends.push_back(ScEnd);
1563   IsWritePtr.push_back(WritePtr);
1564   DependencySetId.push_back(DepSetId);
1565   AliasSetId.push_back(ASId);
1566 }
1567
1568 Value *InnerLoopVectorizer::getBroadcastInstrs(Value *V) {
1569   // We need to place the broadcast of invariant variables outside the loop.
1570   Instruction *Instr = dyn_cast<Instruction>(V);
1571   bool NewInstr =
1572       (Instr && std::find(LoopVectorBody.begin(), LoopVectorBody.end(),
1573                           Instr->getParent()) != LoopVectorBody.end());
1574   bool Invariant = OrigLoop->isLoopInvariant(V) && !NewInstr;
1575
1576   // Place the code for broadcasting invariant variables in the new preheader.
1577   IRBuilder<>::InsertPointGuard Guard(Builder);
1578   if (Invariant)
1579     Builder.SetInsertPoint(LoopVectorPreHeader->getTerminator());
1580
1581   // Broadcast the scalar into all locations in the vector.
1582   Value *Shuf = Builder.CreateVectorSplat(VF, V, "broadcast");
1583
1584   return Shuf;
1585 }
1586
1587 Value *InnerLoopVectorizer::getConsecutiveVector(Value* Val, int StartIdx,
1588                                                  bool Negate) {
1589   assert(Val->getType()->isVectorTy() && "Must be a vector");
1590   assert(Val->getType()->getScalarType()->isIntegerTy() &&
1591          "Elem must be an integer");
1592   // Create the types.
1593   Type *ITy = Val->getType()->getScalarType();
1594   VectorType *Ty = cast<VectorType>(Val->getType());
1595   int VLen = Ty->getNumElements();
1596   SmallVector<Constant*, 8> Indices;
1597
1598   // Create a vector of consecutive numbers from zero to VF.
1599   for (int i = 0; i < VLen; ++i) {
1600     int64_t Idx = Negate ? (-i) : i;
1601     Indices.push_back(ConstantInt::get(ITy, StartIdx + Idx, Negate));
1602   }
1603
1604   // Add the consecutive indices to the vector value.
1605   Constant *Cv = ConstantVector::get(Indices);
1606   assert(Cv->getType() == Val->getType() && "Invalid consecutive vec");
1607   return Builder.CreateAdd(Val, Cv, "induction");
1608 }
1609
1610 /// \brief Find the operand of the GEP that should be checked for consecutive
1611 /// stores. This ignores trailing indices that have no effect on the final
1612 /// pointer.
1613 static unsigned getGEPInductionOperand(const DataLayout *DL,
1614                                        const GetElementPtrInst *Gep) {
1615   unsigned LastOperand = Gep->getNumOperands() - 1;
1616   unsigned GEPAllocSize = DL->getTypeAllocSize(
1617       cast<PointerType>(Gep->getType()->getScalarType())->getElementType());
1618
1619   // Walk backwards and try to peel off zeros.
1620   while (LastOperand > 1 && match(Gep->getOperand(LastOperand), m_Zero())) {
1621     // Find the type we're currently indexing into.
1622     gep_type_iterator GEPTI = gep_type_begin(Gep);
1623     std::advance(GEPTI, LastOperand - 1);
1624
1625     // If it's a type with the same allocation size as the result of the GEP we
1626     // can peel off the zero index.
1627     if (DL->getTypeAllocSize(*GEPTI) != GEPAllocSize)
1628       break;
1629     --LastOperand;
1630   }
1631
1632   return LastOperand;
1633 }
1634
1635 int LoopVectorizationLegality::isConsecutivePtr(Value *Ptr) {
1636   assert(Ptr->getType()->isPointerTy() && "Unexpected non-ptr");
1637   // Make sure that the pointer does not point to structs.
1638   if (Ptr->getType()->getPointerElementType()->isAggregateType())
1639     return 0;
1640
1641   // If this value is a pointer induction variable we know it is consecutive.
1642   PHINode *Phi = dyn_cast_or_null<PHINode>(Ptr);
1643   if (Phi && Inductions.count(Phi)) {
1644     InductionInfo II = Inductions[Phi];
1645     if (IK_PtrInduction == II.IK)
1646       return 1;
1647     else if (IK_ReversePtrInduction == II.IK)
1648       return -1;
1649   }
1650
1651   GetElementPtrInst *Gep = dyn_cast_or_null<GetElementPtrInst>(Ptr);
1652   if (!Gep)
1653     return 0;
1654
1655   unsigned NumOperands = Gep->getNumOperands();
1656   Value *GpPtr = Gep->getPointerOperand();
1657   // If this GEP value is a consecutive pointer induction variable and all of
1658   // the indices are constant then we know it is consecutive. We can
1659   Phi = dyn_cast<PHINode>(GpPtr);
1660   if (Phi && Inductions.count(Phi)) {
1661
1662     // Make sure that the pointer does not point to structs.
1663     PointerType *GepPtrType = cast<PointerType>(GpPtr->getType());
1664     if (GepPtrType->getElementType()->isAggregateType())
1665       return 0;
1666
1667     // Make sure that all of the index operands are loop invariant.
1668     for (unsigned i = 1; i < NumOperands; ++i)
1669       if (!SE->isLoopInvariant(SE->getSCEV(Gep->getOperand(i)), TheLoop))
1670         return 0;
1671
1672     InductionInfo II = Inductions[Phi];
1673     if (IK_PtrInduction == II.IK)
1674       return 1;
1675     else if (IK_ReversePtrInduction == II.IK)
1676       return -1;
1677   }
1678
1679   unsigned InductionOperand = getGEPInductionOperand(DL, Gep);
1680
1681   // Check that all of the gep indices are uniform except for our induction
1682   // operand.
1683   for (unsigned i = 0; i != NumOperands; ++i)
1684     if (i != InductionOperand &&
1685         !SE->isLoopInvariant(SE->getSCEV(Gep->getOperand(i)), TheLoop))
1686       return 0;
1687
1688   // We can emit wide load/stores only if the last non-zero index is the
1689   // induction variable.
1690   const SCEV *Last = nullptr;
1691   if (!Strides.count(Gep))
1692     Last = SE->getSCEV(Gep->getOperand(InductionOperand));
1693   else {
1694     // Because of the multiplication by a stride we can have a s/zext cast.
1695     // We are going to replace this stride by 1 so the cast is safe to ignore.
1696     //
1697     //  %indvars.iv = phi i64 [ 0, %entry ], [ %indvars.iv.next, %for.body ]
1698     //  %0 = trunc i64 %indvars.iv to i32
1699     //  %mul = mul i32 %0, %Stride1
1700     //  %idxprom = zext i32 %mul to i64  << Safe cast.
1701     //  %arrayidx = getelementptr inbounds i32* %B, i64 %idxprom
1702     //
1703     Last = replaceSymbolicStrideSCEV(SE, Strides,
1704                                      Gep->getOperand(InductionOperand), Gep);
1705     if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(Last))
1706       Last =
1707           (C->getSCEVType() == scSignExtend || C->getSCEVType() == scZeroExtend)
1708               ? C->getOperand()
1709               : Last;
1710   }
1711   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Last)) {
1712     const SCEV *Step = AR->getStepRecurrence(*SE);
1713
1714     // The memory is consecutive because the last index is consecutive
1715     // and all other indices are loop invariant.
1716     if (Step->isOne())
1717       return 1;
1718     if (Step->isAllOnesValue())
1719       return -1;
1720   }
1721
1722   return 0;
1723 }
1724
1725 bool LoopVectorizationLegality::isUniform(Value *V) {
1726   return (SE->isLoopInvariant(SE->getSCEV(V), TheLoop));
1727 }
1728
1729 InnerLoopVectorizer::VectorParts&
1730 InnerLoopVectorizer::getVectorValue(Value *V) {
1731   assert(V != Induction && "The new induction variable should not be used.");
1732   assert(!V->getType()->isVectorTy() && "Can't widen a vector");
1733
1734   // If we have a stride that is replaced by one, do it here.
1735   if (Legal->hasStride(V))
1736     V = ConstantInt::get(V->getType(), 1);
1737
1738   // If we have this scalar in the map, return it.
1739   if (WidenMap.has(V))
1740     return WidenMap.get(V);
1741
1742   // If this scalar is unknown, assume that it is a constant or that it is
1743   // loop invariant. Broadcast V and save the value for future uses.
1744   Value *B = getBroadcastInstrs(V);
1745   return WidenMap.splat(V, B);
1746 }
1747
1748 Value *InnerLoopVectorizer::reverseVector(Value *Vec) {
1749   assert(Vec->getType()->isVectorTy() && "Invalid type");
1750   SmallVector<Constant*, 8> ShuffleMask;
1751   for (unsigned i = 0; i < VF; ++i)
1752     ShuffleMask.push_back(Builder.getInt32(VF - i - 1));
1753
1754   return Builder.CreateShuffleVector(Vec, UndefValue::get(Vec->getType()),
1755                                      ConstantVector::get(ShuffleMask),
1756                                      "reverse");
1757 }
1758
1759 void InnerLoopVectorizer::vectorizeMemoryInstruction(Instruction *Instr) {
1760   // Attempt to issue a wide load.
1761   LoadInst *LI = dyn_cast<LoadInst>(Instr);
1762   StoreInst *SI = dyn_cast<StoreInst>(Instr);
1763
1764   assert((LI || SI) && "Invalid Load/Store instruction");
1765
1766   Type *ScalarDataTy = LI ? LI->getType() : SI->getValueOperand()->getType();
1767   Type *DataTy = VectorType::get(ScalarDataTy, VF);
1768   Value *Ptr = LI ? LI->getPointerOperand() : SI->getPointerOperand();
1769   unsigned Alignment = LI ? LI->getAlignment() : SI->getAlignment();
1770   // An alignment of 0 means target abi alignment. We need to use the scalar's
1771   // target abi alignment in such a case.
1772   if (!Alignment)
1773     Alignment = DL->getABITypeAlignment(ScalarDataTy);
1774   unsigned AddressSpace = Ptr->getType()->getPointerAddressSpace();
1775   unsigned ScalarAllocatedSize = DL->getTypeAllocSize(ScalarDataTy);
1776   unsigned VectorElementSize = DL->getTypeStoreSize(DataTy)/VF;
1777
1778   if (SI && Legal->blockNeedsPredication(SI->getParent()))
1779     return scalarizeInstruction(Instr, true);
1780
1781   if (ScalarAllocatedSize != VectorElementSize)
1782     return scalarizeInstruction(Instr);
1783
1784   // If the pointer is loop invariant or if it is non-consecutive,
1785   // scalarize the load.
1786   int ConsecutiveStride = Legal->isConsecutivePtr(Ptr);
1787   bool Reverse = ConsecutiveStride < 0;
1788   bool UniformLoad = LI && Legal->isUniform(Ptr);
1789   if (!ConsecutiveStride || UniformLoad)
1790     return scalarizeInstruction(Instr);
1791
1792   Constant *Zero = Builder.getInt32(0);
1793   VectorParts &Entry = WidenMap.get(Instr);
1794
1795   // Handle consecutive loads/stores.
1796   GetElementPtrInst *Gep = dyn_cast<GetElementPtrInst>(Ptr);
1797   if (Gep && Legal->isInductionVariable(Gep->getPointerOperand())) {
1798     setDebugLocFromInst(Builder, Gep);
1799     Value *PtrOperand = Gep->getPointerOperand();
1800     Value *FirstBasePtr = getVectorValue(PtrOperand)[0];
1801     FirstBasePtr = Builder.CreateExtractElement(FirstBasePtr, Zero);
1802
1803     // Create the new GEP with the new induction variable.
1804     GetElementPtrInst *Gep2 = cast<GetElementPtrInst>(Gep->clone());
1805     Gep2->setOperand(0, FirstBasePtr);
1806     Gep2->setName("gep.indvar.base");
1807     Ptr = Builder.Insert(Gep2);
1808   } else if (Gep) {
1809     setDebugLocFromInst(Builder, Gep);
1810     assert(SE->isLoopInvariant(SE->getSCEV(Gep->getPointerOperand()),
1811                                OrigLoop) && "Base ptr must be invariant");
1812
1813     // The last index does not have to be the induction. It can be
1814     // consecutive and be a function of the index. For example A[I+1];
1815     unsigned NumOperands = Gep->getNumOperands();
1816     unsigned InductionOperand = getGEPInductionOperand(DL, Gep);
1817     // Create the new GEP with the new induction variable.
1818     GetElementPtrInst *Gep2 = cast<GetElementPtrInst>(Gep->clone());
1819
1820     for (unsigned i = 0; i < NumOperands; ++i) {
1821       Value *GepOperand = Gep->getOperand(i);
1822       Instruction *GepOperandInst = dyn_cast<Instruction>(GepOperand);
1823
1824       // Update last index or loop invariant instruction anchored in loop.
1825       if (i == InductionOperand ||
1826           (GepOperandInst && OrigLoop->contains(GepOperandInst))) {
1827         assert((i == InductionOperand ||
1828                SE->isLoopInvariant(SE->getSCEV(GepOperandInst), OrigLoop)) &&
1829                "Must be last index or loop invariant");
1830
1831         VectorParts &GEPParts = getVectorValue(GepOperand);
1832         Value *Index = GEPParts[0];
1833         Index = Builder.CreateExtractElement(Index, Zero);
1834         Gep2->setOperand(i, Index);
1835         Gep2->setName("gep.indvar.idx");
1836       }
1837     }
1838     Ptr = Builder.Insert(Gep2);
1839   } else {
1840     // Use the induction element ptr.
1841     assert(isa<PHINode>(Ptr) && "Invalid induction ptr");
1842     setDebugLocFromInst(Builder, Ptr);
1843     VectorParts &PtrVal = getVectorValue(Ptr);
1844     Ptr = Builder.CreateExtractElement(PtrVal[0], Zero);
1845   }
1846
1847   // Handle Stores:
1848   if (SI) {
1849     assert(!Legal->isUniform(SI->getPointerOperand()) &&
1850            "We do not allow storing to uniform addresses");
1851     setDebugLocFromInst(Builder, SI);
1852     // We don't want to update the value in the map as it might be used in
1853     // another expression. So don't use a reference type for "StoredVal".
1854     VectorParts StoredVal = getVectorValue(SI->getValueOperand());
1855
1856     for (unsigned Part = 0; Part < UF; ++Part) {
1857       // Calculate the pointer for the specific unroll-part.
1858       Value *PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(Part * VF));
1859
1860       if (Reverse) {
1861         // If we store to reverse consecutive memory locations then we need
1862         // to reverse the order of elements in the stored value.
1863         StoredVal[Part] = reverseVector(StoredVal[Part]);
1864         // If the address is consecutive but reversed, then the
1865         // wide store needs to start at the last vector element.
1866         PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(-Part * VF));
1867         PartPtr = Builder.CreateGEP(PartPtr, Builder.getInt32(1 - VF));
1868       }
1869
1870       Value *VecPtr = Builder.CreateBitCast(PartPtr,
1871                                             DataTy->getPointerTo(AddressSpace));
1872       StoreInst *NewSI =
1873         Builder.CreateAlignedStore(StoredVal[Part], VecPtr, Alignment);
1874       propagateMetadata(NewSI, SI);
1875     }
1876     return;
1877   }
1878
1879   // Handle loads.
1880   assert(LI && "Must have a load instruction");
1881   setDebugLocFromInst(Builder, LI);
1882   for (unsigned Part = 0; Part < UF; ++Part) {
1883     // Calculate the pointer for the specific unroll-part.
1884     Value *PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(Part * VF));
1885
1886     if (Reverse) {
1887       // If the address is consecutive but reversed, then the
1888       // wide store needs to start at the last vector element.
1889       PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(-Part * VF));
1890       PartPtr = Builder.CreateGEP(PartPtr, Builder.getInt32(1 - VF));
1891     }
1892
1893     Value *VecPtr = Builder.CreateBitCast(PartPtr,
1894                                           DataTy->getPointerTo(AddressSpace));
1895     LoadInst *NewLI = Builder.CreateAlignedLoad(VecPtr, Alignment, "wide.load");
1896     propagateMetadata(NewLI, LI);
1897     Entry[Part] = Reverse ? reverseVector(NewLI) :  NewLI;
1898   }
1899 }
1900
1901 void InnerLoopVectorizer::scalarizeInstruction(Instruction *Instr, bool IfPredicateStore) {
1902   assert(!Instr->getType()->isAggregateType() && "Can't handle vectors");
1903   // Holds vector parameters or scalars, in case of uniform vals.
1904   SmallVector<VectorParts, 4> Params;
1905
1906   setDebugLocFromInst(Builder, Instr);
1907
1908   // Find all of the vectorized parameters.
1909   for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
1910     Value *SrcOp = Instr->getOperand(op);
1911
1912     // If we are accessing the old induction variable, use the new one.
1913     if (SrcOp == OldInduction) {
1914       Params.push_back(getVectorValue(SrcOp));
1915       continue;
1916     }
1917
1918     // Try using previously calculated values.
1919     Instruction *SrcInst = dyn_cast<Instruction>(SrcOp);
1920
1921     // If the src is an instruction that appeared earlier in the basic block
1922     // then it should already be vectorized.
1923     if (SrcInst && OrigLoop->contains(SrcInst)) {
1924       assert(WidenMap.has(SrcInst) && "Source operand is unavailable");
1925       // The parameter is a vector value from earlier.
1926       Params.push_back(WidenMap.get(SrcInst));
1927     } else {
1928       // The parameter is a scalar from outside the loop. Maybe even a constant.
1929       VectorParts Scalars;
1930       Scalars.append(UF, SrcOp);
1931       Params.push_back(Scalars);
1932     }
1933   }
1934
1935   assert(Params.size() == Instr->getNumOperands() &&
1936          "Invalid number of operands");
1937
1938   // Does this instruction return a value ?
1939   bool IsVoidRetTy = Instr->getType()->isVoidTy();
1940
1941   Value *UndefVec = IsVoidRetTy ? nullptr :
1942     UndefValue::get(VectorType::get(Instr->getType(), VF));
1943   // Create a new entry in the WidenMap and initialize it to Undef or Null.
1944   VectorParts &VecResults = WidenMap.splat(Instr, UndefVec);
1945
1946   Instruction *InsertPt = Builder.GetInsertPoint();
1947   BasicBlock *IfBlock = Builder.GetInsertBlock();
1948   BasicBlock *CondBlock = nullptr;
1949
1950   VectorParts Cond;
1951   Loop *VectorLp = nullptr;
1952   if (IfPredicateStore) {
1953     assert(Instr->getParent()->getSinglePredecessor() &&
1954            "Only support single predecessor blocks");
1955     Cond = createEdgeMask(Instr->getParent()->getSinglePredecessor(),
1956                           Instr->getParent());
1957     VectorLp = LI->getLoopFor(IfBlock);
1958     assert(VectorLp && "Must have a loop for this block");
1959   }
1960
1961   // For each vector unroll 'part':
1962   for (unsigned Part = 0; Part < UF; ++Part) {
1963     // For each scalar that we create:
1964     for (unsigned Width = 0; Width < VF; ++Width) {
1965
1966       // Start if-block.
1967       Value *Cmp = nullptr;
1968       if (IfPredicateStore) {
1969         Cmp = Builder.CreateExtractElement(Cond[Part], Builder.getInt32(Width));
1970         Cmp = Builder.CreateICmp(ICmpInst::ICMP_EQ, Cmp, ConstantInt::get(Cmp->getType(), 1));
1971         CondBlock = IfBlock->splitBasicBlock(InsertPt, "cond.store");
1972         LoopVectorBody.push_back(CondBlock);
1973         VectorLp->addBasicBlockToLoop(CondBlock, LI->getBase());
1974         // Update Builder with newly created basic block.
1975         Builder.SetInsertPoint(InsertPt);
1976       }
1977
1978       Instruction *Cloned = Instr->clone();
1979       if (!IsVoidRetTy)
1980         Cloned->setName(Instr->getName() + ".cloned");
1981       // Replace the operands of the cloned instructions with extracted scalars.
1982       for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
1983         Value *Op = Params[op][Part];
1984         // Param is a vector. Need to extract the right lane.
1985         if (Op->getType()->isVectorTy())
1986           Op = Builder.CreateExtractElement(Op, Builder.getInt32(Width));
1987         Cloned->setOperand(op, Op);
1988       }
1989
1990       // Place the cloned scalar in the new loop.
1991       Builder.Insert(Cloned);
1992
1993       // If the original scalar returns a value we need to place it in a vector
1994       // so that future users will be able to use it.
1995       if (!IsVoidRetTy)
1996         VecResults[Part] = Builder.CreateInsertElement(VecResults[Part], Cloned,
1997                                                        Builder.getInt32(Width));
1998       // End if-block.
1999       if (IfPredicateStore) {
2000          BasicBlock *NewIfBlock = CondBlock->splitBasicBlock(InsertPt, "else");
2001          LoopVectorBody.push_back(NewIfBlock);
2002          VectorLp->addBasicBlockToLoop(NewIfBlock, LI->getBase());
2003          Builder.SetInsertPoint(InsertPt);
2004          Instruction *OldBr = IfBlock->getTerminator();
2005          BranchInst::Create(CondBlock, NewIfBlock, Cmp, OldBr);
2006          OldBr->eraseFromParent();
2007          IfBlock = NewIfBlock;
2008       }
2009     }
2010   }
2011 }
2012
2013 static Instruction *getFirstInst(Instruction *FirstInst, Value *V,
2014                                  Instruction *Loc) {
2015   if (FirstInst)
2016     return FirstInst;
2017   if (Instruction *I = dyn_cast<Instruction>(V))
2018     return I->getParent() == Loc->getParent() ? I : nullptr;
2019   return nullptr;
2020 }
2021
2022 std::pair<Instruction *, Instruction *>
2023 InnerLoopVectorizer::addStrideCheck(Instruction *Loc) {
2024   Instruction *tnullptr = nullptr;
2025   if (!Legal->mustCheckStrides())
2026     return std::pair<Instruction *, Instruction *>(tnullptr, tnullptr);
2027
2028   IRBuilder<> ChkBuilder(Loc);
2029
2030   // Emit checks.
2031   Value *Check = nullptr;
2032   Instruction *FirstInst = nullptr;
2033   for (SmallPtrSet<Value *, 8>::iterator SI = Legal->strides_begin(),
2034                                          SE = Legal->strides_end();
2035        SI != SE; ++SI) {
2036     Value *Ptr = stripIntegerCast(*SI);
2037     Value *C = ChkBuilder.CreateICmpNE(Ptr, ConstantInt::get(Ptr->getType(), 1),
2038                                        "stride.chk");
2039     // Store the first instruction we create.
2040     FirstInst = getFirstInst(FirstInst, C, Loc);
2041     if (Check)
2042       Check = ChkBuilder.CreateOr(Check, C);
2043     else
2044       Check = C;
2045   }
2046
2047   // We have to do this trickery because the IRBuilder might fold the check to a
2048   // constant expression in which case there is no Instruction anchored in a
2049   // the block.
2050   LLVMContext &Ctx = Loc->getContext();
2051   Instruction *TheCheck =
2052       BinaryOperator::CreateAnd(Check, ConstantInt::getTrue(Ctx));
2053   ChkBuilder.Insert(TheCheck, "stride.not.one");
2054   FirstInst = getFirstInst(FirstInst, TheCheck, Loc);
2055
2056   return std::make_pair(FirstInst, TheCheck);
2057 }
2058
2059 std::pair<Instruction *, Instruction *>
2060 InnerLoopVectorizer::addRuntimeCheck(Instruction *Loc) {
2061   LoopVectorizationLegality::RuntimePointerCheck *PtrRtCheck =
2062   Legal->getRuntimePointerCheck();
2063
2064   Instruction *tnullptr = nullptr;
2065   if (!PtrRtCheck->Need)
2066     return std::pair<Instruction *, Instruction *>(tnullptr, tnullptr);
2067
2068   unsigned NumPointers = PtrRtCheck->Pointers.size();
2069   SmallVector<TrackingVH<Value> , 2> Starts;
2070   SmallVector<TrackingVH<Value> , 2> Ends;
2071
2072   LLVMContext &Ctx = Loc->getContext();
2073   SCEVExpander Exp(*SE, "induction");
2074   Instruction *FirstInst = nullptr;
2075
2076   for (unsigned i = 0; i < NumPointers; ++i) {
2077     Value *Ptr = PtrRtCheck->Pointers[i];
2078     const SCEV *Sc = SE->getSCEV(Ptr);
2079
2080     if (SE->isLoopInvariant(Sc, OrigLoop)) {
2081       DEBUG(dbgs() << "LV: Adding RT check for a loop invariant ptr:" <<
2082             *Ptr <<"\n");
2083       Starts.push_back(Ptr);
2084       Ends.push_back(Ptr);
2085     } else {
2086       DEBUG(dbgs() << "LV: Adding RT check for range:" << *Ptr << '\n');
2087       unsigned AS = Ptr->getType()->getPointerAddressSpace();
2088
2089       // Use this type for pointer arithmetic.
2090       Type *PtrArithTy = Type::getInt8PtrTy(Ctx, AS);
2091
2092       Value *Start = Exp.expandCodeFor(PtrRtCheck->Starts[i], PtrArithTy, Loc);
2093       Value *End = Exp.expandCodeFor(PtrRtCheck->Ends[i], PtrArithTy, Loc);
2094       Starts.push_back(Start);
2095       Ends.push_back(End);
2096     }
2097   }
2098
2099   IRBuilder<> ChkBuilder(Loc);
2100   // Our instructions might fold to a constant.
2101   Value *MemoryRuntimeCheck = nullptr;
2102   for (unsigned i = 0; i < NumPointers; ++i) {
2103     for (unsigned j = i+1; j < NumPointers; ++j) {
2104       // No need to check if two readonly pointers intersect.
2105       if (!PtrRtCheck->IsWritePtr[i] && !PtrRtCheck->IsWritePtr[j])
2106         continue;
2107
2108       // Only need to check pointers between two different dependency sets.
2109       if (PtrRtCheck->DependencySetId[i] == PtrRtCheck->DependencySetId[j])
2110        continue;
2111       // Only need to check pointers in the same alias set.
2112       if (PtrRtCheck->AliasSetId[i] != PtrRtCheck->AliasSetId[j])
2113         continue;
2114
2115       unsigned AS0 = Starts[i]->getType()->getPointerAddressSpace();
2116       unsigned AS1 = Starts[j]->getType()->getPointerAddressSpace();
2117
2118       assert((AS0 == Ends[j]->getType()->getPointerAddressSpace()) &&
2119              (AS1 == Ends[i]->getType()->getPointerAddressSpace()) &&
2120              "Trying to bounds check pointers with different address spaces");
2121
2122       Type *PtrArithTy0 = Type::getInt8PtrTy(Ctx, AS0);
2123       Type *PtrArithTy1 = Type::getInt8PtrTy(Ctx, AS1);
2124
2125       Value *Start0 = ChkBuilder.CreateBitCast(Starts[i], PtrArithTy0, "bc");
2126       Value *Start1 = ChkBuilder.CreateBitCast(Starts[j], PtrArithTy1, "bc");
2127       Value *End0 =   ChkBuilder.CreateBitCast(Ends[i],   PtrArithTy1, "bc");
2128       Value *End1 =   ChkBuilder.CreateBitCast(Ends[j],   PtrArithTy0, "bc");
2129
2130       Value *Cmp0 = ChkBuilder.CreateICmpULE(Start0, End1, "bound0");
2131       FirstInst = getFirstInst(FirstInst, Cmp0, Loc);
2132       Value *Cmp1 = ChkBuilder.CreateICmpULE(Start1, End0, "bound1");
2133       FirstInst = getFirstInst(FirstInst, Cmp1, Loc);
2134       Value *IsConflict = ChkBuilder.CreateAnd(Cmp0, Cmp1, "found.conflict");
2135       FirstInst = getFirstInst(FirstInst, IsConflict, Loc);
2136       if (MemoryRuntimeCheck) {
2137         IsConflict = ChkBuilder.CreateOr(MemoryRuntimeCheck, IsConflict,
2138                                          "conflict.rdx");
2139         FirstInst = getFirstInst(FirstInst, IsConflict, Loc);
2140       }
2141       MemoryRuntimeCheck = IsConflict;
2142     }
2143   }
2144
2145   // We have to do this trickery because the IRBuilder might fold the check to a
2146   // constant expression in which case there is no Instruction anchored in a
2147   // the block.
2148   Instruction *Check = BinaryOperator::CreateAnd(MemoryRuntimeCheck,
2149                                                  ConstantInt::getTrue(Ctx));
2150   ChkBuilder.Insert(Check, "memcheck.conflict");
2151   FirstInst = getFirstInst(FirstInst, Check, Loc);
2152   return std::make_pair(FirstInst, Check);
2153 }
2154
2155 void InnerLoopVectorizer::createEmptyLoop() {
2156   /*
2157    In this function we generate a new loop. The new loop will contain
2158    the vectorized instructions while the old loop will continue to run the
2159    scalar remainder.
2160
2161        [ ] <-- Back-edge taken count overflow check.
2162     /   |
2163    /    v
2164   |    [ ] <-- vector loop bypass (may consist of multiple blocks).
2165   |  /  |
2166   | /   v
2167   ||   [ ]     <-- vector pre header.
2168   ||    |
2169   ||    v
2170   ||   [  ] \
2171   ||   [  ]_|   <-- vector loop.
2172   ||    |
2173   | \   v
2174   |   >[ ]   <--- middle-block.
2175   |  /  |
2176   | /   v
2177   -|- >[ ]     <--- new preheader.
2178    |    |
2179    |    v
2180    |   [ ] \
2181    |   [ ]_|   <-- old scalar loop to handle remainder.
2182     \   |
2183      \  v
2184       >[ ]     <-- exit block.
2185    ...
2186    */
2187
2188   BasicBlock *OldBasicBlock = OrigLoop->getHeader();
2189   BasicBlock *BypassBlock = OrigLoop->getLoopPreheader();
2190   BasicBlock *ExitBlock = OrigLoop->getExitBlock();
2191   assert(BypassBlock && "Invalid loop structure");
2192   assert(ExitBlock && "Must have an exit block");
2193
2194   // Some loops have a single integer induction variable, while other loops
2195   // don't. One example is c++ iterators that often have multiple pointer
2196   // induction variables. In the code below we also support a case where we
2197   // don't have a single induction variable.
2198   OldInduction = Legal->getInduction();
2199   Type *IdxTy = Legal->getWidestInductionType();
2200
2201   // Find the loop boundaries.
2202   const SCEV *ExitCount = SE->getBackedgeTakenCount(OrigLoop);
2203   assert(ExitCount != SE->getCouldNotCompute() && "Invalid loop count");
2204
2205   // The exit count might have the type of i64 while the phi is i32. This can
2206   // happen if we have an induction variable that is sign extended before the
2207   // compare. The only way that we get a backedge taken count is that the
2208   // induction variable was signed and as such will not overflow. In such a case
2209   // truncation is legal.
2210   if (ExitCount->getType()->getPrimitiveSizeInBits() >
2211       IdxTy->getPrimitiveSizeInBits())
2212     ExitCount = SE->getTruncateOrNoop(ExitCount, IdxTy);
2213
2214   const SCEV *BackedgeTakeCount = SE->getNoopOrZeroExtend(ExitCount, IdxTy);
2215   // Get the total trip count from the count by adding 1.
2216   ExitCount = SE->getAddExpr(BackedgeTakeCount,
2217                              SE->getConstant(BackedgeTakeCount->getType(), 1));
2218
2219   // Expand the trip count and place the new instructions in the preheader.
2220   // Notice that the pre-header does not change, only the loop body.
2221   SCEVExpander Exp(*SE, "induction");
2222
2223   // We need to test whether the backedge-taken count is uint##_max. Adding one
2224   // to it will cause overflow and an incorrect loop trip count in the vector
2225   // body. In case of overflow we want to directly jump to the scalar remainder
2226   // loop.
2227   Value *BackedgeCount =
2228       Exp.expandCodeFor(BackedgeTakeCount, BackedgeTakeCount->getType(),
2229                         BypassBlock->getTerminator());
2230   if (BackedgeCount->getType()->isPointerTy())
2231     BackedgeCount = CastInst::CreatePointerCast(BackedgeCount, IdxTy,
2232                                                 "backedge.ptrcnt.to.int",
2233                                                 BypassBlock->getTerminator());
2234   Instruction *CheckBCOverflow =
2235       CmpInst::Create(Instruction::ICmp, CmpInst::ICMP_EQ, BackedgeCount,
2236                       Constant::getAllOnesValue(BackedgeCount->getType()),
2237                       "backedge.overflow", BypassBlock->getTerminator());
2238
2239   // The loop index does not have to start at Zero. Find the original start
2240   // value from the induction PHI node. If we don't have an induction variable
2241   // then we know that it starts at zero.
2242   Builder.SetInsertPoint(BypassBlock->getTerminator());
2243   Value *StartIdx = ExtendedIdx = OldInduction ?
2244     Builder.CreateZExt(OldInduction->getIncomingValueForBlock(BypassBlock),
2245                        IdxTy):
2246     ConstantInt::get(IdxTy, 0);
2247
2248   // We need an instruction to anchor the overflow check on. StartIdx needs to
2249   // be defined before the overflow check branch. Because the scalar preheader
2250   // is going to merge the start index and so the overflow branch block needs to
2251   // contain a definition of the start index.
2252   Instruction *OverflowCheckAnchor = BinaryOperator::CreateAdd(
2253       StartIdx, ConstantInt::get(IdxTy, 0), "overflow.check.anchor",
2254       BypassBlock->getTerminator());
2255
2256   // Count holds the overall loop count (N).
2257   Value *Count = Exp.expandCodeFor(ExitCount, ExitCount->getType(),
2258                                    BypassBlock->getTerminator());
2259
2260   LoopBypassBlocks.push_back(BypassBlock);
2261
2262   // Split the single block loop into the two loop structure described above.
2263   BasicBlock *VectorPH =
2264   BypassBlock->splitBasicBlock(BypassBlock->getTerminator(), "vector.ph");
2265   BasicBlock *VecBody =
2266   VectorPH->splitBasicBlock(VectorPH->getTerminator(), "vector.body");
2267   BasicBlock *MiddleBlock =
2268   VecBody->splitBasicBlock(VecBody->getTerminator(), "middle.block");
2269   BasicBlock *ScalarPH =
2270   MiddleBlock->splitBasicBlock(MiddleBlock->getTerminator(), "scalar.ph");
2271
2272   // Create and register the new vector loop.
2273   Loop* Lp = new Loop();
2274   Loop *ParentLoop = OrigLoop->getParentLoop();
2275
2276   // Insert the new loop into the loop nest and register the new basic blocks
2277   // before calling any utilities such as SCEV that require valid LoopInfo.
2278   if (ParentLoop) {
2279     ParentLoop->addChildLoop(Lp);
2280     ParentLoop->addBasicBlockToLoop(ScalarPH, LI->getBase());
2281     ParentLoop->addBasicBlockToLoop(VectorPH, LI->getBase());
2282     ParentLoop->addBasicBlockToLoop(MiddleBlock, LI->getBase());
2283   } else {
2284     LI->addTopLevelLoop(Lp);
2285   }
2286   Lp->addBasicBlockToLoop(VecBody, LI->getBase());
2287
2288   // Use this IR builder to create the loop instructions (Phi, Br, Cmp)
2289   // inside the loop.
2290   Builder.SetInsertPoint(VecBody->getFirstNonPHI());
2291
2292   // Generate the induction variable.
2293   setDebugLocFromInst(Builder, getDebugLocFromInstOrOperands(OldInduction));
2294   Induction = Builder.CreatePHI(IdxTy, 2, "index");
2295   // The loop step is equal to the vectorization factor (num of SIMD elements)
2296   // times the unroll factor (num of SIMD instructions).
2297   Constant *Step = ConstantInt::get(IdxTy, VF * UF);
2298
2299   // This is the IR builder that we use to add all of the logic for bypassing
2300   // the new vector loop.
2301   IRBuilder<> BypassBuilder(BypassBlock->getTerminator());
2302   setDebugLocFromInst(BypassBuilder,
2303                       getDebugLocFromInstOrOperands(OldInduction));
2304
2305   // We may need to extend the index in case there is a type mismatch.
2306   // We know that the count starts at zero and does not overflow.
2307   if (Count->getType() != IdxTy) {
2308     // The exit count can be of pointer type. Convert it to the correct
2309     // integer type.
2310     if (ExitCount->getType()->isPointerTy())
2311       Count = BypassBuilder.CreatePointerCast(Count, IdxTy, "ptrcnt.to.int");
2312     else
2313       Count = BypassBuilder.CreateZExtOrTrunc(Count, IdxTy, "cnt.cast");
2314   }
2315
2316   // Add the start index to the loop count to get the new end index.
2317   Value *IdxEnd = BypassBuilder.CreateAdd(Count, StartIdx, "end.idx");
2318
2319   // Now we need to generate the expression for N - (N % VF), which is
2320   // the part that the vectorized body will execute.
2321   Value *R = BypassBuilder.CreateURem(Count, Step, "n.mod.vf");
2322   Value *CountRoundDown = BypassBuilder.CreateSub(Count, R, "n.vec");
2323   Value *IdxEndRoundDown = BypassBuilder.CreateAdd(CountRoundDown, StartIdx,
2324                                                      "end.idx.rnd.down");
2325
2326   // Now, compare the new count to zero. If it is zero skip the vector loop and
2327   // jump to the scalar loop.
2328   Value *Cmp =
2329       BypassBuilder.CreateICmpEQ(IdxEndRoundDown, StartIdx, "cmp.zero");
2330
2331   BasicBlock *LastBypassBlock = BypassBlock;
2332
2333   // Generate code to check that the loops trip count that we computed by adding
2334   // one to the backedge-taken count will not overflow.
2335   {
2336     auto PastOverflowCheck =
2337         std::next(BasicBlock::iterator(OverflowCheckAnchor));
2338     BasicBlock *CheckBlock =
2339       LastBypassBlock->splitBasicBlock(PastOverflowCheck, "overflow.checked");
2340     if (ParentLoop)
2341       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
2342     LoopBypassBlocks.push_back(CheckBlock);
2343     Instruction *OldTerm = LastBypassBlock->getTerminator();
2344     BranchInst::Create(ScalarPH, CheckBlock, CheckBCOverflow, OldTerm);
2345     OldTerm->eraseFromParent();
2346     LastBypassBlock = CheckBlock;
2347   }
2348
2349   // Generate the code to check that the strides we assumed to be one are really
2350   // one. We want the new basic block to start at the first instruction in a
2351   // sequence of instructions that form a check.
2352   Instruction *StrideCheck;
2353   Instruction *FirstCheckInst;
2354   std::tie(FirstCheckInst, StrideCheck) =
2355       addStrideCheck(LastBypassBlock->getTerminator());
2356   if (StrideCheck) {
2357     // Create a new block containing the stride check.
2358     BasicBlock *CheckBlock =
2359         LastBypassBlock->splitBasicBlock(FirstCheckInst, "vector.stridecheck");
2360     if (ParentLoop)
2361       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
2362     LoopBypassBlocks.push_back(CheckBlock);
2363
2364     // Replace the branch into the memory check block with a conditional branch
2365     // for the "few elements case".
2366     Instruction *OldTerm = LastBypassBlock->getTerminator();
2367     BranchInst::Create(MiddleBlock, CheckBlock, Cmp, OldTerm);
2368     OldTerm->eraseFromParent();
2369
2370     Cmp = StrideCheck;
2371     LastBypassBlock = CheckBlock;
2372   }
2373
2374   // Generate the code that checks in runtime if arrays overlap. We put the
2375   // checks into a separate block to make the more common case of few elements
2376   // faster.
2377   Instruction *MemRuntimeCheck;
2378   std::tie(FirstCheckInst, MemRuntimeCheck) =
2379       addRuntimeCheck(LastBypassBlock->getTerminator());
2380   if (MemRuntimeCheck) {
2381     // Create a new block containing the memory check.
2382     BasicBlock *CheckBlock =
2383         LastBypassBlock->splitBasicBlock(MemRuntimeCheck, "vector.memcheck");
2384     if (ParentLoop)
2385       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
2386     LoopBypassBlocks.push_back(CheckBlock);
2387
2388     // Replace the branch into the memory check block with a conditional branch
2389     // for the "few elements case".
2390     Instruction *OldTerm = LastBypassBlock->getTerminator();
2391     BranchInst::Create(MiddleBlock, CheckBlock, Cmp, OldTerm);
2392     OldTerm->eraseFromParent();
2393
2394     Cmp = MemRuntimeCheck;
2395     LastBypassBlock = CheckBlock;
2396   }
2397
2398   LastBypassBlock->getTerminator()->eraseFromParent();
2399   BranchInst::Create(MiddleBlock, VectorPH, Cmp,
2400                      LastBypassBlock);
2401
2402   // We are going to resume the execution of the scalar loop.
2403   // Go over all of the induction variables that we found and fix the
2404   // PHIs that are left in the scalar version of the loop.
2405   // The starting values of PHI nodes depend on the counter of the last
2406   // iteration in the vectorized loop.
2407   // If we come from a bypass edge then we need to start from the original
2408   // start value.
2409
2410   // This variable saves the new starting index for the scalar loop.
2411   PHINode *ResumeIndex = nullptr;
2412   LoopVectorizationLegality::InductionList::iterator I, E;
2413   LoopVectorizationLegality::InductionList *List = Legal->getInductionVars();
2414   // Set builder to point to last bypass block.
2415   BypassBuilder.SetInsertPoint(LoopBypassBlocks.back()->getTerminator());
2416   for (I = List->begin(), E = List->end(); I != E; ++I) {
2417     PHINode *OrigPhi = I->first;
2418     LoopVectorizationLegality::InductionInfo II = I->second;
2419
2420     Type *ResumeValTy = (OrigPhi == OldInduction) ? IdxTy : OrigPhi->getType();
2421     PHINode *ResumeVal = PHINode::Create(ResumeValTy, 2, "resume.val",
2422                                          MiddleBlock->getTerminator());
2423     // We might have extended the type of the induction variable but we need a
2424     // truncated version for the scalar loop.
2425     PHINode *TruncResumeVal = (OrigPhi == OldInduction) ?
2426       PHINode::Create(OrigPhi->getType(), 2, "trunc.resume.val",
2427                       MiddleBlock->getTerminator()) : nullptr;
2428
2429     // Create phi nodes to merge from the  backedge-taken check block.
2430     PHINode *BCResumeVal = PHINode::Create(ResumeValTy, 3, "bc.resume.val",
2431                                            ScalarPH->getTerminator());
2432     BCResumeVal->addIncoming(ResumeVal, MiddleBlock);
2433
2434     PHINode *BCTruncResumeVal = nullptr;
2435     if (OrigPhi == OldInduction) {
2436       BCTruncResumeVal =
2437           PHINode::Create(OrigPhi->getType(), 2, "bc.trunc.resume.val",
2438                           ScalarPH->getTerminator());
2439       BCTruncResumeVal->addIncoming(TruncResumeVal, MiddleBlock);
2440     }
2441
2442     Value *EndValue = nullptr;
2443     switch (II.IK) {
2444     case LoopVectorizationLegality::IK_NoInduction:
2445       llvm_unreachable("Unknown induction");
2446     case LoopVectorizationLegality::IK_IntInduction: {
2447       // Handle the integer induction counter.
2448       assert(OrigPhi->getType()->isIntegerTy() && "Invalid type");
2449
2450       // We have the canonical induction variable.
2451       if (OrigPhi == OldInduction) {
2452         // Create a truncated version of the resume value for the scalar loop,
2453         // we might have promoted the type to a larger width.
2454         EndValue =
2455           BypassBuilder.CreateTrunc(IdxEndRoundDown, OrigPhi->getType());
2456         // The new PHI merges the original incoming value, in case of a bypass,
2457         // or the value at the end of the vectorized loop.
2458         for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2459           TruncResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[I]);
2460         TruncResumeVal->addIncoming(EndValue, VecBody);
2461
2462         BCTruncResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[0]);
2463
2464         // We know what the end value is.
2465         EndValue = IdxEndRoundDown;
2466         // We also know which PHI node holds it.
2467         ResumeIndex = ResumeVal;
2468         break;
2469       }
2470
2471       // Not the canonical induction variable - add the vector loop count to the
2472       // start value.
2473       Value *CRD = BypassBuilder.CreateSExtOrTrunc(CountRoundDown,
2474                                                    II.StartValue->getType(),
2475                                                    "cast.crd");
2476       EndValue = BypassBuilder.CreateAdd(CRD, II.StartValue , "ind.end");
2477       break;
2478     }
2479     case LoopVectorizationLegality::IK_ReverseIntInduction: {
2480       // Convert the CountRoundDown variable to the PHI size.
2481       Value *CRD = BypassBuilder.CreateSExtOrTrunc(CountRoundDown,
2482                                                    II.StartValue->getType(),
2483                                                    "cast.crd");
2484       // Handle reverse integer induction counter.
2485       EndValue = BypassBuilder.CreateSub(II.StartValue, CRD, "rev.ind.end");
2486       break;
2487     }
2488     case LoopVectorizationLegality::IK_PtrInduction: {
2489       // For pointer induction variables, calculate the offset using
2490       // the end index.
2491       EndValue = BypassBuilder.CreateGEP(II.StartValue, CountRoundDown,
2492                                          "ptr.ind.end");
2493       break;
2494     }
2495     case LoopVectorizationLegality::IK_ReversePtrInduction: {
2496       // The value at the end of the loop for the reverse pointer is calculated
2497       // by creating a GEP with a negative index starting from the start value.
2498       Value *Zero = ConstantInt::get(CountRoundDown->getType(), 0);
2499       Value *NegIdx = BypassBuilder.CreateSub(Zero, CountRoundDown,
2500                                               "rev.ind.end");
2501       EndValue = BypassBuilder.CreateGEP(II.StartValue, NegIdx,
2502                                          "rev.ptr.ind.end");
2503       break;
2504     }
2505     }// end of case
2506
2507     // The new PHI merges the original incoming value, in case of a bypass,
2508     // or the value at the end of the vectorized loop.
2509     for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I) {
2510       if (OrigPhi == OldInduction)
2511         ResumeVal->addIncoming(StartIdx, LoopBypassBlocks[I]);
2512       else
2513         ResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[I]);
2514     }
2515     ResumeVal->addIncoming(EndValue, VecBody);
2516
2517     // Fix the scalar body counter (PHI node).
2518     unsigned BlockIdx = OrigPhi->getBasicBlockIndex(ScalarPH);
2519
2520     // The old induction's phi node in the scalar body needs the truncated
2521     // value.
2522     if (OrigPhi == OldInduction) {
2523       BCResumeVal->addIncoming(StartIdx, LoopBypassBlocks[0]);
2524       OrigPhi->setIncomingValue(BlockIdx, BCTruncResumeVal);
2525     } else {
2526       BCResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[0]);
2527       OrigPhi->setIncomingValue(BlockIdx, BCResumeVal);
2528     }
2529   }
2530
2531   // If we are generating a new induction variable then we also need to
2532   // generate the code that calculates the exit value. This value is not
2533   // simply the end of the counter because we may skip the vectorized body
2534   // in case of a runtime check.
2535   if (!OldInduction){
2536     assert(!ResumeIndex && "Unexpected resume value found");
2537     ResumeIndex = PHINode::Create(IdxTy, 2, "new.indc.resume.val",
2538                                   MiddleBlock->getTerminator());
2539     for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2540       ResumeIndex->addIncoming(StartIdx, LoopBypassBlocks[I]);
2541     ResumeIndex->addIncoming(IdxEndRoundDown, VecBody);
2542   }
2543
2544   // Make sure that we found the index where scalar loop needs to continue.
2545   assert(ResumeIndex && ResumeIndex->getType()->isIntegerTy() &&
2546          "Invalid resume Index");
2547
2548   // Add a check in the middle block to see if we have completed
2549   // all of the iterations in the first vector loop.
2550   // If (N - N%VF) == N, then we *don't* need to run the remainder.
2551   Value *CmpN = CmpInst::Create(Instruction::ICmp, CmpInst::ICMP_EQ, IdxEnd,
2552                                 ResumeIndex, "cmp.n",
2553                                 MiddleBlock->getTerminator());
2554
2555   BranchInst::Create(ExitBlock, ScalarPH, CmpN, MiddleBlock->getTerminator());
2556   // Remove the old terminator.
2557   MiddleBlock->getTerminator()->eraseFromParent();
2558
2559   // Create i+1 and fill the PHINode.
2560   Value *NextIdx = Builder.CreateAdd(Induction, Step, "index.next");
2561   Induction->addIncoming(StartIdx, VectorPH);
2562   Induction->addIncoming(NextIdx, VecBody);
2563   // Create the compare.
2564   Value *ICmp = Builder.CreateICmpEQ(NextIdx, IdxEndRoundDown);
2565   Builder.CreateCondBr(ICmp, MiddleBlock, VecBody);
2566
2567   // Now we have two terminators. Remove the old one from the block.
2568   VecBody->getTerminator()->eraseFromParent();
2569
2570   // Get ready to start creating new instructions into the vectorized body.
2571   Builder.SetInsertPoint(VecBody->getFirstInsertionPt());
2572
2573   // Save the state.
2574   LoopVectorPreHeader = VectorPH;
2575   LoopScalarPreHeader = ScalarPH;
2576   LoopMiddleBlock = MiddleBlock;
2577   LoopExitBlock = ExitBlock;
2578   LoopVectorBody.push_back(VecBody);
2579   LoopScalarBody = OldBasicBlock;
2580
2581   LoopVectorizeHints Hints(Lp, true);
2582   Hints.setAlreadyVectorized();
2583 }
2584
2585 /// This function returns the identity element (or neutral element) for
2586 /// the operation K.
2587 Constant*
2588 LoopVectorizationLegality::getReductionIdentity(ReductionKind K, Type *Tp) {
2589   switch (K) {
2590   case RK_IntegerXor:
2591   case RK_IntegerAdd:
2592   case RK_IntegerOr:
2593     // Adding, Xoring, Oring zero to a number does not change it.
2594     return ConstantInt::get(Tp, 0);
2595   case RK_IntegerMult:
2596     // Multiplying a number by 1 does not change it.
2597     return ConstantInt::get(Tp, 1);
2598   case RK_IntegerAnd:
2599     // AND-ing a number with an all-1 value does not change it.
2600     return ConstantInt::get(Tp, -1, true);
2601   case  RK_FloatMult:
2602     // Multiplying a number by 1 does not change it.
2603     return ConstantFP::get(Tp, 1.0L);
2604   case  RK_FloatAdd:
2605     // Adding zero to a number does not change it.
2606     return ConstantFP::get(Tp, 0.0L);
2607   default:
2608     llvm_unreachable("Unknown reduction kind");
2609   }
2610 }
2611
2612 /// This function translates the reduction kind to an LLVM binary operator.
2613 static unsigned
2614 getReductionBinOp(LoopVectorizationLegality::ReductionKind Kind) {
2615   switch (Kind) {
2616     case LoopVectorizationLegality::RK_IntegerAdd:
2617       return Instruction::Add;
2618     case LoopVectorizationLegality::RK_IntegerMult:
2619       return Instruction::Mul;
2620     case LoopVectorizationLegality::RK_IntegerOr:
2621       return Instruction::Or;
2622     case LoopVectorizationLegality::RK_IntegerAnd:
2623       return Instruction::And;
2624     case LoopVectorizationLegality::RK_IntegerXor:
2625       return Instruction::Xor;
2626     case LoopVectorizationLegality::RK_FloatMult:
2627       return Instruction::FMul;
2628     case LoopVectorizationLegality::RK_FloatAdd:
2629       return Instruction::FAdd;
2630     case LoopVectorizationLegality::RK_IntegerMinMax:
2631       return Instruction::ICmp;
2632     case LoopVectorizationLegality::RK_FloatMinMax:
2633       return Instruction::FCmp;
2634     default:
2635       llvm_unreachable("Unknown reduction operation");
2636   }
2637 }
2638
2639 Value *createMinMaxOp(IRBuilder<> &Builder,
2640                       LoopVectorizationLegality::MinMaxReductionKind RK,
2641                       Value *Left,
2642                       Value *Right) {
2643   CmpInst::Predicate P = CmpInst::ICMP_NE;
2644   switch (RK) {
2645   default:
2646     llvm_unreachable("Unknown min/max reduction kind");
2647   case LoopVectorizationLegality::MRK_UIntMin:
2648     P = CmpInst::ICMP_ULT;
2649     break;
2650   case LoopVectorizationLegality::MRK_UIntMax:
2651     P = CmpInst::ICMP_UGT;
2652     break;
2653   case LoopVectorizationLegality::MRK_SIntMin:
2654     P = CmpInst::ICMP_SLT;
2655     break;
2656   case LoopVectorizationLegality::MRK_SIntMax:
2657     P = CmpInst::ICMP_SGT;
2658     break;
2659   case LoopVectorizationLegality::MRK_FloatMin:
2660     P = CmpInst::FCMP_OLT;
2661     break;
2662   case LoopVectorizationLegality::MRK_FloatMax:
2663     P = CmpInst::FCMP_OGT;
2664     break;
2665   }
2666
2667   Value *Cmp;
2668   if (RK == LoopVectorizationLegality::MRK_FloatMin ||
2669       RK == LoopVectorizationLegality::MRK_FloatMax)
2670     Cmp = Builder.CreateFCmp(P, Left, Right, "rdx.minmax.cmp");
2671   else
2672     Cmp = Builder.CreateICmp(P, Left, Right, "rdx.minmax.cmp");
2673
2674   Value *Select = Builder.CreateSelect(Cmp, Left, Right, "rdx.minmax.select");
2675   return Select;
2676 }
2677
2678 namespace {
2679 struct CSEDenseMapInfo {
2680   static bool canHandle(Instruction *I) {
2681     return isa<InsertElementInst>(I) || isa<ExtractElementInst>(I) ||
2682            isa<ShuffleVectorInst>(I) || isa<GetElementPtrInst>(I);
2683   }
2684   static inline Instruction *getEmptyKey() {
2685     return DenseMapInfo<Instruction *>::getEmptyKey();
2686   }
2687   static inline Instruction *getTombstoneKey() {
2688     return DenseMapInfo<Instruction *>::getTombstoneKey();
2689   }
2690   static unsigned getHashValue(Instruction *I) {
2691     assert(canHandle(I) && "Unknown instruction!");
2692     return hash_combine(I->getOpcode(), hash_combine_range(I->value_op_begin(),
2693                                                            I->value_op_end()));
2694   }
2695   static bool isEqual(Instruction *LHS, Instruction *RHS) {
2696     if (LHS == getEmptyKey() || RHS == getEmptyKey() ||
2697         LHS == getTombstoneKey() || RHS == getTombstoneKey())
2698       return LHS == RHS;
2699     return LHS->isIdenticalTo(RHS);
2700   }
2701 };
2702 }
2703
2704 /// \brief Check whether this block is a predicated block.
2705 /// Due to if predication of stores we might create a sequence of "if(pred) a[i]
2706 /// = ...;  " blocks. We start with one vectorized basic block. For every
2707 /// conditional block we split this vectorized block. Therefore, every second
2708 /// block will be a predicated one.
2709 static bool isPredicatedBlock(unsigned BlockNum) {
2710   return BlockNum % 2;
2711 }
2712
2713 ///\brief Perform cse of induction variable instructions.
2714 static void cse(SmallVector<BasicBlock *, 4> &BBs) {
2715   // Perform simple cse.
2716   SmallDenseMap<Instruction *, Instruction *, 4, CSEDenseMapInfo> CSEMap;
2717   for (unsigned i = 0, e = BBs.size(); i != e; ++i) {
2718     BasicBlock *BB = BBs[i];
2719     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;) {
2720       Instruction *In = I++;
2721
2722       if (!CSEDenseMapInfo::canHandle(In))
2723         continue;
2724
2725       // Check if we can replace this instruction with any of the
2726       // visited instructions.
2727       if (Instruction *V = CSEMap.lookup(In)) {
2728         In->replaceAllUsesWith(V);
2729         In->eraseFromParent();
2730         continue;
2731       }
2732       // Ignore instructions in conditional blocks. We create "if (pred) a[i] =
2733       // ...;" blocks for predicated stores. Every second block is a predicated
2734       // block.
2735       if (isPredicatedBlock(i))
2736         continue;
2737
2738       CSEMap[In] = In;
2739     }
2740   }
2741 }
2742
2743 /// \brief Adds a 'fast' flag to floating point operations.
2744 static Value *addFastMathFlag(Value *V) {
2745   if (isa<FPMathOperator>(V)){
2746     FastMathFlags Flags;
2747     Flags.setUnsafeAlgebra();
2748     cast<Instruction>(V)->setFastMathFlags(Flags);
2749   }
2750   return V;
2751 }
2752
2753 void InnerLoopVectorizer::vectorizeLoop() {
2754   //===------------------------------------------------===//
2755   //
2756   // Notice: any optimization or new instruction that go
2757   // into the code below should be also be implemented in
2758   // the cost-model.
2759   //
2760   //===------------------------------------------------===//
2761   Constant *Zero = Builder.getInt32(0);
2762
2763   // In order to support reduction variables we need to be able to vectorize
2764   // Phi nodes. Phi nodes have cycles, so we need to vectorize them in two
2765   // stages. First, we create a new vector PHI node with no incoming edges.
2766   // We use this value when we vectorize all of the instructions that use the
2767   // PHI. Next, after all of the instructions in the block are complete we
2768   // add the new incoming edges to the PHI. At this point all of the
2769   // instructions in the basic block are vectorized, so we can use them to
2770   // construct the PHI.
2771   PhiVector RdxPHIsToFix;
2772
2773   // Scan the loop in a topological order to ensure that defs are vectorized
2774   // before users.
2775   LoopBlocksDFS DFS(OrigLoop);
2776   DFS.perform(LI);
2777
2778   // Vectorize all of the blocks in the original loop.
2779   for (LoopBlocksDFS::RPOIterator bb = DFS.beginRPO(),
2780        be = DFS.endRPO(); bb != be; ++bb)
2781     vectorizeBlockInLoop(*bb, &RdxPHIsToFix);
2782
2783   // At this point every instruction in the original loop is widened to
2784   // a vector form. We are almost done. Now, we need to fix the PHI nodes
2785   // that we vectorized. The PHI nodes are currently empty because we did
2786   // not want to introduce cycles. Notice that the remaining PHI nodes
2787   // that we need to fix are reduction variables.
2788
2789   // Create the 'reduced' values for each of the induction vars.
2790   // The reduced values are the vector values that we scalarize and combine
2791   // after the loop is finished.
2792   for (PhiVector::iterator it = RdxPHIsToFix.begin(), e = RdxPHIsToFix.end();
2793        it != e; ++it) {
2794     PHINode *RdxPhi = *it;
2795     assert(RdxPhi && "Unable to recover vectorized PHI");
2796
2797     // Find the reduction variable descriptor.
2798     assert(Legal->getReductionVars()->count(RdxPhi) &&
2799            "Unable to find the reduction variable");
2800     LoopVectorizationLegality::ReductionDescriptor RdxDesc =
2801     (*Legal->getReductionVars())[RdxPhi];
2802
2803     setDebugLocFromInst(Builder, RdxDesc.StartValue);
2804
2805     // We need to generate a reduction vector from the incoming scalar.
2806     // To do so, we need to generate the 'identity' vector and override
2807     // one of the elements with the incoming scalar reduction. We need
2808     // to do it in the vector-loop preheader.
2809     Builder.SetInsertPoint(LoopBypassBlocks[1]->getTerminator());
2810
2811     // This is the vector-clone of the value that leaves the loop.
2812     VectorParts &VectorExit = getVectorValue(RdxDesc.LoopExitInstr);
2813     Type *VecTy = VectorExit[0]->getType();
2814
2815     // Find the reduction identity variable. Zero for addition, or, xor,
2816     // one for multiplication, -1 for And.
2817     Value *Identity;
2818     Value *VectorStart;
2819     if (RdxDesc.Kind == LoopVectorizationLegality::RK_IntegerMinMax ||
2820         RdxDesc.Kind == LoopVectorizationLegality::RK_FloatMinMax) {
2821       // MinMax reduction have the start value as their identify.
2822       if (VF == 1) {
2823         VectorStart = Identity = RdxDesc.StartValue;
2824       } else {
2825         VectorStart = Identity = Builder.CreateVectorSplat(VF,
2826                                                            RdxDesc.StartValue,
2827                                                            "minmax.ident");
2828       }
2829     } else {
2830       // Handle other reduction kinds:
2831       Constant *Iden =
2832       LoopVectorizationLegality::getReductionIdentity(RdxDesc.Kind,
2833                                                       VecTy->getScalarType());
2834       if (VF == 1) {
2835         Identity = Iden;
2836         // This vector is the Identity vector where the first element is the
2837         // incoming scalar reduction.
2838         VectorStart = RdxDesc.StartValue;
2839       } else {
2840         Identity = ConstantVector::getSplat(VF, Iden);
2841
2842         // This vector is the Identity vector where the first element is the
2843         // incoming scalar reduction.
2844         VectorStart = Builder.CreateInsertElement(Identity,
2845                                                   RdxDesc.StartValue, Zero);
2846       }
2847     }
2848
2849     // Fix the vector-loop phi.
2850     // We created the induction variable so we know that the
2851     // preheader is the first entry.
2852     BasicBlock *VecPreheader = Induction->getIncomingBlock(0);
2853
2854     // Reductions do not have to start at zero. They can start with
2855     // any loop invariant values.
2856     VectorParts &VecRdxPhi = WidenMap.get(RdxPhi);
2857     BasicBlock *Latch = OrigLoop->getLoopLatch();
2858     Value *LoopVal = RdxPhi->getIncomingValueForBlock(Latch);
2859     VectorParts &Val = getVectorValue(LoopVal);
2860     for (unsigned part = 0; part < UF; ++part) {
2861       // Make sure to add the reduction stat value only to the
2862       // first unroll part.
2863       Value *StartVal = (part == 0) ? VectorStart : Identity;
2864       cast<PHINode>(VecRdxPhi[part])->addIncoming(StartVal, VecPreheader);
2865       cast<PHINode>(VecRdxPhi[part])->addIncoming(Val[part],
2866                                                   LoopVectorBody.back());
2867     }
2868
2869     // Before each round, move the insertion point right between
2870     // the PHIs and the values we are going to write.
2871     // This allows us to write both PHINodes and the extractelement
2872     // instructions.
2873     Builder.SetInsertPoint(LoopMiddleBlock->getFirstInsertionPt());
2874
2875     VectorParts RdxParts;
2876     setDebugLocFromInst(Builder, RdxDesc.LoopExitInstr);
2877     for (unsigned part = 0; part < UF; ++part) {
2878       // This PHINode contains the vectorized reduction variable, or
2879       // the initial value vector, if we bypass the vector loop.
2880       VectorParts &RdxExitVal = getVectorValue(RdxDesc.LoopExitInstr);
2881       PHINode *NewPhi = Builder.CreatePHI(VecTy, 2, "rdx.vec.exit.phi");
2882       Value *StartVal = (part == 0) ? VectorStart : Identity;
2883       for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2884         NewPhi->addIncoming(StartVal, LoopBypassBlocks[I]);
2885       NewPhi->addIncoming(RdxExitVal[part],
2886                           LoopVectorBody.back());
2887       RdxParts.push_back(NewPhi);
2888     }
2889
2890     // Reduce all of the unrolled parts into a single vector.
2891     Value *ReducedPartRdx = RdxParts[0];
2892     unsigned Op = getReductionBinOp(RdxDesc.Kind);
2893     setDebugLocFromInst(Builder, ReducedPartRdx);
2894     for (unsigned part = 1; part < UF; ++part) {
2895       if (Op != Instruction::ICmp && Op != Instruction::FCmp)
2896         // Floating point operations had to be 'fast' to enable the reduction.
2897         ReducedPartRdx = addFastMathFlag(
2898             Builder.CreateBinOp((Instruction::BinaryOps)Op, RdxParts[part],
2899                                 ReducedPartRdx, "bin.rdx"));
2900       else
2901         ReducedPartRdx = createMinMaxOp(Builder, RdxDesc.MinMaxKind,
2902                                         ReducedPartRdx, RdxParts[part]);
2903     }
2904
2905     if (VF > 1) {
2906       // VF is a power of 2 so we can emit the reduction using log2(VF) shuffles
2907       // and vector ops, reducing the set of values being computed by half each
2908       // round.
2909       assert(isPowerOf2_32(VF) &&
2910              "Reduction emission only supported for pow2 vectors!");
2911       Value *TmpVec = ReducedPartRdx;
2912       SmallVector<Constant*, 32> ShuffleMask(VF, nullptr);
2913       for (unsigned i = VF; i != 1; i >>= 1) {
2914         // Move the upper half of the vector to the lower half.
2915         for (unsigned j = 0; j != i/2; ++j)
2916           ShuffleMask[j] = Builder.getInt32(i/2 + j);
2917
2918         // Fill the rest of the mask with undef.
2919         std::fill(&ShuffleMask[i/2], ShuffleMask.end(),
2920                   UndefValue::get(Builder.getInt32Ty()));
2921
2922         Value *Shuf =
2923         Builder.CreateShuffleVector(TmpVec,
2924                                     UndefValue::get(TmpVec->getType()),
2925                                     ConstantVector::get(ShuffleMask),
2926                                     "rdx.shuf");
2927
2928         if (Op != Instruction::ICmp && Op != Instruction::FCmp)
2929           // Floating point operations had to be 'fast' to enable the reduction.
2930           TmpVec = addFastMathFlag(Builder.CreateBinOp(
2931               (Instruction::BinaryOps)Op, TmpVec, Shuf, "bin.rdx"));
2932         else
2933           TmpVec = createMinMaxOp(Builder, RdxDesc.MinMaxKind, TmpVec, Shuf);
2934       }
2935
2936       // The result is in the first element of the vector.
2937       ReducedPartRdx = Builder.CreateExtractElement(TmpVec,
2938                                                     Builder.getInt32(0));
2939     }
2940
2941     // Create a phi node that merges control-flow from the backedge-taken check
2942     // block and the middle block.
2943     PHINode *BCBlockPhi = PHINode::Create(RdxPhi->getType(), 2, "bc.merge.rdx",
2944                                           LoopScalarPreHeader->getTerminator());
2945     BCBlockPhi->addIncoming(RdxDesc.StartValue, LoopBypassBlocks[0]);
2946     BCBlockPhi->addIncoming(ReducedPartRdx, LoopMiddleBlock);
2947
2948     // Now, we need to fix the users of the reduction variable
2949     // inside and outside of the scalar remainder loop.
2950     // We know that the loop is in LCSSA form. We need to update the
2951     // PHI nodes in the exit blocks.
2952     for (BasicBlock::iterator LEI = LoopExitBlock->begin(),
2953          LEE = LoopExitBlock->end(); LEI != LEE; ++LEI) {
2954       PHINode *LCSSAPhi = dyn_cast<PHINode>(LEI);
2955       if (!LCSSAPhi) break;
2956
2957       // All PHINodes need to have a single entry edge, or two if
2958       // we already fixed them.
2959       assert(LCSSAPhi->getNumIncomingValues() < 3 && "Invalid LCSSA PHI");
2960
2961       // We found our reduction value exit-PHI. Update it with the
2962       // incoming bypass edge.
2963       if (LCSSAPhi->getIncomingValue(0) == RdxDesc.LoopExitInstr) {
2964         // Add an edge coming from the bypass.
2965         LCSSAPhi->addIncoming(ReducedPartRdx, LoopMiddleBlock);
2966         break;
2967       }
2968     }// end of the LCSSA phi scan.
2969
2970     // Fix the scalar loop reduction variable with the incoming reduction sum
2971     // from the vector body and from the backedge value.
2972     int IncomingEdgeBlockIdx =
2973     (RdxPhi)->getBasicBlockIndex(OrigLoop->getLoopLatch());
2974     assert(IncomingEdgeBlockIdx >= 0 && "Invalid block index");
2975     // Pick the other block.
2976     int SelfEdgeBlockIdx = (IncomingEdgeBlockIdx ? 0 : 1);
2977     (RdxPhi)->setIncomingValue(SelfEdgeBlockIdx, BCBlockPhi);
2978     (RdxPhi)->setIncomingValue(IncomingEdgeBlockIdx, RdxDesc.LoopExitInstr);
2979   }// end of for each redux variable.
2980
2981   fixLCSSAPHIs();
2982
2983   // Remove redundant induction instructions.
2984   cse(LoopVectorBody);
2985 }
2986
2987 void InnerLoopVectorizer::fixLCSSAPHIs() {
2988   for (BasicBlock::iterator LEI = LoopExitBlock->begin(),
2989        LEE = LoopExitBlock->end(); LEI != LEE; ++LEI) {
2990     PHINode *LCSSAPhi = dyn_cast<PHINode>(LEI);
2991     if (!LCSSAPhi) break;
2992     if (LCSSAPhi->getNumIncomingValues() == 1)
2993       LCSSAPhi->addIncoming(UndefValue::get(LCSSAPhi->getType()),
2994                             LoopMiddleBlock);
2995   }
2996
2997
2998 InnerLoopVectorizer::VectorParts
2999 InnerLoopVectorizer::createEdgeMask(BasicBlock *Src, BasicBlock *Dst) {
3000   assert(std::find(pred_begin(Dst), pred_end(Dst), Src) != pred_end(Dst) &&
3001          "Invalid edge");
3002
3003   // Look for cached value.
3004   std::pair<BasicBlock*, BasicBlock*> Edge(Src, Dst);
3005   EdgeMaskCache::iterator ECEntryIt = MaskCache.find(Edge);
3006   if (ECEntryIt != MaskCache.end())
3007     return ECEntryIt->second;
3008
3009   VectorParts SrcMask = createBlockInMask(Src);
3010
3011   // The terminator has to be a branch inst!
3012   BranchInst *BI = dyn_cast<BranchInst>(Src->getTerminator());
3013   assert(BI && "Unexpected terminator found");
3014
3015   if (BI->isConditional()) {
3016     VectorParts EdgeMask = getVectorValue(BI->getCondition());
3017
3018     if (BI->getSuccessor(0) != Dst)
3019       for (unsigned part = 0; part < UF; ++part)
3020         EdgeMask[part] = Builder.CreateNot(EdgeMask[part]);
3021
3022     for (unsigned part = 0; part < UF; ++part)
3023       EdgeMask[part] = Builder.CreateAnd(EdgeMask[part], SrcMask[part]);
3024
3025     MaskCache[Edge] = EdgeMask;
3026     return EdgeMask;
3027   }
3028
3029   MaskCache[Edge] = SrcMask;
3030   return SrcMask;
3031 }
3032
3033 InnerLoopVectorizer::VectorParts
3034 InnerLoopVectorizer::createBlockInMask(BasicBlock *BB) {
3035   assert(OrigLoop->contains(BB) && "Block is not a part of a loop");
3036
3037   // Loop incoming mask is all-one.
3038   if (OrigLoop->getHeader() == BB) {
3039     Value *C = ConstantInt::get(IntegerType::getInt1Ty(BB->getContext()), 1);
3040     return getVectorValue(C);
3041   }
3042
3043   // This is the block mask. We OR all incoming edges, and with zero.
3044   Value *Zero = ConstantInt::get(IntegerType::getInt1Ty(BB->getContext()), 0);
3045   VectorParts BlockMask = getVectorValue(Zero);
3046
3047   // For each pred:
3048   for (pred_iterator it = pred_begin(BB), e = pred_end(BB); it != e; ++it) {
3049     VectorParts EM = createEdgeMask(*it, BB);
3050     for (unsigned part = 0; part < UF; ++part)
3051       BlockMask[part] = Builder.CreateOr(BlockMask[part], EM[part]);
3052   }
3053
3054   return BlockMask;
3055 }
3056
3057 void InnerLoopVectorizer::widenPHIInstruction(Instruction *PN,
3058                                               InnerLoopVectorizer::VectorParts &Entry,
3059                                               unsigned UF, unsigned VF, PhiVector *PV) {
3060   PHINode* P = cast<PHINode>(PN);
3061   // Handle reduction variables:
3062   if (Legal->getReductionVars()->count(P)) {
3063     for (unsigned part = 0; part < UF; ++part) {
3064       // This is phase one of vectorizing PHIs.
3065       Type *VecTy = (VF == 1) ? PN->getType() :
3066       VectorType::get(PN->getType(), VF);
3067       Entry[part] = PHINode::Create(VecTy, 2, "vec.phi",
3068                                     LoopVectorBody.back()-> getFirstInsertionPt());
3069     }
3070     PV->push_back(P);
3071     return;
3072   }
3073
3074   setDebugLocFromInst(Builder, P);
3075   // Check for PHI nodes that are lowered to vector selects.
3076   if (P->getParent() != OrigLoop->getHeader()) {
3077     // We know that all PHIs in non-header blocks are converted into
3078     // selects, so we don't have to worry about the insertion order and we
3079     // can just use the builder.
3080     // At this point we generate the predication tree. There may be
3081     // duplications since this is a simple recursive scan, but future
3082     // optimizations will clean it up.
3083
3084     unsigned NumIncoming = P->getNumIncomingValues();
3085
3086     // Generate a sequence of selects of the form:
3087     // SELECT(Mask3, In3,
3088     //      SELECT(Mask2, In2,
3089     //                   ( ...)))
3090     for (unsigned In = 0; In < NumIncoming; In++) {
3091       VectorParts Cond = createEdgeMask(P->getIncomingBlock(In),
3092                                         P->getParent());
3093       VectorParts &In0 = getVectorValue(P->getIncomingValue(In));
3094
3095       for (unsigned part = 0; part < UF; ++part) {
3096         // We might have single edge PHIs (blocks) - use an identity
3097         // 'select' for the first PHI operand.
3098         if (In == 0)
3099           Entry[part] = Builder.CreateSelect(Cond[part], In0[part],
3100                                              In0[part]);
3101         else
3102           // Select between the current value and the previous incoming edge
3103           // based on the incoming mask.
3104           Entry[part] = Builder.CreateSelect(Cond[part], In0[part],
3105                                              Entry[part], "predphi");
3106       }
3107     }
3108     return;
3109   }
3110
3111   // This PHINode must be an induction variable.
3112   // Make sure that we know about it.
3113   assert(Legal->getInductionVars()->count(P) &&
3114          "Not an induction variable");
3115
3116   LoopVectorizationLegality::InductionInfo II =
3117   Legal->getInductionVars()->lookup(P);
3118
3119   switch (II.IK) {
3120     case LoopVectorizationLegality::IK_NoInduction:
3121       llvm_unreachable("Unknown induction");
3122     case LoopVectorizationLegality::IK_IntInduction: {
3123       assert(P->getType() == II.StartValue->getType() && "Types must match");
3124       Type *PhiTy = P->getType();
3125       Value *Broadcasted;
3126       if (P == OldInduction) {
3127         // Handle the canonical induction variable. We might have had to
3128         // extend the type.
3129         Broadcasted = Builder.CreateTrunc(Induction, PhiTy);
3130       } else {
3131         // Handle other induction variables that are now based on the
3132         // canonical one.
3133         Value *NormalizedIdx = Builder.CreateSub(Induction, ExtendedIdx,
3134                                                  "normalized.idx");
3135         NormalizedIdx = Builder.CreateSExtOrTrunc(NormalizedIdx, PhiTy);
3136         Broadcasted = Builder.CreateAdd(II.StartValue, NormalizedIdx,
3137                                         "offset.idx");
3138       }
3139       Broadcasted = getBroadcastInstrs(Broadcasted);
3140       // After broadcasting the induction variable we need to make the vector
3141       // consecutive by adding 0, 1, 2, etc.
3142       for (unsigned part = 0; part < UF; ++part)
3143         Entry[part] = getConsecutiveVector(Broadcasted, VF * part, false);
3144       return;
3145     }
3146     case LoopVectorizationLegality::IK_ReverseIntInduction:
3147     case LoopVectorizationLegality::IK_PtrInduction:
3148     case LoopVectorizationLegality::IK_ReversePtrInduction:
3149       // Handle reverse integer and pointer inductions.
3150       Value *StartIdx = ExtendedIdx;
3151       // This is the normalized GEP that starts counting at zero.
3152       Value *NormalizedIdx = Builder.CreateSub(Induction, StartIdx,
3153                                                "normalized.idx");
3154
3155       // Handle the reverse integer induction variable case.
3156       if (LoopVectorizationLegality::IK_ReverseIntInduction == II.IK) {
3157         IntegerType *DstTy = cast<IntegerType>(II.StartValue->getType());
3158         Value *CNI = Builder.CreateSExtOrTrunc(NormalizedIdx, DstTy,
3159                                                "resize.norm.idx");
3160         Value *ReverseInd  = Builder.CreateSub(II.StartValue, CNI,
3161                                                "reverse.idx");
3162
3163         // This is a new value so do not hoist it out.
3164         Value *Broadcasted = getBroadcastInstrs(ReverseInd);
3165         // After broadcasting the induction variable we need to make the
3166         // vector consecutive by adding  ... -3, -2, -1, 0.
3167         for (unsigned part = 0; part < UF; ++part)
3168           Entry[part] = getConsecutiveVector(Broadcasted, -(int)VF * part,
3169                                              true);
3170         return;
3171       }
3172
3173       // Handle the pointer induction variable case.
3174       assert(P->getType()->isPointerTy() && "Unexpected type.");
3175
3176       // Is this a reverse induction ptr or a consecutive induction ptr.
3177       bool Reverse = (LoopVectorizationLegality::IK_ReversePtrInduction ==
3178                       II.IK);
3179
3180       // This is the vector of results. Notice that we don't generate
3181       // vector geps because scalar geps result in better code.
3182       for (unsigned part = 0; part < UF; ++part) {
3183         if (VF == 1) {
3184           int EltIndex = (part) * (Reverse ? -1 : 1);
3185           Constant *Idx = ConstantInt::get(Induction->getType(), EltIndex);
3186           Value *GlobalIdx;
3187           if (Reverse)
3188             GlobalIdx = Builder.CreateSub(Idx, NormalizedIdx, "gep.ridx");
3189           else
3190             GlobalIdx = Builder.CreateAdd(NormalizedIdx, Idx, "gep.idx");
3191
3192           Value *SclrGep = Builder.CreateGEP(II.StartValue, GlobalIdx,
3193                                              "next.gep");
3194           Entry[part] = SclrGep;
3195           continue;
3196         }
3197
3198         Value *VecVal = UndefValue::get(VectorType::get(P->getType(), VF));
3199         for (unsigned int i = 0; i < VF; ++i) {
3200           int EltIndex = (i + part * VF) * (Reverse ? -1 : 1);
3201           Constant *Idx = ConstantInt::get(Induction->getType(), EltIndex);
3202           Value *GlobalIdx;
3203           if (!Reverse)
3204             GlobalIdx = Builder.CreateAdd(NormalizedIdx, Idx, "gep.idx");
3205           else
3206             GlobalIdx = Builder.CreateSub(Idx, NormalizedIdx, "gep.ridx");
3207
3208           Value *SclrGep = Builder.CreateGEP(II.StartValue, GlobalIdx,
3209                                              "next.gep");
3210           VecVal = Builder.CreateInsertElement(VecVal, SclrGep,
3211                                                Builder.getInt32(i),
3212                                                "insert.gep");
3213         }
3214         Entry[part] = VecVal;
3215       }
3216       return;
3217   }
3218 }
3219
3220 void InnerLoopVectorizer::vectorizeBlockInLoop(BasicBlock *BB, PhiVector *PV) {
3221   // For each instruction in the old loop.
3222   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
3223     VectorParts &Entry = WidenMap.get(it);
3224     switch (it->getOpcode()) {
3225     case Instruction::Br:
3226       // Nothing to do for PHIs and BR, since we already took care of the
3227       // loop control flow instructions.
3228       continue;
3229     case Instruction::PHI:{
3230       // Vectorize PHINodes.
3231       widenPHIInstruction(it, Entry, UF, VF, PV);
3232       continue;
3233     }// End of PHI.
3234
3235     case Instruction::Add:
3236     case Instruction::FAdd:
3237     case Instruction::Sub:
3238     case Instruction::FSub:
3239     case Instruction::Mul:
3240     case Instruction::FMul:
3241     case Instruction::UDiv:
3242     case Instruction::SDiv:
3243     case Instruction::FDiv:
3244     case Instruction::URem:
3245     case Instruction::SRem:
3246     case Instruction::FRem:
3247     case Instruction::Shl:
3248     case Instruction::LShr:
3249     case Instruction::AShr:
3250     case Instruction::And:
3251     case Instruction::Or:
3252     case Instruction::Xor: {
3253       // Just widen binops.
3254       BinaryOperator *BinOp = dyn_cast<BinaryOperator>(it);
3255       setDebugLocFromInst(Builder, BinOp);
3256       VectorParts &A = getVectorValue(it->getOperand(0));
3257       VectorParts &B = getVectorValue(it->getOperand(1));
3258
3259       // Use this vector value for all users of the original instruction.
3260       for (unsigned Part = 0; Part < UF; ++Part) {
3261         Value *V = Builder.CreateBinOp(BinOp->getOpcode(), A[Part], B[Part]);
3262
3263         if (BinaryOperator *VecOp = dyn_cast<BinaryOperator>(V))
3264           VecOp->copyIRFlags(BinOp);
3265         
3266         Entry[Part] = V;
3267       }
3268
3269       propagateMetadata(Entry, it);
3270       break;
3271     }
3272     case Instruction::Select: {
3273       // Widen selects.
3274       // If the selector is loop invariant we can create a select
3275       // instruction with a scalar condition. Otherwise, use vector-select.
3276       bool InvariantCond = SE->isLoopInvariant(SE->getSCEV(it->getOperand(0)),
3277                                                OrigLoop);
3278       setDebugLocFromInst(Builder, it);
3279
3280       // The condition can be loop invariant  but still defined inside the
3281       // loop. This means that we can't just use the original 'cond' value.
3282       // We have to take the 'vectorized' value and pick the first lane.
3283       // Instcombine will make this a no-op.
3284       VectorParts &Cond = getVectorValue(it->getOperand(0));
3285       VectorParts &Op0  = getVectorValue(it->getOperand(1));
3286       VectorParts &Op1  = getVectorValue(it->getOperand(2));
3287
3288       Value *ScalarCond = (VF == 1) ? Cond[0] :
3289         Builder.CreateExtractElement(Cond[0], Builder.getInt32(0));
3290
3291       for (unsigned Part = 0; Part < UF; ++Part) {
3292         Entry[Part] = Builder.CreateSelect(
3293           InvariantCond ? ScalarCond : Cond[Part],
3294           Op0[Part],
3295           Op1[Part]);
3296       }
3297
3298       propagateMetadata(Entry, it);
3299       break;
3300     }
3301
3302     case Instruction::ICmp:
3303     case Instruction::FCmp: {
3304       // Widen compares. Generate vector compares.
3305       bool FCmp = (it->getOpcode() == Instruction::FCmp);
3306       CmpInst *Cmp = dyn_cast<CmpInst>(it);
3307       setDebugLocFromInst(Builder, it);
3308       VectorParts &A = getVectorValue(it->getOperand(0));