lib/Transforms/Vectorize/SLPVectorizer.cpp

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