Revert r210342 and r210343, add test case for the crasher.
[oota-llvm.git] / lib / Transforms / Vectorize / SLPVectorizer.cpp
1 //===- SLPVectorizer.cpp - A bottom up SLP 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 // This pass implements the Bottom Up SLP vectorizer. It detects consecutive
10 // stores that can be put together into vector-stores. Next, it attempts to
11 // construct vectorizable tree using the use-def chains. If a profitable tree
12 // was found, the SLP vectorizer performs vectorization on the tree.
13 //
14 // The pass is inspired by the work described in the paper:
15 //  "Loop-Aware SLP in GCC" by Ira Rosen, Dorit Nuzman, Ayal Zaks.
16 //
17 //===----------------------------------------------------------------------===//
18 #include "llvm/Transforms/Vectorize.h"
19 #include "llvm/ADT/MapVector.h"
20 #include "llvm/ADT/PostOrderIterator.h"
21 #include "llvm/ADT/SetVector.h"
22 #include "llvm/ADT/Statistic.h"
23 #include "llvm/Analysis/AliasAnalysis.h"
24 #include "llvm/Analysis/LoopInfo.h"
25 #include "llvm/Analysis/ScalarEvolution.h"
26 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
27 #include "llvm/Analysis/TargetTransformInfo.h"
28 #include "llvm/Analysis/ValueTracking.h"
29 #include "llvm/IR/DataLayout.h"
30 #include "llvm/IR/Dominators.h"
31 #include "llvm/IR/IRBuilder.h"
32 #include "llvm/IR/Instructions.h"
33 #include "llvm/IR/IntrinsicInst.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/IR/NoFolder.h"
36 #include "llvm/IR/Type.h"
37 #include "llvm/IR/Value.h"
38 #include "llvm/IR/Verifier.h"
39 #include "llvm/Pass.h"
40 #include "llvm/Support/CommandLine.h"
41 #include "llvm/Support/Debug.h"
42 #include "llvm/Support/raw_ostream.h"
43 #include "llvm/Transforms/Utils/VectorUtils.h"
44 #include <algorithm>
45 #include <map>
46 #include <memory>
47
48 using namespace llvm;
49
50 #define SV_NAME "slp-vectorizer"
51 #define DEBUG_TYPE "SLP"
52
53 STATISTIC(NumVectorInstructions, "Number of vector instructions generated");
54
55 static cl::opt<int>
56     SLPCostThreshold("slp-threshold", cl::init(0), cl::Hidden,
57                      cl::desc("Only vectorize if you gain more than this "
58                               "number "));
59
60 static cl::opt<bool>
61 ShouldVectorizeHor("slp-vectorize-hor", cl::init(false), cl::Hidden,
62                    cl::desc("Attempt to vectorize horizontal reductions"));
63
64 static cl::opt<bool> ShouldStartVectorizeHorAtStore(
65     "slp-vectorize-hor-store", cl::init(false), cl::Hidden,
66     cl::desc(
67         "Attempt to vectorize horizontal reductions feeding into a store"));
68
69 namespace {
70
71 static const unsigned MinVecRegSize = 128;
72
73 static const unsigned RecursionMaxDepth = 12;
74
75 /// \returns the parent basic block if all of the instructions in \p VL
76 /// are in the same block or null otherwise.
77 static BasicBlock *getSameBlock(ArrayRef<Value *> VL) {
78   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
79   if (!I0)
80     return nullptr;
81   BasicBlock *BB = I0->getParent();
82   for (int i = 1, e = VL.size(); i < e; i++) {
83     Instruction *I = dyn_cast<Instruction>(VL[i]);
84     if (!I)
85       return nullptr;
86
87     if (BB != I->getParent())
88       return nullptr;
89   }
90   return BB;
91 }
92
93 /// \returns True if all of the values in \p VL are constants.
94 static bool allConstant(ArrayRef<Value *> VL) {
95   for (unsigned i = 0, e = VL.size(); i < e; ++i)
96     if (!isa<Constant>(VL[i]))
97       return false;
98   return true;
99 }
100
101 /// \returns True if all of the values in \p VL are identical.
102 static bool isSplat(ArrayRef<Value *> VL) {
103   for (unsigned i = 1, e = VL.size(); i < e; ++i)
104     if (VL[i] != VL[0])
105       return false;
106   return true;
107 }
108
109 ///\returns Opcode that can be clubbed with \p Op to create an alternate
110 /// sequence which can later be merged as a ShuffleVector instruction.
111 static unsigned getAltOpcode(unsigned Op) {
112   switch (Op) {
113   case Instruction::FAdd:
114     return Instruction::FSub;
115   case Instruction::FSub:
116     return Instruction::FAdd;
117   case Instruction::Add:
118     return Instruction::Sub;
119   case Instruction::Sub:
120     return Instruction::Add;
121   default:
122     return 0;
123   }
124 }
125
126 ///\returns bool representing if Opcode \p Op can be part
127 /// of an alternate sequence which can later be merged as
128 /// a ShuffleVector instruction.
129 static bool canCombineAsAltInst(unsigned Op) {
130   if (Op == Instruction::FAdd || Op == Instruction::FSub ||
131       Op == Instruction::Sub || Op == Instruction::Add)
132     return true;
133   return false;
134 }
135
136 /// \returns ShuffleVector instruction if intructions in \p VL have
137 ///  alternate fadd,fsub / fsub,fadd/add,sub/sub,add sequence.
138 /// (i.e. e.g. opcodes of fadd,fsub,fadd,fsub...)
139 static unsigned isAltInst(ArrayRef<Value *> VL) {
140   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
141   unsigned Opcode = I0->getOpcode();
142   unsigned AltOpcode = getAltOpcode(Opcode);
143   for (int i = 1, e = VL.size(); i < e; i++) {
144     Instruction *I = dyn_cast<Instruction>(VL[i]);
145     if (!I || I->getOpcode() != ((i & 1) ? AltOpcode : Opcode))
146       return 0;
147   }
148   return Instruction::ShuffleVector;
149 }
150
151 /// \returns The opcode if all of the Instructions in \p VL have the same
152 /// opcode, or zero.
153 static unsigned getSameOpcode(ArrayRef<Value *> VL) {
154   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
155   if (!I0)
156     return 0;
157   unsigned Opcode = I0->getOpcode();
158   for (int i = 1, e = VL.size(); i < e; i++) {
159     Instruction *I = dyn_cast<Instruction>(VL[i]);
160     if (!I || Opcode != I->getOpcode()) {
161       if (canCombineAsAltInst(Opcode) && i == 1)
162         return isAltInst(VL);
163       return 0;
164     }
165   }
166   return Opcode;
167 }
168
169 /// \returns \p I after propagating metadata from \p VL.
170 static Instruction *propagateMetadata(Instruction *I, ArrayRef<Value *> VL) {
171   Instruction *I0 = cast<Instruction>(VL[0]);
172   SmallVector<std::pair<unsigned, MDNode *>, 4> Metadata;
173   I0->getAllMetadataOtherThanDebugLoc(Metadata);
174
175   for (unsigned i = 0, n = Metadata.size(); i != n; ++i) {
176     unsigned Kind = Metadata[i].first;
177     MDNode *MD = Metadata[i].second;
178
179     for (int i = 1, e = VL.size(); MD && i != e; i++) {
180       Instruction *I = cast<Instruction>(VL[i]);
181       MDNode *IMD = I->getMetadata(Kind);
182
183       switch (Kind) {
184       default:
185         MD = nullptr; // Remove unknown metadata
186         break;
187       case LLVMContext::MD_tbaa:
188         MD = MDNode::getMostGenericTBAA(MD, IMD);
189         break;
190       case LLVMContext::MD_alias_scope:
191       case LLVMContext::MD_noalias:
192         MD = MDNode::intersect(MD, IMD);
193         break;
194       case LLVMContext::MD_fpmath:
195         MD = MDNode::getMostGenericFPMath(MD, IMD);
196         break;
197       }
198     }
199     I->setMetadata(Kind, MD);
200   }
201   return I;
202 }
203
204 /// \returns The type that all of the values in \p VL have or null if there
205 /// are different types.
206 static Type* getSameType(ArrayRef<Value *> VL) {
207   Type *Ty = VL[0]->getType();
208   for (int i = 1, e = VL.size(); i < e; i++)
209     if (VL[i]->getType() != Ty)
210       return nullptr;
211
212   return Ty;
213 }
214
215 /// \returns True if the ExtractElement instructions in VL can be vectorized
216 /// to use the original vector.
217 static bool CanReuseExtract(ArrayRef<Value *> VL) {
218   assert(Instruction::ExtractElement == getSameOpcode(VL) && "Invalid opcode");
219   // Check if all of the extracts come from the same vector and from the
220   // correct offset.
221   Value *VL0 = VL[0];
222   ExtractElementInst *E0 = cast<ExtractElementInst>(VL0);
223   Value *Vec = E0->getOperand(0);
224
225   // We have to extract from the same vector type.
226   unsigned NElts = Vec->getType()->getVectorNumElements();
227
228   if (NElts != VL.size())
229     return false;
230
231   // Check that all of the indices extract from the correct offset.
232   ConstantInt *CI = dyn_cast<ConstantInt>(E0->getOperand(1));
233   if (!CI || CI->getZExtValue())
234     return false;
235
236   for (unsigned i = 1, e = VL.size(); i < e; ++i) {
237     ExtractElementInst *E = cast<ExtractElementInst>(VL[i]);
238     ConstantInt *CI = dyn_cast<ConstantInt>(E->getOperand(1));
239
240     if (!CI || CI->getZExtValue() != i || E->getOperand(0) != Vec)
241       return false;
242   }
243
244   return true;
245 }
246
247 static void reorderInputsAccordingToOpcode(ArrayRef<Value *> VL,
248                                            SmallVectorImpl<Value *> &Left,
249                                            SmallVectorImpl<Value *> &Right) {
250
251   SmallVector<Value *, 16> OrigLeft, OrigRight;
252
253   bool AllSameOpcodeLeft = true;
254   bool AllSameOpcodeRight = true;
255   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
256     Instruction *I = cast<Instruction>(VL[i]);
257     Value *V0 = I->getOperand(0);
258     Value *V1 = I->getOperand(1);
259
260     OrigLeft.push_back(V0);
261     OrigRight.push_back(V1);
262
263     Instruction *I0 = dyn_cast<Instruction>(V0);
264     Instruction *I1 = dyn_cast<Instruction>(V1);
265
266     // Check whether all operands on one side have the same opcode. In this case
267     // we want to preserve the original order and not make things worse by
268     // reordering.
269     AllSameOpcodeLeft = I0;
270     AllSameOpcodeRight = I1;
271
272     if (i && AllSameOpcodeLeft) {
273       if(Instruction *P0 = dyn_cast<Instruction>(OrigLeft[i-1])) {
274         if(P0->getOpcode() != I0->getOpcode())
275           AllSameOpcodeLeft = false;
276       } else
277         AllSameOpcodeLeft = false;
278     }
279     if (i && AllSameOpcodeRight) {
280       if(Instruction *P1 = dyn_cast<Instruction>(OrigRight[i-1])) {
281         if(P1->getOpcode() != I1->getOpcode())
282           AllSameOpcodeRight = false;
283       } else
284         AllSameOpcodeRight = false;
285     }
286
287     // Sort two opcodes. In the code below we try to preserve the ability to use
288     // broadcast of values instead of individual inserts.
289     // vl1 = load
290     // vl2 = phi
291     // vr1 = load
292     // vr2 = vr2
293     //    = vl1 x vr1
294     //    = vl2 x vr2
295     // If we just sorted according to opcode we would leave the first line in
296     // tact but we would swap vl2 with vr2 because opcode(phi) > opcode(load).
297     //    = vl1 x vr1
298     //    = vr2 x vl2
299     // Because vr2 and vr1 are from the same load we loose the opportunity of a
300     // broadcast for the packed right side in the backend: we have [vr1, vl2]
301     // instead of [vr1, vr2=vr1].
302     if (I0 && I1) {
303        if(!i && I0->getOpcode() > I1->getOpcode()) {
304          Left.push_back(I1);
305          Right.push_back(I0);
306        } else if (i && I0->getOpcode() > I1->getOpcode() && Right[i-1] != I1) {
307          // Try not to destroy a broad cast for no apparent benefit.
308          Left.push_back(I1);
309          Right.push_back(I0);
310        } else if (i && I0->getOpcode() == I1->getOpcode() && Right[i-1] ==  I0) {
311          // Try preserve broadcasts.
312          Left.push_back(I1);
313          Right.push_back(I0);
314        } else if (i && I0->getOpcode() == I1->getOpcode() && Left[i-1] == I1) {
315          // Try preserve broadcasts.
316          Left.push_back(I1);
317          Right.push_back(I0);
318        } else {
319          Left.push_back(I0);
320          Right.push_back(I1);
321        }
322        continue;
323     }
324     // One opcode, put the instruction on the right.
325     if (I0) {
326       Left.push_back(V1);
327       Right.push_back(I0);
328       continue;
329     }
330     Left.push_back(V0);
331     Right.push_back(V1);
332   }
333
334   bool LeftBroadcast = isSplat(Left);
335   bool RightBroadcast = isSplat(Right);
336
337   // Don't reorder if the operands where good to begin with.
338   if (!(LeftBroadcast || RightBroadcast) &&
339       (AllSameOpcodeRight || AllSameOpcodeLeft)) {
340     Left = OrigLeft;
341     Right = OrigRight;
342   }
343 }
344
345 /// Bottom Up SLP Vectorizer.
346 class BoUpSLP {
347 public:
348   typedef SmallVector<Value *, 8> ValueList;
349   typedef SmallVector<Instruction *, 16> InstrList;
350   typedef SmallPtrSet<Value *, 16> ValueSet;
351   typedef SmallVector<StoreInst *, 8> StoreList;
352
353   BoUpSLP(Function *Func, ScalarEvolution *Se, const DataLayout *Dl,
354           TargetTransformInfo *Tti, TargetLibraryInfo *TLi, AliasAnalysis *Aa,
355           LoopInfo *Li, DominatorTree *Dt)
356       : NumLoadsWantToKeepOrder(0), NumLoadsWantToChangeOrder(0),
357         F(Func), SE(Se), DL(Dl), TTI(Tti), TLI(TLi), AA(Aa), LI(Li), DT(Dt),
358         Builder(Se->getContext()) {}
359
360   /// \brief Vectorize the tree that starts with the elements in \p VL.
361   /// Returns the vectorized root.
362   Value *vectorizeTree();
363
364   /// \returns the cost incurred by unwanted spills and fills, caused by
365   /// holding live values over call sites.
366   int getSpillCost();
367
368   /// \returns the vectorization cost of the subtree that starts at \p VL.
369   /// A negative number means that this is profitable.
370   int getTreeCost();
371
372   /// Construct a vectorizable tree that starts at \p Roots, ignoring users for
373   /// the purpose of scheduling and extraction in the \p UserIgnoreLst.
374   void buildTree(ArrayRef<Value *> Roots,
375                  ArrayRef<Value *> UserIgnoreLst = None);
376
377   /// Clear the internal data structures that are created by 'buildTree'.
378   void deleteTree() {
379     VectorizableTree.clear();
380     ScalarToTreeEntry.clear();
381     MustGather.clear();
382     ExternalUses.clear();
383     NumLoadsWantToKeepOrder = 0;
384     NumLoadsWantToChangeOrder = 0;
385     for (auto &Iter : BlocksSchedules) {
386       BlockScheduling *BS = Iter.second.get();
387       BS->clear();
388     }
389   }
390
391   /// \returns true if the memory operations A and B are consecutive.
392   bool isConsecutiveAccess(Value *A, Value *B);
393
394   /// \brief Perform LICM and CSE on the newly generated gather sequences.
395   void optimizeGatherSequence();
396
397   /// \returns true if it is benefitial to reverse the vector order.
398   bool shouldReorder() const {
399     return NumLoadsWantToChangeOrder > NumLoadsWantToKeepOrder;
400   }
401
402 private:
403   struct TreeEntry;
404
405   /// \returns the cost of the vectorizable entry.
406   int getEntryCost(TreeEntry *E);
407
408   /// This is the recursive part of buildTree.
409   void buildTree_rec(ArrayRef<Value *> Roots, unsigned Depth);
410
411   /// Vectorize a single entry in the tree.
412   Value *vectorizeTree(TreeEntry *E);
413
414   /// Vectorize a single entry in the tree, starting in \p VL.
415   Value *vectorizeTree(ArrayRef<Value *> VL);
416
417   /// \returns the pointer to the vectorized value if \p VL is already
418   /// vectorized, or NULL. They may happen in cycles.
419   Value *alreadyVectorized(ArrayRef<Value *> VL) const;
420
421   /// \brief Take the pointer operand from the Load/Store instruction.
422   /// \returns NULL if this is not a valid Load/Store instruction.
423   static Value *getPointerOperand(Value *I);
424
425   /// \brief Take the address space operand from the Load/Store instruction.
426   /// \returns -1 if this is not a valid Load/Store instruction.
427   static unsigned getAddressSpaceOperand(Value *I);
428
429   /// \returns the scalarization cost for this type. Scalarization in this
430   /// context means the creation of vectors from a group of scalars.
431   int getGatherCost(Type *Ty);
432
433   /// \returns the scalarization cost for this list of values. Assuming that
434   /// this subtree gets vectorized, we may need to extract the values from the
435   /// roots. This method calculates the cost of extracting the values.
436   int getGatherCost(ArrayRef<Value *> VL);
437
438   /// \brief Set the Builder insert point to one after the last instruction in
439   /// the bundle
440   void setInsertPointAfterBundle(ArrayRef<Value *> VL);
441
442   /// \returns a vector from a collection of scalars in \p VL.
443   Value *Gather(ArrayRef<Value *> VL, VectorType *Ty);
444
445   /// \returns whether the VectorizableTree is fully vectoriable and will
446   /// be beneficial even the tree height is tiny.
447   bool isFullyVectorizableTinyTree();
448
449   struct TreeEntry {
450     TreeEntry() : Scalars(), VectorizedValue(nullptr),
451     NeedToGather(0) {}
452
453     /// \returns true if the scalars in VL are equal to this entry.
454     bool isSame(ArrayRef<Value *> VL) const {
455       assert(VL.size() == Scalars.size() && "Invalid size");
456       return std::equal(VL.begin(), VL.end(), Scalars.begin());
457     }
458
459     /// A vector of scalars.
460     ValueList Scalars;
461
462     /// The Scalars are vectorized into this value. It is initialized to Null.
463     Value *VectorizedValue;
464
465     /// Do we need to gather this sequence ?
466     bool NeedToGather;
467   };
468
469   /// Create a new VectorizableTree entry.
470   TreeEntry *newTreeEntry(ArrayRef<Value *> VL, bool Vectorized) {
471     VectorizableTree.push_back(TreeEntry());
472     int idx = VectorizableTree.size() - 1;
473     TreeEntry *Last = &VectorizableTree[idx];
474     Last->Scalars.insert(Last->Scalars.begin(), VL.begin(), VL.end());
475     Last->NeedToGather = !Vectorized;
476     if (Vectorized) {
477       for (int i = 0, e = VL.size(); i != e; ++i) {
478         assert(!ScalarToTreeEntry.count(VL[i]) && "Scalar already in tree!");
479         ScalarToTreeEntry[VL[i]] = idx;
480       }
481     } else {
482       MustGather.insert(VL.begin(), VL.end());
483     }
484     return Last;
485   }
486   
487   /// -- Vectorization State --
488   /// Holds all of the tree entries.
489   std::vector<TreeEntry> VectorizableTree;
490
491   /// Maps a specific scalar to its tree entry.
492   SmallDenseMap<Value*, int> ScalarToTreeEntry;
493
494   /// A list of scalars that we found that we need to keep as scalars.
495   ValueSet MustGather;
496
497   /// This POD struct describes one external user in the vectorized tree.
498   struct ExternalUser {
499     ExternalUser (Value *S, llvm::User *U, int L) :
500       Scalar(S), User(U), Lane(L){};
501     // Which scalar in our function.
502     Value *Scalar;
503     // Which user that uses the scalar.
504     llvm::User *User;
505     // Which lane does the scalar belong to.
506     int Lane;
507   };
508   typedef SmallVector<ExternalUser, 16> UserList;
509
510   /// A list of values that need to extracted out of the tree.
511   /// This list holds pairs of (Internal Scalar : External User).
512   UserList ExternalUses;
513
514   /// Holds all of the instructions that we gathered.
515   SetVector<Instruction *> GatherSeq;
516   /// A list of blocks that we are going to CSE.
517   SetVector<BasicBlock *> CSEBlocks;
518
519   /// Contains all scheduling relevant data for an instruction.
520   /// A ScheduleData either represents a single instruction or a member of an
521   /// instruction bundle (= a group of instructions which is combined into a
522   /// vector instruction).
523   struct ScheduleData {
524
525     // The initial value for the dependency counters. It means that the
526     // dependencies are not calculated yet.
527     enum { InvalidDeps = -1 };
528
529     ScheduleData()
530         : Inst(nullptr), FirstInBundle(nullptr), NextInBundle(nullptr),
531           NextLoadStore(nullptr), SchedulingRegionID(0), SchedulingPriority(0),
532           Dependencies(InvalidDeps), UnscheduledDeps(InvalidDeps),
533           UnscheduledDepsInBundle(InvalidDeps), IsScheduled(false) {}
534
535     void init(int BlockSchedulingRegionID) {
536       FirstInBundle = this;
537       NextInBundle = nullptr;
538       NextLoadStore = nullptr;
539       IsScheduled = false;
540       SchedulingRegionID = BlockSchedulingRegionID;
541       UnscheduledDepsInBundle = UnscheduledDeps;
542       clearDependencies();
543     }
544
545     /// Returns true if the dependency information has been calculated.
546     bool hasValidDependencies() const { return Dependencies != InvalidDeps; }
547
548     /// Returns true for single instructions and for bundle representatives
549     /// (= the head of a bundle).
550     bool isSchedulingEntity() const { return FirstInBundle == this; }
551
552     /// Returns true if it represents an instruction bundle and not only a
553     /// single instruction.
554     bool isPartOfBundle() const {
555       return NextInBundle != nullptr || FirstInBundle != this;
556     }
557
558     /// Returns true if it is ready for scheduling, i.e. it has no more
559     /// unscheduled depending instructions/bundles.
560     bool isReady() const {
561       assert(isSchedulingEntity() &&
562              "can't consider non-scheduling entity for ready list");
563       return UnscheduledDepsInBundle == 0 && !IsScheduled;
564     }
565
566     /// Modifies the number of unscheduled dependencies, also updating it for
567     /// the whole bundle.
568     int incrementUnscheduledDeps(int Incr) {
569       UnscheduledDeps += Incr;
570       return FirstInBundle->UnscheduledDepsInBundle += Incr;
571     }
572
573     /// Sets the number of unscheduled dependencies to the number of
574     /// dependencies.
575     void resetUnscheduledDeps() {
576       incrementUnscheduledDeps(Dependencies - UnscheduledDeps);
577     }
578
579     /// Clears all dependency information.
580     void clearDependencies() {
581       Dependencies = InvalidDeps;
582       resetUnscheduledDeps();
583       MemoryDependencies.clear();
584     }
585
586     void dump(raw_ostream &os) const {
587       if (!isSchedulingEntity()) {
588         os << "/ " << *Inst;
589       } else if (NextInBundle) {
590         os << '[' << *Inst;
591         ScheduleData *SD = NextInBundle;
592         while (SD) {
593           os << ';' << *SD->Inst;
594           SD = SD->NextInBundle;
595         }
596         os << ']';
597       } else {
598         os << *Inst;
599       }
600     }
601
602     Instruction *Inst;
603
604     /// Points to the head in an instruction bundle (and always to this for
605     /// single instructions).
606     ScheduleData *FirstInBundle;
607
608     /// Single linked list of all instructions in a bundle. Null if it is a
609     /// single instruction.
610     ScheduleData *NextInBundle;
611
612     /// Single linked list of all memory instructions (e.g. load, store, call)
613     /// in the block - until the end of the scheduling region.
614     ScheduleData *NextLoadStore;
615
616     /// The dependent memory instructions.
617     /// This list is derived on demand in calculateDependencies().
618     SmallVector<ScheduleData *, 4> MemoryDependencies;
619
620     /// This ScheduleData is in the current scheduling region if this matches
621     /// the current SchedulingRegionID of BlockScheduling.
622     int SchedulingRegionID;
623
624     /// Used for getting a "good" final ordering of instructions.
625     int SchedulingPriority;
626
627     /// The number of dependencies. Constitutes of the number of users of the
628     /// instruction plus the number of dependent memory instructions (if any).
629     /// This value is calculated on demand.
630     /// If InvalidDeps, the number of dependencies is not calculated yet.
631     ///
632     int Dependencies;
633
634     /// The number of dependencies minus the number of dependencies of scheduled
635     /// instructions. As soon as this is zero, the instruction/bundle gets ready
636     /// for scheduling.
637     /// Note that this is negative as long as Dependencies is not calculated.
638     int UnscheduledDeps;
639
640     /// The sum of UnscheduledDeps in a bundle. Equals to UnscheduledDeps for
641     /// single instructions.
642     int UnscheduledDepsInBundle;
643
644     /// True if this instruction is scheduled (or considered as scheduled in the
645     /// dry-run).
646     bool IsScheduled;
647   };
648
649 #ifndef NDEBUG
650   friend raw_ostream &operator<<(raw_ostream &os,
651                                  const BoUpSLP::ScheduleData &SD);
652 #endif
653
654   /// Contains all scheduling data for a basic block.
655   ///
656   struct BlockScheduling {
657
658     BlockScheduling(BasicBlock *BB)
659         : BB(BB), ChunkSize(BB->size()), ChunkPos(ChunkSize),
660           ScheduleStart(nullptr), ScheduleEnd(nullptr),
661           FirstLoadStoreInRegion(nullptr), LastLoadStoreInRegion(nullptr),
662           // Make sure that the initial SchedulingRegionID is greater than the
663           // initial SchedulingRegionID in ScheduleData (which is 0).
664           SchedulingRegionID(1) {}
665
666     void clear() {
667       ReadyInsts.clear();
668       ScheduleStart = nullptr;
669       ScheduleEnd = nullptr;
670       FirstLoadStoreInRegion = nullptr;
671       LastLoadStoreInRegion = nullptr;
672
673       // Make a new scheduling region, i.e. all existing ScheduleData is not
674       // in the new region yet.
675       ++SchedulingRegionID;
676     }
677
678     ScheduleData *getScheduleData(Value *V) {
679       ScheduleData *SD = ScheduleDataMap[V];
680       if (SD && SD->SchedulingRegionID == SchedulingRegionID)
681         return SD;
682       return nullptr;
683     }
684
685     bool isInSchedulingRegion(ScheduleData *SD) {
686       return SD->SchedulingRegionID == SchedulingRegionID;
687     }
688
689     /// Marks an instruction as scheduled and puts all dependent ready
690     /// instructions into the ready-list.
691     template <typename ReadyListType>
692     void schedule(ScheduleData *SD, ReadyListType &ReadyList) {
693       SD->IsScheduled = true;
694       DEBUG(dbgs() << "SLP:   schedule " << *SD << "\n");
695
696       ScheduleData *BundleMember = SD;
697       while (BundleMember) {
698         // Handle the def-use chain dependencies.
699         for (Use &U : BundleMember->Inst->operands()) {
700           ScheduleData *OpDef = getScheduleData(U.get());
701           if (OpDef && OpDef->hasValidDependencies() &&
702               OpDef->incrementUnscheduledDeps(-1) == 0) {
703             // There are no more unscheduled dependencies after decrementing,
704             // so we can put the dependent instruction into the ready list.
705             ScheduleData *DepBundle = OpDef->FirstInBundle;
706             assert(!DepBundle->IsScheduled &&
707                    "already scheduled bundle gets ready");
708             ReadyList.insert(DepBundle);
709             DEBUG(dbgs() << "SLP:    gets ready (def): " << *DepBundle << "\n");
710           }
711         }
712         // Handle the memory dependencies.
713         for (ScheduleData *MemoryDepSD : BundleMember->MemoryDependencies) {
714           if (MemoryDepSD->incrementUnscheduledDeps(-1) == 0) {
715             // There are no more unscheduled dependencies after decrementing,
716             // so we can put the dependent instruction into the ready list.
717             ScheduleData *DepBundle = MemoryDepSD->FirstInBundle;
718             assert(!DepBundle->IsScheduled &&
719                    "already scheduled bundle gets ready");
720             ReadyList.insert(DepBundle);
721             DEBUG(dbgs() << "SLP:    gets ready (mem): " << *DepBundle << "\n");
722           }
723         }
724         BundleMember = BundleMember->NextInBundle;
725       }
726     }
727
728     /// Put all instructions into the ReadyList which are ready for scheduling.
729     template <typename ReadyListType>
730     void initialFillReadyList(ReadyListType &ReadyList) {
731       for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) {
732         ScheduleData *SD = getScheduleData(I);
733         if (SD->isSchedulingEntity() && SD->isReady()) {
734           ReadyList.insert(SD);
735           DEBUG(dbgs() << "SLP:    initially in ready list: " << *I << "\n");
736         }
737       }
738     }
739
740     /// Checks if a bundle of instructions can be scheduled, i.e. has no
741     /// cyclic dependencies. This is only a dry-run, no instructions are
742     /// actually moved at this stage.
743     bool tryScheduleBundle(ArrayRef<Value *> VL, AliasAnalysis *AA);
744
745     /// Un-bundles a group of instructions.
746     void cancelScheduling(ArrayRef<Value *> VL);
747
748     /// Extends the scheduling region so that V is inside the region.
749     void extendSchedulingRegion(Value *V);
750
751     /// Initialize the ScheduleData structures for new instructions in the
752     /// scheduling region.
753     void initScheduleData(Instruction *FromI, Instruction *ToI,
754                           ScheduleData *PrevLoadStore,
755                           ScheduleData *NextLoadStore);
756
757     /// Updates the dependency information of a bundle and of all instructions/
758     /// bundles which depend on the original bundle.
759     void calculateDependencies(ScheduleData *SD, bool InsertInReadyList,
760                                AliasAnalysis *AA);
761
762     /// Sets all instruction in the scheduling region to un-scheduled.
763     void resetSchedule();
764
765     BasicBlock *BB;
766
767     /// Simple memory allocation for ScheduleData.
768     std::vector<std::unique_ptr<ScheduleData[]>> ScheduleDataChunks;
769
770     /// The size of a ScheduleData array in ScheduleDataChunks.
771     int ChunkSize;
772
773     /// The allocator position in the current chunk, which is the last entry
774     /// of ScheduleDataChunks.
775     int ChunkPos;
776
777     /// Attaches ScheduleData to Instruction.
778     /// Note that the mapping survives during all vectorization iterations, i.e.
779     /// ScheduleData structures are recycled.
780     DenseMap<Value *, ScheduleData *> ScheduleDataMap;
781
782     struct ReadyList : SmallVector<ScheduleData *, 8> {
783       void insert(ScheduleData *SD) { push_back(SD); }
784     };
785
786     /// The ready-list for scheduling (only used for the dry-run).
787     ReadyList ReadyInsts;
788
789     /// The first instruction of the scheduling region.
790     Instruction *ScheduleStart;
791
792     /// The first instruction _after_ the scheduling region.
793     Instruction *ScheduleEnd;
794
795     /// The first memory accessing instruction in the scheduling region
796     /// (can be null).
797     ScheduleData *FirstLoadStoreInRegion;
798
799     /// The last memory accessing instruction in the scheduling region
800     /// (can be null).
801     ScheduleData *LastLoadStoreInRegion;
802
803     /// The ID of the scheduling region. For a new vectorization iteration this
804     /// is incremented which "removes" all ScheduleData from the region.
805     int SchedulingRegionID;
806   };
807
808   /// Attaches the BlockScheduling structures to basic blocks.
809   DenseMap<BasicBlock *, std::unique_ptr<BlockScheduling>> BlocksSchedules;
810
811   /// Performs the "real" scheduling. Done before vectorization is actually
812   /// performed in a basic block.
813   void scheduleBlock(BlockScheduling *BS);
814
815   /// List of users to ignore during scheduling and that don't need extracting.
816   ArrayRef<Value *> UserIgnoreList;
817
818   // Number of load-bundles, which contain consecutive loads.
819   int NumLoadsWantToKeepOrder;
820
821   // Number of load-bundles of size 2, which are consecutive loads if reversed.
822   int NumLoadsWantToChangeOrder;
823
824   // Analysis and block reference.
825   Function *F;
826   ScalarEvolution *SE;
827   const DataLayout *DL;
828   TargetTransformInfo *TTI;
829   TargetLibraryInfo *TLI;
830   AliasAnalysis *AA;
831   LoopInfo *LI;
832   DominatorTree *DT;
833   /// Instruction builder to construct the vectorized tree.
834   IRBuilder<> Builder;
835 };
836
837 #ifndef NDEBUG
838 raw_ostream &operator<<(raw_ostream &os, const BoUpSLP::ScheduleData &SD) {
839   SD.dump(os);
840   return os;
841 }
842 #endif
843
844 void BoUpSLP::buildTree(ArrayRef<Value *> Roots,
845                         ArrayRef<Value *> UserIgnoreLst) {
846   deleteTree();
847   UserIgnoreList = UserIgnoreLst;
848   if (!getSameType(Roots))
849     return;
850   buildTree_rec(Roots, 0);
851
852   // Collect the values that we need to extract from the tree.
853   for (int EIdx = 0, EE = VectorizableTree.size(); EIdx < EE; ++EIdx) {
854     TreeEntry *Entry = &VectorizableTree[EIdx];
855
856     // For each lane:
857     for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) {
858       Value *Scalar = Entry->Scalars[Lane];
859
860       // No need to handle users of gathered values.
861       if (Entry->NeedToGather)
862         continue;
863
864       for (User *U : Scalar->users()) {
865         DEBUG(dbgs() << "SLP: Checking user:" << *U << ".\n");
866
867         // Skip in-tree scalars that become vectors.
868         if (ScalarToTreeEntry.count(U)) {
869           DEBUG(dbgs() << "SLP: \tInternal user will be removed:" <<
870                 *U << ".\n");
871           int Idx = ScalarToTreeEntry[U]; (void) Idx;
872           assert(!VectorizableTree[Idx].NeedToGather && "Bad state");
873           continue;
874         }
875         Instruction *UserInst = dyn_cast<Instruction>(U);
876         if (!UserInst)
877           continue;
878
879         // Ignore users in the user ignore list.
880         if (std::find(UserIgnoreList.begin(), UserIgnoreList.end(), UserInst) !=
881             UserIgnoreList.end())
882           continue;
883
884         DEBUG(dbgs() << "SLP: Need to extract:" << *U << " from lane " <<
885               Lane << " from " << *Scalar << ".\n");
886         ExternalUses.push_back(ExternalUser(Scalar, U, Lane));
887       }
888     }
889   }
890 }
891
892
893 void BoUpSLP::buildTree_rec(ArrayRef<Value *> VL, unsigned Depth) {
894   bool SameTy = getSameType(VL); (void)SameTy;
895   bool isAltShuffle = false;
896   assert(SameTy && "Invalid types!");
897
898   if (Depth == RecursionMaxDepth) {
899     DEBUG(dbgs() << "SLP: Gathering due to max recursion depth.\n");
900     newTreeEntry(VL, false);
901     return;
902   }
903
904   // Don't handle vectors.
905   if (VL[0]->getType()->isVectorTy()) {
906     DEBUG(dbgs() << "SLP: Gathering due to vector type.\n");
907     newTreeEntry(VL, false);
908     return;
909   }
910
911   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
912     if (SI->getValueOperand()->getType()->isVectorTy()) {
913       DEBUG(dbgs() << "SLP: Gathering due to store vector type.\n");
914       newTreeEntry(VL, false);
915       return;
916     }
917   unsigned Opcode = getSameOpcode(VL);
918
919   // Check that this shuffle vector refers to the alternate
920   // sequence of opcodes.
921   if (Opcode == Instruction::ShuffleVector) {
922     Instruction *I0 = dyn_cast<Instruction>(VL[0]);
923     unsigned Op = I0->getOpcode();
924     if (Op != Instruction::ShuffleVector)
925       isAltShuffle = true;
926   }
927
928   // If all of the operands are identical or constant we have a simple solution.
929   if (allConstant(VL) || isSplat(VL) || !getSameBlock(VL) || !Opcode) {
930     DEBUG(dbgs() << "SLP: Gathering due to C,S,B,O. \n");
931     newTreeEntry(VL, false);
932     return;
933   }
934
935   // We now know that this is a vector of instructions of the same type from
936   // the same block.
937
938   // Check if this is a duplicate of another entry.
939   if (ScalarToTreeEntry.count(VL[0])) {
940     int Idx = ScalarToTreeEntry[VL[0]];
941     TreeEntry *E = &VectorizableTree[Idx];
942     for (unsigned i = 0, e = VL.size(); i != e; ++i) {
943       DEBUG(dbgs() << "SLP: \tChecking bundle: " << *VL[i] << ".\n");
944       if (E->Scalars[i] != VL[i]) {
945         DEBUG(dbgs() << "SLP: Gathering due to partial overlap.\n");
946         newTreeEntry(VL, false);
947         return;
948       }
949     }
950     DEBUG(dbgs() << "SLP: Perfect diamond merge at " << *VL[0] << ".\n");
951     return;
952   }
953
954   // Check that none of the instructions in the bundle are already in the tree.
955   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
956     if (ScalarToTreeEntry.count(VL[i])) {
957       DEBUG(dbgs() << "SLP: The instruction (" << *VL[i] <<
958             ") is already in tree.\n");
959       newTreeEntry(VL, false);
960       return;
961     }
962   }
963
964   // If any of the scalars appears in the table OR it is marked as a value that
965   // needs to stat scalar then we need to gather the scalars.
966   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
967     if (ScalarToTreeEntry.count(VL[i]) || MustGather.count(VL[i])) {
968       DEBUG(dbgs() << "SLP: Gathering due to gathered scalar. \n");
969       newTreeEntry(VL, false);
970       return;
971     }
972   }
973
974   // Check that all of the users of the scalars that we want to vectorize are
975   // schedulable.
976   Instruction *VL0 = cast<Instruction>(VL[0]);
977   BasicBlock *BB = cast<Instruction>(VL0)->getParent();
978
979   if (!DT->isReachableFromEntry(BB)) {
980     // Don't go into unreachable blocks. They may contain instructions with
981     // dependency cycles which confuse the final scheduling.
982     DEBUG(dbgs() << "SLP: bundle in unreachable block.\n");
983     newTreeEntry(VL, false);
984     return;
985   }
986   
987   // Check that every instructions appears once in this bundle.
988   for (unsigned i = 0, e = VL.size(); i < e; ++i)
989     for (unsigned j = i+1; j < e; ++j)
990       if (VL[i] == VL[j]) {
991         DEBUG(dbgs() << "SLP: Scalar used twice in bundle.\n");
992         newTreeEntry(VL, false);
993         return;
994       }
995
996   auto &BSRef = BlocksSchedules[BB];
997   if (!BSRef) {
998     BSRef = llvm::make_unique<BlockScheduling>(BB);
999   }
1000   BlockScheduling &BS = *BSRef.get();
1001
1002   if (!BS.tryScheduleBundle(VL, AA)) {
1003     DEBUG(dbgs() << "SLP: We are not able to schedule this bundle!\n");
1004     BS.cancelScheduling(VL);
1005     newTreeEntry(VL, false);
1006     return;
1007   }
1008   DEBUG(dbgs() << "SLP: We are able to schedule this bundle.\n");
1009
1010   switch (Opcode) {
1011     case Instruction::PHI: {
1012       PHINode *PH = dyn_cast<PHINode>(VL0);
1013
1014       // Check for terminator values (e.g. invoke).
1015       for (unsigned j = 0; j < VL.size(); ++j)
1016         for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
1017           TerminatorInst *Term = dyn_cast<TerminatorInst>(
1018               cast<PHINode>(VL[j])->getIncomingValueForBlock(PH->getIncomingBlock(i)));
1019           if (Term) {
1020             DEBUG(dbgs() << "SLP: Need to swizzle PHINodes (TerminatorInst use).\n");
1021             BS.cancelScheduling(VL);
1022             newTreeEntry(VL, false);
1023             return;
1024           }
1025         }
1026
1027       newTreeEntry(VL, true);
1028       DEBUG(dbgs() << "SLP: added a vector of PHINodes.\n");
1029
1030       for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
1031         ValueList Operands;
1032         // Prepare the operand vector.
1033         for (unsigned j = 0; j < VL.size(); ++j)
1034           Operands.push_back(cast<PHINode>(VL[j])->getIncomingValueForBlock(
1035               PH->getIncomingBlock(i)));
1036
1037         buildTree_rec(Operands, Depth + 1);
1038       }
1039       return;
1040     }
1041     case Instruction::ExtractElement: {
1042       bool Reuse = CanReuseExtract(VL);
1043       if (Reuse) {
1044         DEBUG(dbgs() << "SLP: Reusing extract sequence.\n");
1045       } else {
1046         BS.cancelScheduling(VL);
1047       }
1048       newTreeEntry(VL, Reuse);
1049       return;
1050     }
1051     case Instruction::Load: {
1052       // Check if the loads are consecutive or of we need to swizzle them.
1053       for (unsigned i = 0, e = VL.size() - 1; i < e; ++i) {
1054         LoadInst *L = cast<LoadInst>(VL[i]);
1055         if (!L->isSimple()) {
1056           BS.cancelScheduling(VL);
1057           newTreeEntry(VL, false);
1058           DEBUG(dbgs() << "SLP: Gathering non-simple loads.\n");
1059           return;
1060         }
1061         if (!isConsecutiveAccess(VL[i], VL[i + 1])) {
1062           if (VL.size() == 2 && isConsecutiveAccess(VL[1], VL[0])) {
1063             ++NumLoadsWantToChangeOrder;
1064           }
1065           BS.cancelScheduling(VL);
1066           newTreeEntry(VL, false);
1067           DEBUG(dbgs() << "SLP: Gathering non-consecutive loads.\n");
1068           return;
1069         }
1070       }
1071       ++NumLoadsWantToKeepOrder;
1072       newTreeEntry(VL, true);
1073       DEBUG(dbgs() << "SLP: added a vector of loads.\n");
1074       return;
1075     }
1076     case Instruction::ZExt:
1077     case Instruction::SExt:
1078     case Instruction::FPToUI:
1079     case Instruction::FPToSI:
1080     case Instruction::FPExt:
1081     case Instruction::PtrToInt:
1082     case Instruction::IntToPtr:
1083     case Instruction::SIToFP:
1084     case Instruction::UIToFP:
1085     case Instruction::Trunc:
1086     case Instruction::FPTrunc:
1087     case Instruction::BitCast: {
1088       Type *SrcTy = VL0->getOperand(0)->getType();
1089       for (unsigned i = 0; i < VL.size(); ++i) {
1090         Type *Ty = cast<Instruction>(VL[i])->getOperand(0)->getType();
1091         if (Ty != SrcTy || Ty->isAggregateType() || Ty->isVectorTy()) {
1092           BS.cancelScheduling(VL);
1093           newTreeEntry(VL, false);
1094           DEBUG(dbgs() << "SLP: Gathering casts with different src types.\n");
1095           return;
1096         }
1097       }
1098       newTreeEntry(VL, true);
1099       DEBUG(dbgs() << "SLP: added a vector of casts.\n");
1100
1101       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
1102         ValueList Operands;
1103         // Prepare the operand vector.
1104         for (unsigned j = 0; j < VL.size(); ++j)
1105           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
1106
1107         buildTree_rec(Operands, Depth+1);
1108       }
1109       return;
1110     }
1111     case Instruction::ICmp:
1112     case Instruction::FCmp: {
1113       // Check that all of the compares have the same predicate.
1114       CmpInst::Predicate P0 = dyn_cast<CmpInst>(VL0)->getPredicate();
1115       Type *ComparedTy = cast<Instruction>(VL[0])->getOperand(0)->getType();
1116       for (unsigned i = 1, e = VL.size(); i < e; ++i) {
1117         CmpInst *Cmp = cast<CmpInst>(VL[i]);
1118         if (Cmp->getPredicate() != P0 ||
1119             Cmp->getOperand(0)->getType() != ComparedTy) {
1120           BS.cancelScheduling(VL);
1121           newTreeEntry(VL, false);
1122           DEBUG(dbgs() << "SLP: Gathering cmp with different predicate.\n");
1123           return;
1124         }
1125       }
1126
1127       newTreeEntry(VL, true);
1128       DEBUG(dbgs() << "SLP: added a vector of compares.\n");
1129
1130       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
1131         ValueList Operands;
1132         // Prepare the operand vector.
1133         for (unsigned j = 0; j < VL.size(); ++j)
1134           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
1135
1136         buildTree_rec(Operands, Depth+1);
1137       }
1138       return;
1139     }
1140     case Instruction::Select:
1141     case Instruction::Add:
1142     case Instruction::FAdd:
1143     case Instruction::Sub:
1144     case Instruction::FSub:
1145     case Instruction::Mul:
1146     case Instruction::FMul:
1147     case Instruction::UDiv:
1148     case Instruction::SDiv:
1149     case Instruction::FDiv:
1150     case Instruction::URem:
1151     case Instruction::SRem:
1152     case Instruction::FRem:
1153     case Instruction::Shl:
1154     case Instruction::LShr:
1155     case Instruction::AShr:
1156     case Instruction::And:
1157     case Instruction::Or:
1158     case Instruction::Xor: {
1159       newTreeEntry(VL, true);
1160       DEBUG(dbgs() << "SLP: added a vector of bin op.\n");
1161
1162       // Sort operands of the instructions so that each side is more likely to
1163       // have the same opcode.
1164       if (isa<BinaryOperator>(VL0) && VL0->isCommutative()) {
1165         ValueList Left, Right;
1166         reorderInputsAccordingToOpcode(VL, Left, Right);
1167         buildTree_rec(Left, Depth + 1);
1168         buildTree_rec(Right, Depth + 1);
1169         return;
1170       }
1171
1172       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
1173         ValueList Operands;
1174         // Prepare the operand vector.
1175         for (unsigned j = 0; j < VL.size(); ++j)
1176           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
1177
1178         buildTree_rec(Operands, Depth+1);
1179       }
1180       return;
1181     }
1182     case Instruction::Store: {
1183       // Check if the stores are consecutive or of we need to swizzle them.
1184       for (unsigned i = 0, e = VL.size() - 1; i < e; ++i)
1185         if (!isConsecutiveAccess(VL[i], VL[i + 1])) {
1186           BS.cancelScheduling(VL);
1187           newTreeEntry(VL, false);
1188           DEBUG(dbgs() << "SLP: Non-consecutive store.\n");
1189           return;
1190         }
1191
1192       newTreeEntry(VL, true);
1193       DEBUG(dbgs() << "SLP: added a vector of stores.\n");
1194
1195       ValueList Operands;
1196       for (unsigned j = 0; j < VL.size(); ++j)
1197         Operands.push_back(cast<Instruction>(VL[j])->getOperand(0));
1198
1199       buildTree_rec(Operands, Depth + 1);
1200       return;
1201     }
1202     case Instruction::Call: {
1203       // Check if the calls are all to the same vectorizable intrinsic.
1204       CallInst *CI = cast<CallInst>(VL[0]);
1205       // Check if this is an Intrinsic call or something that can be
1206       // represented by an intrinsic call
1207       Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
1208       if (!isTriviallyVectorizable(ID)) {
1209         BS.cancelScheduling(VL);
1210         newTreeEntry(VL, false);
1211         DEBUG(dbgs() << "SLP: Non-vectorizable call.\n");
1212         return;
1213       }
1214       Function *Int = CI->getCalledFunction();
1215       Value *A1I = nullptr;
1216       if (hasVectorInstrinsicScalarOpd(ID, 1))
1217         A1I = CI->getArgOperand(1);
1218       for (unsigned i = 1, e = VL.size(); i != e; ++i) {
1219         CallInst *CI2 = dyn_cast<CallInst>(VL[i]);
1220         if (!CI2 || CI2->getCalledFunction() != Int ||
1221             getIntrinsicIDForCall(CI2, TLI) != ID) {
1222           BS.cancelScheduling(VL);
1223           newTreeEntry(VL, false);
1224           DEBUG(dbgs() << "SLP: mismatched calls:" << *CI << "!=" << *VL[i]
1225                        << "\n");
1226           return;
1227         }
1228         // ctlz,cttz and powi are special intrinsics whose second argument
1229         // should be same in order for them to be vectorized.
1230         if (hasVectorInstrinsicScalarOpd(ID, 1)) {
1231           Value *A1J = CI2->getArgOperand(1);
1232           if (A1I != A1J) {
1233             BS.cancelScheduling(VL);
1234             newTreeEntry(VL, false);
1235             DEBUG(dbgs() << "SLP: mismatched arguments in call:" << *CI
1236                          << " argument "<< A1I<<"!=" << A1J
1237                          << "\n");
1238             return;
1239           }
1240         }
1241       }
1242
1243       newTreeEntry(VL, true);
1244       for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i) {
1245         ValueList Operands;
1246         // Prepare the operand vector.
1247         for (unsigned j = 0; j < VL.size(); ++j) {
1248           CallInst *CI2 = dyn_cast<CallInst>(VL[j]);
1249           Operands.push_back(CI2->getArgOperand(i));
1250         }
1251         buildTree_rec(Operands, Depth + 1);
1252       }
1253       return;
1254     }
1255     case Instruction::ShuffleVector: {
1256       // If this is not an alternate sequence of opcode like add-sub
1257       // then do not vectorize this instruction.
1258       if (!isAltShuffle) {
1259         BS.cancelScheduling(VL);
1260         newTreeEntry(VL, false);
1261         DEBUG(dbgs() << "SLP: ShuffleVector are not vectorized.\n");
1262         return;
1263       }
1264       newTreeEntry(VL, true);
1265       DEBUG(dbgs() << "SLP: added a ShuffleVector op.\n");
1266       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
1267         ValueList Operands;
1268         // Prepare the operand vector.
1269         for (unsigned j = 0; j < VL.size(); ++j)
1270           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
1271
1272         buildTree_rec(Operands, Depth + 1);
1273       }
1274       return;
1275     }
1276     default:
1277       BS.cancelScheduling(VL);
1278       newTreeEntry(VL, false);
1279       DEBUG(dbgs() << "SLP: Gathering unknown instruction.\n");
1280       return;
1281   }
1282 }
1283
1284 int BoUpSLP::getEntryCost(TreeEntry *E) {
1285   ArrayRef<Value*> VL = E->Scalars;
1286
1287   Type *ScalarTy = VL[0]->getType();
1288   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
1289     ScalarTy = SI->getValueOperand()->getType();
1290   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
1291
1292   if (E->NeedToGather) {
1293     if (allConstant(VL))
1294       return 0;
1295     if (isSplat(VL)) {
1296       return TTI->getShuffleCost(TargetTransformInfo::SK_Broadcast, VecTy, 0);
1297     }
1298     return getGatherCost(E->Scalars);
1299   }
1300   unsigned Opcode = getSameOpcode(VL);
1301   assert(Opcode && getSameType(VL) && getSameBlock(VL) && "Invalid VL");
1302   Instruction *VL0 = cast<Instruction>(VL[0]);
1303   switch (Opcode) {
1304     case Instruction::PHI: {
1305       return 0;
1306     }
1307     case Instruction::ExtractElement: {
1308       if (CanReuseExtract(VL)) {
1309         int DeadCost = 0;
1310         for (unsigned i = 0, e = VL.size(); i < e; ++i) {
1311           ExtractElementInst *E = cast<ExtractElementInst>(VL[i]);
1312           if (E->hasOneUse())
1313             // Take credit for instruction that will become dead.
1314             DeadCost +=
1315                 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, i);
1316         }
1317         return -DeadCost;
1318       }
1319       return getGatherCost(VecTy);
1320     }
1321     case Instruction::ZExt:
1322     case Instruction::SExt:
1323     case Instruction::FPToUI:
1324     case Instruction::FPToSI:
1325     case Instruction::FPExt:
1326     case Instruction::PtrToInt:
1327     case Instruction::IntToPtr:
1328     case Instruction::SIToFP:
1329     case Instruction::UIToFP:
1330     case Instruction::Trunc:
1331     case Instruction::FPTrunc:
1332     case Instruction::BitCast: {
1333       Type *SrcTy = VL0->getOperand(0)->getType();
1334
1335       // Calculate the cost of this instruction.
1336       int ScalarCost = VL.size() * TTI->getCastInstrCost(VL0->getOpcode(),
1337                                                          VL0->getType(), SrcTy);
1338
1339       VectorType *SrcVecTy = VectorType::get(SrcTy, VL.size());
1340       int VecCost = TTI->getCastInstrCost(VL0->getOpcode(), VecTy, SrcVecTy);
1341       return VecCost - ScalarCost;
1342     }
1343     case Instruction::FCmp:
1344     case Instruction::ICmp:
1345     case Instruction::Select:
1346     case Instruction::Add:
1347     case Instruction::FAdd:
1348     case Instruction::Sub:
1349     case Instruction::FSub:
1350     case Instruction::Mul:
1351     case Instruction::FMul:
1352     case Instruction::UDiv:
1353     case Instruction::SDiv:
1354     case Instruction::FDiv:
1355     case Instruction::URem:
1356     case Instruction::SRem:
1357     case Instruction::FRem:
1358     case Instruction::Shl:
1359     case Instruction::LShr:
1360     case Instruction::AShr:
1361     case Instruction::And:
1362     case Instruction::Or:
1363     case Instruction::Xor: {
1364       // Calculate the cost of this instruction.
1365       int ScalarCost = 0;
1366       int VecCost = 0;
1367       if (Opcode == Instruction::FCmp || Opcode == Instruction::ICmp ||
1368           Opcode == Instruction::Select) {
1369         VectorType *MaskTy = VectorType::get(Builder.getInt1Ty(), VL.size());
1370         ScalarCost = VecTy->getNumElements() *
1371         TTI->getCmpSelInstrCost(Opcode, ScalarTy, Builder.getInt1Ty());
1372         VecCost = TTI->getCmpSelInstrCost(Opcode, VecTy, MaskTy);
1373       } else {
1374         // Certain instructions can be cheaper to vectorize if they have a
1375         // constant second vector operand.
1376         TargetTransformInfo::OperandValueKind Op1VK =
1377             TargetTransformInfo::OK_AnyValue;
1378         TargetTransformInfo::OperandValueKind Op2VK =
1379             TargetTransformInfo::OK_UniformConstantValue;
1380         TargetTransformInfo::OperandValueProperties Op1VP =
1381             TargetTransformInfo::OP_None;
1382         TargetTransformInfo::OperandValueProperties Op2VP =
1383             TargetTransformInfo::OP_None;
1384
1385         // If all operands are exactly the same ConstantInt then set the
1386         // operand kind to OK_UniformConstantValue.
1387         // If instead not all operands are constants, then set the operand kind
1388         // to OK_AnyValue. If all operands are constants but not the same,
1389         // then set the operand kind to OK_NonUniformConstantValue.
1390         ConstantInt *CInt = nullptr;
1391         for (unsigned i = 0; i < VL.size(); ++i) {
1392           const Instruction *I = cast<Instruction>(VL[i]);
1393           if (!isa<ConstantInt>(I->getOperand(1))) {
1394             Op2VK = TargetTransformInfo::OK_AnyValue;
1395             break;
1396           }
1397           if (i == 0) {
1398             CInt = cast<ConstantInt>(I->getOperand(1));
1399             continue;
1400           }
1401           if (Op2VK == TargetTransformInfo::OK_UniformConstantValue &&
1402               CInt != cast<ConstantInt>(I->getOperand(1)))
1403             Op2VK = TargetTransformInfo::OK_NonUniformConstantValue;
1404         }
1405         // FIXME: Currently cost of model modification for division by
1406         // power of 2 is handled only for X86. Add support for other targets.
1407         if (Op2VK == TargetTransformInfo::OK_UniformConstantValue && CInt &&
1408             CInt->getValue().isPowerOf2())
1409           Op2VP = TargetTransformInfo::OP_PowerOf2;
1410
1411         ScalarCost = VecTy->getNumElements() *
1412                      TTI->getArithmeticInstrCost(Opcode, ScalarTy, Op1VK, Op2VK,
1413                                                  Op1VP, Op2VP);
1414         VecCost = TTI->getArithmeticInstrCost(Opcode, VecTy, Op1VK, Op2VK,
1415                                               Op1VP, Op2VP);
1416       }
1417       return VecCost - ScalarCost;
1418     }
1419     case Instruction::Load: {
1420       // Cost of wide load - cost of scalar loads.
1421       int ScalarLdCost = VecTy->getNumElements() *
1422       TTI->getMemoryOpCost(Instruction::Load, ScalarTy, 1, 0);
1423       int VecLdCost = TTI->getMemoryOpCost(Instruction::Load, VecTy, 1, 0);
1424       return VecLdCost - ScalarLdCost;
1425     }
1426     case Instruction::Store: {
1427       // We know that we can merge the stores. Calculate the cost.
1428       int ScalarStCost = VecTy->getNumElements() *
1429       TTI->getMemoryOpCost(Instruction::Store, ScalarTy, 1, 0);
1430       int VecStCost = TTI->getMemoryOpCost(Instruction::Store, VecTy, 1, 0);
1431       return VecStCost - ScalarStCost;
1432     }
1433     case Instruction::Call: {
1434       CallInst *CI = cast<CallInst>(VL0);
1435       Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
1436
1437       // Calculate the cost of the scalar and vector calls.
1438       SmallVector<Type*, 4> ScalarTys, VecTys;
1439       for (unsigned op = 0, opc = CI->getNumArgOperands(); op!= opc; ++op) {
1440         ScalarTys.push_back(CI->getArgOperand(op)->getType());
1441         VecTys.push_back(VectorType::get(CI->getArgOperand(op)->getType(),
1442                                          VecTy->getNumElements()));
1443       }
1444
1445       int ScalarCallCost = VecTy->getNumElements() *
1446           TTI->getIntrinsicInstrCost(ID, ScalarTy, ScalarTys);
1447
1448       int VecCallCost = TTI->getIntrinsicInstrCost(ID, VecTy, VecTys);
1449
1450       DEBUG(dbgs() << "SLP: Call cost "<< VecCallCost - ScalarCallCost
1451             << " (" << VecCallCost  << "-" <<  ScalarCallCost << ")"
1452             << " for " << *CI << "\n");
1453
1454       return VecCallCost - ScalarCallCost;
1455     }
1456     case Instruction::ShuffleVector: {
1457       TargetTransformInfo::OperandValueKind Op1VK =
1458           TargetTransformInfo::OK_AnyValue;
1459       TargetTransformInfo::OperandValueKind Op2VK =
1460           TargetTransformInfo::OK_AnyValue;
1461       int ScalarCost = 0;
1462       int VecCost = 0;
1463       for (unsigned i = 0; i < VL.size(); ++i) {
1464         Instruction *I = cast<Instruction>(VL[i]);
1465         if (!I)
1466           break;
1467         ScalarCost +=
1468             TTI->getArithmeticInstrCost(I->getOpcode(), ScalarTy, Op1VK, Op2VK);
1469       }
1470       // VecCost is equal to sum of the cost of creating 2 vectors
1471       // and the cost of creating shuffle.
1472       Instruction *I0 = cast<Instruction>(VL[0]);
1473       VecCost =
1474           TTI->getArithmeticInstrCost(I0->getOpcode(), VecTy, Op1VK, Op2VK);
1475       Instruction *I1 = cast<Instruction>(VL[1]);
1476       VecCost +=
1477           TTI->getArithmeticInstrCost(I1->getOpcode(), VecTy, Op1VK, Op2VK);
1478       VecCost +=
1479           TTI->getShuffleCost(TargetTransformInfo::SK_Alternate, VecTy, 0);
1480       return VecCost - ScalarCost;
1481     }
1482     default:
1483       llvm_unreachable("Unknown instruction");
1484   }
1485 }
1486
1487 bool BoUpSLP::isFullyVectorizableTinyTree() {
1488   DEBUG(dbgs() << "SLP: Check whether the tree with height " <<
1489         VectorizableTree.size() << " is fully vectorizable .\n");
1490
1491   // We only handle trees of height 2.
1492   if (VectorizableTree.size() != 2)
1493     return false;
1494
1495   // Handle splat stores.
1496   if (!VectorizableTree[0].NeedToGather && isSplat(VectorizableTree[1].Scalars))
1497     return true;
1498
1499   // Gathering cost would be too much for tiny trees.
1500   if (VectorizableTree[0].NeedToGather || VectorizableTree[1].NeedToGather)
1501     return false;
1502
1503   return true;
1504 }
1505
1506 int BoUpSLP::getSpillCost() {
1507   // Walk from the bottom of the tree to the top, tracking which values are
1508   // live. When we see a call instruction that is not part of our tree,
1509   // query TTI to see if there is a cost to keeping values live over it
1510   // (for example, if spills and fills are required).
1511   unsigned BundleWidth = VectorizableTree.front().Scalars.size();
1512   int Cost = 0;
1513
1514   SmallPtrSet<Instruction*, 4> LiveValues;
1515   Instruction *PrevInst = nullptr; 
1516
1517   for (unsigned N = 0; N < VectorizableTree.size(); ++N) {
1518     Instruction *Inst = dyn_cast<Instruction>(VectorizableTree[N].Scalars[0]);
1519     if (!Inst)
1520       continue;
1521
1522     if (!PrevInst) {
1523       PrevInst = Inst;
1524       continue;
1525     }
1526
1527     DEBUG(
1528       dbgs() << "SLP: #LV: " << LiveValues.size();
1529       for (auto *X : LiveValues)
1530         dbgs() << " " << X->getName();
1531       dbgs() << ", Looking at ";
1532       Inst->dump();
1533       );
1534
1535     // Update LiveValues.
1536     LiveValues.erase(PrevInst);
1537     for (auto &J : PrevInst->operands()) {
1538       if (isa<Instruction>(&*J) && ScalarToTreeEntry.count(&*J))
1539         LiveValues.insert(cast<Instruction>(&*J));
1540     }    
1541
1542     // Now find the sequence of instructions between PrevInst and Inst.
1543     BasicBlock::reverse_iterator InstIt(Inst), PrevInstIt(PrevInst);
1544     --PrevInstIt;
1545     while (InstIt != PrevInstIt) {
1546       if (PrevInstIt == PrevInst->getParent()->rend()) {
1547         PrevInstIt = Inst->getParent()->rbegin();
1548         continue;
1549       }
1550
1551       if (isa<CallInst>(&*PrevInstIt) && &*PrevInstIt != PrevInst) {
1552         SmallVector<Type*, 4> V;
1553         for (auto *II : LiveValues)
1554           V.push_back(VectorType::get(II->getType(), BundleWidth));
1555         Cost += TTI->getCostOfKeepingLiveOverCall(V);
1556       }
1557
1558       ++PrevInstIt;
1559     }
1560
1561     PrevInst = Inst;
1562   }
1563
1564   DEBUG(dbgs() << "SLP: SpillCost=" << Cost << "\n");
1565   return Cost;
1566 }
1567
1568 int BoUpSLP::getTreeCost() {
1569   int Cost = 0;
1570   DEBUG(dbgs() << "SLP: Calculating cost for tree of size " <<
1571         VectorizableTree.size() << ".\n");
1572
1573   // We only vectorize tiny trees if it is fully vectorizable.
1574   if (VectorizableTree.size() < 3 && !isFullyVectorizableTinyTree()) {
1575     if (!VectorizableTree.size()) {
1576       assert(!ExternalUses.size() && "We should not have any external users");
1577     }
1578     return INT_MAX;
1579   }
1580
1581   unsigned BundleWidth = VectorizableTree[0].Scalars.size();
1582
1583   for (unsigned i = 0, e = VectorizableTree.size(); i != e; ++i) {
1584     int C = getEntryCost(&VectorizableTree[i]);
1585     DEBUG(dbgs() << "SLP: Adding cost " << C << " for bundle that starts with "
1586           << *VectorizableTree[i].Scalars[0] << " .\n");
1587     Cost += C;
1588   }
1589
1590   SmallSet<Value *, 16> ExtractCostCalculated;
1591   int ExtractCost = 0;
1592   for (UserList::iterator I = ExternalUses.begin(), E = ExternalUses.end();
1593        I != E; ++I) {
1594     // We only add extract cost once for the same scalar.
1595     if (!ExtractCostCalculated.insert(I->Scalar))
1596       continue;
1597
1598     VectorType *VecTy = VectorType::get(I->Scalar->getType(), BundleWidth);
1599     ExtractCost += TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy,
1600                                            I->Lane);
1601   }
1602
1603   Cost += getSpillCost();
1604
1605   DEBUG(dbgs() << "SLP: Total Cost " << Cost + ExtractCost<< ".\n");
1606   return  Cost + ExtractCost;
1607 }
1608
1609 int BoUpSLP::getGatherCost(Type *Ty) {
1610   int Cost = 0;
1611   for (unsigned i = 0, e = cast<VectorType>(Ty)->getNumElements(); i < e; ++i)
1612     Cost += TTI->getVectorInstrCost(Instruction::InsertElement, Ty, i);
1613   return Cost;
1614 }
1615
1616 int BoUpSLP::getGatherCost(ArrayRef<Value *> VL) {
1617   // Find the type of the operands in VL.
1618   Type *ScalarTy = VL[0]->getType();
1619   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
1620     ScalarTy = SI->getValueOperand()->getType();
1621   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
1622   // Find the cost of inserting/extracting values from the vector.
1623   return getGatherCost(VecTy);
1624 }
1625
1626 Value *BoUpSLP::getPointerOperand(Value *I) {
1627   if (LoadInst *LI = dyn_cast<LoadInst>(I))
1628     return LI->getPointerOperand();
1629   if (StoreInst *SI = dyn_cast<StoreInst>(I))
1630     return SI->getPointerOperand();
1631   return nullptr;
1632 }
1633
1634 unsigned BoUpSLP::getAddressSpaceOperand(Value *I) {
1635   if (LoadInst *L = dyn_cast<LoadInst>(I))
1636     return L->getPointerAddressSpace();
1637   if (StoreInst *S = dyn_cast<StoreInst>(I))
1638     return S->getPointerAddressSpace();
1639   return -1;
1640 }
1641
1642 bool BoUpSLP::isConsecutiveAccess(Value *A, Value *B) {
1643   Value *PtrA = getPointerOperand(A);
1644   Value *PtrB = getPointerOperand(B);
1645   unsigned ASA = getAddressSpaceOperand(A);
1646   unsigned ASB = getAddressSpaceOperand(B);
1647
1648   // Check that the address spaces match and that the pointers are valid.
1649   if (!PtrA || !PtrB || (ASA != ASB))
1650     return false;
1651
1652   // Make sure that A and B are different pointers of the same type.
1653   if (PtrA == PtrB || PtrA->getType() != PtrB->getType())
1654     return false;
1655
1656   unsigned PtrBitWidth = DL->getPointerSizeInBits(ASA);
1657   Type *Ty = cast<PointerType>(PtrA->getType())->getElementType();
1658   APInt Size(PtrBitWidth, DL->getTypeStoreSize(Ty));
1659
1660   APInt OffsetA(PtrBitWidth, 0), OffsetB(PtrBitWidth, 0);
1661   PtrA = PtrA->stripAndAccumulateInBoundsConstantOffsets(*DL, OffsetA);
1662   PtrB = PtrB->stripAndAccumulateInBoundsConstantOffsets(*DL, OffsetB);
1663
1664   APInt OffsetDelta = OffsetB - OffsetA;
1665
1666   // Check if they are based on the same pointer. That makes the offsets
1667   // sufficient.
1668   if (PtrA == PtrB)
1669     return OffsetDelta == Size;
1670
1671   // Compute the necessary base pointer delta to have the necessary final delta
1672   // equal to the size.
1673   APInt BaseDelta = Size - OffsetDelta;
1674
1675   // Otherwise compute the distance with SCEV between the base pointers.
1676   const SCEV *PtrSCEVA = SE->getSCEV(PtrA);
1677   const SCEV *PtrSCEVB = SE->getSCEV(PtrB);
1678   const SCEV *C = SE->getConstant(BaseDelta);
1679   const SCEV *X = SE->getAddExpr(PtrSCEVA, C);
1680   return X == PtrSCEVB;
1681 }
1682
1683 void BoUpSLP::setInsertPointAfterBundle(ArrayRef<Value *> VL) {
1684   Instruction *VL0 = cast<Instruction>(VL[0]);
1685   BasicBlock::iterator NextInst = VL0;
1686   ++NextInst;
1687   Builder.SetInsertPoint(VL0->getParent(), NextInst);
1688   Builder.SetCurrentDebugLocation(VL0->getDebugLoc());
1689 }
1690
1691 Value *BoUpSLP::Gather(ArrayRef<Value *> VL, VectorType *Ty) {
1692   Value *Vec = UndefValue::get(Ty);
1693   // Generate the 'InsertElement' instruction.
1694   for (unsigned i = 0; i < Ty->getNumElements(); ++i) {
1695     Vec = Builder.CreateInsertElement(Vec, VL[i], Builder.getInt32(i));
1696     if (Instruction *Insrt = dyn_cast<Instruction>(Vec)) {
1697       GatherSeq.insert(Insrt);
1698       CSEBlocks.insert(Insrt->getParent());
1699
1700       // Add to our 'need-to-extract' list.
1701       if (ScalarToTreeEntry.count(VL[i])) {
1702         int Idx = ScalarToTreeEntry[VL[i]];
1703         TreeEntry *E = &VectorizableTree[Idx];
1704         // Find which lane we need to extract.
1705         int FoundLane = -1;
1706         for (unsigned Lane = 0, LE = VL.size(); Lane != LE; ++Lane) {
1707           // Is this the lane of the scalar that we are looking for ?
1708           if (E->Scalars[Lane] == VL[i]) {
1709             FoundLane = Lane;
1710             break;
1711           }
1712         }
1713         assert(FoundLane >= 0 && "Could not find the correct lane");
1714         ExternalUses.push_back(ExternalUser(VL[i], Insrt, FoundLane));
1715       }
1716     }
1717   }
1718
1719   return Vec;
1720 }
1721
1722 Value *BoUpSLP::alreadyVectorized(ArrayRef<Value *> VL) const {
1723   SmallDenseMap<Value*, int>::const_iterator Entry
1724     = ScalarToTreeEntry.find(VL[0]);
1725   if (Entry != ScalarToTreeEntry.end()) {
1726     int Idx = Entry->second;
1727     const TreeEntry *En = &VectorizableTree[Idx];
1728     if (En->isSame(VL) && En->VectorizedValue)
1729       return En->VectorizedValue;
1730   }
1731   return nullptr;
1732 }
1733
1734 Value *BoUpSLP::vectorizeTree(ArrayRef<Value *> VL) {
1735   if (ScalarToTreeEntry.count(VL[0])) {
1736     int Idx = ScalarToTreeEntry[VL[0]];
1737     TreeEntry *E = &VectorizableTree[Idx];
1738     if (E->isSame(VL))
1739       return vectorizeTree(E);
1740   }
1741
1742   Type *ScalarTy = VL[0]->getType();
1743   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
1744     ScalarTy = SI->getValueOperand()->getType();
1745   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
1746
1747   return Gather(VL, VecTy);
1748 }
1749
1750 Value *BoUpSLP::vectorizeTree(TreeEntry *E) {
1751   IRBuilder<>::InsertPointGuard Guard(Builder);
1752
1753   if (E->VectorizedValue) {
1754     DEBUG(dbgs() << "SLP: Diamond merged for " << *E->Scalars[0] << ".\n");
1755     return E->VectorizedValue;
1756   }
1757
1758   Instruction *VL0 = cast<Instruction>(E->Scalars[0]);
1759   Type *ScalarTy = VL0->getType();
1760   if (StoreInst *SI = dyn_cast<StoreInst>(VL0))
1761     ScalarTy = SI->getValueOperand()->getType();
1762   VectorType *VecTy = VectorType::get(ScalarTy, E->Scalars.size());
1763
1764   if (E->NeedToGather) {
1765     setInsertPointAfterBundle(E->Scalars);
1766     return Gather(E->Scalars, VecTy);
1767   }
1768
1769   unsigned Opcode = getSameOpcode(E->Scalars);
1770
1771   switch (Opcode) {
1772     case Instruction::PHI: {
1773       PHINode *PH = dyn_cast<PHINode>(VL0);
1774       Builder.SetInsertPoint(PH->getParent()->getFirstNonPHI());
1775       Builder.SetCurrentDebugLocation(PH->getDebugLoc());
1776       PHINode *NewPhi = Builder.CreatePHI(VecTy, PH->getNumIncomingValues());
1777       E->VectorizedValue = NewPhi;
1778
1779       // PHINodes may have multiple entries from the same block. We want to
1780       // visit every block once.
1781       SmallSet<BasicBlock*, 4> VisitedBBs;
1782
1783       for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
1784         ValueList Operands;
1785         BasicBlock *IBB = PH->getIncomingBlock(i);
1786
1787         if (!VisitedBBs.insert(IBB)) {
1788           NewPhi->addIncoming(NewPhi->getIncomingValueForBlock(IBB), IBB);
1789           continue;
1790         }
1791
1792         // Prepare the operand vector.
1793         for (unsigned j = 0; j < E->Scalars.size(); ++j)
1794           Operands.push_back(cast<PHINode>(E->Scalars[j])->
1795                              getIncomingValueForBlock(IBB));
1796
1797         Builder.SetInsertPoint(IBB->getTerminator());
1798         Builder.SetCurrentDebugLocation(PH->getDebugLoc());
1799         Value *Vec = vectorizeTree(Operands);
1800         NewPhi->addIncoming(Vec, IBB);
1801       }
1802
1803       assert(NewPhi->getNumIncomingValues() == PH->getNumIncomingValues() &&
1804              "Invalid number of incoming values");
1805       return NewPhi;
1806     }
1807
1808     case Instruction::ExtractElement: {
1809       if (CanReuseExtract(E->Scalars)) {
1810         Value *V = VL0->getOperand(0);
1811         E->VectorizedValue = V;
1812         return V;
1813       }
1814       return Gather(E->Scalars, VecTy);
1815     }
1816     case Instruction::ZExt:
1817     case Instruction::SExt:
1818     case Instruction::FPToUI:
1819     case Instruction::FPToSI:
1820     case Instruction::FPExt:
1821     case Instruction::PtrToInt:
1822     case Instruction::IntToPtr:
1823     case Instruction::SIToFP:
1824     case Instruction::UIToFP:
1825     case Instruction::Trunc:
1826     case Instruction::FPTrunc:
1827     case Instruction::BitCast: {
1828       ValueList INVL;
1829       for (int i = 0, e = E->Scalars.size(); i < e; ++i)
1830         INVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1831
1832       setInsertPointAfterBundle(E->Scalars);
1833
1834       Value *InVec = vectorizeTree(INVL);
1835
1836       if (Value *V = alreadyVectorized(E->Scalars))
1837         return V;
1838
1839       CastInst *CI = dyn_cast<CastInst>(VL0);
1840       Value *V = Builder.CreateCast(CI->getOpcode(), InVec, VecTy);
1841       E->VectorizedValue = V;
1842       ++NumVectorInstructions;
1843       return V;
1844     }
1845     case Instruction::FCmp:
1846     case Instruction::ICmp: {
1847       ValueList LHSV, RHSV;
1848       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1849         LHSV.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1850         RHSV.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1851       }
1852
1853       setInsertPointAfterBundle(E->Scalars);
1854
1855       Value *L = vectorizeTree(LHSV);
1856       Value *R = vectorizeTree(RHSV);
1857
1858       if (Value *V = alreadyVectorized(E->Scalars))
1859         return V;
1860
1861       CmpInst::Predicate P0 = dyn_cast<CmpInst>(VL0)->getPredicate();
1862       Value *V;
1863       if (Opcode == Instruction::FCmp)
1864         V = Builder.CreateFCmp(P0, L, R);
1865       else
1866         V = Builder.CreateICmp(P0, L, R);
1867
1868       E->VectorizedValue = V;
1869       ++NumVectorInstructions;
1870       return V;
1871     }
1872     case Instruction::Select: {
1873       ValueList TrueVec, FalseVec, CondVec;
1874       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1875         CondVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1876         TrueVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1877         FalseVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(2));
1878       }
1879
1880       setInsertPointAfterBundle(E->Scalars);
1881
1882       Value *Cond = vectorizeTree(CondVec);
1883       Value *True = vectorizeTree(TrueVec);
1884       Value *False = vectorizeTree(FalseVec);
1885
1886       if (Value *V = alreadyVectorized(E->Scalars))
1887         return V;
1888
1889       Value *V = Builder.CreateSelect(Cond, True, False);
1890       E->VectorizedValue = V;
1891       ++NumVectorInstructions;
1892       return V;
1893     }
1894     case Instruction::Add:
1895     case Instruction::FAdd:
1896     case Instruction::Sub:
1897     case Instruction::FSub:
1898     case Instruction::Mul:
1899     case Instruction::FMul:
1900     case Instruction::UDiv:
1901     case Instruction::SDiv:
1902     case Instruction::FDiv:
1903     case Instruction::URem:
1904     case Instruction::SRem:
1905     case Instruction::FRem:
1906     case Instruction::Shl:
1907     case Instruction::LShr:
1908     case Instruction::AShr:
1909     case Instruction::And:
1910     case Instruction::Or:
1911     case Instruction::Xor: {
1912       ValueList LHSVL, RHSVL;
1913       if (isa<BinaryOperator>(VL0) && VL0->isCommutative())
1914         reorderInputsAccordingToOpcode(E->Scalars, LHSVL, RHSVL);
1915       else
1916         for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1917           LHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1918           RHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1919         }
1920
1921       setInsertPointAfterBundle(E->Scalars);
1922
1923       Value *LHS = vectorizeTree(LHSVL);
1924       Value *RHS = vectorizeTree(RHSVL);
1925
1926       if (LHS == RHS && isa<Instruction>(LHS)) {
1927         assert((VL0->getOperand(0) == VL0->getOperand(1)) && "Invalid order");
1928       }
1929
1930       if (Value *V = alreadyVectorized(E->Scalars))
1931         return V;
1932
1933       BinaryOperator *BinOp = cast<BinaryOperator>(VL0);
1934       Value *V = Builder.CreateBinOp(BinOp->getOpcode(), LHS, RHS);
1935       E->VectorizedValue = V;
1936       ++NumVectorInstructions;
1937
1938       if (Instruction *I = dyn_cast<Instruction>(V))
1939         return propagateMetadata(I, E->Scalars);
1940
1941       return V;
1942     }
1943     case Instruction::Load: {
1944       // Loads are inserted at the head of the tree because we don't want to
1945       // sink them all the way down past store instructions.
1946       setInsertPointAfterBundle(E->Scalars);
1947
1948       LoadInst *LI = cast<LoadInst>(VL0);
1949       Type *ScalarLoadTy = LI->getType();
1950       unsigned AS = LI->getPointerAddressSpace();
1951
1952       Value *VecPtr = Builder.CreateBitCast(LI->getPointerOperand(),
1953                                             VecTy->getPointerTo(AS));
1954       unsigned Alignment = LI->getAlignment();
1955       LI = Builder.CreateLoad(VecPtr);
1956       if (!Alignment)
1957         Alignment = DL->getABITypeAlignment(ScalarLoadTy);
1958       LI->setAlignment(Alignment);
1959       E->VectorizedValue = LI;
1960       ++NumVectorInstructions;
1961       return propagateMetadata(LI, E->Scalars);
1962     }
1963     case Instruction::Store: {
1964       StoreInst *SI = cast<StoreInst>(VL0);
1965       unsigned Alignment = SI->getAlignment();
1966       unsigned AS = SI->getPointerAddressSpace();
1967
1968       ValueList ValueOp;
1969       for (int i = 0, e = E->Scalars.size(); i < e; ++i)
1970         ValueOp.push_back(cast<StoreInst>(E->Scalars[i])->getValueOperand());
1971
1972       setInsertPointAfterBundle(E->Scalars);
1973
1974       Value *VecValue = vectorizeTree(ValueOp);
1975       Value *VecPtr = Builder.CreateBitCast(SI->getPointerOperand(),
1976                                             VecTy->getPointerTo(AS));
1977       StoreInst *S = Builder.CreateStore(VecValue, VecPtr);
1978       if (!Alignment)
1979         Alignment = DL->getABITypeAlignment(SI->getValueOperand()->getType());
1980       S->setAlignment(Alignment);
1981       E->VectorizedValue = S;
1982       ++NumVectorInstructions;
1983       return propagateMetadata(S, E->Scalars);
1984     }
1985     case Instruction::Call: {
1986       CallInst *CI = cast<CallInst>(VL0);
1987       setInsertPointAfterBundle(E->Scalars);
1988       Function *FI;
1989       Intrinsic::ID IID  = Intrinsic::not_intrinsic;
1990       if (CI && (FI = CI->getCalledFunction())) {
1991         IID = (Intrinsic::ID) FI->getIntrinsicID();
1992       }
1993       std::vector<Value *> OpVecs;
1994       for (int j = 0, e = CI->getNumArgOperands(); j < e; ++j) {
1995         ValueList OpVL;
1996         // ctlz,cttz and powi are special intrinsics whose second argument is
1997         // a scalar. This argument should not be vectorized.
1998         if (hasVectorInstrinsicScalarOpd(IID, 1) && j == 1) {
1999           CallInst *CEI = cast<CallInst>(E->Scalars[0]);
2000           OpVecs.push_back(CEI->getArgOperand(j));
2001           continue;
2002         }
2003         for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
2004           CallInst *CEI = cast<CallInst>(E->Scalars[i]);
2005           OpVL.push_back(CEI->getArgOperand(j));
2006         }
2007
2008         Value *OpVec = vectorizeTree(OpVL);
2009         DEBUG(dbgs() << "SLP: OpVec[" << j << "]: " << *OpVec << "\n");
2010         OpVecs.push_back(OpVec);
2011       }
2012
2013       Module *M = F->getParent();
2014       Intrinsic::ID ID = getIntrinsicIDForCall(CI, TLI);
2015       Type *Tys[] = { VectorType::get(CI->getType(), E->Scalars.size()) };
2016       Function *CF = Intrinsic::getDeclaration(M, ID, Tys);
2017       Value *V = Builder.CreateCall(CF, OpVecs);
2018       E->VectorizedValue = V;
2019       ++NumVectorInstructions;
2020       return V;
2021     }
2022     case Instruction::ShuffleVector: {
2023       ValueList LHSVL, RHSVL;
2024       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
2025         LHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
2026         RHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
2027       }
2028       setInsertPointAfterBundle(E->Scalars);
2029
2030       Value *LHS = vectorizeTree(LHSVL);
2031       Value *RHS = vectorizeTree(RHSVL);
2032
2033       if (Value *V = alreadyVectorized(E->Scalars))
2034         return V;
2035
2036       // Create a vector of LHS op1 RHS
2037       BinaryOperator *BinOp0 = cast<BinaryOperator>(VL0);
2038       Value *V0 = Builder.CreateBinOp(BinOp0->getOpcode(), LHS, RHS);
2039
2040       // Create a vector of LHS op2 RHS
2041       Instruction *VL1 = cast<Instruction>(E->Scalars[1]);
2042       BinaryOperator *BinOp1 = cast<BinaryOperator>(VL1);
2043       Value *V1 = Builder.CreateBinOp(BinOp1->getOpcode(), LHS, RHS);
2044
2045       // Create appropriate shuffle to take alternative operations from
2046       // the vector.
2047       std::vector<Constant *> Mask(E->Scalars.size());
2048       unsigned e = E->Scalars.size();
2049       for (unsigned i = 0; i < e; ++i) {
2050         if (i & 1)
2051           Mask[i] = Builder.getInt32(e + i);
2052         else
2053           Mask[i] = Builder.getInt32(i);
2054       }
2055
2056       Value *ShuffleMask = ConstantVector::get(Mask);
2057
2058       Value *V = Builder.CreateShuffleVector(V0, V1, ShuffleMask);
2059       E->VectorizedValue = V;
2060       ++NumVectorInstructions;
2061       if (Instruction *I = dyn_cast<Instruction>(V))
2062         return propagateMetadata(I, E->Scalars);
2063
2064       return V;
2065     }
2066     default:
2067     llvm_unreachable("unknown inst");
2068   }
2069   return nullptr;
2070 }
2071
2072 Value *BoUpSLP::vectorizeTree() {
2073   
2074   // All blocks must be scheduled before any instructions are inserted.
2075   for (auto &BSIter : BlocksSchedules) {
2076     scheduleBlock(BSIter.second.get());
2077   }
2078
2079   Builder.SetInsertPoint(F->getEntryBlock().begin());
2080   vectorizeTree(&VectorizableTree[0]);
2081
2082   DEBUG(dbgs() << "SLP: Extracting " << ExternalUses.size() << " values .\n");
2083
2084   // Extract all of the elements with the external uses.
2085   for (UserList::iterator it = ExternalUses.begin(), e = ExternalUses.end();
2086        it != e; ++it) {
2087     Value *Scalar = it->Scalar;
2088     llvm::User *User = it->User;
2089
2090     // Skip users that we already RAUW. This happens when one instruction
2091     // has multiple uses of the same value.
2092     if (std::find(Scalar->user_begin(), Scalar->user_end(), User) ==
2093         Scalar->user_end())
2094       continue;
2095     assert(ScalarToTreeEntry.count(Scalar) && "Invalid scalar");
2096
2097     int Idx = ScalarToTreeEntry[Scalar];
2098     TreeEntry *E = &VectorizableTree[Idx];
2099     assert(!E->NeedToGather && "Extracting from a gather list");
2100
2101     Value *Vec = E->VectorizedValue;
2102     assert(Vec && "Can't find vectorizable value");
2103
2104     Value *Lane = Builder.getInt32(it->Lane);
2105     // Generate extracts for out-of-tree users.
2106     // Find the insertion point for the extractelement lane.
2107     if (isa<Instruction>(Vec)){
2108       if (PHINode *PH = dyn_cast<PHINode>(User)) {
2109         for (int i = 0, e = PH->getNumIncomingValues(); i != e; ++i) {
2110           if (PH->getIncomingValue(i) == Scalar) {
2111             Builder.SetInsertPoint(PH->getIncomingBlock(i)->getTerminator());
2112             Value *Ex = Builder.CreateExtractElement(Vec, Lane);
2113             CSEBlocks.insert(PH->getIncomingBlock(i));
2114             PH->setOperand(i, Ex);
2115           }
2116         }
2117       } else {
2118         Builder.SetInsertPoint(cast<Instruction>(User));
2119         Value *Ex = Builder.CreateExtractElement(Vec, Lane);
2120         CSEBlocks.insert(cast<Instruction>(User)->getParent());
2121         User->replaceUsesOfWith(Scalar, Ex);
2122      }
2123     } else {
2124       Builder.SetInsertPoint(F->getEntryBlock().begin());
2125       Value *Ex = Builder.CreateExtractElement(Vec, Lane);
2126       CSEBlocks.insert(&F->getEntryBlock());
2127       User->replaceUsesOfWith(Scalar, Ex);
2128     }
2129
2130     DEBUG(dbgs() << "SLP: Replaced:" << *User << ".\n");
2131   }
2132
2133   // For each vectorized value:
2134   for (int EIdx = 0, EE = VectorizableTree.size(); EIdx < EE; ++EIdx) {
2135     TreeEntry *Entry = &VectorizableTree[EIdx];
2136
2137     // For each lane:
2138     for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) {
2139       Value *Scalar = Entry->Scalars[Lane];
2140       // No need to handle users of gathered values.
2141       if (Entry->NeedToGather)
2142         continue;
2143
2144       assert(Entry->VectorizedValue && "Can't find vectorizable value");
2145
2146       Type *Ty = Scalar->getType();
2147       if (!Ty->isVoidTy()) {
2148 #ifndef NDEBUG
2149         for (User *U : Scalar->users()) {
2150           DEBUG(dbgs() << "SLP: \tvalidating user:" << *U << ".\n");
2151
2152           assert((ScalarToTreeEntry.count(U) ||
2153                   // It is legal to replace users in the ignorelist by undef.
2154                   (std::find(UserIgnoreList.begin(), UserIgnoreList.end(), U) !=
2155                    UserIgnoreList.end())) &&
2156                  "Replacing out-of-tree value with undef");
2157         }
2158 #endif
2159         Value *Undef = UndefValue::get(Ty);
2160         Scalar->replaceAllUsesWith(Undef);
2161       }
2162       DEBUG(dbgs() << "SLP: \tErasing scalar:" << *Scalar << ".\n");
2163       cast<Instruction>(Scalar)->eraseFromParent();
2164     }
2165   }
2166
2167   Builder.ClearInsertionPoint();
2168
2169   return VectorizableTree[0].VectorizedValue;
2170 }
2171
2172 void BoUpSLP::optimizeGatherSequence() {
2173   DEBUG(dbgs() << "SLP: Optimizing " << GatherSeq.size()
2174         << " gather sequences instructions.\n");
2175   // LICM InsertElementInst sequences.
2176   for (SetVector<Instruction *>::iterator it = GatherSeq.begin(),
2177        e = GatherSeq.end(); it != e; ++it) {
2178     InsertElementInst *Insert = dyn_cast<InsertElementInst>(*it);
2179
2180     if (!Insert)
2181       continue;
2182
2183     // Check if this block is inside a loop.
2184     Loop *L = LI->getLoopFor(Insert->getParent());
2185     if (!L)
2186       continue;
2187
2188     // Check if it has a preheader.
2189     BasicBlock *PreHeader = L->getLoopPreheader();
2190     if (!PreHeader)
2191       continue;
2192
2193     // If the vector or the element that we insert into it are
2194     // instructions that are defined in this basic block then we can't
2195     // hoist this instruction.
2196     Instruction *CurrVec = dyn_cast<Instruction>(Insert->getOperand(0));
2197     Instruction *NewElem = dyn_cast<Instruction>(Insert->getOperand(1));
2198     if (CurrVec && L->contains(CurrVec))
2199       continue;
2200     if (NewElem && L->contains(NewElem))
2201       continue;
2202
2203     // We can hoist this instruction. Move it to the pre-header.
2204     Insert->moveBefore(PreHeader->getTerminator());
2205   }
2206
2207   // Make a list of all reachable blocks in our CSE queue.
2208   SmallVector<const DomTreeNode *, 8> CSEWorkList;
2209   CSEWorkList.reserve(CSEBlocks.size());
2210   for (BasicBlock *BB : CSEBlocks)
2211     if (DomTreeNode *N = DT->getNode(BB)) {
2212       assert(DT->isReachableFromEntry(N));
2213       CSEWorkList.push_back(N);
2214     }
2215
2216   // Sort blocks by domination. This ensures we visit a block after all blocks
2217   // dominating it are visited.
2218   std::stable_sort(CSEWorkList.begin(), CSEWorkList.end(),
2219                    [this](const DomTreeNode *A, const DomTreeNode *B) {
2220     return DT->properlyDominates(A, B);
2221   });
2222
2223   // Perform O(N^2) search over the gather sequences and merge identical
2224   // instructions. TODO: We can further optimize this scan if we split the
2225   // instructions into different buckets based on the insert lane.
2226   SmallVector<Instruction *, 16> Visited;
2227   for (auto I = CSEWorkList.begin(), E = CSEWorkList.end(); I != E; ++I) {
2228     assert((I == CSEWorkList.begin() || !DT->dominates(*I, *std::prev(I))) &&
2229            "Worklist not sorted properly!");
2230     BasicBlock *BB = (*I)->getBlock();
2231     // For all instructions in blocks containing gather sequences:
2232     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e;) {
2233       Instruction *In = it++;
2234       if (!isa<InsertElementInst>(In) && !isa<ExtractElementInst>(In))
2235         continue;
2236
2237       // Check if we can replace this instruction with any of the
2238       // visited instructions.
2239       for (SmallVectorImpl<Instruction *>::iterator v = Visited.begin(),
2240                                                     ve = Visited.end();
2241            v != ve; ++v) {
2242         if (In->isIdenticalTo(*v) &&
2243             DT->dominates((*v)->getParent(), In->getParent())) {
2244           In->replaceAllUsesWith(*v);
2245           In->eraseFromParent();
2246           In = nullptr;
2247           break;
2248         }
2249       }
2250       if (In) {
2251         assert(std::find(Visited.begin(), Visited.end(), In) == Visited.end());
2252         Visited.push_back(In);
2253       }
2254     }
2255   }
2256   CSEBlocks.clear();
2257   GatherSeq.clear();
2258 }
2259
2260 // Groups the instructions to a bundle (which is then a single scheduling entity)
2261 // and schedules instructions until the bundle gets ready.
2262 bool BoUpSLP::BlockScheduling::tryScheduleBundle(ArrayRef<Value *> VL,
2263                                                  AliasAnalysis *AA) {
2264   if (isa<PHINode>(VL[0]))
2265     return true;
2266
2267   // Initialize the instruction bundle.
2268   Instruction *OldScheduleEnd = ScheduleEnd;
2269   ScheduleData *PrevInBundle = nullptr;
2270   ScheduleData *Bundle = nullptr;
2271   bool ReSchedule = false;
2272   DEBUG(dbgs() << "SLP:  bundle: " << *VL[0] << "\n");
2273   for (Value *V : VL) {
2274     extendSchedulingRegion(V);
2275     ScheduleData *BundleMember = getScheduleData(V);
2276     assert(BundleMember &&
2277            "no ScheduleData for bundle member (maybe not in same basic block)");
2278     if (BundleMember->IsScheduled) {
2279       // A bundle member was scheduled as single instruction before and now
2280       // needs to be scheduled as part of the bundle. We just get rid of the
2281       // existing schedule.
2282       DEBUG(dbgs() << "SLP:  reset schedule because " << *BundleMember
2283                    << " was already scheduled\n");
2284       ReSchedule = true;
2285     }
2286     assert(BundleMember->isSchedulingEntity() &&
2287            "bundle member already part of other bundle");
2288     if (PrevInBundle) {
2289       PrevInBundle->NextInBundle = BundleMember;
2290     } else {
2291       Bundle = BundleMember;
2292     }
2293     BundleMember->UnscheduledDepsInBundle = 0;
2294     Bundle->UnscheduledDepsInBundle += BundleMember->UnscheduledDeps;
2295
2296     // Group the instructions to a bundle.
2297     BundleMember->FirstInBundle = Bundle;
2298     PrevInBundle = BundleMember;
2299   }
2300   if (ScheduleEnd != OldScheduleEnd) {
2301     // The scheduling region got new instructions at the lower end (or it is a
2302     // new region for the first bundle). This makes it necessary to
2303     // recalculate all dependencies.
2304     // It is seldom that this needs to be done a second time after adding the
2305     // initial bundle to the region.
2306     for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) {
2307       ScheduleData *SD = getScheduleData(I);
2308       SD->clearDependencies();
2309     }
2310     ReSchedule = true;
2311   }
2312   if (ReSchedule) {
2313     resetSchedule();
2314     initialFillReadyList(ReadyInsts);
2315   }
2316
2317   DEBUG(dbgs() << "SLP: try schedule bundle " << *Bundle << " in block "
2318                << BB->getName() << "\n");
2319
2320   calculateDependencies(Bundle, true, AA);
2321
2322   // Now try to schedule the new bundle. As soon as the bundle is "ready" it
2323   // means that there are no cyclic dependencies and we can schedule it.
2324   // Note that's important that we don't "schedule" the bundle yet (see
2325   // cancelScheduling).
2326   while (!Bundle->isReady() && !ReadyInsts.empty()) {
2327
2328     ScheduleData *pickedSD = ReadyInsts.back();
2329     ReadyInsts.pop_back();
2330
2331     if (pickedSD->isSchedulingEntity() && pickedSD->isReady()) {
2332       schedule(pickedSD, ReadyInsts);
2333     }
2334   }
2335   return Bundle->isReady();
2336 }
2337
2338 void BoUpSLP::BlockScheduling::cancelScheduling(ArrayRef<Value *> VL) {
2339   if (isa<PHINode>(VL[0]))
2340     return;
2341
2342   ScheduleData *Bundle = getScheduleData(VL[0]);
2343   DEBUG(dbgs() << "SLP:  cancel scheduling of " << *Bundle << "\n");
2344   assert(!Bundle->IsScheduled &&
2345          "Can't cancel bundle which is already scheduled");
2346   assert(Bundle->isSchedulingEntity() && Bundle->isPartOfBundle() &&
2347          "tried to unbundle something which is not a bundle");
2348
2349   // Un-bundle: make single instructions out of the bundle.
2350   ScheduleData *BundleMember = Bundle;
2351   while (BundleMember) {
2352     assert(BundleMember->FirstInBundle == Bundle && "corrupt bundle links");
2353     BundleMember->FirstInBundle = BundleMember;
2354     ScheduleData *Next = BundleMember->NextInBundle;
2355     BundleMember->NextInBundle = nullptr;
2356     BundleMember->UnscheduledDepsInBundle = BundleMember->UnscheduledDeps;
2357     if (BundleMember->UnscheduledDepsInBundle == 0) {
2358       ReadyInsts.insert(BundleMember);
2359     }
2360     BundleMember = Next;
2361   }
2362 }
2363
2364 void BoUpSLP::BlockScheduling::extendSchedulingRegion(Value *V) {
2365   if (getScheduleData(V))
2366     return;
2367   Instruction *I = dyn_cast<Instruction>(V);
2368   assert(I && "bundle member must be an instruction");
2369   assert(!isa<PHINode>(I) && "phi nodes don't need to be scheduled");
2370   if (!ScheduleStart) {
2371     // It's the first instruction in the new region.
2372     initScheduleData(I, I->getNextNode(), nullptr, nullptr);
2373     ScheduleStart = I;
2374     ScheduleEnd = I->getNextNode();
2375     assert(ScheduleEnd && "tried to vectorize a TerminatorInst?");
2376     DEBUG(dbgs() << "SLP:  initialize schedule region to " << *I << "\n");
2377     return;
2378   }
2379   // Search up and down at the same time, because we don't know if the new
2380   // instruction is above or below the existing scheduling region.
2381   BasicBlock::reverse_iterator UpIter(ScheduleStart);
2382   BasicBlock::reverse_iterator UpperEnd = BB->rend();
2383   BasicBlock::iterator DownIter(ScheduleEnd);
2384   BasicBlock::iterator LowerEnd = BB->end();
2385   for (;;) {
2386     if (UpIter != UpperEnd) {
2387       if (&*UpIter == I) {
2388         initScheduleData(I, ScheduleStart, nullptr, FirstLoadStoreInRegion);
2389         ScheduleStart = I;
2390         DEBUG(dbgs() << "SLP:  extend schedule region start to " << *I << "\n");
2391         return;
2392       }
2393       UpIter++;
2394     }
2395     if (DownIter != LowerEnd) {
2396       if (&*DownIter == I) {
2397         initScheduleData(ScheduleEnd, I->getNextNode(), LastLoadStoreInRegion,
2398                          nullptr);
2399         ScheduleEnd = I->getNextNode();
2400         assert(ScheduleEnd && "tried to vectorize a TerminatorInst?");
2401         DEBUG(dbgs() << "SLP:  extend schedule region end to " << *I << "\n");
2402         return;
2403       }
2404       DownIter++;
2405     }
2406     assert((UpIter != UpperEnd || DownIter != LowerEnd) &&
2407            "instruction not found in block");
2408   }
2409 }
2410
2411 void BoUpSLP::BlockScheduling::initScheduleData(Instruction *FromI,
2412                                                 Instruction *ToI,
2413                                                 ScheduleData *PrevLoadStore,
2414                                                 ScheduleData *NextLoadStore) {
2415   ScheduleData *CurrentLoadStore = PrevLoadStore;
2416   for (Instruction *I = FromI; I != ToI; I = I->getNextNode()) {
2417     ScheduleData *SD = ScheduleDataMap[I];
2418     if (!SD) {
2419       // Allocate a new ScheduleData for the instruction.
2420       if (ChunkPos >= ChunkSize) {
2421         ScheduleDataChunks.push_back(
2422             llvm::make_unique<ScheduleData[]>(ChunkSize));
2423         ChunkPos = 0;
2424       }
2425       SD = &(ScheduleDataChunks.back()[ChunkPos++]);
2426       ScheduleDataMap[I] = SD;
2427       SD->Inst = I;
2428     }
2429     assert(!isInSchedulingRegion(SD) &&
2430            "new ScheduleData already in scheduling region");
2431     SD->init(SchedulingRegionID);
2432
2433     if (I->mayReadOrWriteMemory()) {
2434       // Update the linked list of memory accessing instructions.
2435       if (CurrentLoadStore) {
2436         CurrentLoadStore->NextLoadStore = SD;
2437       } else {
2438         FirstLoadStoreInRegion = SD;
2439       }
2440       CurrentLoadStore = SD;
2441     }
2442   }
2443   if (NextLoadStore) {
2444     if (CurrentLoadStore)
2445       CurrentLoadStore->NextLoadStore = NextLoadStore;
2446   } else {
2447     LastLoadStoreInRegion = CurrentLoadStore;
2448   }
2449 }
2450
2451 /// \returns the AA location that is being access by the instruction.
2452 static AliasAnalysis::Location getLocation(Instruction *I, AliasAnalysis *AA) {
2453   if (StoreInst *SI = dyn_cast<StoreInst>(I))
2454     return AA->getLocation(SI);
2455   if (LoadInst *LI = dyn_cast<LoadInst>(I))
2456     return AA->getLocation(LI);
2457   return AliasAnalysis::Location();
2458 }
2459
2460 void BoUpSLP::BlockScheduling::calculateDependencies(ScheduleData *SD,
2461                                                      bool InsertInReadyList,
2462                                                      AliasAnalysis *AA) {
2463   assert(SD->isSchedulingEntity());
2464
2465   SmallVector<ScheduleData *, 10> WorkList;
2466   WorkList.push_back(SD);
2467
2468   while (!WorkList.empty()) {
2469     ScheduleData *SD = WorkList.back();
2470     WorkList.pop_back();
2471
2472     ScheduleData *BundleMember = SD;
2473     while (BundleMember) {
2474       assert(isInSchedulingRegion(BundleMember));
2475       if (!BundleMember->hasValidDependencies()) {
2476
2477         DEBUG(dbgs() << "SLP:       update deps of " << *BundleMember << "\n");
2478         BundleMember->Dependencies = 0;
2479         BundleMember->resetUnscheduledDeps();
2480
2481         // Handle def-use chain dependencies.
2482         for (User *U : BundleMember->Inst->users()) {
2483           if (isa<Instruction>(U)) {
2484             ScheduleData *UseSD = getScheduleData(U);
2485             if (UseSD && isInSchedulingRegion(UseSD->FirstInBundle)) {
2486               BundleMember->Dependencies++;
2487               ScheduleData *DestBundle = UseSD->FirstInBundle;
2488               if (!DestBundle->IsScheduled) {
2489                 BundleMember->incrementUnscheduledDeps(1);
2490               }
2491               if (!DestBundle->hasValidDependencies()) {
2492                 WorkList.push_back(DestBundle);
2493               }
2494             }
2495           } else {
2496             // I'm not sure if this can ever happen. But we need to be safe.
2497             // This lets the instruction/bundle never be scheduled and eventally
2498             // disable vectorization.
2499             BundleMember->Dependencies++;
2500             BundleMember->incrementUnscheduledDeps(1);
2501           }
2502         }
2503
2504         // Handle the memory dependencies.
2505         ScheduleData *DepDest = BundleMember->NextLoadStore;
2506         if (DepDest) {
2507           AliasAnalysis::Location SrcLoc = getLocation(BundleMember->Inst, AA);
2508           bool SrcMayWrite = BundleMember->Inst->mayWriteToMemory();
2509
2510           while (DepDest) {
2511             assert(isInSchedulingRegion(DepDest));
2512             if (SrcMayWrite || DepDest->Inst->mayWriteToMemory()) {
2513               AliasAnalysis::Location DstLoc = getLocation(DepDest->Inst, AA);
2514               if (!SrcLoc.Ptr || !DstLoc.Ptr || AA->alias(SrcLoc, DstLoc)) {
2515                 DepDest->MemoryDependencies.push_back(BundleMember);
2516                 BundleMember->Dependencies++;
2517                 ScheduleData *DestBundle = DepDest->FirstInBundle;
2518                 if (!DestBundle->IsScheduled) {
2519                   BundleMember->incrementUnscheduledDeps(1);
2520                 }
2521                 if (!DestBundle->hasValidDependencies()) {
2522                   WorkList.push_back(DestBundle);
2523                 }
2524               }
2525             }
2526             DepDest = DepDest->NextLoadStore;
2527           }
2528         }
2529       }
2530       BundleMember = BundleMember->NextInBundle;
2531     }
2532     if (InsertInReadyList && SD->isReady()) {
2533       ReadyInsts.push_back(SD);
2534       DEBUG(dbgs() << "SLP:     gets ready on update: " << *SD->Inst << "\n");
2535     }
2536   }
2537 }
2538
2539 void BoUpSLP::BlockScheduling::resetSchedule() {
2540   assert(ScheduleStart &&
2541          "tried to reset schedule on block which has not been scheduled");
2542   for (Instruction *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) {
2543     ScheduleData *SD = getScheduleData(I);
2544     assert(isInSchedulingRegion(SD));
2545     SD->IsScheduled = false;
2546     SD->resetUnscheduledDeps();
2547   }
2548   ReadyInsts.clear();
2549 }
2550
2551 void BoUpSLP::scheduleBlock(BlockScheduling *BS) {
2552   
2553   if (!BS->ScheduleStart)
2554     return;
2555   
2556   DEBUG(dbgs() << "SLP: schedule block " << BS->BB->getName() << "\n");
2557
2558   BS->resetSchedule();
2559
2560   // For the real scheduling we use a more sophisticated ready-list: it is
2561   // sorted by the original instruction location. This lets the final schedule
2562   // be as  close as possible to the original instruction order.
2563   struct ScheduleDataCompare {
2564     bool operator()(ScheduleData *SD1, ScheduleData *SD2) {
2565       return SD2->SchedulingPriority < SD1->SchedulingPriority;
2566     }
2567   };
2568   std::set<ScheduleData *, ScheduleDataCompare> ReadyInsts;
2569
2570   // Ensure that all depencency data is updated and fill the ready-list with
2571   // initial instructions.
2572   int Idx = 0;
2573   int NumToSchedule = 0;
2574   for (auto *I = BS->ScheduleStart; I != BS->ScheduleEnd;
2575        I = I->getNextNode()) {
2576     ScheduleData *SD = BS->getScheduleData(I);
2577     assert(
2578         SD->isPartOfBundle() == (ScalarToTreeEntry.count(SD->Inst) != 0) &&
2579         "scheduler and vectorizer have different opinion on what is a bundle");
2580     SD->FirstInBundle->SchedulingPriority = Idx++;
2581     if (SD->isSchedulingEntity()) {
2582       BS->calculateDependencies(SD, false, AA);
2583       NumToSchedule++;
2584     }
2585   }
2586   BS->initialFillReadyList(ReadyInsts);
2587
2588   Instruction *LastScheduledInst = BS->ScheduleEnd;
2589
2590   // Do the "real" scheduling.
2591   while (!ReadyInsts.empty()) {
2592     ScheduleData *picked = *ReadyInsts.begin();
2593     ReadyInsts.erase(ReadyInsts.begin());
2594
2595     // Move the scheduled instruction(s) to their dedicated places, if not
2596     // there yet.
2597     ScheduleData *BundleMember = picked;
2598     while (BundleMember) {
2599       Instruction *pickedInst = BundleMember->Inst;
2600       if (LastScheduledInst->getNextNode() != pickedInst) {
2601         BS->BB->getInstList().remove(pickedInst);
2602         BS->BB->getInstList().insert(LastScheduledInst, pickedInst);
2603       }
2604       LastScheduledInst = pickedInst;
2605       BundleMember = BundleMember->NextInBundle;
2606     }
2607
2608     BS->schedule(picked, ReadyInsts);
2609     NumToSchedule--;
2610   }
2611   assert(NumToSchedule == 0 && "could not schedule all instructions");
2612
2613   // Avoid duplicate scheduling of the block.
2614   BS->ScheduleStart = nullptr;
2615 }
2616
2617 /// The SLPVectorizer Pass.
2618 struct SLPVectorizer : public FunctionPass {
2619   typedef SmallVector<StoreInst *, 8> StoreList;
2620   typedef MapVector<Value *, StoreList> StoreListMap;
2621
2622   /// Pass identification, replacement for typeid
2623   static char ID;
2624
2625   explicit SLPVectorizer() : FunctionPass(ID) {
2626     initializeSLPVectorizerPass(*PassRegistry::getPassRegistry());
2627   }
2628
2629   ScalarEvolution *SE;
2630   const DataLayout *DL;
2631   TargetTransformInfo *TTI;
2632   TargetLibraryInfo *TLI;
2633   AliasAnalysis *AA;
2634   LoopInfo *LI;
2635   DominatorTree *DT;
2636
2637   bool runOnFunction(Function &F) override {
2638     if (skipOptnoneFunction(F))
2639       return false;
2640
2641     SE = &getAnalysis<ScalarEvolution>();
2642     DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
2643     DL = DLP ? &DLP->getDataLayout() : nullptr;
2644     TTI = &getAnalysis<TargetTransformInfo>();
2645     TLI = getAnalysisIfAvailable<TargetLibraryInfo>();
2646     AA = &getAnalysis<AliasAnalysis>();
2647     LI = &getAnalysis<LoopInfo>();
2648     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
2649
2650     StoreRefs.clear();
2651     bool Changed = false;
2652
2653     // If the target claims to have no vector registers don't attempt
2654     // vectorization.
2655     if (!TTI->getNumberOfRegisters(true))
2656       return false;
2657
2658     // Must have DataLayout. We can't require it because some tests run w/o
2659     // triple.
2660     if (!DL)
2661       return false;
2662
2663     // Don't vectorize when the attribute NoImplicitFloat is used.
2664     if (F.hasFnAttribute(Attribute::NoImplicitFloat))
2665       return false;
2666
2667     DEBUG(dbgs() << "SLP: Analyzing blocks in " << F.getName() << ".\n");
2668
2669     // Use the bottom up slp vectorizer to construct chains that start with
2670     // store instructions.
2671     BoUpSLP R(&F, SE, DL, TTI, TLI, AA, LI, DT);
2672
2673     // Scan the blocks in the function in post order.
2674     for (po_iterator<BasicBlock*> it = po_begin(&F.getEntryBlock()),
2675          e = po_end(&F.getEntryBlock()); it != e; ++it) {
2676       BasicBlock *BB = *it;
2677       // Vectorize trees that end at stores.
2678       if (unsigned count = collectStores(BB, R)) {
2679         (void)count;
2680         DEBUG(dbgs() << "SLP: Found " << count << " stores to vectorize.\n");
2681         Changed |= vectorizeStoreChains(R);
2682       }
2683
2684       // Vectorize trees that end at reductions.
2685       Changed |= vectorizeChainsInBlock(BB, R);
2686     }
2687
2688     if (Changed) {
2689       R.optimizeGatherSequence();
2690       DEBUG(dbgs() << "SLP: vectorized \"" << F.getName() << "\"\n");
2691       DEBUG(verifyFunction(F));
2692     }
2693     return Changed;
2694   }
2695
2696   void getAnalysisUsage(AnalysisUsage &AU) const override {
2697     FunctionPass::getAnalysisUsage(AU);
2698     AU.addRequired<ScalarEvolution>();
2699     AU.addRequired<AliasAnalysis>();
2700     AU.addRequired<TargetTransformInfo>();
2701     AU.addRequired<LoopInfo>();
2702     AU.addRequired<DominatorTreeWrapperPass>();
2703     AU.addPreserved<LoopInfo>();
2704     AU.addPreserved<DominatorTreeWrapperPass>();
2705     AU.setPreservesCFG();
2706   }
2707
2708 private:
2709
2710   /// \brief Collect memory references and sort them according to their base
2711   /// object. We sort the stores to their base objects to reduce the cost of the
2712   /// quadratic search on the stores. TODO: We can further reduce this cost
2713   /// if we flush the chain creation every time we run into a memory barrier.
2714   unsigned collectStores(BasicBlock *BB, BoUpSLP &R);
2715
2716   /// \brief Try to vectorize a chain that starts at two arithmetic instrs.
2717   bool tryToVectorizePair(Value *A, Value *B, BoUpSLP &R);
2718
2719   /// \brief Try to vectorize a list of operands.
2720   /// \@param BuildVector A list of users to ignore for the purpose of
2721   ///                     scheduling and that don't need extracting.
2722   /// \returns true if a value was vectorized.
2723   bool tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R,
2724                           ArrayRef<Value *> BuildVector = None,
2725                           bool allowReorder = false);
2726
2727   /// \brief Try to vectorize a chain that may start at the operands of \V;
2728   bool tryToVectorize(BinaryOperator *V, BoUpSLP &R);
2729
2730   /// \brief Vectorize the stores that were collected in StoreRefs.
2731   bool vectorizeStoreChains(BoUpSLP &R);
2732
2733   /// \brief Scan the basic block and look for patterns that are likely to start
2734   /// a vectorization chain.
2735   bool vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R);
2736
2737   bool vectorizeStoreChain(ArrayRef<Value *> Chain, int CostThreshold,
2738                            BoUpSLP &R);
2739
2740   bool vectorizeStores(ArrayRef<StoreInst *> Stores, int costThreshold,
2741                        BoUpSLP &R);
2742 private:
2743   StoreListMap StoreRefs;
2744 };
2745
2746 /// \brief Check that the Values in the slice in VL array are still existent in
2747 /// the WeakVH array.
2748 /// Vectorization of part of the VL array may cause later values in the VL array
2749 /// to become invalid. We track when this has happened in the WeakVH array.
2750 static bool hasValueBeenRAUWed(ArrayRef<Value *> &VL,
2751                                SmallVectorImpl<WeakVH> &VH,
2752                                unsigned SliceBegin,
2753                                unsigned SliceSize) {
2754   for (unsigned i = SliceBegin; i < SliceBegin + SliceSize; ++i)
2755     if (VH[i] != VL[i])
2756       return true;
2757
2758   return false;
2759 }
2760
2761 bool SLPVectorizer::vectorizeStoreChain(ArrayRef<Value *> Chain,
2762                                           int CostThreshold, BoUpSLP &R) {
2763   unsigned ChainLen = Chain.size();
2764   DEBUG(dbgs() << "SLP: Analyzing a store chain of length " << ChainLen
2765         << "\n");
2766   Type *StoreTy = cast<StoreInst>(Chain[0])->getValueOperand()->getType();
2767   unsigned Sz = DL->getTypeSizeInBits(StoreTy);
2768   unsigned VF = MinVecRegSize / Sz;
2769
2770   if (!isPowerOf2_32(Sz) || VF < 2)
2771     return false;
2772
2773   // Keep track of values that were deleted by vectorizing in the loop below.
2774   SmallVector<WeakVH, 8> TrackValues(Chain.begin(), Chain.end());
2775
2776   bool Changed = false;
2777   // Look for profitable vectorizable trees at all offsets, starting at zero.
2778   for (unsigned i = 0, e = ChainLen; i < e; ++i) {
2779     if (i + VF > e)
2780       break;
2781
2782     // Check that a previous iteration of this loop did not delete the Value.
2783     if (hasValueBeenRAUWed(Chain, TrackValues, i, VF))
2784       continue;
2785
2786     DEBUG(dbgs() << "SLP: Analyzing " << VF << " stores at offset " << i
2787           << "\n");
2788     ArrayRef<Value *> Operands = Chain.slice(i, VF);
2789
2790     R.buildTree(Operands);
2791
2792     int Cost = R.getTreeCost();
2793
2794     DEBUG(dbgs() << "SLP: Found cost=" << Cost << " for VF=" << VF << "\n");
2795     if (Cost < CostThreshold) {
2796       DEBUG(dbgs() << "SLP: Decided to vectorize cost=" << Cost << "\n");
2797       R.vectorizeTree();
2798
2799       // Move to the next bundle.
2800       i += VF - 1;
2801       Changed = true;
2802     }
2803   }
2804
2805   return Changed;
2806 }
2807
2808 bool SLPVectorizer::vectorizeStores(ArrayRef<StoreInst *> Stores,
2809                                     int costThreshold, BoUpSLP &R) {
2810   SetVector<Value *> Heads, Tails;
2811   SmallDenseMap<Value *, Value *> ConsecutiveChain;
2812
2813   // We may run into multiple chains that merge into a single chain. We mark the
2814   // stores that we vectorized so that we don't visit the same store twice.
2815   BoUpSLP::ValueSet VectorizedStores;
2816   bool Changed = false;
2817
2818   // Do a quadratic search on all of the given stores and find
2819   // all of the pairs of stores that follow each other.
2820   for (unsigned i = 0, e = Stores.size(); i < e; ++i) {
2821     for (unsigned j = 0; j < e; ++j) {
2822       if (i == j)
2823         continue;
2824
2825       if (R.isConsecutiveAccess(Stores[i], Stores[j])) {
2826         Tails.insert(Stores[j]);
2827         Heads.insert(Stores[i]);
2828         ConsecutiveChain[Stores[i]] = Stores[j];
2829       }
2830     }
2831   }
2832
2833   // For stores that start but don't end a link in the chain:
2834   for (SetVector<Value *>::iterator it = Heads.begin(), e = Heads.end();
2835        it != e; ++it) {
2836     if (Tails.count(*it))
2837       continue;
2838
2839     // We found a store instr that starts a chain. Now follow the chain and try
2840     // to vectorize it.
2841     BoUpSLP::ValueList Operands;
2842     Value *I = *it;
2843     // Collect the chain into a list.
2844     while (Tails.count(I) || Heads.count(I)) {
2845       if (VectorizedStores.count(I))
2846         break;
2847       Operands.push_back(I);
2848       // Move to the next value in the chain.
2849       I = ConsecutiveChain[I];
2850     }
2851
2852     bool Vectorized = vectorizeStoreChain(Operands, costThreshold, R);
2853
2854     // Mark the vectorized stores so that we don't vectorize them again.
2855     if (Vectorized)
2856       VectorizedStores.insert(Operands.begin(), Operands.end());
2857     Changed |= Vectorized;
2858   }
2859
2860   return Changed;
2861 }
2862
2863
2864 unsigned SLPVectorizer::collectStores(BasicBlock *BB, BoUpSLP &R) {
2865   unsigned count = 0;
2866   StoreRefs.clear();
2867   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
2868     StoreInst *SI = dyn_cast<StoreInst>(it);
2869     if (!SI)
2870       continue;
2871
2872     // Don't touch volatile stores.
2873     if (!SI->isSimple())
2874       continue;
2875
2876     // Check that the pointer points to scalars.
2877     Type *Ty = SI->getValueOperand()->getType();
2878     if (Ty->isAggregateType() || Ty->isVectorTy())
2879       continue;
2880
2881     // Find the base pointer.
2882     Value *Ptr = GetUnderlyingObject(SI->getPointerOperand(), DL);
2883
2884     // Save the store locations.
2885     StoreRefs[Ptr].push_back(SI);
2886     count++;
2887   }
2888   return count;
2889 }
2890
2891 bool SLPVectorizer::tryToVectorizePair(Value *A, Value *B, BoUpSLP &R) {
2892   if (!A || !B)
2893     return false;
2894   Value *VL[] = { A, B };
2895   return tryToVectorizeList(VL, R, None, true);
2896 }
2897
2898 bool SLPVectorizer::tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R,
2899                                        ArrayRef<Value *> BuildVector,
2900                                        bool allowReorder) {
2901   if (VL.size() < 2)
2902     return false;
2903
2904   DEBUG(dbgs() << "SLP: Vectorizing a list of length = " << VL.size() << ".\n");
2905
2906   // Check that all of the parts are scalar instructions of the same type.
2907   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
2908   if (!I0)
2909     return false;
2910
2911   unsigned Opcode0 = I0->getOpcode();
2912
2913   Type *Ty0 = I0->getType();
2914   unsigned Sz = DL->getTypeSizeInBits(Ty0);
2915   unsigned VF = MinVecRegSize / Sz;
2916
2917   for (int i = 0, e = VL.size(); i < e; ++i) {
2918     Type *Ty = VL[i]->getType();
2919     if (Ty->isAggregateType() || Ty->isVectorTy())
2920       return false;
2921     Instruction *Inst = dyn_cast<Instruction>(VL[i]);
2922     if (!Inst || Inst->getOpcode() != Opcode0)
2923       return false;
2924   }
2925
2926   bool Changed = false;
2927
2928   // Keep track of values that were deleted by vectorizing in the loop below.
2929   SmallVector<WeakVH, 8> TrackValues(VL.begin(), VL.end());
2930
2931   for (unsigned i = 0, e = VL.size(); i < e; ++i) {
2932     unsigned OpsWidth = 0;
2933
2934     if (i + VF > e)
2935       OpsWidth = e - i;
2936     else
2937       OpsWidth = VF;
2938
2939     if (!isPowerOf2_32(OpsWidth) || OpsWidth < 2)
2940       break;
2941
2942     // Check that a previous iteration of this loop did not delete the Value.
2943     if (hasValueBeenRAUWed(VL, TrackValues, i, OpsWidth))
2944       continue;
2945
2946     DEBUG(dbgs() << "SLP: Analyzing " << OpsWidth << " operations "
2947                  << "\n");
2948     ArrayRef<Value *> Ops = VL.slice(i, OpsWidth);
2949
2950     ArrayRef<Value *> BuildVectorSlice;
2951     if (!BuildVector.empty())
2952       BuildVectorSlice = BuildVector.slice(i, OpsWidth);
2953
2954     R.buildTree(Ops, BuildVectorSlice);
2955     // TODO: check if we can allow reordering also for other cases than
2956     // tryToVectorizePair()
2957     if (allowReorder && R.shouldReorder()) {
2958       assert(Ops.size() == 2);
2959       assert(BuildVectorSlice.empty());
2960       Value *ReorderedOps[] = { Ops[1], Ops[0] };
2961       R.buildTree(ReorderedOps, None);
2962     }
2963     int Cost = R.getTreeCost();
2964
2965     if (Cost < -SLPCostThreshold) {
2966       DEBUG(dbgs() << "SLP: Vectorizing list at cost:" << Cost << ".\n");
2967       Value *VectorizedRoot = R.vectorizeTree();
2968
2969       // Reconstruct the build vector by extracting the vectorized root. This
2970       // way we handle the case where some elements of the vector are undefined.
2971       //  (return (inserelt <4 xi32> (insertelt undef (opd0) 0) (opd1) 2))
2972       if (!BuildVectorSlice.empty()) {
2973         // The insert point is the last build vector instruction. The vectorized
2974         // root will precede it. This guarantees that we get an instruction. The
2975         // vectorized tree could have been constant folded.
2976         Instruction *InsertAfter = cast<Instruction>(BuildVectorSlice.back());
2977         unsigned VecIdx = 0;
2978         for (auto &V : BuildVectorSlice) {
2979           IRBuilder<true, NoFolder> Builder(
2980               ++BasicBlock::iterator(InsertAfter));
2981           InsertElementInst *IE = cast<InsertElementInst>(V);
2982           Instruction *Extract = cast<Instruction>(Builder.CreateExtractElement(
2983               VectorizedRoot, Builder.getInt32(VecIdx++)));
2984           IE->setOperand(1, Extract);
2985           IE->removeFromParent();
2986           IE->insertAfter(Extract);
2987           InsertAfter = IE;
2988         }
2989       }
2990       // Move to the next bundle.
2991       i += VF - 1;
2992       Changed = true;
2993     }
2994   }
2995
2996   return Changed;
2997 }
2998
2999 bool SLPVectorizer::tryToVectorize(BinaryOperator *V, BoUpSLP &R) {
3000   if (!V)
3001     return false;
3002
3003   // Try to vectorize V.
3004   if (tryToVectorizePair(V->getOperand(0), V->getOperand(1), R))
3005     return true;
3006
3007   BinaryOperator *A = dyn_cast<BinaryOperator>(V->getOperand(0));
3008   BinaryOperator *B = dyn_cast<BinaryOperator>(V->getOperand(1));
3009   // Try to skip B.
3010   if (B && B->hasOneUse()) {
3011     BinaryOperator *B0 = dyn_cast<BinaryOperator>(B->getOperand(0));
3012     BinaryOperator *B1 = dyn_cast<BinaryOperator>(B->getOperand(1));
3013     if (tryToVectorizePair(A, B0, R)) {
3014       B->moveBefore(V);
3015       return true;
3016     }
3017     if (tryToVectorizePair(A, B1, R)) {
3018       B->moveBefore(V);
3019       return true;
3020     }
3021   }
3022
3023   // Try to skip A.
3024   if (A && A->hasOneUse()) {
3025     BinaryOperator *A0 = dyn_cast<BinaryOperator>(A->getOperand(0));
3026     BinaryOperator *A1 = dyn_cast<BinaryOperator>(A->getOperand(1));
3027     if (tryToVectorizePair(A0, B, R)) {
3028       A->moveBefore(V);
3029       return true;
3030     }
3031     if (tryToVectorizePair(A1, B, R)) {
3032       A->moveBefore(V);
3033       return true;
3034     }
3035   }
3036   return 0;
3037 }
3038
3039 /// \brief Generate a shuffle mask to be used in a reduction tree.
3040 ///
3041 /// \param VecLen The length of the vector to be reduced.
3042 /// \param NumEltsToRdx The number of elements that should be reduced in the
3043 ///        vector.
3044 /// \param IsPairwise Whether the reduction is a pairwise or splitting
3045 ///        reduction. A pairwise reduction will generate a mask of 
3046 ///        <0,2,...> or <1,3,..> while a splitting reduction will generate
3047 ///        <2,3, undef,undef> for a vector of 4 and NumElts = 2.
3048 /// \param IsLeft True will generate a mask of even elements, odd otherwise.
3049 static Value *createRdxShuffleMask(unsigned VecLen, unsigned NumEltsToRdx,
3050                                    bool IsPairwise, bool IsLeft,
3051                                    IRBuilder<> &Builder) {
3052   assert((IsPairwise || !IsLeft) && "Don't support a <0,1,undef,...> mask");
3053
3054   SmallVector<Constant *, 32> ShuffleMask(
3055       VecLen, UndefValue::get(Builder.getInt32Ty()));
3056
3057   if (IsPairwise)
3058     // Build a mask of 0, 2, ... (left) or 1, 3, ... (right).
3059     for (unsigned i = 0; i != NumEltsToRdx; ++i)
3060       ShuffleMask[i] = Builder.getInt32(2 * i + !IsLeft);
3061   else
3062     // Move the upper half of the vector to the lower half.
3063     for (unsigned i = 0; i != NumEltsToRdx; ++i)
3064       ShuffleMask[i] = Builder.getInt32(NumEltsToRdx + i);
3065
3066   return ConstantVector::get(ShuffleMask);
3067 }
3068
3069
3070 /// Model horizontal reductions.
3071 ///
3072 /// A horizontal reduction is a tree of reduction operations (currently add and
3073 /// fadd) that has operations that can be put into a vector as its leaf.
3074 /// For example, this tree:
3075 ///
3076 /// mul mul mul mul
3077 ///  \  /    \  /
3078 ///   +       +
3079 ///    \     /
3080 ///       +
3081 /// This tree has "mul" as its reduced values and "+" as its reduction
3082 /// operations. A reduction might be feeding into a store or a binary operation
3083 /// feeding a phi.
3084 ///    ...
3085 ///    \  /
3086 ///     +
3087 ///     |
3088 ///  phi +=
3089 ///
3090 ///  Or:
3091 ///    ...
3092 ///    \  /
3093 ///     +
3094 ///     |
3095 ///   *p =
3096 ///
3097 class HorizontalReduction {
3098   SmallVector<Value *, 16> ReductionOps;
3099   SmallVector<Value *, 32> ReducedVals;
3100
3101   BinaryOperator *ReductionRoot;
3102   PHINode *ReductionPHI;
3103
3104   /// The opcode of the reduction.
3105   unsigned ReductionOpcode;
3106   /// The opcode of the values we perform a reduction on.
3107   unsigned ReducedValueOpcode;
3108   /// The width of one full horizontal reduction operation.
3109   unsigned ReduxWidth;
3110   /// Should we model this reduction as a pairwise reduction tree or a tree that
3111   /// splits the vector in halves and adds those halves.
3112   bool IsPairwiseReduction;
3113
3114 public:
3115   HorizontalReduction()
3116     : ReductionRoot(nullptr), ReductionPHI(nullptr), ReductionOpcode(0),
3117     ReducedValueOpcode(0), ReduxWidth(0), IsPairwiseReduction(false) {}
3118
3119   /// \brief Try to find a reduction tree.
3120   bool matchAssociativeReduction(PHINode *Phi, BinaryOperator *B,
3121                                  const DataLayout *DL) {
3122     assert((!Phi ||
3123             std::find(Phi->op_begin(), Phi->op_end(), B) != Phi->op_end()) &&
3124            "Thi phi needs to use the binary operator");
3125
3126     // We could have a initial reductions that is not an add.
3127     //  r *= v1 + v2 + v3 + v4
3128     // In such a case start looking for a tree rooted in the first '+'.
3129     if (Phi) {
3130       if (B->getOperand(0) == Phi) {
3131         Phi = nullptr;
3132         B = dyn_cast<BinaryOperator>(B->getOperand(1));
3133       } else if (B->getOperand(1) == Phi) {
3134         Phi = nullptr;
3135         B = dyn_cast<BinaryOperator>(B->getOperand(0));
3136       }
3137     }
3138
3139     if (!B)
3140       return false;
3141
3142     Type *Ty = B->getType();
3143     if (Ty->isVectorTy())
3144       return false;
3145
3146     ReductionOpcode = B->getOpcode();
3147     ReducedValueOpcode = 0;
3148     ReduxWidth = MinVecRegSize / DL->getTypeSizeInBits(Ty);
3149     ReductionRoot = B;
3150     ReductionPHI = Phi;
3151
3152     if (ReduxWidth < 4)
3153       return false;
3154
3155     // We currently only support adds.
3156     if (ReductionOpcode != Instruction::Add &&
3157         ReductionOpcode != Instruction::FAdd)
3158       return false;
3159
3160     // Post order traverse the reduction tree starting at B. We only handle true
3161     // trees containing only binary operators.
3162     SmallVector<std::pair<BinaryOperator *, unsigned>, 32> Stack;
3163     Stack.push_back(std::make_pair(B, 0));
3164     while (!Stack.empty()) {
3165       BinaryOperator *TreeN = Stack.back().first;
3166       unsigned EdgeToVist = Stack.back().second++;
3167       bool IsReducedValue = TreeN->getOpcode() != ReductionOpcode;
3168
3169       // Only handle trees in the current basic block.
3170       if (TreeN->getParent() != B->getParent())
3171         return false;
3172
3173       // Each tree node needs to have one user except for the ultimate
3174       // reduction.
3175       if (!TreeN->hasOneUse() && TreeN != B)
3176         return false;
3177
3178       // Postorder vist.
3179       if (EdgeToVist == 2 || IsReducedValue) {
3180         if (IsReducedValue) {
3181           // Make sure that the opcodes of the operations that we are going to
3182           // reduce match.
3183           if (!ReducedValueOpcode)
3184             ReducedValueOpcode = TreeN->getOpcode();
3185           else if (ReducedValueOpcode != TreeN->getOpcode())
3186             return false;
3187           ReducedVals.push_back(TreeN);
3188         } else {
3189           // We need to be able to reassociate the adds.
3190           if (!TreeN->isAssociative())
3191             return false;
3192           ReductionOps.push_back(TreeN);
3193         }
3194         // Retract.
3195         Stack.pop_back();
3196         continue;
3197       }
3198
3199       // Visit left or right.
3200       Value *NextV = TreeN->getOperand(EdgeToVist);
3201       BinaryOperator *Next = dyn_cast<BinaryOperator>(NextV);
3202       if (Next)
3203         Stack.push_back(std::make_pair(Next, 0));
3204       else if (NextV != Phi)
3205         return false;
3206     }
3207     return true;
3208   }
3209
3210   /// \brief Attempt to vectorize the tree found by
3211   /// matchAssociativeReduction.
3212   bool tryToReduce(BoUpSLP &V, TargetTransformInfo *TTI) {
3213     if (ReducedVals.empty())
3214       return false;
3215
3216     unsigned NumReducedVals = ReducedVals.size();
3217     if (NumReducedVals < ReduxWidth)
3218       return false;
3219
3220     Value *VectorizedTree = nullptr;
3221     IRBuilder<> Builder(ReductionRoot);
3222     FastMathFlags Unsafe;
3223     Unsafe.setUnsafeAlgebra();
3224     Builder.SetFastMathFlags(Unsafe);
3225     unsigned i = 0;
3226
3227     for (; i < NumReducedVals - ReduxWidth + 1; i += ReduxWidth) {
3228       ArrayRef<Value *> ValsToReduce(&ReducedVals[i], ReduxWidth);
3229       V.buildTree(ValsToReduce, ReductionOps);
3230
3231       // Estimate cost.
3232       int Cost = V.getTreeCost() + getReductionCost(TTI, ReducedVals[i]);
3233       if (Cost >= -SLPCostThreshold)
3234         break;
3235
3236       DEBUG(dbgs() << "SLP: Vectorizing horizontal reduction at cost:" << Cost
3237                    << ". (HorRdx)\n");
3238
3239       // Vectorize a tree.
3240       DebugLoc Loc = cast<Instruction>(ReducedVals[i])->getDebugLoc();
3241       Value *VectorizedRoot = V.vectorizeTree();
3242
3243       // Emit a reduction.
3244       Value *ReducedSubTree = emitReduction(VectorizedRoot, Builder);
3245       if (VectorizedTree) {
3246         Builder.SetCurrentDebugLocation(Loc);
3247         VectorizedTree = createBinOp(Builder, ReductionOpcode, VectorizedTree,
3248                                      ReducedSubTree, "bin.rdx");
3249       } else
3250         VectorizedTree = ReducedSubTree;
3251     }
3252
3253     if (VectorizedTree) {
3254       // Finish the reduction.
3255       for (; i < NumReducedVals; ++i) {
3256         Builder.SetCurrentDebugLocation(
3257           cast<Instruction>(ReducedVals[i])->getDebugLoc());
3258         VectorizedTree = createBinOp(Builder, ReductionOpcode, VectorizedTree,
3259                                      ReducedVals[i]);
3260       }
3261       // Update users.
3262       if (ReductionPHI) {
3263         assert(ReductionRoot && "Need a reduction operation");
3264         ReductionRoot->setOperand(0, VectorizedTree);
3265         ReductionRoot->setOperand(1, ReductionPHI);
3266       } else
3267         ReductionRoot->replaceAllUsesWith(VectorizedTree);
3268     }
3269     return VectorizedTree != nullptr;
3270   }
3271
3272 private:
3273
3274   /// \brief Calcuate the cost of a reduction.
3275   int getReductionCost(TargetTransformInfo *TTI, Value *FirstReducedVal) {
3276     Type *ScalarTy = FirstReducedVal->getType();
3277     Type *VecTy = VectorType::get(ScalarTy, ReduxWidth);
3278
3279     int PairwiseRdxCost = TTI->getReductionCost(ReductionOpcode, VecTy, true);
3280     int SplittingRdxCost = TTI->getReductionCost(ReductionOpcode, VecTy, false);
3281
3282     IsPairwiseReduction = PairwiseRdxCost < SplittingRdxCost;
3283     int VecReduxCost = IsPairwiseReduction ? PairwiseRdxCost : SplittingRdxCost;
3284
3285     int ScalarReduxCost =
3286         ReduxWidth * TTI->getArithmeticInstrCost(ReductionOpcode, VecTy);
3287
3288     DEBUG(dbgs() << "SLP: Adding cost " << VecReduxCost - ScalarReduxCost
3289                  << " for reduction that starts with " << *FirstReducedVal
3290                  << " (It is a "
3291                  << (IsPairwiseReduction ? "pairwise" : "splitting")
3292                  << " reduction)\n");
3293
3294     return VecReduxCost - ScalarReduxCost;
3295   }
3296
3297   static Value *createBinOp(IRBuilder<> &Builder, unsigned Opcode, Value *L,
3298                             Value *R, const Twine &Name = "") {
3299     if (Opcode == Instruction::FAdd)
3300       return Builder.CreateFAdd(L, R, Name);
3301     return Builder.CreateBinOp((Instruction::BinaryOps)Opcode, L, R, Name);
3302   }
3303
3304   /// \brief Emit a horizontal reduction of the vectorized value.
3305   Value *emitReduction(Value *VectorizedValue, IRBuilder<> &Builder) {
3306     assert(VectorizedValue && "Need to have a vectorized tree node");
3307     Instruction *ValToReduce = dyn_cast<Instruction>(VectorizedValue);
3308     assert(isPowerOf2_32(ReduxWidth) &&
3309            "We only handle power-of-two reductions for now");
3310
3311     Value *TmpVec = ValToReduce;
3312     for (unsigned i = ReduxWidth / 2; i != 0; i >>= 1) {
3313       if (IsPairwiseReduction) {
3314         Value *LeftMask =
3315           createRdxShuffleMask(ReduxWidth, i, true, true, Builder);
3316         Value *RightMask =
3317           createRdxShuffleMask(ReduxWidth, i, true, false, Builder);
3318
3319         Value *LeftShuf = Builder.CreateShuffleVector(
3320           TmpVec, UndefValue::get(TmpVec->getType()), LeftMask, "rdx.shuf.l");
3321         Value *RightShuf = Builder.CreateShuffleVector(
3322           TmpVec, UndefValue::get(TmpVec->getType()), (RightMask),
3323           "rdx.shuf.r");
3324         TmpVec = createBinOp(Builder, ReductionOpcode, LeftShuf, RightShuf,
3325                              "bin.rdx");
3326       } else {
3327         Value *UpperHalf =
3328           createRdxShuffleMask(ReduxWidth, i, false, false, Builder);
3329         Value *Shuf = Builder.CreateShuffleVector(
3330           TmpVec, UndefValue::get(TmpVec->getType()), UpperHalf, "rdx.shuf");
3331         TmpVec = createBinOp(Builder, ReductionOpcode, TmpVec, Shuf, "bin.rdx");
3332       }
3333     }
3334
3335     // The result is in the first element of the vector.
3336     return Builder.CreateExtractElement(TmpVec, Builder.getInt32(0));
3337   }
3338 };
3339
3340 /// \brief Recognize construction of vectors like
3341 ///  %ra = insertelement <4 x float> undef, float %s0, i32 0
3342 ///  %rb = insertelement <4 x float> %ra, float %s1, i32 1
3343 ///  %rc = insertelement <4 x float> %rb, float %s2, i32 2
3344 ///  %rd = insertelement <4 x float> %rc, float %s3, i32 3
3345 ///
3346 /// Returns true if it matches
3347 ///
3348 static bool findBuildVector(InsertElementInst *FirstInsertElem,
3349                             SmallVectorImpl<Value *> &BuildVector,
3350                             SmallVectorImpl<Value *> &BuildVectorOpds) {
3351   if (!isa<UndefValue>(FirstInsertElem->getOperand(0)))
3352     return false;
3353
3354   InsertElementInst *IE = FirstInsertElem;
3355   while (true) {
3356     BuildVector.push_back(IE);
3357     BuildVectorOpds.push_back(IE->getOperand(1));
3358
3359     if (IE->use_empty())
3360       return false;
3361
3362     InsertElementInst *NextUse = dyn_cast<InsertElementInst>(IE->user_back());
3363     if (!NextUse)
3364       return true;
3365
3366     // If this isn't the final use, make sure the next insertelement is the only
3367     // use. It's OK if the final constructed vector is used multiple times
3368     if (!IE->hasOneUse())
3369       return false;
3370
3371     IE = NextUse;
3372   }
3373
3374   return false;
3375 }
3376
3377 static bool PhiTypeSorterFunc(Value *V, Value *V2) {
3378   return V->getType() < V2->getType();
3379 }
3380
3381 bool SLPVectorizer::vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R) {
3382   bool Changed = false;
3383   SmallVector<Value *, 4> Incoming;
3384   SmallSet<Value *, 16> VisitedInstrs;
3385
3386   bool HaveVectorizedPhiNodes = true;
3387   while (HaveVectorizedPhiNodes) {
3388     HaveVectorizedPhiNodes = false;
3389
3390     // Collect the incoming values from the PHIs.
3391     Incoming.clear();
3392     for (BasicBlock::iterator instr = BB->begin(), ie = BB->end(); instr != ie;
3393          ++instr) {
3394       PHINode *P = dyn_cast<PHINode>(instr);
3395       if (!P)
3396         break;
3397
3398       if (!VisitedInstrs.count(P))
3399         Incoming.push_back(P);
3400     }
3401
3402     // Sort by type.
3403     std::stable_sort(Incoming.begin(), Incoming.end(), PhiTypeSorterFunc);
3404
3405     // Try to vectorize elements base on their type.
3406     for (SmallVector<Value *, 4>::iterator IncIt = Incoming.begin(),
3407                                            E = Incoming.end();
3408          IncIt != E;) {
3409
3410       // Look for the next elements with the same type.
3411       SmallVector<Value *, 4>::iterator SameTypeIt = IncIt;
3412       while (SameTypeIt != E &&
3413              (*SameTypeIt)->getType() == (*IncIt)->getType()) {
3414         VisitedInstrs.insert(*SameTypeIt);
3415         ++SameTypeIt;
3416       }
3417
3418       // Try to vectorize them.
3419       unsigned NumElts = (SameTypeIt - IncIt);
3420       DEBUG(errs() << "SLP: Trying to vectorize starting at PHIs (" << NumElts << ")\n");
3421       if (NumElts > 1 &&
3422           tryToVectorizeList(ArrayRef<Value *>(IncIt, NumElts), R)) {
3423         // Success start over because instructions might have been changed.
3424         HaveVectorizedPhiNodes = true;
3425         Changed = true;
3426         break;
3427       }
3428
3429       // Start over at the next instruction of a different type (or the end).
3430       IncIt = SameTypeIt;
3431     }
3432   }
3433
3434   VisitedInstrs.clear();
3435
3436   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; it++) {
3437     // We may go through BB multiple times so skip the one we have checked.
3438     if (!VisitedInstrs.insert(it))
3439       continue;
3440
3441     if (isa<DbgInfoIntrinsic>(it))
3442       continue;
3443
3444     // Try to vectorize reductions that use PHINodes.
3445     if (PHINode *P = dyn_cast<PHINode>(it)) {
3446       // Check that the PHI is a reduction PHI.
3447       if (P->getNumIncomingValues() != 2)
3448         return Changed;
3449       Value *Rdx =
3450           (P->getIncomingBlock(0) == BB
3451                ? (P->getIncomingValue(0))
3452                : (P->getIncomingBlock(1) == BB ? P->getIncomingValue(1)
3453                                                : nullptr));
3454       // Check if this is a Binary Operator.
3455       BinaryOperator *BI = dyn_cast_or_null<BinaryOperator>(Rdx);
3456       if (!BI)
3457         continue;
3458
3459       // Try to match and vectorize a horizontal reduction.
3460       HorizontalReduction HorRdx;
3461       if (ShouldVectorizeHor &&
3462           HorRdx.matchAssociativeReduction(P, BI, DL) &&
3463           HorRdx.tryToReduce(R, TTI)) {
3464         Changed = true;
3465         it = BB->begin();
3466         e = BB->end();
3467         continue;
3468       }
3469
3470      Value *Inst = BI->getOperand(0);
3471       if (Inst == P)
3472         Inst = BI->getOperand(1);
3473
3474       if (tryToVectorize(dyn_cast<BinaryOperator>(Inst), R)) {
3475         // We would like to start over since some instructions are deleted
3476         // and the iterator may become invalid value.
3477         Changed = true;
3478         it = BB->begin();
3479         e = BB->end();
3480         continue;
3481       }
3482
3483       continue;
3484     }
3485
3486     // Try to vectorize horizontal reductions feeding into a store.
3487     if (ShouldStartVectorizeHorAtStore)
3488       if (StoreInst *SI = dyn_cast<StoreInst>(it))
3489         if (BinaryOperator *BinOp =
3490                 dyn_cast<BinaryOperator>(SI->getValueOperand())) {
3491           HorizontalReduction HorRdx;
3492           if (((HorRdx.matchAssociativeReduction(nullptr, BinOp, DL) &&
3493                 HorRdx.tryToReduce(R, TTI)) ||
3494                tryToVectorize(BinOp, R))) {
3495             Changed = true;
3496             it = BB->begin();
3497             e = BB->end();
3498             continue;
3499           }
3500         }
3501
3502     // Try to vectorize trees that start at compare instructions.
3503     if (CmpInst *CI = dyn_cast<CmpInst>(it)) {
3504       if (tryToVectorizePair(CI->getOperand(0), CI->getOperand(1), R)) {
3505         Changed = true;
3506         // We would like to start over since some instructions are deleted
3507         // and the iterator may become invalid value.
3508         it = BB->begin();
3509         e = BB->end();
3510         continue;
3511       }
3512
3513       for (int i = 0; i < 2; ++i) {
3514         if (BinaryOperator *BI = dyn_cast<BinaryOperator>(CI->getOperand(i))) {
3515           if (tryToVectorizePair(BI->getOperand(0), BI->getOperand(1), R)) {
3516             Changed = true;
3517             // We would like to start over since some instructions are deleted
3518             // and the iterator may become invalid value.
3519             it = BB->begin();
3520             e = BB->end();
3521           }
3522         }
3523       }
3524       continue;
3525     }
3526
3527     // Try to vectorize trees that start at insertelement instructions.
3528     if (InsertElementInst *FirstInsertElem = dyn_cast<InsertElementInst>(it)) {
3529       SmallVector<Value *, 16> BuildVector;
3530       SmallVector<Value *, 16> BuildVectorOpds;
3531       if (!findBuildVector(FirstInsertElem, BuildVector, BuildVectorOpds))
3532         continue;
3533
3534       // Vectorize starting with the build vector operands ignoring the
3535       // BuildVector instructions for the purpose of scheduling and user
3536       // extraction.
3537       if (tryToVectorizeList(BuildVectorOpds, R, BuildVector)) {
3538         Changed = true;
3539         it = BB->begin();
3540         e = BB->end();
3541       }
3542
3543       continue;
3544     }
3545   }
3546
3547   return Changed;
3548 }
3549
3550 bool SLPVectorizer::vectorizeStoreChains(BoUpSLP &R) {
3551   bool Changed = false;
3552   // Attempt to sort and vectorize each of the store-groups.
3553   for (StoreListMap::iterator it = StoreRefs.begin(), e = StoreRefs.end();
3554        it != e; ++it) {
3555     if (it->second.size() < 2)
3556       continue;
3557
3558     DEBUG(dbgs() << "SLP: Analyzing a store chain of length "
3559           << it->second.size() << ".\n");
3560
3561     // Process the stores in chunks of 16.
3562     for (unsigned CI = 0, CE = it->second.size(); CI < CE; CI+=16) {
3563       unsigned Len = std::min<unsigned>(CE - CI, 16);
3564       ArrayRef<StoreInst *> Chunk(&it->second[CI], Len);
3565       Changed |= vectorizeStores(Chunk, -SLPCostThreshold, R);
3566     }
3567   }
3568   return Changed;
3569 }
3570
3571 } // end anonymous namespace
3572
3573 char SLPVectorizer::ID = 0;
3574 static const char lv_name[] = "SLP Vectorizer";
3575 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false)
3576 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
3577 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
3578 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
3579 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
3580 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false)
3581
3582 namespace llvm {
3583 Pass *createSLPVectorizerPass() { return new SLPVectorizer(); }
3584 }