lib/Transforms/Scalar/LoopUnroll.cpp

   1 //===-- LoopUnroll.cpp - Loop unroller 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 pass implements a simple loop unroller.  It works best when loops have
  11 // been canonicalized by the -indvars pass, allowing it to determine the trip
  12 // counts of loops easily.
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "loop-unroll"
  16 #include "llvm/IntrinsicInst.h"
  17 #include "llvm/Transforms/Scalar.h"
  18 #include "llvm/Analysis/LoopInfo.h"
  19 #include "llvm/Analysis/LoopPass.h"
  20 #include "llvm/Support/Compiler.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Transforms/Utils/UnrollLoop.h"
  24 #include <climits>
  25
  26 using namespace llvm;
  27
  28 static cl::opt<unsigned>
  29 UnrollThreshold("unroll-threshold", cl::init(100), cl::Hidden,
  30   cl::desc("The cut-off point for automatic loop unrolling"));
  31
  32 static cl::opt<unsigned>
  33 UnrollCount("unroll-count", cl::init(0), cl::Hidden,
  34   cl::desc("Use this unroll count for all loops, for testing purposes"));
  35
  36 static cl::opt<bool>
  37 UnrollAllowPartial("unroll-allow-partial", cl::init(false), cl::Hidden,
  38   cl::desc("Allows loops to be partially unrolled until "
  39            "-unroll-threshold loop size is reached."));
  40
  41 namespace {
  42   class VISIBILITY_HIDDEN LoopUnroll : public LoopPass {
  43   public:
  44     static char ID; // Pass ID, replacement for typeid
  45     LoopUnroll() : LoopPass(&ID) {}
  46
  47     /// A magic value for use with the Threshold parameter to indicate
  48     /// that the loop unroll should be performed regardless of how much
  49     /// code expansion would result.
  50     static const unsigned NoThreshold = UINT_MAX;
  51
  52     bool runOnLoop(Loop *L, LPPassManager &LPM);
  53
  54     /// This transformation requires natural loop information & requires that
  55     /// loop preheaders be inserted into the CFG...
  56     ///
  57     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  58       AU.addRequiredID(LoopSimplifyID);
  59       AU.addRequiredID(LCSSAID);
  60       AU.addRequired<LoopInfo>();
  61       AU.addPreservedID(LCSSAID);
  62       AU.addPreserved<LoopInfo>();
  63       // FIXME: Loop unroll requires LCSSA. And LCSSA requires dom info.
  64       // If loop unroll does not preserve dom info then LCSSA pass on next
  65       // loop will receive invalid dom info.
  66       // For now, recreate dom info, if loop is unrolled.
  67       AU.addPreserved<DominatorTree>();
  68       AU.addPreserved<DominanceFrontier>();
  69     }
  70   };
  71 }
  72
  73 char LoopUnroll::ID = 0;
  74 static RegisterPass<LoopUnroll> X("loop-unroll", "Unroll loops");
  75
  76 Pass *llvm::createLoopUnrollPass() { return new LoopUnroll(); }
  77
  78 /// ApproximateLoopSize - Approximate the size of the loop.
  79 static unsigned ApproximateLoopSize(const Loop *L) {
  80   unsigned Size = 0;
  81   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
  82        I != E; ++I) {
  83     BasicBlock *BB = *I;
  84     Instruction *Term = BB->getTerminator();
  85     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
  86       if (isa<PHINode>(I) && BB == L->getHeader()) {
  87         // Ignore PHI nodes in the header.
  88       } else if (I->hasOneUse() && I->use_back() == Term) {
  89         // Ignore instructions only used by the loop terminator.
  90       } else if (isa<DbgInfoIntrinsic>(I)) {
  91         // Ignore debug instructions
  92       } else if (isa<CallInst>(I)) {
  93         // Estimate size overhead introduced by call instructions which
  94         // is higher than other instructions. Here 3 and 10 are magic
  95         // numbers that help one isolated test case from PR2067 without
  96         // negatively impacting measured benchmarks.
  97         if (isa<IntrinsicInst>(I))
  98           Size = Size + 3;
  99         else
 100           Size = Size + 10;
 101       } else {
 102         ++Size;
 103       }
 104
 105       // TODO: Ignore expressions derived from PHI and constants if inval of phi
 106       // is a constant, or if operation is associative.  This will get induction
 107       // variables.
 108     }
 109   }
 110
 111   return Size;
 112 }
 113
 114 bool LoopUnroll::runOnLoop(Loop *L, LPPassManager &LPM) {
 115   assert(L->isLCSSAForm());
 116   LoopInfo *LI = &getAnalysis<LoopInfo>();
 117
 118   BasicBlock *Header = L->getHeader();
 119   DOUT << "Loop Unroll: F[" << Header->getParent()->getName()
 120        << "] Loop %" << Header->getName() << "\n";
 121
 122   // Find trip count
 123   unsigned TripCount = L->getSmallConstantTripCount();
 124   unsigned Count = UnrollCount;
 125
 126   // Automatically select an unroll count.
 127   if (Count == 0) {
 128     // Conservative heuristic: if we know the trip count, see if we can
 129     // completely unroll (subject to the threshold, checked below); otherwise
 130     // try to find greatest modulo of the trip count which is still under
 131     // threshold value.
 132     if (TripCount != 0) {
 133       Count = TripCount;
 134     } else {
 135       return false;
 136     }
 137   }
 138
 139   // Enforce the threshold.
 140   if (UnrollThreshold != NoThreshold) {
 141     unsigned LoopSize = ApproximateLoopSize(L);
 142     DOUT << "  Loop Size = " << LoopSize << "\n";
 143     uint64_t Size = (uint64_t)LoopSize*Count;
 144     if (TripCount != 1 && Size > UnrollThreshold) {
 145       DOUT << "  Too large to fully unroll with count: " << Count
 146            << " because size: " << Size << ">" << UnrollThreshold << "\n";
 147       if (UnrollAllowPartial) {
 148         // Reduce unroll count to be modulo of TripCount for partial unrolling
 149         Count = UnrollThreshold / LoopSize;
 150         while (Count != 0 && TripCount%Count != 0) {
 151           Count--;
 152         }
 153         if (Count < 2) {
 154           DOUT << "  could not unroll partially\n";
 155           return false;
 156         } else {
 157           DOUT << "  partially unrolling with count: " << Count << "\n";
 158         }
 159       } else {
 160         DOUT << "  will not try to unroll partially because "
 161              << "-unroll-allow-partial not given\n";
 162         return false;
 163       }
 164     }
 165   }
 166
 167   // Unroll the loop.
 168   Function *F = L->getHeader()->getParent();
 169   if (!UnrollLoop(L, Count, LI, &LPM))
 170     return false;
 171
 172   // FIXME: Reconstruct dom info, because it is not preserved properly.
 173   DominatorTree *DT = getAnalysisToUpdate<DominatorTree>();
 174   if (DT) {
 175     DT->runOnFunction(*F);
 176     DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>();
 177     if (DF)
 178       DF->runOnFunction(*F);
 179   }
 180   return true;
 181 }