lib/Target/PowerPC/PPCLoopDataPrefetch.cpp

   1 //===-------- PPCLoopDataPrefetch.cpp - Loop Data Prefetching Pass --------===//
   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 //
  10 // This file implements a Loop Data Prefetching Pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "ppc-loop-data-prefetch"
  15 #include "PPC.h"
  16 #include "llvm/Transforms/Scalar.h"
  17 #include "llvm/ADT/DepthFirstIterator.h"
  18 #include "llvm/ADT/Statistic.h"
  19 #include "llvm/Analysis/AssumptionCache.h"
  20 #include "llvm/Analysis/CodeMetrics.h"
  21 #include "llvm/Analysis/InstructionSimplify.h"
  22 #include "llvm/Analysis/LoopInfo.h"
  23 #include "llvm/Analysis/ScalarEvolution.h"
  24 #include "llvm/Analysis/ScalarEvolutionExpander.h"
  25 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  26 #include "llvm/Analysis/TargetTransformInfo.h"
  27 #include "llvm/Analysis/ValueTracking.h"
  28 #include "llvm/IR/CFG.h"
  29 #include "llvm/IR/Dominators.h"
  30 #include "llvm/IR/Function.h"
  31 #include "llvm/IR/IntrinsicInst.h"
  32 #include "llvm/IR/Module.h"
  33 #include "llvm/Support/CommandLine.h"
  34 #include "llvm/Support/Debug.h"
  35 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  36 #include "llvm/Transforms/Utils/Local.h"
  37 #include "llvm/Transforms/Utils/ValueMapper.h"
  38 using namespace llvm;
  39
  40 // By default, we limit this to creating 16 PHIs (which is a little over half
  41 // of the allocatable register set).
  42 static cl::opt<bool>
  43 PrefetchWrites("ppc-loop-prefetch-writes", cl::Hidden, cl::init(false),
  44                cl::desc("Prefetch write addresses"));
  45
  46 // This seems like a reasonable default for the BG/Q (this pass is enabled, by
  47 // default, only on the BG/Q).
  48 static cl::opt<unsigned>
  49 PrefDist("ppc-loop-prefetch-distance", cl::Hidden, cl::init(300),
  50          cl::desc("The loop prefetch distance"));
  51
  52 static cl::opt<unsigned>
  53 CacheLineSize("ppc-loop-prefetch-cache-line", cl::Hidden, cl::init(64),
  54               cl::desc("The loop prefetch cache line size"));
  55
  56 namespace llvm {
  57   void initializePPCLoopDataPrefetchPass(PassRegistry&);
  58 }
  59
  60 namespace {
  61
  62   class PPCLoopDataPrefetch : public FunctionPass {
  63   public:
  64     static char ID; // Pass ID, replacement for typeid
  65     PPCLoopDataPrefetch() : FunctionPass(ID) {
  66       initializePPCLoopDataPrefetchPass(*PassRegistry::getPassRegistry());
  67     }
  68
  69     void getAnalysisUsage(AnalysisUsage &AU) const override {
  70       AU.addRequired<AssumptionCacheTracker>();
  71       AU.addPreserved<DominatorTreeWrapperPass>();
  72       AU.addRequired<LoopInfoWrapperPass>();
  73       AU.addPreserved<LoopInfoWrapperPass>();
  74       AU.addRequired<ScalarEvolution>();
  75       // FIXME: For some reason, preserving SE here breaks LSR (even if
  76       // this pass changes nothing).
  77       // AU.addPreserved<ScalarEvolution>();
  78       AU.addRequired<TargetTransformInfoWrapperPass>();
  79     }
  80
  81     bool runOnFunction(Function &F) override;
  82     bool runOnLoop(Loop *L);
  83
  84   private:
  85     AssumptionCache *AC;
  86     LoopInfo *LI;
  87     ScalarEvolution *SE;
  88     const TargetTransformInfo *TTI;
  89     const DataLayout *DL;
  90   };
  91 }
  92
  93 char PPCLoopDataPrefetch::ID = 0;
  94 INITIALIZE_PASS_BEGIN(PPCLoopDataPrefetch, "ppc-loop-data-prefetch",
  95                       "PPC Loop Data Prefetch", false, false)
  96 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
  97 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
  98 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
  99 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
 100 INITIALIZE_PASS_END(PPCLoopDataPrefetch, "ppc-loop-data-prefetch",
 101                     "PPC Loop Data Prefetch", false, false)
 102
 103 FunctionPass *llvm::createPPCLoopDataPrefetchPass() { return new PPCLoopDataPrefetch(); }
 104
 105 bool PPCLoopDataPrefetch::runOnFunction(Function &F) {
 106   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
 107   SE = &getAnalysis<ScalarEvolution>();
 108   DL = &F.getParent()->getDataLayout();
 109   AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
 110   TTI = &getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F);
 111
 112   bool MadeChange = false;
 113
 114   for (auto I = LI->begin(), IE = LI->end(); I != IE; ++I)
 115     for (auto L = df_begin(*I), LE = df_end(*I); L != LE; ++L)
 116       MadeChange |= runOnLoop(*L);
 117
 118   return MadeChange;
 119 }
 120
 121 bool PPCLoopDataPrefetch::runOnLoop(Loop *L) {
 122   bool MadeChange = false;
 123
 124   // Only prefetch in the inner-most loop
 125   if (!L->empty())
 126     return MadeChange;
 127
 128   SmallPtrSet<const Value *, 32> EphValues;
 129   CodeMetrics::collectEphemeralValues(L, AC, EphValues);
 130
 131   // Calculate the number of iterations ahead to prefetch
 132   CodeMetrics Metrics;
 133   for (Loop::block_iterator I = L->block_begin(), IE = L->block_end();
 134        I != IE; ++I) {
 135
 136     // If the loop already has prefetches, then assume that the user knows
 137     // what he or she is doing and don't add any more.
 138     for (BasicBlock::iterator J = (*I)->begin(), JE = (*I)->end();
 139          J != JE; ++J)
 140       if (CallInst *CI = dyn_cast<CallInst>(J))
 141         if (Function *F = CI->getCalledFunction())
 142           if (F->getIntrinsicID() == Intrinsic::prefetch)
 143             return MadeChange;
 144
 145     Metrics.analyzeBasicBlock(*I, *TTI, EphValues);
 146   }
 147   unsigned LoopSize = Metrics.NumInsts;
 148   if (!LoopSize)
 149     LoopSize = 1;
 150
 151   unsigned ItersAhead = PrefDist/LoopSize;
 152   if (!ItersAhead)
 153     ItersAhead = 1;
 154
 155   SmallVector<std::pair<Instruction *, const SCEVAddRecExpr *>, 16> PrefLoads;
 156   for (Loop::block_iterator I = L->block_begin(), IE = L->block_end();
 157        I != IE; ++I) {
 158     for (BasicBlock::iterator J = (*I)->begin(), JE = (*I)->end();
 159         J != JE; ++J) {
 160       Value *PtrValue;
 161       Instruction *MemI;
 162
 163       if (LoadInst *LMemI = dyn_cast<LoadInst>(J)) {
 164         MemI = LMemI;
 165         PtrValue = LMemI->getPointerOperand();
 166       } else if (StoreInst *SMemI = dyn_cast<StoreInst>(J)) {
 167         if (!PrefetchWrites) continue;
 168         MemI = SMemI;
 169         PtrValue = SMemI->getPointerOperand();
 170       } else continue;
 171
 172       unsigned PtrAddrSpace = PtrValue->getType()->getPointerAddressSpace();
 173       if (PtrAddrSpace)
 174         continue;
 175
 176       if (L->isLoopInvariant(PtrValue))
 177         continue;
 178
 179       const SCEV *LSCEV = SE->getSCEV(PtrValue);
 180       const SCEVAddRecExpr *LSCEVAddRec = dyn_cast<SCEVAddRecExpr>(LSCEV);
 181       if (!LSCEVAddRec)
 182         continue;
 183
 184       // We don't want to double prefetch individual cache lines. If this load
 185       // is known to be within one cache line of some other load that has
 186       // already been prefetched, then don't prefetch this one as well.
 187       bool DupPref = false;
 188       for (SmallVector<std::pair<Instruction *, const SCEVAddRecExpr *>,
 189              16>::iterator K = PrefLoads.begin(), KE = PrefLoads.end();
 190            K != KE; ++K) {
 191         const SCEV *PtrDiff = SE->getMinusSCEV(LSCEVAddRec, K->second);
 192         if (const SCEVConstant *ConstPtrDiff =
 193             dyn_cast<SCEVConstant>(PtrDiff)) {
 194           int64_t PD = std::abs(ConstPtrDiff->getValue()->getSExtValue());
 195           if (PD < (int64_t) CacheLineSize) {
 196             DupPref = true;
 197             break;
 198           }
 199         }
 200       }
 201       if (DupPref)
 202         continue;
 203
 204       const SCEV *NextLSCEV = SE->getAddExpr(LSCEVAddRec, SE->getMulExpr(
 205         SE->getConstant(LSCEVAddRec->getType(), ItersAhead),
 206         LSCEVAddRec->getStepRecurrence(*SE)));
 207       if (!isSafeToExpand(NextLSCEV, *SE))
 208         continue;
 209
 210       PrefLoads.push_back(std::make_pair(MemI, LSCEVAddRec));
 211
 212       Type *I8Ptr = Type::getInt8PtrTy((*I)->getContext(), PtrAddrSpace);
 213       SCEVExpander SCEVE(*SE, J->getModule()->getDataLayout(), "prefaddr");
 214       Value *PrefPtrValue = SCEVE.expandCodeFor(NextLSCEV, I8Ptr, MemI);
 215
 216       IRBuilder<> Builder(MemI);
 217       Module *M = (*I)->getParent()->getParent();
 218       Type *I32 = Type::getInt32Ty((*I)->getContext());
 219       Value *PrefetchFunc = Intrinsic::getDeclaration(M, Intrinsic::prefetch);
 220       Builder.CreateCall(
 221           PrefetchFunc,
 222           {PrefPtrValue,
 223            ConstantInt::get(I32, MemI->mayReadFromMemory() ? 0 : 1),
 224            ConstantInt::get(I32, 3), ConstantInt::get(I32, 1)});
 225
 226       MadeChange = true;
 227     }
 228   }
 229
 230   return MadeChange;
 231 }
 232