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