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 #define SV_NAME "slp-vectorizer"
  19 #define DEBUG_TYPE "SLP"
  20
  21 #include "llvm/Transforms/Vectorize.h"
  22 #include "llvm/ADT/MapVector.h"
  23 #include "llvm/ADT/PostOrderIterator.h"
  24 #include "llvm/ADT/SetVector.h"
  25 #include "llvm/Analysis/AliasAnalysis.h"
  26 #include "llvm/Analysis/LoopInfo.h"
  27 #include "llvm/Analysis/ScalarEvolution.h"
  28 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  29 #include "llvm/Analysis/TargetTransformInfo.h"
  30 #include "llvm/Analysis/ValueTracking.h"
  31 #include "llvm/IR/DataLayout.h"
  32 #include "llvm/IR/Dominators.h"
  33 #include "llvm/IR/IRBuilder.h"
  34 #include "llvm/IR/Instructions.h"
  35 #include "llvm/IR/IntrinsicInst.h"
  36 #include "llvm/IR/Module.h"
  37 #include "llvm/IR/Type.h"
  38 #include "llvm/IR/Value.h"
  39 #include "llvm/IR/Verifier.h"
  40 #include "llvm/Pass.h"
  41 #include "llvm/Support/CommandLine.h"
  42 #include "llvm/Support/Debug.h"
  43 #include "llvm/Support/raw_ostream.h"
  44 #include <algorithm>
  45 #include <map>
  46
  47 using namespace llvm;
  48
  49 static cl::opt<int>
  50     SLPCostThreshold("slp-threshold", cl::init(0), cl::Hidden,
  51                      cl::desc("Only vectorize if you gain more than this "
  52                               "number "));
  53
  54 static cl::opt<bool>
  55 ShouldVectorizeHor("slp-vectorize-hor", cl::init(false), cl::Hidden,
  56                    cl::desc("Attempt to vectorize horizontal reductions"));
  57
  58 static cl::opt<bool> ShouldStartVectorizeHorAtStore(
  59     "slp-vectorize-hor-store", cl::init(false), cl::Hidden,
  60     cl::desc(
  61         "Attempt to vectorize horizontal reductions feeding into a store"));
  62
  63 namespace {
  64
  65 static const unsigned MinVecRegSize = 128;
  66
  67 static const unsigned RecursionMaxDepth = 12;
  68
  69 /// A helper class for numbering instructions in multiple blocks.
  70 /// Numbers start at zero for each basic block.
  71 struct BlockNumbering {
  72
  73   BlockNumbering(BasicBlock *Bb) : BB(Bb), Valid(false) {}
  74
  75   BlockNumbering() : BB(0), Valid(false) {}
  76
  77   void numberInstructions() {
  78     unsigned Loc = 0;
  79     InstrIdx.clear();
  80     InstrVec.clear();
  81     // Number the instructions in the block.
  82     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
  83       InstrIdx[it] = Loc++;
  84       InstrVec.push_back(it);
  85       assert(InstrVec[InstrIdx[it]] == it && "Invalid allocation");
  86     }
  87     Valid = true;
  88   }
  89
  90   int getIndex(Instruction *I) {
  91     assert(I->getParent() == BB && "Invalid instruction");
  92     if (!Valid)
  93       numberInstructions();
  94     assert(InstrIdx.count(I) && "Unknown instruction");
  95     return InstrIdx[I];
  96   }
  97
  98   Instruction *getInstruction(unsigned loc) {
  99     if (!Valid)
 100       numberInstructions();
 101     assert(InstrVec.size() > loc && "Invalid Index");
 102     return InstrVec[loc];
 103   }
 104
 105   void forget() { Valid = false; }
 106
 107 private:
 108   /// The block we are numbering.
 109   BasicBlock *BB;
 110   /// Is the block numbered.
 111   bool Valid;
 112   /// Maps instructions to numbers and back.
 113   SmallDenseMap<Instruction *, int> InstrIdx;
 114   /// Maps integers to Instructions.
 115   SmallVector<Instruction *, 32> InstrVec;
 116 };
 117
 118 /// \returns the parent basic block if all of the instructions in \p VL
 119 /// are in the same block or null otherwise.
 120 static BasicBlock *getSameBlock(ArrayRef<Value *> VL) {
 121   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
 122   if (!I0)
 123     return 0;
 124   BasicBlock *BB = I0->getParent();
 125   for (int i = 1, e = VL.size(); i < e; i++) {
 126     Instruction *I = dyn_cast<Instruction>(VL[i]);
 127     if (!I)
 128       return 0;
 129
 130     if (BB != I->getParent())
 131       return 0;
 132   }
 133   return BB;
 134 }
 135
 136 /// \returns True if all of the values in \p VL are constants.
 137 static bool allConstant(ArrayRef<Value *> VL) {
 138   for (unsigned i = 0, e = VL.size(); i < e; ++i)
 139     if (!isa<Constant>(VL[i]))
 140       return false;
 141   return true;
 142 }
 143
 144 /// \returns True if all of the values in \p VL are identical.
 145 static bool isSplat(ArrayRef<Value *> VL) {
 146   for (unsigned i = 1, e = VL.size(); i < e; ++i)
 147     if (VL[i] != VL[0])
 148       return false;
 149   return true;
 150 }
 151
 152 /// \returns The opcode if all of the Instructions in \p VL have the same
 153 /// opcode, or zero.
 154 static unsigned getSameOpcode(ArrayRef<Value *> VL) {
 155   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
 156   if (!I0)
 157     return 0;
 158   unsigned Opcode = I0->getOpcode();
 159   for (int i = 1, e = VL.size(); i < e; i++) {
 160     Instruction *I = dyn_cast<Instruction>(VL[i]);
 161     if (!I || Opcode != I->getOpcode())
 162       return 0;
 163   }
 164   return Opcode;
 165 }
 166
 167 /// \returns \p I after propagating metadata from \p VL.
 168 static Instruction *propagateMetadata(Instruction *I, ArrayRef<Value *> VL) {
 169   Instruction *I0 = cast<Instruction>(VL[0]);
 170   SmallVector<std::pair<unsigned, MDNode *>, 4> Metadata;
 171   I0->getAllMetadataOtherThanDebugLoc(Metadata);
 172
 173   for (unsigned i = 0, n = Metadata.size(); i != n; ++i) {
 174     unsigned Kind = Metadata[i].first;
 175     MDNode *MD = Metadata[i].second;
 176
 177     for (int i = 1, e = VL.size(); MD && i != e; i++) {
 178       Instruction *I = cast<Instruction>(VL[i]);
 179       MDNode *IMD = I->getMetadata(Kind);
 180
 181       switch (Kind) {
 182       default:
 183         MD = 0; // Remove unknown metadata
 184         break;
 185       case LLVMContext::MD_tbaa:
 186         MD = MDNode::getMostGenericTBAA(MD, IMD);
 187         break;
 188       case LLVMContext::MD_fpmath:
 189         MD = MDNode::getMostGenericFPMath(MD, IMD);
 190         break;
 191       }
 192     }
 193     I->setMetadata(Kind, MD);
 194   }
 195   return I;
 196 }
 197
 198 /// \returns The type that all of the values in \p VL have or null if there
 199 /// are different types.
 200 static Type* getSameType(ArrayRef<Value *> VL) {
 201   Type *Ty = VL[0]->getType();
 202   for (int i = 1, e = VL.size(); i < e; i++)
 203     if (VL[i]->getType() != Ty)
 204       return 0;
 205
 206   return Ty;
 207 }
 208
 209 /// \returns True if the ExtractElement instructions in VL can be vectorized
 210 /// to use the original vector.
 211 static bool CanReuseExtract(ArrayRef<Value *> VL) {
 212   assert(Instruction::ExtractElement == getSameOpcode(VL) && "Invalid opcode");
 213   // Check if all of the extracts come from the same vector and from the
 214   // correct offset.
 215   Value *VL0 = VL[0];
 216   ExtractElementInst *E0 = cast<ExtractElementInst>(VL0);
 217   Value *Vec = E0->getOperand(0);
 218
 219   // We have to extract from the same vector type.
 220   unsigned NElts = Vec->getType()->getVectorNumElements();
 221
 222   if (NElts != VL.size())
 223     return false;
 224
 225   // Check that all of the indices extract from the correct offset.
 226   ConstantInt *CI = dyn_cast<ConstantInt>(E0->getOperand(1));
 227   if (!CI || CI->getZExtValue())
 228     return false;
 229
 230   for (unsigned i = 1, e = VL.size(); i < e; ++i) {
 231     ExtractElementInst *E = cast<ExtractElementInst>(VL[i]);
 232     ConstantInt *CI = dyn_cast<ConstantInt>(E->getOperand(1));
 233
 234     if (!CI || CI->getZExtValue() != i || E->getOperand(0) != Vec)
 235       return false;
 236   }
 237
 238   return true;
 239 }
 240
 241 static void reorderInputsAccordingToOpcode(ArrayRef<Value *> VL,
 242                                            SmallVectorImpl<Value *> &Left,
 243                                            SmallVectorImpl<Value *> &Right) {
 244
 245   SmallVector<Value *, 16> OrigLeft, OrigRight;
 246
 247   bool AllSameOpcodeLeft = true;
 248   bool AllSameOpcodeRight = true;
 249   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 250     Instruction *I = cast<Instruction>(VL[i]);
 251     Value *V0 = I->getOperand(0);
 252     Value *V1 = I->getOperand(1);
 253
 254     OrigLeft.push_back(V0);
 255     OrigRight.push_back(V1);
 256
 257     Instruction *I0 = dyn_cast<Instruction>(V0);
 258     Instruction *I1 = dyn_cast<Instruction>(V1);
 259
 260     // Check whether all operands on one side have the same opcode. In this case
 261     // we want to preserve the original order and not make things worse by
 262     // reordering.
 263     AllSameOpcodeLeft = I0;
 264     AllSameOpcodeRight = I1;
 265
 266     if (i && AllSameOpcodeLeft) {
 267       if(Instruction *P0 = dyn_cast<Instruction>(OrigLeft[i-1])) {
 268         if(P0->getOpcode() != I0->getOpcode())
 269           AllSameOpcodeLeft = false;
 270       } else
 271         AllSameOpcodeLeft = false;
 272     }
 273     if (i && AllSameOpcodeRight) {
 274       if(Instruction *P1 = dyn_cast<Instruction>(OrigRight[i-1])) {
 275         if(P1->getOpcode() != I1->getOpcode())
 276           AllSameOpcodeRight = false;
 277       } else
 278         AllSameOpcodeRight = false;
 279     }
 280
 281     // Sort two opcodes. In the code below we try to preserve the ability to use
 282     // broadcast of values instead of individual inserts.
 283     // vl1 = load
 284     // vl2 = phi
 285     // vr1 = load
 286     // vr2 = vr2
 287     //    = vl1 x vr1
 288     //    = vl2 x vr2
 289     // If we just sorted according to opcode we would leave the first line in
 290     // tact but we would swap vl2 with vr2 because opcode(phi) > opcode(load).
 291     //    = vl1 x vr1
 292     //    = vr2 x vl2
 293     // Because vr2 and vr1 are from the same load we loose the opportunity of a
 294     // broadcast for the packed right side in the backend: we have [vr1, vl2]
 295     // instead of [vr1, vr2=vr1].
 296     if (I0 && I1) {
 297        if(!i && I0->getOpcode() > I1->getOpcode()) {
 298          Left.push_back(I1);
 299          Right.push_back(I0);
 300        } else if (i && I0->getOpcode() > I1->getOpcode() && Right[i-1] != I1) {
 301          // Try not to destroy a broad cast for no apparent benefit.
 302          Left.push_back(I1);
 303          Right.push_back(I0);
 304        } else if (i && I0->getOpcode() == I1->getOpcode() && Right[i-1] ==  I0) {
 305          // Try preserve broadcasts.
 306          Left.push_back(I1);
 307          Right.push_back(I0);
 308        } else if (i && I0->getOpcode() == I1->getOpcode() && Left[i-1] == I1) {
 309          // Try preserve broadcasts.
 310          Left.push_back(I1);
 311          Right.push_back(I0);
 312        } else {
 313          Left.push_back(I0);
 314          Right.push_back(I1);
 315        }
 316        continue;
 317     }
 318     // One opcode, put the instruction on the right.
 319     if (I0) {
 320       Left.push_back(V1);
 321       Right.push_back(I0);
 322       continue;
 323     }
 324     Left.push_back(V0);
 325     Right.push_back(V1);
 326   }
 327
 328   bool LeftBroadcast = isSplat(Left);
 329   bool RightBroadcast = isSplat(Right);
 330
 331   // Don't reorder if the operands where good to begin with.
 332   if (!(LeftBroadcast || RightBroadcast) &&
 333       (AllSameOpcodeRight || AllSameOpcodeLeft)) {
 334     Left = OrigLeft;
 335     Right = OrigRight;
 336   }
 337 }
 338
 339 /// Bottom Up SLP Vectorizer.
 340 class BoUpSLP {
 341 public:
 342   typedef SmallVector<Value *, 8> ValueList;
 343   typedef SmallVector<Instruction *, 16> InstrList;
 344   typedef SmallPtrSet<Value *, 16> ValueSet;
 345   typedef SmallVector<StoreInst *, 8> StoreList;
 346
 347   BoUpSLP(Function *Func, ScalarEvolution *Se, DataLayout *Dl,
 348           TargetTransformInfo *Tti, AliasAnalysis *Aa, LoopInfo *Li,
 349           DominatorTree *Dt) :
 350     F(Func), SE(Se), DL(Dl), TTI(Tti), AA(Aa), LI(Li), DT(Dt),
 351     Builder(Se->getContext()) {
 352       // Setup the block numbering utility for all of the blocks in the
 353       // function.
 354       for (Function::iterator it = F->begin(), e = F->end(); it != e; ++it) {
 355         BasicBlock *BB = it;
 356         BlocksNumbers[BB] = BlockNumbering(BB);
 357       }
 358     }
 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 vectorization cost of the subtree that starts at \p VL.
 365   /// A negative number means that this is profitable.
 366   int getTreeCost();
 367
 368   /// Construct a vectorizable tree that starts at \p Roots and is possibly
 369   /// used by a reduction of \p RdxOps.
 370   void buildTree(ArrayRef<Value *> Roots, ValueSet *RdxOps = 0);
 371
 372   /// Clear the internal data structures that are created by 'buildTree'.
 373   void deleteTree() {
 374     RdxOps = 0;
 375     VectorizableTree.clear();
 376     ScalarToTreeEntry.clear();
 377     MustGather.clear();
 378     ExternalUses.clear();
 379     MemBarrierIgnoreList.clear();
 380   }
 381
 382   /// \returns true if the memory operations A and B are consecutive.
 383   bool isConsecutiveAccess(Value *A, Value *B);
 384
 385   /// \brief Perform LICM and CSE on the newly generated gather sequences.
 386   void optimizeGatherSequence();
 387 private:
 388   struct TreeEntry;
 389
 390   /// \returns the cost of the vectorizable entry.
 391   int getEntryCost(TreeEntry *E);
 392
 393   /// This is the recursive part of buildTree.
 394   void buildTree_rec(ArrayRef<Value *> Roots, unsigned Depth);
 395
 396   /// Vectorize a single entry in the tree.
 397   Value *vectorizeTree(TreeEntry *E);
 398
 399   /// Vectorize a single entry in the tree, starting in \p VL.
 400   Value *vectorizeTree(ArrayRef<Value *> VL);
 401
 402   /// \returns the pointer to the vectorized value if \p VL is already
 403   /// vectorized, or NULL. They may happen in cycles.
 404   Value *alreadyVectorized(ArrayRef<Value *> VL) const;
 405
 406   /// \brief Take the pointer operand from the Load/Store instruction.
 407   /// \returns NULL if this is not a valid Load/Store instruction.
 408   static Value *getPointerOperand(Value *I);
 409
 410   /// \brief Take the address space operand from the Load/Store instruction.
 411   /// \returns -1 if this is not a valid Load/Store instruction.
 412   static unsigned getAddressSpaceOperand(Value *I);
 413
 414   /// \returns the scalarization cost for this type. Scalarization in this
 415   /// context means the creation of vectors from a group of scalars.
 416   int getGatherCost(Type *Ty);
 417
 418   /// \returns the scalarization cost for this list of values. Assuming that
 419   /// this subtree gets vectorized, we may need to extract the values from the
 420   /// roots. This method calculates the cost of extracting the values.
 421   int getGatherCost(ArrayRef<Value *> VL);
 422
 423   /// \returns the AA location that is being access by the instruction.
 424   AliasAnalysis::Location getLocation(Instruction *I);
 425
 426   /// \brief Checks if it is possible to sink an instruction from
 427   /// \p Src to \p Dst.
 428   /// \returns the pointer to the barrier instruction if we can't sink.
 429   Value *getSinkBarrier(Instruction *Src, Instruction *Dst);
 430
 431   /// \returns the index of the last instruction in the BB from \p VL.
 432   int getLastIndex(ArrayRef<Value *> VL);
 433
 434   /// \returns the Instruction in the bundle \p VL.
 435   Instruction *getLastInstruction(ArrayRef<Value *> VL);
 436
 437   /// \brief Set the Builder insert point to one after the last instruction in
 438   /// the bundle
 439   void setInsertPointAfterBundle(ArrayRef<Value *> VL);
 440
 441   /// \returns a vector from a collection of scalars in \p VL.
 442   Value *Gather(ArrayRef<Value *> VL, VectorType *Ty);
 443
 444   /// \returns whether the VectorizableTree is fully vectoriable and will
 445   /// be beneficial even the tree height is tiny.
 446   bool isFullyVectorizableTinyTree();
 447
 448   struct TreeEntry {
 449     TreeEntry() : Scalars(), VectorizedValue(0), LastScalarIndex(0),
 450     NeedToGather(0) {}
 451
 452     /// \returns true if the scalars in VL are equal to this entry.
 453     bool isSame(ArrayRef<Value *> VL) const {
 454       assert(VL.size() == Scalars.size() && "Invalid size");
 455       return std::equal(VL.begin(), VL.end(), Scalars.begin());
 456     }
 457
 458     /// A vector of scalars.
 459     ValueList Scalars;
 460
 461     /// The Scalars are vectorized into this value. It is initialized to Null.
 462     Value *VectorizedValue;
 463
 464     /// The index in the basic block of the last scalar.
 465     int LastScalarIndex;
 466
 467     /// Do we need to gather this sequence ?
 468     bool NeedToGather;
 469   };
 470
 471   /// Create a new VectorizableTree entry.
 472   TreeEntry *newTreeEntry(ArrayRef<Value *> VL, bool Vectorized) {
 473     VectorizableTree.push_back(TreeEntry());
 474     int idx = VectorizableTree.size() - 1;
 475     TreeEntry *Last = &VectorizableTree[idx];
 476     Last->Scalars.insert(Last->Scalars.begin(), VL.begin(), VL.end());
 477     Last->NeedToGather = !Vectorized;
 478     if (Vectorized) {
 479       Last->LastScalarIndex = getLastIndex(VL);
 480       for (int i = 0, e = VL.size(); i != e; ++i) {
 481         assert(!ScalarToTreeEntry.count(VL[i]) && "Scalar already in tree!");
 482         ScalarToTreeEntry[VL[i]] = idx;
 483       }
 484     } else {
 485       Last->LastScalarIndex = 0;
 486       MustGather.insert(VL.begin(), VL.end());
 487     }
 488     return Last;
 489   }
 490
 491   /// -- Vectorization State --
 492   /// Holds all of the tree entries.
 493   std::vector<TreeEntry> VectorizableTree;
 494
 495   /// Maps a specific scalar to its tree entry.
 496   SmallDenseMap<Value*, int> ScalarToTreeEntry;
 497
 498   /// A list of scalars that we found that we need to keep as scalars.
 499   ValueSet MustGather;
 500
 501   /// This POD struct describes one external user in the vectorized tree.
 502   struct ExternalUser {
 503     ExternalUser (Value *S, llvm::User *U, int L) :
 504       Scalar(S), User(U), Lane(L){};
 505     // Which scalar in our function.
 506     Value *Scalar;
 507     // Which user that uses the scalar.
 508     llvm::User *User;
 509     // Which lane does the scalar belong to.
 510     int Lane;
 511   };
 512   typedef SmallVector<ExternalUser, 16> UserList;
 513
 514   /// A list of values that need to extracted out of the tree.
 515   /// This list holds pairs of (Internal Scalar : External User).
 516   UserList ExternalUses;
 517
 518   /// A list of instructions to ignore while sinking
 519   /// memory instructions. This map must be reset between runs of getCost.
 520   ValueSet MemBarrierIgnoreList;
 521
 522   /// Holds all of the instructions that we gathered.
 523   SetVector<Instruction *> GatherSeq;
 524   /// A list of blocks that we are going to CSE.
 525   SetVector<BasicBlock *> CSEBlocks;
 526
 527   /// Numbers instructions in different blocks.
 528   DenseMap<BasicBlock *, BlockNumbering> BlocksNumbers;
 529
 530   /// Reduction operators.
 531   ValueSet *RdxOps;
 532
 533   // Analysis and block reference.
 534   Function *F;
 535   ScalarEvolution *SE;
 536   DataLayout *DL;
 537   TargetTransformInfo *TTI;
 538   AliasAnalysis *AA;
 539   LoopInfo *LI;
 540   DominatorTree *DT;
 541   /// Instruction builder to construct the vectorized tree.
 542   IRBuilder<> Builder;
 543 };
 544
 545 void BoUpSLP::buildTree(ArrayRef<Value *> Roots, ValueSet *Rdx) {
 546   deleteTree();
 547   RdxOps = Rdx;
 548   if (!getSameType(Roots))
 549     return;
 550   buildTree_rec(Roots, 0);
 551
 552   // Collect the values that we need to extract from the tree.
 553   for (int EIdx = 0, EE = VectorizableTree.size(); EIdx < EE; ++EIdx) {
 554     TreeEntry *Entry = &VectorizableTree[EIdx];
 555
 556     // For each lane:
 557     for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) {
 558       Value *Scalar = Entry->Scalars[Lane];
 559
 560       // No need to handle users of gathered values.
 561       if (Entry->NeedToGather)
 562         continue;
 563
 564       for (Value::use_iterator User = Scalar->use_begin(),
 565            UE = Scalar->use_end(); User != UE; ++User) {
 566         DEBUG(dbgs() << "SLP: Checking user:" << **User << ".\n");
 567
 568         // Skip in-tree scalars that become vectors.
 569         if (ScalarToTreeEntry.count(*User)) {
 570           DEBUG(dbgs() << "SLP: \tInternal user will be removed:" <<
 571                 **User << ".\n");
 572           int Idx = ScalarToTreeEntry[*User]; (void) Idx;
 573           assert(!VectorizableTree[Idx].NeedToGather && "Bad state");
 574           continue;
 575         }
 576         Instruction *UserInst = dyn_cast<Instruction>(*User);
 577         if (!UserInst)
 578           continue;
 579
 580         // Ignore uses that are part of the reduction.
 581         if (Rdx && std::find(Rdx->begin(), Rdx->end(), UserInst) != Rdx->end())
 582           continue;
 583
 584         DEBUG(dbgs() << "SLP: Need to extract:" << **User << " from lane " <<
 585               Lane << " from " << *Scalar << ".\n");
 586         ExternalUses.push_back(ExternalUser(Scalar, *User, Lane));
 587       }
 588     }
 589   }
 590 }
 591
 592
 593 void BoUpSLP::buildTree_rec(ArrayRef<Value *> VL, unsigned Depth) {
 594   bool SameTy = getSameType(VL); (void)SameTy;
 595   assert(SameTy && "Invalid types!");
 596
 597   if (Depth == RecursionMaxDepth) {
 598     DEBUG(dbgs() << "SLP: Gathering due to max recursion depth.\n");
 599     newTreeEntry(VL, false);
 600     return;
 601   }
 602
 603   // Don't handle vectors.
 604   if (VL[0]->getType()->isVectorTy()) {
 605     DEBUG(dbgs() << "SLP: Gathering due to vector type.\n");
 606     newTreeEntry(VL, false);
 607     return;
 608   }
 609
 610   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
 611     if (SI->getValueOperand()->getType()->isVectorTy()) {
 612       DEBUG(dbgs() << "SLP: Gathering due to store vector type.\n");
 613       newTreeEntry(VL, false);
 614       return;
 615     }
 616
 617   // If all of the operands are identical or constant we have a simple solution.
 618   if (allConstant(VL) || isSplat(VL) || !getSameBlock(VL) ||
 619       !getSameOpcode(VL)) {
 620     DEBUG(dbgs() << "SLP: Gathering due to C,S,B,O. \n");
 621     newTreeEntry(VL, false);
 622     return;
 623   }
 624
 625   // We now know that this is a vector of instructions of the same type from
 626   // the same block.
 627
 628   // Check if this is a duplicate of another entry.
 629   if (ScalarToTreeEntry.count(VL[0])) {
 630     int Idx = ScalarToTreeEntry[VL[0]];
 631     TreeEntry *E = &VectorizableTree[Idx];
 632     for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 633       DEBUG(dbgs() << "SLP: \tChecking bundle: " << *VL[i] << ".\n");
 634       if (E->Scalars[i] != VL[i]) {
 635         DEBUG(dbgs() << "SLP: Gathering due to partial overlap.\n");
 636         newTreeEntry(VL, false);
 637         return;
 638       }
 639     }
 640     DEBUG(dbgs() << "SLP: Perfect diamond merge at " << *VL[0] << ".\n");
 641     return;
 642   }
 643
 644   // Check that none of the instructions in the bundle are already in the tree.
 645   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 646     if (ScalarToTreeEntry.count(VL[i])) {
 647       DEBUG(dbgs() << "SLP: The instruction (" << *VL[i] <<
 648             ") is already in tree.\n");
 649       newTreeEntry(VL, false);
 650       return;
 651     }
 652   }
 653
 654   // If any of the scalars appears in the table OR it is marked as a value that
 655   // needs to stat scalar then we need to gather the scalars.
 656   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 657     if (ScalarToTreeEntry.count(VL[i]) || MustGather.count(VL[i])) {
 658       DEBUG(dbgs() << "SLP: Gathering due to gathered scalar. \n");
 659       newTreeEntry(VL, false);
 660       return;
 661     }
 662   }
 663
 664   // Check that all of the users of the scalars that we want to vectorize are
 665   // schedulable.
 666   Instruction *VL0 = cast<Instruction>(VL[0]);
 667   int MyLastIndex = getLastIndex(VL);
 668   BasicBlock *BB = cast<Instruction>(VL0)->getParent();
 669
 670   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 671     Instruction *Scalar = cast<Instruction>(VL[i]);
 672     DEBUG(dbgs() << "SLP: Checking users of  " << *Scalar << ". \n");
 673     for (Value::use_iterator U = Scalar->use_begin(), UE = Scalar->use_end();
 674          U != UE; ++U) {
 675       DEBUG(dbgs() << "SLP: \tUser " << **U << ". \n");
 676       Instruction *User = dyn_cast<Instruction>(*U);
 677       if (!User) {
 678         DEBUG(dbgs() << "SLP: Gathering due unknown user. \n");
 679         newTreeEntry(VL, false);
 680         return;
 681       }
 682
 683       // We don't care if the user is in a different basic block.
 684       BasicBlock *UserBlock = User->getParent();
 685       if (UserBlock != BB) {
 686         DEBUG(dbgs() << "SLP: User from a different basic block "
 687               << *User << ". \n");
 688         continue;
 689       }
 690
 691       // If this is a PHINode within this basic block then we can place the
 692       // extract wherever we want.
 693       if (isa<PHINode>(*User)) {
 694         DEBUG(dbgs() << "SLP: \tWe can schedule PHIs:" << *User << ". \n");
 695         continue;
 696       }
 697
 698       // Check if this is a safe in-tree user.
 699       if (ScalarToTreeEntry.count(User)) {
 700         int Idx = ScalarToTreeEntry[User];
 701         int VecLocation = VectorizableTree[Idx].LastScalarIndex;
 702         if (VecLocation <= MyLastIndex) {
 703           DEBUG(dbgs() << "SLP: Gathering due to unschedulable vector. \n");
 704           newTreeEntry(VL, false);
 705           return;
 706         }
 707         DEBUG(dbgs() << "SLP: In-tree user (" << *User << ") at #" <<
 708               VecLocation << " vector value (" << *Scalar << ") at #"
 709               << MyLastIndex << ".\n");
 710         continue;
 711       }
 712
 713       // This user is part of the reduction.
 714       if (RdxOps && RdxOps->count(User))
 715         continue;
 716
 717       // Make sure that we can schedule this unknown user.
 718       BlockNumbering &BN = BlocksNumbers[BB];
 719       int UserIndex = BN.getIndex(User);
 720       if (UserIndex < MyLastIndex) {
 721
 722         DEBUG(dbgs() << "SLP: Can't schedule extractelement for "
 723               << *User << ". \n");
 724         newTreeEntry(VL, false);
 725         return;
 726       }
 727     }
 728   }
 729
 730   // Check that every instructions appears once in this bundle.
 731   for (unsigned i = 0, e = VL.size(); i < e; ++i)
 732     for (unsigned j = i+1; j < e; ++j)
 733       if (VL[i] == VL[j]) {
 734         DEBUG(dbgs() << "SLP: Scalar used twice in bundle.\n");
 735         newTreeEntry(VL, false);
 736         return;
 737       }
 738
 739   // Check that instructions in this bundle don't reference other instructions.
 740   // The runtime of this check is O(N * N-1 * uses(N)) and a typical N is 4.
 741   for (unsigned i = 0, e = VL.size(); i < e; ++i) {
 742     for (Value::use_iterator U = VL[i]->use_begin(), UE = VL[i]->use_end();
 743          U != UE; ++U) {
 744       for (unsigned j = 0; j < e; ++j) {
 745         if (i != j && *U == VL[j]) {
 746           DEBUG(dbgs() << "SLP: Intra-bundle dependencies!" << **U << ". \n");
 747           newTreeEntry(VL, false);
 748           return;
 749         }
 750       }
 751     }
 752   }
 753
 754   DEBUG(dbgs() << "SLP: We are able to schedule this bundle.\n");
 755
 756   unsigned Opcode = getSameOpcode(VL);
 757
 758   // Check if it is safe to sink the loads or the stores.
 759   if (Opcode == Instruction::Load || Opcode == Instruction::Store) {
 760     Instruction *Last = getLastInstruction(VL);
 761
 762     for (unsigned i = 0, e = VL.size(); i < e; ++i) {
 763       if (VL[i] == Last)
 764         continue;
 765       Value *Barrier = getSinkBarrier(cast<Instruction>(VL[i]), Last);
 766       if (Barrier) {
 767         DEBUG(dbgs() << "SLP: Can't sink " << *VL[i] << "\n down to " << *Last
 768               << "\n because of " << *Barrier << ".  Gathering.\n");
 769         newTreeEntry(VL, false);
 770         return;
 771       }
 772     }
 773   }
 774
 775   switch (Opcode) {
 776     case Instruction::PHI: {
 777       PHINode *PH = dyn_cast<PHINode>(VL0);
 778
 779       // Check for terminator values (e.g. invoke).
 780       for (unsigned j = 0; j < VL.size(); ++j)
 781         for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
 782           TerminatorInst *Term = dyn_cast<TerminatorInst>(
 783               cast<PHINode>(VL[j])->getIncomingValueForBlock(PH->getIncomingBlock(i)));
 784           if (Term) {
 785             DEBUG(dbgs() << "SLP: Need to swizzle PHINodes (TerminatorInst use).\n");
 786             newTreeEntry(VL, false);
 787             return;
 788           }
 789         }
 790
 791       newTreeEntry(VL, true);
 792       DEBUG(dbgs() << "SLP: added a vector of PHINodes.\n");
 793
 794       for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
 795         ValueList Operands;
 796         // Prepare the operand vector.
 797         for (unsigned j = 0; j < VL.size(); ++j)
 798           Operands.push_back(cast<PHINode>(VL[j])->getIncomingValueForBlock(
 799               PH->getIncomingBlock(i)));
 800
 801         buildTree_rec(Operands, Depth + 1);
 802       }
 803       return;
 804     }
 805     case Instruction::ExtractElement: {
 806       bool Reuse = CanReuseExtract(VL);
 807       if (Reuse) {
 808         DEBUG(dbgs() << "SLP: Reusing extract sequence.\n");
 809       }
 810       newTreeEntry(VL, Reuse);
 811       return;
 812     }
 813     case Instruction::Load: {
 814       // Check if the loads are consecutive or of we need to swizzle them.
 815       for (unsigned i = 0, e = VL.size() - 1; i < e; ++i) {
 816         LoadInst *L = cast<LoadInst>(VL[i]);
 817         if (!L->isSimple() || !isConsecutiveAccess(VL[i], VL[i + 1])) {
 818           newTreeEntry(VL, false);
 819           DEBUG(dbgs() << "SLP: Need to swizzle loads.\n");
 820           return;
 821         }
 822       }
 823       newTreeEntry(VL, true);
 824       DEBUG(dbgs() << "SLP: added a vector of loads.\n");
 825       return;
 826     }
 827     case Instruction::ZExt:
 828     case Instruction::SExt:
 829     case Instruction::FPToUI:
 830     case Instruction::FPToSI:
 831     case Instruction::FPExt:
 832     case Instruction::PtrToInt:
 833     case Instruction::IntToPtr:
 834     case Instruction::SIToFP:
 835     case Instruction::UIToFP:
 836     case Instruction::Trunc:
 837     case Instruction::FPTrunc:
 838     case Instruction::BitCast: {
 839       Type *SrcTy = VL0->getOperand(0)->getType();
 840       for (unsigned i = 0; i < VL.size(); ++i) {
 841         Type *Ty = cast<Instruction>(VL[i])->getOperand(0)->getType();
 842         if (Ty != SrcTy || Ty->isAggregateType() || Ty->isVectorTy()) {
 843           newTreeEntry(VL, false);
 844           DEBUG(dbgs() << "SLP: Gathering casts with different src types.\n");
 845           return;
 846         }
 847       }
 848       newTreeEntry(VL, true);
 849       DEBUG(dbgs() << "SLP: added a vector of casts.\n");
 850
 851       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
 852         ValueList Operands;
 853         // Prepare the operand vector.
 854         for (unsigned j = 0; j < VL.size(); ++j)
 855           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
 856
 857         buildTree_rec(Operands, Depth+1);
 858       }
 859       return;
 860     }
 861     case Instruction::ICmp:
 862     case Instruction::FCmp: {
 863       // Check that all of the compares have the same predicate.
 864       CmpInst::Predicate P0 = dyn_cast<CmpInst>(VL0)->getPredicate();
 865       Type *ComparedTy = cast<Instruction>(VL[0])->getOperand(0)->getType();
 866       for (unsigned i = 1, e = VL.size(); i < e; ++i) {
 867         CmpInst *Cmp = cast<CmpInst>(VL[i]);
 868         if (Cmp->getPredicate() != P0 ||
 869             Cmp->getOperand(0)->getType() != ComparedTy) {
 870           newTreeEntry(VL, false);
 871           DEBUG(dbgs() << "SLP: Gathering cmp with different predicate.\n");
 872           return;
 873         }
 874       }
 875
 876       newTreeEntry(VL, true);
 877       DEBUG(dbgs() << "SLP: added a vector of compares.\n");
 878
 879       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
 880         ValueList Operands;
 881         // Prepare the operand vector.
 882         for (unsigned j = 0; j < VL.size(); ++j)
 883           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
 884
 885         buildTree_rec(Operands, Depth+1);
 886       }
 887       return;
 888     }
 889     case Instruction::Select:
 890     case Instruction::Add:
 891     case Instruction::FAdd:
 892     case Instruction::Sub:
 893     case Instruction::FSub:
 894     case Instruction::Mul:
 895     case Instruction::FMul:
 896     case Instruction::UDiv:
 897     case Instruction::SDiv:
 898     case Instruction::FDiv:
 899     case Instruction::URem:
 900     case Instruction::SRem:
 901     case Instruction::FRem:
 902     case Instruction::Shl:
 903     case Instruction::LShr:
 904     case Instruction::AShr:
 905     case Instruction::And:
 906     case Instruction::Or:
 907     case Instruction::Xor: {
 908       newTreeEntry(VL, true);
 909       DEBUG(dbgs() << "SLP: added a vector of bin op.\n");
 910
 911       // Sort operands of the instructions so that each side is more likely to
 912       // have the same opcode.
 913       if (isa<BinaryOperator>(VL0) && VL0->isCommutative()) {
 914         ValueList Left, Right;
 915         reorderInputsAccordingToOpcode(VL, Left, Right);
 916         buildTree_rec(Left, Depth + 1);
 917         buildTree_rec(Right, Depth + 1);
 918         return;
 919       }
 920
 921       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
 922         ValueList Operands;
 923         // Prepare the operand vector.
 924         for (unsigned j = 0; j < VL.size(); ++j)
 925           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
 926
 927         buildTree_rec(Operands, Depth+1);
 928       }
 929       return;
 930     }
 931     case Instruction::Store: {
 932       // Check if the stores are consecutive or of we need to swizzle them.
 933       for (unsigned i = 0, e = VL.size() - 1; i < e; ++i)
 934         if (!isConsecutiveAccess(VL[i], VL[i + 1])) {
 935           newTreeEntry(VL, false);
 936           DEBUG(dbgs() << "SLP: Non-consecutive store.\n");
 937           return;
 938         }
 939
 940       newTreeEntry(VL, true);
 941       DEBUG(dbgs() << "SLP: added a vector of stores.\n");
 942
 943       ValueList Operands;
 944       for (unsigned j = 0; j < VL.size(); ++j)
 945         Operands.push_back(cast<Instruction>(VL[j])->getOperand(0));
 946
 947       // We can ignore these values because we are sinking them down.
 948       MemBarrierIgnoreList.insert(VL.begin(), VL.end());
 949       buildTree_rec(Operands, Depth + 1);
 950       return;
 951     }
 952     default:
 953       newTreeEntry(VL, false);
 954       DEBUG(dbgs() << "SLP: Gathering unknown instruction.\n");
 955       return;
 956   }
 957 }
 958
 959 int BoUpSLP::getEntryCost(TreeEntry *E) {
 960   ArrayRef<Value*> VL = E->Scalars;
 961
 962   Type *ScalarTy = VL[0]->getType();
 963   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
 964     ScalarTy = SI->getValueOperand()->getType();
 965   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
 966
 967   if (E->NeedToGather) {
 968     if (allConstant(VL))
 969       return 0;
 970     if (isSplat(VL)) {
 971       return TTI->getShuffleCost(TargetTransformInfo::SK_Broadcast, VecTy, 0);
 972     }
 973     return getGatherCost(E->Scalars);
 974   }
 975
 976   assert(getSameOpcode(VL) && getSameType(VL) && getSameBlock(VL) &&
 977          "Invalid VL");
 978   Instruction *VL0 = cast<Instruction>(VL[0]);
 979   unsigned Opcode = VL0->getOpcode();
 980   switch (Opcode) {
 981     case Instruction::PHI: {
 982       return 0;
 983     }
 984     case Instruction::ExtractElement: {
 985       if (CanReuseExtract(VL))
 986         return 0;
 987       return getGatherCost(VecTy);
 988     }
 989     case Instruction::ZExt:
 990     case Instruction::SExt:
 991     case Instruction::FPToUI:
 992     case Instruction::FPToSI:
 993     case Instruction::FPExt:
 994     case Instruction::PtrToInt:
 995     case Instruction::IntToPtr:
 996     case Instruction::SIToFP:
 997     case Instruction::UIToFP:
 998     case Instruction::Trunc:
 999     case Instruction::FPTrunc:
1000     case Instruction::BitCast: {
1001       Type *SrcTy = VL0->getOperand(0)->getType();
1002
1003       // Calculate the cost of this instruction.
1004       int ScalarCost = VL.size() * TTI->getCastInstrCost(VL0->getOpcode(),
1005                                                          VL0->getType(), SrcTy);
1006
1007       VectorType *SrcVecTy = VectorType::get(SrcTy, VL.size());
1008       int VecCost = TTI->getCastInstrCost(VL0->getOpcode(), VecTy, SrcVecTy);
1009       return VecCost - ScalarCost;
1010     }
1011     case Instruction::FCmp:
1012     case Instruction::ICmp:
1013     case Instruction::Select:
1014     case Instruction::Add:
1015     case Instruction::FAdd:
1016     case Instruction::Sub:
1017     case Instruction::FSub:
1018     case Instruction::Mul:
1019     case Instruction::FMul:
1020     case Instruction::UDiv:
1021     case Instruction::SDiv:
1022     case Instruction::FDiv:
1023     case Instruction::URem:
1024     case Instruction::SRem:
1025     case Instruction::FRem:
1026     case Instruction::Shl:
1027     case Instruction::LShr:
1028     case Instruction::AShr:
1029     case Instruction::And:
1030     case Instruction::Or:
1031     case Instruction::Xor: {
1032       // Calculate the cost of this instruction.
1033       int ScalarCost = 0;
1034       int VecCost = 0;
1035       if (Opcode == Instruction::FCmp || Opcode == Instruction::ICmp ||
1036           Opcode == Instruction::Select) {
1037         VectorType *MaskTy = VectorType::get(Builder.getInt1Ty(), VL.size());
1038         ScalarCost = VecTy->getNumElements() *
1039         TTI->getCmpSelInstrCost(Opcode, ScalarTy, Builder.getInt1Ty());
1040         VecCost = TTI->getCmpSelInstrCost(Opcode, VecTy, MaskTy);
1041       } else {
1042         // Certain instructions can be cheaper to vectorize if they have a
1043         // constant second vector operand.
1044         TargetTransformInfo::OperandValueKind Op1VK =
1045             TargetTransformInfo::OK_AnyValue;
1046         TargetTransformInfo::OperandValueKind Op2VK =
1047             TargetTransformInfo::OK_UniformConstantValue;
1048
1049         // If all operands are exactly the same ConstantInt then set the
1050         // operand kind to OK_UniformConstantValue.
1051         // If instead not all operands are constants, then set the operand kind
1052         // to OK_AnyValue. If all operands are constants but not the same,
1053         // then set the operand kind to OK_NonUniformConstantValue.
1054         ConstantInt *CInt = NULL;
1055         for (unsigned i = 0; i < VL.size(); ++i) {
1056           const Instruction *I = cast<Instruction>(VL[i]);
1057           if (!isa<ConstantInt>(I->getOperand(1))) {
1058             Op2VK = TargetTransformInfo::OK_AnyValue;
1059             break;
1060           }
1061           if (i == 0) {
1062             CInt = cast<ConstantInt>(I->getOperand(1));
1063             continue;
1064           }
1065           if (Op2VK == TargetTransformInfo::OK_UniformConstantValue &&
1066               CInt != cast<ConstantInt>(I->getOperand(1)))
1067             Op2VK = TargetTransformInfo::OK_NonUniformConstantValue;
1068         }
1069
1070         ScalarCost =
1071             VecTy->getNumElements() *
1072             TTI->getArithmeticInstrCost(Opcode, ScalarTy, Op1VK, Op2VK);
1073         VecCost = TTI->getArithmeticInstrCost(Opcode, VecTy, Op1VK, Op2VK);
1074       }
1075       return VecCost - ScalarCost;
1076     }
1077     case Instruction::Load: {
1078       // Cost of wide load - cost of scalar loads.
1079       int ScalarLdCost = VecTy->getNumElements() *
1080       TTI->getMemoryOpCost(Instruction::Load, ScalarTy, 1, 0);
1081       int VecLdCost = TTI->getMemoryOpCost(Instruction::Load, VecTy, 1, 0);
1082       return VecLdCost - ScalarLdCost;
1083     }
1084     case Instruction::Store: {
1085       // We know that we can merge the stores. Calculate the cost.
1086       int ScalarStCost = VecTy->getNumElements() *
1087       TTI->getMemoryOpCost(Instruction::Store, ScalarTy, 1, 0);
1088       int VecStCost = TTI->getMemoryOpCost(Instruction::Store, VecTy, 1, 0);
1089       return VecStCost - ScalarStCost;
1090     }
1091     default:
1092       llvm_unreachable("Unknown instruction");
1093   }
1094 }
1095
1096 bool BoUpSLP::isFullyVectorizableTinyTree() {
1097   DEBUG(dbgs() << "SLP: Check whether the tree with height " <<
1098         VectorizableTree.size() << " is fully vectorizable .\n");
1099
1100   // We only handle trees of height 2.
1101   if (VectorizableTree.size() != 2)
1102     return false;
1103
1104   // Handle splat stores.
1105   if (!VectorizableTree[0].NeedToGather && isSplat(VectorizableTree[1].Scalars))
1106     return true;
1107
1108   // Gathering cost would be too much for tiny trees.
1109   if (VectorizableTree[0].NeedToGather || VectorizableTree[1].NeedToGather)
1110     return false;
1111
1112   return true;
1113 }
1114
1115 int BoUpSLP::getTreeCost() {
1116   int Cost = 0;
1117   DEBUG(dbgs() << "SLP: Calculating cost for tree of size " <<
1118         VectorizableTree.size() << ".\n");
1119
1120   // We only vectorize tiny trees if it is fully vectorizable.
1121   if (VectorizableTree.size() < 3 && !isFullyVectorizableTinyTree()) {
1122     if (!VectorizableTree.size()) {
1123       assert(!ExternalUses.size() && "We should not have any external users");
1124     }
1125     return INT_MAX;
1126   }
1127
1128   unsigned BundleWidth = VectorizableTree[0].Scalars.size();
1129
1130   for (unsigned i = 0, e = VectorizableTree.size(); i != e; ++i) {
1131     int C = getEntryCost(&VectorizableTree[i]);
1132     DEBUG(dbgs() << "SLP: Adding cost " << C << " for bundle that starts with "
1133           << *VectorizableTree[i].Scalars[0] << " .\n");
1134     Cost += C;
1135   }
1136
1137   SmallSet<Value *, 16> ExtractCostCalculated;
1138   int ExtractCost = 0;
1139   for (UserList::iterator I = ExternalUses.begin(), E = ExternalUses.end();
1140        I != E; ++I) {
1141     // We only add extract cost once for the same scalar.
1142     if (!ExtractCostCalculated.insert(I->Scalar))
1143       continue;
1144
1145     VectorType *VecTy = VectorType::get(I->Scalar->getType(), BundleWidth);
1146     ExtractCost += TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy,
1147                                            I->Lane);
1148   }
1149
1150   DEBUG(dbgs() << "SLP: Total Cost " << Cost + ExtractCost<< ".\n");
1151   return  Cost + ExtractCost;
1152 }
1153
1154 int BoUpSLP::getGatherCost(Type *Ty) {
1155   int Cost = 0;
1156   for (unsigned i = 0, e = cast<VectorType>(Ty)->getNumElements(); i < e; ++i)
1157     Cost += TTI->getVectorInstrCost(Instruction::InsertElement, Ty, i);
1158   return Cost;
1159 }
1160
1161 int BoUpSLP::getGatherCost(ArrayRef<Value *> VL) {
1162   // Find the type of the operands in VL.
1163   Type *ScalarTy = VL[0]->getType();
1164   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
1165     ScalarTy = SI->getValueOperand()->getType();
1166   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
1167   // Find the cost of inserting/extracting values from the vector.
1168   return getGatherCost(VecTy);
1169 }
1170
1171 AliasAnalysis::Location BoUpSLP::getLocation(Instruction *I) {
1172   if (StoreInst *SI = dyn_cast<StoreInst>(I))
1173     return AA->getLocation(SI);
1174   if (LoadInst *LI = dyn_cast<LoadInst>(I))
1175     return AA->getLocation(LI);
1176   return AliasAnalysis::Location();
1177 }
1178
1179 Value *BoUpSLP::getPointerOperand(Value *I) {
1180   if (LoadInst *LI = dyn_cast<LoadInst>(I))
1181     return LI->getPointerOperand();
1182   if (StoreInst *SI = dyn_cast<StoreInst>(I))
1183     return SI->getPointerOperand();
1184   return 0;
1185 }
1186
1187 unsigned BoUpSLP::getAddressSpaceOperand(Value *I) {
1188   if (LoadInst *L = dyn_cast<LoadInst>(I))
1189     return L->getPointerAddressSpace();
1190   if (StoreInst *S = dyn_cast<StoreInst>(I))
1191     return S->getPointerAddressSpace();
1192   return -1;
1193 }
1194
1195 bool BoUpSLP::isConsecutiveAccess(Value *A, Value *B) {
1196   Value *PtrA = getPointerOperand(A);
1197   Value *PtrB = getPointerOperand(B);
1198   unsigned ASA = getAddressSpaceOperand(A);
1199   unsigned ASB = getAddressSpaceOperand(B);
1200
1201   // Check that the address spaces match and that the pointers are valid.
1202   if (!PtrA || !PtrB || (ASA != ASB))
1203     return false;
1204
1205   // Make sure that A and B are different pointers of the same type.
1206   if (PtrA == PtrB || PtrA->getType() != PtrB->getType())
1207     return false;
1208
1209   unsigned PtrBitWidth = DL->getPointerSizeInBits(ASA);
1210   Type *Ty = cast<PointerType>(PtrA->getType())->getElementType();
1211   APInt Size(PtrBitWidth, DL->getTypeStoreSize(Ty));
1212
1213   APInt OffsetA(PtrBitWidth, 0), OffsetB(PtrBitWidth, 0);
1214   PtrA = PtrA->stripAndAccumulateInBoundsConstantOffsets(*DL, OffsetA);
1215   PtrB = PtrB->stripAndAccumulateInBoundsConstantOffsets(*DL, OffsetB);
1216
1217   APInt OffsetDelta = OffsetB - OffsetA;
1218
1219   // Check if they are based on the same pointer. That makes the offsets
1220   // sufficient.
1221   if (PtrA == PtrB)
1222     return OffsetDelta == Size;
1223
1224   // Compute the necessary base pointer delta to have the necessary final delta
1225   // equal to the size.
1226   APInt BaseDelta = Size - OffsetDelta;
1227
1228   // Otherwise compute the distance with SCEV between the base pointers.
1229   const SCEV *PtrSCEVA = SE->getSCEV(PtrA);
1230   const SCEV *PtrSCEVB = SE->getSCEV(PtrB);
1231   const SCEV *C = SE->getConstant(BaseDelta);
1232   const SCEV *X = SE->getAddExpr(PtrSCEVA, C);
1233   return X == PtrSCEVB;
1234 }
1235
1236 Value *BoUpSLP::getSinkBarrier(Instruction *Src, Instruction *Dst) {
1237   assert(Src->getParent() == Dst->getParent() && "Not the same BB");
1238   BasicBlock::iterator I = Src, E = Dst;
1239   /// Scan all of the instruction from SRC to DST and check if
1240   /// the source may alias.
1241   for (++I; I != E; ++I) {
1242     // Ignore store instructions that are marked as 'ignore'.
1243     if (MemBarrierIgnoreList.count(I))
1244       continue;
1245     if (Src->mayWriteToMemory()) /* Write */ {
1246       if (!I->mayReadOrWriteMemory())
1247         continue;
1248     } else /* Read */ {
1249       if (!I->mayWriteToMemory())
1250         continue;
1251     }
1252     AliasAnalysis::Location A = getLocation(&*I);
1253     AliasAnalysis::Location B = getLocation(Src);
1254
1255     if (!A.Ptr || !B.Ptr || AA->alias(A, B))
1256       return I;
1257   }
1258   return 0;
1259 }
1260
1261 int BoUpSLP::getLastIndex(ArrayRef<Value *> VL) {
1262   BasicBlock *BB = cast<Instruction>(VL[0])->getParent();
1263   assert(BB == getSameBlock(VL) && BlocksNumbers.count(BB) && "Invalid block");
1264   BlockNumbering &BN = BlocksNumbers[BB];
1265
1266   int MaxIdx = BN.getIndex(BB->getFirstNonPHI());
1267   for (unsigned i = 0, e = VL.size(); i < e; ++i)
1268     MaxIdx = std::max(MaxIdx, BN.getIndex(cast<Instruction>(VL[i])));
1269   return MaxIdx;
1270 }
1271
1272 Instruction *BoUpSLP::getLastInstruction(ArrayRef<Value *> VL) {
1273   BasicBlock *BB = cast<Instruction>(VL[0])->getParent();
1274   assert(BB == getSameBlock(VL) && BlocksNumbers.count(BB) && "Invalid block");
1275   BlockNumbering &BN = BlocksNumbers[BB];
1276
1277   int MaxIdx = BN.getIndex(cast<Instruction>(VL[0]));
1278   for (unsigned i = 1, e = VL.size(); i < e; ++i)
1279     MaxIdx = std::max(MaxIdx, BN.getIndex(cast<Instruction>(VL[i])));
1280   Instruction *I = BN.getInstruction(MaxIdx);
1281   assert(I && "bad location");
1282   return I;
1283 }
1284
1285 void BoUpSLP::setInsertPointAfterBundle(ArrayRef<Value *> VL) {
1286   Instruction *VL0 = cast<Instruction>(VL[0]);
1287   Instruction *LastInst = getLastInstruction(VL);
1288   BasicBlock::iterator NextInst = LastInst;
1289   ++NextInst;
1290   Builder.SetInsertPoint(VL0->getParent(), NextInst);
1291   Builder.SetCurrentDebugLocation(VL0->getDebugLoc());
1292 }
1293
1294 Value *BoUpSLP::Gather(ArrayRef<Value *> VL, VectorType *Ty) {
1295   Value *Vec = UndefValue::get(Ty);
1296   // Generate the 'InsertElement' instruction.
1297   for (unsigned i = 0; i < Ty->getNumElements(); ++i) {
1298     Vec = Builder.CreateInsertElement(Vec, VL[i], Builder.getInt32(i));
1299     if (Instruction *Insrt = dyn_cast<Instruction>(Vec)) {
1300       GatherSeq.insert(Insrt);
1301       CSEBlocks.insert(Insrt->getParent());
1302
1303       // Add to our 'need-to-extract' list.
1304       if (ScalarToTreeEntry.count(VL[i])) {
1305         int Idx = ScalarToTreeEntry[VL[i]];
1306         TreeEntry *E = &VectorizableTree[Idx];
1307         // Find which lane we need to extract.
1308         int FoundLane = -1;
1309         for (unsigned Lane = 0, LE = VL.size(); Lane != LE; ++Lane) {
1310           // Is this the lane of the scalar that we are looking for ?
1311           if (E->Scalars[Lane] == VL[i]) {
1312             FoundLane = Lane;
1313             break;
1314           }
1315         }
1316         assert(FoundLane >= 0 && "Could not find the correct lane");
1317         ExternalUses.push_back(ExternalUser(VL[i], Insrt, FoundLane));
1318       }
1319     }
1320   }
1321
1322   return Vec;
1323 }
1324
1325 Value *BoUpSLP::alreadyVectorized(ArrayRef<Value *> VL) const {
1326   SmallDenseMap<Value*, int>::const_iterator Entry
1327     = ScalarToTreeEntry.find(VL[0]);
1328   if (Entry != ScalarToTreeEntry.end()) {
1329     int Idx = Entry->second;
1330     const TreeEntry *En = &VectorizableTree[Idx];
1331     if (En->isSame(VL) && En->VectorizedValue)
1332       return En->VectorizedValue;
1333   }
1334   return 0;
1335 }
1336
1337 Value *BoUpSLP::vectorizeTree(ArrayRef<Value *> VL) {
1338   if (ScalarToTreeEntry.count(VL[0])) {
1339     int Idx = ScalarToTreeEntry[VL[0]];
1340     TreeEntry *E = &VectorizableTree[Idx];
1341     if (E->isSame(VL))
1342       return vectorizeTree(E);
1343   }
1344
1345   Type *ScalarTy = VL[0]->getType();
1346   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
1347     ScalarTy = SI->getValueOperand()->getType();
1348   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
1349
1350   return Gather(VL, VecTy);
1351 }
1352
1353 Value *BoUpSLP::vectorizeTree(TreeEntry *E) {
1354   IRBuilder<>::InsertPointGuard Guard(Builder);
1355
1356   if (E->VectorizedValue) {
1357     DEBUG(dbgs() << "SLP: Diamond merged for " << *E->Scalars[0] << ".\n");
1358     return E->VectorizedValue;
1359   }
1360
1361   Instruction *VL0 = cast<Instruction>(E->Scalars[0]);
1362   Type *ScalarTy = VL0->getType();
1363   if (StoreInst *SI = dyn_cast<StoreInst>(VL0))
1364     ScalarTy = SI->getValueOperand()->getType();
1365   VectorType *VecTy = VectorType::get(ScalarTy, E->Scalars.size());
1366
1367   if (E->NeedToGather) {
1368     setInsertPointAfterBundle(E->Scalars);
1369     return Gather(E->Scalars, VecTy);
1370   }
1371
1372   unsigned Opcode = VL0->getOpcode();
1373   assert(Opcode == getSameOpcode(E->Scalars) && "Invalid opcode");
1374
1375   switch (Opcode) {
1376     case Instruction::PHI: {
1377       PHINode *PH = dyn_cast<PHINode>(VL0);
1378       Builder.SetInsertPoint(PH->getParent()->getFirstNonPHI());
1379       Builder.SetCurrentDebugLocation(PH->getDebugLoc());
1380       PHINode *NewPhi = Builder.CreatePHI(VecTy, PH->getNumIncomingValues());
1381       E->VectorizedValue = NewPhi;
1382
1383       // PHINodes may have multiple entries from the same block. We want to
1384       // visit every block once.
1385       SmallSet<BasicBlock*, 4> VisitedBBs;
1386
1387       for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
1388         ValueList Operands;
1389         BasicBlock *IBB = PH->getIncomingBlock(i);
1390
1391         if (!VisitedBBs.insert(IBB)) {
1392           NewPhi->addIncoming(NewPhi->getIncomingValueForBlock(IBB), IBB);
1393           continue;
1394         }
1395
1396         // Prepare the operand vector.
1397         for (unsigned j = 0; j < E->Scalars.size(); ++j)
1398           Operands.push_back(cast<PHINode>(E->Scalars[j])->
1399                              getIncomingValueForBlock(IBB));
1400
1401         Builder.SetInsertPoint(IBB->getTerminator());
1402         Builder.SetCurrentDebugLocation(PH->getDebugLoc());
1403         Value *Vec = vectorizeTree(Operands);
1404         NewPhi->addIncoming(Vec, IBB);
1405       }
1406
1407       assert(NewPhi->getNumIncomingValues() == PH->getNumIncomingValues() &&
1408              "Invalid number of incoming values");
1409       return NewPhi;
1410     }
1411
1412     case Instruction::ExtractElement: {
1413       if (CanReuseExtract(E->Scalars)) {
1414         Value *V = VL0->getOperand(0);
1415         E->VectorizedValue = V;
1416         return V;
1417       }
1418       return Gather(E->Scalars, VecTy);
1419     }
1420     case Instruction::ZExt:
1421     case Instruction::SExt:
1422     case Instruction::FPToUI:
1423     case Instruction::FPToSI:
1424     case Instruction::FPExt:
1425     case Instruction::PtrToInt:
1426     case Instruction::IntToPtr:
1427     case Instruction::SIToFP:
1428     case Instruction::UIToFP:
1429     case Instruction::Trunc:
1430     case Instruction::FPTrunc:
1431     case Instruction::BitCast: {
1432       ValueList INVL;
1433       for (int i = 0, e = E->Scalars.size(); i < e; ++i)
1434         INVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1435
1436       setInsertPointAfterBundle(E->Scalars);
1437
1438       Value *InVec = vectorizeTree(INVL);
1439
1440       if (Value *V = alreadyVectorized(E->Scalars))
1441         return V;
1442
1443       CastInst *CI = dyn_cast<CastInst>(VL0);
1444       Value *V = Builder.CreateCast(CI->getOpcode(), InVec, VecTy);
1445       E->VectorizedValue = V;
1446       return V;
1447     }
1448     case Instruction::FCmp:
1449     case Instruction::ICmp: {
1450       ValueList LHSV, RHSV;
1451       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1452         LHSV.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1453         RHSV.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1454       }
1455
1456       setInsertPointAfterBundle(E->Scalars);
1457
1458       Value *L = vectorizeTree(LHSV);
1459       Value *R = vectorizeTree(RHSV);
1460
1461       if (Value *V = alreadyVectorized(E->Scalars))
1462         return V;
1463
1464       CmpInst::Predicate P0 = dyn_cast<CmpInst>(VL0)->getPredicate();
1465       Value *V;
1466       if (Opcode == Instruction::FCmp)
1467         V = Builder.CreateFCmp(P0, L, R);
1468       else
1469         V = Builder.CreateICmp(P0, L, R);
1470
1471       E->VectorizedValue = V;
1472       return V;
1473     }
1474     case Instruction::Select: {
1475       ValueList TrueVec, FalseVec, CondVec;
1476       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1477         CondVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1478         TrueVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1479         FalseVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(2));
1480       }
1481
1482       setInsertPointAfterBundle(E->Scalars);
1483
1484       Value *Cond = vectorizeTree(CondVec);
1485       Value *True = vectorizeTree(TrueVec);
1486       Value *False = vectorizeTree(FalseVec);
1487
1488       if (Value *V = alreadyVectorized(E->Scalars))
1489         return V;
1490
1491       Value *V = Builder.CreateSelect(Cond, True, False);
1492       E->VectorizedValue = V;
1493       return V;
1494     }
1495     case Instruction::Add:
1496     case Instruction::FAdd:
1497     case Instruction::Sub:
1498     case Instruction::FSub:
1499     case Instruction::Mul:
1500     case Instruction::FMul:
1501     case Instruction::UDiv:
1502     case Instruction::SDiv:
1503     case Instruction::FDiv:
1504     case Instruction::URem:
1505     case Instruction::SRem:
1506     case Instruction::FRem:
1507     case Instruction::Shl:
1508     case Instruction::LShr:
1509     case Instruction::AShr:
1510     case Instruction::And:
1511     case Instruction::Or:
1512     case Instruction::Xor: {
1513       ValueList LHSVL, RHSVL;
1514       if (isa<BinaryOperator>(VL0) && VL0->isCommutative())
1515         reorderInputsAccordingToOpcode(E->Scalars, LHSVL, RHSVL);
1516       else
1517         for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1518           LHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1519           RHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1520         }
1521
1522       setInsertPointAfterBundle(E->Scalars);
1523
1524       Value *LHS = vectorizeTree(LHSVL);
1525       Value *RHS = vectorizeTree(RHSVL);
1526
1527       if (LHS == RHS && isa<Instruction>(LHS)) {
1528         assert((VL0->getOperand(0) == VL0->getOperand(1)) && "Invalid order");
1529       }
1530
1531       if (Value *V = alreadyVectorized(E->Scalars))
1532         return V;
1533
1534       BinaryOperator *BinOp = cast<BinaryOperator>(VL0);
1535       Value *V = Builder.CreateBinOp(BinOp->getOpcode(), LHS, RHS);
1536       E->VectorizedValue = V;
1537
1538       if (Instruction *I = dyn_cast<Instruction>(V))
1539         return propagateMetadata(I, E->Scalars);
1540
1541       return V;
1542     }
1543     case Instruction::Load: {
1544       // Loads are inserted at the head of the tree because we don't want to
1545       // sink them all the way down past store instructions.
1546       setInsertPointAfterBundle(E->Scalars);
1547
1548       LoadInst *LI = cast<LoadInst>(VL0);
1549       unsigned AS = LI->getPointerAddressSpace();
1550
1551       Value *VecPtr = Builder.CreateBitCast(LI->getPointerOperand(),
1552                                             VecTy->getPointerTo(AS));
1553       unsigned Alignment = LI->getAlignment();
1554       LI = Builder.CreateLoad(VecPtr);
1555       LI->setAlignment(Alignment);
1556       E->VectorizedValue = LI;
1557       return propagateMetadata(LI, E->Scalars);
1558     }
1559     case Instruction::Store: {
1560       StoreInst *SI = cast<StoreInst>(VL0);
1561       unsigned Alignment = SI->getAlignment();
1562       unsigned AS = SI->getPointerAddressSpace();
1563
1564       ValueList ValueOp;
1565       for (int i = 0, e = E->Scalars.size(); i < e; ++i)
1566         ValueOp.push_back(cast<StoreInst>(E->Scalars[i])->getValueOperand());
1567
1568       setInsertPointAfterBundle(E->Scalars);
1569
1570       Value *VecValue = vectorizeTree(ValueOp);
1571       Value *VecPtr = Builder.CreateBitCast(SI->getPointerOperand(),
1572                                             VecTy->getPointerTo(AS));
1573       StoreInst *S = Builder.CreateStore(VecValue, VecPtr);
1574       S->setAlignment(Alignment);
1575       E->VectorizedValue = S;
1576       return propagateMetadata(S, E->Scalars);
1577     }
1578     default:
1579     llvm_unreachable("unknown inst");
1580   }
1581   return 0;
1582 }
1583
1584 Value *BoUpSLP::vectorizeTree() {
1585   Builder.SetInsertPoint(F->getEntryBlock().begin());
1586   vectorizeTree(&VectorizableTree[0]);
1587
1588   DEBUG(dbgs() << "SLP: Extracting " << ExternalUses.size() << " values .\n");
1589
1590   // Extract all of the elements with the external uses.
1591   for (UserList::iterator it = ExternalUses.begin(), e = ExternalUses.end();
1592        it != e; ++it) {
1593     Value *Scalar = it->Scalar;
1594     llvm::User *User = it->User;
1595
1596     // Skip users that we already RAUW. This happens when one instruction
1597     // has multiple uses of the same value.
1598     if (std::find(Scalar->use_begin(), Scalar->use_end(), User) ==
1599         Scalar->use_end())
1600       continue;
1601     assert(ScalarToTreeEntry.count(Scalar) && "Invalid scalar");
1602
1603     int Idx = ScalarToTreeEntry[Scalar];
1604     TreeEntry *E = &VectorizableTree[Idx];
1605     assert(!E->NeedToGather && "Extracting from a gather list");
1606
1607     Value *Vec = E->VectorizedValue;
1608     assert(Vec && "Can't find vectorizable value");
1609
1610     Value *Lane = Builder.getInt32(it->Lane);
1611     // Generate extracts for out-of-tree users.
1612     // Find the insertion point for the extractelement lane.
1613     if (PHINode *PN = dyn_cast<PHINode>(Vec)) {
1614       Builder.SetInsertPoint(PN->getParent()->getFirstInsertionPt());
1615       Value *Ex = Builder.CreateExtractElement(Vec, Lane);
1616       CSEBlocks.insert(PN->getParent());
1617       User->replaceUsesOfWith(Scalar, Ex);
1618     } else if (isa<Instruction>(Vec)){
1619       if (PHINode *PH = dyn_cast<PHINode>(User)) {
1620         for (int i = 0, e = PH->getNumIncomingValues(); i != e; ++i) {
1621           if (PH->getIncomingValue(i) == Scalar) {
1622             Builder.SetInsertPoint(PH->getIncomingBlock(i)->getTerminator());
1623             Value *Ex = Builder.CreateExtractElement(Vec, Lane);
1624             CSEBlocks.insert(PH->getIncomingBlock(i));
1625             PH->setOperand(i, Ex);
1626           }
1627         }
1628       } else {
1629         Builder.SetInsertPoint(cast<Instruction>(User));
1630         Value *Ex = Builder.CreateExtractElement(Vec, Lane);
1631         CSEBlocks.insert(cast<Instruction>(User)->getParent());
1632         User->replaceUsesOfWith(Scalar, Ex);
1633      }
1634     } else {
1635       Builder.SetInsertPoint(F->getEntryBlock().begin());
1636       Value *Ex = Builder.CreateExtractElement(Vec, Lane);
1637       CSEBlocks.insert(&F->getEntryBlock());
1638       User->replaceUsesOfWith(Scalar, Ex);
1639     }
1640
1641     DEBUG(dbgs() << "SLP: Replaced:" << *User << ".\n");
1642   }
1643
1644   // For each vectorized value:
1645   for (int EIdx = 0, EE = VectorizableTree.size(); EIdx < EE; ++EIdx) {
1646     TreeEntry *Entry = &VectorizableTree[EIdx];
1647
1648     // For each lane:
1649     for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) {
1650       Value *Scalar = Entry->Scalars[Lane];
1651
1652       // No need to handle users of gathered values.
1653       if (Entry->NeedToGather)
1654         continue;
1655
1656       assert(Entry->VectorizedValue && "Can't find vectorizable value");
1657
1658       Type *Ty = Scalar->getType();
1659       if (!Ty->isVoidTy()) {
1660         for (Value::use_iterator User = Scalar->use_begin(),
1661              UE = Scalar->use_end(); User != UE; ++User) {
1662           DEBUG(dbgs() << "SLP: \tvalidating user:" << **User << ".\n");
1663
1664           assert((ScalarToTreeEntry.count(*User) ||
1665                   // It is legal to replace the reduction users by undef.
1666                   (RdxOps && RdxOps->count(*User))) &&
1667                  "Replacing out-of-tree value with undef");
1668         }
1669         Value *Undef = UndefValue::get(Ty);
1670         Scalar->replaceAllUsesWith(Undef);
1671       }
1672       DEBUG(dbgs() << "SLP: \tErasing scalar:" << *Scalar << ".\n");
1673       cast<Instruction>(Scalar)->eraseFromParent();
1674     }
1675   }
1676
1677   for (Function::iterator it = F->begin(), e = F->end(); it != e; ++it) {
1678     BlocksNumbers[it].forget();
1679   }
1680   Builder.ClearInsertionPoint();
1681
1682   return VectorizableTree[0].VectorizedValue;
1683 }
1684
1685 class DTCmp {
1686   const DominatorTree *DT;
1687
1688 public:
1689   DTCmp(const DominatorTree *DT) : DT(DT) {}
1690   bool operator()(const BasicBlock *A, const BasicBlock *B) const {
1691     return DT->properlyDominates(A, B);
1692   }
1693 };
1694
1695 void BoUpSLP::optimizeGatherSequence() {
1696   DEBUG(dbgs() << "SLP: Optimizing " << GatherSeq.size()
1697         << " gather sequences instructions.\n");
1698   // LICM InsertElementInst sequences.
1699   for (SetVector<Instruction *>::iterator it = GatherSeq.begin(),
1700        e = GatherSeq.end(); it != e; ++it) {
1701     InsertElementInst *Insert = dyn_cast<InsertElementInst>(*it);
1702
1703     if (!Insert)
1704       continue;
1705
1706     // Check if this block is inside a loop.
1707     Loop *L = LI->getLoopFor(Insert->getParent());
1708     if (!L)
1709       continue;
1710
1711     // Check if it has a preheader.
1712     BasicBlock *PreHeader = L->getLoopPreheader();
1713     if (!PreHeader)
1714       continue;
1715
1716     // If the vector or the element that we insert into it are
1717     // instructions that are defined in this basic block then we can't
1718     // hoist this instruction.
1719     Instruction *CurrVec = dyn_cast<Instruction>(Insert->getOperand(0));
1720     Instruction *NewElem = dyn_cast<Instruction>(Insert->getOperand(1));
1721     if (CurrVec && L->contains(CurrVec))
1722       continue;
1723     if (NewElem && L->contains(NewElem))
1724       continue;
1725
1726     // We can hoist this instruction. Move it to the pre-header.
1727     Insert->moveBefore(PreHeader->getTerminator());
1728   }
1729
1730   // Sort blocks by domination. This ensures we visit a block after all blocks
1731   // dominating it are visited.
1732   SmallVector<BasicBlock *, 8> CSEWorkList(CSEBlocks.begin(), CSEBlocks.end());
1733   std::stable_sort(CSEWorkList.begin(), CSEWorkList.end(), DTCmp(DT));
1734
1735   // Perform O(N^2) search over the gather sequences and merge identical
1736   // instructions. TODO: We can further optimize this scan if we split the
1737   // instructions into different buckets based on the insert lane.
1738   SmallVector<Instruction *, 16> Visited;
1739   for (SmallVectorImpl<BasicBlock *>::iterator I = CSEWorkList.begin(),
1740                                                E = CSEWorkList.end();
1741        I != E; ++I) {
1742     assert((I == CSEWorkList.begin() || !DT->dominates(*I, *llvm::prior(I))) &&
1743            "Worklist not sorted properly!");
1744     BasicBlock *BB = *I;
1745     // For all instructions in blocks containing gather sequences:
1746     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e;) {
1747       Instruction *In = it++;
1748       if (!isa<InsertElementInst>(In) && !isa<ExtractElementInst>(In))
1749         continue;
1750
1751       // Check if we can replace this instruction with any of the
1752       // visited instructions.
1753       for (SmallVectorImpl<Instruction *>::iterator v = Visited.begin(),
1754                                                     ve = Visited.end();
1755            v != ve; ++v) {
1756         if (In->isIdenticalTo(*v) &&
1757             DT->dominates((*v)->getParent(), In->getParent())) {
1758           In->replaceAllUsesWith(*v);
1759           In->eraseFromParent();
1760           In = 0;
1761           break;
1762         }
1763       }
1764       if (In) {
1765         assert(std::find(Visited.begin(), Visited.end(), In) == Visited.end());
1766         Visited.push_back(In);
1767       }
1768     }
1769   }
1770   CSEBlocks.clear();
1771   GatherSeq.clear();
1772 }
1773
1774 /// The SLPVectorizer Pass.
1775 struct SLPVectorizer : public FunctionPass {
1776   typedef SmallVector<StoreInst *, 8> StoreList;
1777   typedef MapVector<Value *, StoreList> StoreListMap;
1778
1779   /// Pass identification, replacement for typeid
1780   static char ID;
1781
1782   explicit SLPVectorizer() : FunctionPass(ID) {
1783     initializeSLPVectorizerPass(*PassRegistry::getPassRegistry());
1784   }
1785
1786   ScalarEvolution *SE;
1787   DataLayout *DL;
1788   TargetTransformInfo *TTI;
1789   AliasAnalysis *AA;
1790   LoopInfo *LI;
1791   DominatorTree *DT;
1792
1793   virtual bool runOnFunction(Function &F) {
1794     if (skipOptnoneFunction(F))
1795       return false;
1796
1797     SE = &getAnalysis<ScalarEvolution>();
1798     DL = getAnalysisIfAvailable<DataLayout>();
1799     TTI = &getAnalysis<TargetTransformInfo>();
1800     AA = &getAnalysis<AliasAnalysis>();
1801     LI = &getAnalysis<LoopInfo>();
1802     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1803
1804     StoreRefs.clear();
1805     bool Changed = false;
1806
1807     // If the target claims to have no vector registers don't attempt
1808     // vectorization.
1809     if (!TTI->getNumberOfRegisters(true))
1810       return false;
1811
1812     // Must have DataLayout. We can't require it because some tests run w/o
1813     // triple.
1814     if (!DL)
1815       return false;
1816
1817     // Don't vectorize when the attribute NoImplicitFloat is used.
1818     if (F.hasFnAttribute(Attribute::NoImplicitFloat))
1819       return false;
1820
1821     DEBUG(dbgs() << "SLP: Analyzing blocks in " << F.getName() << ".\n");
1822
1823     // Use the bottom up slp vectorizer to construct chains that start with
1824     // he store instructions.
1825     BoUpSLP R(&F, SE, DL, TTI, AA, LI, DT);
1826
1827     // Scan the blocks in the function in post order.
1828     for (po_iterator<BasicBlock*> it = po_begin(&F.getEntryBlock()),
1829          e = po_end(&F.getEntryBlock()); it != e; ++it) {
1830       BasicBlock *BB = *it;
1831
1832       // Vectorize trees that end at stores.
1833       if (unsigned count = collectStores(BB, R)) {
1834         (void)count;
1835         DEBUG(dbgs() << "SLP: Found " << count << " stores to vectorize.\n");
1836         Changed |= vectorizeStoreChains(R);
1837       }
1838
1839       // Vectorize trees that end at reductions.
1840       Changed |= vectorizeChainsInBlock(BB, R);
1841     }
1842
1843     if (Changed) {
1844       R.optimizeGatherSequence();
1845       DEBUG(dbgs() << "SLP: vectorized \"" << F.getName() << "\"\n");
1846       DEBUG(verifyFunction(F));
1847     }
1848     return Changed;
1849   }
1850
1851   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
1852     FunctionPass::getAnalysisUsage(AU);
1853     AU.addRequired<ScalarEvolution>();
1854     AU.addRequired<AliasAnalysis>();
1855     AU.addRequired<TargetTransformInfo>();
1856     AU.addRequired<LoopInfo>();
1857     AU.addRequired<DominatorTreeWrapperPass>();
1858     AU.addPreserved<LoopInfo>();
1859     AU.addPreserved<DominatorTreeWrapperPass>();
1860     AU.setPreservesCFG();
1861   }
1862
1863 private:
1864
1865   /// \brief Collect memory references and sort them according to their base
1866   /// object. We sort the stores to their base objects to reduce the cost of the
1867   /// quadratic search on the stores. TODO: We can further reduce this cost
1868   /// if we flush the chain creation every time we run into a memory barrier.
1869   unsigned collectStores(BasicBlock *BB, BoUpSLP &R);
1870
1871   /// \brief Try to vectorize a chain that starts at two arithmetic instrs.
1872   bool tryToVectorizePair(Value *A, Value *B, BoUpSLP &R);
1873
1874   /// \brief Try to vectorize a list of operands.
1875   /// \returns true if a value was vectorized.
1876   bool tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R);
1877
1878   /// \brief Try to vectorize a chain that may start at the operands of \V;
1879   bool tryToVectorize(BinaryOperator *V, BoUpSLP &R);
1880
1881   /// \brief Vectorize the stores that were collected in StoreRefs.
1882   bool vectorizeStoreChains(BoUpSLP &R);
1883
1884   /// \brief Scan the basic block and look for patterns that are likely to start
1885   /// a vectorization chain.
1886   bool vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R);
1887
1888   bool vectorizeStoreChain(ArrayRef<Value *> Chain, int CostThreshold,
1889                            BoUpSLP &R);
1890
1891   bool vectorizeStores(ArrayRef<StoreInst *> Stores, int costThreshold,
1892                        BoUpSLP &R);
1893 private:
1894   StoreListMap StoreRefs;
1895 };
1896
1897 /// \brief Check that the Values in the slice in VL array are still existent in
1898 /// the WeakVH array.
1899 /// Vectorization of part of the VL array may cause later values in the VL array
1900 /// to become invalid. We track when this has happened in the WeakVH array.
1901 static bool hasValueBeenRAUWed(ArrayRef<Value *> &VL,
1902                                SmallVectorImpl<WeakVH> &VH,
1903                                unsigned SliceBegin,
1904                                unsigned SliceSize) {
1905   for (unsigned i = SliceBegin; i < SliceBegin + SliceSize; ++i)
1906     if (VH[i] != VL[i])
1907       return true;
1908
1909   return false;
1910 }
1911
1912 bool SLPVectorizer::vectorizeStoreChain(ArrayRef<Value *> Chain,
1913                                           int CostThreshold, BoUpSLP &R) {
1914   unsigned ChainLen = Chain.size();
1915   DEBUG(dbgs() << "SLP: Analyzing a store chain of length " << ChainLen
1916         << "\n");
1917   Type *StoreTy = cast<StoreInst>(Chain[0])->getValueOperand()->getType();
1918   unsigned Sz = DL->getTypeSizeInBits(StoreTy);
1919   unsigned VF = MinVecRegSize / Sz;
1920
1921   if (!isPowerOf2_32(Sz) || VF < 2)
1922     return false;
1923
1924   // Keep track of values that were delete by vectorizing in the loop below.
1925   SmallVector<WeakVH, 8> TrackValues(Chain.begin(), Chain.end());
1926
1927   bool Changed = false;
1928   // Look for profitable vectorizable trees at all offsets, starting at zero.
1929   for (unsigned i = 0, e = ChainLen; i < e; ++i) {
1930     if (i + VF > e)
1931       break;
1932
1933     // Check that a previous iteration of this loop did not delete the Value.
1934     if (hasValueBeenRAUWed(Chain, TrackValues, i, VF))
1935       continue;
1936
1937     DEBUG(dbgs() << "SLP: Analyzing " << VF << " stores at offset " << i
1938           << "\n");
1939     ArrayRef<Value *> Operands = Chain.slice(i, VF);
1940
1941     R.buildTree(Operands);
1942
1943     int Cost = R.getTreeCost();
1944
1945     DEBUG(dbgs() << "SLP: Found cost=" << Cost << " for VF=" << VF << "\n");
1946     if (Cost < CostThreshold) {
1947       DEBUG(dbgs() << "SLP: Decided to vectorize cost=" << Cost << "\n");
1948       R.vectorizeTree();
1949
1950       // Move to the next bundle.
1951       i += VF - 1;
1952       Changed = true;
1953     }
1954   }
1955
1956   return Changed;
1957 }
1958
1959 bool SLPVectorizer::vectorizeStores(ArrayRef<StoreInst *> Stores,
1960                                     int costThreshold, BoUpSLP &R) {
1961   SetVector<Value *> Heads, Tails;
1962   SmallDenseMap<Value *, Value *> ConsecutiveChain;
1963
1964   // We may run into multiple chains that merge into a single chain. We mark the
1965   // stores that we vectorized so that we don't visit the same store twice.
1966   BoUpSLP::ValueSet VectorizedStores;
1967   bool Changed = false;
1968
1969   // Do a quadratic search on all of the given stores and find
1970   // all of the pairs of stores that follow each other.
1971   for (unsigned i = 0, e = Stores.size(); i < e; ++i) {
1972     for (unsigned j = 0; j < e; ++j) {
1973       if (i == j)
1974         continue;
1975
1976       if (R.isConsecutiveAccess(Stores[i], Stores[j])) {
1977         Tails.insert(Stores[j]);
1978         Heads.insert(Stores[i]);
1979         ConsecutiveChain[Stores[i]] = Stores[j];
1980       }
1981     }
1982   }
1983
1984   // For stores that start but don't end a link in the chain:
1985   for (SetVector<Value *>::iterator it = Heads.begin(), e = Heads.end();
1986        it != e; ++it) {
1987     if (Tails.count(*it))
1988       continue;
1989
1990     // We found a store instr that starts a chain. Now follow the chain and try
1991     // to vectorize it.
1992     BoUpSLP::ValueList Operands;
1993     Value *I = *it;
1994     // Collect the chain into a list.
1995     while (Tails.count(I) || Heads.count(I)) {
1996       if (VectorizedStores.count(I))
1997         break;
1998       Operands.push_back(I);
1999       // Move to the next value in the chain.
2000       I = ConsecutiveChain[I];
2001     }
2002
2003     bool Vectorized = vectorizeStoreChain(Operands, costThreshold, R);
2004
2005     // Mark the vectorized stores so that we don't vectorize them again.
2006     if (Vectorized)
2007       VectorizedStores.insert(Operands.begin(), Operands.end());
2008     Changed |= Vectorized;
2009   }
2010
2011   return Changed;
2012 }
2013
2014
2015 unsigned SLPVectorizer::collectStores(BasicBlock *BB, BoUpSLP &R) {
2016   unsigned count = 0;
2017   StoreRefs.clear();
2018   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
2019     StoreInst *SI = dyn_cast<StoreInst>(it);
2020     if (!SI)
2021       continue;
2022
2023     // Don't touch volatile stores.
2024     if (!SI->isSimple())
2025       continue;
2026
2027     // Check that the pointer points to scalars.
2028     Type *Ty = SI->getValueOperand()->getType();
2029     if (Ty->isAggregateType() || Ty->isVectorTy())
2030       return 0;
2031
2032     // Find the base pointer.
2033     Value *Ptr = GetUnderlyingObject(SI->getPointerOperand(), DL);
2034
2035     // Save the store locations.
2036     StoreRefs[Ptr].push_back(SI);
2037     count++;
2038   }
2039   return count;
2040 }
2041
2042 bool SLPVectorizer::tryToVectorizePair(Value *A, Value *B, BoUpSLP &R) {
2043   if (!A || !B)
2044     return false;
2045   Value *VL[] = { A, B };
2046   return tryToVectorizeList(VL, R);
2047 }
2048
2049 bool SLPVectorizer::tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R) {
2050   if (VL.size() < 2)
2051     return false;
2052
2053   DEBUG(dbgs() << "SLP: Vectorizing a list of length = " << VL.size() << ".\n");
2054
2055   // Check that all of the parts are scalar instructions of the same type.
2056   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
2057   if (!I0)
2058     return false;
2059
2060   unsigned Opcode0 = I0->getOpcode();
2061
2062   Type *Ty0 = I0->getType();
2063   unsigned Sz = DL->getTypeSizeInBits(Ty0);
2064   unsigned VF = MinVecRegSize / Sz;
2065
2066   for (int i = 0, e = VL.size(); i < e; ++i) {
2067     Type *Ty = VL[i]->getType();
2068     if (Ty->isAggregateType() || Ty->isVectorTy())
2069       return false;
2070     Instruction *Inst = dyn_cast<Instruction>(VL[i]);
2071     if (!Inst || Inst->getOpcode() != Opcode0)
2072       return false;
2073   }
2074
2075   bool Changed = false;
2076
2077   // Keep track of values that were delete by vectorizing in the loop below.
2078   SmallVector<WeakVH, 8> TrackValues(VL.begin(), VL.end());
2079
2080   for (unsigned i = 0, e = VL.size(); i < e; ++i) {
2081     unsigned OpsWidth = 0;
2082
2083     if (i + VF > e)
2084       OpsWidth = e - i;
2085     else
2086       OpsWidth = VF;
2087
2088     if (!isPowerOf2_32(OpsWidth) || OpsWidth < 2)
2089       break;
2090
2091     // Check that a previous iteration of this loop did not delete the Value.
2092     if (hasValueBeenRAUWed(VL, TrackValues, i, OpsWidth))
2093       continue;
2094
2095     DEBUG(dbgs() << "SLP: Analyzing " << OpsWidth << " operations "
2096                  << "\n");
2097     ArrayRef<Value *> Ops = VL.slice(i, OpsWidth);
2098
2099     R.buildTree(Ops);
2100     int Cost = R.getTreeCost();
2101
2102     if (Cost < -SLPCostThreshold) {
2103       DEBUG(dbgs() << "SLP: Vectorizing pair at cost:" << Cost << ".\n");
2104       R.vectorizeTree();
2105
2106       // Move to the next bundle.
2107       i += VF - 1;
2108       Changed = true;
2109     }
2110   }
2111
2112   return Changed;
2113 }
2114
2115 bool SLPVectorizer::tryToVectorize(BinaryOperator *V, BoUpSLP &R) {
2116   if (!V)
2117     return false;
2118
2119   // Try to vectorize V.
2120   if (tryToVectorizePair(V->getOperand(0), V->getOperand(1), R))
2121     return true;
2122
2123   BinaryOperator *A = dyn_cast<BinaryOperator>(V->getOperand(0));
2124   BinaryOperator *B = dyn_cast<BinaryOperator>(V->getOperand(1));
2125   // Try to skip B.
2126   if (B && B->hasOneUse()) {
2127     BinaryOperator *B0 = dyn_cast<BinaryOperator>(B->getOperand(0));
2128     BinaryOperator *B1 = dyn_cast<BinaryOperator>(B->getOperand(1));
2129     if (tryToVectorizePair(A, B0, R)) {
2130       B->moveBefore(V);
2131       return true;
2132     }
2133     if (tryToVectorizePair(A, B1, R)) {
2134       B->moveBefore(V);
2135       return true;
2136     }
2137   }
2138
2139   // Try to skip A.
2140   if (A && A->hasOneUse()) {
2141     BinaryOperator *A0 = dyn_cast<BinaryOperator>(A->getOperand(0));
2142     BinaryOperator *A1 = dyn_cast<BinaryOperator>(A->getOperand(1));
2143     if (tryToVectorizePair(A0, B, R)) {
2144       A->moveBefore(V);
2145       return true;
2146     }
2147     if (tryToVectorizePair(A1, B, R)) {
2148       A->moveBefore(V);
2149       return true;
2150     }
2151   }
2152   return 0;
2153 }
2154
2155 /// \brief Generate a shuffle mask to be used in a reduction tree.
2156 ///
2157 /// \param VecLen The length of the vector to be reduced.
2158 /// \param NumEltsToRdx The number of elements that should be reduced in the
2159 ///        vector.
2160 /// \param IsPairwise Whether the reduction is a pairwise or splitting
2161 ///        reduction. A pairwise reduction will generate a mask of
2162 ///        <0,2,...> or <1,3,..> while a splitting reduction will generate
2163 ///        <2,3, undef,undef> for a vector of 4 and NumElts = 2.
2164 /// \param IsLeft True will generate a mask of even elements, odd otherwise.
2165 static Value *createRdxShuffleMask(unsigned VecLen, unsigned NumEltsToRdx,
2166                                    bool IsPairwise, bool IsLeft,
2167                                    IRBuilder<> &Builder) {
2168   assert((IsPairwise || !IsLeft) && "Don't support a <0,1,undef,...> mask");
2169
2170   SmallVector<Constant *, 32> ShuffleMask(
2171       VecLen, UndefValue::get(Builder.getInt32Ty()));
2172
2173   if (IsPairwise)
2174     // Build a mask of 0, 2, ... (left) or 1, 3, ... (right).
2175     for (unsigned i = 0; i != NumEltsToRdx; ++i)
2176       ShuffleMask[i] = Builder.getInt32(2 * i + !IsLeft);
2177   else
2178     // Move the upper half of the vector to the lower half.
2179     for (unsigned i = 0; i != NumEltsToRdx; ++i)
2180       ShuffleMask[i] = Builder.getInt32(NumEltsToRdx + i);
2181
2182   return ConstantVector::get(ShuffleMask);
2183 }
2184
2185
2186 /// Model horizontal reductions.
2187 ///
2188 /// A horizontal reduction is a tree of reduction operations (currently add and
2189 /// fadd) that has operations that can be put into a vector as its leaf.
2190 /// For example, this tree:
2191 ///
2192 /// mul mul mul mul
2193 ///  \  /    \  /
2194 ///   +       +
2195 ///    \     /
2196 ///       +
2197 /// This tree has "mul" as its reduced values and "+" as its reduction
2198 /// operations. A reduction might be feeding into a store or a binary operation
2199 /// feeding a phi.
2200 ///    ...
2201 ///    \  /
2202 ///     +
2203 ///     |
2204 ///  phi +=
2205 ///
2206 ///  Or:
2207 ///    ...
2208 ///    \  /
2209 ///     +
2210 ///     |
2211 ///   *p =
2212 ///
2213 class HorizontalReduction {
2214   SmallPtrSet<Value *, 16> ReductionOps;
2215   SmallVector<Value *, 32> ReducedVals;
2216
2217   BinaryOperator *ReductionRoot;
2218   PHINode *ReductionPHI;
2219
2220   /// The opcode of the reduction.
2221   unsigned ReductionOpcode;
2222   /// The opcode of the values we perform a reduction on.
2223   unsigned ReducedValueOpcode;
2224   /// The width of one full horizontal reduction operation.
2225   unsigned ReduxWidth;
2226   /// Should we model this reduction as a pairwise reduction tree or a tree that
2227   /// splits the vector in halves and adds those halves.
2228   bool IsPairwiseReduction;
2229
2230 public:
2231   HorizontalReduction()
2232     : ReductionRoot(0), ReductionPHI(0), ReductionOpcode(0),
2233     ReducedValueOpcode(0), ReduxWidth(0), IsPairwiseReduction(false) {}
2234
2235   /// \brief Try to find a reduction tree.
2236   bool matchAssociativeReduction(PHINode *Phi, BinaryOperator *B,
2237                                  DataLayout *DL) {
2238     assert((!Phi ||
2239             std::find(Phi->op_begin(), Phi->op_end(), B) != Phi->op_end()) &&
2240            "Thi phi needs to use the binary operator");
2241
2242     // We could have a initial reductions that is not an add.
2243     //  r *= v1 + v2 + v3 + v4
2244     // In such a case start looking for a tree rooted in the first '+'.
2245     if (Phi) {
2246       if (B->getOperand(0) == Phi) {
2247         Phi = 0;
2248         B = dyn_cast<BinaryOperator>(B->getOperand(1));
2249       } else if (B->getOperand(1) == Phi) {
2250         Phi = 0;
2251         B = dyn_cast<BinaryOperator>(B->getOperand(0));
2252       }
2253     }
2254
2255     if (!B)
2256       return false;
2257
2258     Type *Ty = B->getType();
2259     if (Ty->isVectorTy())
2260       return false;
2261
2262     ReductionOpcode = B->getOpcode();
2263     ReducedValueOpcode = 0;
2264     ReduxWidth = MinVecRegSize / DL->getTypeSizeInBits(Ty);
2265     ReductionRoot = B;
2266     ReductionPHI = Phi;
2267
2268     if (ReduxWidth < 4)
2269       return false;
2270
2271     // We currently only support adds.
2272     if (ReductionOpcode != Instruction::Add &&
2273         ReductionOpcode != Instruction::FAdd)
2274       return false;
2275
2276     // Post order traverse the reduction tree starting at B. We only handle true
2277     // trees containing only binary operators.
2278     SmallVector<std::pair<BinaryOperator *, unsigned>, 32> Stack;
2279     Stack.push_back(std::make_pair(B, 0));
2280     while (!Stack.empty()) {
2281       BinaryOperator *TreeN = Stack.back().first;
2282       unsigned EdgeToVist = Stack.back().second++;
2283       bool IsReducedValue = TreeN->getOpcode() != ReductionOpcode;
2284
2285       // Only handle trees in the current basic block.
2286       if (TreeN->getParent() != B->getParent())
2287         return false;
2288
2289       // Each tree node needs to have one user except for the ultimate
2290       // reduction.
2291       if (!TreeN->hasOneUse() && TreeN != B)
2292         return false;
2293
2294       // Postorder vist.
2295       if (EdgeToVist == 2 || IsReducedValue) {
2296         if (IsReducedValue) {
2297           // Make sure that the opcodes of the operations that we are going to
2298           // reduce match.
2299           if (!ReducedValueOpcode)
2300             ReducedValueOpcode = TreeN->getOpcode();
2301           else if (ReducedValueOpcode != TreeN->getOpcode())
2302             return false;
2303           ReducedVals.push_back(TreeN);
2304         } else {
2305           // We need to be able to reassociate the adds.
2306           if (!TreeN->isAssociative())
2307             return false;
2308           ReductionOps.insert(TreeN);
2309         }
2310         // Retract.
2311         Stack.pop_back();
2312         continue;
2313       }
2314
2315       // Visit left or right.
2316       Value *NextV = TreeN->getOperand(EdgeToVist);
2317       BinaryOperator *Next = dyn_cast<BinaryOperator>(NextV);
2318       if (Next)
2319         Stack.push_back(std::make_pair(Next, 0));
2320       else if (NextV != Phi)
2321         return false;
2322     }
2323     return true;
2324   }
2325
2326   /// \brief Attempt to vectorize the tree found by
2327   /// matchAssociativeReduction.
2328   bool tryToReduce(BoUpSLP &V, TargetTransformInfo *TTI) {
2329     if (ReducedVals.empty())
2330       return false;
2331
2332     unsigned NumReducedVals = ReducedVals.size();
2333     if (NumReducedVals < ReduxWidth)
2334       return false;
2335
2336     Value *VectorizedTree = 0;
2337     IRBuilder<> Builder(ReductionRoot);
2338     FastMathFlags Unsafe;
2339     Unsafe.setUnsafeAlgebra();
2340     Builder.SetFastMathFlags(Unsafe);
2341     unsigned i = 0;
2342
2343     for (; i < NumReducedVals - ReduxWidth + 1; i += ReduxWidth) {
2344       ArrayRef<Value *> ValsToReduce(&ReducedVals[i], ReduxWidth);
2345       V.buildTree(ValsToReduce, &ReductionOps);
2346
2347       // Estimate cost.
2348       int Cost = V.getTreeCost() + getReductionCost(TTI, ReducedVals[i]);
2349       if (Cost >= -SLPCostThreshold)
2350         break;
2351
2352       DEBUG(dbgs() << "SLP: Vectorizing horizontal reduction at cost:" << Cost
2353                    << ". (HorRdx)\n");
2354
2355       // Vectorize a tree.
2356       DebugLoc Loc = cast<Instruction>(ReducedVals[i])->getDebugLoc();
2357       Value *VectorizedRoot = V.vectorizeTree();
2358
2359       // Emit a reduction.
2360       Value *ReducedSubTree = emitReduction(VectorizedRoot, Builder);
2361       if (VectorizedTree) {
2362         Builder.SetCurrentDebugLocation(Loc);
2363         VectorizedTree = createBinOp(Builder, ReductionOpcode, VectorizedTree,
2364                                      ReducedSubTree, "bin.rdx");
2365       } else
2366         VectorizedTree = ReducedSubTree;
2367     }
2368
2369     if (VectorizedTree) {
2370       // Finish the reduction.
2371       for (; i < NumReducedVals; ++i) {
2372         Builder.SetCurrentDebugLocation(
2373           cast<Instruction>(ReducedVals[i])->getDebugLoc());
2374         VectorizedTree = createBinOp(Builder, ReductionOpcode, VectorizedTree,
2375                                      ReducedVals[i]);
2376       }
2377       // Update users.
2378       if (ReductionPHI) {
2379         assert(ReductionRoot != NULL && "Need a reduction operation");
2380         ReductionRoot->setOperand(0, VectorizedTree);
2381         ReductionRoot->setOperand(1, ReductionPHI);
2382       } else
2383         ReductionRoot->replaceAllUsesWith(VectorizedTree);
2384     }
2385     return VectorizedTree != 0;
2386   }
2387
2388 private:
2389
2390   /// \brief Calcuate the cost of a reduction.
2391   int getReductionCost(TargetTransformInfo *TTI, Value *FirstReducedVal) {
2392     Type *ScalarTy = FirstReducedVal->getType();
2393     Type *VecTy = VectorType::get(ScalarTy, ReduxWidth);
2394
2395     int PairwiseRdxCost = TTI->getReductionCost(ReductionOpcode, VecTy, true);
2396     int SplittingRdxCost = TTI->getReductionCost(ReductionOpcode, VecTy, false);
2397
2398     IsPairwiseReduction = PairwiseRdxCost < SplittingRdxCost;
2399     int VecReduxCost = IsPairwiseReduction ? PairwiseRdxCost : SplittingRdxCost;
2400
2401     int ScalarReduxCost =
2402         ReduxWidth * TTI->getArithmeticInstrCost(ReductionOpcode, VecTy);
2403
2404     DEBUG(dbgs() << "SLP: Adding cost " << VecReduxCost - ScalarReduxCost
2405                  << " for reduction that starts with " << *FirstReducedVal
2406                  << " (It is a "
2407                  << (IsPairwiseReduction ? "pairwise" : "splitting")
2408                  << " reduction)\n");
2409
2410     return VecReduxCost - ScalarReduxCost;
2411   }
2412
2413   static Value *createBinOp(IRBuilder<> &Builder, unsigned Opcode, Value *L,
2414                             Value *R, const Twine &Name = "") {
2415     if (Opcode == Instruction::FAdd)
2416       return Builder.CreateFAdd(L, R, Name);
2417     return Builder.CreateBinOp((Instruction::BinaryOps)Opcode, L, R, Name);
2418   }
2419
2420   /// \brief Emit a horizontal reduction of the vectorized value.
2421   Value *emitReduction(Value *VectorizedValue, IRBuilder<> &Builder) {
2422     assert(VectorizedValue && "Need to have a vectorized tree node");
2423     Instruction *ValToReduce = dyn_cast<Instruction>(VectorizedValue);
2424     assert(isPowerOf2_32(ReduxWidth) &&
2425            "We only handle power-of-two reductions for now");
2426
2427     Value *TmpVec = ValToReduce;
2428     for (unsigned i = ReduxWidth / 2; i != 0; i >>= 1) {
2429       if (IsPairwiseReduction) {
2430         Value *LeftMask =
2431           createRdxShuffleMask(ReduxWidth, i, true, true, Builder);
2432         Value *RightMask =
2433           createRdxShuffleMask(ReduxWidth, i, true, false, Builder);
2434
2435         Value *LeftShuf = Builder.CreateShuffleVector(
2436           TmpVec, UndefValue::get(TmpVec->getType()), LeftMask, "rdx.shuf.l");
2437         Value *RightShuf = Builder.CreateShuffleVector(
2438           TmpVec, UndefValue::get(TmpVec->getType()), (RightMask),
2439           "rdx.shuf.r");
2440         TmpVec = createBinOp(Builder, ReductionOpcode, LeftShuf, RightShuf,
2441                              "bin.rdx");
2442       } else {
2443         Value *UpperHalf =
2444           createRdxShuffleMask(ReduxWidth, i, false, false, Builder);
2445         Value *Shuf = Builder.CreateShuffleVector(
2446           TmpVec, UndefValue::get(TmpVec->getType()), UpperHalf, "rdx.shuf");
2447         TmpVec = createBinOp(Builder, ReductionOpcode, TmpVec, Shuf, "bin.rdx");
2448       }
2449     }
2450
2451     // The result is in the first element of the vector.
2452     return Builder.CreateExtractElement(TmpVec, Builder.getInt32(0));
2453   }
2454 };
2455
2456 /// \brief Recognize construction of vectors like
2457 ///  %ra = insertelement <4 x float> undef, float %s0, i32 0
2458 ///  %rb = insertelement <4 x float> %ra, float %s1, i32 1
2459 ///  %rc = insertelement <4 x float> %rb, float %s2, i32 2
2460 ///  %rd = insertelement <4 x float> %rc, float %s3, i32 3
2461 ///
2462 /// Returns true if it matches
2463 ///
2464 static bool findBuildVector(InsertElementInst *IE,
2465                             SmallVectorImpl<Value *> &Ops) {
2466   if (!isa<UndefValue>(IE->getOperand(0)))
2467     return false;
2468
2469   while (true) {
2470     Ops.push_back(IE->getOperand(1));
2471
2472     if (IE->use_empty())
2473       return false;
2474
2475     InsertElementInst *NextUse = dyn_cast<InsertElementInst>(IE->use_back());
2476     if (!NextUse)
2477       return true;
2478
2479     // If this isn't the final use, make sure the next insertelement is the only
2480     // use. It's OK if the final constructed vector is used multiple times
2481     if (!IE->hasOneUse())
2482       return false;
2483
2484     IE = NextUse;
2485   }
2486
2487   return false;
2488 }
2489
2490 static bool PhiTypeSorterFunc(Value *V, Value *V2) {
2491   return V->getType() < V2->getType();
2492 }
2493
2494 bool SLPVectorizer::vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R) {
2495   bool Changed = false;
2496   SmallVector<Value *, 4> Incoming;
2497   SmallSet<Value *, 16> VisitedInstrs;
2498
2499   bool HaveVectorizedPhiNodes = true;
2500   while (HaveVectorizedPhiNodes) {
2501     HaveVectorizedPhiNodes = false;
2502
2503     // Collect the incoming values from the PHIs.
2504     Incoming.clear();
2505     for (BasicBlock::iterator instr = BB->begin(), ie = BB->end(); instr != ie;
2506          ++instr) {
2507       PHINode *P = dyn_cast<PHINode>(instr);
2508       if (!P)
2509         break;
2510
2511       if (!VisitedInstrs.count(P))
2512         Incoming.push_back(P);
2513     }
2514
2515     // Sort by type.
2516     std::stable_sort(Incoming.begin(), Incoming.end(), PhiTypeSorterFunc);
2517
2518     // Try to vectorize elements base on their type.
2519     for (SmallVector<Value *, 4>::iterator IncIt = Incoming.begin(),
2520                                            E = Incoming.end();
2521          IncIt != E;) {
2522
2523       // Look for the next elements with the same type.
2524       SmallVector<Value *, 4>::iterator SameTypeIt = IncIt;
2525       while (SameTypeIt != E &&
2526              (*SameTypeIt)->getType() == (*IncIt)->getType()) {
2527         VisitedInstrs.insert(*SameTypeIt);
2528         ++SameTypeIt;
2529       }
2530
2531       // Try to vectorize them.
2532       unsigned NumElts = (SameTypeIt - IncIt);
2533       DEBUG(errs() << "SLP: Trying to vectorize starting at PHIs (" << NumElts << ")\n");
2534       if (NumElts > 1 &&
2535           tryToVectorizeList(ArrayRef<Value *>(IncIt, NumElts), R)) {
2536         // Success start over because instructions might have been changed.
2537         HaveVectorizedPhiNodes = true;
2538         Changed = true;
2539         break;
2540       }
2541
2542       // Start over at the next instruction of a different type (or the end).
2543       IncIt = SameTypeIt;
2544     }
2545   }
2546
2547   VisitedInstrs.clear();
2548
2549   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; it++) {
2550     // We may go through BB multiple times so skip the one we have checked.
2551     if (!VisitedInstrs.insert(it))
2552       continue;
2553
2554     if (isa<DbgInfoIntrinsic>(it))
2555       continue;
2556
2557     // Try to vectorize reductions that use PHINodes.
2558     if (PHINode *P = dyn_cast<PHINode>(it)) {
2559       // Check that the PHI is a reduction PHI.
2560       if (P->getNumIncomingValues() != 2)
2561         return Changed;
2562       Value *Rdx =
2563           (P->getIncomingBlock(0) == BB
2564                ? (P->getIncomingValue(0))
2565                : (P->getIncomingBlock(1) == BB ? P->getIncomingValue(1) : 0));
2566       // Check if this is a Binary Operator.
2567       BinaryOperator *BI = dyn_cast_or_null<BinaryOperator>(Rdx);
2568       if (!BI)
2569         continue;
2570
2571       // Try to match and vectorize a horizontal reduction.
2572       HorizontalReduction HorRdx;
2573       if (ShouldVectorizeHor &&
2574           HorRdx.matchAssociativeReduction(P, BI, DL) &&
2575           HorRdx.tryToReduce(R, TTI)) {
2576         Changed = true;
2577         it = BB->begin();
2578         e = BB->end();
2579         continue;
2580       }
2581
2582      Value *Inst = BI->getOperand(0);
2583       if (Inst == P)
2584         Inst = BI->getOperand(1);
2585
2586       if (tryToVectorize(dyn_cast<BinaryOperator>(Inst), R)) {
2587         // We would like to start over since some instructions are deleted
2588         // and the iterator may become invalid value.
2589         Changed = true;
2590         it = BB->begin();
2591         e = BB->end();
2592         continue;
2593       }
2594
2595       continue;
2596     }
2597
2598     // Try to vectorize horizontal reductions feeding into a store.
2599     if (ShouldStartVectorizeHorAtStore)
2600       if (StoreInst *SI = dyn_cast<StoreInst>(it))
2601         if (BinaryOperator *BinOp =
2602                 dyn_cast<BinaryOperator>(SI->getValueOperand())) {
2603           HorizontalReduction HorRdx;
2604           if (((HorRdx.matchAssociativeReduction(0, BinOp, DL) &&
2605                 HorRdx.tryToReduce(R, TTI)) ||
2606                tryToVectorize(BinOp, R))) {
2607             Changed = true;
2608             it = BB->begin();
2609             e = BB->end();
2610             continue;
2611           }
2612         }
2613
2614     // Try to vectorize trees that start at compare instructions.
2615     if (CmpInst *CI = dyn_cast<CmpInst>(it)) {
2616       if (tryToVectorizePair(CI->getOperand(0), CI->getOperand(1), R)) {
2617         Changed = true;
2618         // We would like to start over since some instructions are deleted
2619         // and the iterator may become invalid value.
2620         it = BB->begin();
2621         e = BB->end();
2622         continue;
2623       }
2624
2625       for (int i = 0; i < 2; ++i) {
2626          if (BinaryOperator *BI = dyn_cast<BinaryOperator>(CI->getOperand(i))) {
2627             if (tryToVectorizePair(BI->getOperand(0), BI->getOperand(1), R)) {
2628               Changed = true;
2629               // We would like to start over since some instructions are deleted
2630               // and the iterator may become invalid value.
2631               it = BB->begin();
2632               e = BB->end();
2633             }
2634          }
2635       }
2636       continue;
2637     }
2638
2639     // Try to vectorize trees that start at insertelement instructions.
2640     if (InsertElementInst *IE = dyn_cast<InsertElementInst>(it)) {
2641       SmallVector<Value *, 8> Ops;
2642       if (!findBuildVector(IE, Ops))
2643         continue;
2644
2645       if (tryToVectorizeList(Ops, R)) {
2646         Changed = true;
2647         it = BB->begin();
2648         e = BB->end();
2649       }
2650
2651       continue;
2652     }
2653   }
2654
2655   return Changed;
2656 }
2657
2658 bool SLPVectorizer::vectorizeStoreChains(BoUpSLP &R) {
2659   bool Changed = false;
2660   // Attempt to sort and vectorize each of the store-groups.
2661   for (StoreListMap::iterator it = StoreRefs.begin(), e = StoreRefs.end();
2662        it != e; ++it) {
2663     if (it->second.size() < 2)
2664       continue;
2665
2666     DEBUG(dbgs() << "SLP: Analyzing a store chain of length "
2667           << it->second.size() << ".\n");
2668
2669     // Process the stores in chunks of 16.
2670     for (unsigned CI = 0, CE = it->second.size(); CI < CE; CI+=16) {
2671       unsigned Len = std::min<unsigned>(CE - CI, 16);
2672       ArrayRef<StoreInst *> Chunk(&it->second[CI], Len);
2673       Changed |= vectorizeStores(Chunk, -SLPCostThreshold, R);
2674     }
2675   }
2676   return Changed;
2677 }
2678
2679 } // end anonymous namespace
2680
2681 char SLPVectorizer::ID = 0;
2682 static const char lv_name[] = "SLP Vectorizer";
2683 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false)
2684 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
2685 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
2686 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
2687 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
2688 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false)
2689
2690 namespace llvm {
2691 Pass *createSLPVectorizerPass() { return new SLPVectorizer(); }
2692 }