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 // This pass will multi-block loops only if they contain no non-unrolled
  15 // subloops.  The process of unrolling can produce extraneous basic blocks
  16 // linked with unconditional branches.  This will be corrected in the future.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #define DEBUG_TYPE "loop-unroll"
  21 #include "llvm/Transforms/Scalar.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/Function.h"
  24 #include "llvm/Instructions.h"
  25 #include "llvm/Analysis/ConstantFolding.h"
  26 #include "llvm/Analysis/LoopInfo.h"
  27 #include "llvm/Analysis/LoopPass.h"
  28 #include "llvm/Transforms/Utils/Cloning.h"
  29 #include "llvm/Transforms/Utils/Local.h"
  30 #include "llvm/Support/CFG.h"
  31 #include "llvm/Support/Compiler.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/MathExtras.h"
  35 #include "llvm/ADT/Statistic.h"
  36 #include "llvm/ADT/STLExtras.h"
  37 #include "llvm/ADT/SmallPtrSet.h"
  38 #include "llvm/IntrinsicInst.h"
  39 #include <algorithm>
  40 #include <climits>
  41 #include <cstdio>
  42 using namespace llvm;
  43
  44 STATISTIC(NumCompletelyUnrolled, "Number of loops completely unrolled");
  45 STATISTIC(NumUnrolled,    "Number of loops unrolled (completely or otherwise)");
  46
  47 namespace {
  48   cl::opt<unsigned>
  49   UnrollThreshold
  50     ("unroll-threshold", cl::init(100), cl::Hidden,
  51      cl::desc("The cut-off point for automatic loop unrolling"));
  52
  53   cl::opt<unsigned>
  54   UnrollCount
  55     ("unroll-count", cl::init(0), cl::Hidden,
  56      cl::desc("Use this unroll count for all loops, for testing purposes"));
  57
  58   class VISIBILITY_HIDDEN LoopUnroll : public LoopPass {
  59     LoopInfo *LI;  // The current loop information
  60   public:
  61     static char ID; // Pass ID, replacement for typeid
  62     LoopUnroll() : LoopPass((intptr_t)&ID) {}
  63
  64     /// A magic value for use with the Threshold parameter to indicate
  65     /// that the loop unroll should be performed regardless of how much
  66     /// code expansion would result.
  67     static const unsigned NoThreshold = UINT_MAX;
  68
  69     bool runOnLoop(Loop *L, LPPassManager &LPM);
  70     bool unrollLoop(Loop *L, unsigned Count, unsigned Threshold);
  71     BasicBlock *FoldBlockIntoPredecessor(BasicBlock *BB);
  72
  73     /// This transformation requires natural loop information & requires that
  74     /// loop preheaders be inserted into the CFG...
  75     ///
  76     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  77       AU.addRequiredID(LoopSimplifyID);
  78       AU.addRequiredID(LCSSAID);
  79       AU.addRequired<LoopInfo>();
  80       AU.addPreservedID(LCSSAID);
  81       AU.addPreserved<LoopInfo>();
  82     }
  83   };
  84   char LoopUnroll::ID = 0;
  85   RegisterPass<LoopUnroll> X("loop-unroll", "Unroll loops");
  86 }
  87
  88 LoopPass *llvm::createLoopUnrollPass() { return new LoopUnroll(); }
  89
  90 /// ApproximateLoopSize - Approximate the size of the loop.
  91 static unsigned ApproximateLoopSize(const Loop *L) {
  92   unsigned Size = 0;
  93   for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i) {
  94     BasicBlock *BB = L->getBlocks()[i];
  95     Instruction *Term = BB->getTerminator();
  96     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
  97       if (isa<PHINode>(I) && BB == L->getHeader()) {
  98         // Ignore PHI nodes in the header.
  99       } else if (I->hasOneUse() && I->use_back() == Term) {
 100         // Ignore instructions only used by the loop terminator.
 101       } else if (isa<DbgInfoIntrinsic>(I)) {
 102         // Ignore debug instructions
 103       } else if (isa<CallInst>(I)) {
 104         // Estimate size overhead introduced by call instructions which
 105         // is higher than other instructions. Here 3 and 10 are magic
 106         // numbers that help one isolated test case from PR2067 without
 107         // negatively impacting measured benchmarks.
 108         if (isa<IntrinsicInst>(I))
 109           Size = Size + 3;
 110         else
 111           Size = Size + 10;
 112       } else {
 113         ++Size;
 114       }
 115
 116       // TODO: Ignore expressions derived from PHI and constants if inval of phi
 117       // is a constant, or if operation is associative.  This will get induction
 118       // variables.
 119     }
 120   }
 121
 122   return Size;
 123 }
 124
 125 // RemapInstruction - Convert the instruction operands from referencing the
 126 // current values into those specified by ValueMap.
 127 //
 128 static inline void RemapInstruction(Instruction *I,
 129                                     DenseMap<const Value *, Value*> &ValueMap) {
 130   for (unsigned op = 0, E = I->getNumOperands(); op != E; ++op) {
 131     Value *Op = I->getOperand(op);
 132     DenseMap<const Value *, Value*>::iterator It = ValueMap.find(Op);
 133     if (It != ValueMap.end()) Op = It->second;
 134     I->setOperand(op, Op);
 135   }
 136 }
 137
 138 // FoldBlockIntoPredecessor - Folds a basic block into its predecessor if it
 139 // only has one predecessor, and that predecessor only has one successor.
 140 // Returns the new combined block.
 141 BasicBlock *LoopUnroll::FoldBlockIntoPredecessor(BasicBlock *BB) {
 142   // Merge basic blocks into their predecessor if there is only one distinct
 143   // pred, and if there is only one distinct successor of the predecessor, and
 144   // if there are no PHI nodes.
 145   //
 146   BasicBlock *OnlyPred = BB->getSinglePredecessor();
 147   if (!OnlyPred) return 0;
 148
 149   if (OnlyPred->getTerminator()->getNumSuccessors() != 1)
 150     return 0;
 151
 152   DOUT << "Merging: " << *BB << "into: " << *OnlyPred;
 153
 154   // Resolve any PHI nodes at the start of the block.  They are all
 155   // guaranteed to have exactly one entry if they exist, unless there are
 156   // multiple duplicate (but guaranteed to be equal) entries for the
 157   // incoming edges.  This occurs when there are multiple edges from
 158   // OnlyPred to OnlySucc.
 159   //
 160   while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
 161     PN->replaceAllUsesWith(PN->getIncomingValue(0));
 162     BB->getInstList().pop_front();  // Delete the phi node...
 163   }
 164
 165   // Delete the unconditional branch from the predecessor...
 166   OnlyPred->getInstList().pop_back();
 167
 168   // Move all definitions in the successor to the predecessor...
 169   OnlyPred->getInstList().splice(OnlyPred->end(), BB->getInstList());
 170
 171   // Make all PHI nodes that referred to BB now refer to Pred as their
 172   // source...
 173   BB->replaceAllUsesWith(OnlyPred);
 174
 175   std::string OldName = BB->getName();
 176
 177   // Erase basic block from the function...
 178   LI->removeBlock(BB);
 179   BB->eraseFromParent();
 180
 181   // Inherit predecessor's name if it exists...
 182   if (!OldName.empty() && !OnlyPred->hasName())
 183     OnlyPred->setName(OldName);
 184
 185   return OnlyPred;
 186 }
 187
 188 bool LoopUnroll::runOnLoop(Loop *L, LPPassManager &LPM) {
 189   LI = &getAnalysis<LoopInfo>();
 190
 191   // Unroll the loop.
 192   if (!unrollLoop(L, UnrollCount, UnrollThreshold))
 193     return false;
 194
 195   // Update the loop information for this loop.
 196   // If we completely unrolled the loop, remove it from the parent.
 197   if (L->getNumBackEdges() == 0)
 198     LPM.deleteLoopFromQueue(L);
 199
 200   return true;
 201 }
 202
 203 /// Unroll the given loop by UnrollCount, or by a heuristically-determined
 204 /// value if Count is zero. If Threshold is not NoThreshold, it is a value
 205 /// to limit code size expansion. If the loop size would expand beyond the
 206 /// threshold value, unrolling is suppressed. The return value is true if
 207 /// any transformations are performed.
 208 ///
 209 bool LoopUnroll::unrollLoop(Loop *L, unsigned Count, unsigned Threshold) {
 210   assert(L->isLCSSAForm());
 211
 212   BasicBlock *Header = L->getHeader();
 213   BasicBlock *LatchBlock = L->getLoopLatch();
 214   BranchInst *BI = dyn_cast<BranchInst>(LatchBlock->getTerminator());
 215
 216   DOUT << "Loop Unroll: F[" << Header->getParent()->getName()
 217        << "] Loop %" << Header->getName() << "\n";
 218
 219   if (!BI || BI->isUnconditional()) {
 220     // The loop-rotate pass can be helpful to avoid this in many cases.
 221     DOUT << "  Can't unroll; loop not terminated by a conditional branch.\n";
 222     return false;
 223   }
 224
 225   // Determine the trip count and/or trip multiple. A TripCount value of zero
 226   // is used to mean an unknown trip count. The TripMultiple value is the
 227   // greatest known integer multiple of the trip count.
 228   unsigned TripCount = 0;
 229   unsigned TripMultiple = 1;
 230   if (Value *TripCountValue = L->getTripCount()) {
 231     if (ConstantInt *TripCountC = dyn_cast<ConstantInt>(TripCountValue)) {
 232       // Guard against huge trip counts. This also guards against assertions in
 233       // APInt from the use of getZExtValue, below.
 234       if (TripCountC->getValue().getActiveBits() <= 32) {
 235         TripCount = (unsigned)TripCountC->getZExtValue();
 236       }
 237     } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(TripCountValue)) {
 238       switch (BO->getOpcode()) {
 239       case BinaryOperator::Mul:
 240         if (ConstantInt *MultipleC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
 241           if (MultipleC->getValue().getActiveBits() <= 32) {
 242             TripMultiple = (unsigned)MultipleC->getZExtValue();
 243           }
 244         }
 245         break;
 246       default: break;
 247       }
 248     }
 249   }
 250   if (TripCount != 0)
 251     DOUT << "  Trip Count = " << TripCount << "\n";
 252   if (TripMultiple != 1)
 253     DOUT << "  Trip Multiple = " << TripMultiple << "\n";
 254
 255   // Automatically select an unroll count.
 256   if (Count == 0) {
 257     // Conservative heuristic: if we know the trip count, see if we can
 258     // completely unroll (subject to the threshold, checked below); otherwise
 259     // don't unroll.
 260     if (TripCount != 0) {
 261       Count = TripCount;
 262     } else {
 263       return false;
 264     }
 265   }
 266
 267   // Effectively "DCE" unrolled iterations that are beyond the tripcount
 268   // and will never be executed.
 269   if (TripCount != 0 && Count > TripCount)
 270     Count = TripCount;
 271
 272   assert(Count > 0);
 273   assert(TripMultiple > 0);
 274   assert(TripCount == 0 || TripCount % TripMultiple == 0);
 275
 276   // Enforce the threshold.
 277   if (Threshold != NoThreshold) {
 278     unsigned LoopSize = ApproximateLoopSize(L);
 279     DOUT << "  Loop Size = " << LoopSize << "\n";
 280     uint64_t Size = (uint64_t)LoopSize*Count;
 281     if (TripCount != 1 && Size > Threshold) {
 282       DOUT << "  TOO LARGE TO UNROLL: "
 283            << Size << ">" << Threshold << "\n";
 284       return false;
 285     }
 286   }
 287
 288   // Are we eliminating the loop control altogether?
 289   bool CompletelyUnroll = Count == TripCount;
 290
 291   // If we know the trip count, we know the multiple...
 292   unsigned BreakoutTrip = 0;
 293   if (TripCount != 0) {
 294     BreakoutTrip = TripCount % Count;
 295     TripMultiple = 0;
 296   } else {
 297     // Figure out what multiple to use.
 298     BreakoutTrip = TripMultiple =
 299       (unsigned)GreatestCommonDivisor64(Count, TripMultiple);
 300   }
 301
 302   if (CompletelyUnroll) {
 303     DOUT << "COMPLETELY UNROLLING loop %" << Header->getName()
 304          << " with trip count " << TripCount << "!\n";
 305   } else {
 306     DOUT << "UNROLLING loop %" << Header->getName()
 307          << " by " << Count;
 308     if (TripMultiple == 0 || BreakoutTrip != TripMultiple) {
 309       DOUT << " with a breakout at trip " << BreakoutTrip;
 310     } else if (TripMultiple != 1) {
 311       DOUT << " with " << TripMultiple << " trips per branch";
 312     }
 313     DOUT << "!\n";
 314   }
 315
 316   std::vector<BasicBlock*> LoopBlocks = L->getBlocks();
 317
 318   bool ContinueOnTrue = L->contains(BI->getSuccessor(0));
 319   BasicBlock *LoopExit = BI->getSuccessor(ContinueOnTrue);
 320
 321   // For the first iteration of the loop, we should use the precloned values for
 322   // PHI nodes.  Insert associations now.
 323   typedef DenseMap<const Value*, Value*> ValueMapTy;
 324   ValueMapTy LastValueMap;
 325   std::vector<PHINode*> OrigPHINode;
 326   for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
 327     PHINode *PN = cast<PHINode>(I);
 328     OrigPHINode.push_back(PN);
 329     if (Instruction *I =
 330                 dyn_cast<Instruction>(PN->getIncomingValueForBlock(LatchBlock)))
 331       if (L->contains(I->getParent()))
 332         LastValueMap[I] = I;
 333   }
 334
 335   std::vector<BasicBlock*> Headers;
 336   std::vector<BasicBlock*> Latches;
 337   Headers.push_back(Header);
 338   Latches.push_back(LatchBlock);
 339
 340   for (unsigned It = 1; It != Count; ++It) {
 341     char SuffixBuffer[100];
 342     sprintf(SuffixBuffer, ".%d", It);
 343
 344     std::vector<BasicBlock*> NewBlocks;
 345
 346     for (std::vector<BasicBlock*>::iterator BB = LoopBlocks.begin(),
 347          E = LoopBlocks.end(); BB != E; ++BB) {
 348       ValueMapTy ValueMap;
 349       BasicBlock *New = CloneBasicBlock(*BB, ValueMap, SuffixBuffer);
 350       Header->getParent()->getBasicBlockList().push_back(New);
 351
 352       // Loop over all of the PHI nodes in the block, changing them to use the
 353       // incoming values from the previous block.
 354       if (*BB == Header)
 355         for (unsigned i = 0, e = OrigPHINode.size(); i != e; ++i) {
 356           PHINode *NewPHI = cast<PHINode>(ValueMap[OrigPHINode[i]]);
 357           Value *InVal = NewPHI->getIncomingValueForBlock(LatchBlock);
 358           if (Instruction *InValI = dyn_cast<Instruction>(InVal))
 359             if (It > 1 && L->contains(InValI->getParent()))
 360               InVal = LastValueMap[InValI];
 361           ValueMap[OrigPHINode[i]] = InVal;
 362           New->getInstList().erase(NewPHI);
 363         }
 364
 365       // Update our running map of newest clones
 366       LastValueMap[*BB] = New;
 367       for (ValueMapTy::iterator VI = ValueMap.begin(), VE = ValueMap.end();
 368            VI != VE; ++VI)
 369         LastValueMap[VI->first] = VI->second;
 370
 371       L->addBasicBlockToLoop(New, LI->getBase());
 372
 373       // Add phi entries for newly created values to all exit blocks except
 374       // the successor of the latch block.  The successor of the exit block will
 375       // be updated specially after unrolling all the way.
 376       if (*BB != LatchBlock)
 377         for (Value::use_iterator UI = (*BB)->use_begin(), UE = (*BB)->use_end();
 378              UI != UE;) {
 379           Instruction *UseInst = cast<Instruction>(*UI);
 380           ++UI;
 381           if (isa<PHINode>(UseInst) && !L->contains(UseInst->getParent())) {
 382             PHINode *phi = cast<PHINode>(UseInst);
 383             Value *Incoming = phi->getIncomingValueForBlock(*BB);
 384             phi->addIncoming(Incoming, New);
 385           }
 386         }
 387
 388       // Keep track of new headers and latches as we create them, so that
 389       // we can insert the proper branches later.
 390       if (*BB == Header)
 391         Headers.push_back(New);
 392       if (*BB == LatchBlock) {
 393         Latches.push_back(New);
 394
 395         // Also, clear out the new latch's back edge so that it doesn't look
 396         // like a new loop, so that it's amenable to being merged with adjacent
 397         // blocks later on.
 398         TerminatorInst *Term = New->getTerminator();
 399         assert(L->contains(Term->getSuccessor(!ContinueOnTrue)));
 400         assert(Term->getSuccessor(ContinueOnTrue) == LoopExit);
 401         Term->setSuccessor(!ContinueOnTrue, NULL);
 402       }
 403
 404       NewBlocks.push_back(New);
 405     }
 406
 407     // Remap all instructions in the most recent iteration
 408     for (unsigned i = 0; i < NewBlocks.size(); ++i)
 409       for (BasicBlock::iterator I = NewBlocks[i]->begin(),
 410            E = NewBlocks[i]->end(); I != E; ++I)
 411         RemapInstruction(I, LastValueMap);
 412   }
 413
 414   // The latch block exits the loop.  If there are any PHI nodes in the
 415   // successor blocks, update them to use the appropriate values computed as the
 416   // last iteration of the loop.
 417   if (Count != 1) {
 418     SmallPtrSet<PHINode*, 8> Users;
 419     for (Value::use_iterator UI = LatchBlock->use_begin(),
 420          UE = LatchBlock->use_end(); UI != UE; ++UI)
 421       if (PHINode *phi = dyn_cast<PHINode>(*UI))
 422         Users.insert(phi);
 423
 424     BasicBlock *LastIterationBB = cast<BasicBlock>(LastValueMap[LatchBlock]);
 425     for (SmallPtrSet<PHINode*,8>::iterator SI = Users.begin(), SE = Users.end();
 426          SI != SE; ++SI) {
 427       PHINode *PN = *SI;
 428       Value *InVal = PN->removeIncomingValue(LatchBlock, false);
 429       // If this value was defined in the loop, take the value defined by the
 430       // last iteration of the loop.
 431       if (Instruction *InValI = dyn_cast<Instruction>(InVal)) {
 432         if (L->contains(InValI->getParent()))
 433           InVal = LastValueMap[InVal];
 434       }
 435       PN->addIncoming(InVal, LastIterationBB);
 436     }
 437   }
 438
 439   // Now, if we're doing complete unrolling, loop over the PHI nodes in the
 440   // original block, setting them to their incoming values.
 441   if (CompletelyUnroll) {
 442     BasicBlock *Preheader = L->getLoopPreheader();
 443     for (unsigned i = 0, e = OrigPHINode.size(); i != e; ++i) {
 444       PHINode *PN = OrigPHINode[i];
 445       PN->replaceAllUsesWith(PN->getIncomingValueForBlock(Preheader));
 446       Header->getInstList().erase(PN);
 447     }
 448   }
 449
 450   // Now that all the basic blocks for the unrolled iterations are in place,
 451   // set up the branches to connect them.
 452   for (unsigned i = 0, e = Latches.size(); i != e; ++i) {
 453     // The original branch was replicated in each unrolled iteration.
 454     BranchInst *Term = cast<BranchInst>(Latches[i]->getTerminator());
 455
 456     // The branch destination.
 457     unsigned j = (i + 1) % e;
 458     BasicBlock *Dest = Headers[j];
 459     bool NeedConditional = true;
 460
 461     // For a complete unroll, make the last iteration end with a branch
 462     // to the exit block.
 463     if (CompletelyUnroll && j == 0) {
 464       Dest = LoopExit;
 465       NeedConditional = false;
 466     }
 467
 468     // If we know the trip count or a multiple of it, we can safely use an
 469     // unconditional branch for some iterations.
 470     if (j != BreakoutTrip && (TripMultiple == 0 || j % TripMultiple != 0)) {
 471       NeedConditional = false;
 472     }
 473
 474     if (NeedConditional) {
 475       // Update the conditional branch's successor for the following
 476       // iteration.
 477       Term->setSuccessor(!ContinueOnTrue, Dest);
 478     } else {
 479       Term->setUnconditionalDest(Dest);
 480       // Merge adjacent basic blocks, if possible.
 481       if (BasicBlock *Fold = FoldBlockIntoPredecessor(Dest)) {
 482         std::replace(Latches.begin(), Latches.end(), Dest, Fold);
 483         std::replace(Headers.begin(), Headers.end(), Dest, Fold);
 484       }
 485     }
 486   }
 487
 488   // At this point, the code is well formed.  We now do a quick sweep over the
 489   // inserted code, doing constant propagation and dead code elimination as we
 490   // go.
 491   const std::vector<BasicBlock*> &NewLoopBlocks = L->getBlocks();
 492   for (std::vector<BasicBlock*>::const_iterator BB = NewLoopBlocks.begin(),
 493        BBE = NewLoopBlocks.end(); BB != BBE; ++BB)
 494     for (BasicBlock::iterator I = (*BB)->begin(), E = (*BB)->end(); I != E; ) {
 495       Instruction *Inst = I++;
 496
 497       if (isInstructionTriviallyDead(Inst))
 498         (*BB)->getInstList().erase(Inst);
 499       else if (Constant *C = ConstantFoldInstruction(Inst)) {
 500         Inst->replaceAllUsesWith(C);
 501         (*BB)->getInstList().erase(Inst);
 502       }
 503     }
 504
 505   NumCompletelyUnrolled += CompletelyUnroll;
 506   ++NumUnrolled;
 507   return true;
 508 }