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((intptr_t)&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 IsLoopInvariantInst(Instruction *I, Loop* L);
  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     }
  57   };
  58 }
  59
  60 char LoopDeletion::ID = 0;
  61 static RegisterPass<LoopDeletion> X("loop-deletion", "Delete dead loops");
  62
  63 LoopPass* llvm::createLoopDeletionPass() {
  64   return new LoopDeletion();
  65 }
  66
  67 /// SingleDominatingExit - Checks that there is only a single blocks that
  68 /// branches out of the loop, and that it also g the latch block.  Loops
  69 /// with multiple or non-latch-dominating exiting blocks could be dead, but we'd
  70 /// have to do more extensive analysis to make sure, for instance, that the
  71 /// control flow logic involved was or could be made loop-invariant.
  72 bool LoopDeletion::SingleDominatingExit(Loop* L,
  73                                    SmallVector<BasicBlock*, 4>& exitingBlocks) {
  74
  75   if (exitingBlocks.size() != 1)
  76     return false;
  77
  78   BasicBlock* latch = L->getLoopLatch();
  79   if (!latch)
  80     return false;
  81
  82   DominatorTree& DT = getAnalysis<DominatorTree>();
  83   return DT.dominates(exitingBlocks[0], latch);
  84 }
  85
  86 /// IsLoopInvariantInst - Checks if an instruction is invariant with respect to
  87 /// a loop, which is defined as being true if all of its operands are defined
  88 /// outside of the loop.  These instructions can be hoisted out of the loop
  89 /// if their results are needed.  This could be made more aggressive by
  90 /// recursively checking the operands for invariance, but it's not clear that
  91 /// it's worth it.
  92 bool LoopDeletion::IsLoopInvariantInst(Instruction *I, Loop* L)  {
  93   // PHI nodes are not loop invariant if defined in  the loop.
  94   if (isa<PHINode>(I) && L->contains(I->getParent()))
  95     return false;
  96
  97   // The instruction is loop invariant if all of its operands are loop-invariant
  98   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
  99     if (!L->isLoopInvariant(I->getOperand(i)))
 100       return false;
 101
 102   // If we got this far, the instruction is loop invariant!
 103   return true;
 104 }
 105
 106 /// IsLoopDead - Determined if a loop is dead.  This assumes that we've already
 107 /// checked for unique exit and exiting blocks, and that the code is in LCSSA
 108 /// form.
 109 bool LoopDeletion::IsLoopDead(Loop* L,
 110                               SmallVector<BasicBlock*, 4>& exitingBlocks,
 111                               SmallVector<BasicBlock*, 4>& exitBlocks) {
 112   BasicBlock* exitingBlock = exitingBlocks[0];
 113   BasicBlock* exitBlock = exitBlocks[0];
 114
 115   // Make sure that all PHI entries coming from the loop are loop invariant.
 116   // Because the code is in LCSSA form, any values used outside of the loop
 117   // must pass through a PHI in the exit block, meaning that this check is
 118   // sufficient to guarantee that no loop-variant values are used outside
 119   // of the loop.
 120   BasicBlock::iterator BI = exitBlock->begin();
 121   while (PHINode* P = dyn_cast<PHINode>(BI)) {
 122     Value* incoming = P->getIncomingValueForBlock(exitingBlock);
 123     if (Instruction* I = dyn_cast<Instruction>(incoming))
 124       if (!IsLoopInvariantInst(I, L))
 125         return false;
 126
 127     BI++;
 128   }
 129
 130   // Make sure that no instructions in the block have potential side-effects.
 131   // This includes instructions that could write to memory, and loads that are
 132   // marked volatile.  This could be made more aggressive by using aliasing
 133   // information to identify readonly and readnone calls.
 134   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 135        LI != LE; ++LI) {
 136     for (BasicBlock::iterator BI = (*LI)->begin(), BE = (*LI)->end();
 137          BI != BE; ++BI) {
 138       if (BI->mayWriteToMemory())
 139         return false;
 140       else if (LoadInst* L = dyn_cast<LoadInst>(BI))
 141         if (L->isVolatile())
 142           return false;
 143     }
 144   }
 145
 146   return true;
 147 }
 148
 149 /// runOnLoop - Remove dead loops, by which we mean loops that do not impact the
 150 /// observable behavior of the program other than finite running time.  Note
 151 /// we do ensure that this never remove a loop that might be infinite, as doing
 152 /// so could change the halting/non-halting nature of a program.
 153 /// NOTE: This entire process relies pretty heavily on LoopSimplify and LCSSA
 154 /// in order to make various safety checks work.
 155 bool LoopDeletion::runOnLoop(Loop* L, LPPassManager& LPM) {
 156   // We can only remove the loop if there is a preheader that we can
 157   // branch from after removing it.
 158   BasicBlock* preheader = L->getLoopPreheader();
 159   if (!preheader)
 160     return false;
 161
 162   // We can't remove loops that contain subloops.  If the subloops were dead,
 163   // they would already have been removed in earlier executions of this pass.
 164   if (L->begin() != L->end())
 165     return false;
 166
 167   SmallVector<BasicBlock*, 4> exitingBlocks;
 168   L->getExitingBlocks(exitingBlocks);
 169
 170   SmallVector<BasicBlock*, 4> exitBlocks;
 171   L->getUniqueExitBlocks(exitBlocks);
 172
 173   // We require that the loop only have a single exit block.  Otherwise, we'd
 174   // be in the situation of needing to be able to solve statically which exit
 175   // block will be branched to, or trying to preserve the branching logic in
 176   // a loop invariant manner.
 177   if (exitBlocks.size() != 1)
 178     return false;
 179
 180   // Loops with multiple exits or exits that don't dominate the latch
 181   // are too complicated to handle correctly.
 182   if (!SingleDominatingExit(L, exitingBlocks))
 183     return false;
 184
 185   // Finally, we have to check that the loop really is dead.
 186   if (!IsLoopDead(L, exitingBlocks, exitBlocks))
 187     return false;
 188
 189   // Don't remove loops for which we can't solve the trip count.
 190   // They could be infinite, in which case we'd be changing program behavior.
 191   ScalarEvolution& SE = getAnalysis<ScalarEvolution>();
 192   SCEVHandle S = SE.getIterationCount(L);
 193   if (isa<SCEVCouldNotCompute>(S))
 194     return false;
 195
 196   // Now that we know the removal is safe, remove the loop by changing the
 197   // branch from the preheader to go to the single exit block.
 198   BasicBlock* exitBlock = exitBlocks[0];
 199   BasicBlock* exitingBlock = exitingBlocks[0];
 200
 201   // Because we're deleting a large chunk of code at once, the sequence in which
 202   // we remove things is very important to avoid invalidation issues.  Don't
 203   // mess with this unless you have good reason and know what you're doing.
 204
 205   // Move simple loop-invariant expressions out of the loop, since they
 206   // might be needed by the exit phis.
 207   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 208        LI != LE; ++LI)
 209     for (BasicBlock::iterator BI = (*LI)->begin(), BE = (*LI)->end();
 210          BI != BE; ) {
 211       Instruction* I = BI++;
 212       if (!I->use_empty() && IsLoopInvariantInst(I, L))
 213         I->moveBefore(preheader->getTerminator());
 214     }
 215
 216   // Connect the preheader directly to the exit block.
 217   TerminatorInst* TI = preheader->getTerminator();
 218   TI->replaceUsesOfWith(L->getHeader(), exitBlock);
 219
 220   // Rewrite phis in the exit block to get their inputs from
 221   // the preheader instead of the exiting block.
 222   BasicBlock::iterator BI = exitBlock->begin();
 223   while (PHINode* P = dyn_cast<PHINode>(BI)) {
 224     P->replaceUsesOfWith(exitingBlock, preheader);
 225     BI++;
 226   }
 227
 228   // Update the dominator tree and remove the instructions and blocks that will
 229   // be deleted from the reference counting scheme.
 230   DominatorTree& DT = getAnalysis<DominatorTree>();
 231   SmallPtrSet<DomTreeNode*, 8> ChildNodes;
 232   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 233        LI != LE; ++LI) {
 234     // Move all of the block's children to be children of the preheader, which
 235     // allows us to remove the domtree entry for the block.
 236     ChildNodes.insert(DT[*LI]->begin(), DT[*LI]->end());
 237     for (SmallPtrSet<DomTreeNode*, 8>::iterator DI = ChildNodes.begin(),
 238          DE = ChildNodes.end(); DI != DE; ++DI)
 239       DT.changeImmediateDominator(*DI, DT[preheader]);
 240
 241     ChildNodes.clear();
 242     DT.eraseNode(*LI);
 243
 244     // Remove instructions that we're deleting from ScalarEvolution.
 245     for (BasicBlock::iterator BI = (*LI)->begin(), BE = (*LI)->end();
 246          BI != BE; ++BI)
 247       SE.deleteValueFromRecords(BI);
 248
 249     SE.deleteValueFromRecords(*LI);
 250
 251     // Remove the block from the reference counting scheme, so that we can
 252     // delete it freely later.
 253     (*LI)->dropAllReferences();
 254   }
 255
 256   // Erase the instructions and the blocks without having to worry
 257   // about ordering because we already dropped the references.
 258   // NOTE: This iteration is safe because erasing the block does not remove its
 259   // entry from the loop's block list.  We do that in the next section.
 260   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
 261        LI != LE; ++LI)
 262     (*LI)->eraseFromParent();
 263
 264   // Finally, the blocks from loopinfo.  This has to happen late because
 265   // otherwise our loop iterators won't work.
 266   LoopInfo& loopInfo = getAnalysis<LoopInfo>();
 267   SmallPtrSet<BasicBlock*, 8> blocks;
 268   blocks.insert(L->block_begin(), L->block_end());
 269   for (SmallPtrSet<BasicBlock*,8>::iterator I = blocks.begin(),
 270        E = blocks.end(); I != E; ++I)
 271     loopInfo.removeBlock(*I);
 272
 273   // The last step is to inform the loop pass manager that we've
 274   // eliminated this loop.
 275   LPM.deleteLoopFromQueue(L);
 276
 277   NumDeleted++;
 278
 279   return true;
 280 }