lib/Transforms/Vectorize/SLPVectorizer.cpp

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