Unbreak Debug build on Windows
[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 #define LV_NAME "loop-vectorize"
46 #define DEBUG_TYPE LV_NAME
47
48 #include "llvm/Transforms/Vectorize.h"
49 #include "llvm/ADT/DenseMap.h"
50 #include "llvm/ADT/EquivalenceClasses.h"
51 #include "llvm/ADT/MapVector.h"
52 #include "llvm/ADT/SetVector.h"
53 #include "llvm/ADT/SmallPtrSet.h"
54 #include "llvm/ADT/SmallSet.h"
55 #include "llvm/ADT/SmallVector.h"
56 #include "llvm/ADT/StringExtras.h"
57 #include "llvm/Analysis/AliasAnalysis.h"
58 #include "llvm/Analysis/Dominators.h"
59 #include "llvm/Analysis/LoopInfo.h"
60 #include "llvm/Analysis/LoopIterator.h"
61 #include "llvm/Analysis/LoopPass.h"
62 #include "llvm/Analysis/ScalarEvolution.h"
63 #include "llvm/Analysis/ScalarEvolutionExpander.h"
64 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
65 #include "llvm/Analysis/TargetTransformInfo.h"
66 #include "llvm/Analysis/ValueTracking.h"
67 #include "llvm/Analysis/Verifier.h"
68 #include "llvm/IR/Constants.h"
69 #include "llvm/IR/DataLayout.h"
70 #include "llvm/IR/DerivedTypes.h"
71 #include "llvm/IR/Function.h"
72 #include "llvm/IR/IRBuilder.h"
73 #include "llvm/IR/Instructions.h"
74 #include "llvm/IR/IntrinsicInst.h"
75 #include "llvm/IR/LLVMContext.h"
76 #include "llvm/IR/Module.h"
77 #include "llvm/IR/Type.h"
78 #include "llvm/IR/Value.h"
79 #include "llvm/Pass.h"
80 #include "llvm/Support/CommandLine.h"
81 #include "llvm/Support/Debug.h"
82 #include "llvm/Support/PatternMatch.h"
83 #include "llvm/Support/raw_ostream.h"
84 #include "llvm/Support/ValueHandle.h"
85 #include "llvm/Target/TargetLibraryInfo.h"
86 #include "llvm/Transforms/Scalar.h"
87 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
88 #include "llvm/Transforms/Utils/Local.h"
89 #include <algorithm>
90 #include <map>
91
92 using namespace llvm;
93 using namespace llvm::PatternMatch;
94
95 static cl::opt<unsigned>
96 VectorizationFactor("force-vector-width", cl::init(0), cl::Hidden,
97                     cl::desc("Sets the SIMD width. Zero is autoselect."));
98
99 static cl::opt<unsigned>
100 VectorizationUnroll("force-vector-unroll", cl::init(0), cl::Hidden,
101                     cl::desc("Sets the vectorization unroll count. "
102                              "Zero is autoselect."));
103
104 static cl::opt<bool>
105 EnableIfConversion("enable-if-conversion", cl::init(true), cl::Hidden,
106                    cl::desc("Enable if-conversion during vectorization."));
107
108 /// We don't vectorize loops with a known constant trip count below this number.
109 static cl::opt<unsigned>
110 TinyTripCountVectorThreshold("vectorizer-min-trip-count", cl::init(16),
111                              cl::Hidden,
112                              cl::desc("Don't vectorize loops with a constant "
113                                       "trip count that is smaller than this "
114                                       "value."));
115
116 /// We don't unroll loops with a known constant trip count below this number.
117 static const unsigned TinyTripCountUnrollThreshold = 128;
118
119 /// When performing memory disambiguation checks at runtime do not make more
120 /// than this number of comparisons.
121 static const unsigned RuntimeMemoryCheckThreshold = 8;
122
123 /// Maximum simd width.
124 static const unsigned MaxVectorWidth = 64;
125
126 /// Maximum vectorization unroll count.
127 static const unsigned MaxUnrollFactor = 16;
128
129 namespace {
130
131 // Forward declarations.
132 class LoopVectorizationLegality;
133 class LoopVectorizationCostModel;
134
135 /// InnerLoopVectorizer vectorizes loops which contain only one basic
136 /// block to a specified vectorization factor (VF).
137 /// This class performs the widening of scalars into vectors, or multiple
138 /// scalars. This class also implements the following features:
139 /// * It inserts an epilogue loop for handling loops that don't have iteration
140 ///   counts that are known to be a multiple of the vectorization factor.
141 /// * It handles the code generation for reduction variables.
142 /// * Scalarization (implementation using scalars) of un-vectorizable
143 ///   instructions.
144 /// InnerLoopVectorizer does not perform any vectorization-legality
145 /// checks, and relies on the caller to check for the different legality
146 /// aspects. The InnerLoopVectorizer relies on the
147 /// LoopVectorizationLegality class to provide information about the induction
148 /// and reduction variables that were found to a given vectorization factor.
149 class InnerLoopVectorizer {
150 public:
151   InnerLoopVectorizer(Loop *OrigLoop, ScalarEvolution *SE, LoopInfo *LI,
152                       DominatorTree *DT, DataLayout *DL,
153                       const TargetLibraryInfo *TLI, unsigned VecWidth,
154                       unsigned UnrollFactor)
155       : OrigLoop(OrigLoop), SE(SE), LI(LI), DT(DT), DL(DL), TLI(TLI),
156         VF(VecWidth), UF(UnrollFactor), Builder(SE->getContext()), Induction(0),
157         OldInduction(0), WidenMap(UnrollFactor) {}
158
159   // Perform the actual loop widening (vectorization).
160   void vectorize(LoopVectorizationLegality *Legal) {
161     // Create a new empty loop. Unlink the old loop and connect the new one.
162     createEmptyLoop(Legal);
163     // Widen each instruction in the old loop to a new one in the new loop.
164     // Use the Legality module to find the induction and reduction variables.
165     vectorizeLoop(Legal);
166     // Register the new loop and update the analysis passes.
167     updateAnalysis();
168   }
169
170 private:
171   /// A small list of PHINodes.
172   typedef SmallVector<PHINode*, 4> PhiVector;
173   /// When we unroll loops we have multiple vector values for each scalar.
174   /// This data structure holds the unrolled and vectorized values that
175   /// originated from one scalar instruction.
176   typedef SmallVector<Value*, 2> VectorParts;
177
178   // When we if-convert we need create edge masks. We have to cache values so
179   // that we don't end up with exponential recursion/IR.
180   typedef DenseMap<std::pair<BasicBlock*, BasicBlock*>,
181                    VectorParts> EdgeMaskCache;
182
183   /// Add code that checks at runtime if the accessed arrays overlap.
184   /// Returns the comparator value or NULL if no check is needed.
185   Instruction *addRuntimeCheck(LoopVectorizationLegality *Legal,
186                                Instruction *Loc);
187   /// Create an empty loop, based on the loop ranges of the old loop.
188   void createEmptyLoop(LoopVectorizationLegality *Legal);
189   /// Copy and widen the instructions from the old loop.
190   void vectorizeLoop(LoopVectorizationLegality *Legal);
191
192   /// A helper function that computes the predicate of the block BB, assuming
193   /// that the header block of the loop is set to True. It returns the *entry*
194   /// mask for the block BB.
195   VectorParts createBlockInMask(BasicBlock *BB);
196   /// A helper function that computes the predicate of the edge between SRC
197   /// and DST.
198   VectorParts createEdgeMask(BasicBlock *Src, BasicBlock *Dst);
199
200   /// A helper function to vectorize a single BB within the innermost loop.
201   void vectorizeBlockInLoop(LoopVectorizationLegality *Legal, BasicBlock *BB,
202                             PhiVector *PV);
203
204   /// Insert the new loop to the loop hierarchy and pass manager
205   /// and update the analysis passes.
206   void updateAnalysis();
207
208   /// This instruction is un-vectorizable. Implement it as a sequence
209   /// of scalars.
210   void scalarizeInstruction(Instruction *Instr);
211
212   /// Vectorize Load and Store instructions,
213   void vectorizeMemoryInstruction(Instruction *Instr,
214                                   LoopVectorizationLegality *Legal);
215
216   /// Create a broadcast instruction. This method generates a broadcast
217   /// instruction (shuffle) for loop invariant values and for the induction
218   /// value. If this is the induction variable then we extend it to N, N+1, ...
219   /// this is needed because each iteration in the loop corresponds to a SIMD
220   /// element.
221   Value *getBroadcastInstrs(Value *V);
222
223   /// This function adds 0, 1, 2 ... to each vector element, starting at zero.
224   /// If Negate is set then negative numbers are added e.g. (0, -1, -2, ...).
225   /// The sequence starts at StartIndex.
226   Value *getConsecutiveVector(Value* Val, int StartIdx, bool Negate);
227
228   /// When we go over instructions in the basic block we rely on previous
229   /// values within the current basic block or on loop invariant values.
230   /// When we widen (vectorize) values we place them in the map. If the values
231   /// are not within the map, they have to be loop invariant, so we simply
232   /// broadcast them into a vector.
233   VectorParts &getVectorValue(Value *V);
234
235   /// Generate a shuffle sequence that will reverse the vector Vec.
236   Value *reverseVector(Value *Vec);
237
238   /// This is a helper class that holds the vectorizer state. It maps scalar
239   /// instructions to vector instructions. When the code is 'unrolled' then
240   /// then a single scalar value is mapped to multiple vector parts. The parts
241   /// are stored in the VectorPart type.
242   struct ValueMap {
243     /// C'tor.  UnrollFactor controls the number of vectors ('parts') that
244     /// are mapped.
245     ValueMap(unsigned UnrollFactor) : UF(UnrollFactor) {}
246
247     /// \return True if 'Key' is saved in the Value Map.
248     bool has(Value *Key) const { return MapStorage.count(Key); }
249
250     /// Initializes a new entry in the map. Sets all of the vector parts to the
251     /// save value in 'Val'.
252     /// \return A reference to a vector with splat values.
253     VectorParts &splat(Value *Key, Value *Val) {
254       VectorParts &Entry = MapStorage[Key];
255       Entry.assign(UF, Val);
256       return Entry;
257     }
258
259     ///\return A reference to the value that is stored at 'Key'.
260     VectorParts &get(Value *Key) {
261       VectorParts &Entry = MapStorage[Key];
262       if (Entry.empty())
263         Entry.resize(UF);
264       assert(Entry.size() == UF);
265       return Entry;
266     }
267
268   private:
269     /// The unroll factor. Each entry in the map stores this number of vector
270     /// elements.
271     unsigned UF;
272
273     /// Map storage. We use std::map and not DenseMap because insertions to a
274     /// dense map invalidates its iterators.
275     std::map<Value *, VectorParts> MapStorage;
276   };
277
278   /// The original loop.
279   Loop *OrigLoop;
280   /// Scev analysis to use.
281   ScalarEvolution *SE;
282   /// Loop Info.
283   LoopInfo *LI;
284   /// Dominator Tree.
285   DominatorTree *DT;
286   /// Data Layout.
287   DataLayout *DL;
288   /// Target Library Info.
289   const TargetLibraryInfo *TLI;
290
291   /// The vectorization SIMD factor to use. Each vector will have this many
292   /// vector elements.
293   unsigned VF;
294   /// The vectorization unroll factor to use. Each scalar is vectorized to this
295   /// many different vector instructions.
296   unsigned UF;
297
298   /// The builder that we use
299   IRBuilder<> Builder;
300
301   // --- Vectorization state ---
302
303   /// The vector-loop preheader.
304   BasicBlock *LoopVectorPreHeader;
305   /// The scalar-loop preheader.
306   BasicBlock *LoopScalarPreHeader;
307   /// Middle Block between the vector and the scalar.
308   BasicBlock *LoopMiddleBlock;
309   ///The ExitBlock of the scalar loop.
310   BasicBlock *LoopExitBlock;
311   ///The vector loop body.
312   BasicBlock *LoopVectorBody;
313   ///The scalar loop body.
314   BasicBlock *LoopScalarBody;
315   /// A list of all bypass blocks. The first block is the entry of the loop.
316   SmallVector<BasicBlock *, 4> LoopBypassBlocks;
317
318   /// The new Induction variable which was added to the new block.
319   PHINode *Induction;
320   /// The induction variable of the old basic block.
321   PHINode *OldInduction;
322   /// Holds the extended (to the widest induction type) start index.
323   Value *ExtendedIdx;
324   /// Maps scalars to widened vectors.
325   ValueMap WidenMap;
326   EdgeMaskCache MaskCache;
327 };
328
329 /// \brief Look for a meaningful debug location on the instruction or it's
330 /// operands.
331 static Instruction *getDebugLocFromInstOrOperands(Instruction *I) {
332   if (!I)
333     return I;
334
335   DebugLoc Empty;
336   if (I->getDebugLoc() != Empty)
337     return I;
338
339   for (User::op_iterator OI = I->op_begin(), OE = I->op_end(); OI != OE; ++OI) {
340     if (Instruction *OpInst = dyn_cast<Instruction>(*OI))
341       if (OpInst->getDebugLoc() != Empty)
342         return OpInst;
343   }
344
345   return I;
346 }
347
348 /// \brief Set the debug location in the builder using the debug location in the
349 /// instruction.
350 static void setDebugLocFromInst(IRBuilder<> &B, const Value *Ptr) {
351   if (const Instruction *Inst = dyn_cast_or_null<Instruction>(Ptr))
352     B.SetCurrentDebugLocation(Inst->getDebugLoc());
353   else
354     B.SetCurrentDebugLocation(DebugLoc());
355 }
356
357 /// LoopVectorizationLegality checks if it is legal to vectorize a loop, and
358 /// to what vectorization factor.
359 /// This class does not look at the profitability of vectorization, only the
360 /// legality. This class has two main kinds of checks:
361 /// * Memory checks - The code in canVectorizeMemory checks if vectorization
362 ///   will change the order of memory accesses in a way that will change the
363 ///   correctness of the program.
364 /// * Scalars checks - The code in canVectorizeInstrs and canVectorizeMemory
365 /// checks for a number of different conditions, such as the availability of a
366 /// single induction variable, that all types are supported and vectorize-able,
367 /// etc. This code reflects the capabilities of InnerLoopVectorizer.
368 /// This class is also used by InnerLoopVectorizer for identifying
369 /// induction variable and the different reduction variables.
370 class LoopVectorizationLegality {
371 public:
372   LoopVectorizationLegality(Loop *L, ScalarEvolution *SE, DataLayout *DL,
373                             DominatorTree *DT, TargetLibraryInfo *TLI)
374       : TheLoop(L), SE(SE), DL(DL), DT(DT), TLI(TLI),
375         Induction(0), WidestIndTy(0), HasFunNoNaNAttr(false),
376         MaxSafeDepDistBytes(-1U) {}
377
378   /// This enum represents the kinds of reductions that we support.
379   enum ReductionKind {
380     RK_NoReduction, ///< Not a reduction.
381     RK_IntegerAdd,  ///< Sum of integers.
382     RK_IntegerMult, ///< Product of integers.
383     RK_IntegerOr,   ///< Bitwise or logical OR of numbers.
384     RK_IntegerAnd,  ///< Bitwise or logical AND of numbers.
385     RK_IntegerXor,  ///< Bitwise or logical XOR of numbers.
386     RK_IntegerMinMax, ///< Min/max implemented in terms of select(cmp()).
387     RK_FloatAdd,    ///< Sum of floats.
388     RK_FloatMult,   ///< Product of floats.
389     RK_FloatMinMax  ///< Min/max implemented in terms of select(cmp()).
390   };
391
392   /// This enum represents the kinds of inductions that we support.
393   enum InductionKind {
394     IK_NoInduction,         ///< Not an induction variable.
395     IK_IntInduction,        ///< Integer induction variable. Step = 1.
396     IK_ReverseIntInduction, ///< Reverse int induction variable. Step = -1.
397     IK_PtrInduction,        ///< Pointer induction var. Step = sizeof(elem).
398     IK_ReversePtrInduction  ///< Reverse ptr indvar. Step = - sizeof(elem).
399   };
400
401   // This enum represents the kind of minmax reduction.
402   enum MinMaxReductionKind {
403     MRK_Invalid,
404     MRK_UIntMin,
405     MRK_UIntMax,
406     MRK_SIntMin,
407     MRK_SIntMax,
408     MRK_FloatMin,
409     MRK_FloatMax
410   };
411
412   /// This POD struct holds information about reduction variables.
413   struct ReductionDescriptor {
414     ReductionDescriptor() : StartValue(0), LoopExitInstr(0),
415       Kind(RK_NoReduction), MinMaxKind(MRK_Invalid) {}
416
417     ReductionDescriptor(Value *Start, Instruction *Exit, ReductionKind K,
418                         MinMaxReductionKind MK)
419         : StartValue(Start), LoopExitInstr(Exit), Kind(K), MinMaxKind(MK) {}
420
421     // The starting value of the reduction.
422     // It does not have to be zero!
423     TrackingVH<Value> StartValue;
424     // The instruction who's value is used outside the loop.
425     Instruction *LoopExitInstr;
426     // The kind of the reduction.
427     ReductionKind Kind;
428     // If this a min/max reduction the kind of reduction.
429     MinMaxReductionKind MinMaxKind;
430   };
431
432   /// This POD struct holds information about a potential reduction operation.
433   struct ReductionInstDesc {
434     ReductionInstDesc(bool IsRedux, Instruction *I) :
435       IsReduction(IsRedux), PatternLastInst(I), MinMaxKind(MRK_Invalid) {}
436
437     ReductionInstDesc(Instruction *I, MinMaxReductionKind K) :
438       IsReduction(true), PatternLastInst(I), MinMaxKind(K) {}
439
440     // Is this instruction a reduction candidate.
441     bool IsReduction;
442     // The last instruction in a min/max pattern (select of the select(icmp())
443     // pattern), or the current reduction instruction otherwise.
444     Instruction *PatternLastInst;
445     // If this is a min/max pattern the comparison predicate.
446     MinMaxReductionKind MinMaxKind;
447   };
448
449   // This POD struct holds information about the memory runtime legality
450   // check that a group of pointers do not overlap.
451   struct RuntimePointerCheck {
452     RuntimePointerCheck() : Need(false) {}
453
454     /// Reset the state of the pointer runtime information.
455     void reset() {
456       Need = false;
457       Pointers.clear();
458       Starts.clear();
459       Ends.clear();
460     }
461
462     /// Insert a pointer and calculate the start and end SCEVs.
463     void insert(ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr,
464                 unsigned DepSetId);
465
466     /// This flag indicates if we need to add the runtime check.
467     bool Need;
468     /// Holds the pointers that we need to check.
469     SmallVector<TrackingVH<Value>, 2> Pointers;
470     /// Holds the pointer value at the beginning of the loop.
471     SmallVector<const SCEV*, 2> Starts;
472     /// Holds the pointer value at the end of the loop.
473     SmallVector<const SCEV*, 2> Ends;
474     /// Holds the information if this pointer is used for writing to memory.
475     SmallVector<bool, 2> IsWritePtr;
476     /// Holds the id of the set of pointers that could be dependent because of a
477     /// shared underlying object.
478     SmallVector<unsigned, 2> DependencySetId;
479   };
480
481   /// A POD for saving information about induction variables.
482   struct InductionInfo {
483     InductionInfo(Value *Start, InductionKind K) : StartValue(Start), IK(K) {}
484     InductionInfo() : StartValue(0), IK(IK_NoInduction) {}
485     /// Start value.
486     TrackingVH<Value> StartValue;
487     /// Induction kind.
488     InductionKind IK;
489   };
490
491   /// ReductionList contains the reduction descriptors for all
492   /// of the reductions that were found in the loop.
493   typedef DenseMap<PHINode*, ReductionDescriptor> ReductionList;
494
495   /// InductionList saves induction variables and maps them to the
496   /// induction descriptor.
497   typedef MapVector<PHINode*, InductionInfo> InductionList;
498
499   /// Returns true if it is legal to vectorize this loop.
500   /// This does not mean that it is profitable to vectorize this
501   /// loop, only that it is legal to do so.
502   bool canVectorize();
503
504   /// Returns the Induction variable.
505   PHINode *getInduction() { return Induction; }
506
507   /// Returns the reduction variables found in the loop.
508   ReductionList *getReductionVars() { return &Reductions; }
509
510   /// Returns the induction variables found in the loop.
511   InductionList *getInductionVars() { return &Inductions; }
512
513   /// Returns the widest induction type.
514   Type *getWidestInductionType() { return WidestIndTy; }
515
516   /// Returns True if V is an induction variable in this loop.
517   bool isInductionVariable(const Value *V);
518
519   /// Return true if the block BB needs to be predicated in order for the loop
520   /// to be vectorized.
521   bool blockNeedsPredication(BasicBlock *BB);
522
523   /// Check if this  pointer is consecutive when vectorizing. This happens
524   /// when the last index of the GEP is the induction variable, or that the
525   /// pointer itself is an induction variable.
526   /// This check allows us to vectorize A[idx] into a wide load/store.
527   /// Returns:
528   /// 0 - Stride is unknown or non consecutive.
529   /// 1 - Address is consecutive.
530   /// -1 - Address is consecutive, and decreasing.
531   int isConsecutivePtr(Value *Ptr);
532
533   /// Returns true if the value V is uniform within the loop.
534   bool isUniform(Value *V);
535
536   /// Returns true if this instruction will remain scalar after vectorization.
537   bool isUniformAfterVectorization(Instruction* I) { return Uniforms.count(I); }
538
539   /// Returns the information that we collected about runtime memory check.
540   RuntimePointerCheck *getRuntimePointerCheck() { return &PtrRtCheck; }
541
542   /// This function returns the identity element (or neutral element) for
543   /// the operation K.
544   static Constant *getReductionIdentity(ReductionKind K, Type *Tp);
545
546   unsigned getMaxSafeDepDistBytes() { return MaxSafeDepDistBytes; }
547
548 private:
549   /// Check if a single basic block loop is vectorizable.
550   /// At this point we know that this is a loop with a constant trip count
551   /// and we only need to check individual instructions.
552   bool canVectorizeInstrs();
553
554   /// When we vectorize loops we may change the order in which
555   /// we read and write from memory. This method checks if it is
556   /// legal to vectorize the code, considering only memory constrains.
557   /// Returns true if the loop is vectorizable
558   bool canVectorizeMemory();
559
560   /// Return true if we can vectorize this loop using the IF-conversion
561   /// transformation.
562   bool canVectorizeWithIfConvert();
563
564   /// Collect the variables that need to stay uniform after vectorization.
565   void collectLoopUniforms();
566
567   /// Return true if all of the instructions in the block can be speculatively
568   /// executed. \p SafePtrs is a list of addresses that are known to be legal
569   /// and we know that we can read from them without segfault.
570   bool blockCanBePredicated(BasicBlock *BB, SmallPtrSet<Value *, 8>& SafePtrs);
571
572   /// Returns True, if 'Phi' is the kind of reduction variable for type
573   /// 'Kind'. If this is a reduction variable, it adds it to ReductionList.
574   bool AddReductionVar(PHINode *Phi, ReductionKind Kind);
575   /// Returns a struct describing if the instruction 'I' can be a reduction
576   /// variable of type 'Kind'. If the reduction is a min/max pattern of
577   /// select(icmp()) this function advances the instruction pointer 'I' from the
578   /// compare instruction to the select instruction and stores this pointer in
579   /// 'PatternLastInst' member of the returned struct.
580   ReductionInstDesc isReductionInstr(Instruction *I, ReductionKind Kind,
581                                      ReductionInstDesc &Desc);
582   /// Returns true if the instruction is a Select(ICmp(X, Y), X, Y) instruction
583   /// pattern corresponding to a min(X, Y) or max(X, Y).
584   static ReductionInstDesc isMinMaxSelectCmpPattern(Instruction *I,
585                                                     ReductionInstDesc &Prev);
586   /// Returns the induction kind of Phi. This function may return NoInduction
587   /// if the PHI is not an induction variable.
588   InductionKind isInductionVariable(PHINode *Phi);
589
590   /// The loop that we evaluate.
591   Loop *TheLoop;
592   /// Scev analysis.
593   ScalarEvolution *SE;
594   /// DataLayout analysis.
595   DataLayout *DL;
596   /// Dominators.
597   DominatorTree *DT;
598   /// Target Library Info.
599   TargetLibraryInfo *TLI;
600
601   //  ---  vectorization state --- //
602
603   /// Holds the integer induction variable. This is the counter of the
604   /// loop.
605   PHINode *Induction;
606   /// Holds the reduction variables.
607   ReductionList Reductions;
608   /// Holds all of the induction variables that we found in the loop.
609   /// Notice that inductions don't need to start at zero and that induction
610   /// variables can be pointers.
611   InductionList Inductions;
612   /// Holds the widest induction type encountered.
613   Type *WidestIndTy;
614
615   /// Allowed outside users. This holds the reduction
616   /// vars which can be accessed from outside the loop.
617   SmallPtrSet<Value*, 4> AllowedExit;
618   /// This set holds the variables which are known to be uniform after
619   /// vectorization.
620   SmallPtrSet<Instruction*, 4> Uniforms;
621   /// We need to check that all of the pointers in this list are disjoint
622   /// at runtime.
623   RuntimePointerCheck PtrRtCheck;
624   /// Can we assume the absence of NaNs.
625   bool HasFunNoNaNAttr;
626
627   unsigned MaxSafeDepDistBytes;
628 };
629
630 /// LoopVectorizationCostModel - estimates the expected speedups due to
631 /// vectorization.
632 /// In many cases vectorization is not profitable. This can happen because of
633 /// a number of reasons. In this class we mainly attempt to predict the
634 /// expected speedup/slowdowns due to the supported instruction set. We use the
635 /// TargetTransformInfo to query the different backends for the cost of
636 /// different operations.
637 class LoopVectorizationCostModel {
638 public:
639   LoopVectorizationCostModel(Loop *L, ScalarEvolution *SE, LoopInfo *LI,
640                              LoopVectorizationLegality *Legal,
641                              const TargetTransformInfo &TTI,
642                              DataLayout *DL, const TargetLibraryInfo *TLI)
643       : TheLoop(L), SE(SE), LI(LI), Legal(Legal), TTI(TTI), DL(DL), TLI(TLI) {}
644
645   /// Information about vectorization costs
646   struct VectorizationFactor {
647     unsigned Width; // Vector width with best cost
648     unsigned Cost; // Cost of the loop with that width
649   };
650   /// \return The most profitable vectorization factor and the cost of that VF.
651   /// This method checks every power of two up to VF. If UserVF is not ZERO
652   /// then this vectorization factor will be selected if vectorization is
653   /// possible.
654   VectorizationFactor selectVectorizationFactor(bool OptForSize,
655                                                 unsigned UserVF);
656
657   /// \return The size (in bits) of the widest type in the code that
658   /// needs to be vectorized. We ignore values that remain scalar such as
659   /// 64 bit loop indices.
660   unsigned getWidestType();
661
662   /// \return The most profitable unroll factor.
663   /// If UserUF is non-zero then this method finds the best unroll-factor
664   /// based on register pressure and other parameters.
665   /// VF and LoopCost are the selected vectorization factor and the cost of the
666   /// selected VF.
667   unsigned selectUnrollFactor(bool OptForSize, unsigned UserUF, unsigned VF,
668                               unsigned LoopCost);
669
670   /// \brief A struct that represents some properties of the register usage
671   /// of a loop.
672   struct RegisterUsage {
673     /// Holds the number of loop invariant values that are used in the loop.
674     unsigned LoopInvariantRegs;
675     /// Holds the maximum number of concurrent live intervals in the loop.
676     unsigned MaxLocalUsers;
677     /// Holds the number of instructions in the loop.
678     unsigned NumInstructions;
679   };
680
681   /// \return  information about the register usage of the loop.
682   RegisterUsage calculateRegisterUsage();
683
684 private:
685   /// Returns the expected execution cost. The unit of the cost does
686   /// not matter because we use the 'cost' units to compare different
687   /// vector widths. The cost that is returned is *not* normalized by
688   /// the factor width.
689   unsigned expectedCost(unsigned VF);
690
691   /// Returns the execution time cost of an instruction for a given vector
692   /// width. Vector width of one means scalar.
693   unsigned getInstructionCost(Instruction *I, unsigned VF);
694
695   /// A helper function for converting Scalar types to vector types.
696   /// If the incoming type is void, we return void. If the VF is 1, we return
697   /// the scalar type.
698   static Type* ToVectorTy(Type *Scalar, unsigned VF);
699
700   /// Returns whether the instruction is a load or store and will be a emitted
701   /// as a vector operation.
702   bool isConsecutiveLoadOrStore(Instruction *I);
703
704   /// The loop that we evaluate.
705   Loop *TheLoop;
706   /// Scev analysis.
707   ScalarEvolution *SE;
708   /// Loop Info analysis.
709   LoopInfo *LI;
710   /// Vectorization legality.
711   LoopVectorizationLegality *Legal;
712   /// Vector target information.
713   const TargetTransformInfo &TTI;
714   /// Target data layout information.
715   DataLayout *DL;
716   /// Target Library Info.
717   const TargetLibraryInfo *TLI;
718 };
719
720 /// Utility class for getting and setting loop vectorizer hints in the form
721 /// of loop metadata.
722 struct LoopVectorizeHints {
723   /// Vectorization width.
724   unsigned Width;
725   /// Vectorization unroll factor.
726   unsigned Unroll;
727
728   LoopVectorizeHints(const Loop *L)
729   : Width(VectorizationFactor)
730   , Unroll(VectorizationUnroll)
731   , LoopID(L->getLoopID()) {
732     getHints(L);
733     // The command line options override any loop metadata except for when
734     // width == 1 which is used to indicate the loop is already vectorized.
735     if (VectorizationFactor.getNumOccurrences() > 0 && Width != 1)
736       Width = VectorizationFactor;
737     if (VectorizationUnroll.getNumOccurrences() > 0)
738       Unroll = VectorizationUnroll;
739   }
740
741   /// Return the loop vectorizer metadata prefix.
742   static StringRef Prefix() { return "llvm.vectorizer."; }
743
744   MDNode *createHint(LLVMContext &Context, StringRef Name, unsigned V) {
745     SmallVector<Value*, 2> Vals;
746     Vals.push_back(MDString::get(Context, Name));
747     Vals.push_back(ConstantInt::get(Type::getInt32Ty(Context), V));
748     return MDNode::get(Context, Vals);
749   }
750
751   /// Mark the loop L as already vectorized by setting the width to 1.
752   void setAlreadyVectorized(Loop *L) {
753     LLVMContext &Context = L->getHeader()->getContext();
754
755     Width = 1;
756
757     // Create a new loop id with one more operand for the already_vectorized
758     // hint. If the loop already has a loop id then copy the existing operands.
759     SmallVector<Value*, 4> Vals(1);
760     if (LoopID)
761       for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i)
762         Vals.push_back(LoopID->getOperand(i));
763
764     Vals.push_back(createHint(Context, Twine(Prefix(), "width").str(), Width));
765
766     MDNode *NewLoopID = MDNode::get(Context, Vals);
767     // Set operand 0 to refer to the loop id itself.
768     NewLoopID->replaceOperandWith(0, NewLoopID);
769
770     L->setLoopID(NewLoopID);
771     if (LoopID)
772       LoopID->replaceAllUsesWith(NewLoopID);
773
774     LoopID = NewLoopID;
775   }
776
777 private:
778   MDNode *LoopID;
779
780   /// Find hints specified in the loop metadata.
781   void getHints(const Loop *L) {
782     if (!LoopID)
783       return;
784
785     // First operand should refer to the loop id itself.
786     assert(LoopID->getNumOperands() > 0 && "requires at least one operand");
787     assert(LoopID->getOperand(0) == LoopID && "invalid loop id");
788
789     for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
790       const MDString *S = 0;
791       SmallVector<Value*, 4> Args;
792
793       // The expected hint is either a MDString or a MDNode with the first
794       // operand a MDString.
795       if (const MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i))) {
796         if (!MD || MD->getNumOperands() == 0)
797           continue;
798         S = dyn_cast<MDString>(MD->getOperand(0));
799         for (unsigned i = 1, ie = MD->getNumOperands(); i < ie; ++i)
800           Args.push_back(MD->getOperand(i));
801       } else {
802         S = dyn_cast<MDString>(LoopID->getOperand(i));
803         assert(Args.size() == 0 && "too many arguments for MDString");
804       }
805
806       if (!S)
807         continue;
808
809       // Check if the hint starts with the vectorizer prefix.
810       StringRef Hint = S->getString();
811       if (!Hint.startswith(Prefix()))
812         continue;
813       // Remove the prefix.
814       Hint = Hint.substr(Prefix().size(), StringRef::npos);
815
816       if (Args.size() == 1)
817         getHint(Hint, Args[0]);
818     }
819   }
820
821   // Check string hint with one operand.
822   void getHint(StringRef Hint, Value *Arg) {
823     const ConstantInt *C = dyn_cast<ConstantInt>(Arg);
824     if (!C) return;
825     unsigned Val = C->getZExtValue();
826
827     if (Hint == "width") {
828       assert(isPowerOf2_32(Val) && Val <= MaxVectorWidth &&
829              "Invalid width metadata");
830       Width = Val;
831     } else if (Hint == "unroll") {
832       assert(isPowerOf2_32(Val) && Val <= MaxUnrollFactor &&
833              "Invalid unroll metadata");
834       Unroll = Val;
835     } else
836       DEBUG(dbgs() << "LV: ignoring unknown hint " << Hint);
837   }
838 };
839
840 /// The LoopVectorize Pass.
841 struct LoopVectorize : public LoopPass {
842   /// Pass identification, replacement for typeid
843   static char ID;
844
845   explicit LoopVectorize() : LoopPass(ID) {
846     initializeLoopVectorizePass(*PassRegistry::getPassRegistry());
847   }
848
849   ScalarEvolution *SE;
850   DataLayout *DL;
851   LoopInfo *LI;
852   TargetTransformInfo *TTI;
853   DominatorTree *DT;
854   TargetLibraryInfo *TLI;
855
856   virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
857     // We only vectorize innermost loops.
858     if (!L->empty())
859       return false;
860
861     SE = &getAnalysis<ScalarEvolution>();
862     DL = getAnalysisIfAvailable<DataLayout>();
863     LI = &getAnalysis<LoopInfo>();
864     TTI = &getAnalysis<TargetTransformInfo>();
865     DT = &getAnalysis<DominatorTree>();
866     TLI = getAnalysisIfAvailable<TargetLibraryInfo>();
867
868     if (DL == NULL) {
869       DEBUG(dbgs() << "LV: Not vectorizing because of missing data layout");
870       return false;
871     }
872
873     DEBUG(dbgs() << "LV: Checking a loop in \"" <<
874           L->getHeader()->getParent()->getName() << "\"\n");
875
876     LoopVectorizeHints Hints(L);
877
878     if (Hints.Width == 1) {
879       DEBUG(dbgs() << "LV: Not vectorizing.\n");
880       return false;
881     }
882
883     // Check if it is legal to vectorize the loop.
884     LoopVectorizationLegality LVL(L, SE, DL, DT, TLI);
885     if (!LVL.canVectorize()) {
886       DEBUG(dbgs() << "LV: Not vectorizing.\n");
887       return false;
888     }
889
890     // Use the cost model.
891     LoopVectorizationCostModel CM(L, SE, LI, &LVL, *TTI, DL, TLI);
892
893     // Check the function attributes to find out if this function should be
894     // optimized for size.
895     Function *F = L->getHeader()->getParent();
896     Attribute::AttrKind SzAttr = Attribute::OptimizeForSize;
897     Attribute::AttrKind FlAttr = Attribute::NoImplicitFloat;
898     unsigned FnIndex = AttributeSet::FunctionIndex;
899     bool OptForSize = F->getAttributes().hasAttribute(FnIndex, SzAttr);
900     bool NoFloat = F->getAttributes().hasAttribute(FnIndex, FlAttr);
901
902     if (NoFloat) {
903       DEBUG(dbgs() << "LV: Can't vectorize when the NoImplicitFloat"
904             "attribute is used.\n");
905       return false;
906     }
907
908     // Select the optimal vectorization factor.
909     LoopVectorizationCostModel::VectorizationFactor VF;
910     VF = CM.selectVectorizationFactor(OptForSize, Hints.Width);
911     // Select the unroll factor.
912     unsigned UF = CM.selectUnrollFactor(OptForSize, Hints.Unroll, VF.Width,
913                                         VF.Cost);
914
915     if (VF.Width == 1) {
916       DEBUG(dbgs() << "LV: Vectorization is possible but not beneficial.\n");
917       return false;
918     }
919
920     DEBUG(dbgs() << "LV: Found a vectorizable loop ("<< VF.Width << ") in "<<
921           F->getParent()->getModuleIdentifier()<<"\n");
922     DEBUG(dbgs() << "LV: Unroll Factor is " << UF << "\n");
923
924     // If we decided that it is *legal* to vectorize the loop then do it.
925     InnerLoopVectorizer LB(L, SE, LI, DT, DL, TLI, VF.Width, UF);
926     LB.vectorize(&LVL);
927
928     // Mark the loop as already vectorized to avoid vectorizing again.
929     Hints.setAlreadyVectorized(L);
930
931     DEBUG(verifyFunction(*L->getHeader()->getParent()));
932     return true;
933   }
934
935   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
936     LoopPass::getAnalysisUsage(AU);
937     AU.addRequiredID(LoopSimplifyID);
938     AU.addRequiredID(LCSSAID);
939     AU.addRequired<DominatorTree>();
940     AU.addRequired<LoopInfo>();
941     AU.addRequired<ScalarEvolution>();
942     AU.addRequired<TargetTransformInfo>();
943     AU.addPreserved<LoopInfo>();
944     AU.addPreserved<DominatorTree>();
945   }
946
947 };
948
949 } // end anonymous namespace
950
951 //===----------------------------------------------------------------------===//
952 // Implementation of LoopVectorizationLegality, InnerLoopVectorizer and
953 // LoopVectorizationCostModel.
954 //===----------------------------------------------------------------------===//
955
956 void
957 LoopVectorizationLegality::RuntimePointerCheck::insert(ScalarEvolution *SE,
958                                                        Loop *Lp, Value *Ptr,
959                                                        bool WritePtr,
960                                                        unsigned DepSetId) {
961   const SCEV *Sc = SE->getSCEV(Ptr);
962   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Sc);
963   assert(AR && "Invalid addrec expression");
964   const SCEV *Ex = SE->getBackedgeTakenCount(Lp);
965   const SCEV *ScEnd = AR->evaluateAtIteration(Ex, *SE);
966   Pointers.push_back(Ptr);
967   Starts.push_back(AR->getStart());
968   Ends.push_back(ScEnd);
969   IsWritePtr.push_back(WritePtr);
970   DependencySetId.push_back(DepSetId);
971 }
972
973 Value *InnerLoopVectorizer::getBroadcastInstrs(Value *V) {
974   // Save the current insertion location.
975   Instruction *Loc = Builder.GetInsertPoint();
976
977   // We need to place the broadcast of invariant variables outside the loop.
978   Instruction *Instr = dyn_cast<Instruction>(V);
979   bool NewInstr = (Instr && Instr->getParent() == LoopVectorBody);
980   bool Invariant = OrigLoop->isLoopInvariant(V) && !NewInstr;
981
982   // Place the code for broadcasting invariant variables in the new preheader.
983   if (Invariant)
984     Builder.SetInsertPoint(LoopVectorPreHeader->getTerminator());
985
986   // Broadcast the scalar into all locations in the vector.
987   Value *Shuf = Builder.CreateVectorSplat(VF, V, "broadcast");
988
989   // Restore the builder insertion point.
990   if (Invariant)
991     Builder.SetInsertPoint(Loc);
992
993   return Shuf;
994 }
995
996 Value *InnerLoopVectorizer::getConsecutiveVector(Value* Val, int StartIdx,
997                                                  bool Negate) {
998   assert(Val->getType()->isVectorTy() && "Must be a vector");
999   assert(Val->getType()->getScalarType()->isIntegerTy() &&
1000          "Elem must be an integer");
1001   // Create the types.
1002   Type *ITy = Val->getType()->getScalarType();
1003   VectorType *Ty = cast<VectorType>(Val->getType());
1004   int VLen = Ty->getNumElements();
1005   SmallVector<Constant*, 8> Indices;
1006
1007   // Create a vector of consecutive numbers from zero to VF.
1008   for (int i = 0; i < VLen; ++i) {
1009     int64_t Idx = Negate ? (-i) : i;
1010     Indices.push_back(ConstantInt::get(ITy, StartIdx + Idx, Negate));
1011   }
1012
1013   // Add the consecutive indices to the vector value.
1014   Constant *Cv = ConstantVector::get(Indices);
1015   assert(Cv->getType() == Val->getType() && "Invalid consecutive vec");
1016   return Builder.CreateAdd(Val, Cv, "induction");
1017 }
1018
1019 int LoopVectorizationLegality::isConsecutivePtr(Value *Ptr) {
1020   assert(Ptr->getType()->isPointerTy() && "Unexpected non ptr");
1021   // Make sure that the pointer does not point to structs.
1022   if (cast<PointerType>(Ptr->getType())->getElementType()->isAggregateType())
1023     return 0;
1024
1025   // If this value is a pointer induction variable we know it is consecutive.
1026   PHINode *Phi = dyn_cast_or_null<PHINode>(Ptr);
1027   if (Phi && Inductions.count(Phi)) {
1028     InductionInfo II = Inductions[Phi];
1029     if (IK_PtrInduction == II.IK)
1030       return 1;
1031     else if (IK_ReversePtrInduction == II.IK)
1032       return -1;
1033   }
1034
1035   GetElementPtrInst *Gep = dyn_cast_or_null<GetElementPtrInst>(Ptr);
1036   if (!Gep)
1037     return 0;
1038
1039   unsigned NumOperands = Gep->getNumOperands();
1040   Value *LastIndex = Gep->getOperand(NumOperands - 1);
1041
1042   Value *GpPtr = Gep->getPointerOperand();
1043   // If this GEP value is a consecutive pointer induction variable and all of
1044   // the indices are constant then we know it is consecutive. We can
1045   Phi = dyn_cast<PHINode>(GpPtr);
1046   if (Phi && Inductions.count(Phi)) {
1047
1048     // Make sure that the pointer does not point to structs.
1049     PointerType *GepPtrType = cast<PointerType>(GpPtr->getType());
1050     if (GepPtrType->getElementType()->isAggregateType())
1051       return 0;
1052
1053     // Make sure that all of the index operands are loop invariant.
1054     for (unsigned i = 1; i < NumOperands; ++i)
1055       if (!SE->isLoopInvariant(SE->getSCEV(Gep->getOperand(i)), TheLoop))
1056         return 0;
1057
1058     InductionInfo II = Inductions[Phi];
1059     if (IK_PtrInduction == II.IK)
1060       return 1;
1061     else if (IK_ReversePtrInduction == II.IK)
1062       return -1;
1063   }
1064
1065   // Check that all of the gep indices are uniform except for the last.
1066   for (unsigned i = 0; i < NumOperands - 1; ++i)
1067     if (!SE->isLoopInvariant(SE->getSCEV(Gep->getOperand(i)), TheLoop))
1068       return 0;
1069
1070   // We can emit wide load/stores only if the last index is the induction
1071   // variable.
1072   const SCEV *Last = SE->getSCEV(LastIndex);
1073   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Last)) {
1074     const SCEV *Step = AR->getStepRecurrence(*SE);
1075
1076     // The memory is consecutive because the last index is consecutive
1077     // and all other indices are loop invariant.
1078     if (Step->isOne())
1079       return 1;
1080     if (Step->isAllOnesValue())
1081       return -1;
1082   }
1083
1084   return 0;
1085 }
1086
1087 bool LoopVectorizationLegality::isUniform(Value *V) {
1088   return (SE->isLoopInvariant(SE->getSCEV(V), TheLoop));
1089 }
1090
1091 InnerLoopVectorizer::VectorParts&
1092 InnerLoopVectorizer::getVectorValue(Value *V) {
1093   assert(V != Induction && "The new induction variable should not be used.");
1094   assert(!V->getType()->isVectorTy() && "Can't widen a vector");
1095
1096   // If we have this scalar in the map, return it.
1097   if (WidenMap.has(V))
1098     return WidenMap.get(V);
1099
1100   // If this scalar is unknown, assume that it is a constant or that it is
1101   // loop invariant. Broadcast V and save the value for future uses.
1102   Value *B = getBroadcastInstrs(V);
1103   return WidenMap.splat(V, B);
1104 }
1105
1106 Value *InnerLoopVectorizer::reverseVector(Value *Vec) {
1107   assert(Vec->getType()->isVectorTy() && "Invalid type");
1108   SmallVector<Constant*, 8> ShuffleMask;
1109   for (unsigned i = 0; i < VF; ++i)
1110     ShuffleMask.push_back(Builder.getInt32(VF - i - 1));
1111
1112   return Builder.CreateShuffleVector(Vec, UndefValue::get(Vec->getType()),
1113                                      ConstantVector::get(ShuffleMask),
1114                                      "reverse");
1115 }
1116
1117
1118 void InnerLoopVectorizer::vectorizeMemoryInstruction(Instruction *Instr,
1119                                              LoopVectorizationLegality *Legal) {
1120   // Attempt to issue a wide load.
1121   LoadInst *LI = dyn_cast<LoadInst>(Instr);
1122   StoreInst *SI = dyn_cast<StoreInst>(Instr);
1123
1124   assert((LI || SI) && "Invalid Load/Store instruction");
1125
1126   Type *ScalarDataTy = LI ? LI->getType() : SI->getValueOperand()->getType();
1127   Type *DataTy = VectorType::get(ScalarDataTy, VF);
1128   Value *Ptr = LI ? LI->getPointerOperand() : SI->getPointerOperand();
1129   unsigned Alignment = LI ? LI->getAlignment() : SI->getAlignment();
1130   unsigned AddressSpace = Ptr->getType()->getPointerAddressSpace();
1131   unsigned ScalarAllocatedSize = DL->getTypeAllocSize(ScalarDataTy);
1132   unsigned VectorElementSize = DL->getTypeStoreSize(DataTy)/VF;
1133
1134   if (ScalarAllocatedSize != VectorElementSize)
1135     return scalarizeInstruction(Instr);
1136
1137   // If the pointer is loop invariant or if it is non consecutive,
1138   // scalarize the load.
1139   int ConsecutiveStride = Legal->isConsecutivePtr(Ptr);
1140   bool Reverse = ConsecutiveStride < 0;
1141   bool UniformLoad = LI && Legal->isUniform(Ptr);
1142   if (!ConsecutiveStride || UniformLoad)
1143     return scalarizeInstruction(Instr);
1144
1145   Constant *Zero = Builder.getInt32(0);
1146   VectorParts &Entry = WidenMap.get(Instr);
1147
1148   // Handle consecutive loads/stores.
1149   GetElementPtrInst *Gep = dyn_cast<GetElementPtrInst>(Ptr);
1150   if (Gep && Legal->isInductionVariable(Gep->getPointerOperand())) {
1151     setDebugLocFromInst(Builder, Gep);
1152     Value *PtrOperand = Gep->getPointerOperand();
1153     Value *FirstBasePtr = getVectorValue(PtrOperand)[0];
1154     FirstBasePtr = Builder.CreateExtractElement(FirstBasePtr, Zero);
1155
1156     // Create the new GEP with the new induction variable.
1157     GetElementPtrInst *Gep2 = cast<GetElementPtrInst>(Gep->clone());
1158     Gep2->setOperand(0, FirstBasePtr);
1159     Gep2->setName("gep.indvar.base");
1160     Ptr = Builder.Insert(Gep2);
1161   } else if (Gep) {
1162     setDebugLocFromInst(Builder, Gep);
1163     assert(SE->isLoopInvariant(SE->getSCEV(Gep->getPointerOperand()),
1164                                OrigLoop) && "Base ptr must be invariant");
1165
1166     // The last index does not have to be the induction. It can be
1167     // consecutive and be a function of the index. For example A[I+1];
1168     unsigned NumOperands = Gep->getNumOperands();
1169     unsigned LastOperand = NumOperands - 1;
1170     // Create the new GEP with the new induction variable.
1171     GetElementPtrInst *Gep2 = cast<GetElementPtrInst>(Gep->clone());
1172
1173     for (unsigned i = 0; i < NumOperands; ++i) {
1174       Value *GepOperand = Gep->getOperand(i);
1175       Instruction *GepOperandInst = dyn_cast<Instruction>(GepOperand);
1176
1177       // Update last index or loop invariant instruction anchored in loop.
1178       if (i == LastOperand ||
1179           (GepOperandInst && OrigLoop->contains(GepOperandInst))) {
1180         assert((i == LastOperand ||
1181                SE->isLoopInvariant(SE->getSCEV(GepOperandInst), OrigLoop)) &&
1182                "Must be last index or loop invariant");
1183
1184         VectorParts &GEPParts = getVectorValue(GepOperand);
1185         Value *Index = GEPParts[0];
1186         Index = Builder.CreateExtractElement(Index, Zero);
1187         Gep2->setOperand(i, Index);
1188         Gep2->setName("gep.indvar.idx");
1189       }
1190     }
1191     Ptr = Builder.Insert(Gep2);
1192   } else {
1193     // Use the induction element ptr.
1194     assert(isa<PHINode>(Ptr) && "Invalid induction ptr");
1195     setDebugLocFromInst(Builder, Ptr);
1196     VectorParts &PtrVal = getVectorValue(Ptr);
1197     Ptr = Builder.CreateExtractElement(PtrVal[0], Zero);
1198   }
1199
1200   // Handle Stores:
1201   if (SI) {
1202     assert(!Legal->isUniform(SI->getPointerOperand()) &&
1203            "We do not allow storing to uniform addresses");
1204     setDebugLocFromInst(Builder, SI);
1205     // We don't want to update the value in the map as it might be used in
1206     // another expression. So don't use a reference type for "StoredVal".
1207     VectorParts StoredVal = getVectorValue(SI->getValueOperand());
1208
1209     for (unsigned Part = 0; Part < UF; ++Part) {
1210       // Calculate the pointer for the specific unroll-part.
1211       Value *PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(Part * VF));
1212
1213       if (Reverse) {
1214         // If we store to reverse consecutive memory locations then we need
1215         // to reverse the order of elements in the stored value.
1216         StoredVal[Part] = reverseVector(StoredVal[Part]);
1217         // If the address is consecutive but reversed, then the
1218         // wide store needs to start at the last vector element.
1219         PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(-Part * VF));
1220         PartPtr = Builder.CreateGEP(PartPtr, Builder.getInt32(1 - VF));
1221       }
1222
1223       Value *VecPtr = Builder.CreateBitCast(PartPtr,
1224                                             DataTy->getPointerTo(AddressSpace));
1225       Builder.CreateStore(StoredVal[Part], VecPtr)->setAlignment(Alignment);
1226     }
1227     return;
1228   }
1229
1230   // Handle loads.
1231   assert(LI && "Must have a load instruction");
1232   setDebugLocFromInst(Builder, LI);
1233   for (unsigned Part = 0; Part < UF; ++Part) {
1234     // Calculate the pointer for the specific unroll-part.
1235     Value *PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(Part * VF));
1236
1237     if (Reverse) {
1238       // If the address is consecutive but reversed, then the
1239       // wide store needs to start at the last vector element.
1240       PartPtr = Builder.CreateGEP(Ptr, Builder.getInt32(-Part * VF));
1241       PartPtr = Builder.CreateGEP(PartPtr, Builder.getInt32(1 - VF));
1242     }
1243
1244     Value *VecPtr = Builder.CreateBitCast(PartPtr,
1245                                           DataTy->getPointerTo(AddressSpace));
1246     Value *LI = Builder.CreateLoad(VecPtr, "wide.load");
1247     cast<LoadInst>(LI)->setAlignment(Alignment);
1248     Entry[Part] = Reverse ? reverseVector(LI) :  LI;
1249   }
1250 }
1251
1252 void InnerLoopVectorizer::scalarizeInstruction(Instruction *Instr) {
1253   assert(!Instr->getType()->isAggregateType() && "Can't handle vectors");
1254   // Holds vector parameters or scalars, in case of uniform vals.
1255   SmallVector<VectorParts, 4> Params;
1256
1257   setDebugLocFromInst(Builder, Instr);
1258
1259   // Find all of the vectorized parameters.
1260   for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
1261     Value *SrcOp = Instr->getOperand(op);
1262
1263     // If we are accessing the old induction variable, use the new one.
1264     if (SrcOp == OldInduction) {
1265       Params.push_back(getVectorValue(SrcOp));
1266       continue;
1267     }
1268
1269     // Try using previously calculated values.
1270     Instruction *SrcInst = dyn_cast<Instruction>(SrcOp);
1271
1272     // If the src is an instruction that appeared earlier in the basic block
1273     // then it should already be vectorized.
1274     if (SrcInst && OrigLoop->contains(SrcInst)) {
1275       assert(WidenMap.has(SrcInst) && "Source operand is unavailable");
1276       // The parameter is a vector value from earlier.
1277       Params.push_back(WidenMap.get(SrcInst));
1278     } else {
1279       // The parameter is a scalar from outside the loop. Maybe even a constant.
1280       VectorParts Scalars;
1281       Scalars.append(UF, SrcOp);
1282       Params.push_back(Scalars);
1283     }
1284   }
1285
1286   assert(Params.size() == Instr->getNumOperands() &&
1287          "Invalid number of operands");
1288
1289   // Does this instruction return a value ?
1290   bool IsVoidRetTy = Instr->getType()->isVoidTy();
1291
1292   Value *UndefVec = IsVoidRetTy ? 0 :
1293     UndefValue::get(VectorType::get(Instr->getType(), VF));
1294   // Create a new entry in the WidenMap and initialize it to Undef or Null.
1295   VectorParts &VecResults = WidenMap.splat(Instr, UndefVec);
1296
1297   // For each vector unroll 'part':
1298   for (unsigned Part = 0; Part < UF; ++Part) {
1299     // For each scalar that we create:
1300     for (unsigned Width = 0; Width < VF; ++Width) {
1301       Instruction *Cloned = Instr->clone();
1302       if (!IsVoidRetTy)
1303         Cloned->setName(Instr->getName() + ".cloned");
1304       // Replace the operands of the cloned instrucions with extracted scalars.
1305       for (unsigned op = 0, e = Instr->getNumOperands(); op != e; ++op) {
1306         Value *Op = Params[op][Part];
1307         // Param is a vector. Need to extract the right lane.
1308         if (Op->getType()->isVectorTy())
1309           Op = Builder.CreateExtractElement(Op, Builder.getInt32(Width));
1310         Cloned->setOperand(op, Op);
1311       }
1312
1313       // Place the cloned scalar in the new loop.
1314       Builder.Insert(Cloned);
1315
1316       // If the original scalar returns a value we need to place it in a vector
1317       // so that future users will be able to use it.
1318       if (!IsVoidRetTy)
1319         VecResults[Part] = Builder.CreateInsertElement(VecResults[Part], Cloned,
1320                                                        Builder.getInt32(Width));
1321     }
1322   }
1323 }
1324
1325 Instruction *
1326 InnerLoopVectorizer::addRuntimeCheck(LoopVectorizationLegality *Legal,
1327                                      Instruction *Loc) {
1328   LoopVectorizationLegality::RuntimePointerCheck *PtrRtCheck =
1329   Legal->getRuntimePointerCheck();
1330
1331   if (!PtrRtCheck->Need)
1332     return NULL;
1333
1334   unsigned NumPointers = PtrRtCheck->Pointers.size();
1335   SmallVector<TrackingVH<Value> , 2> Starts;
1336   SmallVector<TrackingVH<Value> , 2> Ends;
1337
1338   SCEVExpander Exp(*SE, "induction");
1339
1340   // Use this type for pointer arithmetic.
1341   Type* PtrArithTy = Type::getInt8PtrTy(Loc->getContext(), 0);
1342
1343   for (unsigned i = 0; i < NumPointers; ++i) {
1344     Value *Ptr = PtrRtCheck->Pointers[i];
1345     const SCEV *Sc = SE->getSCEV(Ptr);
1346
1347     if (SE->isLoopInvariant(Sc, OrigLoop)) {
1348       DEBUG(dbgs() << "LV: Adding RT check for a loop invariant ptr:" <<
1349             *Ptr <<"\n");
1350       Starts.push_back(Ptr);
1351       Ends.push_back(Ptr);
1352     } else {
1353       DEBUG(dbgs() << "LV: Adding RT check for range:" << *Ptr <<"\n");
1354
1355       Value *Start = Exp.expandCodeFor(PtrRtCheck->Starts[i], PtrArithTy, Loc);
1356       Value *End = Exp.expandCodeFor(PtrRtCheck->Ends[i], PtrArithTy, Loc);
1357       Starts.push_back(Start);
1358       Ends.push_back(End);
1359     }
1360   }
1361
1362   IRBuilder<> ChkBuilder(Loc);
1363   // Our instructions might fold to a constant.
1364   Value *MemoryRuntimeCheck = 0;
1365   for (unsigned i = 0; i < NumPointers; ++i) {
1366     for (unsigned j = i+1; j < NumPointers; ++j) {
1367       // No need to check if two readonly pointers intersect.
1368       if (!PtrRtCheck->IsWritePtr[i] && !PtrRtCheck->IsWritePtr[j])
1369         continue;
1370
1371       // Only need to check pointers between two different dependency sets.
1372       if (PtrRtCheck->DependencySetId[i] == PtrRtCheck->DependencySetId[j])
1373        continue;
1374
1375       Value *Start0 = ChkBuilder.CreateBitCast(Starts[i], PtrArithTy, "bc");
1376       Value *Start1 = ChkBuilder.CreateBitCast(Starts[j], PtrArithTy, "bc");
1377       Value *End0 =   ChkBuilder.CreateBitCast(Ends[i],   PtrArithTy, "bc");
1378       Value *End1 =   ChkBuilder.CreateBitCast(Ends[j],   PtrArithTy, "bc");
1379
1380       Value *Cmp0 = ChkBuilder.CreateICmpULE(Start0, End1, "bound0");
1381       Value *Cmp1 = ChkBuilder.CreateICmpULE(Start1, End0, "bound1");
1382       Value *IsConflict = ChkBuilder.CreateAnd(Cmp0, Cmp1, "found.conflict");
1383       if (MemoryRuntimeCheck)
1384         IsConflict = ChkBuilder.CreateOr(MemoryRuntimeCheck, IsConflict,
1385                                          "conflict.rdx");
1386       MemoryRuntimeCheck = IsConflict;
1387     }
1388   }
1389
1390   // We have to do this trickery because the IRBuilder might fold the check to a
1391   // constant expression in which case there is no Instruction anchored in a
1392   // the block.
1393   LLVMContext &Ctx = Loc->getContext();
1394   Instruction * Check = BinaryOperator::CreateAnd(MemoryRuntimeCheck,
1395                                                   ConstantInt::getTrue(Ctx));
1396   ChkBuilder.Insert(Check, "memcheck.conflict");
1397   return Check;
1398 }
1399
1400 void
1401 InnerLoopVectorizer::createEmptyLoop(LoopVectorizationLegality *Legal) {
1402   /*
1403    In this function we generate a new loop. The new loop will contain
1404    the vectorized instructions while the old loop will continue to run the
1405    scalar remainder.
1406
1407        [ ] <-- vector loop bypass (may consist of multiple blocks).
1408      /  |
1409     /   v
1410    |   [ ]     <-- vector pre header.
1411    |    |
1412    |    v
1413    |   [  ] \
1414    |   [  ]_|   <-- vector loop.
1415    |    |
1416     \   v
1417       >[ ]   <--- middle-block.
1418      /  |
1419     /   v
1420    |   [ ]     <--- new preheader.
1421    |    |
1422    |    v
1423    |   [ ] \
1424    |   [ ]_|   <-- old scalar loop to handle remainder.
1425     \   |
1426      \  v
1427       >[ ]     <-- exit block.
1428    ...
1429    */
1430
1431   BasicBlock *OldBasicBlock = OrigLoop->getHeader();
1432   BasicBlock *BypassBlock = OrigLoop->getLoopPreheader();
1433   BasicBlock *ExitBlock = OrigLoop->getExitBlock();
1434   assert(ExitBlock && "Must have an exit block");
1435
1436   // Some loops have a single integer induction variable, while other loops
1437   // don't. One example is c++ iterators that often have multiple pointer
1438   // induction variables. In the code below we also support a case where we
1439   // don't have a single induction variable.
1440   OldInduction = Legal->getInduction();
1441   Type *IdxTy = Legal->getWidestInductionType();
1442
1443   // Find the loop boundaries.
1444   const SCEV *ExitCount = SE->getBackedgeTakenCount(OrigLoop);
1445   assert(ExitCount != SE->getCouldNotCompute() && "Invalid loop count");
1446
1447   // Get the total trip count from the count by adding 1.
1448   ExitCount = SE->getAddExpr(ExitCount,
1449                              SE->getConstant(ExitCount->getType(), 1));
1450
1451   // Expand the trip count and place the new instructions in the preheader.
1452   // Notice that the pre-header does not change, only the loop body.
1453   SCEVExpander Exp(*SE, "induction");
1454
1455   // Count holds the overall loop count (N).
1456   Value *Count = Exp.expandCodeFor(ExitCount, ExitCount->getType(),
1457                                    BypassBlock->getTerminator());
1458
1459   // The loop index does not have to start at Zero. Find the original start
1460   // value from the induction PHI node. If we don't have an induction variable
1461   // then we know that it starts at zero.
1462   Builder.SetInsertPoint(BypassBlock->getTerminator());
1463   Value *StartIdx = ExtendedIdx = OldInduction ?
1464     Builder.CreateZExt(OldInduction->getIncomingValueForBlock(BypassBlock),
1465                        IdxTy):
1466     ConstantInt::get(IdxTy, 0);
1467
1468   assert(BypassBlock && "Invalid loop structure");
1469   LoopBypassBlocks.push_back(BypassBlock);
1470
1471   // Split the single block loop into the two loop structure described above.
1472   BasicBlock *VectorPH =
1473   BypassBlock->splitBasicBlock(BypassBlock->getTerminator(), "vector.ph");
1474   BasicBlock *VecBody =
1475   VectorPH->splitBasicBlock(VectorPH->getTerminator(), "vector.body");
1476   BasicBlock *MiddleBlock =
1477   VecBody->splitBasicBlock(VecBody->getTerminator(), "middle.block");
1478   BasicBlock *ScalarPH =
1479   MiddleBlock->splitBasicBlock(MiddleBlock->getTerminator(), "scalar.ph");
1480
1481   // Create and register the new vector loop.
1482   Loop* Lp = new Loop();
1483   Loop *ParentLoop = OrigLoop->getParentLoop();
1484
1485   // Insert the new loop into the loop nest and register the new basic blocks
1486   // before calling any utilities such as SCEV that require valid LoopInfo.
1487   if (ParentLoop) {
1488     ParentLoop->addChildLoop(Lp);
1489     ParentLoop->addBasicBlockToLoop(ScalarPH, LI->getBase());
1490     ParentLoop->addBasicBlockToLoop(VectorPH, LI->getBase());
1491     ParentLoop->addBasicBlockToLoop(MiddleBlock, LI->getBase());
1492   } else {
1493     LI->addTopLevelLoop(Lp);
1494   }
1495   Lp->addBasicBlockToLoop(VecBody, LI->getBase());
1496
1497   // Use this IR builder to create the loop instructions (Phi, Br, Cmp)
1498   // inside the loop.
1499   Builder.SetInsertPoint(VecBody->getFirstInsertionPt());
1500
1501   // Generate the induction variable.
1502   setDebugLocFromInst(Builder, getDebugLocFromInstOrOperands(OldInduction));
1503   Induction = Builder.CreatePHI(IdxTy, 2, "index");
1504   // The loop step is equal to the vectorization factor (num of SIMD elements)
1505   // times the unroll factor (num of SIMD instructions).
1506   Constant *Step = ConstantInt::get(IdxTy, VF * UF);
1507
1508   // This is the IR builder that we use to add all of the logic for bypassing
1509   // the new vector loop.
1510   IRBuilder<> BypassBuilder(BypassBlock->getTerminator());
1511   setDebugLocFromInst(BypassBuilder,
1512                       getDebugLocFromInstOrOperands(OldInduction));
1513
1514   // We may need to extend the index in case there is a type mismatch.
1515   // We know that the count starts at zero and does not overflow.
1516   if (Count->getType() != IdxTy) {
1517     // The exit count can be of pointer type. Convert it to the correct
1518     // integer type.
1519     if (ExitCount->getType()->isPointerTy())
1520       Count = BypassBuilder.CreatePointerCast(Count, IdxTy, "ptrcnt.to.int");
1521     else
1522       Count = BypassBuilder.CreateZExtOrTrunc(Count, IdxTy, "cnt.cast");
1523   }
1524
1525   // Add the start index to the loop count to get the new end index.
1526   Value *IdxEnd = BypassBuilder.CreateAdd(Count, StartIdx, "end.idx");
1527
1528   // Now we need to generate the expression for N - (N % VF), which is
1529   // the part that the vectorized body will execute.
1530   Value *R = BypassBuilder.CreateURem(Count, Step, "n.mod.vf");
1531   Value *CountRoundDown = BypassBuilder.CreateSub(Count, R, "n.vec");
1532   Value *IdxEndRoundDown = BypassBuilder.CreateAdd(CountRoundDown, StartIdx,
1533                                                      "end.idx.rnd.down");
1534
1535   // Now, compare the new count to zero. If it is zero skip the vector loop and
1536   // jump to the scalar loop.
1537   Value *Cmp = BypassBuilder.CreateICmpEQ(IdxEndRoundDown, StartIdx,
1538                                           "cmp.zero");
1539
1540   BasicBlock *LastBypassBlock = BypassBlock;
1541
1542   // Generate the code that checks in runtime if arrays overlap. We put the
1543   // checks into a separate block to make the more common case of few elements
1544   // faster.
1545   Instruction *MemRuntimeCheck = addRuntimeCheck(Legal,
1546                                                  BypassBlock->getTerminator());
1547   if (MemRuntimeCheck) {
1548     // Create a new block containing the memory check.
1549     BasicBlock *CheckBlock = BypassBlock->splitBasicBlock(MemRuntimeCheck,
1550                                                           "vector.memcheck");
1551     if (ParentLoop)
1552       ParentLoop->addBasicBlockToLoop(CheckBlock, LI->getBase());
1553     LoopBypassBlocks.push_back(CheckBlock);
1554
1555     // Replace the branch into the memory check block with a conditional branch
1556     // for the "few elements case".
1557     Instruction *OldTerm = BypassBlock->getTerminator();
1558     BranchInst::Create(MiddleBlock, CheckBlock, Cmp, OldTerm);
1559     OldTerm->eraseFromParent();
1560
1561     Cmp = MemRuntimeCheck;
1562     LastBypassBlock = CheckBlock;
1563   }
1564
1565   LastBypassBlock->getTerminator()->eraseFromParent();
1566   BranchInst::Create(MiddleBlock, VectorPH, Cmp,
1567                      LastBypassBlock);
1568
1569   // We are going to resume the execution of the scalar loop.
1570   // Go over all of the induction variables that we found and fix the
1571   // PHIs that are left in the scalar version of the loop.
1572   // The starting values of PHI nodes depend on the counter of the last
1573   // iteration in the vectorized loop.
1574   // If we come from a bypass edge then we need to start from the original
1575   // start value.
1576
1577   // This variable saves the new starting index for the scalar loop.
1578   PHINode *ResumeIndex = 0;
1579   LoopVectorizationLegality::InductionList::iterator I, E;
1580   LoopVectorizationLegality::InductionList *List = Legal->getInductionVars();
1581   // Set builder to point to last bypass block.
1582   BypassBuilder.SetInsertPoint(LoopBypassBlocks.back()->getTerminator());
1583   for (I = List->begin(), E = List->end(); I != E; ++I) {
1584     PHINode *OrigPhi = I->first;
1585     LoopVectorizationLegality::InductionInfo II = I->second;
1586
1587     Type *ResumeValTy = (OrigPhi == OldInduction) ? IdxTy : OrigPhi->getType();
1588     PHINode *ResumeVal = PHINode::Create(ResumeValTy, 2, "resume.val",
1589                                          MiddleBlock->getTerminator());
1590     // We might have extended the type of the induction variable but we need a
1591     // truncated version for the scalar loop.
1592     PHINode *TruncResumeVal = (OrigPhi == OldInduction) ?
1593       PHINode::Create(OrigPhi->getType(), 2, "trunc.resume.val",
1594                       MiddleBlock->getTerminator()) : 0;
1595
1596     Value *EndValue = 0;
1597     switch (II.IK) {
1598     case LoopVectorizationLegality::IK_NoInduction:
1599       llvm_unreachable("Unknown induction");
1600     case LoopVectorizationLegality::IK_IntInduction: {
1601       // Handle the integer induction counter.
1602       assert(OrigPhi->getType()->isIntegerTy() && "Invalid type");
1603
1604       // We have the canonical induction variable.
1605       if (OrigPhi == OldInduction) {
1606         // Create a truncated version of the resume value for the scalar loop,
1607         // we might have promoted the type to a larger width.
1608         EndValue =
1609           BypassBuilder.CreateTrunc(IdxEndRoundDown, OrigPhi->getType());
1610         // The new PHI merges the original incoming value, in case of a bypass,
1611         // or the value at the end of the vectorized loop.
1612         for (unsigned I = 0, E = LoopBypassBlocks.size(); I != E; ++I)
1613           TruncResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[I]);
1614         TruncResumeVal->addIncoming(EndValue, VecBody);
1615
1616         // We know what the end value is.
1617         EndValue = IdxEndRoundDown;
1618         // We also know which PHI node holds it.
1619         ResumeIndex = ResumeVal;
1620         break;
1621       }
1622
1623       // Not the canonical induction variable - add the vector loop count to the
1624       // start value.
1625       Value *CRD = BypassBuilder.CreateSExtOrTrunc(CountRoundDown,
1626                                                    II.StartValue->getType(),
1627                                                    "cast.crd");
1628       EndValue = BypassBuilder.CreateAdd(CRD, II.StartValue , "ind.end");
1629       break;
1630     }
1631     case LoopVectorizationLegality::IK_ReverseIntInduction: {
1632       // Convert the CountRoundDown variable to the PHI size.
1633       Value *CRD = BypassBuilder.CreateSExtOrTrunc(CountRoundDown,
1634                                                    II.StartValue->getType(),
1635                                                    "cast.crd");
1636       // Handle reverse integer induction counter.
1637       EndValue = BypassBuilder.CreateSub(II.StartValue, CRD, "rev.ind.end");
1638       break;
1639     }
1640     case LoopVectorizationLegality::IK_PtrInduction: {
1641       // For pointer induction variables, calculate the offset using
1642       // the end index.
1643       EndValue = BypassBuilder.CreateGEP(II.StartValue, CountRoundDown,
1644                                          "ptr.ind.end");
1645       break;
1646     }
1647     case LoopVectorizationLegality::IK_ReversePtrInduction: {
1648       // The value at the end of the loop for the reverse pointer is calculated
1649       // by creating a GEP with a negative index starting from the start value.
1650       Value *Zero = ConstantInt::get(CountRoundDown->getType(), 0);
1651       Value *NegIdx = BypassBuilder.CreateSub(Zero, CountRoundDown,
1652                                               "rev.ind.end");
1653       EndValue = BypassBuilder.CreateGEP(II.StartValue, NegIdx,
1654                                          "rev.ptr.ind.end");
1655       break;
1656     }
1657     }// end of case
1658
1659     // The new PHI merges the original incoming value, in case of a bypass,
1660     // or the value at the end of the vectorized loop.
1661     for (unsigned I = 0, E = LoopBypassBlocks.size(); I != E; ++I) {
1662       if (OrigPhi == OldInduction)
1663         ResumeVal->addIncoming(StartIdx, LoopBypassBlocks[I]);
1664       else
1665         ResumeVal->addIncoming(II.StartValue, LoopBypassBlocks[I]);
1666     }
1667     ResumeVal->addIncoming(EndValue, VecBody);
1668
1669     // Fix the scalar body counter (PHI node).
1670     unsigned BlockIdx = OrigPhi->getBasicBlockIndex(ScalarPH);
1671     // The old inductions phi node in the scalar body needs the truncated value.
1672     if (OrigPhi == OldInduction)
1673       OrigPhi->setIncomingValue(BlockIdx, TruncResumeVal);
1674     else
1675       OrigPhi->setIncomingValue(BlockIdx, ResumeVal);
1676   }
1677
1678   // If we are generating a new induction variable then we also need to
1679   // generate the code that calculates the exit value. This value is not
1680   // simply the end of the counter because we may skip the vectorized body
1681   // in case of a runtime check.
1682   if (!OldInduction){
1683     assert(!ResumeIndex && "Unexpected resume value found");
1684     ResumeIndex = PHINode::Create(IdxTy, 2, "new.indc.resume.val",
1685                                   MiddleBlock->getTerminator());
1686     for (unsigned I = 0, E = LoopBypassBlocks.size(); I != E; ++I)
1687       ResumeIndex->addIncoming(StartIdx, LoopBypassBlocks[I]);
1688     ResumeIndex->addIncoming(IdxEndRoundDown, VecBody);
1689   }
1690
1691   // Make sure that we found the index where scalar loop needs to continue.
1692   assert(ResumeIndex && ResumeIndex->getType()->isIntegerTy() &&
1693          "Invalid resume Index");
1694
1695   // Add a check in the middle block to see if we have completed
1696   // all of the iterations in the first vector loop.
1697   // If (N - N%VF) == N, then we *don't* need to run the remainder.
1698   Value *CmpN = CmpInst::Create(Instruction::ICmp, CmpInst::ICMP_EQ, IdxEnd,
1699                                 ResumeIndex, "cmp.n",
1700                                 MiddleBlock->getTerminator());
1701
1702   BranchInst::Create(ExitBlock, ScalarPH, CmpN, MiddleBlock->getTerminator());
1703   // Remove the old terminator.
1704   MiddleBlock->getTerminator()->eraseFromParent();
1705
1706   // Create i+1 and fill the PHINode.
1707   Value *NextIdx = Builder.CreateAdd(Induction, Step, "index.next");
1708   Induction->addIncoming(StartIdx, VectorPH);
1709   Induction->addIncoming(NextIdx, VecBody);
1710   // Create the compare.
1711   Value *ICmp = Builder.CreateICmpEQ(NextIdx, IdxEndRoundDown);
1712   Builder.CreateCondBr(ICmp, MiddleBlock, VecBody);
1713
1714   // Now we have two terminators. Remove the old one from the block.
1715   VecBody->getTerminator()->eraseFromParent();
1716
1717   // Get ready to start creating new instructions into the vectorized body.
1718   Builder.SetInsertPoint(VecBody->getFirstInsertionPt());
1719
1720   // Save the state.
1721   LoopVectorPreHeader = VectorPH;
1722   LoopScalarPreHeader = ScalarPH;
1723   LoopMiddleBlock = MiddleBlock;
1724   LoopExitBlock = ExitBlock;
1725   LoopVectorBody = VecBody;
1726   LoopScalarBody = OldBasicBlock;
1727 }
1728
1729 /// This function returns the identity element (or neutral element) for
1730 /// the operation K.
1731 Constant*
1732 LoopVectorizationLegality::getReductionIdentity(ReductionKind K, Type *Tp) {
1733   switch (K) {
1734   case RK_IntegerXor:
1735   case RK_IntegerAdd:
1736   case RK_IntegerOr:
1737     // Adding, Xoring, Oring zero to a number does not change it.
1738     return ConstantInt::get(Tp, 0);
1739   case RK_IntegerMult:
1740     // Multiplying a number by 1 does not change it.
1741     return ConstantInt::get(Tp, 1);
1742   case RK_IntegerAnd:
1743     // AND-ing a number with an all-1 value does not change it.
1744     return ConstantInt::get(Tp, -1, true);
1745   case  RK_FloatMult:
1746     // Multiplying a number by 1 does not change it.
1747     return ConstantFP::get(Tp, 1.0L);
1748   case  RK_FloatAdd:
1749     // Adding zero to a number does not change it.
1750     return ConstantFP::get(Tp, 0.0L);
1751   default:
1752     llvm_unreachable("Unknown reduction kind");
1753   }
1754 }
1755
1756 static Intrinsic::ID
1757 getIntrinsicIDForCall(CallInst *CI, const TargetLibraryInfo *TLI) {
1758   // If we have an intrinsic call, check if it is trivially vectorizable.
1759   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
1760     switch (II->getIntrinsicID()) {
1761     case Intrinsic::sqrt:
1762     case Intrinsic::sin:
1763     case Intrinsic::cos:
1764     case Intrinsic::exp:
1765     case Intrinsic::exp2:
1766     case Intrinsic::log:
1767     case Intrinsic::log10:
1768     case Intrinsic::log2:
1769     case Intrinsic::fabs:
1770     case Intrinsic::floor:
1771     case Intrinsic::ceil:
1772     case Intrinsic::trunc:
1773     case Intrinsic::rint:
1774     case Intrinsic::nearbyint:
1775     case Intrinsic::pow:
1776     case Intrinsic::fma:
1777     case Intrinsic::fmuladd:
1778       return II->getIntrinsicID();
1779     default:
1780       return Intrinsic::not_intrinsic;
1781     }
1782   }
1783
1784   if (!TLI)
1785     return Intrinsic::not_intrinsic;
1786
1787   LibFunc::Func Func;
1788   Function *F = CI->getCalledFunction();
1789   // We're going to make assumptions on the semantics of the functions, check
1790   // that the target knows that it's available in this environment.
1791   if (!F || !TLI->getLibFunc(F->getName(), Func))
1792     return Intrinsic::not_intrinsic;
1793
1794   // Otherwise check if we have a call to a function that can be turned into a
1795   // vector intrinsic.
1796   switch (Func) {
1797   default:
1798     break;
1799   case LibFunc::sin:
1800   case LibFunc::sinf:
1801   case LibFunc::sinl:
1802     return Intrinsic::sin;
1803   case LibFunc::cos:
1804   case LibFunc::cosf:
1805   case LibFunc::cosl:
1806     return Intrinsic::cos;
1807   case LibFunc::exp:
1808   case LibFunc::expf:
1809   case LibFunc::expl:
1810     return Intrinsic::exp;
1811   case LibFunc::exp2:
1812   case LibFunc::exp2f:
1813   case LibFunc::exp2l:
1814     return Intrinsic::exp2;
1815   case LibFunc::log:
1816   case LibFunc::logf:
1817   case LibFunc::logl:
1818     return Intrinsic::log;
1819   case LibFunc::log10:
1820   case LibFunc::log10f:
1821   case LibFunc::log10l:
1822     return Intrinsic::log10;
1823   case LibFunc::log2:
1824   case LibFunc::log2f:
1825   case LibFunc::log2l:
1826     return Intrinsic::log2;
1827   case LibFunc::fabs:
1828   case LibFunc::fabsf:
1829   case LibFunc::fabsl:
1830     return Intrinsic::fabs;
1831   case LibFunc::floor:
1832   case LibFunc::floorf:
1833   case LibFunc::floorl:
1834     return Intrinsic::floor;
1835   case LibFunc::ceil:
1836   case LibFunc::ceilf:
1837   case LibFunc::ceill:
1838     return Intrinsic::ceil;
1839   case LibFunc::trunc:
1840   case LibFunc::truncf:
1841   case LibFunc::truncl:
1842     return Intrinsic::trunc;
1843   case LibFunc::rint:
1844   case LibFunc::rintf:
1845   case LibFunc::rintl:
1846     return Intrinsic::rint;
1847   case LibFunc::nearbyint:
1848   case LibFunc::nearbyintf:
1849   case LibFunc::nearbyintl:
1850     return Intrinsic::nearbyint;
1851   case LibFunc::pow:
1852   case LibFunc::powf:
1853   case LibFunc::powl:
1854     return Intrinsic::pow;
1855   }
1856
1857   return Intrinsic::not_intrinsic;
1858 }
1859
1860 /// This function translates the reduction kind to an LLVM binary operator.
1861 static unsigned
1862 getReductionBinOp(LoopVectorizationLegality::ReductionKind Kind) {
1863   switch (Kind) {
1864     case LoopVectorizationLegality::RK_IntegerAdd:
1865       return Instruction::Add;
1866     case LoopVectorizationLegality::RK_IntegerMult:
1867       return Instruction::Mul;
1868     case LoopVectorizationLegality::RK_IntegerOr:
1869       return Instruction::Or;
1870     case LoopVectorizationLegality::RK_IntegerAnd:
1871       return Instruction::And;
1872     case LoopVectorizationLegality::RK_IntegerXor:
1873       return Instruction::Xor;
1874     case LoopVectorizationLegality::RK_FloatMult:
1875       return Instruction::FMul;
1876     case LoopVectorizationLegality::RK_FloatAdd:
1877       return Instruction::FAdd;
1878     case LoopVectorizationLegality::RK_IntegerMinMax:
1879       return Instruction::ICmp;
1880     case LoopVectorizationLegality::RK_FloatMinMax:
1881       return Instruction::FCmp;
1882     default:
1883       llvm_unreachable("Unknown reduction operation");
1884   }
1885 }
1886
1887 Value *createMinMaxOp(IRBuilder<> &Builder,
1888                       LoopVectorizationLegality::MinMaxReductionKind RK,
1889                       Value *Left,
1890                       Value *Right) {
1891   CmpInst::Predicate P = CmpInst::ICMP_NE;
1892   switch (RK) {
1893   default:
1894     llvm_unreachable("Unknown min/max reduction kind");
1895   case LoopVectorizationLegality::MRK_UIntMin:
1896     P = CmpInst::ICMP_ULT;
1897     break;
1898   case LoopVectorizationLegality::MRK_UIntMax:
1899     P = CmpInst::ICMP_UGT;
1900     break;
1901   case LoopVectorizationLegality::MRK_SIntMin:
1902     P = CmpInst::ICMP_SLT;
1903     break;
1904   case LoopVectorizationLegality::MRK_SIntMax:
1905     P = CmpInst::ICMP_SGT;
1906     break;
1907   case LoopVectorizationLegality::MRK_FloatMin:
1908     P = CmpInst::FCMP_OLT;
1909     break;
1910   case LoopVectorizationLegality::MRK_FloatMax:
1911     P = CmpInst::FCMP_OGT;
1912     break;
1913   }
1914
1915   Value *Cmp;
1916   if (RK == LoopVectorizationLegality::MRK_FloatMin ||
1917       RK == LoopVectorizationLegality::MRK_FloatMax)
1918     Cmp = Builder.CreateFCmp(P, Left, Right, "rdx.minmax.cmp");
1919   else
1920     Cmp = Builder.CreateICmp(P, Left, Right, "rdx.minmax.cmp");
1921
1922   Value *Select = Builder.CreateSelect(Cmp, Left, Right, "rdx.minmax.select");
1923   return Select;
1924 }
1925
1926 void
1927 InnerLoopVectorizer::vectorizeLoop(LoopVectorizationLegality *Legal) {
1928   //===------------------------------------------------===//
1929   //
1930   // Notice: any optimization or new instruction that go
1931   // into the code below should be also be implemented in
1932   // the cost-model.
1933   //
1934   //===------------------------------------------------===//
1935   Constant *Zero = Builder.getInt32(0);
1936
1937   // In order to support reduction variables we need to be able to vectorize
1938   // Phi nodes. Phi nodes have cycles, so we need to vectorize them in two
1939   // stages. First, we create a new vector PHI node with no incoming edges.
1940   // We use this value when we vectorize all of the instructions that use the
1941   // PHI. Next, after all of the instructions in the block are complete we
1942   // add the new incoming edges to the PHI. At this point all of the
1943   // instructions in the basic block are vectorized, so we can use them to
1944   // construct the PHI.
1945   PhiVector RdxPHIsToFix;
1946
1947   // Scan the loop in a topological order to ensure that defs are vectorized
1948   // before users.
1949   LoopBlocksDFS DFS(OrigLoop);
1950   DFS.perform(LI);
1951
1952   // Vectorize all of the blocks in the original loop.
1953   for (LoopBlocksDFS::RPOIterator bb = DFS.beginRPO(),
1954        be = DFS.endRPO(); bb != be; ++bb)
1955     vectorizeBlockInLoop(Legal, *bb, &RdxPHIsToFix);
1956
1957   // At this point every instruction in the original loop is widened to
1958   // a vector form. We are almost done. Now, we need to fix the PHI nodes
1959   // that we vectorized. The PHI nodes are currently empty because we did
1960   // not want to introduce cycles. Notice that the remaining PHI nodes
1961   // that we need to fix are reduction variables.
1962
1963   // Create the 'reduced' values for each of the induction vars.
1964   // The reduced values are the vector values that we scalarize and combine
1965   // after the loop is finished.
1966   for (PhiVector::iterator it = RdxPHIsToFix.begin(), e = RdxPHIsToFix.end();
1967        it != e; ++it) {
1968     PHINode *RdxPhi = *it;
1969     assert(RdxPhi && "Unable to recover vectorized PHI");
1970
1971     // Find the reduction variable descriptor.
1972     assert(Legal->getReductionVars()->count(RdxPhi) &&
1973            "Unable to find the reduction variable");
1974     LoopVectorizationLegality::ReductionDescriptor RdxDesc =
1975     (*Legal->getReductionVars())[RdxPhi];
1976
1977     setDebugLocFromInst(Builder, RdxDesc.StartValue);
1978
1979     // We need to generate a reduction vector from the incoming scalar.
1980     // To do so, we need to generate the 'identity' vector and overide
1981     // one of the elements with the incoming scalar reduction. We need
1982     // to do it in the vector-loop preheader.
1983     Builder.SetInsertPoint(LoopBypassBlocks.front()->getTerminator());
1984
1985     // This is the vector-clone of the value that leaves the loop.
1986     VectorParts &VectorExit = getVectorValue(RdxDesc.LoopExitInstr);
1987     Type *VecTy = VectorExit[0]->getType();
1988
1989     // Find the reduction identity variable. Zero for addition, or, xor,
1990     // one for multiplication, -1 for And.
1991     Value *Identity;
1992     Value *VectorStart;
1993     if (RdxDesc.Kind == LoopVectorizationLegality::RK_IntegerMinMax ||
1994         RdxDesc.Kind == LoopVectorizationLegality::RK_FloatMinMax) {
1995       // MinMax reduction have the start value as their identify.
1996       VectorStart = Identity = Builder.CreateVectorSplat(VF, RdxDesc.StartValue,
1997                                                          "minmax.ident");
1998     } else {
1999       Constant *Iden =
2000         LoopVectorizationLegality::getReductionIdentity(RdxDesc.Kind,
2001                                                         VecTy->getScalarType());
2002       Identity = ConstantVector::getSplat(VF, Iden);
2003
2004       // This vector is the Identity vector where the first element is the
2005       // incoming scalar reduction.
2006       VectorStart = Builder.CreateInsertElement(Identity,
2007                                                 RdxDesc.StartValue, Zero);
2008     }
2009
2010     // Fix the vector-loop phi.
2011     // We created the induction variable so we know that the
2012     // preheader is the first entry.
2013     BasicBlock *VecPreheader = Induction->getIncomingBlock(0);
2014
2015     // Reductions do not have to start at zero. They can start with
2016     // any loop invariant values.
2017     VectorParts &VecRdxPhi = WidenMap.get(RdxPhi);
2018     BasicBlock *Latch = OrigLoop->getLoopLatch();
2019     Value *LoopVal = RdxPhi->getIncomingValueForBlock(Latch);
2020     VectorParts &Val = getVectorValue(LoopVal);
2021     for (unsigned part = 0; part < UF; ++part) {
2022       // Make sure to add the reduction stat value only to the
2023       // first unroll part.
2024       Value *StartVal = (part == 0) ? VectorStart : Identity;
2025       cast<PHINode>(VecRdxPhi[part])->addIncoming(StartVal, VecPreheader);
2026       cast<PHINode>(VecRdxPhi[part])->addIncoming(Val[part], LoopVectorBody);
2027     }
2028
2029     // Before each round, move the insertion point right between
2030     // the PHIs and the values we are going to write.
2031     // This allows us to write both PHINodes and the extractelement
2032     // instructions.
2033     Builder.SetInsertPoint(LoopMiddleBlock->getFirstInsertionPt());
2034
2035     VectorParts RdxParts;
2036     setDebugLocFromInst(Builder, RdxDesc.LoopExitInstr);
2037     for (unsigned part = 0; part < UF; ++part) {
2038       // This PHINode contains the vectorized reduction variable, or
2039       // the initial value vector, if we bypass the vector loop.
2040       VectorParts &RdxExitVal = getVectorValue(RdxDesc.LoopExitInstr);
2041       PHINode *NewPhi = Builder.CreatePHI(VecTy, 2, "rdx.vec.exit.phi");
2042       Value *StartVal = (part == 0) ? VectorStart : Identity;
2043       for (unsigned I = 0, E = LoopBypassBlocks.size(); I != E; ++I)
2044         NewPhi->addIncoming(StartVal, LoopBypassBlocks[I]);
2045       NewPhi->addIncoming(RdxExitVal[part], LoopVectorBody);
2046       RdxParts.push_back(NewPhi);
2047     }
2048
2049     // Reduce all of the unrolled parts into a single vector.
2050     Value *ReducedPartRdx = RdxParts[0];
2051     unsigned Op = getReductionBinOp(RdxDesc.Kind);
2052     setDebugLocFromInst(Builder, ReducedPartRdx);
2053     for (unsigned part = 1; part < UF; ++part) {
2054       if (Op != Instruction::ICmp && Op != Instruction::FCmp)
2055         ReducedPartRdx = Builder.CreateBinOp((Instruction::BinaryOps)Op,
2056                                              RdxParts[part], ReducedPartRdx,
2057                                              "bin.rdx");
2058       else
2059         ReducedPartRdx = createMinMaxOp(Builder, RdxDesc.MinMaxKind,
2060                                         ReducedPartRdx, RdxParts[part]);
2061     }
2062
2063     // VF is a power of 2 so we can emit the reduction using log2(VF) shuffles
2064     // and vector ops, reducing the set of values being computed by half each
2065     // round.
2066     assert(isPowerOf2_32(VF) &&
2067            "Reduction emission only supported for pow2 vectors!");
2068     Value *TmpVec = ReducedPartRdx;
2069     SmallVector<Constant*, 32> ShuffleMask(VF, 0);
2070     for (unsigned i = VF; i != 1; i >>= 1) {
2071       // Move the upper half of the vector to the lower half.
2072       for (unsigned j = 0; j != i/2; ++j)
2073         ShuffleMask[j] = Builder.getInt32(i/2 + j);
2074
2075       // Fill the rest of the mask with undef.
2076       std::fill(&ShuffleMask[i/2], ShuffleMask.end(),
2077                 UndefValue::get(Builder.getInt32Ty()));
2078
2079       Value *Shuf =
2080         Builder.CreateShuffleVector(TmpVec,
2081                                     UndefValue::get(TmpVec->getType()),
2082                                     ConstantVector::get(ShuffleMask),
2083                                     "rdx.shuf");
2084
2085       if (Op != Instruction::ICmp && Op != Instruction::FCmp)
2086         TmpVec = Builder.CreateBinOp((Instruction::BinaryOps)Op, TmpVec, Shuf,
2087                                      "bin.rdx");
2088       else
2089         TmpVec = createMinMaxOp(Builder, RdxDesc.MinMaxKind, TmpVec, Shuf);
2090     }
2091
2092     // The result is in the first element of the vector.
2093     Value *Scalar0 = Builder.CreateExtractElement(TmpVec, Builder.getInt32(0));
2094
2095     // Now, we need to fix the users of the reduction variable
2096     // inside and outside of the scalar remainder loop.
2097     // We know that the loop is in LCSSA form. We need to update the
2098     // PHI nodes in the exit blocks.
2099     for (BasicBlock::iterator LEI = LoopExitBlock->begin(),
2100          LEE = LoopExitBlock->end(); LEI != LEE; ++LEI) {
2101       PHINode *LCSSAPhi = dyn_cast<PHINode>(LEI);
2102       if (!LCSSAPhi) continue;
2103
2104       // All PHINodes need to have a single entry edge, or two if
2105       // we already fixed them.
2106       assert(LCSSAPhi->getNumIncomingValues() < 3 && "Invalid LCSSA PHI");
2107
2108       // We found our reduction value exit-PHI. Update it with the
2109       // incoming bypass edge.
2110       if (LCSSAPhi->getIncomingValue(0) == RdxDesc.LoopExitInstr) {
2111         // Add an edge coming from the bypass.
2112         LCSSAPhi->addIncoming(Scalar0, LoopMiddleBlock);
2113         break;
2114       }
2115     }// end of the LCSSA phi scan.
2116
2117     // Fix the scalar loop reduction variable with the incoming reduction sum
2118     // from the vector body and from the backedge value.
2119     int IncomingEdgeBlockIdx =
2120     (RdxPhi)->getBasicBlockIndex(OrigLoop->getLoopLatch());
2121     assert(IncomingEdgeBlockIdx >= 0 && "Invalid block index");
2122     // Pick the other block.
2123     int SelfEdgeBlockIdx = (IncomingEdgeBlockIdx ? 0 : 1);
2124     (RdxPhi)->setIncomingValue(SelfEdgeBlockIdx, Scalar0);
2125     (RdxPhi)->setIncomingValue(IncomingEdgeBlockIdx, RdxDesc.LoopExitInstr);
2126   }// end of for each redux variable.
2127
2128   // The Loop exit block may have single value PHI nodes where the incoming
2129   // value is 'undef'. While vectorizing we only handled real values that
2130   // were defined inside the loop. Here we handle the 'undef case'.
2131   // See PR14725.
2132   for (BasicBlock::iterator LEI = LoopExitBlock->begin(),
2133        LEE = LoopExitBlock->end(); LEI != LEE; ++LEI) {
2134     PHINode *LCSSAPhi = dyn_cast<PHINode>(LEI);
2135     if (!LCSSAPhi) continue;
2136     if (LCSSAPhi->getNumIncomingValues() == 1)
2137       LCSSAPhi->addIncoming(UndefValue::get(LCSSAPhi->getType()),
2138                             LoopMiddleBlock);
2139   }
2140 }
2141
2142 InnerLoopVectorizer::VectorParts
2143 InnerLoopVectorizer::createEdgeMask(BasicBlock *Src, BasicBlock *Dst) {
2144   assert(std::find(pred_begin(Dst), pred_end(Dst), Src) != pred_end(Dst) &&
2145          "Invalid edge");
2146
2147   // Look for cached value.
2148   std::pair<BasicBlock*, BasicBlock*> Edge(Src, Dst);
2149   EdgeMaskCache::iterator ECEntryIt = MaskCache.find(Edge);
2150   if (ECEntryIt != MaskCache.end())
2151     return ECEntryIt->second;
2152
2153   VectorParts SrcMask = createBlockInMask(Src);
2154
2155   // The terminator has to be a branch inst!
2156   BranchInst *BI = dyn_cast<BranchInst>(Src->getTerminator());
2157   assert(BI && "Unexpected terminator found");
2158
2159   if (BI->isConditional()) {
2160     VectorParts EdgeMask = getVectorValue(BI->getCondition());
2161
2162     if (BI->getSuccessor(0) != Dst)
2163       for (unsigned part = 0; part < UF; ++part)
2164         EdgeMask[part] = Builder.CreateNot(EdgeMask[part]);
2165
2166     for (unsigned part = 0; part < UF; ++part)
2167       EdgeMask[part] = Builder.CreateAnd(EdgeMask[part], SrcMask[part]);
2168
2169     MaskCache[Edge] = EdgeMask;
2170     return EdgeMask;
2171   }
2172
2173   MaskCache[Edge] = SrcMask;
2174   return SrcMask;
2175 }
2176
2177 InnerLoopVectorizer::VectorParts
2178 InnerLoopVectorizer::createBlockInMask(BasicBlock *BB) {
2179   assert(OrigLoop->contains(BB) && "Block is not a part of a loop");
2180
2181   // Loop incoming mask is all-one.
2182   if (OrigLoop->getHeader() == BB) {
2183     Value *C = ConstantInt::get(IntegerType::getInt1Ty(BB->getContext()), 1);
2184     return getVectorValue(C);
2185   }
2186
2187   // This is the block mask. We OR all incoming edges, and with zero.
2188   Value *Zero = ConstantInt::get(IntegerType::getInt1Ty(BB->getContext()), 0);
2189   VectorParts BlockMask = getVectorValue(Zero);
2190
2191   // For each pred:
2192   for (pred_iterator it = pred_begin(BB), e = pred_end(BB); it != e; ++it) {
2193     VectorParts EM = createEdgeMask(*it, BB);
2194     for (unsigned part = 0; part < UF; ++part)
2195       BlockMask[part] = Builder.CreateOr(BlockMask[part], EM[part]);
2196   }
2197
2198   return BlockMask;
2199 }
2200
2201 void
2202 InnerLoopVectorizer::vectorizeBlockInLoop(LoopVectorizationLegality *Legal,
2203                                           BasicBlock *BB, PhiVector *PV) {
2204   // For each instruction in the old loop.
2205   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
2206     VectorParts &Entry = WidenMap.get(it);
2207     switch (it->getOpcode()) {
2208     case Instruction::Br:
2209       // Nothing to do for PHIs and BR, since we already took care of the
2210       // loop control flow instructions.
2211       continue;
2212     case Instruction::PHI:{
2213       PHINode* P = cast<PHINode>(it);
2214       // Handle reduction variables:
2215       if (Legal->getReductionVars()->count(P)) {
2216         for (unsigned part = 0; part < UF; ++part) {
2217           // This is phase one of vectorizing PHIs.
2218           Type *VecTy = VectorType::get(it->getType(), VF);
2219           Entry[part] = PHINode::Create(VecTy, 2, "vec.phi",
2220                                         LoopVectorBody-> getFirstInsertionPt());
2221         }
2222         PV->push_back(P);
2223         continue;
2224       }
2225
2226       setDebugLocFromInst(Builder, P);
2227       // Check for PHI nodes that are lowered to vector selects.
2228       if (P->getParent() != OrigLoop->getHeader()) {
2229         // We know that all PHIs in non header blocks are converted into
2230         // selects, so we don't have to worry about the insertion order and we
2231         // can just use the builder.
2232         // At this point we generate the predication tree. There may be
2233         // duplications since this is a simple recursive scan, but future
2234         // optimizations will clean it up.
2235
2236         unsigned NumIncoming = P->getNumIncomingValues();
2237
2238         // Generate a sequence of selects of the form:
2239         // SELECT(Mask3, In3,
2240         //      SELECT(Mask2, In2,
2241         //                   ( ...)))
2242         for (unsigned In = 0; In < NumIncoming; In++) {
2243           VectorParts Cond = createEdgeMask(P->getIncomingBlock(In),
2244                                             P->getParent());
2245           VectorParts &In0 = getVectorValue(P->getIncomingValue(In));
2246
2247           for (unsigned part = 0; part < UF; ++part) {
2248             // We might have single edge PHIs (blocks) - use an identity
2249             // 'select' for the first PHI operand.
2250             if (In == 0)
2251               Entry[part] = Builder.CreateSelect(Cond[part], In0[part],
2252                                                  In0[part]);
2253             else
2254               // Select between the current value and the previous incoming edge
2255               // based on the incoming mask.
2256               Entry[part] = Builder.CreateSelect(Cond[part], In0[part],
2257                                                  Entry[part], "predphi");
2258           }
2259         }
2260         continue;
2261       }
2262
2263       // This PHINode must be an induction variable.
2264       // Make sure that we know about it.
2265       assert(Legal->getInductionVars()->count(P) &&
2266              "Not an induction variable");
2267
2268       LoopVectorizationLegality::InductionInfo II =
2269         Legal->getInductionVars()->lookup(P);
2270
2271       switch (II.IK) {
2272       case LoopVectorizationLegality::IK_NoInduction:
2273         llvm_unreachable("Unknown induction");
2274       case LoopVectorizationLegality::IK_IntInduction: {
2275         assert(P->getType() == II.StartValue->getType() && "Types must match");
2276         Type *PhiTy = P->getType();
2277         Value *Broadcasted;
2278         if (P == OldInduction) {
2279           // Handle the canonical induction variable. We might have had to
2280           // extend the type.
2281           Broadcasted = Builder.CreateTrunc(Induction, PhiTy);
2282         } else {
2283           // Handle other induction variables that are now based on the
2284           // canonical one.
2285           Value *NormalizedIdx = Builder.CreateSub(Induction, ExtendedIdx,
2286                                                    "normalized.idx");
2287           NormalizedIdx = Builder.CreateSExtOrTrunc(NormalizedIdx, PhiTy);
2288           Broadcasted = Builder.CreateAdd(II.StartValue, NormalizedIdx,
2289                                           "offset.idx");
2290         }
2291         Broadcasted = getBroadcastInstrs(Broadcasted);
2292         // After broadcasting the induction variable we need to make the vector
2293         // consecutive by adding 0, 1, 2, etc.
2294         for (unsigned part = 0; part < UF; ++part)
2295           Entry[part] = getConsecutiveVector(Broadcasted, VF * part, false);
2296         continue;
2297       }
2298       case LoopVectorizationLegality::IK_ReverseIntInduction:
2299       case LoopVectorizationLegality::IK_PtrInduction:
2300       case LoopVectorizationLegality::IK_ReversePtrInduction:
2301         // Handle reverse integer and pointer inductions.
2302         Value *StartIdx = ExtendedIdx;
2303         // This is the normalized GEP that starts counting at zero.
2304         Value *NormalizedIdx = Builder.CreateSub(Induction, StartIdx,
2305                                                  "normalized.idx");
2306
2307         // Handle the reverse integer induction variable case.
2308         if (LoopVectorizationLegality::IK_ReverseIntInduction == II.IK) {
2309           IntegerType *DstTy = cast<IntegerType>(II.StartValue->getType());
2310           Value *CNI = Builder.CreateSExtOrTrunc(NormalizedIdx, DstTy,
2311                                                  "resize.norm.idx");
2312           Value *ReverseInd  = Builder.CreateSub(II.StartValue, CNI,
2313                                                  "reverse.idx");
2314
2315           // This is a new value so do not hoist it out.
2316           Value *Broadcasted = getBroadcastInstrs(ReverseInd);
2317           // After broadcasting the induction variable we need to make the
2318           // vector consecutive by adding  ... -3, -2, -1, 0.
2319           for (unsigned part = 0; part < UF; ++part)
2320             Entry[part] = getConsecutiveVector(Broadcasted, -(int)VF * part,
2321                                                true);
2322           continue;
2323         }
2324
2325         // Handle the pointer induction variable case.
2326         assert(P->getType()->isPointerTy() && "Unexpected type.");
2327
2328         // Is this a reverse induction ptr or a consecutive induction ptr.
2329         bool Reverse = (LoopVectorizationLegality::IK_ReversePtrInduction ==
2330                         II.IK);
2331
2332         // This is the vector of results. Notice that we don't generate
2333         // vector geps because scalar geps result in better code.
2334         for (unsigned part = 0; part < UF; ++part) {
2335           Value *VecVal = UndefValue::get(VectorType::get(P->getType(), VF));
2336           for (unsigned int i = 0; i < VF; ++i) {
2337             int EltIndex = (i + part * VF) * (Reverse ? -1 : 1);
2338             Constant *Idx = ConstantInt::get(Induction->getType(), EltIndex);
2339             Value *GlobalIdx;
2340             if (!Reverse)
2341               GlobalIdx = Builder.CreateAdd(NormalizedIdx, Idx, "gep.idx");
2342             else
2343               GlobalIdx = Builder.CreateSub(Idx, NormalizedIdx, "gep.ridx");
2344
2345             Value *SclrGep = Builder.CreateGEP(II.StartValue, GlobalIdx,
2346                                                "next.gep");
2347             VecVal = Builder.CreateInsertElement(VecVal, SclrGep,
2348                                                  Builder.getInt32(i),
2349                                                  "insert.gep");
2350           }
2351           Entry[part] = VecVal;
2352         }
2353         continue;
2354       }
2355
2356     }// End of PHI.
2357
2358     case Instruction::Add:
2359     case Instruction::FAdd:
2360     case Instruction::Sub:
2361     case Instruction::FSub:
2362     case Instruction::Mul:
2363     case Instruction::FMul:
2364     case Instruction::UDiv:
2365     case Instruction::SDiv:
2366     case Instruction::FDiv:
2367     case Instruction::URem:
2368     case Instruction::SRem:
2369     case Instruction::FRem:
2370     case Instruction::Shl:
2371     case Instruction::LShr:
2372     case Instruction::AShr:
2373     case Instruction::And:
2374     case Instruction::Or:
2375     case Instruction::Xor: {
2376       // Just widen binops.
2377       BinaryOperator *BinOp = dyn_cast<BinaryOperator>(it);
2378       setDebugLocFromInst(Builder, BinOp);
2379       VectorParts &A = getVectorValue(it->getOperand(0));
2380       VectorParts &B = getVectorValue(it->getOperand(1));
2381
2382       // Use this vector value for all users of the original instruction.
2383       for (unsigned Part = 0; Part < UF; ++Part) {
2384         Value *V = Builder.CreateBinOp(BinOp->getOpcode(), A[Part], B[Part]);
2385
2386         // Update the NSW, NUW and Exact flags. Notice: V can be an Undef.
2387         BinaryOperator *VecOp = dyn_cast<BinaryOperator>(V);
2388         if (VecOp && isa<OverflowingBinaryOperator>(BinOp)) {
2389           VecOp->setHasNoSignedWrap(BinOp->hasNoSignedWrap());
2390           VecOp->setHasNoUnsignedWrap(BinOp->hasNoUnsignedWrap());
2391         }
2392         if (VecOp && isa<PossiblyExactOperator>(VecOp))
2393           VecOp->setIsExact(BinOp->isExact());
2394
2395         Entry[Part] = V;
2396       }
2397       break;
2398     }
2399     case Instruction::Select: {
2400       // Widen selects.
2401       // If the selector is loop invariant we can create a select
2402       // instruction with a scalar condition. Otherwise, use vector-select.
2403       bool InvariantCond = SE->isLoopInvariant(SE->getSCEV(it->getOperand(0)),
2404                                                OrigLoop);
2405       setDebugLocFromInst(Builder, it);
2406
2407       // The condition can be loop invariant  but still defined inside the
2408       // loop. This means that we can't just use the original 'cond' value.
2409       // We have to take the 'vectorized' value and pick the first lane.
2410       // Instcombine will make this a no-op.
2411       VectorParts &Cond = getVectorValue(it->getOperand(0));
2412       VectorParts &Op0  = getVectorValue(it->getOperand(1));
2413       VectorParts &Op1  = getVectorValue(it->getOperand(2));
2414       Value *ScalarCond = Builder.CreateExtractElement(Cond[0],
2415                                                        Builder.getInt32(0));
2416       for (unsigned Part = 0; Part < UF; ++Part) {
2417         Entry[Part] = Builder.CreateSelect(
2418           InvariantCond ? ScalarCond : Cond[Part],
2419           Op0[Part],
2420           Op1[Part]);
2421       }
2422       break;
2423     }
2424
2425     case Instruction::ICmp:
2426     case Instruction::FCmp: {
2427       // Widen compares. Generate vector compares.
2428       bool FCmp = (it->getOpcode() == Instruction::FCmp);
2429       CmpInst *Cmp = dyn_cast<CmpInst>(it);
2430       setDebugLocFromInst(Builder, it);
2431       VectorParts &A = getVectorValue(it->getOperand(0));
2432       VectorParts &B = getVectorValue(it->getOperand(1));
2433       for (unsigned Part = 0; Part < UF; ++Part) {
2434         Value *C = 0;
2435         if (FCmp)
2436           C = Builder.CreateFCmp(Cmp->getPredicate(), A[Part], B[Part]);
2437         else
2438           C = Builder.CreateICmp(Cmp->getPredicate(), A[Part], B[Part]);
2439         Entry[Part] = C;
2440       }
2441       break;
2442     }
2443
2444     case Instruction::Store:
2445     case Instruction::Load:
2446         vectorizeMemoryInstruction(it, Legal);
2447         break;
2448     case Instruction::ZExt:
2449     case Instruction::SExt:
2450     case Instruction::FPToUI:
2451     case Instruction::FPToSI:
2452     case Instruction::FPExt:
2453     case Instruction::PtrToInt:
2454     case Instruction::IntToPtr:
2455     case Instruction::SIToFP:
2456     case Instruction::UIToFP:
2457     case Instruction::Trunc:
2458     case Instruction::FPTrunc:
2459     case Instruction::BitCast: {
2460       CastInst *CI = dyn_cast<CastInst>(it);
2461       setDebugLocFromInst(Builder, it);
2462       /// Optimize the special case where the source is the induction
2463       /// variable. Notice that we can only optimize the 'trunc' case
2464       /// because: a. FP conversions lose precision, b. sext/zext may wrap,
2465       /// c. other casts depend on pointer size.
2466       if (CI->getOperand(0) == OldInduction &&
2467           it->getOpcode() == Instruction::Trunc) {
2468         Value *ScalarCast = Builder.CreateCast(CI->getOpcode(), Induction,
2469                                                CI->getType());
2470         Value *Broadcasted = getBroadcastInstrs(ScalarCast);
2471         for (unsigned Part = 0; Part < UF; ++Part)
2472           Entry[Part] = getConsecutiveVector(Broadcasted, VF * Part, false);
2473         break;
2474       }
2475       /// Vectorize casts.
2476       Type *DestTy = VectorType::get(CI->getType()->getScalarType(), VF);
2477
2478       VectorParts &A = getVectorValue(it->getOperand(0));
2479       for (unsigned Part = 0; Part < UF; ++Part)
2480         Entry[Part] = Builder.CreateCast(CI->getOpcode(), A[Part], DestTy);
2481       break;
2482     }
2483
2484     case Instruction::Call: {
2485       // Ignore dbg intrinsics.
2486       if (isa<DbgInfoIntrinsic>(it))
2487         break;
2488       setDebugLocFromInst(Builder, it);
2489
2490       Module *M = BB->getParent()->getParent();
2491       CallInst *CI = cast<CallInst>(it);
2492       Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
2493       assert(ID && "Not an intrinsic call!");
2494       for (unsigned Part = 0; Part < UF; ++Part) {
2495         SmallVector<Value*, 4> Args;
2496         for (unsigned i = 0, ie = CI->getNumArgOperands(); i != ie; ++i) {
2497           VectorParts &Arg = getVectorValue(CI->getArgOperand(i));
2498           Args.push_back(Arg[Part]);
2499         }
2500         Type *Tys[] = { VectorType::get(CI->getType()->getScalarType(), VF) };
2501         Function *F = Intrinsic::getDeclaration(M, ID, Tys);
2502         Entry[Part] = Builder.CreateCall(F, Args);
2503       }
2504       break;
2505     }
2506
2507     default:
2508       // All other instructions are unsupported. Scalarize them.
2509       scalarizeInstruction(it);
2510       break;
2511     }// end of switch.
2512   }// end of for_each instr.
2513 }
2514
2515 void InnerLoopVectorizer::updateAnalysis() {
2516   // Forget the original basic block.
2517   SE->forgetLoop(OrigLoop);
2518
2519   // Update the dominator tree information.
2520   assert(DT->properlyDominates(LoopBypassBlocks.front(), LoopExitBlock) &&
2521          "Entry does not dominate exit.");
2522
2523   for (unsigned I = 1, E = LoopBypassBlocks.size(); I != E; ++I)
2524     DT->addNewBlock(LoopBypassBlocks[I], LoopBypassBlocks[I-1]);
2525   DT->addNewBlock(LoopVectorPreHeader, LoopBypassBlocks.back());
2526   DT->addNewBlock(LoopVectorBody, LoopVectorPreHeader);
2527   DT->addNewBlock(LoopMiddleBlock, LoopBypassBlocks.front());
2528   DT->addNewBlock(LoopScalarPreHeader, LoopMiddleBlock);
2529   DT->changeImmediateDominator(LoopScalarBody, LoopScalarPreHeader);
2530   DT->changeImmediateDominator(LoopExitBlock, LoopMiddleBlock);
2531
2532   DEBUG(DT->verifyAnalysis());
2533 }
2534
2535 bool LoopVectorizationLegality::canVectorizeWithIfConvert() {
2536   if (!EnableIfConversion)
2537     return false;
2538
2539   assert(TheLoop->getNumBlocks() > 1 && "Single block loops are vectorizable");
2540   std::vector<BasicBlock*> &LoopBlocks = TheLoop->getBlocksVector();
2541
2542   // A list of pointers that we can safely read and write to.
2543   SmallPtrSet<Value *, 8> SafePointes;
2544
2545   // Collect safe addresses.
2546   for (unsigned i = 0, e = LoopBlocks.size(); i < e; ++i) {
2547     BasicBlock *BB = LoopBlocks[i];
2548
2549     if (blockNeedsPredication(BB))
2550       continue;
2551
2552     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2553       if (LoadInst *LI = dyn_cast<LoadInst>(I))
2554         SafePointes.insert(LI->getPointerOperand());
2555       else if (StoreInst *SI = dyn_cast<StoreInst>(I))
2556         SafePointes.insert(SI->getPointerOperand());
2557     }
2558   }
2559
2560   // Collect the blocks that need predication.
2561   for (unsigned i = 0, e = LoopBlocks.size(); i < e; ++i) {
2562     BasicBlock *BB = LoopBlocks[i];
2563
2564     // We don't support switch statements inside loops.
2565     if (!isa<BranchInst>(BB->getTerminator()))
2566       return false;
2567
2568     // We must be able to predicate all blocks that need to be predicated.
2569     if (blockNeedsPredication(BB) && !blockCanBePredicated(BB, SafePointes))
2570       return false;
2571   }
2572
2573   // We can if-convert this loop.
2574   return true;
2575 }
2576
2577 bool LoopVectorizationLegality::canVectorize() {
2578   // We must have a loop in canonical form. Loops with indirectbr in them cannot
2579   // be canonicalized.
2580   if (!TheLoop->getLoopPreheader())
2581     return false;
2582
2583   // We can only vectorize innermost loops.
2584   if (TheLoop->getSubLoopsVector().size())
2585     return false;
2586
2587   // We must have a single backedge.
2588   if (TheLoop->getNumBackEdges() != 1)
2589     return false;
2590
2591   // We must have a single exiting block.
2592   if (!TheLoop->getExitingBlock())
2593     return false;
2594
2595   unsigned NumBlocks = TheLoop->getNumBlocks();
2596
2597   // Check if we can if-convert non single-bb loops.
2598   if (NumBlocks != 1 && !canVectorizeWithIfConvert()) {
2599     DEBUG(dbgs() << "LV: Can't if-convert the loop.\n");
2600     return false;
2601   }
2602
2603   // We need to have a loop header.
2604   BasicBlock *Latch = TheLoop->getLoopLatch();
2605   DEBUG(dbgs() << "LV: Found a loop: " <<
2606         TheLoop->getHeader()->getName() << "\n");
2607
2608   // ScalarEvolution needs to be able to find the exit count.
2609   const SCEV *ExitCount = SE->getBackedgeTakenCount(TheLoop);
2610   if (ExitCount == SE->getCouldNotCompute()) {
2611     DEBUG(dbgs() << "LV: SCEV could not compute the loop exit count.\n");
2612     return false;
2613   }
2614
2615   // Do not loop-vectorize loops with a tiny trip count.
2616   unsigned TC = SE->getSmallConstantTripCount(TheLoop, Latch);
2617   if (TC > 0u && TC < TinyTripCountVectorThreshold) {
2618     DEBUG(dbgs() << "LV: Found a loop with a very small trip count. " <<
2619           "This loop is not worth vectorizing.\n");
2620     return false;
2621   }
2622
2623   // Check if we can vectorize the instructions and CFG in this loop.
2624   if (!canVectorizeInstrs()) {
2625     DEBUG(dbgs() << "LV: Can't vectorize the instructions or CFG\n");
2626     return false;
2627   }
2628
2629   // Go over each instruction and look at memory deps.
2630   if (!canVectorizeMemory()) {
2631     DEBUG(dbgs() << "LV: Can't vectorize due to memory conflicts\n");
2632     return false;
2633   }
2634
2635   // Collect all of the variables that remain uniform after vectorization.
2636   collectLoopUniforms();
2637
2638   DEBUG(dbgs() << "LV: We can vectorize this loop" <<
2639         (PtrRtCheck.Need ? " (with a runtime bound check)" : "")
2640         <<"!\n");
2641
2642   // Okay! We can vectorize. At this point we don't have any other mem analysis
2643   // which may limit our maximum vectorization factor, so just return true with
2644   // no restrictions.
2645   return true;
2646 }
2647
2648 static Type *convertPointerToIntegerType(DataLayout &DL, Type *Ty) {
2649   if (Ty->isPointerTy())
2650     return DL.getIntPtrType(Ty->getContext());
2651   return Ty;
2652 }
2653
2654 static Type* getWiderType(DataLayout &DL, Type *Ty0, Type *Ty1) {
2655   Ty0 = convertPointerToIntegerType(DL, Ty0);
2656   Ty1 = convertPointerToIntegerType(DL, Ty1);
2657   if (Ty0->getScalarSizeInBits() > Ty1->getScalarSizeInBits())
2658     return Ty0;
2659   return Ty1;
2660 }
2661
2662 /// \brief Check that the instruction has outside loop users and is not an
2663 /// identified reduction variable.
2664 static bool hasOutsideLoopUser(const Loop *TheLoop, Instruction *Inst,
2665                                SmallPtrSet<Value *, 4> &Reductions) {
2666   // Reduction instructions are allowed to have exit users. All other
2667   // instructions must not have external users.
2668   if (!Reductions.count(Inst))
2669     //Check that all of the users of the loop are inside the BB.
2670     for (Value::use_iterator I = Inst->use_begin(), E = Inst->use_end();
2671          I != E; ++I) {
2672       Instruction *U = cast<Instruction>(*I);
2673       // This user may be a reduction exit value.
2674       if (!TheLoop->contains(U)) {
2675         DEBUG(dbgs() << "LV: Found an outside user for : "<< *U << "\n");
2676         return true;
2677       }
2678     }
2679   return false;
2680 }
2681
2682 bool LoopVectorizationLegality::canVectorizeInstrs() {
2683   BasicBlock *PreHeader = TheLoop->getLoopPreheader();
2684   BasicBlock *Header = TheLoop->getHeader();
2685
2686   // Look for the attribute signaling the absence of NaNs.
2687   Function &F = *Header->getParent();
2688   if (F.hasFnAttribute("no-nans-fp-math"))
2689     HasFunNoNaNAttr = F.getAttributes().getAttribute(
2690       AttributeSet::FunctionIndex,
2691       "no-nans-fp-math").getValueAsString() == "true";
2692
2693   // For each block in the loop.
2694   for (Loop::block_iterator bb = TheLoop->block_begin(),
2695        be = TheLoop->block_end(); bb != be; ++bb) {
2696
2697     // Scan the instructions in the block and look for hazards.
2698     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
2699          ++it) {
2700
2701       if (PHINode *Phi = dyn_cast<PHINode>(it)) {
2702         Type *PhiTy = Phi->getType();
2703         // Check that this PHI type is allowed.
2704         if (!PhiTy->isIntegerTy() &&
2705             !PhiTy->isFloatingPointTy() &&
2706             !PhiTy->isPointerTy()) {
2707           DEBUG(dbgs() << "LV: Found an non-int non-pointer PHI.\n");
2708           return false;
2709         }
2710
2711         // If this PHINode is not in the header block, then we know that we
2712         // can convert it to select during if-conversion. No need to check if
2713         // the PHIs in this block are induction or reduction variables.
2714         if (*bb != Header) {
2715           // Check that this instruction has no outside users or is an
2716           // identified reduction value with an outside user.
2717           if(!hasOutsideLoopUser(TheLoop, it, AllowedExit))
2718             continue;
2719           return false;
2720         }
2721
2722         // We only allow if-converted PHIs with more than two incoming values.
2723         if (Phi->getNumIncomingValues() != 2) {
2724           DEBUG(dbgs() << "LV: Found an invalid PHI.\n");
2725           return false;
2726         }
2727
2728         // This is the value coming from the preheader.
2729         Value *StartValue = Phi->getIncomingValueForBlock(PreHeader);
2730         // Check if this is an induction variable.
2731         InductionKind IK = isInductionVariable(Phi);
2732
2733         if (IK_NoInduction != IK) {
2734           // Get the widest type.
2735           if (!WidestIndTy)
2736             WidestIndTy = convertPointerToIntegerType(*DL, PhiTy);
2737           else
2738             WidestIndTy = getWiderType(*DL, PhiTy, WidestIndTy);
2739
2740           // Int inductions are special because we only allow one IV.
2741           if (IK == IK_IntInduction) {
2742             // Use the phi node with the widest type as induction. Use the last
2743             // one if there are multiple (no good reason for doing this other
2744             // than it is expedient).
2745             if (!Induction || PhiTy == WidestIndTy)
2746               Induction = Phi;
2747           }
2748
2749           DEBUG(dbgs() << "LV: Found an induction variable.\n");
2750           Inductions[Phi] = InductionInfo(StartValue, IK);
2751           continue;
2752         }
2753
2754         if (AddReductionVar(Phi, RK_IntegerAdd)) {
2755           DEBUG(dbgs() << "LV: Found an ADD reduction PHI."<< *Phi <<"\n");
2756           continue;
2757         }
2758         if (AddReductionVar(Phi, RK_IntegerMult)) {
2759           DEBUG(dbgs() << "LV: Found a MUL reduction PHI."<< *Phi <<"\n");
2760           continue;
2761         }
2762         if (AddReductionVar(Phi, RK_IntegerOr)) {
2763           DEBUG(dbgs() << "LV: Found an OR reduction PHI."<< *Phi <<"\n");
2764           continue;
2765         }
2766         if (AddReductionVar(Phi, RK_IntegerAnd)) {
2767           DEBUG(dbgs() << "LV: Found an AND reduction PHI."<< *Phi <<"\n");
2768           continue;
2769         }
2770         if (AddReductionVar(Phi, RK_IntegerXor)) {
2771           DEBUG(dbgs() << "LV: Found a XOR reduction PHI."<< *Phi <<"\n");
2772           continue;
2773         }
2774         if (AddReductionVar(Phi, RK_IntegerMinMax)) {
2775           DEBUG(dbgs() << "LV: Found a MINMAX reduction PHI."<< *Phi <<"\n");
2776           continue;
2777         }
2778         if (AddReductionVar(Phi, RK_FloatMult)) {
2779           DEBUG(dbgs() << "LV: Found an FMult reduction PHI."<< *Phi <<"\n");
2780           continue;
2781         }
2782         if (AddReductionVar(Phi, RK_FloatAdd)) {
2783           DEBUG(dbgs() << "LV: Found an FAdd reduction PHI."<< *Phi <<"\n");
2784           continue;
2785         }
2786         if (AddReductionVar(Phi, RK_FloatMinMax)) {
2787           DEBUG(dbgs() << "LV: Found an float MINMAX reduction PHI."<< *Phi <<
2788                 "\n");
2789           continue;
2790         }
2791
2792         DEBUG(dbgs() << "LV: Found an unidentified PHI."<< *Phi <<"\n");
2793         return false;
2794       }// end of PHI handling
2795
2796       // We still don't handle functions. However, we can ignore dbg intrinsic
2797       // calls and we do handle certain intrinsic and libm functions.
2798       CallInst *CI = dyn_cast<CallInst>(it);
2799       if (CI && !getIntrinsicIDForCall(CI, TLI) && !isa<DbgInfoIntrinsic>(CI)) {
2800         DEBUG(dbgs() << "LV: Found a call site.\n");
2801         return false;
2802       }
2803
2804       // Check that the instruction return type is vectorizable.
2805       if (!VectorType::isValidElementType(it->getType()) &&
2806           !it->getType()->isVoidTy()) {
2807         DEBUG(dbgs() << "LV: Found unvectorizable type." << "\n");
2808         return false;
2809       }
2810
2811       // Check that the stored type is vectorizable.
2812       if (StoreInst *ST = dyn_cast<StoreInst>(it)) {
2813         Type *T = ST->getValueOperand()->getType();
2814         if (!VectorType::isValidElementType(T))
2815           return false;
2816       }
2817
2818       // Reduction instructions are allowed to have exit users.
2819       // All other instructions must not have external users.
2820       if (hasOutsideLoopUser(TheLoop, it, AllowedExit))
2821         return false;
2822
2823     } // next instr.
2824
2825   }
2826
2827   if (!Induction) {
2828     DEBUG(dbgs() << "LV: Did not find one integer induction var.\n");
2829     if (Inductions.empty())
2830       return false;
2831   }
2832
2833   return true;
2834 }
2835
2836 void LoopVectorizationLegality::collectLoopUniforms() {
2837   // We now know that the loop is vectorizable!
2838   // Collect variables that will remain uniform after vectorization.
2839   std::vector<Value*> Worklist;
2840   BasicBlock *Latch = TheLoop->getLoopLatch();
2841
2842   // Start with the conditional branch and walk up the block.
2843   Worklist.push_back(Latch->getTerminator()->getOperand(0));
2844
2845   while (Worklist.size()) {
2846     Instruction *I = dyn_cast<Instruction>(Worklist.back());
2847     Worklist.pop_back();
2848
2849     // Look at instructions inside this loop.
2850     // Stop when reaching PHI nodes.
2851     // TODO: we need to follow values all over the loop, not only in this block.
2852     if (!I || !TheLoop->contains(I) || isa<PHINode>(I))
2853       continue;
2854
2855     // This is a known uniform.
2856     Uniforms.insert(I);
2857
2858     // Insert all operands.
2859     Worklist.insert(Worklist.end(), I->op_begin(), I->op_end());
2860   }
2861 }
2862
2863 namespace {
2864 /// \brief Analyses memory accesses in a loop.
2865 ///
2866 /// Checks whether run time pointer checks are needed and builds sets for data
2867 /// dependence checking.
2868 class AccessAnalysis {
2869 public:
2870   /// \brief Read or write access location.
2871   typedef PointerIntPair<Value *, 1, bool> MemAccessInfo;
2872   typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet;
2873
2874   /// \brief Set of potential dependent memory accesses.
2875   typedef EquivalenceClasses<MemAccessInfo> DepCandidates;
2876
2877   AccessAnalysis(DataLayout *Dl, DepCandidates &DA) :
2878     DL(Dl), DepCands(DA), AreAllWritesIdentified(true),
2879     AreAllReadsIdentified(true), IsRTCheckNeeded(false) {}
2880
2881   /// \brief Register a load  and whether it is only read from.
2882   void addLoad(Value *Ptr, bool IsReadOnly) {
2883     Accesses.insert(MemAccessInfo(Ptr, false));
2884     if (IsReadOnly)
2885       ReadOnlyPtr.insert(Ptr);
2886   }
2887
2888   /// \brief Register a store.
2889   void addStore(Value *Ptr) {
2890     Accesses.insert(MemAccessInfo(Ptr, true));
2891   }
2892
2893   /// \brief Check whether we can check the pointers at runtime for
2894   /// non-intersection.
2895   bool canCheckPtrAtRT(LoopVectorizationLegality::RuntimePointerCheck &RtCheck,
2896                        unsigned &NumComparisons, ScalarEvolution *SE,
2897                        Loop *TheLoop);
2898
2899   /// \brief Goes over all memory accesses, checks whether a RT check is needed
2900   /// and builds sets of dependent accesses.
2901   void buildDependenceSets() {
2902     // Process read-write pointers first.
2903     processMemAccesses(false);
2904     // Next, process read pointers.
2905     processMemAccesses(true);
2906   }
2907
2908   bool isRTCheckNeeded() { return IsRTCheckNeeded; }
2909
2910   bool isDependencyCheckNeeded() { return !CheckDeps.empty(); }
2911
2912   MemAccessInfoSet &getDependenciesToCheck() { return CheckDeps; }
2913
2914 private:
2915   typedef SetVector<MemAccessInfo> PtrAccessSet;
2916   typedef DenseMap<Value*, MemAccessInfo> UnderlyingObjToAccessMap;
2917
2918   /// \brief Go over all memory access or only the deferred ones if
2919   /// \p UseDeferred is true and check whether runtime pointer checks are needed
2920   /// and build sets of dependency check candidates.
2921   void processMemAccesses(bool UseDeferred);
2922
2923   /// Set of all accesses.
2924   PtrAccessSet Accesses;
2925
2926   /// Set of access to check after all writes have been processed.
2927   PtrAccessSet DeferredAccesses;
2928
2929   /// Map of pointers to last access encountered.
2930   UnderlyingObjToAccessMap ObjToLastAccess;
2931
2932   /// Set of accesses that need a further dependence check.
2933   MemAccessInfoSet CheckDeps;
2934
2935   /// Set of pointers that are read only.
2936   SmallPtrSet<Value*, 16> ReadOnlyPtr;
2937
2938   /// Set of underlying objects already written to.
2939   SmallPtrSet<Value*, 16> WriteObjects;
2940
2941   DataLayout *DL;
2942
2943   /// Sets of potentially dependent accesses - members of one set share an
2944   /// underlying pointer. The set "CheckDeps" identfies which sets really need a
2945   /// dependence check.
2946   DepCandidates &DepCands;
2947
2948   bool AreAllWritesIdentified;
2949   bool AreAllReadsIdentified;
2950   bool IsRTCheckNeeded;
2951 };
2952
2953 } // end anonymous namespace
2954
2955 /// \brief Check whether a pointer can participate in a runtime bounds check.
2956 static bool hasComputableBounds(ScalarEvolution *SE, Value *Ptr) {
2957   const SCEV *PtrScev = SE->getSCEV(Ptr);
2958   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
2959   if (!AR)
2960     return false;
2961
2962   return AR->isAffine();
2963 }
2964
2965 bool AccessAnalysis::canCheckPtrAtRT(
2966                        LoopVectorizationLegality::RuntimePointerCheck &RtCheck,
2967                         unsigned &NumComparisons, ScalarEvolution *SE,
2968                         Loop *TheLoop) {
2969   // Find pointers with computable bounds. We are going to use this information
2970   // to place a runtime bound check.
2971   unsigned NumReadPtrChecks = 0;
2972   unsigned NumWritePtrChecks = 0;
2973   bool CanDoRT = true;
2974
2975   bool IsDepCheckNeeded = isDependencyCheckNeeded();
2976   // We assign consecutive id to access from different dependence sets.
2977   // Accesses within the same set don't need a runtime check.
2978   unsigned RunningDepId = 1;
2979   DenseMap<Value *, unsigned> DepSetId;
2980
2981   for (PtrAccessSet::iterator AI = Accesses.begin(), AE = Accesses.end();
2982        AI != AE; ++AI) {
2983     const MemAccessInfo &Access = *AI;
2984     Value *Ptr = Access.getPointer();
2985     bool IsWrite = Access.getInt();
2986
2987     // Just add write checks if we have both.
2988     if (!IsWrite && Accesses.count(MemAccessInfo(Ptr, true)))
2989       continue;
2990
2991     if (IsWrite)
2992       ++NumWritePtrChecks;
2993     else
2994       ++NumReadPtrChecks;
2995
2996     if (hasComputableBounds(SE, Ptr)) {
2997       // The id of the dependence set.
2998       unsigned DepId;
2999
3000       if (IsDepCheckNeeded) {
3001         Value *Leader = DepCands.getLeaderValue(Access).getPointer();
3002         unsigned &LeaderId = DepSetId[Leader];
3003         if (!LeaderId)
3004           LeaderId = RunningDepId++;
3005         DepId = LeaderId;
3006       } else
3007         // Each access has its own dependence set.
3008         DepId = RunningDepId++;
3009
3010       RtCheck.insert(SE, TheLoop, Ptr, IsWrite, DepId);
3011
3012       DEBUG(dbgs() << "LV: Found a runtime check ptr:" << *Ptr <<"\n");
3013     } else {
3014       CanDoRT = false;
3015     }
3016   }
3017
3018   if (IsDepCheckNeeded && CanDoRT && RunningDepId == 2)
3019     NumComparisons = 0; // Only one dependence set.
3020   else
3021     NumComparisons = (NumWritePtrChecks * (NumReadPtrChecks +
3022                                            NumWritePtrChecks - 1));
3023   return CanDoRT;
3024 }
3025
3026 static bool isFunctionScopeIdentifiedObject(Value *Ptr) {
3027   return isNoAliasArgument(Ptr) || isNoAliasCall(Ptr) || isa<AllocaInst>(Ptr);
3028 }
3029
3030 void AccessAnalysis::processMemAccesses(bool UseDeferred) {
3031   // We process the set twice: first we process read-write pointers, last we
3032   // process read-only pointers. This allows us to skip dependence tests for
3033   // read-only pointers.
3034
3035   PtrAccessSet &S = UseDeferred ? DeferredAccesses : Accesses;
3036   for (PtrAccessSet::iterator AI = S.begin(), AE = S.end(); AI != AE; ++AI) {
3037     const MemAccessInfo &Access = *AI;
3038     Value *Ptr = Access.getPointer();
3039     bool IsWrite = Access.getInt();
3040
3041     DepCands.insert(Access);
3042
3043     // Memorize read-only pointers for later processing and skip them in the
3044     // first round (they need to be checked after we have seen all write
3045     // pointers). Note: we also mark pointer that are not consecutive as
3046     // "read-only" pointers (so that we check "a[b[i]] +="). Hence, we need the
3047     // second check for "!IsWrite".
3048     bool IsReadOnlyPtr = ReadOnlyPtr.count(Ptr) && !IsWrite;
3049     if (!UseDeferred && IsReadOnlyPtr) {
3050       DeferredAccesses.insert(Access);
3051       continue;
3052     }
3053
3054     bool NeedDepCheck = false;
3055     // Check whether there is the possiblity of dependency because of underlying
3056     // objects being the same.
3057     typedef SmallVector<Value*, 16> ValueVector;
3058     ValueVector TempObjects;
3059     GetUnderlyingObjects(Ptr, TempObjects, DL);
3060     for (ValueVector::iterator UI = TempObjects.begin(), UE = TempObjects.end();
3061          UI != UE; ++UI) {
3062       Value *UnderlyingObj = *UI;
3063
3064       // If this is a write then it needs to be an identified object.  If this a
3065       // read and all writes (so far) are identified function scope objects we
3066       // don't need an identified underlying object but only an Argument (the
3067       // next write is going to invalidate this assumption if it is
3068       // unidentified).
3069       // This is a micro-optimization for the case where all writes are
3070       // identified and we have one argument pointer.
3071       // Otherwise, we do need a runtime check.
3072       if ((IsWrite && !isFunctionScopeIdentifiedObject(UnderlyingObj)) ||
3073           (!IsWrite && (!AreAllWritesIdentified ||
3074                         !isa<Argument>(UnderlyingObj)) &&
3075            !isIdentifiedObject(UnderlyingObj))) {
3076         DEBUG(dbgs() << "LV: Found an unidentified " <<
3077               (IsWrite ?  "write" : "read" ) << " ptr:" << *UnderlyingObj <<
3078               "\n");
3079         IsRTCheckNeeded = (IsRTCheckNeeded ||
3080                            !isIdentifiedObject(UnderlyingObj) ||
3081                            !AreAllReadsIdentified);
3082
3083         if (IsWrite)
3084           AreAllWritesIdentified = false;
3085         if (!IsWrite)
3086           AreAllReadsIdentified = false;
3087       }
3088
3089       // If this is a write - check other reads and writes for conflicts.  If
3090       // this is a read only check other writes for conflicts (but only if there
3091       // is no other write to the ptr - this is an optimization to catch "a[i] =
3092       // a[i] + " without having to do a dependence check).
3093       if ((IsWrite || IsReadOnlyPtr) && WriteObjects.count(UnderlyingObj))
3094         NeedDepCheck = true;
3095
3096       if (IsWrite)
3097         WriteObjects.insert(UnderlyingObj);
3098
3099       // Create sets of pointers connected by shared underlying objects.
3100       UnderlyingObjToAccessMap::iterator Prev =
3101         ObjToLastAccess.find(UnderlyingObj);
3102       if (Prev != ObjToLastAccess.end())
3103         DepCands.unionSets(Access, Prev->second);
3104
3105       ObjToLastAccess[UnderlyingObj] = Access;
3106     }
3107
3108     if (NeedDepCheck)
3109       CheckDeps.insert(Access);
3110   }
3111 }
3112
3113 namespace {
3114 /// \brief Checks memory dependences among accesses to the same underlying
3115 /// object to determine whether there vectorization is legal or not (and at
3116 /// which vectorization factor).
3117 ///
3118 /// This class works under the assumption that we already checked that memory
3119 /// locations with different underlying pointers are "must-not alias".
3120 /// We use the ScalarEvolution framework to symbolically evalutate access
3121 /// functions pairs. Since we currently don't restructure the loop we can rely
3122 /// on the program order of memory accesses to determine their safety.
3123 /// At the moment we will only deem accesses as safe for:
3124 ///  * A negative constant distance assuming program order.
3125 ///
3126 ///      Safe: tmp = a[i + 1];     OR     a[i + 1] = x;
3127 ///            a[i] = tmp;                y = a[i];
3128 ///
3129 ///   The latter case is safe because later checks guarantuee that there can't
3130 ///   be a cycle through a phi node (that is, we check that "x" and "y" is not
3131 ///   the same variable: a header phi can only be an induction or a reduction, a
3132 ///   reduction can't have a memory sink, an induction can't have a memory
3133 ///   source). This is important and must not be violated (or we have to
3134 ///   resort to checking for cycles through memory).
3135 ///
3136 ///  * A positive constant distance assuming program order that is bigger
3137 ///    than the biggest memory access.
3138 ///
3139 ///     tmp = a[i]        OR              b[i] = x
3140 ///     a[i+2] = tmp                      y = b[i+2];
3141 ///
3142 ///     Safe distance: 2 x sizeof(a[0]), and 2 x sizeof(b[0]), respectively.
3143 ///
3144 ///  * Zero distances and all accesses have the same size.
3145 ///
3146 class MemoryDepChecker {
3147 public:
3148   typedef PointerIntPair<Value *, 1, bool> MemAccessInfo;
3149   typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet;
3150
3151   MemoryDepChecker(ScalarEvolution *Se, DataLayout *Dl, const Loop *L) :
3152     SE(Se), DL(Dl), InnermostLoop(L), AccessIdx(0) {}
3153
3154   /// \brief Register the location (instructions are given increasing numbers)
3155   /// of a write access.
3156   void addAccess(StoreInst *SI) {
3157     Value *Ptr = SI->getPointerOperand();
3158     Accesses[MemAccessInfo(Ptr, true)].push_back(AccessIdx);
3159     InstMap.push_back(SI);
3160     ++AccessIdx;
3161   }
3162
3163   /// \brief Register the location (instructions are given increasing numbers)
3164   /// of a write access.
3165   void addAccess(LoadInst *LI) {
3166     Value *Ptr = LI->getPointerOperand();
3167     Accesses[MemAccessInfo(Ptr, false)].push_back(AccessIdx);
3168     InstMap.push_back(LI);
3169     ++AccessIdx;
3170   }
3171
3172   /// \brief Check whether the dependencies between the accesses are safe.
3173   ///
3174   /// Only checks sets with elements in \p CheckDeps.
3175   bool areDepsSafe(AccessAnalysis::DepCandidates &AccessSets,
3176                    MemAccessInfoSet &CheckDeps);
3177
3178   /// \brief The maximum number of bytes of a vector register we can vectorize
3179   /// the accesses safely with.
3180   unsigned getMaxSafeDepDistBytes() { return MaxSafeDepDistBytes; }
3181
3182 private:
3183   ScalarEvolution *SE;
3184   DataLayout *DL;
3185   const Loop *InnermostLoop;
3186
3187   /// \brief Maps access locations (ptr, read/write) to program order.
3188   DenseMap<MemAccessInfo, std::vector<unsigned> > Accesses;
3189
3190   /// \brief Memory access instructions in program order.
3191   SmallVector<Instruction *, 16> InstMap;
3192
3193   /// \brief The program order index to be used for the next instruction.
3194   unsigned AccessIdx;
3195
3196   // We can access this many bytes in parallel safely.
3197   unsigned MaxSafeDepDistBytes;
3198
3199   /// \brief Check whether there is a plausible dependence between the two
3200   /// accesses.
3201   ///
3202   /// Access \p A must happen before \p B in program order. The two indices
3203   /// identify the index into the program order map.
3204   ///
3205   /// This function checks  whether there is a plausible dependence (or the
3206   /// absence of such can't be proved) between the two accesses. If there is a
3207   /// plausible dependence but the dependence distance is bigger than one
3208   /// element access it records this distance in \p MaxSafeDepDistBytes (if this
3209   /// distance is smaller than any other distance encountered so far).
3210   /// Otherwise, this function returns true signaling a possible dependence.
3211   bool isDependent(const MemAccessInfo &A, unsigned AIdx,
3212                    const MemAccessInfo &B, unsigned BIdx);
3213
3214   /// \brief Check whether the data dependence could prevent store-load
3215   /// forwarding.
3216   bool couldPreventStoreLoadForward(unsigned Distance, unsigned TypeByteSize);
3217 };
3218
3219 } // end anonymous namespace
3220
3221 static bool isInBoundsGep(Value *Ptr) {
3222   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr))
3223     return GEP->isInBounds();
3224   return false;
3225 }
3226
3227 /// \brief Check whether the access through \p Ptr has a constant stride.
3228 static int isStridedPtr(ScalarEvolution *SE, DataLayout *DL, Value *Ptr,
3229                         const Loop *Lp) {
3230   const Type *Ty = Ptr->getType();
3231   assert(Ty->isPointerTy() && "Unexpected non ptr");
3232
3233   // Make sure that the pointer does not point to aggregate types.
3234   const PointerType *PtrTy = cast<PointerType>(Ty);
3235   if (PtrTy->getElementType()->isAggregateType()) {
3236     DEBUG(dbgs() << "LV: Bad stride - Not a pointer to a scalar type" << *Ptr <<
3237           "\n");
3238     return 0;
3239   }
3240
3241   const SCEV *PtrScev = SE->getSCEV(Ptr);
3242   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
3243   if (!AR) {
3244     DEBUG(dbgs() << "LV: Bad stride - Not an AddRecExpr pointer "
3245           << *Ptr << " SCEV: " << *PtrScev << "\n");
3246     return 0;
3247   }
3248
3249   // The accesss function must stride over the innermost loop.
3250   if (Lp != AR->getLoop()) {
3251     DEBUG(dbgs() << "LV: Bad stride - Not striding over innermost loop " <<
3252           *Ptr << " SCEV: " << *PtrScev << "\n");
3253   }
3254
3255   // The address calculation must not wrap. Otherwise, a dependence could be
3256   // inverted.
3257   // An inbounds getelementptr that is a AddRec with a unit stride
3258   // cannot wrap per definition. The unit stride requirement is checked later.
3259   // An getelementptr without an inbounds attribute and unit stride would have
3260   // to access the pointer value "0" which is undefined behavior in address
3261   // space 0, therefore we can also vectorize this case.
3262   bool IsInBoundsGEP = isInBoundsGep(Ptr);
3263   bool IsNoWrapAddRec = AR->getNoWrapFlags(SCEV::NoWrapMask);
3264   bool IsInAddressSpaceZero = PtrTy->getAddressSpace() == 0;
3265   if (!IsNoWrapAddRec && !IsInBoundsGEP && !IsInAddressSpaceZero) {
3266     DEBUG(dbgs() << "LV: Bad stride - Pointer may wrap in the address space "
3267           << *Ptr << " SCEV: " << *PtrScev << "\n");
3268     return 0;
3269   }
3270
3271   // Check the step is constant.
3272   const SCEV *Step = AR->getStepRecurrence(*SE);
3273
3274   // Calculate the pointer stride and check if it is consecutive.
3275   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
3276   if (!C) {
3277     DEBUG(dbgs() << "LV: Bad stride - Not a constant strided " << *Ptr <<
3278           " SCEV: " << *PtrScev << "\n");
3279     return 0;
3280   }
3281
3282   int64_t Size = DL->getTypeAllocSize(PtrTy->getElementType());
3283   const APInt &APStepVal = C->getValue()->getValue();
3284
3285   // Huge step value - give up.
3286   if (APStepVal.getBitWidth() > 64)
3287     return 0;
3288
3289   int64_t StepVal = APStepVal.getSExtValue();
3290
3291   // Strided access.
3292   int64_t Stride = StepVal / Size;
3293   int64_t Rem = StepVal % Size;
3294   if (Rem)
3295     return 0;
3296
3297   // If the SCEV could wrap but we have an inbounds gep with a unit stride we
3298   // know we can't "wrap around the address space". In case of address space
3299   // zero we know that this won't happen without triggering undefined behavior.
3300   if (!IsNoWrapAddRec && (IsInBoundsGEP || IsInAddressSpaceZero) &&
3301       Stride != 1 && Stride != -1)
3302     return 0;
3303
3304   return Stride;
3305 }
3306
3307 bool MemoryDepChecker::couldPreventStoreLoadForward(unsigned Distance,
3308                                                     unsigned TypeByteSize) {
3309   // If loads occur at a distance that is not a multiple of a feasible vector
3310   // factor store-load forwarding does not take place.
3311   // Positive dependences might cause troubles because vectorizing them might
3312   // prevent store-load forwarding making vectorized code run a lot slower.
3313   //   a[i] = a[i-3] ^ a[i-8];
3314   //   The stores to a[i:i+1] don't align with the stores to a[i-3:i-2] and
3315   //   hence on your typical architecture store-load forwarding does not take
3316   //   place. Vectorizing in such cases does not make sense.
3317   // Store-load forwarding distance.
3318   const unsigned NumCyclesForStoreLoadThroughMemory = 8*TypeByteSize;
3319   // Maximum vector factor.
3320   unsigned MaxVFWithoutSLForwardIssues = MaxVectorWidth*TypeByteSize;
3321   if(MaxSafeDepDistBytes < MaxVFWithoutSLForwardIssues)
3322     MaxVFWithoutSLForwardIssues = MaxSafeDepDistBytes;
3323
3324   for (unsigned vf = 2*TypeByteSize; vf <= MaxVFWithoutSLForwardIssues;
3325        vf *= 2) {
3326     if (Distance % vf && Distance / vf < NumCyclesForStoreLoadThroughMemory) {
3327       MaxVFWithoutSLForwardIssues = (vf >>=1);
3328       break;
3329     }
3330   }
3331
3332   if (MaxVFWithoutSLForwardIssues< 2*TypeByteSize) {
3333     DEBUG(dbgs() << "LV: Distance " << Distance <<
3334           " that could cause a store-load forwarding conflict\n");
3335     return true;
3336   }
3337
3338   if (MaxVFWithoutSLForwardIssues < MaxSafeDepDistBytes &&
3339       MaxVFWithoutSLForwardIssues != MaxVectorWidth*TypeByteSize)
3340     MaxSafeDepDistBytes = MaxVFWithoutSLForwardIssues;
3341   return false;
3342 }
3343
3344 bool MemoryDepChecker::isDependent(const MemAccessInfo &A, unsigned AIdx,
3345                                    const MemAccessInfo &B, unsigned BIdx) {
3346   assert (AIdx < BIdx && "Must pass arguments in program order");
3347
3348   Value *APtr = A.getPointer();
3349   Value *BPtr = B.getPointer();
3350   bool AIsWrite = A.getInt();
3351   bool BIsWrite = B.getInt();
3352
3353   // Two reads are independent.
3354   if (!AIsWrite && !BIsWrite)
3355     return false;
3356
3357   const SCEV *AScev = SE->getSCEV(APtr);
3358   const SCEV *BScev = SE->getSCEV(BPtr);
3359
3360   int StrideAPtr = isStridedPtr(SE, DL, APtr, InnermostLoop);
3361   int StrideBPtr = isStridedPtr(SE, DL, BPtr, InnermostLoop);
3362
3363   const SCEV *Src = AScev;
3364   const SCEV *Sink = BScev;
3365
3366   // If the induction step is negative we have to invert source and sink of the
3367   // dependence.
3368   if (StrideAPtr < 0) {
3369     //Src = BScev;
3370     //Sink = AScev;
3371     std::swap(APtr, BPtr);
3372     std::swap(Src, Sink);
3373     std::swap(AIsWrite, BIsWrite);
3374     std::swap(AIdx, BIdx);
3375     std::swap(StrideAPtr, StrideBPtr);
3376   }
3377
3378   const SCEV *Dist = SE->getMinusSCEV(Sink, Src);
3379
3380   DEBUG(dbgs() << "LV: Src Scev: " << *Src << "Sink Scev: " << *Sink
3381         << "(Induction step: " << StrideAPtr <<  ")\n");
3382   DEBUG(dbgs() << "LV: Distance for " << *InstMap[AIdx] << " to "
3383         << *InstMap[BIdx] << ": " << *Dist << "\n");
3384
3385   // Need consecutive accesses. We don't want to vectorize
3386   // "A[B[i]] += ..." and similar code or pointer arithmetic that could wrap in
3387   // the address space.
3388   if (!StrideAPtr || !StrideBPtr || StrideAPtr != StrideBPtr){
3389     DEBUG(dbgs() << "Non-consecutive pointer access\n");
3390     return true;
3391   }
3392
3393   const SCEVConstant *C = dyn_cast<SCEVConstant>(Dist);
3394   if (!C) {
3395     DEBUG(dbgs() << "LV: Dependence because of non constant distance\n");
3396     return true;
3397   }
3398
3399   Type *ATy = APtr->getType()->getPointerElementType();
3400   Type *BTy = BPtr->getType()->getPointerElementType();
3401   unsigned TypeByteSize = DL->getTypeAllocSize(ATy);
3402
3403   // Negative distances are not plausible dependencies.
3404   const APInt &Val = C->getValue()->getValue();
3405   if (Val.isNegative()) {
3406     bool IsTrueDataDependence = (AIsWrite && !BIsWrite);
3407     if (IsTrueDataDependence &&
3408         (couldPreventStoreLoadForward(Val.abs().getZExtValue(), TypeByteSize) ||
3409          ATy != BTy))
3410       return true;
3411
3412     DEBUG(dbgs() << "LV: Dependence is negative: NoDep\n");
3413     return false;
3414   }
3415
3416   // Write to the same location with the same size.
3417   // Could be improved to assert type sizes are the same (i32 == float, etc).
3418   if (Val == 0) {
3419     if (ATy == BTy)
3420       return false;
3421     DEBUG(dbgs() << "LV: Zero dependence difference but different types");
3422     return true;
3423   }
3424
3425   assert(Val.isStrictlyPositive() && "Expect a positive value");
3426
3427   // Positive distance bigger than max vectorization factor.
3428   if (ATy != BTy) {
3429     DEBUG(dbgs() <<
3430           "LV: ReadWrite-Write positive dependency with different types");
3431     return false;
3432   }
3433
3434   unsigned Distance = (unsigned) Val.getZExtValue();
3435
3436   // Bail out early if passed-in parameters make vectorization not feasible.
3437   unsigned ForcedFactor = VectorizationFactor ? VectorizationFactor : 1;
3438   unsigned ForcedUnroll = VectorizationUnroll ? VectorizationUnroll : 1;
3439
3440   // The distance must be bigger than the size needed for a vectorized version
3441   // of the operation and the size of the vectorized operation must not be
3442   // bigger than the currrent maximum size.
3443   if (Distance < 2*TypeByteSize ||
3444       2*TypeByteSize > MaxSafeDepDistBytes ||
3445       Distance < TypeByteSize * ForcedUnroll * ForcedFactor) {
3446     DEBUG(dbgs() << "LV: Failure because of Positive distance "
3447         << Val.getSExtValue() << "\n");
3448     return true;
3449   }
3450
3451   MaxSafeDepDistBytes = Distance < MaxSafeDepDistBytes ?
3452     Distance : MaxSafeDepDistBytes;
3453
3454   bool IsTrueDataDependence = (!AIsWrite && BIsWrite);
3455   if (IsTrueDataDependence &&
3456       couldPreventStoreLoadForward(Distance, TypeByteSize))
3457      return true;
3458
3459   DEBUG(dbgs() << "LV: Positive distance " << Val.getSExtValue() <<
3460         " with max VF=" << MaxSafeDepDistBytes/TypeByteSize << "\n");
3461
3462   return false;
3463 }
3464
3465 bool
3466 MemoryDepChecker::areDepsSafe(AccessAnalysis::DepCandidates &AccessSets,
3467                               MemAccessInfoSet &CheckDeps) {
3468
3469   MaxSafeDepDistBytes = -1U;
3470   while (!CheckDeps.empty()) {
3471     MemAccessInfo CurAccess = *CheckDeps.begin();
3472
3473     // Get the relevant memory access set.
3474     EquivalenceClasses<MemAccessInfo>::iterator I =
3475       AccessSets.findValue(AccessSets.getLeaderValue(CurAccess));
3476
3477     // Check accesses within this set.
3478     EquivalenceClasses<MemAccessInfo>::member_iterator AI, AE;
3479     AI = AccessSets.member_begin(I), AE = AccessSets.member_end();
3480
3481     // Check every access pair.
3482     while (AI != AE) {
3483       CheckDeps.erase(*AI);
3484       EquivalenceClasses<MemAccessInfo>::member_iterator OI = llvm::next(AI);
3485       while (OI != AE) {
3486         // Check every accessing instruction pair in program order.
3487         for (std::vector<unsigned>::iterator I1 = Accesses[*AI].begin(),
3488              I1E = Accesses[*AI].end(); I1 != I1E; ++I1)
3489           for (std::vector<unsigned>::iterator I2 = Accesses[*OI].begin(),
3490                I2E = Accesses[*OI].end(); I2 != I2E; ++I2) {
3491             if (*I1 < *I2 && isDependent(*AI, *I1, *OI, *I2))
3492               return false;
3493             if (*I2 < *I1 && isDependent(*OI, *I2, *AI, *I1))
3494               return false;
3495           }
3496         ++OI;
3497       }
3498       AI++;
3499     }
3500   }
3501   return true;
3502 }
3503
3504 bool LoopVectorizationLegality::canVectorizeMemory() {
3505
3506   typedef SmallVector<Value*, 16> ValueVector;
3507   typedef SmallPtrSet<Value*, 16> ValueSet;
3508
3509   // Holds the Load and Store *instructions*.
3510   ValueVector Loads;
3511   ValueVector Stores;
3512
3513   // Holds all the different accesses in the loop.
3514   unsigned NumReads = 0;
3515   unsigned NumReadWrites = 0;
3516
3517   PtrRtCheck.Pointers.clear();
3518   PtrRtCheck.Need = false;
3519
3520   const bool IsAnnotatedParallel = TheLoop->isAnnotatedParallel();
3521   MemoryDepChecker DepChecker(SE, DL, TheLoop);
3522
3523   // For each block.
3524   for (Loop::block_iterator bb = TheLoop->block_begin(),
3525        be = TheLoop->block_end(); bb != be; ++bb) {
3526
3527     // Scan the BB and collect legal loads and stores.
3528     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
3529          ++it) {
3530
3531       // If this is a load, save it. If this instruction can read from memory
3532       // but is not a load, then we quit. Notice that we don't handle function
3533       // calls that read or write.
3534       if (it->mayReadFromMemory()) {
3535         // Many math library functions read the rounding mode. We will only
3536         // vectorize a loop if it contains known function calls that don't set
3537         // the flag. Therefore, it is safe to ignore this read from memory.
3538         CallInst *Call = dyn_cast<CallInst>(it);
3539         if (Call && getIntrinsicIDForCall(Call, TLI))
3540           continue;
3541
3542         LoadInst *Ld = dyn_cast<LoadInst>(it);
3543         if (!Ld) return false;
3544         if (!Ld->isSimple() && !IsAnnotatedParallel) {
3545           DEBUG(dbgs() << "LV: Found a non-simple load.\n");
3546           return false;
3547         }
3548         Loads.push_back(Ld);
3549         DepChecker.addAccess(Ld);
3550         continue;
3551       }
3552
3553       // Save 'store' instructions. Abort if other instructions write to memory.
3554       if (it->mayWriteToMemory()) {
3555         StoreInst *St = dyn_cast<StoreInst>(it);
3556         if (!St) return false;
3557         if (!St->isSimple() && !IsAnnotatedParallel) {
3558           DEBUG(dbgs() << "LV: Found a non-simple store.\n");
3559           return false;
3560         }
3561         Stores.push_back(St);
3562         DepChecker.addAccess(St);
3563       }
3564     } // next instr.
3565   } // next block.
3566
3567   // Now we have two lists that hold the loads and the stores.
3568   // Next, we find the pointers that they use.
3569
3570   // Check if we see any stores. If there are no stores, then we don't
3571   // care if the pointers are *restrict*.
3572   if (!Stores.size()) {
3573     DEBUG(dbgs() << "LV: Found a read-only loop!\n");
3574     return true;
3575   }
3576
3577   AccessAnalysis::DepCandidates DependentAccesses;
3578   AccessAnalysis Accesses(DL, DependentAccesses);
3579
3580   // Holds the analyzed pointers. We don't want to call GetUnderlyingObjects
3581   // multiple times on the same object. If the ptr is accessed twice, once
3582   // for read and once for write, it will only appear once (on the write
3583   // list). This is okay, since we are going to check for conflicts between
3584   // writes and between reads and writes, but not between reads and reads.
3585   ValueSet Seen;
3586
3587   ValueVector::iterator I, IE;
3588   for (I = Stores.begin(), IE = Stores.end(); I != IE; ++I) {
3589     StoreInst *ST = cast<StoreInst>(*I);
3590     Value* Ptr = ST->getPointerOperand();
3591
3592     if (isUniform(Ptr)) {
3593       DEBUG(dbgs() << "LV: We don't allow storing to uniform addresses\n");
3594       return false;
3595     }
3596
3597     // If we did *not* see this pointer before, insert it to  the read-write
3598     // list. At this phase it is only a 'write' list.
3599     if (Seen.insert(Ptr)) {
3600       ++NumReadWrites;
3601       Accesses.addStore(Ptr);
3602     }
3603   }
3604
3605   if (IsAnnotatedParallel) {
3606     DEBUG(dbgs()
3607           << "LV: A loop annotated parallel, ignore memory dependency "
3608           << "checks.\n");
3609     return true;
3610   }
3611
3612   SmallPtrSet<Value *, 16> ReadOnlyPtr;
3613   for (I = Loads.begin(), IE = Loads.end(); I != IE; ++I) {
3614     LoadInst *LD = cast<LoadInst>(*I);
3615     Value* Ptr = LD->getPointerOperand();
3616     // If we did *not* see this pointer before, insert it to the
3617     // read list. If we *did* see it before, then it is already in
3618     // the read-write list. This allows us to vectorize expressions
3619     // such as A[i] += x;  Because the address of A[i] is a read-write
3620     // pointer. This only works if the index of A[i] is consecutive.
3621     // If the address of i is unknown (for example A[B[i]]) then we may
3622     // read a few words, modify, and write a few words, and some of the
3623     // words may be written to the same address.
3624     bool IsReadOnlyPtr = false;
3625     if (Seen.insert(Ptr) || !isStridedPtr(SE, DL, Ptr, TheLoop)) {
3626       ++NumReads;
3627       IsReadOnlyPtr = true;
3628     }
3629     Accesses.addLoad(Ptr, IsReadOnlyPtr);
3630   }
3631
3632   // If we write (or read-write) to a single destination and there are no
3633   // other reads in this loop then is it safe to vectorize.
3634   if (NumReadWrites == 1 && NumReads == 0) {
3635     DEBUG(dbgs() << "LV: Found a write-only loop!\n");
3636     return true;
3637   }
3638
3639   // Build dependence sets and check whether we need a runtime pointer bounds
3640   // check.
3641   Accesses.buildDependenceSets();
3642   bool NeedRTCheck = Accesses.isRTCheckNeeded();
3643
3644   // Find pointers with computable bounds. We are going to use this information
3645   // to place a runtime bound check.
3646   unsigned NumComparisons = 0;
3647   bool CanDoRT = false;
3648   if (NeedRTCheck)
3649     CanDoRT = Accesses.canCheckPtrAtRT(PtrRtCheck, NumComparisons, SE, TheLoop);
3650
3651
3652   DEBUG(dbgs() << "LV: We need to do " << NumComparisons <<
3653         " pointer comparisons.\n");
3654
3655   // If we only have one set of dependences to check pointers among we don't
3656   // need a runtime check.
3657   if (NumComparisons == 0 && NeedRTCheck)
3658     NeedRTCheck = false;
3659
3660   // Check that we did not collect too many pointers or found a unsizeable
3661   // pointer.
3662   if (!CanDoRT || NumComparisons > RuntimeMemoryCheckThreshold) {
3663     PtrRtCheck.reset();
3664     CanDoRT = false;
3665   }
3666
3667   if (CanDoRT) {
3668     DEBUG(dbgs() << "LV: We can perform a memory runtime check if needed.\n");
3669   }
3670
3671   if (NeedRTCheck && !CanDoRT) {
3672     DEBUG(dbgs() << "LV: We can't vectorize because we can't find " <<
3673           "the array bounds.\n");
3674     PtrRtCheck.reset();
3675     return false;
3676   }
3677
3678   PtrRtCheck.Need = NeedRTCheck;
3679
3680   bool CanVecMem = true;
3681   if (Accesses.isDependencyCheckNeeded()) {
3682     DEBUG(dbgs() << "LV: Checking memory dependencies\n");
3683     CanVecMem = DepChecker.areDepsSafe(DependentAccesses,
3684                                        Accesses.getDependenciesToCheck());
3685     MaxSafeDepDistBytes = DepChecker.getMaxSafeDepDistBytes();
3686   }
3687
3688   DEBUG(dbgs() << "LV: We "<< (NeedRTCheck ? "" : "don't") <<
3689         " need a runtime memory check.\n");
3690
3691   return CanVecMem;
3692 }
3693
3694 static bool hasMultipleUsesOf(Instruction *I,
3695                               SmallPtrSet<Instruction *, 8> &Insts) {
3696   unsigned NumUses = 0;
3697   for(User::op_iterator Use = I->op_begin(), E = I->op_end(); Use != E; ++Use) {
3698     if (Insts.count(dyn_cast<Instruction>(*Use)))
3699       ++NumUses;
3700     if (NumUses > 1)
3701       return true;
3702   }
3703
3704   return false;
3705 }
3706
3707 static bool areAllUsesIn(Instruction *I, SmallPtrSet<Instruction *, 8> &Set) {
3708   for(User::op_iterator Use = I->op_begin(), E = I->op_end(); Use != E; ++Use)
3709     if (!Set.count(dyn_cast<Instruction>(*Use)))
3710       return false;
3711   return true;
3712 }
3713
3714 bool LoopVectorizationLegality::AddReductionVar(PHINode *Phi,
3715                                                 ReductionKind Kind) {
3716   if (Phi->getNumIncomingValues() != 2)
3717     return false;
3718
3719   // Reduction variables are only found in the loop header block.
3720   if (Phi->getParent() != TheLoop->getHeader())
3721     return false;
3722
3723   // Obtain the reduction start value from the value that comes from the loop
3724   // preheader.
3725   Value *RdxStart = Phi->getIncomingValueForBlock(TheLoop->getLoopPreheader());
3726
3727   // ExitInstruction is the single value which is used outside the loop.
3728   // We only allow for a single reduction value to be used outside the loop.
3729   // This includes users of the reduction, variables (which form a cycle
3730   // which ends in the phi node).
3731   Instruction *ExitInstruction = 0;
3732   // Indicates that we found a reduction operation in our scan.
3733   bool FoundReduxOp = false;
3734
3735   // We start with the PHI node and scan for all of the users of this
3736   // instruction. All users must be instructions that can be used as reduction
3737   // variables (such as ADD). We must have a single out-of-block user. The cycle
3738   // must include the original PHI.
3739   bool FoundStartPHI = false;
3740
3741   // To recognize min/max patterns formed by a icmp select sequence, we store
3742   // the number of instruction we saw from the recognized min/max pattern,
3743   //  to make sure we only see exactly the two instructions.
3744   unsigned NumCmpSelectPatternInst = 0;
3745   ReductionInstDesc ReduxDesc(false, 0);
3746
3747   SmallPtrSet<Instruction *, 8> VisitedInsts;
3748   SmallVector<Instruction *, 8> Worklist;
3749   Worklist.push_back(Phi);
3750   VisitedInsts.insert(Phi);
3751
3752   // A value in the reduction can be used:
3753   //  - By the reduction:
3754   //      - Reduction operation:
3755   //        - One use of reduction value (safe).
3756   //        - Multiple use of reduction value (not safe).
3757   //      - PHI:
3758   //        - All uses of the PHI must be the reduction (safe).
3759   //        - Otherwise, not safe.
3760   //  - By one instruction outside of the loop (safe).
3761   //  - By further instructions outside of the loop (not safe).
3762   //  - By an instruction that is not part of the reduction (not safe).
3763   //    This is either:
3764   //      * An instruction type other than PHI or the reduction operation.
3765   //      * A PHI in the header other than the initial PHI.
3766   while (!Worklist.empty()) {
3767     Instruction *Cur = Worklist.back();
3768     Worklist.pop_back();
3769
3770     // No Users.
3771     // If the instruction has no users then this is a broken chain and can't be
3772     // a reduction variable.
3773     if (Cur->use_empty())
3774       return false;
3775
3776     bool IsAPhi = isa<PHINode>(Cur);
3777
3778     // A header PHI use other than the original PHI.
3779     if (Cur != Phi && IsAPhi && Cur->getParent() == Phi->getParent())
3780       return false;
3781
3782     // Reductions of instructions such as Div, and Sub is only possible if the
3783     // LHS is the reduction variable.
3784     if (!Cur->isCommutative() && !IsAPhi && !isa<SelectInst>(Cur) &&
3785         !isa<ICmpInst>(Cur) && !isa<FCmpInst>(Cur) &&
3786         !VisitedInsts.count(dyn_cast<Instruction>(Cur->getOperand(0))))
3787       return false;
3788
3789     // Any reduction instruction must be of one of the allowed kinds.
3790     ReduxDesc = isReductionInstr(Cur, Kind, ReduxDesc);
3791     if (!ReduxDesc.IsReduction)
3792       return false;
3793
3794     // A reduction operation must only have one use of the reduction value.
3795     if (!IsAPhi && Kind != RK_IntegerMinMax && Kind != RK_FloatMinMax &&
3796         hasMultipleUsesOf(Cur, VisitedInsts))
3797       return false;
3798
3799     // All inputs to a PHI node must be a reduction value.
3800     if(IsAPhi && Cur != Phi && !areAllUsesIn(Cur, VisitedInsts))
3801       return false;
3802
3803     if (Kind == RK_IntegerMinMax && (isa<ICmpInst>(Cur) ||
3804                                      isa<SelectInst>(Cur)))
3805       ++NumCmpSelectPatternInst;
3806     if (Kind == RK_FloatMinMax && (isa<FCmpInst>(Cur) ||
3807                                    isa<SelectInst>(Cur)))
3808       ++NumCmpSelectPatternInst;
3809
3810     // Check  whether we found a reduction operator.
3811     FoundReduxOp |= !IsAPhi;
3812
3813     // Process users of current instruction. Push non PHI nodes after PHI nodes
3814     // onto the stack. This way we are going to have seen all inputs to PHI
3815     // nodes once we get to them.
3816     SmallVector<Instruction *, 8> NonPHIs;
3817     SmallVector<Instruction *, 8> PHIs;
3818     for (Value::use_iterator UI = Cur->use_begin(), E = Cur->use_end(); UI != E;
3819          ++UI) {
3820       Instruction *Usr = cast<Instruction>(*UI);
3821
3822       // Check if we found the exit user.
3823       BasicBlock *Parent = Usr->getParent();
3824       if (!TheLoop->contains(Parent)) {
3825         // Exit if you find multiple outside users or if the header phi node is
3826         // being used. In this case the user uses the value of the previous
3827         // iteration, in which case we would loose "VF-1" iterations of the
3828         // reduction operation if we vectorize.
3829         if (ExitInstruction != 0 || Cur == Phi)
3830           return false;
3831
3832         ExitInstruction = Cur;
3833         continue;
3834       }
3835
3836       // Process instructions only once (termination).
3837       if (VisitedInsts.insert(Usr)) {
3838         if (isa<PHINode>(Usr))
3839           PHIs.push_back(Usr);
3840         else
3841           NonPHIs.push_back(Usr);
3842       }
3843       // Remember that we completed the cycle.
3844       if (Usr == Phi)
3845         FoundStartPHI = true;
3846     }
3847     Worklist.append(PHIs.begin(), PHIs.end());
3848     Worklist.append(NonPHIs.begin(), NonPHIs.end());
3849   }
3850
3851   // This means we have seen one but not the other instruction of the
3852   // pattern or more than just a select and cmp.
3853   if ((Kind == RK_IntegerMinMax || Kind == RK_FloatMinMax) &&
3854       NumCmpSelectPatternInst != 2)
3855     return false;
3856
3857   if (!FoundStartPHI || !FoundReduxOp || !ExitInstruction)
3858     return false;
3859
3860   // We found a reduction var if we have reached the original phi node and we
3861   // only have a single instruction with out-of-loop users.
3862
3863   // This instruction is allowed to have out-of-loop users.
3864   AllowedExit.insert(ExitInstruction);
3865
3866   // Save the description of this reduction variable.
3867   ReductionDescriptor RD(RdxStart, ExitInstruction, Kind,
3868                          ReduxDesc.MinMaxKind);
3869   Reductions[Phi] = RD;
3870   // We've ended the cycle. This is a reduction variable if we have an
3871   // outside user and it has a binary op.
3872
3873   return true;
3874 }
3875
3876 /// Returns true if the instruction is a Select(ICmp(X, Y), X, Y) instruction
3877 /// pattern corresponding to a min(X, Y) or max(X, Y).
3878 LoopVectorizationLegality::ReductionInstDesc
3879 LoopVectorizationLegality::isMinMaxSelectCmpPattern(Instruction *I,
3880                                                     ReductionInstDesc &Prev) {
3881
3882   assert((isa<ICmpInst>(I) || isa<FCmpInst>(I) || isa<SelectInst>(I)) &&
3883          "Expect a select instruction");
3884   Instruction *Cmp = 0;
3885   SelectInst *Select = 0;
3886
3887   // We must handle the select(cmp()) as a single instruction. Advance to the
3888   // select.
3889   if ((Cmp = dyn_cast<ICmpInst>(I)) || (Cmp = dyn_cast<FCmpInst>(I))) {
3890     if (!Cmp->hasOneUse() || !(Select = dyn_cast<SelectInst>(*I->use_begin())))
3891       return ReductionInstDesc(false, I);
3892     return ReductionInstDesc(Select, Prev.MinMaxKind);
3893   }
3894
3895   // Only handle single use cases for now.
3896   if (!(Select = dyn_cast<SelectInst>(I)))
3897     return ReductionInstDesc(false, I);
3898   if (!(Cmp = dyn_cast<ICmpInst>(I->getOperand(0))) &&
3899       !(Cmp = dyn_cast<FCmpInst>(I->getOperand(0))))
3900     return ReductionInstDesc(false, I);
3901   if (!Cmp->hasOneUse())
3902     return ReductionInstDesc(false, I);
3903
3904   Value *CmpLeft;
3905   Value *CmpRight;
3906
3907   // Look for a min/max pattern.
3908   if (m_UMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3909     return ReductionInstDesc(Select, MRK_UIntMin);
3910   else if (m_UMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3911     return ReductionInstDesc(Select, MRK_UIntMax);
3912   else if (m_SMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3913     return ReductionInstDesc(Select, MRK_SIntMax);
3914   else if (m_SMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3915     return ReductionInstDesc(Select, MRK_SIntMin);
3916   else if (m_OrdFMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3917     return ReductionInstDesc(Select, MRK_FloatMin);
3918   else if (m_OrdFMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3919     return ReductionInstDesc(Select, MRK_FloatMax);
3920   else if (m_UnordFMin(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3921     return ReductionInstDesc(Select, MRK_FloatMin);
3922   else if (m_UnordFMax(m_Value(CmpLeft), m_Value(CmpRight)).match(Select))
3923     return ReductionInstDesc(Select, MRK_FloatMax);
3924
3925   return ReductionInstDesc(false, I);
3926 }
3927
3928 LoopVectorizationLegality::ReductionInstDesc
3929 LoopVectorizationLegality::isReductionInstr(Instruction *I,
3930                                             ReductionKind Kind,
3931                                             ReductionInstDesc &Prev) {
3932   bool FP = I->getType()->isFloatingPointTy();
3933   bool FastMath = (FP && I->isCommutative() && I->isAssociative());
3934   switch (I->getOpcode()) {
3935   default:
3936     return ReductionInstDesc(false, I);
3937   case Instruction::PHI:
3938       if (FP && (Kind != RK_FloatMult && Kind != RK_FloatAdd &&
3939                  Kind != RK_FloatMinMax))
3940         return ReductionInstDesc(false, I);
3941     return ReductionInstDesc(I, Prev.MinMaxKind);
3942   case Instruction::Sub:
3943   case Instruction::Add:
3944     return ReductionInstDesc(Kind == RK_IntegerAdd, I);
3945   case Instruction::Mul:
3946     return ReductionInstDesc(Kind == RK_IntegerMult, I);
3947   case Instruction::And:
3948     return ReductionInstDesc(Kind == RK_IntegerAnd, I);
3949   case Instruction::Or:
3950     return ReductionInstDesc(Kind == RK_IntegerOr, I);
3951   case Instruction::Xor:
3952     return ReductionInstDesc(Kind == RK_IntegerXor, I);
3953   case Instruction::FMul:
3954     return ReductionInstDesc(Kind == RK_FloatMult && FastMath, I);
3955   case Instruction::FAdd:
3956     return ReductionInstDesc(Kind == RK_FloatAdd && FastMath, I);
3957   case Instruction::FCmp:
3958   case Instruction::ICmp:
3959   case Instruction::Select:
3960     if (Kind != RK_IntegerMinMax &&
3961         (!HasFunNoNaNAttr || Kind != RK_FloatMinMax))
3962       return ReductionInstDesc(false, I);
3963     return isMinMaxSelectCmpPattern(I, Prev);
3964   }
3965 }
3966
3967 LoopVectorizationLegality::InductionKind
3968 LoopVectorizationLegality::isInductionVariable(PHINode *Phi) {
3969   Type *PhiTy = Phi->getType();
3970   // We only handle integer and pointer inductions variables.
3971   if (!PhiTy->isIntegerTy() && !PhiTy->isPointerTy())
3972     return IK_NoInduction;
3973
3974   // Check that the PHI is consecutive.
3975   const SCEV *PhiScev = SE->getSCEV(Phi);
3976   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PhiScev);
3977   if (!AR) {
3978     DEBUG(dbgs() << "LV: PHI is not a poly recurrence.\n");
3979     return IK_NoInduction;
3980   }
3981   const SCEV *Step = AR->getStepRecurrence(*SE);
3982
3983   // Integer inductions need to have a stride of one.
3984   if (PhiTy->isIntegerTy()) {
3985     if (Step->isOne())
3986       return IK_IntInduction;
3987     if (Step->isAllOnesValue())
3988       return IK_ReverseIntInduction;
3989     return IK_NoInduction;
3990   }
3991
3992   // Calculate the pointer stride and check if it is consecutive.
3993   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
3994   if (!C)
3995     return IK_NoInduction;
3996
3997   assert(PhiTy->isPointerTy() && "The PHI must be a pointer");
3998   uint64_t Size = DL->getTypeAllocSize(PhiTy->getPointerElementType());
3999   if (C->getValue()->equalsInt(Size))
4000     return IK_PtrInduction;
4001   else if (C->getValue()->equalsInt(0 - Size))
4002     return IK_ReversePtrInduction;
4003
4004   return IK_NoInduction;
4005 }
4006
4007 bool LoopVectorizationLegality::isInductionVariable(const Value *V) {
4008   Value *In0 = const_cast<Value*>(V);
4009   PHINode *PN = dyn_cast_or_null<PHINode>(In0);
4010   if (!PN)
4011     return false;
4012
4013   return Inductions.count(PN);
4014 }
4015
4016 bool LoopVectorizationLegality::blockNeedsPredication(BasicBlock *BB)  {
4017   assert(TheLoop->contains(BB) && "Unknown block used");
4018
4019   // Blocks that do not dominate the latch need predication.
4020   BasicBlock* Latch = TheLoop->getLoopLatch();
4021   return !DT->dominates(BB, Latch);
4022 }
4023
4024 bool LoopVectorizationLegality::blockCanBePredicated(BasicBlock *BB,
4025                                             SmallPtrSet<Value *, 8>& SafePtrs) {
4026   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
4027     // We might be able to hoist the load.
4028     if (it->mayReadFromMemory()) {
4029       LoadInst *LI = dyn_cast<LoadInst>(it);
4030       if (!LI || !SafePtrs.count(LI->getPointerOperand()))
4031         return false;
4032     }
4033
4034     // We don't predicate stores at the moment.
4035     if (it->mayWriteToMemory() || it->mayThrow())
4036       return false;
4037
4038     // The instructions below can trap.
4039     switch (it->getOpcode()) {
4040     default: continue;
4041     case Instruction::UDiv:
4042     case Instruction::SDiv:
4043     case Instruction::URem:
4044     case Instruction::SRem:
4045              return false;
4046     }
4047   }
4048
4049   return true;
4050 }
4051
4052 LoopVectorizationCostModel::VectorizationFactor
4053 LoopVectorizationCostModel::selectVectorizationFactor(bool OptForSize,
4054                                                       unsigned UserVF) {
4055   // Width 1 means no vectorize
4056   VectorizationFactor Factor = { 1U, 0U };
4057   if (OptForSize && Legal->getRuntimePointerCheck()->Need) {
4058     DEBUG(dbgs() << "LV: Aborting. Runtime ptr check is required in Os.\n");
4059     return Factor;
4060   }
4061
4062   // Find the trip count.
4063   unsigned TC = SE->getSmallConstantTripCount(TheLoop, TheLoop->getLoopLatch());
4064   DEBUG(dbgs() << "LV: Found trip count:"<<TC<<"\n");
4065
4066   unsigned WidestType = getWidestType();
4067   unsigned WidestRegister = TTI.getRegisterBitWidth(true);
4068   unsigned MaxSafeDepDist = -1U;
4069   if (Legal->getMaxSafeDepDistBytes() != -1U)
4070     MaxSafeDepDist = Legal->getMaxSafeDepDistBytes() * 8;
4071   WidestRegister = ((WidestRegister < MaxSafeDepDist) ?
4072                     WidestRegister : MaxSafeDepDist);
4073   unsigned MaxVectorSize = WidestRegister / WidestType;
4074   DEBUG(dbgs() << "LV: The Widest type: " << WidestType << " bits.\n");
4075   DEBUG(dbgs() << "LV: The Widest register is:" << WidestRegister << "bits.\n");
4076
4077   if (MaxVectorSize == 0) {
4078     DEBUG(dbgs() << "LV: The target has no vector registers.\n");
4079     MaxVectorSize = 1;
4080   }
4081
4082   assert(MaxVectorSize <= 32 && "Did not expect to pack so many elements"
4083          " into one vector!");
4084
4085   unsigned VF = MaxVectorSize;
4086
4087   // If we optimize the program for size, avoid creating the tail loop.
4088   if (OptForSize) {
4089     // If we are unable to calculate the trip count then don't try to vectorize.
4090     if (TC < 2) {
4091       DEBUG(dbgs() << "LV: Aborting. A tail loop is required in Os.\n");
4092       return Factor;
4093     }
4094
4095     // Find the maximum SIMD width that can fit within the trip count.
4096     VF = TC % MaxVectorSize;
4097
4098     if (VF == 0)
4099       VF = MaxVectorSize;
4100
4101     // If the trip count that we found modulo the vectorization factor is not
4102     // zero then we require a tail.
4103     if (VF < 2) {
4104       DEBUG(dbgs() << "LV: Aborting. A tail loop is required in Os.\n");
4105       return Factor;
4106     }
4107   }
4108
4109   if (UserVF != 0) {
4110     assert(isPowerOf2_32(UserVF) && "VF needs to be a power of two");
4111     DEBUG(dbgs() << "LV: Using user VF "<<UserVF<<".\n");
4112
4113     Factor.Width = UserVF;
4114     return Factor;
4115   }
4116
4117   float Cost = expectedCost(1);
4118   unsigned Width = 1;
4119   DEBUG(dbgs() << "LV: Scalar loop costs: "<< (int)Cost << ".\n");
4120   for (unsigned i=2; i <= VF; i*=2) {
4121     // Notice that the vector loop needs to be executed less times, so
4122     // we need to divide the cost of the vector loops by the width of
4123     // the vector elements.
4124     float VectorCost = expectedCost(i) / (float)i;
4125     DEBUG(dbgs() << "LV: Vector loop of width "<< i << " costs: " <<
4126           (int)VectorCost << ".\n");
4127     if (VectorCost < Cost) {
4128       Cost = VectorCost;
4129       Width = i;
4130     }
4131   }
4132
4133   DEBUG(dbgs() << "LV: Selecting VF = : "<< Width << ".\n");
4134   Factor.Width = Width;
4135   Factor.Cost = Width * Cost;
4136   return Factor;
4137 }
4138
4139 unsigned LoopVectorizationCostModel::getWidestType() {
4140   unsigned MaxWidth = 8;
4141
4142   // For each block.
4143   for (Loop::block_iterator bb = TheLoop->block_begin(),
4144        be = TheLoop->block_end(); bb != be; ++bb) {
4145     BasicBlock *BB = *bb;
4146
4147     // For each instruction in the loop.
4148     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
4149       Type *T = it->getType();
4150
4151       // Only examine Loads, Stores and PHINodes.
4152       if (!isa<LoadInst>(it) && !isa<StoreInst>(it) && !isa<PHINode>(it))
4153         continue;
4154
4155       // Examine PHI nodes that are reduction variables.
4156       if (PHINode *PN = dyn_cast<PHINode>(it))
4157         if (!Legal->getReductionVars()->count(PN))
4158           continue;
4159
4160       // Examine the stored values.
4161       if (StoreInst *ST = dyn_cast<StoreInst>(it))
4162         T = ST->getValueOperand()->getType();
4163
4164       // Ignore loaded pointer types and stored pointer types that are not
4165       // consecutive. However, we do want to take consecutive stores/loads of
4166       // pointer vectors into account.
4167       if (T->isPointerTy() && !isConsecutiveLoadOrStore(it))
4168         continue;
4169
4170       MaxWidth = std::max(MaxWidth,
4171                           (unsigned)DL->getTypeSizeInBits(T->getScalarType()));
4172     }
4173   }
4174
4175   return MaxWidth;
4176 }
4177
4178 unsigned
4179 LoopVectorizationCostModel::selectUnrollFactor(bool OptForSize,
4180                                                unsigned UserUF,
4181                                                unsigned VF,
4182                                                unsigned LoopCost) {
4183
4184   // -- The unroll heuristics --
4185   // We unroll the loop in order to expose ILP and reduce the loop overhead.
4186   // There are many micro-architectural considerations that we can't predict
4187   // at this level. For example frontend pressure (on decode or fetch) due to
4188   // code size, or the number and capabilities of the execution ports.
4189   //
4190   // We use the following heuristics to select the unroll factor:
4191   // 1. If the code has reductions the we unroll in order to break the cross
4192   // iteration dependency.
4193   // 2. If the loop is really small then we unroll in order to reduce the loop
4194   // overhead.
4195   // 3. We don't unroll if we think that we will spill registers to memory due
4196   // to the increased register pressure.
4197
4198   // Use the user preference, unless 'auto' is selected.
4199   if (UserUF != 0)
4200     return UserUF;
4201
4202   // When we optimize for size we don't unroll.
4203   if (OptForSize)
4204     return 1;
4205
4206   // We used the distance for the unroll factor.
4207   if (Legal->getMaxSafeDepDistBytes() != -1U)
4208     return 1;
4209
4210   // Do not unroll loops with a relatively small trip count.
4211   unsigned TC = SE->getSmallConstantTripCount(TheLoop,
4212                                               TheLoop->getLoopLatch());
4213   if (TC > 1 && TC < TinyTripCountUnrollThreshold)
4214     return 1;
4215
4216   unsigned TargetVectorRegisters = TTI.getNumberOfRegisters(true);
4217   DEBUG(dbgs() << "LV: The target has " << TargetVectorRegisters <<
4218         " vector registers\n");
4219
4220   LoopVectorizationCostModel::RegisterUsage R = calculateRegisterUsage();
4221   // We divide by these constants so assume that we have at least one
4222   // instruction that uses at least one register.
4223   R.MaxLocalUsers = std::max(R.MaxLocalUsers, 1U);
4224   R.NumInstructions = std::max(R.NumInstructions, 1U);
4225
4226   // We calculate the unroll factor using the following formula.
4227   // Subtract the number of loop invariants from the number of available
4228   // registers. These registers are used by all of the unrolled instances.
4229   // Next, divide the remaining registers by the number of registers that is
4230   // required by the loop, in order to estimate how many parallel instances
4231   // fit without causing spills.
4232   unsigned UF = (TargetVectorRegisters - R.LoopInvariantRegs) / R.MaxLocalUsers;
4233
4234   // Clamp the unroll factor ranges to reasonable factors.
4235   unsigned MaxUnrollSize = TTI.getMaximumUnrollFactor();
4236
4237   // If we did not calculate the cost for VF (because the user selected the VF)
4238   // then we calculate the cost of VF here.
4239   if (LoopCost == 0)
4240     LoopCost = expectedCost(VF);
4241
4242   // Clamp the calculated UF to be between the 1 and the max unroll factor
4243   // that the target allows.
4244   if (UF > MaxUnrollSize)
4245     UF = MaxUnrollSize;
4246   else if (UF < 1)
4247     UF = 1;
4248
4249   if (Legal->getReductionVars()->size()) {
4250     DEBUG(dbgs() << "LV: Unrolling because of reductions. \n");
4251     return UF;
4252   }
4253
4254   // We want to unroll tiny loops in order to reduce the loop overhead.
4255   // We assume that the cost overhead is 1 and we use the cost model
4256   // to estimate the cost of the loop and unroll until the cost of the
4257   // loop overhead is about 5% of the cost of the loop.
4258   DEBUG(dbgs() << "LV: Loop cost is "<< LoopCost <<" \n");
4259   if (LoopCost < 20) {
4260     DEBUG(dbgs() << "LV: Unrolling to reduce branch cost. \n");
4261     unsigned NewUF = 20/LoopCost + 1;
4262     return std::min(NewUF, UF);
4263   }
4264
4265   DEBUG(dbgs() << "LV: Not Unrolling. \n");
4266   return 1;
4267 }
4268
4269 LoopVectorizationCostModel::RegisterUsage
4270 LoopVectorizationCostModel::calculateRegisterUsage() {
4271   // This function calculates the register usage by measuring the highest number
4272   // of values that are alive at a single location. Obviously, this is a very
4273   // rough estimation. We scan the loop in a topological order in order and
4274   // assign a number to each instruction. We use RPO to ensure that defs are
4275   // met before their users. We assume that each instruction that has in-loop
4276   // users starts an interval. We record every time that an in-loop value is
4277   // used, so we have a list of the first and last occurrences of each
4278   // instruction. Next, we transpose this data structure into a multi map that
4279   // holds the list of intervals that *end* at a specific location. This multi
4280   // map allows us to perform a linear search. We scan the instructions linearly
4281   // and record each time that a new interval starts, by placing it in a set.
4282   // If we find this value in the multi-map then we remove it from the set.
4283   // The max register usage is the maximum size of the set.
4284   // We also search for instructions that are defined outside the loop, but are
4285   // used inside the loop. We need this number separately from the max-interval
4286   // usage number because when we unroll, loop-invariant values do not take
4287   // more register.
4288   LoopBlocksDFS DFS(TheLoop);
4289   DFS.perform(LI);
4290
4291   RegisterUsage R;
4292   R.NumInstructions = 0;
4293
4294   // Each 'key' in the map opens a new interval. The values
4295   // of the map are the index of the 'last seen' usage of the
4296   // instruction that is the key.
4297   typedef DenseMap<Instruction*, unsigned> IntervalMap;
4298   // Maps instruction to its index.
4299   DenseMap<unsigned, Instruction*> IdxToInstr;
4300   // Marks the end of each interval.
4301   IntervalMap EndPoint;
4302   // Saves the list of instruction indices that are used in the loop.
4303   SmallSet<Instruction*, 8> Ends;
4304   // Saves the list of values that are used in the loop but are
4305   // defined outside the loop, such as arguments and constants.
4306   SmallPtrSet<Value*, 8> LoopInvariants;
4307
4308   unsigned Index = 0;
4309   for (LoopBlocksDFS::RPOIterator bb = DFS.beginRPO(),
4310        be = DFS.endRPO(); bb != be; ++bb) {
4311     R.NumInstructions += (*bb)->size();
4312     for (BasicBlock::iterator it = (*bb)->begin(), e = (*bb)->end(); it != e;
4313          ++it) {
4314       Instruction *I = it;
4315       IdxToInstr[Index++] = I;
4316
4317       // Save the end location of each USE.
4318       for (unsigned i = 0; i < I->getNumOperands(); ++i) {
4319         Value *U = I->getOperand(i);
4320         Instruction *Instr = dyn_cast<Instruction>(U);
4321
4322         // Ignore non-instruction values such as arguments, constants, etc.
4323         if (!Instr) continue;
4324
4325         // If this instruction is outside the loop then record it and continue.
4326         if (!TheLoop->contains(Instr)) {
4327           LoopInvariants.insert(Instr);
4328           continue;
4329         }
4330
4331         // Overwrite previous end points.
4332         EndPoint[Instr] = Index;
4333         Ends.insert(Instr);
4334       }
4335     }
4336   }
4337
4338   // Saves the list of intervals that end with the index in 'key'.
4339   typedef SmallVector<Instruction*, 2> InstrList;
4340   DenseMap<unsigned, InstrList> TransposeEnds;
4341
4342   // Transpose the EndPoints to a list of values that end at each index.
4343   for (IntervalMap::iterator it = EndPoint.begin(), e = EndPoint.end();
4344        it != e; ++it)
4345     TransposeEnds[it->second].push_back(it->first);
4346
4347   SmallSet<Instruction*, 8> OpenIntervals;
4348   unsigned MaxUsage = 0;
4349
4350
4351   DEBUG(dbgs() << "LV(REG): Calculating max register usage:\n");
4352   for (unsigned int i = 0; i < Index; ++i) {
4353     Instruction *I = IdxToInstr[i];
4354     // Ignore instructions that are never used within the loop.
4355     if (!Ends.count(I)) continue;
4356
4357     // Remove all of the instructions that end at this location.
4358     InstrList &List = TransposeEnds[i];
4359     for (unsigned int j=0, e = List.size(); j < e; ++j)
4360       OpenIntervals.erase(List[j]);
4361
4362     // Count the number of live interals.
4363     MaxUsage = std::max(MaxUsage, OpenIntervals.size());
4364
4365     DEBUG(dbgs() << "LV(REG): At #" << i << " Interval # " <<
4366           OpenIntervals.size() <<"\n");
4367
4368     // Add the current instruction to the list of open intervals.
4369     OpenIntervals.insert(I);
4370   }
4371
4372   unsigned Invariant = LoopInvariants.size();
4373   DEBUG(dbgs() << "LV(REG): Found max usage: " << MaxUsage << " \n");
4374   DEBUG(dbgs() << "LV(REG): Found invariant usage: " << Invariant << " \n");
4375   DEBUG(dbgs() << "LV(REG): LoopSize: " << R.NumInstructions << " \n");
4376
4377   R.LoopInvariantRegs = Invariant;
4378   R.MaxLocalUsers = MaxUsage;
4379   return R;
4380 }
4381
4382 unsigned LoopVectorizationCostModel::expectedCost(unsigned VF) {
4383   unsigned Cost = 0;
4384
4385   // For each block.
4386   for (Loop::block_iterator bb = TheLoop->block_begin(),
4387        be = TheLoop->block_end(); bb != be; ++bb) {
4388     unsigned BlockCost = 0;
4389     BasicBlock *BB = *bb;
4390
4391     // For each instruction in the old loop.
4392     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
4393       // Skip dbg intrinsics.
4394       if (isa<DbgInfoIntrinsic>(it))
4395         continue;
4396
4397       unsigned C = getInstructionCost(it, VF);
4398       BlockCost += C;
4399       DEBUG(dbgs() << "LV: Found an estimated cost of "<< C <<" for VF " <<
4400             VF << " For instruction: "<< *it << "\n");
4401     }
4402
4403     // We assume that if-converted blocks have a 50% chance of being executed.
4404     // When the code is scalar then some of the blocks are avoided due to CF.
4405     // When the code is vectorized we execute all code paths.
4406     if (VF == 1 && Legal->blockNeedsPredication(*bb))
4407       BlockCost /= 2;
4408
4409     Cost += BlockCost;
4410   }
4411
4412   return Cost;
4413 }
4414
4415 /// \brief Check whether the address computation for a non-consecutive memory
4416 /// access looks like an unlikely candidate for being merged into the indexing
4417 /// mode.
4418 ///
4419 /// We look for a GEP which has one index that is an induction variable and all
4420 /// other indices are loop invariant. If the stride of this access is also
4421 /// within a small bound we decide that this address computation can likely be
4422 /// merged into the addressing mode.
4423 /// In all other cases, we identify the address computation as complex.
4424 static bool isLikelyComplexAddressComputation(Value *Ptr,
4425                                               LoopVectorizationLegality *Legal,
4426                                               ScalarEvolution *SE,
4427                                               const Loop *TheLoop) {
4428   GetElementPtrInst *Gep = dyn_cast<GetElementPtrInst>(Ptr);
4429   if (!Gep)
4430     return true;
4431
4432   // We are looking for a gep with all loop invariant indices except for one
4433   // which should be an induction variable.
4434   unsigned NumOperands = Gep->getNumOperands();
4435   for (unsigned i = 1; i < NumOperands; ++i) {
4436     Value *Opd = Gep->getOperand(i);
4437     if (!SE->isLoopInvariant(SE->getSCEV(Opd), TheLoop) &&
4438         !Legal->isInductionVariable(Opd))
4439       return true;
4440   }
4441
4442   // Now we know we have a GEP ptr, %inv, %ind, %inv. Make sure that the step
4443   // can likely be merged into the address computation.
4444   unsigned MaxMergeDistance = 64;
4445
4446   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(SE->getSCEV(Ptr));
4447   if (!AddRec)
4448     return true;
4449
4450   // Check the step is constant.
4451   const SCEV *Step = AddRec->getStepRecurrence(*SE);
4452   // Calculate the pointer stride and check if it is consecutive.
4453   const SCEVConstant *C = dyn_cast<SCEVConstant>(Step);
4454   if (!C)
4455     return true;
4456
4457   const APInt &APStepVal = C->getValue()->getValue();
4458
4459   // Huge step value - give up.
4460   if (APStepVal.getBitWidth() > 64)
4461     return true;
4462
4463   int64_t StepVal = APStepVal.getSExtValue();
4464
4465   return StepVal > MaxMergeDistance;
4466 }
4467
4468 unsigned
4469 LoopVectorizationCostModel::getInstructionCost(Instruction *I, unsigned VF) {
4470   // If we know that this instruction will remain uniform, check the cost of
4471   // the scalar version.
4472   if (Legal->isUniformAfterVectorization(I))
4473     VF = 1;
4474
4475   Type *RetTy = I->getType();
4476   Type *VectorTy = ToVectorTy(RetTy, VF);
4477
4478   // TODO: We need to estimate the cost of intrinsic calls.
4479   switch (I->getOpcode()) {
4480   case Instruction::GetElementPtr:
4481     // We mark this instruction as zero-cost because the cost of GEPs in
4482     // vectorized code depends on whether the corresponding memory instruction
4483     // is scalarized or not. Therefore, we handle GEPs with the memory
4484     // instruction cost.
4485     return 0;
4486   case Instruction::Br: {
4487     return TTI.getCFInstrCost(I->getOpcode());
4488   }
4489   case Instruction::PHI:
4490     //TODO: IF-converted IFs become selects.
4491     return 0;
4492   case Instruction::Add:
4493   case Instruction::FAdd:
4494   case Instruction::Sub:
4495   case Instruction::FSub:
4496   case Instruction::Mul:
4497   case Instruction::FMul:
4498   case Instruction::UDiv:
4499   case Instruction::SDiv:
4500   case Instruction::FDiv:
4501   case Instruction::URem:
4502   case Instruction::SRem:
4503   case Instruction::FRem:
4504   case Instruction::Shl:
4505   case Instruction::LShr:
4506   case Instruction::AShr:
4507   case Instruction::And:
4508   case Instruction::Or:
4509   case Instruction::Xor: {
4510     // Certain instructions can be cheaper to vectorize if they have a constant
4511     // second vector operand. One example of this are shifts on x86.
4512     TargetTransformInfo::OperandValueKind Op1VK =
4513       TargetTransformInfo::OK_AnyValue;
4514     TargetTransformInfo::OperandValueKind Op2VK =
4515       TargetTransformInfo::OK_AnyValue;
4516
4517     if (isa<ConstantInt>(I->getOperand(1)))
4518       Op2VK = TargetTransformInfo::OK_UniformConstantValue;
4519
4520     return TTI.getArithmeticInstrCost(I->getOpcode(), VectorTy, Op1VK, Op2VK);
4521   }
4522   case Instruction::Select: {
4523     SelectInst *SI = cast<SelectInst>(I);
4524     const SCEV *CondSCEV = SE->getSCEV(SI->getCondition());
4525     bool ScalarCond = (SE->isLoopInvariant(CondSCEV, TheLoop));
4526     Type *CondTy = SI->getCondition()->getType();
4527     if (!ScalarCond)
4528       CondTy = VectorType::get(CondTy, VF);
4529
4530     return TTI.getCmpSelInstrCost(I->getOpcode(), VectorTy, CondTy);
4531   }
4532   case Instruction::ICmp:
4533   case Instruction::FCmp: {
4534     Type *ValTy = I->getOperand(0)->getType();
4535     VectorTy = ToVectorTy(ValTy, VF);
4536     return TTI.getCmpSelInstrCost(I->getOpcode(), VectorTy);
4537   }
4538   case Instruction::Store:
4539   case Instruction::Load: {
4540     StoreInst *SI = dyn_cast<StoreInst>(I);
4541     LoadInst *LI = dyn_cast<LoadInst>(I);
4542     Type *ValTy = (SI ? SI->getValueOperand()->getType() :
4543                    LI->getType());
4544     VectorTy = ToVectorTy(ValTy, VF);
4545
4546     unsigned Alignment = SI ? SI->getAlignment() : LI->getAlignment();
4547     unsigned AS = SI ? SI->getPointerAddressSpace() :
4548       LI->getPointerAddressSpace();
4549     Value *Ptr = SI ? SI->getPointerOperand() : LI->getPointerOperand();
4550     // We add the cost of address computation here instead of with the gep
4551     // instruction because only here we know whether the operation is
4552     // scalarized.
4553     if (VF == 1)
4554       return TTI.getAddressComputationCost(VectorTy) +
4555         TTI.getMemoryOpCost(I->getOpcode(), VectorTy, Alignment, AS);
4556
4557     // Scalarized loads/stores.
4558     int ConsecutiveStride = Legal->isConsecutivePtr(Ptr);
4559     bool Reverse = ConsecutiveStride < 0;
4560     unsigned ScalarAllocatedSize = DL->getTypeAllocSize(ValTy);
4561     unsigned VectorElementSize = DL->getTypeStoreSize(VectorTy)/VF;
4562     if (!ConsecutiveStride || ScalarAllocatedSize != VectorElementSize) {
4563       bool IsComplexComputation =
4564         isLikelyComplexAddressComputation(Ptr, Legal, SE, TheLoop);
4565       unsigned Cost = 0;
4566       // The cost of extracting from the value vector and pointer vector.
4567       Type *PtrTy = ToVectorTy(Ptr->getType(), VF);
4568       for (unsigned i = 0; i < VF; ++i) {
4569         //  The cost of extracting the pointer operand.
4570         Cost += TTI.getVectorInstrCost(Instruction::ExtractElement, PtrTy, i);
4571         // In case of STORE, the cost of ExtractElement from the vector.
4572         // In case of LOAD, the cost of InsertElement into the returned
4573         // vector.
4574         Cost += TTI.getVectorInstrCost(SI ? Instruction::ExtractElement :
4575                                             Instruction::InsertElement,
4576                                             VectorTy, i);
4577       }
4578
4579       // The cost of the scalar loads/stores.
4580       Cost += VF * TTI.getAddressComputationCost(PtrTy, IsComplexComputation);
4581       Cost += VF * TTI.getMemoryOpCost(I->getOpcode(), ValTy->getScalarType(),
4582                                        Alignment, AS);
4583       return Cost;
4584     }
4585
4586     // Wide load/stores.
4587     unsigned Cost = TTI.getAddressComputationCost(VectorTy);
4588     Cost += TTI.getMemoryOpCost(I->getOpcode(), VectorTy, Alignment, AS);
4589
4590     if (Reverse)
4591       Cost += TTI.getShuffleCost(TargetTransformInfo::SK_Reverse,
4592                                   VectorTy, 0);
4593     return Cost;
4594   }
4595   case Instruction::ZExt:
4596   case Instruction::SExt:
4597   case Instruction::FPToUI:
4598   case Instruction::FPToSI:
4599   case Instruction::FPExt:
4600   case Instruction::PtrToInt:
4601   case Instruction::IntToPtr:
4602   case Instruction::SIToFP:
4603   case Instruction::UIToFP:
4604   case Instruction::Trunc:
4605   case Instruction::FPTrunc:
4606   case Instruction::BitCast: {
4607     // We optimize the truncation of induction variable.
4608     // The cost of these is the same as the scalar operation.
4609     if (I->getOpcode() == Instruction::Trunc &&
4610         Legal->isInductionVariable(I->getOperand(0)))
4611       return TTI.getCastInstrCost(I->getOpcode(), I->getType(),
4612                                   I->getOperand(0)->getType());
4613
4614     Type *SrcVecTy = ToVectorTy(I->getOperand(0)->getType(), VF);
4615     return TTI.getCastInstrCost(I->getOpcode(), VectorTy, SrcVecTy);
4616   }
4617   case Instruction::Call: {
4618     CallInst *CI = cast<CallInst>(I);
4619     Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
4620     assert(ID && "Not an intrinsic call!");
4621     Type *RetTy = ToVectorTy(CI->getType(), VF);
4622     SmallVector<Type*, 4> Tys;
4623     for (unsigned i = 0, ie = CI->getNumArgOperands(); i != ie; ++i)
4624       Tys.push_back(ToVectorTy(CI->getArgOperand(i)->getType(), VF));
4625     return TTI.getIntrinsicInstrCost(ID, RetTy, Tys);
4626   }
4627   default: {
4628     // We are scalarizing the instruction. Return the cost of the scalar
4629     // instruction, plus the cost of insert and extract into vector
4630     // elements, times the vector width.
4631     unsigned Cost = 0;
4632
4633     if (!RetTy->isVoidTy() && VF != 1) {
4634       unsigned InsCost = TTI.getVectorInstrCost(Instruction::InsertElement,
4635                                                 VectorTy);
4636       unsigned ExtCost = TTI.getVectorInstrCost(Instruction::ExtractElement,
4637                                                 VectorTy);
4638
4639       // The cost of inserting the results plus extracting each one of the
4640       // operands.
4641       Cost += VF * (InsCost + ExtCost * I->getNumOperands());
4642     }
4643
4644     // The cost of executing VF copies of the scalar instruction. This opcode
4645     // is unknown. Assume that it is the same as 'mul'.
4646     Cost += VF * TTI.getArithmeticInstrCost(Instruction::Mul, VectorTy);
4647     return Cost;
4648   }
4649   }// end of switch.
4650 }
4651
4652 Type* LoopVectorizationCostModel::ToVectorTy(Type *Scalar, unsigned VF) {
4653   if (Scalar->isVoidTy() || VF == 1)
4654     return Scalar;
4655   return VectorType::get(Scalar, VF);
4656 }
4657
4658 char LoopVectorize::ID = 0;
4659 static const char lv_name[] = "Loop Vectorization";
4660 INITIALIZE_PASS_BEGIN(LoopVectorize, LV_NAME, lv_name, false, false)
4661 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
4662 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
4663 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
4664 INITIALIZE_PASS_END(LoopVectorize, LV_NAME, lv_name, false, false)
4665
4666 namespace llvm {
4667   Pass *createLoopVectorizePass() {
4668     return new LoopVectorize();
4669   }
4670 }
4671
4672 bool LoopVectorizationCostModel::isConsecutiveLoadOrStore(Instruction *Inst) {
4673   // Check for a store.
4674   if (StoreInst *ST = dyn_cast<StoreInst>(Inst))
4675     return Legal->isConsecutivePtr(ST->getPointerOperand()) != 0;
4676
4677   // Check for a load.
4678   if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
4679     return Legal->isConsecutivePtr(LI->getPointerOperand()) != 0;
4680
4681   return false;
4682 }