lib/Transforms/Vectorize/SLPVectorizer.cpp

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