lib/Transforms/Scalar/LoopDeletion.cpp

   1 //===- LoopDeletion.cpp - Dead Loop Deletion 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 the Dead Loop Deletion Pass. This pass is responsible
  11 // for eliminating loops with non-infinite computable trip counts that have no
  12 // side effects or volatile instructions, and do not contribute to the
  13 // computation of the function's return value.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #define DEBUG_TYPE "loop-delete"
  18
  19 #include "llvm/Transforms/Scalar.h"
  20 #include "llvm/Analysis/LoopPass.h"
  21 #include "llvm/Analysis/ScalarEvolution.h"
  22 #include "llvm/ADT/Statistic.h"
  23 #include "llvm/ADT/SmallVector.h"
  24
  25 using namespace llvm;
  26
  27 STATISTIC(NumDeleted, "Number of loops deleted");
  28
  29 namespace {
  30   class VISIBILITY_HIDDEN LoopDeletion : public LoopPass {
  31   public:
  32     static char ID; // Pass ID, replacement for typeid
  33     LoopDeletion() : LoopPass(&ID) {}
  34
  35     // Possibly eliminate loop L if it is dead.
  36     bool runOnLoop(Loop* L, LPPassManager& LPM);
  37
  38     bool SingleDominatingExit(Loop* L,
  39                               SmallVector<BasicBlock*, 4>& exitingBlocks);
  40     bool IsLoopDead(Loop* L, SmallVector<BasicBlock*, 4>& exitingBlocks,
  41                     SmallVector<BasicBlock*, 4>& exitBlocks,
  42                     bool &Changed, BasicBlock *Preheader);
  43
  44     virtual void getAnalysisUsage(AnalysisUsage& AU) const {
  45       AU.addRequired<ScalarEvolution>();
  46       AU.addRequired<DominatorTree>();
  47       AU.addRequired<LoopInfo>();
  48       AU.addRequiredID(LoopSimplifyID);
  49       AU.addRequiredID(LCSSAID);
  50
  51       AU.addPreserved<ScalarEvolution>();
  52       AU.addPreserved<DominatorTree>();
  53       AU.addPreserved<LoopInfo>();
  54       AU.addPreservedID(LoopSimplifyID);
  55       AU.addPreservedID(LCSSAID);
  56       AU.addPreserved<DominanceFrontier>();
  57     }
  58   };
  59 }
  60
  61 char LoopDeletion::ID = 0;
  62 static RegisterPass<LoopDeletion> X("loop-deletion", "Delete dead loops");
  63
  64 Pass* llvm::createLoopDeletionPass() {
  65   return new LoopDeletion();
  66 }
  67
  68 /// SingleDominatingExit - Checks that there is only a single blocks that
  69 /// branches out of the loop, and that it also g the latch block.  Loops
  70 /// with multiple or non-latch-dominating exiting blocks could be dead, but we'd
  71 /// have to do more extensive analysis to make sure, for instance, that the
  72 /// control flow logic involved was or could be made loop-invariant.
  73 bool LoopDeletion::SingleDominatingExit(Loop* L,
  74                                    SmallVector<BasicBlock*, 4>& exitingBlocks) {
  75
  76   if (exitingBlocks.size() != 1)
  77     return false;
  78
  79   BasicBlock* latch = L->getLoopLatch();
  80   if (!latch)
  81     return false;
  82
  83   DominatorTree& DT = getAnalysis<DominatorTree>();
  84   return DT.dominates(exitingBlocks[0], latch);
  85 }
  86
  87 /// IsLoopDead - Determined if a loop is dead.  This assumes that we've already
  88 /// checked for unique exit and exiting blocks, and that the code is in LCSSA
  89 /// form.
  90 bool LoopDeletion::IsLoopDead(Loop* L,
  91                               SmallVector<BasicBlock*, 4>& exitingBlocks,
  92                               SmallVector<BasicBlock*, 4>& exitBlocks,
  93                               bool &Changed, BasicBlock *Preheader) {
  94   BasicBlock* exitingBlock = exitingBlocks[0];
  95   BasicBlock* exitBlock = exitBlocks[0];
  96
  97   // Make sure that all PHI entries coming from the loop are loop invariant.
  98   // Because the code is in LCSSA form, any values used outside of the loop
  99   // must pass through a PHI in the exit block, meaning that this check is
 100   // sufficient to guarantee that no loop-variant values are used outside
 101   // of the loop.
 102   BasicBlock::iterator BI = exitBlock->begin();
 103   while (PHINode* P = dyn_cast<PHINode>(BI)) {
 104     Value* incoming = P->getIncomingValueForBlock(exitingBlock);
 105     if (Instruction* I = dyn_cast<Instruction>(incoming))
 106       if (!L->makeLoopInvariant(I, Changed, Preheader->getTerminator()))
 107         return false;
 108
 109     BI++;
 110   }
 111
 112   // Make sure that no instructions in the block have potential side-effects.
 113   // This includes instructions that could write to memory, and loads that are
 114   // marked volatile.  This could be made more aggressive by using aliasing
 115   // information to identify readonly and readnone calls.
 116   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 117        LI != LE; ++LI) {
 118     for (BasicBlock::iterator BI = (*LI)->begin(), BE = (*LI)->end();
 119          BI != BE; ++BI) {
 120       if (BI->mayHaveSideEffects())
 121         return false;
 122     }
 123   }
 124
 125   return true;
 126 }
 127
 128 /// runOnLoop - Remove dead loops, by which we mean loops that do not impact the
 129 /// observable behavior of the program other than finite running time.  Note
 130 /// we do ensure that this never remove a loop that might be infinite, as doing
 131 /// so could change the halting/non-halting nature of a program.
 132 /// NOTE: This entire process relies pretty heavily on LoopSimplify and LCSSA
 133 /// in order to make various safety checks work.
 134 bool LoopDeletion::runOnLoop(Loop* L, LPPassManager& LPM) {
 135   // We can only remove the loop if there is a preheader that we can
 136   // branch from after removing it.
 137   BasicBlock* preheader = L->getLoopPreheader();
 138   if (!preheader)
 139     return false;
 140
 141   // We can't remove loops that contain subloops.  If the subloops were dead,
 142   // they would already have been removed in earlier executions of this pass.
 143   if (L->begin() != L->end())
 144     return false;
 145
 146   SmallVector<BasicBlock*, 4> exitingBlocks;
 147   L->getExitingBlocks(exitingBlocks);
 148
 149   SmallVector<BasicBlock*, 4> exitBlocks;
 150   L->getUniqueExitBlocks(exitBlocks);
 151
 152   // We require that the loop only have a single exit block.  Otherwise, we'd
 153   // be in the situation of needing to be able to solve statically which exit
 154   // block will be branched to, or trying to preserve the branching logic in
 155   // a loop invariant manner.
 156   if (exitBlocks.size() != 1)
 157     return false;
 158
 159   // Loops with multiple exits or exits that don't dominate the latch
 160   // are too complicated to handle correctly.
 161   if (!SingleDominatingExit(L, exitingBlocks))
 162     return false;
 163
 164   // Finally, we have to check that the loop really is dead.
 165   bool Changed = false;
 166   if (!IsLoopDead(L, exitingBlocks, exitBlocks, Changed, preheader))
 167     return Changed;
 168
 169   // Don't remove loops for which we can't solve the trip count.
 170   // They could be infinite, in which case we'd be changing program behavior.
 171   ScalarEvolution& SE = getAnalysis<ScalarEvolution>();
 172   const SCEV *S = SE.getBackedgeTakenCount(L);
 173   if (isa<SCEVCouldNotCompute>(S))
 174     return Changed;
 175
 176   // Now that we know the removal is safe, remove the loop by changing the
 177   // branch from the preheader to go to the single exit block.
 178   BasicBlock* exitBlock = exitBlocks[0];
 179   BasicBlock* exitingBlock = exitingBlocks[0];
 180
 181   // Because we're deleting a large chunk of code at once, the sequence in which
 182   // we remove things is very important to avoid invalidation issues.  Don't
 183   // mess with this unless you have good reason and know what you're doing.
 184
 185   // Tell ScalarEvolution that the loop is deleted. Do this before
 186   // deleting the loop so that ScalarEvolution can look at the loop
 187   // to determine what it needs to clean up.
 188   SE.forgetLoopBackedgeTakenCount(L);
 189
 190   // Connect the preheader directly to the exit block.
 191   TerminatorInst* TI = preheader->getTerminator();
 192   TI->replaceUsesOfWith(L->getHeader(), exitBlock);
 193
 194   // Rewrite phis in the exit block to get their inputs from
 195   // the preheader instead of the exiting block.
 196   BasicBlock::iterator BI = exitBlock->begin();
 197   while (PHINode* P = dyn_cast<PHINode>(BI)) {
 198     P->replaceUsesOfWith(exitingBlock, preheader);
 199     BI++;
 200   }
 201
 202   // Update the dominator tree and remove the instructions and blocks that will
 203   // be deleted from the reference counting scheme.
 204   DominatorTree& DT = getAnalysis<DominatorTree>();
 205   DominanceFrontier* DF = getAnalysisIfAvailable<DominanceFrontier>();
 206   SmallPtrSet<DomTreeNode*, 8> ChildNodes;
 207   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 208        LI != LE; ++LI) {
 209     // Move all of the block's children to be children of the preheader, which
 210     // allows us to remove the domtree entry for the block.
 211     ChildNodes.insert(DT[*LI]->begin(), DT[*LI]->end());
 212     for (SmallPtrSet<DomTreeNode*, 8>::iterator DI = ChildNodes.begin(),
 213          DE = ChildNodes.end(); DI != DE; ++DI) {
 214       DT.changeImmediateDominator(*DI, DT[preheader]);
 215       if (DF) DF->changeImmediateDominator((*DI)->getBlock(), preheader, &DT);
 216     }
 217
 218     ChildNodes.clear();
 219     DT.eraseNode(*LI);
 220     if (DF) DF->removeBlock(*LI);
 221
 222     // Remove the block from the reference counting scheme, so that we can
 223     // delete it freely later.
 224     (*LI)->dropAllReferences();
 225   }
 226
 227   // Erase the instructions and the blocks without having to worry
 228   // about ordering because we already dropped the references.
 229   // NOTE: This iteration is safe because erasing the block does not remove its
 230   // entry from the loop's block list.  We do that in the next section.
 231   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 232        LI != LE; ++LI)
 233     (*LI)->eraseFromParent();
 234
 235   // Finally, the blocks from loopinfo.  This has to happen late because
 236   // otherwise our loop iterators won't work.
 237   LoopInfo& loopInfo = getAnalysis<LoopInfo>();
 238   SmallPtrSet<BasicBlock*, 8> blocks;
 239   blocks.insert(L->block_begin(), L->block_end());
 240   for (SmallPtrSet<BasicBlock*,8>::iterator I = blocks.begin(),
 241        E = blocks.end(); I != E; ++I)
 242     loopInfo.removeBlock(*I);
 243
 244   // The last step is to inform the loop pass manager that we've
 245   // eliminated this loop.
 246   LPM.deleteLoopFromQueue(L);
 247   Changed = true;
 248
 249   NumDeleted++;
 250
 251   return Changed;
 252 }