lib/IR/Dominators.cpp

   1 //===- Dominators.cpp - Dominator Calculation -----------------------------===//
   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 simple dominator construction algorithms for finding
  11 // forward dominators.  Postdominators are available in libanalysis, but are not
  12 // included in libvmcore, because it's not needed.  Forward dominators are
  13 // needed to support the Verifier pass.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/Dominators.h"
  18 #include "llvm/ADT/DepthFirstIterator.h"
  19 #include "llvm/ADT/SmallPtrSet.h"
  20 #include "llvm/ADT/SmallVector.h"
  21 #include "llvm/Analysis/DominatorInternals.h"
  22 #include "llvm/IR/Instructions.h"
  23 #include "llvm/Support/CFG.h"
  24 #include "llvm/Support/CommandLine.h"
  25 #include "llvm/Support/Compiler.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include <algorithm>
  29 using namespace llvm;
  30
  31 // Always verify dominfo if expensive checking is enabled.
  32 #ifdef XDEBUG
  33 static bool VerifyDomInfo = true;
  34 #else
  35 static bool VerifyDomInfo = false;
  36 #endif
  37 static cl::opt<bool,true>
  38 VerifyDomInfoX("verify-dom-info", cl::location(VerifyDomInfo),
  39                cl::desc("Verify dominator info (time consuming)"));
  40
  41 bool BasicBlockEdge::isSingleEdge() const {
  42   const TerminatorInst *TI = Start->getTerminator();
  43   unsigned NumEdgesToEnd = 0;
  44   for (unsigned int i = 0, n = TI->getNumSuccessors(); i < n; ++i) {
  45     if (TI->getSuccessor(i) == End)
  46       ++NumEdgesToEnd;
  47     if (NumEdgesToEnd >= 2)
  48       return false;
  49   }
  50   assert(NumEdgesToEnd == 1);
  51   return true;
  52 }
  53
  54 //===----------------------------------------------------------------------===//
  55 //  DominatorTree Implementation
  56 //===----------------------------------------------------------------------===//
  57 //
  58 // Provide public access to DominatorTree information.  Implementation details
  59 // can be found in DominatorInternals.h.
  60 //
  61 //===----------------------------------------------------------------------===//
  62
  63 TEMPLATE_INSTANTIATION(class llvm::DomTreeNodeBase<BasicBlock>);
  64 TEMPLATE_INSTANTIATION(class llvm::DominatorTreeBase<BasicBlock>);
  65
  66 char DominatorTree::ID = 0;
  67 INITIALIZE_PASS(DominatorTree, "domtree",
  68                 "Dominator Tree Construction", true, true)
  69
  70 bool DominatorTree::runOnFunction(Function &F) {
  71   DT->recalculate(F);
  72   return false;
  73 }
  74
  75 void DominatorTree::verifyAnalysis() const {
  76   if (!VerifyDomInfo) return;
  77
  78   Function &F = *getRoot()->getParent();
  79
  80   DominatorTree OtherDT;
  81   OtherDT.getBase().recalculate(F);
  82   if (compare(OtherDT)) {
  83     errs() << "DominatorTree is not up to date!\nComputed:\n";
  84     print(errs());
  85     errs() << "\nActual:\n";
  86     OtherDT.print(errs());
  87     abort();
  88   }
  89 }
  90
  91 void DominatorTree::print(raw_ostream &OS, const Module *) const {
  92   DT->print(OS);
  93 }
  94
  95 // dominates - Return true if Def dominates a use in User. This performs
  96 // the special checks necessary if Def and User are in the same basic block.
  97 // Note that Def doesn't dominate a use in Def itself!
  98 bool DominatorTree::dominates(const Instruction *Def,
  99                               const Instruction *User) const {
 100   const BasicBlock *UseBB = User->getParent();
 101   const BasicBlock *DefBB = Def->getParent();
 102
 103   // Any unreachable use is dominated, even if Def == User.
 104   if (!isReachableFromEntry(UseBB))
 105     return true;
 106
 107   // Unreachable definitions don't dominate anything.
 108   if (!isReachableFromEntry(DefBB))
 109     return false;
 110
 111   // An instruction doesn't dominate a use in itself.
 112   if (Def == User)
 113     return false;
 114
 115   // The value defined by an invoke dominates an instruction only if
 116   // it dominates every instruction in UseBB.
 117   // A PHI is dominated only if the instruction dominates every possible use
 118   // in the UseBB.
 119   if (isa<InvokeInst>(Def) || isa<PHINode>(User))
 120     return dominates(Def, UseBB);
 121
 122   if (DefBB != UseBB)
 123     return dominates(DefBB, UseBB);
 124
 125   // Loop through the basic block until we find Def or User.
 126   BasicBlock::const_iterator I = DefBB->begin();
 127   for (; &*I != Def && &*I != User; ++I)
 128     /*empty*/;
 129
 130   return &*I == Def;
 131 }
 132
 133 // true if Def would dominate a use in any instruction in UseBB.
 134 // note that dominates(Def, Def->getParent()) is false.
 135 bool DominatorTree::dominates(const Instruction *Def,
 136                               const BasicBlock *UseBB) const {
 137   const BasicBlock *DefBB = Def->getParent();
 138
 139   // Any unreachable use is dominated, even if DefBB == UseBB.
 140   if (!isReachableFromEntry(UseBB))
 141     return true;
 142
 143   // Unreachable definitions don't dominate anything.
 144   if (!isReachableFromEntry(DefBB))
 145     return false;
 146
 147   if (DefBB == UseBB)
 148     return false;
 149
 150   const InvokeInst *II = dyn_cast<InvokeInst>(Def);
 151   if (!II)
 152     return dominates(DefBB, UseBB);
 153
 154   // Invoke results are only usable in the normal destination, not in the
 155   // exceptional destination.
 156   BasicBlock *NormalDest = II->getNormalDest();
 157   BasicBlockEdge E(DefBB, NormalDest);
 158   return dominates(E, UseBB);
 159 }
 160
 161 bool DominatorTree::dominates(const BasicBlockEdge &BBE,
 162                               const BasicBlock *UseBB) const {
 163   // Assert that we have a single edge. We could handle them by simply
 164   // returning false, but since isSingleEdge is linear on the number of
 165   // edges, the callers can normally handle them more efficiently.
 166   assert(BBE.isSingleEdge());
 167
 168   // If the BB the edge ends in doesn't dominate the use BB, then the
 169   // edge also doesn't.
 170   const BasicBlock *Start = BBE.getStart();
 171   const BasicBlock *End = BBE.getEnd();
 172   if (!dominates(End, UseBB))
 173     return false;
 174
 175   // Simple case: if the end BB has a single predecessor, the fact that it
 176   // dominates the use block implies that the edge also does.
 177   if (End->getSinglePredecessor())
 178     return true;
 179
 180   // The normal edge from the invoke is critical. Conceptually, what we would
 181   // like to do is split it and check if the new block dominates the use.
 182   // With X being the new block, the graph would look like:
 183   //
 184   //        DefBB
 185   //          /\      .  .
 186   //         /  \     .  .
 187   //        /    \    .  .
 188   //       /      \   |  |
 189   //      A        X  B  C
 190   //      |         \ | /
 191   //      .          \|/
 192   //      .      NormalDest
 193   //      .
 194   //
 195   // Given the definition of dominance, NormalDest is dominated by X iff X
 196   // dominates all of NormalDest's predecessors (X, B, C in the example). X
 197   // trivially dominates itself, so we only have to find if it dominates the
 198   // other predecessors. Since the only way out of X is via NormalDest, X can
 199   // only properly dominate a node if NormalDest dominates that node too.
 200   for (const_pred_iterator PI = pred_begin(End), E = pred_end(End);
 201        PI != E; ++PI) {
 202     const BasicBlock *BB = *PI;
 203     if (BB == Start)
 204       continue;
 205
 206     if (!dominates(End, BB))
 207       return false;
 208   }
 209   return true;
 210 }
 211
 212 bool DominatorTree::dominates(const BasicBlockEdge &BBE,
 213                               const Use &U) const {
 214   // Assert that we have a single edge. We could handle them by simply
 215   // returning false, but since isSingleEdge is linear on the number of
 216   // edges, the callers can normally handle them more efficiently.
 217   assert(BBE.isSingleEdge());
 218
 219   Instruction *UserInst = cast<Instruction>(U.getUser());
 220   // A PHI in the end of the edge is dominated by it.
 221   PHINode *PN = dyn_cast<PHINode>(UserInst);
 222   if (PN && PN->getParent() == BBE.getEnd() &&
 223       PN->getIncomingBlock(U) == BBE.getStart())
 224     return true;
 225
 226   // Otherwise use the edge-dominates-block query, which
 227   // handles the crazy critical edge cases properly.
 228   const BasicBlock *UseBB;
 229   if (PN)
 230     UseBB = PN->getIncomingBlock(U);
 231   else
 232     UseBB = UserInst->getParent();
 233   return dominates(BBE, UseBB);
 234 }
 235
 236 bool DominatorTree::dominates(const Instruction *Def,
 237                               const Use &U) const {
 238   Instruction *UserInst = cast<Instruction>(U.getUser());
 239   const BasicBlock *DefBB = Def->getParent();
 240
 241   // Determine the block in which the use happens. PHI nodes use
 242   // their operands on edges; simulate this by thinking of the use
 243   // happening at the end of the predecessor block.
 244   const BasicBlock *UseBB;
 245   if (PHINode *PN = dyn_cast<PHINode>(UserInst))
 246     UseBB = PN->getIncomingBlock(U);
 247   else
 248     UseBB = UserInst->getParent();
 249
 250   // Any unreachable use is dominated, even if Def == User.
 251   if (!isReachableFromEntry(UseBB))
 252     return true;
 253
 254   // Unreachable definitions don't dominate anything.
 255   if (!isReachableFromEntry(DefBB))
 256     return false;
 257
 258   // Invoke instructions define their return values on the edges
 259   // to their normal successors, so we have to handle them specially.
 260   // Among other things, this means they don't dominate anything in
 261   // their own block, except possibly a phi, so we don't need to
 262   // walk the block in any case.
 263   if (const InvokeInst *II = dyn_cast<InvokeInst>(Def)) {
 264     BasicBlock *NormalDest = II->getNormalDest();
 265     BasicBlockEdge E(DefBB, NormalDest);
 266     return dominates(E, U);
 267   }
 268
 269   // If the def and use are in different blocks, do a simple CFG dominator
 270   // tree query.
 271   if (DefBB != UseBB)
 272     return dominates(DefBB, UseBB);
 273
 274   // Ok, def and use are in the same block. If the def is an invoke, it
 275   // doesn't dominate anything in the block. If it's a PHI, it dominates
 276   // everything in the block.
 277   if (isa<PHINode>(UserInst))
 278     return true;
 279
 280   // Otherwise, just loop through the basic block until we find Def or User.
 281   BasicBlock::const_iterator I = DefBB->begin();
 282   for (; &*I != Def && &*I != UserInst; ++I)
 283     /*empty*/;
 284
 285   return &*I != UserInst;
 286 }
 287
 288 bool DominatorTree::isReachableFromEntry(const Use &U) const {
 289   Instruction *I = dyn_cast<Instruction>(U.getUser());
 290
 291   // ConstantExprs aren't really reachable from the entry block, but they
 292   // don't need to be treated like unreachable code either.
 293   if (!I) return true;
 294
 295   // PHI nodes use their operands on their incoming edges.
 296   if (PHINode *PN = dyn_cast<PHINode>(I))
 297     return isReachableFromEntry(PN->getIncomingBlock(U));
 298
 299   // Everything else uses their operands in their own block.
 300   return isReachableFromEntry(I->getParent());
 301 }