lib/Transforms/Utils/BreakCriticalEdges.cpp

   1 //===- BreakCriticalEdges.cpp - Critical Edge Elimination Pass ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // BreakCriticalEdges pass - Break all of the critical edges in the CFG by
  11 // inserting a dummy basic block.  This pass may be "required" by passes that
  12 // cannot deal with critical edges.  For this usage, the structure type is
  13 // forward declared.  This pass obviously invalidates the CFG, but can update
  14 // forward dominator (set, immediate dominators, tree, and frontier)
  15 // information.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/Transforms/Scalar.h"
  20 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  21 #include "llvm/Analysis/Dominators.h"
  22 #include "llvm/Function.h"
  23 #include "llvm/Instructions.h"
  24 #include "llvm/Support/CFG.h"
  25 #include "llvm/ADT/Statistic.h"
  26 using namespace llvm;
  27
  28 namespace {
  29   Statistic<> NumBroken("break-crit-edges", "Number of blocks inserted");
  30
  31   struct BreakCriticalEdges : public FunctionPass {
  32     virtual bool runOnFunction(Function &F);
  33
  34     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  35       AU.addPreserved<DominatorSet>();
  36       AU.addPreserved<ImmediateDominators>();
  37       AU.addPreserved<DominatorTree>();
  38       AU.addPreserved<DominanceFrontier>();
  39
  40       // No loop canonicalization guarantees are broken by this pass.
  41       AU.addPreservedID(LoopSimplifyID);
  42     }
  43   };
  44
  45   RegisterOpt<BreakCriticalEdges> X("break-crit-edges",
  46                                     "Break critical edges in CFG");
  47 }
  48
  49 // Publically exposed interface to pass...
  50 const PassInfo *llvm::BreakCriticalEdgesID = X.getPassInfo();
  51 FunctionPass *llvm::createBreakCriticalEdgesPass() {
  52   return new BreakCriticalEdges();
  53 }
  54
  55 // runOnFunction - Loop over all of the edges in the CFG, breaking critical
  56 // edges as they are found.
  57 //
  58 bool BreakCriticalEdges::runOnFunction(Function &F) {
  59   bool Changed = false;
  60   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
  61     TerminatorInst *TI = I->getTerminator();
  62     if (TI->getNumSuccessors() > 1)
  63       for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
  64         if (SplitCriticalEdge(TI, i, this)) {
  65           ++NumBroken;
  66           Changed = true;
  67         }
  68   }
  69
  70   return Changed;
  71 }
  72
  73 //===----------------------------------------------------------------------===//
  74 //    Implementation of the external critical edge manipulation functions
  75 //===----------------------------------------------------------------------===//
  76
  77 // isCriticalEdge - Return true if the specified edge is a critical edge.
  78 // Critical edges are edges from a block with multiple successors to a block
  79 // with multiple predecessors.
  80 //
  81 bool llvm::isCriticalEdge(const TerminatorInst *TI, unsigned SuccNum) {
  82   assert(SuccNum < TI->getNumSuccessors() && "Illegal edge specification!");
  83   if (TI->getNumSuccessors() == 1) return false;
  84
  85   const BasicBlock *Dest = TI->getSuccessor(SuccNum);
  86   pred_const_iterator I = pred_begin(Dest), E = pred_end(Dest);
  87
  88   // If there is more than one predecessor, this is a critical edge...
  89   assert(I != E && "No preds, but we have an edge to the block?");
  90   ++I;        // Skip one edge due to the incoming arc from TI.
  91   return I != E;
  92 }
  93
  94 // SplitCriticalEdge - If this edge is a critical edge, insert a new node to
  95 // split the critical edge.  This will update DominatorSet, ImmediateDominator,
  96 // DominatorTree, and DominatorFrontier information if it is available, thus
  97 // calling this pass will not invalidate either of them.  This returns true if
  98 // the edge was split, false otherwise.
  99 //
 100 bool llvm::SplitCriticalEdge(TerminatorInst *TI, unsigned SuccNum, Pass *P) {
 101   if (!isCriticalEdge(TI, SuccNum)) return false;
 102   BasicBlock *TIBB = TI->getParent();
 103   BasicBlock *DestBB = TI->getSuccessor(SuccNum);
 104
 105   // Create a new basic block, linking it into the CFG.
 106   BasicBlock *NewBB = new BasicBlock(TIBB->getName() + "." +
 107                                      DestBB->getName() + "_crit_edge");
 108   // Create our unconditional branch...
 109   new BranchInst(DestBB, NewBB);
 110
 111   // Branch to the new block, breaking the edge...
 112   TI->setSuccessor(SuccNum, NewBB);
 113
 114   // Insert the block into the function... right after the block TI lives in.
 115   Function &F = *TIBB->getParent();
 116   F.getBasicBlockList().insert(TIBB->getNext(), NewBB);
 117
 118   // If there are any PHI nodes in DestBB, we need to update them so that they
 119   // merge incoming values from NewBB instead of from TIBB.
 120   //
 121   for (BasicBlock::iterator I = DestBB->begin(); isa<PHINode>(I); ++I) {
 122     PHINode *PN = cast<PHINode>(I);
 123     // We no longer enter through TIBB, now we come in through NewBB.  Revector
 124     // exactly one entry in the PHI node that used to come from TIBB to come
 125     // from NewBB.
 126     Value *InVal = PN->removeIncomingValue(TIBB, false);
 127     PN->addIncoming(InVal, NewBB);
 128   }
 129
 130   // If we don't have a pass object, we can't update anything...
 131   if (P == 0) return true;
 132
 133   // Now update analysis information.  These are the analyses that we are
 134   // currently capable of updating...
 135   //
 136
 137   // Should we update DominatorSet information?
 138   if (DominatorSet *DS = P->getAnalysisToUpdate<DominatorSet>()) {
 139     // The blocks that dominate the new one are the blocks that dominate TIBB
 140     // plus the new block itself.
 141     DominatorSet::DomSetType DomSet = DS->getDominators(TIBB);
 142     DomSet.insert(NewBB);  // A block always dominates itself.
 143     DS->addBasicBlock(NewBB, DomSet);
 144   }
 145
 146   // Should we update ImmediateDominator information?
 147   if (ImmediateDominators *ID = P->getAnalysisToUpdate<ImmediateDominators>()) {
 148     // TIBB is the new immediate dominator for NewBB.  NewBB doesn't dominate
 149     // anything.
 150     ID->addNewBlock(NewBB, TIBB);
 151   }
 152
 153   // Should we update DominatorTree information?
 154   if (DominatorTree *DT = P->getAnalysisToUpdate<DominatorTree>()) {
 155     DominatorTree::Node *TINode = DT->getNode(TIBB);
 156
 157     // The new block is not the immediate dominator for any other nodes, but
 158     // TINode is the immediate dominator for the new node.
 159     //
 160     if (TINode)        // Don't break unreachable code!
 161       DT->createNewNode(NewBB, TINode);
 162   }
 163
 164   // Should we update DominanceFrontier information?
 165   if (DominanceFrontier *DF = P->getAnalysisToUpdate<DominanceFrontier>()) {
 166     // Since the new block is dominated by its only predecessor TIBB,
 167     // it cannot be in any block's dominance frontier.  Its dominance
 168     // frontier is {DestBB}.
 169     DominanceFrontier::DomSetType NewDFSet;
 170     NewDFSet.insert(DestBB);
 171     DF->addBasicBlock(NewBB, NewDFSet);
 172   }
 173   return true;
 174 }