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 SV_NAME
  20
  21 #include "VecUtils.h"
  22 #include "llvm/Transforms/Vectorize.h"
  23 #include "llvm/Analysis/AliasAnalysis.h"
  24 #include "llvm/Analysis/ScalarEvolution.h"
  25 #include "llvm/Analysis/TargetTransformInfo.h"
  26 #include "llvm/Analysis/Verifier.h"
  27 #include "llvm/Analysis/LoopInfo.h"
  28 #include "llvm/IR/DataLayout.h"
  29 #include "llvm/IR/Instructions.h"
  30 #include "llvm/IR/IntrinsicInst.h"
  31 #include "llvm/IR/Module.h"
  32 #include "llvm/IR/Type.h"
  33 #include "llvm/IR/Value.h"
  34 #include "llvm/Pass.h"
  35 #include "llvm/Support/CommandLine.h"
  36 #include "llvm/Support/Debug.h"
  37 #include "llvm/Support/raw_ostream.h"
  38 #include <map>
  39
  40 using namespace llvm;
  41
  42 static cl::opt<int>
  43 SLPCostThreshold("slp-threshold", cl::init(0), cl::Hidden,
  44                  cl::desc("Only vectorize trees if the gain is above this "
  45                           "number. (gain = -cost of vectorization)"));
  46 namespace {
  47
  48 /// The SLPVectorizer Pass.
  49 struct SLPVectorizer : public FunctionPass {
  50   typedef std::map<Value*, BoUpSLP::StoreList> StoreListMap;
  51
  52   /// Pass identification, replacement for typeid
  53   static char ID;
  54
  55   explicit SLPVectorizer() : FunctionPass(ID) {
  56     initializeSLPVectorizerPass(*PassRegistry::getPassRegistry());
  57   }
  58
  59   ScalarEvolution *SE;
  60   DataLayout *DL;
  61   TargetTransformInfo *TTI;
  62   AliasAnalysis *AA;
  63   LoopInfo *LI;
  64
  65   virtual bool runOnFunction(Function &F) {
  66     SE = &getAnalysis<ScalarEvolution>();
  67     DL = getAnalysisIfAvailable<DataLayout>();
  68     TTI = &getAnalysis<TargetTransformInfo>();
  69     AA = &getAnalysis<AliasAnalysis>();
  70     LI = &getAnalysis<LoopInfo>();
  71
  72     StoreRefs.clear();
  73     bool Changed = false;
  74
  75     // Must have DataLayout. We can't require it because some tests run w/o
  76     // triple.
  77     if (!DL)
  78       return false;
  79
  80     for (Function::iterator it = F.begin(), e = F.end(); it != e; ++it) {
  81       BasicBlock *BB = it;
  82       bool BBChanged = false;
  83
  84       // Use the bollom up slp vectorizer to construct chains that start with
  85       // he store instructions.
  86       BoUpSLP R(BB, SE, DL, TTI, AA, LI->getLoopFor(BB));
  87
  88       // Vectorize trees that end at reductions.
  89       BBChanged |= vectorizeReductions(BB, R);
  90
  91       // Vectorize trees that end at stores.
  92       if (unsigned count = collectStores(BB, R)) {
  93         (void)count;
  94         DEBUG(dbgs()<<"SLP: Found " << count << " stores to vectorize.\n");
  95         BBChanged |= vectorizeStoreChains(R);
  96       }
  97
  98       // Try to hoist some of the scalarization code to the preheader.
  99       if (BBChanged) hoistGatherSequence(LI, BB, R);
 100
 101       Changed |= BBChanged;
 102     }
 103
 104     if (Changed) {
 105       DEBUG(dbgs()<<"SLP: vectorized \""<<F.getName()<<"\"\n");
 106       DEBUG(verifyFunction(F));
 107     }
 108     return Changed;
 109   }
 110
 111   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 112     FunctionPass::getAnalysisUsage(AU);
 113     AU.addRequired<ScalarEvolution>();
 114     AU.addRequired<AliasAnalysis>();
 115     AU.addRequired<TargetTransformInfo>();
 116     AU.addRequired<LoopInfo>();
 117   }
 118
 119 private:
 120
 121   /// \brief Collect memory references and sort them according to their base
 122   /// object. We sort the stores to their base objects to reduce the cost of the
 123   /// quadratic search on the stores. TODO: We can further reduce this cost
 124   /// if we flush the chain creation every time we run into a memory barrier.
 125   unsigned collectStores(BasicBlock *BB, BoUpSLP &R);
 126
 127   /// \brief Try to vectorize a chain that starts at two arithmetic instrs.
 128   bool tryToVectorizePair(Value *A, Value *B,  BoUpSLP &R);
 129
 130   /// \brief Try to vectorize a chain that may start at the operands of \V;
 131   bool tryToVectorize(BinaryOperator *V,  BoUpSLP &R);
 132
 133   /// \brief Vectorize the stores that were collected in StoreRefs.
 134   bool vectorizeStoreChains(BoUpSLP &R);
 135
 136   /// \brief Try to hoist gather sequences outside of the loop in cases where
 137   /// all of the sources are loop invariant.
 138   void hoistGatherSequence(LoopInfo *LI, BasicBlock *BB, BoUpSLP &R);
 139
 140   /// \brief Scan the basic block and look for reductions that may start a
 141   /// vectorization chain.
 142   bool vectorizeReductions(BasicBlock *BB, BoUpSLP &R);
 143
 144 private:
 145   StoreListMap StoreRefs;
 146 };
 147
 148 unsigned SLPVectorizer::collectStores(BasicBlock *BB, BoUpSLP &R) {
 149   unsigned count = 0;
 150   StoreRefs.clear();
 151   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
 152     StoreInst *SI = dyn_cast<StoreInst>(it);
 153     if (!SI)
 154       continue;
 155
 156     // Check that the pointer points to scalars.
 157     if (SI->getValueOperand()->getType()->isAggregateType())
 158       return 0;
 159
 160     // Find the base of the GEP.
 161     Value *Ptr = SI->getPointerOperand();
 162     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr))
 163       Ptr = GEP->getPointerOperand();
 164
 165     // Save the store locations.
 166     StoreRefs[Ptr].push_back(SI);
 167     count++;
 168   }
 169   return count;
 170 }
 171
 172 bool SLPVectorizer::tryToVectorizePair(Value *A, Value *B,  BoUpSLP &R) {
 173   if (!A || !B) return false;
 174   BoUpSLP::ValueList VL;
 175   VL.push_back(A);
 176   VL.push_back(B);
 177   int Cost = R.getTreeCost(VL);
 178   int ExtrCost = R.getScalarizationCost(VL);
 179   DEBUG(dbgs()<<"SLP: Cost of pair:" << Cost <<
 180         " Cost of extract:" << ExtrCost << ".\n");
 181   if ((Cost+ExtrCost) >= -SLPCostThreshold) return false;
 182   DEBUG(dbgs()<<"SLP: Vectorizing pair.\n");
 183   R.vectorizeArith(VL);
 184   return true;
 185 }
 186
 187 bool SLPVectorizer::tryToVectorize(BinaryOperator *V,  BoUpSLP &R) {
 188   if (!V) return false;
 189   // Try to vectorize V.
 190   if (tryToVectorizePair(V->getOperand(0), V->getOperand(1), R))
 191     return true;
 192
 193   BinaryOperator *A = dyn_cast<BinaryOperator>(V->getOperand(0));
 194   BinaryOperator *B = dyn_cast<BinaryOperator>(V->getOperand(1));
 195   // Try to skip B.
 196   if (B && B->hasOneUse()) {
 197     BinaryOperator *B0 = dyn_cast<BinaryOperator>(B->getOperand(0));
 198     BinaryOperator *B1 = dyn_cast<BinaryOperator>(B->getOperand(1));
 199     if (tryToVectorizePair(A, B0, R)) {
 200       B->moveBefore(V);
 201       return true;
 202     }
 203     if (tryToVectorizePair(A, B1, R)) {
 204       B->moveBefore(V);
 205       return true;
 206     }
 207   }
 208
 209   // Try to slip A.
 210   if (A && A->hasOneUse()) {
 211     BinaryOperator *A0 = dyn_cast<BinaryOperator>(A->getOperand(0));
 212     BinaryOperator *A1 = dyn_cast<BinaryOperator>(A->getOperand(1));
 213     if (tryToVectorizePair(A0, B, R)) {
 214       A->moveBefore(V);
 215       return true;
 216     }
 217     if (tryToVectorizePair(A1, B, R)) {
 218       A->moveBefore(V);
 219       return true;
 220     }
 221   }
 222   return 0;
 223 }
 224
 225 bool SLPVectorizer::vectorizeReductions(BasicBlock *BB, BoUpSLP &R) {
 226   bool Changed = false;
 227   for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) {
 228     if (isa<DbgInfoIntrinsic>(it)) continue;
 229
 230     // Try to vectorize reductions that use PHINodes.
 231     if (PHINode *P = dyn_cast<PHINode>(it)) {
 232       // Check that the PHI is a reduction PHI.
 233       if (P->getNumIncomingValues() != 2) return Changed;
 234       Value *Rdx = (P->getIncomingBlock(0) == BB ? P->getIncomingValue(0) :
 235                     (P->getIncomingBlock(1) == BB ? P->getIncomingValue(1) :
 236                      0));
 237       // Check if this is a Binary Operator.
 238       BinaryOperator *BI = dyn_cast_or_null<BinaryOperator>(Rdx);
 239       if (!BI)
 240         continue;
 241
 242       Value *Inst = BI->getOperand(0);
 243       if (Inst == P) Inst = BI->getOperand(1);
 244       Changed |= tryToVectorize(dyn_cast<BinaryOperator>(Inst), R);
 245       continue;
 246     }
 247
 248     // Try to vectorize trees that start at compare instructions.
 249     if (CmpInst *CI = dyn_cast<CmpInst>(it)) {
 250       if (tryToVectorizePair(CI->getOperand(0), CI->getOperand(1), R)) {
 251         Changed |= true;
 252         continue;
 253       }
 254       for (int i = 0; i < 2; ++i)
 255         if (BinaryOperator *BI = dyn_cast<BinaryOperator>(CI->getOperand(i)))
 256           Changed |= tryToVectorize(BI, R);
 257       continue;
 258     }
 259   }
 260
 261   return Changed;
 262 }
 263
 264 bool SLPVectorizer::vectorizeStoreChains(BoUpSLP &R) {
 265   bool Changed = false;
 266   // Attempt to sort and vectorize each of the store-groups.
 267   for (StoreListMap::iterator it = StoreRefs.begin(), e = StoreRefs.end();
 268        it != e; ++it) {
 269     if (it->second.size() < 2)
 270       continue;
 271
 272     DEBUG(dbgs()<<"SLP: Analyzing a store chain of length " <<
 273           it->second.size() << ".\n");
 274
 275     Changed |= R.vectorizeStores(it->second, -SLPCostThreshold);
 276   }
 277   return Changed;
 278 }
 279
 280 void SLPVectorizer::hoistGatherSequence(LoopInfo *LI, BasicBlock *BB,
 281                                         BoUpSLP &R) {
 282   // Check if this block is inside a loop.
 283   Loop *L = LI->getLoopFor(BB);
 284   if (!L)
 285     return;
 286
 287   // Check if it has a preheader.
 288   BasicBlock *PreHeader = L->getLoopPreheader();
 289   if (!PreHeader)
 290     return;
 291
 292   // Mark the insertion point for the block.
 293   Instruction *Location = PreHeader->getTerminator();
 294
 295   BoUpSLP::ValueList &Gathers = R.getGatherSeqInstructions();
 296   for (BoUpSLP::ValueList::iterator it = Gathers.begin(), e = Gathers.end();
 297        it != e; ++it) {
 298     InsertElementInst *Insert = dyn_cast<InsertElementInst>(*it);
 299
 300     // The InsertElement sequence can be simplified into a constant.
 301     if (!Insert)
 302       continue;
 303
 304     // If the vector or the element that we insert into it are
 305     // instructions that are defined in this basic block then we can't
 306     // hoist this instruction.
 307     Instruction *CurrVec = dyn_cast<Instruction>(Insert->getOperand(0));
 308     Instruction *NewElem = dyn_cast<Instruction>(Insert->getOperand(1));
 309     if (CurrVec && L->contains(CurrVec)) continue;
 310     if (NewElem && L->contains(NewElem)) continue;
 311
 312     // We can hoist this instruction. Move it to the pre-header.
 313     Insert->moveBefore(Location);
 314   }
 315 }
 316
 317 } // end anonymous namespace
 318
 319 char SLPVectorizer::ID = 0;
 320 static const char lv_name[] = "SLP Vectorizer";
 321 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false)
 322 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
 323 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
 324 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
 325 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
 326 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false)
 327
 328 namespace llvm {
 329   Pass *createSLPVectorizerPass() {
 330     return new SLPVectorizer();
 331   }
 332 }
 333