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 #define DEBUG_TYPE "break-crit-edges"
  20 #include "llvm/Transforms/Scalar.h"
  21 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  22 #include "llvm/Analysis/Dominators.h"
  23 #include "llvm/Analysis/LoopInfo.h"
  24 #include "llvm/Function.h"
  25 #include "llvm/Instructions.h"
  26 #include "llvm/Type.h"
  27 #include "llvm/Support/CFG.h"
  28 #include "llvm/Support/Compiler.h"
  29 #include "llvm/ADT/SmallVector.h"
  30 #include "llvm/ADT/Statistic.h"
  31 using namespace llvm;
  32
  33 STATISTIC(NumBroken, "Number of blocks inserted");
  34
  35 namespace {
  36   struct VISIBILITY_HIDDEN BreakCriticalEdges : public FunctionPass {
  37     virtual bool runOnFunction(Function &F);
  38
  39     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  40       AU.addPreserved<ETForest>();
  41       AU.addPreserved<ImmediateDominators>();
  42       AU.addPreserved<DominanceFrontier>();
  43       AU.addPreserved<LoopInfo>();
  44
  45       // No loop canonicalization guarantees are broken by this pass.
  46       AU.addPreservedID(LoopSimplifyID);
  47     }
  48   };
  49
  50   RegisterPass<BreakCriticalEdges> X("break-crit-edges",
  51                                     "Break critical edges in CFG");
  52 }
  53
  54 // Publically exposed interface to pass...
  55 const PassInfo *llvm::BreakCriticalEdgesID = X.getPassInfo();
  56 FunctionPass *llvm::createBreakCriticalEdgesPass() {
  57   return new BreakCriticalEdges();
  58 }
  59
  60 // runOnFunction - Loop over all of the edges in the CFG, breaking critical
  61 // edges as they are found.
  62 //
  63 bool BreakCriticalEdges::runOnFunction(Function &F) {
  64   bool Changed = false;
  65   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
  66     TerminatorInst *TI = I->getTerminator();
  67     if (TI->getNumSuccessors() > 1)
  68       for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
  69         if (SplitCriticalEdge(TI, i, this)) {
  70           ++NumBroken;
  71           Changed = true;
  72         }
  73   }
  74
  75   return Changed;
  76 }
  77
  78 //===----------------------------------------------------------------------===//
  79 //    Implementation of the external critical edge manipulation functions
  80 //===----------------------------------------------------------------------===//
  81
  82 // isCriticalEdge - Return true if the specified edge is a critical edge.
  83 // Critical edges are edges from a block with multiple successors to a block
  84 // with multiple predecessors.
  85 //
  86 bool llvm::isCriticalEdge(const TerminatorInst *TI, unsigned SuccNum,
  87                           bool AllowIdenticalEdges) {
  88   assert(SuccNum < TI->getNumSuccessors() && "Illegal edge specification!");
  89   if (TI->getNumSuccessors() == 1) return false;
  90
  91   const BasicBlock *Dest = TI->getSuccessor(SuccNum);
  92   pred_const_iterator I = pred_begin(Dest), E = pred_end(Dest);
  93
  94   // If there is more than one predecessor, this is a critical edge...
  95   assert(I != E && "No preds, but we have an edge to the block?");
  96   const BasicBlock *FirstPred = *I;
  97   ++I;        // Skip one edge due to the incoming arc from TI.
  98   if (!AllowIdenticalEdges)
  99     return I != E;
 100
 101   // If AllowIdenticalEdges is true, then we allow this edge to be considered
 102   // non-critical iff all preds come from TI's block.
 103   for (; I != E; ++I)
 104     if (*I != FirstPred) return true;
 105   return false;
 106 }
 107
 108 // SplitCriticalEdge - If this edge is a critical edge, insert a new node to
 109 // split the critical edge.  This will update ETForest, ImmediateDominator,
 110 // DominatorTree, and DominatorFrontier information if it is available, thus
 111 // calling this pass will not invalidate any of them.  This returns true if
 112 // the edge was split, false otherwise.  This ensures that all edges to that
 113 // dest go to one block instead of each going to a different block.
 114 //
 115 bool llvm::SplitCriticalEdge(TerminatorInst *TI, unsigned SuccNum, Pass *P,
 116                              bool MergeIdenticalEdges) {
 117   if (!isCriticalEdge(TI, SuccNum, MergeIdenticalEdges)) return false;
 118   BasicBlock *TIBB = TI->getParent();
 119   BasicBlock *DestBB = TI->getSuccessor(SuccNum);
 120
 121   // Create a new basic block, linking it into the CFG.
 122   BasicBlock *NewBB = new BasicBlock(TIBB->getName() + "." +
 123                                      DestBB->getName() + "_crit_edge");
 124   // Create our unconditional branch...
 125   new BranchInst(DestBB, NewBB);
 126
 127   // Branch to the new block, breaking the edge.
 128   TI->setSuccessor(SuccNum, NewBB);
 129
 130   // Insert the block into the function... right after the block TI lives in.
 131   Function &F = *TIBB->getParent();
 132   F.getBasicBlockList().insert(TIBB->getNext(), NewBB);
 133
 134   // If there are any PHI nodes in DestBB, we need to update them so that they
 135   // merge incoming values from NewBB instead of from TIBB.
 136   //
 137   for (BasicBlock::iterator I = DestBB->begin(); isa<PHINode>(I); ++I) {
 138     PHINode *PN = cast<PHINode>(I);
 139     // We no longer enter through TIBB, now we come in through NewBB.  Revector
 140     // exactly one entry in the PHI node that used to come from TIBB to come
 141     // from NewBB.
 142     int BBIdx = PN->getBasicBlockIndex(TIBB);
 143     PN->setIncomingBlock(BBIdx, NewBB);
 144   }
 145
 146   // If there are any other edges from TIBB to DestBB, update those to go
 147   // through the split block, making those edges non-critical as well (and
 148   // reducing the number of phi entries in the DestBB if relevant).
 149   if (MergeIdenticalEdges) {
 150     for (unsigned i = SuccNum+1, e = TI->getNumSuccessors(); i != e; ++i) {
 151       if (TI->getSuccessor(i) != DestBB) continue;
 152
 153       // Remove an entry for TIBB from DestBB phi nodes.
 154       DestBB->removePredecessor(TIBB);
 155
 156       // We found another edge to DestBB, go to NewBB instead.
 157       TI->setSuccessor(i, NewBB);
 158     }
 159   }
 160
 161
 162
 163   // If we don't have a pass object, we can't update anything...
 164   if (P == 0) return true;
 165
 166   // Now update analysis information.  Since the only predecessor of NewBB is
 167   // the TIBB, TIBB clearly dominates NewBB.  TIBB usually doesn't dominate
 168   // anything, as there are other successors of DestBB.  However, if all other
 169   // predecessors of DestBB are already dominated by DestBB (e.g. DestBB is a
 170   // loop header) then NewBB dominates DestBB.
 171   SmallVector<BasicBlock*, 8> OtherPreds;
 172
 173   for (pred_iterator I = pred_begin(DestBB), E = pred_end(DestBB); I != E; ++I)
 174     if (*I != NewBB)
 175       OtherPreds.push_back(*I);
 176
 177   bool NewBBDominatesDestBB = true;
 178
 179   // Update the forest?
 180   if (ETForest *EF = P->getAnalysisToUpdate<ETForest>()) {
 181     // NewBB is dominated by TIBB.
 182     EF->addNewBlock(NewBB, TIBB);
 183
 184     // If NewBBDominatesDestBB hasn't been computed yet, do so with EF.
 185     if (!OtherPreds.empty()) {
 186       while (!OtherPreds.empty() && NewBBDominatesDestBB) {
 187         NewBBDominatesDestBB = EF->dominates(DestBB, OtherPreds.back());
 188         OtherPreds.pop_back();
 189       }
 190       OtherPreds.clear();
 191     }
 192
 193     // If NewBBDominatesDestBB, then NewBB dominates DestBB, otherwise it
 194     // doesn't dominate anything.
 195     if (NewBBDominatesDestBB)
 196       EF->setImmediateDominator(DestBB, NewBB);
 197   }
 198
 199   // Should we update ImmediateDominator information?
 200   if (ImmediateDominators *ID = P->getAnalysisToUpdate<ImmediateDominators>()) {
 201     // Only do this if TIBB is reachable.
 202     if (ID->get(TIBB) || &TIBB->getParent()->getEntryBlock() == TIBB) {
 203       // TIBB is the new immediate dominator for NewBB.
 204       ID->addNewBlock(NewBB, TIBB);
 205
 206       // If NewBBDominatesDestBB hasn't been computed yet, do so with ID.
 207       if (!OtherPreds.empty()) {
 208         while (!OtherPreds.empty() && NewBBDominatesDestBB) {
 209           NewBBDominatesDestBB = ID->dominates(DestBB, OtherPreds.back());
 210           OtherPreds.pop_back();
 211         }
 212         OtherPreds.clear();
 213       }
 214
 215       // If NewBBDominatesDestBB, then NewBB dominates DestBB, otherwise it
 216       // doesn't dominate anything.
 217       if (NewBBDominatesDestBB)
 218         ID->setImmediateDominator(DestBB, NewBB);
 219     }
 220   }
 221
 222   // Should we update DominatorTree information?
 223   if (DominatorTree *DT = P->getAnalysisToUpdate<DominatorTree>()) {
 224     DominatorTree::Node *TINode = DT->getNode(TIBB);
 225
 226     // The new block is not the immediate dominator for any other nodes, but
 227     // TINode is the immediate dominator for the new node.
 228     //
 229     if (TINode) {       // Don't break unreachable code!
 230       DominatorTree::Node *NewBBNode = DT->createNewNode(NewBB, TINode);
 231       DominatorTree::Node *DestBBNode = 0;
 232
 233       // If NewBBDominatesDestBB hasn't been computed yet, do so with DT.
 234       if (!OtherPreds.empty()) {
 235         DestBBNode = DT->getNode(DestBB);
 236         while (!OtherPreds.empty() && NewBBDominatesDestBB) {
 237           if (DominatorTree::Node *OPNode = DT->getNode(OtherPreds.back()))
 238             NewBBDominatesDestBB = DestBBNode->dominates(OPNode);
 239           OtherPreds.pop_back();
 240         }
 241         OtherPreds.clear();
 242       }
 243
 244       // If NewBBDominatesDestBB, then NewBB dominates DestBB, otherwise it
 245       // doesn't dominate anything.
 246       if (NewBBDominatesDestBB) {
 247         if (!DestBBNode) DestBBNode = DT->getNode(DestBB);
 248         DT->changeImmediateDominator(DestBBNode, NewBBNode);
 249       }
 250     }
 251   }
 252
 253   // Should we update DominanceFrontier information?
 254   if (DominanceFrontier *DF = P->getAnalysisToUpdate<DominanceFrontier>()) {
 255     // If NewBBDominatesDestBB hasn't been computed yet, do so with DF.
 256     if (!OtherPreds.empty()) {
 257       // FIXME: IMPLEMENT THIS!
 258       assert(0 && "Requiring domfrontiers but not idom/domtree/domset."
 259              " not implemented yet!");
 260     }
 261
 262     // Since the new block is dominated by its only predecessor TIBB,
 263     // it cannot be in any block's dominance frontier.  If NewBB dominates
 264     // DestBB, its dominance frontier is the same as DestBB's, otherwise it is
 265     // just {DestBB}.
 266     DominanceFrontier::DomSetType NewDFSet;
 267     if (NewBBDominatesDestBB) {
 268       DominanceFrontier::iterator I = DF->find(DestBB);
 269       if (I != DF->end())
 270         DF->addBasicBlock(NewBB, I->second);
 271       else
 272         DF->addBasicBlock(NewBB, DominanceFrontier::DomSetType());
 273     } else {
 274       DominanceFrontier::DomSetType NewDFSet;
 275       NewDFSet.insert(DestBB);
 276       DF->addBasicBlock(NewBB, NewDFSet);
 277     }
 278   }
 279
 280   // Update LoopInfo if it is around.
 281   if (LoopInfo *LI = P->getAnalysisToUpdate<LoopInfo>()) {
 282     // If one or the other blocks were not in a loop, the new block is not
 283     // either, and thus LI doesn't need to be updated.
 284     if (Loop *TIL = LI->getLoopFor(TIBB))
 285       if (Loop *DestLoop = LI->getLoopFor(DestBB)) {
 286         if (TIL == DestLoop) {
 287           // Both in the same loop, the NewBB joins loop.
 288           DestLoop->addBasicBlockToLoop(NewBB, *LI);
 289         } else if (TIL->contains(DestLoop->getHeader())) {
 290           // Edge from an outer loop to an inner loop.  Add to the outer loop.
 291           TIL->addBasicBlockToLoop(NewBB, *LI);
 292         } else if (DestLoop->contains(TIL->getHeader())) {
 293           // Edge from an inner loop to an outer loop.  Add to the outer loop.
 294           DestLoop->addBasicBlockToLoop(NewBB, *LI);
 295         } else {
 296           // Edge from two loops with no containment relation.  Because these
 297           // are natural loops, we know that the destination block must be the
 298           // header of its loop (adding a branch into a loop elsewhere would
 299           // create an irreducible loop).
 300           assert(DestLoop->getHeader() == DestBB &&
 301                  "Should not create irreducible loops!");
 302           if (Loop *P = DestLoop->getParentLoop())
 303             P->addBasicBlockToLoop(NewBB, *LI);
 304         }
 305       }
 306   }
 307   return true;
 308 }