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/ScalarEvolution.h"
  27 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  28 #include "llvm/Analysis/AliasAnalysis.h"
  29 #include "llvm/Analysis/TargetTransformInfo.h"
  30 #include "llvm/Analysis/Verifier.h"
  31 #include "llvm/Analysis/LoopInfo.h"
  32 #include "llvm/IR/DataLayout.h"
  33 #include "llvm/IR/Instructions.h"
  34 #include "llvm/IR/IntrinsicInst.h"
  35 #include "llvm/IR/IRBuilder.h"
  36 #include "llvm/IR/Module.h"
  37 #include "llvm/IR/Type.h"
  38 #include "llvm/IR/Value.h"
  39 #include "llvm/Pass.h"
  40 #include "llvm/Support/CommandLine.h"
  41 #include "llvm/Support/Debug.h"
  42 #include "llvm/Support/raw_ostream.h"
  43 #include <algorithm>
  44 #include <map>
  45
  46 using namespace llvm;
  47
  48 static cl::opt<int>
  49     SLPCostThreshold("slp-threshold", cl::init(0), cl::Hidden,
  50                      cl::desc("Only vectorize if you gain more than this "
  51                               "number "));
  52 namespace {
  53
  54 static const unsigned MinVecRegSize = 128;
  55
  56 static const unsigned RecursionMaxDepth = 12;
  57
  58 /// RAII pattern to save the insertion point of the IR builder.
  59 class BuilderLocGuard {
  60 public:
  61   BuilderLocGuard(IRBuilder<> &B) : Builder(B), Loc(B.GetInsertPoint()) {}
  62   ~BuilderLocGuard() { if (Loc) Builder.SetInsertPoint(Loc); }
  63
  64 private:
  65   // Prevent copying.
  66   BuilderLocGuard(const BuilderLocGuard &);
  67   BuilderLocGuard &operator=(const BuilderLocGuard &);
  68   IRBuilder<> &Builder;
  69   AssertingVH<Instruction> Loc;
  70 };
  71
  72 /// A helper class for numbering instructions in multible blocks.
  73 /// Numbers starts at zero for each basic block.
  74 struct BlockNumbering {
  75
  76   BlockNumbering(BasicBlock *Bb) : BB(Bb), Valid(false) {}
  77
  78   BlockNumbering() : BB(0), Valid(false) {}
  79
  80   void numberInstructions() {
  81     unsigned Loc = 0;
  82     InstrIdx.clear();
  83     InstrVec.clear();
  84     // Number the instructions in the block.
  85     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
  86       InstrIdx[it] = Loc++;
  87       InstrVec.push_back(it);
  88       assert(InstrVec[InstrIdx[it]] == it && "Invalid allocation");
  89     }
  90     Valid = true;
  91   }
  92
  93   int getIndex(Instruction *I) {
  94     assert(I->getParent() == BB && "Invalid instruction");
  95     if (!Valid)
  96       numberInstructions();
  97     assert(InstrIdx.count(I) && "Unknown instruction");
  98     return InstrIdx[I];
  99   }
 100
 101   Instruction *getInstruction(unsigned loc) {
 102     if (!Valid)
 103       numberInstructions();
 104     assert(InstrVec.size() > loc && "Invalid Index");
 105     return InstrVec[loc];
 106   }
 107
 108   void forget() { Valid = false; }
 109
 110 private:
 111   /// The block we are numbering.
 112   BasicBlock *BB;
 113   /// Is the block numbered.
 114   bool Valid;
 115   /// Maps instructions to numbers and back.
 116   SmallDenseMap<Instruction *, int> InstrIdx;
 117   /// Maps integers to Instructions.
 118   std::vector<Instruction *> InstrVec;
 119 };
 120
 121 /// \returns the parent basic block if all of the instructions in \p VL
 122 /// are in the same block or null otherwise.
 123 static BasicBlock *getSameBlock(ArrayRef<Value *> VL) {
 124   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
 125   if (!I0)
 126     return 0;
 127   BasicBlock *BB = I0->getParent();
 128   for (int i = 1, e = VL.size(); i < e; i++) {
 129     Instruction *I = dyn_cast<Instruction>(VL[i]);
 130     if (!I)
 131       return 0;
 132
 133     if (BB != I->getParent())
 134       return 0;
 135   }
 136   return BB;
 137 }
 138
 139 /// \returns True if all of the values in \p VL are constants.
 140 static bool allConstant(ArrayRef<Value *> VL) {
 141   for (unsigned i = 0, e = VL.size(); i < e; ++i)
 142     if (!isa<Constant>(VL[i]))
 143       return false;
 144   return true;
 145 }
 146
 147 /// \returns True if all of the values in \p VL are identical.
 148 static bool isSplat(ArrayRef<Value *> VL) {
 149   for (unsigned i = 1, e = VL.size(); i < e; ++i)
 150     if (VL[i] != VL[0])
 151       return false;
 152   return true;
 153 }
 154
 155 /// \returns The opcode if all of the Instructions in \p VL have the same
 156 /// opcode, or zero.
 157 static unsigned getSameOpcode(ArrayRef<Value *> VL) {
 158   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
 159   if (!I0)
 160     return 0;
 161   unsigned Opcode = I0->getOpcode();
 162   for (int i = 1, e = VL.size(); i < e; i++) {
 163     Instruction *I = dyn_cast<Instruction>(VL[i]);
 164     if (!I || Opcode != I->getOpcode())
 165       return 0;
 166   }
 167   return Opcode;
 168 }
 169
 170 /// \returns The type that all of the values in \p VL have or null if there
 171 /// are different types.
 172 static Type* getSameType(ArrayRef<Value *> VL) {
 173   Type *Ty = VL[0]->getType();
 174   for (int i = 1, e = VL.size(); i < e; i++)
 175     if (VL[i]->getType() != Ty)
 176       return 0;
 177
 178   return Ty;
 179 }
 180
 181 /// \returns True if the ExtractElement instructions in VL can be vectorized
 182 /// to use the original vector.
 183 static bool CanReuseExtract(ArrayRef<Value *> VL) {
 184   assert(Instruction::ExtractElement == getSameOpcode(VL) && "Invalid opcode");
 185   // Check if all of the extracts come from the same vector and from the
 186   // correct offset.
 187   Value *VL0 = VL[0];
 188   ExtractElementInst *E0 = cast<ExtractElementInst>(VL0);
 189   Value *Vec = E0->getOperand(0);
 190
 191   // We have to extract from the same vector type.
 192   unsigned NElts = Vec->getType()->getVectorNumElements();
 193
 194   if (NElts != VL.size())
 195     return false;
 196
 197   // Check that all of the indices extract from the correct offset.
 198   ConstantInt *CI = dyn_cast<ConstantInt>(E0->getOperand(1));
 199   if (!CI || CI->getZExtValue())
 200     return false;
 201
 202   for (unsigned i = 1, e = VL.size(); i < e; ++i) {
 203     ExtractElementInst *E = cast<ExtractElementInst>(VL[i]);
 204     ConstantInt *CI = dyn_cast<ConstantInt>(E->getOperand(1));
 205
 206     if (!CI || CI->getZExtValue() != i || E->getOperand(0) != Vec)
 207       return false;
 208   }
 209
 210   return true;
 211 }
 212
 213 /// Bottom Up SLP Vectorizer.
 214 class BoUpSLP {
 215 public:
 216   typedef SmallVector<Value *, 8> ValueList;
 217   typedef SmallVector<Instruction *, 16> InstrList;
 218   typedef SmallPtrSet<Value *, 16> ValueSet;
 219   typedef SmallVector<StoreInst *, 8> StoreList;
 220
 221   BoUpSLP(Function *Func, ScalarEvolution *Se, DataLayout *Dl,
 222           TargetTransformInfo *Tti, AliasAnalysis *Aa, LoopInfo *Li,
 223           DominatorTree *Dt) :
 224     F(Func), SE(Se), DL(Dl), TTI(Tti), AA(Aa), LI(Li), DT(Dt),
 225     Builder(Se->getContext()) {
 226       // Setup the block numbering utility for all of the blocks in the
 227       // function.
 228       for (Function::iterator it = F->begin(), e = F->end(); it != e; ++it) {
 229         BasicBlock *BB = it;
 230         BlocksNumbers[BB] = BlockNumbering(BB);
 231       }
 232     }
 233
 234   /// \brief Vectorize the tree that starts with the elements in \p VL.
 235   void vectorizeTree();
 236
 237   /// \returns the vectorization cost of the subtree that starts at \p VL.
 238   /// A negative number means that this is profitable.
 239   int getTreeCost();
 240
 241   /// Construct a vectorizable tree that starts at \p Roots.
 242   void buildTree(ArrayRef<Value *> Roots);
 243
 244   /// Clear the internal data structures that are created by 'buildTree'.
 245   void deleteTree() {
 246     VectorizableTree.clear();
 247     ScalarToTreeEntry.clear();
 248     MustGather.clear();
 249     ExternalUses.clear();
 250     MemBarrierIgnoreList.clear();
 251   }
 252
 253   /// \returns true if the memory operations A and B are consecutive.
 254   bool isConsecutiveAccess(Value *A, Value *B);
 255
 256   /// \brief Perform LICM and CSE on the newly generated gather sequences.
 257   void optimizeGatherSequence();
 258 private:
 259   struct TreeEntry;
 260
 261   /// \returns the cost of the vectorizable entry.
 262   int getEntryCost(TreeEntry *E);
 263
 264   /// This is the recursive part of buildTree.
 265   void buildTree_rec(ArrayRef<Value *> Roots, unsigned Depth);
 266
 267   /// Vectorizer a single entry in the tree.
 268   Value *vectorizeTree(TreeEntry *E);
 269
 270   /// Vectorizer a single entry in the tree, starting in \p VL.
 271   Value *vectorizeTree(ArrayRef<Value *> VL);
 272
 273   /// \brief Take the pointer operand from the Load/Store instruction.
 274   /// \returns NULL if this is not a valid Load/Store instruction.
 275   static Value *getPointerOperand(Value *I);
 276
 277   /// \brief Take the address space operand from the Load/Store instruction.
 278   /// \returns -1 if this is not a valid Load/Store instruction.
 279   static unsigned getAddressSpaceOperand(Value *I);
 280
 281   /// \returns the scalarization cost for this type. Scalarization in this
 282   /// context means the creation of vectors from a group of scalars.
 283   int getGatherCost(Type *Ty);
 284
 285   /// \returns the scalarization cost for this list of values. Assuming that
 286   /// this subtree gets vectorized, we may need to extract the values from the
 287   /// roots. This method calculates the cost of extracting the values.
 288   int getGatherCost(ArrayRef<Value *> VL);
 289
 290   /// \returns the AA location that is being access by the instruction.
 291   AliasAnalysis::Location getLocation(Instruction *I);
 292
 293   /// \brief Checks if it is possible to sink an instruction from
 294   /// \p Src to \p Dst.
 295   /// \returns the pointer to the barrier instruction if we can't sink.
 296   Value *getSinkBarrier(Instruction *Src, Instruction *Dst);
 297
 298   /// \returns the index of the last instrucion in the BB from \p VL.
 299   int getLastIndex(ArrayRef<Value *> VL);
 300
 301   /// \returns the Instrucion in the bundle \p VL.
 302   Instruction *getLastInstruction(ArrayRef<Value *> VL);
 303
 304   /// \returns the Instruction at index \p Index which is in Block \p BB.
 305   Instruction *getInstructionForIndex(unsigned Index, BasicBlock *BB);
 306
 307   /// \returns the index of the first User of \p VL.
 308   int getFirstUserIndex(ArrayRef<Value *> VL);
 309
 310   /// \returns a vector from a collection of scalars in \p VL.
 311   Value *Gather(ArrayRef<Value *> VL, VectorType *Ty);
 312
 313   struct TreeEntry {
 314     TreeEntry() : Scalars(), VectorizedValue(0), LastScalarIndex(0),
 315     NeedToGather(0) {}
 316
 317     /// \returns true if the scalars in VL are equal to this entry.
 318     bool isSame(ArrayRef<Value *> VL) {
 319       assert(VL.size() == Scalars.size() && "Invalid size");
 320       for (int i = 0, e = VL.size(); i != e; ++i)
 321         if (VL[i] != Scalars[i])
 322           return false;
 323       return true;
 324     }
 325
 326     /// A vector of scalars.
 327     ValueList Scalars;
 328
 329     /// The Scalars are vectorized into this value. It is initialized to Null.
 330     Value *VectorizedValue;
 331
 332     /// The index in the basic block of the last scalar.
 333     int LastScalarIndex;
 334
 335     /// Do we need to gather this sequence ?
 336     bool NeedToGather;
 337   };
 338
 339   /// Create a new VectorizableTree entry.
 340   TreeEntry *newTreeEntry(ArrayRef<Value *> VL, bool Vectorized) {
 341     VectorizableTree.push_back(TreeEntry());
 342     int idx = VectorizableTree.size() - 1;
 343     TreeEntry *Last = &VectorizableTree[idx];
 344     Last->Scalars.insert(Last->Scalars.begin(), VL.begin(), VL.end());
 345     Last->NeedToGather = !Vectorized;
 346     if (Vectorized) {
 347       Last->LastScalarIndex = getLastIndex(VL);
 348       for (int i = 0, e = VL.size(); i != e; ++i) {
 349         assert(!ScalarToTreeEntry.count(VL[i]) && "Scalar already in tree!");
 350         ScalarToTreeEntry[VL[i]] = idx;
 351       }
 352     } else {
 353       Last->LastScalarIndex = 0;
 354       MustGather.insert(VL.begin(), VL.end());
 355     }
 356     return Last;
 357   }
 358
 359   /// -- Vectorization State --
 360   /// Holds all of the tree entries.
 361   std::vector<TreeEntry> VectorizableTree;
 362
 363   /// Maps a specific scalar to its tree entry.
 364   SmallDenseMap<Value*, int> ScalarToTreeEntry;
 365
 366   /// A list of scalars that we found that we need to keep as scalars.
 367   ValueSet MustGather;
 368
 369   /// This POD struct describes one external user in the vectorized tree.
 370   struct ExternalUser {
 371     ExternalUser (Value *S, llvm::User *U, int L) :
 372       Scalar(S), User(U), Lane(L){};
 373     // Which scalar in our function.
 374     Value *Scalar;
 375     // Which user that uses the scalar.
 376     llvm::User *User;
 377     // Which lane does the scalar belong to.
 378     int Lane;
 379   };
 380   typedef SmallVector<ExternalUser, 16> UserList;
 381
 382   /// A list of values that need to extracted out of the tree.
 383   /// This list holds pairs of (Internal Scalar : External User).
 384   UserList ExternalUses;
 385
 386   /// A list of instructions to ignore while sinking
 387   /// memory instructions. This map must be reset between runs of getCost.
 388   ValueSet MemBarrierIgnoreList;
 389
 390   /// Holds all of the instructions that we gathered.
 391   SetVector<Instruction *> GatherSeq;
 392
 393   /// Numbers instructions in different blocks.
 394   std::map<BasicBlock *, BlockNumbering> BlocksNumbers;
 395
 396   // Analysis and block reference.
 397   Function *F;
 398   ScalarEvolution *SE;
 399   DataLayout *DL;
 400   TargetTransformInfo *TTI;
 401   AliasAnalysis *AA;
 402   LoopInfo *LI;
 403   DominatorTree *DT;
 404   /// Instruction builder to construct the vectorized tree.
 405   IRBuilder<> Builder;
 406 };
 407
 408 void BoUpSLP::buildTree(ArrayRef<Value *> Roots) {
 409   deleteTree();
 410   if (!getSameType(Roots))
 411     return;
 412   buildTree_rec(Roots, 0);
 413
 414   // Collect the values that we need to extract from the tree.
 415   for (int EIdx = 0, EE = VectorizableTree.size(); EIdx < EE; ++EIdx) {
 416     TreeEntry *Entry = &VectorizableTree[EIdx];
 417
 418     // For each lane:
 419     for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) {
 420       Value *Scalar = Entry->Scalars[Lane];
 421
 422       // No need to handle users of gathered values.
 423       if (Entry->NeedToGather)
 424         continue;
 425
 426       for (Value::use_iterator User = Scalar->use_begin(),
 427            UE = Scalar->use_end(); User != UE; ++User) {
 428         DEBUG(dbgs() << "SLP: Checking user:" << **User << ".\n");
 429
 430         bool Gathered = MustGather.count(*User);
 431
 432         // Skip in-tree scalars that become vectors.
 433         if (ScalarToTreeEntry.count(*User) && !Gathered) {
 434           DEBUG(dbgs() << "SLP: \tInternal user will be removed:" <<
 435                 **User << ".\n");
 436           int Idx = ScalarToTreeEntry[*User]; (void) Idx;
 437           assert(!VectorizableTree[Idx].NeedToGather && "Bad state");
 438           continue;
 439         }
 440
 441         if (!isa<Instruction>(*User))
 442           continue;
 443
 444         DEBUG(dbgs() << "SLP: Need to extract:" << **User << " from lane " <<
 445               Lane << " from " << *Scalar << ".\n");
 446         ExternalUses.push_back(ExternalUser(Scalar, *User, Lane));
 447       }
 448     }
 449   }
 450 }
 451
 452
 453 void BoUpSLP::buildTree_rec(ArrayRef<Value *> VL, unsigned Depth) {
 454   bool SameTy = getSameType(VL); (void)SameTy;
 455   assert(SameTy && "Invalid types!");
 456
 457   if (Depth == RecursionMaxDepth) {
 458     DEBUG(dbgs() << "SLP: Gathering due to max recursion depth.\n");
 459     newTreeEntry(VL, false);
 460     return;
 461   }
 462
 463   // Don't handle vectors.
 464   if (VL[0]->getType()->isVectorTy()) {
 465     DEBUG(dbgs() << "SLP: Gathering due to vector type.\n");
 466     newTreeEntry(VL, false);
 467     return;
 468   }
 469
 470   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
 471     if (SI->getValueOperand()->getType()->isVectorTy()) {
 472       DEBUG(dbgs() << "SLP: Gathering due to store vector type.\n");
 473       newTreeEntry(VL, false);
 474       return;
 475     }
 476
 477   // If all of the operands are identical or constant we have a simple solution.
 478   if (allConstant(VL) || isSplat(VL) || !getSameBlock(VL) ||
 479       !getSameOpcode(VL)) {
 480     DEBUG(dbgs() << "SLP: Gathering due to C,S,B,O. \n");
 481     newTreeEntry(VL, false);
 482     return;
 483   }
 484
 485   // We now know that this is a vector of instructions of the same type from
 486   // the same block.
 487
 488   // Check if this is a duplicate of another entry.
 489   if (ScalarToTreeEntry.count(VL[0])) {
 490     int Idx = ScalarToTreeEntry[VL[0]];
 491     TreeEntry *E = &VectorizableTree[Idx];
 492     for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 493       DEBUG(dbgs() << "SLP: \tChecking bundle: " << *VL[i] << ".\n");
 494       if (E->Scalars[i] != VL[i]) {
 495         DEBUG(dbgs() << "SLP: Gathering due to partial overlap.\n");
 496         newTreeEntry(VL, false);
 497         return;
 498       }
 499     }
 500     DEBUG(dbgs() << "SLP: Perfect diamond merge at " << *VL[0] << ".\n");
 501     return;
 502   }
 503
 504   // Check that none of the instructions in the bundle are already in the tree.
 505   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 506     if (ScalarToTreeEntry.count(VL[i])) {
 507       DEBUG(dbgs() << "SLP: The instruction (" << *VL[i] <<
 508             ") is already in tree.\n");
 509       newTreeEntry(VL, false);
 510       return;
 511     }
 512   }
 513
 514   // If any of the scalars appears in the table OR it is marked as a value that
 515   // needs to stat scalar then we need to gather the scalars.
 516   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 517     if (ScalarToTreeEntry.count(VL[i]) || MustGather.count(VL[i])) {
 518       DEBUG(dbgs() << "SLP: Gathering due to gathered scalar. \n");
 519       newTreeEntry(VL, false);
 520       return;
 521     }
 522   }
 523
 524   // Check that all of the users of the scalars that we want to vectorize are
 525   // schedulable.
 526   Instruction *VL0 = cast<Instruction>(VL[0]);
 527   int MyLastIndex = getLastIndex(VL);
 528   BasicBlock *BB = cast<Instruction>(VL0)->getParent();
 529
 530   for (unsigned i = 0, e = VL.size(); i != e; ++i) {
 531     Instruction *Scalar = cast<Instruction>(VL[i]);
 532     DEBUG(dbgs() << "SLP: Checking users of  " << *Scalar << ". \n");
 533     for (Value::use_iterator U = Scalar->use_begin(), UE = Scalar->use_end();
 534          U != UE; ++U) {
 535       DEBUG(dbgs() << "SLP: \tUser " << **U << ". \n");
 536       Instruction *User = dyn_cast<Instruction>(*U);
 537       if (!User) {
 538         DEBUG(dbgs() << "SLP: Gathering due unknown user. \n");
 539         newTreeEntry(VL, false);
 540         return;
 541       }
 542
 543       // We don't care if the user is in a different basic block.
 544       BasicBlock *UserBlock = User->getParent();
 545       if (UserBlock != BB) {
 546         DEBUG(dbgs() << "SLP: User from a different basic block "
 547               << *User << ". \n");
 548         continue;
 549       }
 550
 551       // If this is a PHINode within this basic block then we can place the
 552       // extract wherever we want.
 553       if (isa<PHINode>(*User)) {
 554         DEBUG(dbgs() << "SLP: \tWe can schedule PHIs:" << *User << ". \n");
 555         continue;
 556       }
 557
 558       // Check if this is a safe in-tree user.
 559       if (ScalarToTreeEntry.count(User)) {
 560         int Idx = ScalarToTreeEntry[User];
 561         int VecLocation = VectorizableTree[Idx].LastScalarIndex;
 562         if (VecLocation <= MyLastIndex) {
 563           DEBUG(dbgs() << "SLP: Gathering due to unschedulable vector. \n");
 564           newTreeEntry(VL, false);
 565           return;
 566         }
 567         DEBUG(dbgs() << "SLP: In-tree user (" << *User << ") at #" <<
 568               VecLocation << " vector value (" << *Scalar << ") at #"
 569               << MyLastIndex << ".\n");
 570         continue;
 571       }
 572
 573       // Make sure that we can schedule this unknown user.
 574       BlockNumbering &BN = BlocksNumbers[BB];
 575       int UserIndex = BN.getIndex(User);
 576       if (UserIndex < MyLastIndex) {
 577
 578         DEBUG(dbgs() << "SLP: Can't schedule extractelement for "
 579               << *User << ". \n");
 580         newTreeEntry(VL, false);
 581         return;
 582       }
 583     }
 584   }
 585
 586   // Check that every instructions appears once in this bundle.
 587   for (unsigned i = 0, e = VL.size(); i < e; ++i)
 588     for (unsigned j = i+1; j < e; ++j)
 589       if (VL[i] == VL[j]) {
 590         DEBUG(dbgs() << "SLP: Scalar used twice in bundle.\n");
 591         newTreeEntry(VL, false);
 592         return;
 593       }
 594
 595   // Check that instructions in this bundle don't reference other instructions.
 596   // The runtime of this check is O(N * N-1 * uses(N)) and a typical N is 4.
 597   for (unsigned i = 0, e = VL.size(); i < e; ++i) {
 598     for (Value::use_iterator U = VL[i]->use_begin(), UE = VL[i]->use_end();
 599          U != UE; ++U) {
 600       for (unsigned j = 0; j < e; ++j) {
 601         if (i != j && *U == VL[j]) {
 602           DEBUG(dbgs() << "SLP: Intra-bundle dependencies!" << **U << ". \n");
 603           newTreeEntry(VL, false);
 604           return;
 605         }
 606       }
 607     }
 608   }
 609
 610   DEBUG(dbgs() << "SLP: We are able to schedule this bundle.\n");
 611
 612   unsigned Opcode = getSameOpcode(VL);
 613
 614   // Check if it is safe to sink the loads or the stores.
 615   if (Opcode == Instruction::Load || Opcode == Instruction::Store) {
 616     Instruction *Last = getLastInstruction(VL);
 617
 618     for (unsigned i = 0, e = VL.size(); i < e; ++i) {
 619       if (VL[i] == Last)
 620         continue;
 621       Value *Barrier = getSinkBarrier(cast<Instruction>(VL[i]), Last);
 622       if (Barrier) {
 623         DEBUG(dbgs() << "SLP: Can't sink " << *VL[i] << "\n down to " << *Last
 624               << "\n because of " << *Barrier << ".  Gathering.\n");
 625         newTreeEntry(VL, false);
 626         return;
 627       }
 628     }
 629   }
 630
 631   switch (Opcode) {
 632     case Instruction::PHI: {
 633       PHINode *PH = dyn_cast<PHINode>(VL0);
 634       newTreeEntry(VL, true);
 635       DEBUG(dbgs() << "SLP: added a vector of PHINodes.\n");
 636
 637       for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
 638         ValueList Operands;
 639         // Prepare the operand vector.
 640         for (unsigned j = 0; j < VL.size(); ++j)
 641           Operands.push_back(cast<PHINode>(VL[j])->getIncomingValue(i));
 642
 643         buildTree_rec(Operands, Depth + 1);
 644       }
 645       return;
 646     }
 647     case Instruction::ExtractElement: {
 648       bool Reuse = CanReuseExtract(VL);
 649       if (Reuse) {
 650         DEBUG(dbgs() << "SLP: Reusing extract sequence.\n");
 651       }
 652       newTreeEntry(VL, Reuse);
 653       return;
 654     }
 655     case Instruction::Load: {
 656       // Check if the loads are consecutive or of we need to swizzle them.
 657       for (unsigned i = 0, e = VL.size() - 1; i < e; ++i)
 658         if (!isConsecutiveAccess(VL[i], VL[i + 1])) {
 659           newTreeEntry(VL, false);
 660           DEBUG(dbgs() << "SLP: Need to swizzle loads.\n");
 661           return;
 662         }
 663
 664       newTreeEntry(VL, true);
 665       DEBUG(dbgs() << "SLP: added a vector of loads.\n");
 666       return;
 667     }
 668     case Instruction::ZExt:
 669     case Instruction::SExt:
 670     case Instruction::FPToUI:
 671     case Instruction::FPToSI:
 672     case Instruction::FPExt:
 673     case Instruction::PtrToInt:
 674     case Instruction::IntToPtr:
 675     case Instruction::SIToFP:
 676     case Instruction::UIToFP:
 677     case Instruction::Trunc:
 678     case Instruction::FPTrunc:
 679     case Instruction::BitCast: {
 680       Type *SrcTy = VL0->getOperand(0)->getType();
 681       for (unsigned i = 0; i < VL.size(); ++i) {
 682         Type *Ty = cast<Instruction>(VL[i])->getOperand(0)->getType();
 683         if (Ty != SrcTy || Ty->isAggregateType() || Ty->isVectorTy()) {
 684           newTreeEntry(VL, false);
 685           DEBUG(dbgs() << "SLP: Gathering casts with different src types.\n");
 686           return;
 687         }
 688       }
 689       newTreeEntry(VL, true);
 690       DEBUG(dbgs() << "SLP: added a vector of casts.\n");
 691
 692       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
 693         ValueList Operands;
 694         // Prepare the operand vector.
 695         for (unsigned j = 0; j < VL.size(); ++j)
 696           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
 697
 698         buildTree_rec(Operands, Depth+1);
 699       }
 700       return;
 701     }
 702     case Instruction::ICmp:
 703     case Instruction::FCmp: {
 704       // Check that all of the compares have the same predicate.
 705       CmpInst::Predicate P0 = dyn_cast<CmpInst>(VL0)->getPredicate();
 706       Type *ComparedTy = cast<Instruction>(VL[0])->getOperand(0)->getType();
 707       for (unsigned i = 1, e = VL.size(); i < e; ++i) {
 708         CmpInst *Cmp = cast<CmpInst>(VL[i]);
 709         if (Cmp->getPredicate() != P0 ||
 710             Cmp->getOperand(0)->getType() != ComparedTy) {
 711           newTreeEntry(VL, false);
 712           DEBUG(dbgs() << "SLP: Gathering cmp with different predicate.\n");
 713           return;
 714         }
 715       }
 716
 717       newTreeEntry(VL, true);
 718       DEBUG(dbgs() << "SLP: added a vector of compares.\n");
 719
 720       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
 721         ValueList Operands;
 722         // Prepare the operand vector.
 723         for (unsigned j = 0; j < VL.size(); ++j)
 724           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
 725
 726         buildTree_rec(Operands, Depth+1);
 727       }
 728       return;
 729     }
 730     case Instruction::Select:
 731     case Instruction::Add:
 732     case Instruction::FAdd:
 733     case Instruction::Sub:
 734     case Instruction::FSub:
 735     case Instruction::Mul:
 736     case Instruction::FMul:
 737     case Instruction::UDiv:
 738     case Instruction::SDiv:
 739     case Instruction::FDiv:
 740     case Instruction::URem:
 741     case Instruction::SRem:
 742     case Instruction::FRem:
 743     case Instruction::Shl:
 744     case Instruction::LShr:
 745     case Instruction::AShr:
 746     case Instruction::And:
 747     case Instruction::Or:
 748     case Instruction::Xor: {
 749       newTreeEntry(VL, true);
 750       DEBUG(dbgs() << "SLP: added a vector of bin op.\n");
 751
 752       for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) {
 753         ValueList Operands;
 754         // Prepare the operand vector.
 755         for (unsigned j = 0; j < VL.size(); ++j)
 756           Operands.push_back(cast<Instruction>(VL[j])->getOperand(i));
 757
 758         buildTree_rec(Operands, Depth+1);
 759       }
 760       return;
 761     }
 762     case Instruction::Store: {
 763       // Check if the stores are consecutive or of we need to swizzle them.
 764       for (unsigned i = 0, e = VL.size() - 1; i < e; ++i)
 765         if (!isConsecutiveAccess(VL[i], VL[i + 1])) {
 766           newTreeEntry(VL, false);
 767           DEBUG(dbgs() << "SLP: Non consecutive store.\n");
 768           return;
 769         }
 770
 771       newTreeEntry(VL, true);
 772       DEBUG(dbgs() << "SLP: added a vector of stores.\n");
 773
 774       ValueList Operands;
 775       for (unsigned j = 0; j < VL.size(); ++j)
 776         Operands.push_back(cast<Instruction>(VL[j])->getOperand(0));
 777
 778       // We can ignore these values because we are sinking them down.
 779       MemBarrierIgnoreList.insert(VL.begin(), VL.end());
 780       buildTree_rec(Operands, Depth + 1);
 781       return;
 782     }
 783     default:
 784       newTreeEntry(VL, false);
 785       DEBUG(dbgs() << "SLP: Gathering unknown instruction.\n");
 786       return;
 787   }
 788 }
 789
 790 int BoUpSLP::getEntryCost(TreeEntry *E) {
 791   ArrayRef<Value*> VL = E->Scalars;
 792
 793   Type *ScalarTy = VL[0]->getType();
 794   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
 795     ScalarTy = SI->getValueOperand()->getType();
 796   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
 797
 798   if (E->NeedToGather) {
 799     if (allConstant(VL))
 800       return 0;
 801     if (isSplat(VL)) {
 802       return TTI->getShuffleCost(TargetTransformInfo::SK_Broadcast, VecTy, 0);
 803     }
 804     return getGatherCost(E->Scalars);
 805   }
 806
 807   assert(getSameOpcode(VL) && getSameType(VL) && getSameBlock(VL) &&
 808          "Invalid VL");
 809   Instruction *VL0 = cast<Instruction>(VL[0]);
 810   unsigned Opcode = VL0->getOpcode();
 811   switch (Opcode) {
 812     case Instruction::PHI: {
 813       return 0;
 814     }
 815     case Instruction::ExtractElement: {
 816       if (CanReuseExtract(VL))
 817         return 0;
 818       return getGatherCost(VecTy);
 819     }
 820     case Instruction::ZExt:
 821     case Instruction::SExt:
 822     case Instruction::FPToUI:
 823     case Instruction::FPToSI:
 824     case Instruction::FPExt:
 825     case Instruction::PtrToInt:
 826     case Instruction::IntToPtr:
 827     case Instruction::SIToFP:
 828     case Instruction::UIToFP:
 829     case Instruction::Trunc:
 830     case Instruction::FPTrunc:
 831     case Instruction::BitCast: {
 832       Type *SrcTy = VL0->getOperand(0)->getType();
 833
 834       // Calculate the cost of this instruction.
 835       int ScalarCost = VL.size() * TTI->getCastInstrCost(VL0->getOpcode(),
 836                                                          VL0->getType(), SrcTy);
 837
 838       VectorType *SrcVecTy = VectorType::get(SrcTy, VL.size());
 839       int VecCost = TTI->getCastInstrCost(VL0->getOpcode(), VecTy, SrcVecTy);
 840       return VecCost - ScalarCost;
 841     }
 842     case Instruction::FCmp:
 843     case Instruction::ICmp:
 844     case Instruction::Select:
 845     case Instruction::Add:
 846     case Instruction::FAdd:
 847     case Instruction::Sub:
 848     case Instruction::FSub:
 849     case Instruction::Mul:
 850     case Instruction::FMul:
 851     case Instruction::UDiv:
 852     case Instruction::SDiv:
 853     case Instruction::FDiv:
 854     case Instruction::URem:
 855     case Instruction::SRem:
 856     case Instruction::FRem:
 857     case Instruction::Shl:
 858     case Instruction::LShr:
 859     case Instruction::AShr:
 860     case Instruction::And:
 861     case Instruction::Or:
 862     case Instruction::Xor: {
 863       // Calculate the cost of this instruction.
 864       int ScalarCost = 0;
 865       int VecCost = 0;
 866       if (Opcode == Instruction::FCmp || Opcode == Instruction::ICmp ||
 867           Opcode == Instruction::Select) {
 868         VectorType *MaskTy = VectorType::get(Builder.getInt1Ty(), VL.size());
 869         ScalarCost = VecTy->getNumElements() *
 870         TTI->getCmpSelInstrCost(Opcode, ScalarTy, Builder.getInt1Ty());
 871         VecCost = TTI->getCmpSelInstrCost(Opcode, VecTy, MaskTy);
 872       } else {
 873         ScalarCost = VecTy->getNumElements() *
 874         TTI->getArithmeticInstrCost(Opcode, ScalarTy);
 875         VecCost = TTI->getArithmeticInstrCost(Opcode, VecTy);
 876       }
 877       return VecCost - ScalarCost;
 878     }
 879     case Instruction::Load: {
 880       // Cost of wide load - cost of scalar loads.
 881       int ScalarLdCost = VecTy->getNumElements() *
 882       TTI->getMemoryOpCost(Instruction::Load, ScalarTy, 1, 0);
 883       int VecLdCost = TTI->getMemoryOpCost(Instruction::Load, ScalarTy, 1, 0);
 884       return VecLdCost - ScalarLdCost;
 885     }
 886     case Instruction::Store: {
 887       // We know that we can merge the stores. Calculate the cost.
 888       int ScalarStCost = VecTy->getNumElements() *
 889       TTI->getMemoryOpCost(Instruction::Store, ScalarTy, 1, 0);
 890       int VecStCost = TTI->getMemoryOpCost(Instruction::Store, ScalarTy, 1, 0);
 891       return VecStCost - ScalarStCost;
 892     }
 893     default:
 894       llvm_unreachable("Unknown instruction");
 895   }
 896 }
 897
 898 int BoUpSLP::getTreeCost() {
 899   int Cost = 0;
 900   DEBUG(dbgs() << "SLP: Calculating cost for tree of size " <<
 901         VectorizableTree.size() << ".\n");
 902
 903   if (!VectorizableTree.size()) {
 904     assert(!ExternalUses.size() && "We should not have any external users");
 905     return 0;
 906   }
 907
 908   unsigned BundleWidth = VectorizableTree[0].Scalars.size();
 909
 910   for (unsigned i = 0, e = VectorizableTree.size(); i != e; ++i) {
 911     int C = getEntryCost(&VectorizableTree[i]);
 912     DEBUG(dbgs() << "SLP: Adding cost " << C << " for bundle that starts with "
 913           << *VectorizableTree[i].Scalars[0] << " .\n");
 914     Cost += C;
 915   }
 916
 917   int ExtractCost = 0;
 918   for (UserList::iterator I = ExternalUses.begin(), E = ExternalUses.end();
 919        I != E; ++I) {
 920
 921     VectorType *VecTy = VectorType::get(I->Scalar->getType(), BundleWidth);
 922     ExtractCost += TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy,
 923                                            I->Lane);
 924   }
 925
 926
 927   DEBUG(dbgs() << "SLP: Total Cost " << Cost + ExtractCost<< ".\n");
 928   return  Cost + ExtractCost;
 929 }
 930
 931 int BoUpSLP::getGatherCost(Type *Ty) {
 932   int Cost = 0;
 933   for (unsigned i = 0, e = cast<VectorType>(Ty)->getNumElements(); i < e; ++i)
 934     Cost += TTI->getVectorInstrCost(Instruction::InsertElement, Ty, i);
 935   return Cost;
 936 }
 937
 938 int BoUpSLP::getGatherCost(ArrayRef<Value *> VL) {
 939   // Find the type of the operands in VL.
 940   Type *ScalarTy = VL[0]->getType();
 941   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
 942     ScalarTy = SI->getValueOperand()->getType();
 943   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
 944   // Find the cost of inserting/extracting values from the vector.
 945   return getGatherCost(VecTy);
 946 }
 947
 948 AliasAnalysis::Location BoUpSLP::getLocation(Instruction *I) {
 949   if (StoreInst *SI = dyn_cast<StoreInst>(I))
 950     return AA->getLocation(SI);
 951   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 952     return AA->getLocation(LI);
 953   return AliasAnalysis::Location();
 954 }
 955
 956 Value *BoUpSLP::getPointerOperand(Value *I) {
 957   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 958     return LI->getPointerOperand();
 959   if (StoreInst *SI = dyn_cast<StoreInst>(I))
 960     return SI->getPointerOperand();
 961   return 0;
 962 }
 963
 964 unsigned BoUpSLP::getAddressSpaceOperand(Value *I) {
 965   if (LoadInst *L = dyn_cast<LoadInst>(I))
 966     return L->getPointerAddressSpace();
 967   if (StoreInst *S = dyn_cast<StoreInst>(I))
 968     return S->getPointerAddressSpace();
 969   return -1;
 970 }
 971
 972 bool BoUpSLP::isConsecutiveAccess(Value *A, Value *B) {
 973   Value *PtrA = getPointerOperand(A);
 974   Value *PtrB = getPointerOperand(B);
 975   unsigned ASA = getAddressSpaceOperand(A);
 976   unsigned ASB = getAddressSpaceOperand(B);
 977
 978   // Check that the address spaces match and that the pointers are valid.
 979   if (!PtrA || !PtrB || (ASA != ASB))
 980     return false;
 981
 982   // Make sure that A and B are different pointers of the same type.
 983   if (PtrA == PtrB || PtrA->getType() != PtrB->getType())
 984     return false;
 985
 986   // Calculate a constant offset from the base pointer without using SCEV
 987   // in the supported cases.
 988   // TODO: Add support for the case where one of the pointers is a GEP that
 989   // uses the other pointer.
 990   GetElementPtrInst *GepA = dyn_cast<GetElementPtrInst>(PtrA);
 991   GetElementPtrInst *GepB = dyn_cast<GetElementPtrInst>(PtrB);
 992
 993   unsigned BW = DL->getPointerSizeInBits(ASA);
 994   Type *Ty = cast<PointerType>(PtrA->getType())->getElementType();
 995   int64_t Sz = DL->getTypeStoreSize(Ty);
 996
 997   // If both pointers are GEPs:
 998   if (GepA && GepB) {
 999     // Check that they have the same base pointer.
1000     if (GepA->getPointerOperand() != GepB->getPointerOperand())
1001       return false;
1002
1003     // Check if the geps use a constant offset.
1004     APInt OffsetA(BW, 0) ,OffsetB(BW, 0);
1005     if (GepA->accumulateConstantOffset(*DL, OffsetA) &&
1006         GepB->accumulateConstantOffset(*DL, OffsetB))
1007       return ((OffsetB.getSExtValue() - OffsetA.getSExtValue()) == Sz);
1008
1009     // Try to strip the geps. This makes SCEV faster.
1010     if (GepA->getNumIndices() == 1 && GepB->getNumIndices() == 1) {
1011       PtrA = GepA->getOperand(1);
1012       PtrB = GepB->getOperand(1);
1013       Sz = 1;
1014     }
1015   }
1016
1017   // Check if PtrA is the base and PtrB is a constant offset.
1018   if (GepB && GepB->getPointerOperand() == PtrA) {
1019     APInt Offset(BW, 0);
1020     if (GepB->accumulateConstantOffset(*DL, Offset))
1021       return Offset.getZExtValue() == DL->getTypeStoreSize(Ty);
1022   }
1023
1024   // GepA can't use PtrB as a base pointer.
1025   if (GepA && GepA->getPointerOperand() == PtrB)
1026     return false;
1027
1028   // Calculate the distance.
1029   const SCEV *PtrSCEVA = SE->getSCEV(PtrA);
1030   const SCEV *PtrSCEVB = SE->getSCEV(PtrB);
1031   const SCEV *C = SE->getConstant(PtrSCEVA->getType(), Sz);
1032   const SCEV *X = SE->getAddExpr(PtrSCEVA, C);
1033   return X == PtrSCEVB;
1034 }
1035
1036 Value *BoUpSLP::getSinkBarrier(Instruction *Src, Instruction *Dst) {
1037   assert(Src->getParent() == Dst->getParent() && "Not the same BB");
1038   BasicBlock::iterator I = Src, E = Dst;
1039   /// Scan all of the instruction from SRC to DST and check if
1040   /// the source may alias.
1041   for (++I; I != E; ++I) {
1042     // Ignore store instructions that are marked as 'ignore'.
1043     if (MemBarrierIgnoreList.count(I))
1044       continue;
1045     if (Src->mayWriteToMemory()) /* Write */ {
1046       if (!I->mayReadOrWriteMemory())
1047         continue;
1048     } else /* Read */ {
1049       if (!I->mayWriteToMemory())
1050         continue;
1051     }
1052     AliasAnalysis::Location A = getLocation(&*I);
1053     AliasAnalysis::Location B = getLocation(Src);
1054
1055     if (!A.Ptr || !B.Ptr || AA->alias(A, B))
1056       return I;
1057   }
1058   return 0;
1059 }
1060
1061 int BoUpSLP::getLastIndex(ArrayRef<Value *> VL) {
1062   BasicBlock *BB = cast<Instruction>(VL[0])->getParent();
1063   assert(BB == getSameBlock(VL) && BlocksNumbers.count(BB) && "Invalid block");
1064   BlockNumbering &BN = BlocksNumbers[BB];
1065
1066   int MaxIdx = BN.getIndex(BB->getFirstNonPHI());
1067   for (unsigned i = 0, e = VL.size(); i < e; ++i)
1068     MaxIdx = std::max(MaxIdx, BN.getIndex(cast<Instruction>(VL[i])));
1069   return MaxIdx;
1070 }
1071
1072 Instruction *BoUpSLP::getLastInstruction(ArrayRef<Value *> VL) {
1073   BasicBlock *BB = cast<Instruction>(VL[0])->getParent();
1074   assert(BB == getSameBlock(VL) && BlocksNumbers.count(BB) && "Invalid block");
1075   BlockNumbering &BN = BlocksNumbers[BB];
1076
1077   int MaxIdx = BN.getIndex(cast<Instruction>(VL[0]));
1078   for (unsigned i = 1, e = VL.size(); i < e; ++i)
1079     MaxIdx = std::max(MaxIdx, BN.getIndex(cast<Instruction>(VL[i])));
1080   Instruction *I = BN.getInstruction(MaxIdx);
1081   assert(I && "bad location");
1082   return I;
1083 }
1084
1085 Instruction *BoUpSLP::getInstructionForIndex(unsigned Index, BasicBlock *BB) {
1086   BlockNumbering &BN = BlocksNumbers[BB];
1087   return BN.getInstruction(Index);
1088 }
1089
1090 int BoUpSLP::getFirstUserIndex(ArrayRef<Value *> VL) {
1091   BasicBlock *BB = getSameBlock(VL);
1092   assert(BB && "All instructions must come from the same block");
1093   BlockNumbering &BN = BlocksNumbers[BB];
1094
1095   // Find the first user of the values.
1096   int FirstUser = BN.getIndex(BB->getTerminator());
1097   for (unsigned i = 0, e = VL.size(); i < e; ++i) {
1098     for (Value::use_iterator U = VL[i]->use_begin(), UE = VL[i]->use_end();
1099          U != UE; ++U) {
1100       Instruction *Instr = dyn_cast<Instruction>(*U);
1101
1102       if (!Instr || Instr->getParent() != BB)
1103         continue;
1104
1105       FirstUser = std::min(FirstUser, BN.getIndex(Instr));
1106     }
1107   }
1108   return FirstUser;
1109 }
1110
1111 Value *BoUpSLP::Gather(ArrayRef<Value *> VL, VectorType *Ty) {
1112   Value *Vec = UndefValue::get(Ty);
1113   // Generate the 'InsertElement' instruction.
1114   for (unsigned i = 0; i < Ty->getNumElements(); ++i) {
1115     Vec = Builder.CreateInsertElement(Vec, VL[i], Builder.getInt32(i));
1116     if (Instruction *Insrt = dyn_cast<Instruction>(Vec)) {
1117       GatherSeq.insert(Insrt);
1118
1119       // Add to our 'need-to-extract' list.
1120       if (ScalarToTreeEntry.count(VL[i])) {
1121         int Idx = ScalarToTreeEntry[VL[i]];
1122         TreeEntry *E = &VectorizableTree[Idx];
1123         // Find which lane we need to extract.
1124         int FoundLane = -1;
1125         for (unsigned Lane = 0, LE = VL.size(); Lane != LE; ++Lane) {
1126           // Is this the lane of the scalar that we are looking for ?
1127           if (E->Scalars[Lane] == VL[i]) {
1128             FoundLane = Lane;
1129             break;
1130           }
1131         }
1132         assert(FoundLane >= 0 && "Could not find the correct lane");
1133         ExternalUses.push_back(ExternalUser(VL[i], Insrt, FoundLane));
1134       }
1135     }
1136   }
1137
1138   return Vec;
1139 }
1140
1141 Value *BoUpSLP::vectorizeTree(ArrayRef<Value *> VL) {
1142   if (ScalarToTreeEntry.count(VL[0])) {
1143     int Idx = ScalarToTreeEntry[VL[0]];
1144     TreeEntry *E = &VectorizableTree[Idx];
1145     if (E->isSame(VL))
1146       return vectorizeTree(E);
1147   }
1148
1149   Type *ScalarTy = VL[0]->getType();
1150   if (StoreInst *SI = dyn_cast<StoreInst>(VL[0]))
1151     ScalarTy = SI->getValueOperand()->getType();
1152   VectorType *VecTy = VectorType::get(ScalarTy, VL.size());
1153
1154   return Gather(VL, VecTy);
1155 }
1156
1157 Value *BoUpSLP::vectorizeTree(TreeEntry *E) {
1158   BuilderLocGuard Guard(Builder);
1159
1160   if (E->VectorizedValue) {
1161     DEBUG(dbgs() << "SLP: Diamond merged for " << *E->Scalars[0] << ".\n");
1162     return E->VectorizedValue;
1163   }
1164
1165   Type *ScalarTy = E->Scalars[0]->getType();
1166   if (StoreInst *SI = dyn_cast<StoreInst>(E->Scalars[0]))
1167     ScalarTy = SI->getValueOperand()->getType();
1168   VectorType *VecTy = VectorType::get(ScalarTy, E->Scalars.size());
1169
1170   if (E->NeedToGather) {
1171     return Gather(E->Scalars, VecTy);
1172   }
1173
1174   Instruction *VL0 = cast<Instruction>(E->Scalars[0]);
1175   unsigned Opcode = VL0->getOpcode();
1176   assert(Opcode == getSameOpcode(E->Scalars) && "Invalid opcode");
1177
1178   switch (Opcode) {
1179     case Instruction::PHI: {
1180       PHINode *PH = dyn_cast<PHINode>(VL0);
1181       Builder.SetInsertPoint(PH->getParent()->getFirstInsertionPt());
1182       PHINode *NewPhi = Builder.CreatePHI(VecTy, PH->getNumIncomingValues());
1183       E->VectorizedValue = NewPhi;
1184
1185       for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) {
1186         ValueList Operands;
1187         BasicBlock *IBB = PH->getIncomingBlock(i);
1188
1189         // Prepare the operand vector.
1190         for (unsigned j = 0; j < E->Scalars.size(); ++j)
1191           Operands.push_back(cast<PHINode>(E->Scalars[j])->
1192                              getIncomingValueForBlock(IBB));
1193
1194         Builder.SetInsertPoint(IBB->getTerminator());
1195         Value *Vec = vectorizeTree(Operands);
1196         NewPhi->addIncoming(Vec, IBB);
1197       }
1198
1199       assert(NewPhi->getNumIncomingValues() == PH->getNumIncomingValues() &&
1200              "Invalid number of incoming values");
1201       return NewPhi;
1202     }
1203
1204     case Instruction::ExtractElement: {
1205       if (CanReuseExtract(E->Scalars)) {
1206         Value *V = VL0->getOperand(0);
1207         E->VectorizedValue = V;
1208         return V;
1209       }
1210       return Gather(E->Scalars, VecTy);
1211     }
1212     case Instruction::ZExt:
1213     case Instruction::SExt:
1214     case Instruction::FPToUI:
1215     case Instruction::FPToSI:
1216     case Instruction::FPExt:
1217     case Instruction::PtrToInt:
1218     case Instruction::IntToPtr:
1219     case Instruction::SIToFP:
1220     case Instruction::UIToFP:
1221     case Instruction::Trunc:
1222     case Instruction::FPTrunc:
1223     case Instruction::BitCast: {
1224       ValueList INVL;
1225       for (int i = 0, e = E->Scalars.size(); i < e; ++i)
1226         INVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1227
1228       Builder.SetInsertPoint(getLastInstruction(E->Scalars));
1229       Value *InVec = vectorizeTree(INVL);
1230       CastInst *CI = dyn_cast<CastInst>(VL0);
1231       Value *V = Builder.CreateCast(CI->getOpcode(), InVec, VecTy);
1232       E->VectorizedValue = V;
1233       return V;
1234     }
1235     case Instruction::FCmp:
1236     case Instruction::ICmp: {
1237       ValueList LHSV, RHSV;
1238       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1239         LHSV.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1240         RHSV.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1241       }
1242
1243       Builder.SetInsertPoint(getLastInstruction(E->Scalars));
1244       Value *L = vectorizeTree(LHSV);
1245       Value *R = vectorizeTree(RHSV);
1246       Value *V;
1247
1248       CmpInst::Predicate P0 = dyn_cast<CmpInst>(VL0)->getPredicate();
1249       if (Opcode == Instruction::FCmp)
1250         V = Builder.CreateFCmp(P0, L, R);
1251       else
1252         V = Builder.CreateICmp(P0, L, R);
1253
1254       E->VectorizedValue = V;
1255       return V;
1256     }
1257     case Instruction::Select: {
1258       ValueList TrueVec, FalseVec, CondVec;
1259       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1260         CondVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1261         TrueVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1262         FalseVec.push_back(cast<Instruction>(E->Scalars[i])->getOperand(2));
1263       }
1264
1265       Builder.SetInsertPoint(getLastInstruction(E->Scalars));
1266       Value *Cond = vectorizeTree(CondVec);
1267       Value *True = vectorizeTree(TrueVec);
1268       Value *False = vectorizeTree(FalseVec);
1269       Value *V = Builder.CreateSelect(Cond, True, False);
1270       E->VectorizedValue = V;
1271       return V;
1272     }
1273     case Instruction::Add:
1274     case Instruction::FAdd:
1275     case Instruction::Sub:
1276     case Instruction::FSub:
1277     case Instruction::Mul:
1278     case Instruction::FMul:
1279     case Instruction::UDiv:
1280     case Instruction::SDiv:
1281     case Instruction::FDiv:
1282     case Instruction::URem:
1283     case Instruction::SRem:
1284     case Instruction::FRem:
1285     case Instruction::Shl:
1286     case Instruction::LShr:
1287     case Instruction::AShr:
1288     case Instruction::And:
1289     case Instruction::Or:
1290     case Instruction::Xor: {
1291       ValueList LHSVL, RHSVL;
1292       for (int i = 0, e = E->Scalars.size(); i < e; ++i) {
1293         LHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(0));
1294         RHSVL.push_back(cast<Instruction>(E->Scalars[i])->getOperand(1));
1295       }
1296
1297       Builder.SetInsertPoint(getLastInstruction(E->Scalars));
1298       Value *LHS = vectorizeTree(LHSVL);
1299       Value *RHS = vectorizeTree(RHSVL);
1300
1301       if (LHS == RHS && isa<Instruction>(LHS)) {
1302         assert((VL0->getOperand(0) == VL0->getOperand(1)) && "Invalid order");
1303       }
1304
1305       BinaryOperator *BinOp = cast<BinaryOperator>(VL0);
1306       Value *V = Builder.CreateBinOp(BinOp->getOpcode(), LHS, RHS);
1307       E->VectorizedValue = V;
1308       return V;
1309     }
1310     case Instruction::Load: {
1311       // Loads are inserted at the head of the tree because we don't want to
1312       // sink them all the way down past store instructions.
1313       Builder.SetInsertPoint(getLastInstruction(E->Scalars));
1314       LoadInst *LI = cast<LoadInst>(VL0);
1315       Value *VecPtr =
1316       Builder.CreateBitCast(LI->getPointerOperand(), VecTy->getPointerTo());
1317       unsigned Alignment = LI->getAlignment();
1318       LI = Builder.CreateLoad(VecPtr);
1319       LI->setAlignment(Alignment);
1320       E->VectorizedValue = LI;
1321       return LI;
1322     }
1323     case Instruction::Store: {
1324       StoreInst *SI = cast<StoreInst>(VL0);
1325       unsigned Alignment = SI->getAlignment();
1326
1327       ValueList ValueOp;
1328       for (int i = 0, e = E->Scalars.size(); i < e; ++i)
1329         ValueOp.push_back(cast<StoreInst>(E->Scalars[i])->getValueOperand());
1330
1331       Builder.SetInsertPoint(getLastInstruction(E->Scalars));
1332       Value *VecValue = vectorizeTree(ValueOp);
1333       Value *VecPtr =
1334       Builder.CreateBitCast(SI->getPointerOperand(), VecTy->getPointerTo());
1335       StoreInst *S = Builder.CreateStore(VecValue, VecPtr);
1336       S->setAlignment(Alignment);
1337       E->VectorizedValue = S;
1338       return S;
1339     }
1340     default:
1341     llvm_unreachable("unknown inst");
1342   }
1343   return 0;
1344 }
1345
1346 void BoUpSLP::vectorizeTree() {
1347   Builder.SetInsertPoint(F->getEntryBlock().begin());
1348   vectorizeTree(&VectorizableTree[0]);
1349
1350   DEBUG(dbgs() << "SLP: Extracting " << ExternalUses.size() << " values .\n");
1351
1352   // Extract all of the elements with the external uses.
1353   for (UserList::iterator it = ExternalUses.begin(), e = ExternalUses.end();
1354        it != e; ++it) {
1355     Value *Scalar = it->Scalar;
1356     llvm::User *User = it->User;
1357
1358     // Skip users that we already RAUW. This happens when one instruction
1359     // has multiple uses of the same value.
1360     if (std::find(Scalar->use_begin(), Scalar->use_end(), User) ==
1361         Scalar->use_end())
1362       continue;
1363     assert(ScalarToTreeEntry.count(Scalar) && "Invalid scalar");
1364
1365     int Idx = ScalarToTreeEntry[Scalar];
1366     TreeEntry *E = &VectorizableTree[Idx];
1367     assert(!E->NeedToGather && "Extracting from a gather list");
1368
1369     Value *Vec = E->VectorizedValue;
1370     assert(Vec && "Can't find vectorizable value");
1371
1372     // Generate extracts for out-of-tree users.
1373     // Find the insertion point for the extractelement lane.
1374     Instruction *Loc = 0;
1375     if (PHINode *PN = dyn_cast<PHINode>(Vec)) {
1376       Loc = PN->getParent()->getFirstInsertionPt();
1377     } else if (isa<Instruction>(Vec)){
1378       if (PHINode *PH = dyn_cast<PHINode>(User)) {
1379         for (int i = 0, e = PH->getNumIncomingValues(); i != e; ++i) {
1380           if (PH->getIncomingValue(i) == Scalar) {
1381             Loc = PH->getIncomingBlock(i)->getTerminator();
1382             break;
1383           }
1384         }
1385         assert(Loc && "Unable to find incoming value for the PHI");
1386       } else {
1387         Loc = cast<Instruction>(User);
1388      }
1389     } else {
1390       Loc = F->getEntryBlock().begin();
1391     }
1392
1393     Builder.SetInsertPoint(Loc);
1394     Value *Ex = Builder.CreateExtractElement(Vec, Builder.getInt32(it->Lane));
1395     User->replaceUsesOfWith(Scalar, Ex);
1396     DEBUG(dbgs() << "SLP: Replaced:" << *User << ".\n");
1397   }
1398
1399   // For each vectorized value:
1400   for (int EIdx = 0, EE = VectorizableTree.size(); EIdx < EE; ++EIdx) {
1401     TreeEntry *Entry = &VectorizableTree[EIdx];
1402
1403     // For each lane:
1404     for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) {
1405       Value *Scalar = Entry->Scalars[Lane];
1406
1407       // No need to handle users of gathered values.
1408       if (Entry->NeedToGather)
1409         continue;
1410
1411       assert(Entry->VectorizedValue && "Can't find vectorizable value");
1412
1413       Type *Ty = Scalar->getType();
1414       if (!Ty->isVoidTy()) {
1415         for (Value::use_iterator User = Scalar->use_begin(), UE = Scalar->use_end();
1416              User != UE; ++User) {
1417           DEBUG(dbgs() << "SLP: \tvalidating user:" << **User << ".\n");
1418           assert(!MustGather.count(*User) &&
1419                  "Replacing gathered value with undef");
1420           assert(ScalarToTreeEntry.count(*User) &&
1421                  "Replacing out-of-tree value with undef");
1422         }
1423         Value *Undef = UndefValue::get(Ty);
1424         Scalar->replaceAllUsesWith(Undef);
1425       }
1426       DEBUG(dbgs() << "SLP: \tErasing scalar:" << *Scalar << ".\n");
1427       cast<Instruction>(Scalar)->eraseFromParent();
1428     }
1429   }
1430
1431   for (Function::iterator it = F->begin(), e = F->end(); it != e; ++it) {
1432     BlocksNumbers[it].forget();
1433   }
1434   Builder.ClearInsertionPoint();
1435 }
1436
1437 void BoUpSLP::optimizeGatherSequence() {
1438   DEBUG(dbgs() << "SLP: Optimizing " << GatherSeq.size()
1439         << " gather sequences instructions.\n");
1440   // LICM InsertElementInst sequences.
1441   for (SetVector<Instruction *>::iterator it = GatherSeq.begin(),
1442        e = GatherSeq.end(); it != e; ++it) {
1443     InsertElementInst *Insert = dyn_cast<InsertElementInst>(*it);
1444
1445     if (!Insert)
1446       continue;
1447
1448     // Check if this block is inside a loop.
1449     Loop *L = LI->getLoopFor(Insert->getParent());
1450     if (!L)
1451       continue;
1452
1453     // Check if it has a preheader.
1454     BasicBlock *PreHeader = L->getLoopPreheader();
1455     if (!PreHeader)
1456       continue;
1457
1458     // If the vector or the element that we insert into it are
1459     // instructions that are defined in this basic block then we can't
1460     // hoist this instruction.
1461     Instruction *CurrVec = dyn_cast<Instruction>(Insert->getOperand(0));
1462     Instruction *NewElem = dyn_cast<Instruction>(Insert->getOperand(1));
1463     if (CurrVec && L->contains(CurrVec))
1464       continue;
1465     if (NewElem && L->contains(NewElem))
1466       continue;
1467
1468     // We can hoist this instruction. Move it to the pre-header.
1469     Insert->moveBefore(PreHeader->getTerminator());
1470   }
1471
1472   // Perform O(N^2) search over the gather sequences and merge identical
1473   // instructions. TODO: We can further optimize this scan if we split the
1474   // instructions into different buckets based on the insert lane.
1475   SmallPtrSet<Instruction*, 16> Visited;
1476   SmallVector<Instruction*, 16> ToRemove;
1477   ReversePostOrderTraversal<Function*> RPOT(F);
1478   for (ReversePostOrderTraversal<Function*>::rpo_iterator I = RPOT.begin(),
1479        E = RPOT.end(); I != E; ++I) {
1480     BasicBlock *BB = *I;
1481     // For all instructions in the function:
1482     for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
1483       Instruction *In = it;
1484       if ((!isa<InsertElementInst>(In) && !isa<ExtractElementInst>(In)) ||
1485           !GatherSeq.count(In))
1486         continue;
1487
1488       // Check if we can replace this instruction with any of the
1489       // visited instructions.
1490       for (SmallPtrSet<Instruction*, 16>::iterator v = Visited.begin(),
1491            ve = Visited.end(); v != ve; ++v) {
1492         if (In->isIdenticalTo(*v) &&
1493             DT->dominates((*v)->getParent(), In->getParent())) {
1494           In->replaceAllUsesWith(*v);
1495           ToRemove.push_back(In);
1496           In = 0;
1497           break;
1498         }
1499       }
1500       if (In)
1501         Visited.insert(In);
1502     }
1503   }
1504
1505   // Erase all of the instructions that we RAUWed.
1506   for (SmallVectorImpl<Instruction *>::iterator v = ToRemove.begin(),
1507        ve = ToRemove.end(); v != ve; ++v) {
1508     assert((*v)->getNumUses() == 0 && "Can't remove instructions with uses");
1509     (*v)->eraseFromParent();
1510   }
1511 }
1512
1513 /// The SLPVectorizer Pass.
1514 struct SLPVectorizer : public FunctionPass {
1515   typedef SmallVector<StoreInst *, 8> StoreList;
1516   typedef MapVector<Value *, StoreList> StoreListMap;
1517
1518   /// Pass identification, replacement for typeid
1519   static char ID;
1520
1521   explicit SLPVectorizer() : FunctionPass(ID) {
1522     initializeSLPVectorizerPass(*PassRegistry::getPassRegistry());
1523   }
1524
1525   ScalarEvolution *SE;
1526   DataLayout *DL;
1527   TargetTransformInfo *TTI;
1528   AliasAnalysis *AA;
1529   LoopInfo *LI;
1530   DominatorTree *DT;
1531
1532   virtual bool runOnFunction(Function &F) {
1533     SE = &getAnalysis<ScalarEvolution>();
1534     DL = getAnalysisIfAvailable<DataLayout>();
1535     TTI = &getAnalysis<TargetTransformInfo>();
1536     AA = &getAnalysis<AliasAnalysis>();
1537     LI = &getAnalysis<LoopInfo>();
1538     DT = &getAnalysis<DominatorTree>();
1539
1540     StoreRefs.clear();
1541     bool Changed = false;
1542
1543     // Must have DataLayout. We can't require it because some tests run w/o
1544     // triple.
1545     if (!DL)
1546       return false;
1547
1548     DEBUG(dbgs() << "SLP: Analyzing blocks in " << F.getName() << ".\n");
1549
1550     // Use the bollom up slp vectorizer to construct chains that start with
1551     // he store instructions.
1552     BoUpSLP R(&F, SE, DL, TTI, AA, LI, DT);
1553
1554     // Scan the blocks in the function in post order.
1555     for (po_iterator<BasicBlock*> it = po_begin(&F.getEntryBlock()),
1556          e = po_end(&F.getEntryBlock()); it != e; ++it) {
1557       BasicBlock *BB = *it;
1558
1559       // Vectorize trees that end at stores.
1560       if (unsigned count = collectStores(BB, R)) {
1561         (void)count;
1562         DEBUG(dbgs() << "SLP: Found " << count << " stores to vectorize.\n");
1563         Changed |= vectorizeStoreChains(R);
1564       }
1565
1566       // Vectorize trees that end at reductions.
1567       Changed |= vectorizeChainsInBlock(BB, R);
1568     }
1569
1570     if (Changed) {
1571       R.optimizeGatherSequence();
1572       DEBUG(dbgs() << "SLP: vectorized \"" << F.getName() << "\"\n");
1573       DEBUG(verifyFunction(F));
1574     }
1575     return Changed;
1576   }
1577
1578   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
1579     FunctionPass::getAnalysisUsage(AU);
1580     AU.addRequired<ScalarEvolution>();
1581     AU.addRequired<AliasAnalysis>();
1582     AU.addRequired<TargetTransformInfo>();
1583     AU.addRequired<LoopInfo>();
1584     AU.addRequired<DominatorTree>();
1585     AU.addPreserved<LoopInfo>();
1586     AU.addPreserved<DominatorTree>();
1587     AU.setPreservesCFG();
1588   }
1589
1590 private:
1591
1592   /// \brief Collect memory references and sort them according to their base
1593   /// object. We sort the stores to their base objects to reduce the cost of the
1594   /// quadratic search on the stores. TODO: We can further reduce this cost
1595   /// if we flush the chain creation every time we run into a memory barrier.
1596   unsigned collectStores(BasicBlock *BB, BoUpSLP &R);
1597
1598   /// \brief Try to vectorize a chain that starts at two arithmetic instrs.
1599   bool tryToVectorizePair(Value *A, Value *B, BoUpSLP &R);
1600
1601   /// \brief Try to vectorize a list of operands.
1602   /// \returns true if a value was vectorized.
1603   bool tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R);
1604
1605   /// \brief Try to vectorize a chain that may start at the operands of \V;
1606   bool tryToVectorize(BinaryOperator *V, BoUpSLP &R);
1607
1608   /// \brief Vectorize the stores that were collected in StoreRefs.
1609   bool vectorizeStoreChains(BoUpSLP &R);
1610
1611   /// \brief Scan the basic block and look for patterns that are likely to start
1612   /// a vectorization chain.
1613   bool vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R);
1614
1615   bool vectorizeStoreChain(ArrayRef<Value *> Chain, int CostThreshold,
1616                            BoUpSLP &R);
1617
1618   bool vectorizeStores(ArrayRef<StoreInst *> Stores, int costThreshold,
1619                        BoUpSLP &R);
1620 private:
1621   StoreListMap StoreRefs;
1622 };
1623
1624 bool SLPVectorizer::vectorizeStoreChain(ArrayRef<Value *> Chain,
1625                                           int CostThreshold, BoUpSLP &R) {
1626   unsigned ChainLen = Chain.size();
1627   DEBUG(dbgs() << "SLP: Analyzing a store chain of length " << ChainLen
1628         << "\n");
1629   Type *StoreTy = cast<StoreInst>(Chain[0])->getValueOperand()->getType();
1630   unsigned Sz = DL->getTypeSizeInBits(StoreTy);
1631   unsigned VF = MinVecRegSize / Sz;
1632
1633   if (!isPowerOf2_32(Sz) || VF < 2)
1634     return false;
1635
1636   bool Changed = false;
1637   // Look for profitable vectorizable trees at all offsets, starting at zero.
1638   for (unsigned i = 0, e = ChainLen; i < e; ++i) {
1639     if (i + VF > e)
1640       break;
1641     DEBUG(dbgs() << "SLP: Analyzing " << VF << " stores at offset " << i
1642           << "\n");
1643     ArrayRef<Value *> Operands = Chain.slice(i, VF);
1644
1645     R.buildTree(Operands);
1646
1647     int Cost = R.getTreeCost();
1648
1649     DEBUG(dbgs() << "SLP: Found cost=" << Cost << " for VF=" << VF << "\n");
1650     if (Cost < CostThreshold) {
1651       DEBUG(dbgs() << "SLP: Decided to vectorize cost=" << Cost << "\n");
1652       R.vectorizeTree();
1653
1654       // Move to the next bundle.
1655       i += VF - 1;
1656       Changed = true;
1657     }
1658   }
1659
1660   if (Changed || ChainLen > VF)
1661     return Changed;
1662
1663   // Handle short chains. This helps us catch types such as <3 x float> that
1664   // are smaller than vector size.
1665   R.buildTree(Chain);
1666
1667   int Cost = R.getTreeCost();
1668
1669   if (Cost < CostThreshold) {
1670     DEBUG(dbgs() << "SLP: Found store chain cost = " << Cost
1671           << " for size = " << ChainLen << "\n");
1672     R.vectorizeTree();
1673     return true;
1674   }
1675
1676   return false;
1677 }
1678
1679 bool SLPVectorizer::vectorizeStores(ArrayRef<StoreInst *> Stores,
1680                                     int costThreshold, BoUpSLP &R) {
1681   SetVector<Value *> Heads, Tails;
1682   SmallDenseMap<Value *, Value *> ConsecutiveChain;
1683
1684   // We may run into multiple chains that merge into a single chain. We mark the
1685   // stores that we vectorized so that we don't visit the same store twice.
1686   BoUpSLP::ValueSet VectorizedStores;
1687   bool Changed = false;
1688
1689   // Do a quadratic search on all of the given stores and find
1690   // all of the pairs of stores that follow each other.
1691   for (unsigned i = 0, e = Stores.size(); i < e; ++i) {
1692     if (Heads.count(Stores[i]))
1693       continue;
1694     for (unsigned j = 0; j < e; ++j) {
1695       if (i == j || Tails.count(Stores[j]))
1696         continue;
1697
1698       if (R.isConsecutiveAccess(Stores[i], Stores[j])) {
1699         Tails.insert(Stores[j]);
1700         Heads.insert(Stores[i]);
1701         ConsecutiveChain[Stores[i]] = Stores[j];
1702       }
1703     }
1704   }
1705
1706   // For stores that start but don't end a link in the chain:
1707   for (SetVector<Value *>::iterator it = Heads.begin(), e = Heads.end();
1708        it != e; ++it) {
1709     if (Tails.count(*it))
1710       continue;
1711
1712     // We found a store instr that starts a chain. Now follow the chain and try
1713     // to vectorize it.
1714     BoUpSLP::ValueList Operands;
1715     Value *I = *it;
1716     // Collect the chain into a list.
1717     while (Tails.count(I) || Heads.count(I)) {
1718       if (VectorizedStores.count(I))
1719         break;
1720       Operands.push_back(I);
1721       // Move to the next value in the chain.
1722       I = ConsecutiveChain[I];
1723     }
1724
1725     bool Vectorized = vectorizeStoreChain(Operands, costThreshold, R);
1726
1727     // Mark the vectorized stores so that we don't vectorize them again.
1728     if (Vectorized)
1729       VectorizedStores.insert(Operands.begin(), Operands.end());
1730     Changed |= Vectorized;
1731   }
1732
1733   return Changed;
1734 }
1735
1736
1737 unsigned SLPVectorizer::collectStores(BasicBlock *BB, BoUpSLP &R) {
1738   unsigned count = 0;
1739   StoreRefs.clear();
1740   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
1741     StoreInst *SI = dyn_cast<StoreInst>(it);
1742     if (!SI)
1743       continue;
1744
1745     // Check that the pointer points to scalars.
1746     Type *Ty = SI->getValueOperand()->getType();
1747     if (Ty->isAggregateType() || Ty->isVectorTy())
1748       return 0;
1749
1750     // Find the base of the GEP.
1751     Value *Ptr = SI->getPointerOperand();
1752     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr))
1753       Ptr = GEP->getPointerOperand();
1754
1755     // Save the store locations.
1756     StoreRefs[Ptr].push_back(SI);
1757     count++;
1758   }
1759   return count;
1760 }
1761
1762 bool SLPVectorizer::tryToVectorizePair(Value *A, Value *B, BoUpSLP &R) {
1763   if (!A || !B)
1764     return false;
1765   Value *VL[] = { A, B };
1766   return tryToVectorizeList(VL, R);
1767 }
1768
1769 bool SLPVectorizer::tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R) {
1770   if (VL.size() < 2)
1771     return false;
1772
1773   DEBUG(dbgs() << "SLP: Vectorizing a list of length = " << VL.size() << ".\n");
1774
1775   // Check that all of the parts are scalar instructions of the same type.
1776   Instruction *I0 = dyn_cast<Instruction>(VL[0]);
1777   if (!I0)
1778     return 0;
1779
1780   unsigned Opcode0 = I0->getOpcode();
1781
1782   for (int i = 0, e = VL.size(); i < e; ++i) {
1783     Type *Ty = VL[i]->getType();
1784     if (Ty->isAggregateType() || Ty->isVectorTy())
1785       return 0;
1786     Instruction *Inst = dyn_cast<Instruction>(VL[i]);
1787     if (!Inst || Inst->getOpcode() != Opcode0)
1788       return 0;
1789   }
1790
1791   R.buildTree(VL);
1792   int Cost = R.getTreeCost();
1793
1794   if (Cost >= -SLPCostThreshold)
1795     return false;
1796
1797   DEBUG(dbgs() << "SLP: Vectorizing pair at cost:" << Cost << ".\n");
1798   R.vectorizeTree();
1799   return true;
1800 }
1801
1802 bool SLPVectorizer::tryToVectorize(BinaryOperator *V, BoUpSLP &R) {
1803   if (!V)
1804     return false;
1805
1806   // Try to vectorize V.
1807   if (tryToVectorizePair(V->getOperand(0), V->getOperand(1), R))
1808     return true;
1809
1810   BinaryOperator *A = dyn_cast<BinaryOperator>(V->getOperand(0));
1811   BinaryOperator *B = dyn_cast<BinaryOperator>(V->getOperand(1));
1812   // Try to skip B.
1813   if (B && B->hasOneUse()) {
1814     BinaryOperator *B0 = dyn_cast<BinaryOperator>(B->getOperand(0));
1815     BinaryOperator *B1 = dyn_cast<BinaryOperator>(B->getOperand(1));
1816     if (tryToVectorizePair(A, B0, R)) {
1817       B->moveBefore(V);
1818       return true;
1819     }
1820     if (tryToVectorizePair(A, B1, R)) {
1821       B->moveBefore(V);
1822       return true;
1823     }
1824   }
1825
1826   // Try to skip A.
1827   if (A && A->hasOneUse()) {
1828     BinaryOperator *A0 = dyn_cast<BinaryOperator>(A->getOperand(0));
1829     BinaryOperator *A1 = dyn_cast<BinaryOperator>(A->getOperand(1));
1830     if (tryToVectorizePair(A0, B, R)) {
1831       A->moveBefore(V);
1832       return true;
1833     }
1834     if (tryToVectorizePair(A1, B, R)) {
1835       A->moveBefore(V);
1836       return true;
1837     }
1838   }
1839   return 0;
1840 }
1841
1842 bool SLPVectorizer::vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R) {
1843   bool Changed = false;
1844   SmallVector<Value *, 4> Incoming;
1845   // Collect the incoming values from the PHIs.
1846   for (BasicBlock::iterator instr = BB->begin(), ie = BB->end(); instr != ie;
1847        ++instr) {
1848     PHINode *P = dyn_cast<PHINode>(instr);
1849
1850     if (!P)
1851       break;
1852
1853     // Stop constructing the list when you reach a different type.
1854     if (Incoming.size() && P->getType() != Incoming[0]->getType()) {
1855       Changed |= tryToVectorizeList(Incoming, R);
1856       Incoming.clear();
1857     }
1858
1859     Incoming.push_back(P);
1860   }
1861
1862   if (Incoming.size() > 1)
1863     Changed |= tryToVectorizeList(Incoming, R);
1864
1865   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
1866     if (isa<DbgInfoIntrinsic>(it))
1867       continue;
1868
1869     // Try to vectorize reductions that use PHINodes.
1870     if (PHINode *P = dyn_cast<PHINode>(it)) {
1871       // Check that the PHI is a reduction PHI.
1872       if (P->getNumIncomingValues() != 2)
1873         return Changed;
1874       Value *Rdx =
1875           (P->getIncomingBlock(0) == BB
1876                ? (P->getIncomingValue(0))
1877                : (P->getIncomingBlock(1) == BB ? P->getIncomingValue(1) : 0));
1878       // Check if this is a Binary Operator.
1879       BinaryOperator *BI = dyn_cast_or_null<BinaryOperator>(Rdx);
1880       if (!BI)
1881         continue;
1882
1883       Value *Inst = BI->getOperand(0);
1884       if (Inst == P)
1885         Inst = BI->getOperand(1);
1886
1887       Changed |= tryToVectorize(dyn_cast<BinaryOperator>(Inst), R);
1888       continue;
1889     }
1890
1891     // Try to vectorize trees that start at compare instructions.
1892     if (CmpInst *CI = dyn_cast<CmpInst>(it)) {
1893       if (tryToVectorizePair(CI->getOperand(0), CI->getOperand(1), R)) {
1894         Changed |= true;
1895         continue;
1896       }
1897       for (int i = 0; i < 2; ++i)
1898         if (BinaryOperator *BI = dyn_cast<BinaryOperator>(CI->getOperand(i)))
1899           Changed |=
1900               tryToVectorizePair(BI->getOperand(0), BI->getOperand(1), R);
1901       continue;
1902     }
1903   }
1904
1905   return Changed;
1906 }
1907
1908 bool SLPVectorizer::vectorizeStoreChains(BoUpSLP &R) {
1909   bool Changed = false;
1910   // Attempt to sort and vectorize each of the store-groups.
1911   for (StoreListMap::iterator it = StoreRefs.begin(), e = StoreRefs.end();
1912        it != e; ++it) {
1913     if (it->second.size() < 2)
1914       continue;
1915
1916     DEBUG(dbgs() << "SLP: Analyzing a store chain of length "
1917           << it->second.size() << ".\n");
1918
1919     // Process the stores in chunks of 16.
1920     for (unsigned CI = 0, CE = it->second.size(); CI < CE; CI+=16) {
1921       unsigned Len = std::min<unsigned>(CE - CI, 16);
1922       ArrayRef<StoreInst *> Chunk(&it->second[CI], Len);
1923       Changed |= vectorizeStores(Chunk, -SLPCostThreshold, R);
1924     }
1925   }
1926   return Changed;
1927 }
1928
1929 } // end anonymous namespace
1930
1931 char SLPVectorizer::ID = 0;
1932 static const char lv_name[] = "SLP Vectorizer";
1933 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false)
1934 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
1935 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
1936 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
1937 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
1938 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false)
1939
1940 namespace llvm {
1941 Pass *createSLPVectorizerPass() { return new SLPVectorizer(); }
1942 }