lib/VMCore/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/Support/CFG.h"
  19 #include "llvm/Support/Compiler.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/ADT/DepthFirstIterator.h"
  22 #include "llvm/ADT/SetOperations.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/Analysis/DominatorInternals.h"
  26 #include "llvm/Assembly/Writer.h"
  27 #include "llvm/Instructions.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include <algorithm>
  31 using namespace llvm;
  32
  33 // Always verify dominfo if expensive checking is enabled.
  34 #ifdef XDEBUG
  35 static bool VerifyDomInfo = true;
  36 #else
  37 static bool VerifyDomInfo = false;
  38 #endif
  39 static cl::opt<bool,true>
  40 VerifyDomInfoX("verify-dom-info", cl::location(VerifyDomInfo),
  41                cl::desc("Verify dominator info (time consuming)"));
  42
  43 //===----------------------------------------------------------------------===//
  44 //  DominatorTree Implementation
  45 //===----------------------------------------------------------------------===//
  46 //
  47 // Provide public access to DominatorTree information.  Implementation details
  48 // can be found in DominatorCalculation.h.
  49 //
  50 //===----------------------------------------------------------------------===//
  51
  52 TEMPLATE_INSTANTIATION(class llvm::DomTreeNodeBase<BasicBlock>);
  53 TEMPLATE_INSTANTIATION(class llvm::DominatorTreeBase<BasicBlock>);
  54
  55 char DominatorTree::ID = 0;
  56 INITIALIZE_PASS(DominatorTree, "domtree",
  57                 "Dominator Tree Construction", true, true)
  58
  59 bool DominatorTree::runOnFunction(Function &F) {
  60   DT->recalculate(F);
  61   return false;
  62 }
  63
  64 void DominatorTree::verifyAnalysis() const {
  65   if (!VerifyDomInfo) return;
  66
  67   Function &F = *getRoot()->getParent();
  68
  69   DominatorTree OtherDT;
  70   OtherDT.getBase().recalculate(F);
  71   if (compare(OtherDT)) {
  72     errs() << "DominatorTree is not up to date!  Computed:\n";
  73     print(errs());
  74
  75     errs() << "\nActual:\n";
  76     OtherDT.print(errs());
  77     abort();
  78   }
  79 }
  80
  81 void DominatorTree::print(raw_ostream &OS, const Module *) const {
  82   DT->print(OS);
  83 }
  84
  85 // dominates - Return true if A dominates a use in B. This performs the
  86 // special checks necessary if A and B are in the same basic block.
  87 bool DominatorTree::dominates(const Instruction *A, const Instruction *B) const{
  88   const BasicBlock *BBA = A->getParent(), *BBB = B->getParent();
  89
  90   // If A is an invoke instruction, its value is only available in this normal
  91   // successor block.
  92   if (const InvokeInst *II = dyn_cast<InvokeInst>(A))
  93     BBA = II->getNormalDest();
  94
  95   if (BBA != BBB) return dominates(BBA, BBB);
  96
  97   // It is not possible to determine dominance between two PHI nodes
  98   // based on their ordering.
  99   if (isa<PHINode>(A) && isa<PHINode>(B))
 100     return false;
 101
 102   // Loop through the basic block until we find A or B.
 103   BasicBlock::const_iterator I = BBA->begin();
 104   for (; &*I != A && &*I != B; ++I)
 105     /*empty*/;
 106
 107   return &*I == A;
 108 }