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